MFEM  v4.5.2
Finite element discretization library
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 SetTime (double t)
 Set the time for internally stored coefficients. 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 ()
 
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 void Project (QuadratureFunction &qf)
 Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points. 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 1412 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ ProductCoefficient() [1/2]

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

Constructor with one coefficient. Result is A * B.

Definition at line 1421 of file coefficient.hpp.

◆ ProductCoefficient() [2/2]

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

Constructor with two coefficients. Result is A * B.

Definition at line 1425 of file coefficient.hpp.

Member Function Documentation

◆ Eval()

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

Evaluate the coefficient at ip.

Implements mfem::Coefficient.

Definition at line 1447 of file coefficient.hpp.

◆ GetACoef()

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

Return the first term in the product.

Definition at line 1439 of file coefficient.hpp.

◆ GetAConst()

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

Return the first term in the product.

Definition at line 1434 of file coefficient.hpp.

◆ GetBCoef()

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

Return the second term in the product.

Definition at line 1444 of file coefficient.hpp.

◆ SetACoef()

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

Reset the first term in the product.

Definition at line 1437 of file coefficient.hpp.

◆ SetAConst()

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

Reset the first term in the product as a constant.

Definition at line 1432 of file coefficient.hpp.

◆ SetBCoef()

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

Reset the second term in the product.

Definition at line 1442 of file coefficient.hpp.

◆ SetTime()

void mfem::ProductCoefficient::SetTime ( double  t)
virtual

Set the time for internally stored coefficients.

Reimplemented from mfem::Coefficient.

Definition at line 905 of file coefficient.cpp.


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