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

Scalar coefficient defined as the ratio of two scalars where one or both scalars are scalar coefficients. More...

#include <coefficient.hpp>

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

## Public Member Functions

RatioCoefficient (double A, Coefficient &B)

RatioCoefficient (Coefficient &A, Coefficient &B)

RatioCoefficient (Coefficient &A, double B)

void SetAConst (double A)
Reset the numerator in the ratio as a constant. More...

double GetAConst () const
Return the numerator of the ratio. More...

void SetBConst (double B)
Reset the denominator in the ratio as a constant. More...

double GetBConst () const
Return the denominator of the ratio. More...

void SetACoef (Coefficient &A)
Reset the numerator in the ratio. More...

CoefficientGetACoef () const
Return the numerator of the ratio. More...

void SetBCoef (Coefficient &B)
Reset the denominator in the ratio. More...

CoefficientGetBCoef () const
Return the denominator of the ratio. More...

virtual double Eval (ElementTransformation &T, const IntegrationPoint &ip)
Evaluate the coefficient. 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 ratio of two scalars where one or both scalars are scalar coefficients.

Definition at line 1089 of file coefficient.hpp.

## Constructor & Destructor Documentation

 mfem::RatioCoefficient::RatioCoefficient ( double A, Coefficient & B )
inline

Initialize a coefficient which returns A / B where A is a constant and B is a scalar coefficient

Definition at line 1100 of file coefficient.hpp.

 mfem::RatioCoefficient::RatioCoefficient ( Coefficient & A, Coefficient & B )
inline

Initialize a coefficient which returns A / B where A and B are both scalar coefficients

Definition at line 1104 of file coefficient.hpp.

 mfem::RatioCoefficient::RatioCoefficient ( Coefficient & A, double B )
inline

Initialize a coefficient which returns A / B where A is a scalar coefficient and B is a constant

Definition at line 1108 of file coefficient.hpp.

## Member Function Documentation

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

Evaluate the coefficient.

Implements mfem::Coefficient.

Definition at line 1132 of file coefficient.hpp.

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

Return the numerator of the ratio.

Definition at line 1124 of file coefficient.hpp.

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

Return the numerator of the ratio.

Definition at line 1114 of file coefficient.hpp.

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

Return the denominator of the ratio.

Definition at line 1129 of file coefficient.hpp.

 double mfem::RatioCoefficient::GetBConst ( ) const
inline

Return the denominator of the ratio.

Definition at line 1119 of file coefficient.hpp.

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

Reset the numerator in the ratio.

Definition at line 1122 of file coefficient.hpp.

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

Reset the numerator in the ratio as a constant.

Definition at line 1112 of file coefficient.hpp.

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

Reset the denominator in the ratio.

Definition at line 1127 of file coefficient.hpp.

 void mfem::RatioCoefficient::SetBConst ( double B )
inline

Reset the denominator in the ratio as a constant.

Definition at line 1117 of file coefficient.hpp.

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