MFEM  v4.3.0 Finite element discretization library
mfem::SumCoefficient Class Reference

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

#include <coefficient.hpp>

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

## Public Member Functions

SumCoefficient (double A, Coefficient &B, double alpha_=1.0, double beta_=1.0)
Constructor with one coefficient. Result is alpha_ * A + beta_ * B. More...

SumCoefficient (Coefficient &A, Coefficient &B, double alpha_=1.0, double beta_=1.0)
Constructor with two coefficients. Result is alpha_ * A + beta_ * B. More...

void SetAConst (double A)
Reset the first term in the linear combination as a constant. More...

double GetAConst () const
Return the first term in the linear combination. More...

void SetACoef (Coefficient &A)
Reset the first term in the linear combination. More...

CoefficientGetACoef () const
Return the first term in the linear combination. More...

void SetBCoef (Coefficient &B)
Reset the second term in the linear combination. More...

CoefficientGetBCoef () const
Return the second term in the linear combination. More...

void SetAlpha (double alpha_)
Reset the factor in front of the first term in the linear combination. More...

double GetAlpha () const
Return the factor in front of the first term in the linear combination. More...

void SetBeta (double beta_)
Reset the factor in front of the second term in the linear combination. More...

double GetBeta () const
Return the factor in front of the second term in the linear combination. 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 ()

Protected Attributes inherited from mfem::Coefficient
double time

## Detailed Description

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

Coefficients based on sums, products, or other functions of coefficients.

Definition at line 893 of file coefficient.hpp.

## Constructor & Destructor Documentation

 mfem::SumCoefficient::SumCoefficient ( double A, Coefficient & B, double alpha_ = 1.0, double beta_ = 1.0 )
inline

Constructor with one coefficient. Result is alpha_ * A + beta_ * B.

Definition at line 905 of file coefficient.hpp.

 mfem::SumCoefficient::SumCoefficient ( Coefficient & A, Coefficient & B, double alpha_ = 1.0, double beta_ = 1.0 )
inline

Constructor with two coefficients. Result is alpha_ * A + beta_ * B.

Definition at line 910 of file coefficient.hpp.

## Member Function Documentation

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

Evaluate the coefficient at ip.

Implements mfem::Coefficient.

Definition at line 940 of file coefficient.hpp.

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

Return the first term in the linear combination.

Definition at line 922 of file coefficient.hpp.

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

Return the first term in the linear combination.

Definition at line 917 of file coefficient.hpp.

 double mfem::SumCoefficient::GetAlpha ( ) const
inline

Return the factor in front of the first term in the linear combination.

Definition at line 932 of file coefficient.hpp.

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

Return the second term in the linear combination.

Definition at line 927 of file coefficient.hpp.

 double mfem::SumCoefficient::GetBeta ( ) const
inline

Return the factor in front of the second term in the linear combination.

Definition at line 937 of file coefficient.hpp.

 void mfem::SumCoefficient::SetACoef ( Coefficient & A )
inline

Reset the first term in the linear combination.

Definition at line 920 of file coefficient.hpp.

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

Reset the first term in the linear combination as a constant.

Definition at line 915 of file coefficient.hpp.

 void mfem::SumCoefficient::SetAlpha ( double alpha_ )
inline

Reset the factor in front of the first term in the linear combination.

Definition at line 930 of file coefficient.hpp.

 void mfem::SumCoefficient::SetBCoef ( Coefficient & B )
inline

Reset the second term in the linear combination.

Definition at line 925 of file coefficient.hpp.

 void mfem::SumCoefficient::SetBeta ( double beta_ )
inline

Reset the factor in front of the second term in the linear combination.

Definition at line 935 of file coefficient.hpp.

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