MFEM  v4.3.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
mfem::ProductCoefficient Class Reference

Scalar coefficient defined as the product of two scalar coefficients or a scalar and a scalar coefficient. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::ProductCoefficient:
[legend]
Collaboration diagram for mfem::ProductCoefficient:
[legend]

Public Member Functions

 ProductCoefficient (double A, Coefficient &B)
 Constructor with one coefficient. Result is A * B. More...
 
 ProductCoefficient (Coefficient &A, Coefficient &B)
 Constructor with two coefficients. Result is A * B. More...
 
void SetAConst (double A)
 Reset the first term in the product as a constant. More...
 
double GetAConst () const
 Return the first term in the product. More...
 
void SetACoef (Coefficient &A)
 Reset the first term in the product. More...
 
CoefficientGetACoef () const
 Return the first term in the product. More...
 
void SetBCoef (Coefficient &B)
 Reset the second term in the product. More...
 
CoefficientGetBCoef () const
 Return the second term in the product. More...
 
virtual double Eval (ElementTransformation &T, const IntegrationPoint &ip)
 Evaluate the coefficient at ip. More...
 
- Public Member Functions inherited from mfem::Coefficient
 Coefficient ()
 
void SetTime (double t)
 Set the time for time dependent coefficients. More...
 
double GetTime ()
 Get the time for time dependent coefficients. More...
 
double Eval (ElementTransformation &T, const IntegrationPoint &ip, double t)
 Evaluate the coefficient in the element described by T at the point ip at time t. More...
 
virtual ~Coefficient ()
 

Additional Inherited Members

- Protected Attributes inherited from mfem::Coefficient
double time
 

Detailed Description

Scalar coefficient defined as the product of two scalar coefficients or a scalar and a scalar coefficient.

Definition at line 1050 of file coefficient.hpp.

Constructor & Destructor Documentation

mfem::ProductCoefficient::ProductCoefficient ( double  A,
Coefficient B 
)
inline

Constructor with one coefficient. Result is A * B.

Definition at line 1059 of file coefficient.hpp.

mfem::ProductCoefficient::ProductCoefficient ( Coefficient A,
Coefficient B 
)
inline

Constructor with two coefficients. Result is A * B.

Definition at line 1063 of file coefficient.hpp.

Member Function Documentation

virtual double mfem::ProductCoefficient::Eval ( ElementTransformation T,
const IntegrationPoint ip 
)
inlinevirtual

Evaluate the coefficient at ip.

Implements mfem::Coefficient.

Definition at line 1082 of file coefficient.hpp.

Coefficient* mfem::ProductCoefficient::GetACoef ( ) const
inline

Return the first term in the product.

Definition at line 1074 of file coefficient.hpp.

double mfem::ProductCoefficient::GetAConst ( ) const
inline

Return the first term in the product.

Definition at line 1069 of file coefficient.hpp.

Coefficient* mfem::ProductCoefficient::GetBCoef ( ) const
inline

Return the second term in the product.

Definition at line 1079 of file coefficient.hpp.

void mfem::ProductCoefficient::SetACoef ( Coefficient A)
inline

Reset the first term in the product.

Definition at line 1072 of file coefficient.hpp.

void mfem::ProductCoefficient::SetAConst ( double  A)
inline

Reset the first term in the product as a constant.

Definition at line 1067 of file coefficient.hpp.

void mfem::ProductCoefficient::SetBCoef ( Coefficient B)
inline

Reset the second term in the product.

Definition at line 1077 of file coefficient.hpp.


The documentation for this class was generated from the following file: