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:

Collaboration diagram for mfem::RatioCoefficient:

Public Member Functions
	RatioCoefficient (real_t A, Coefficient &B)
	RatioCoefficient (Coefficient &A, Coefficient &B)
	RatioCoefficient (Coefficient &A, real_t B)
void	SetTime (real_t t) override
	Set the time for internally stored coefficients.
void	Project (QuadratureFunction &qf) override
	Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points.
void	SetAConst (real_t A)
	Reset the numerator in the ratio as a constant.
real_t	GetAConst () const
	Return the numerator of the ratio.
void	SetBConst (real_t B)
	Reset the denominator in the ratio as a constant.
real_t	GetBConst () const
	Return the denominator of the ratio.
void	SetACoef (Coefficient &A)
	Reset the numerator in the ratio.
Coefficient *	GetACoef () const
	Return the numerator of the ratio.
void	SetBCoef (Coefficient &B)
	Reset the denominator in the ratio.
Coefficient *	GetBCoef () const
	Return the denominator of the ratio.
real_t	Eval (ElementTransformation &T, const IntegrationPoint &ip) override
	Evaluate the coefficient.
Public Member Functions inherited from mfem::Coefficient
	Coefficient ()
real_t	GetTime ()
	Get the time for time dependent coefficients.
real_t	Eval (ElementTransformation &T, const IntegrationPoint &ip, real_t t)
	Evaluate the coefficient in the element described by T at the point ip at time t.
virtual	~Coefficient ()

Additional Inherited Members
Protected Attributes inherited from mfem::Coefficient
real_t	time

Detailed Description

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

Definition at line 1669 of file coefficient.hpp.

Constructor & Destructor Documentation

RatioCoefficient() [1/3]

mfem::RatioCoefficient::RatioCoefficient ( real_t 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 1680 of file coefficient.hpp.

RatioCoefficient() [2/3]

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 1684 of file coefficient.hpp.

RatioCoefficient() [3/3]

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

inline

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

Definition at line 1688 of file coefficient.hpp.

Member Function Documentation

Eval()

real_t mfem::RatioCoefficient::Eval ( ElementTransformation & T, const IntegrationPoint & ip )

inlineoverridevirtual

Evaluate the coefficient.

Implements mfem::Coefficient.

Definition at line 1718 of file coefficient.hpp.

GetACoef()

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

inline

Return the numerator of the ratio.

Definition at line 1710 of file coefficient.hpp.

GetAConst()

real_t mfem::RatioCoefficient::GetAConst ( ) const

inline

Return the numerator of the ratio.

Definition at line 1700 of file coefficient.hpp.

GetBCoef()

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

inline

Return the denominator of the ratio.

Definition at line 1715 of file coefficient.hpp.

GetBConst()

real_t mfem::RatioCoefficient::GetBConst ( ) const

inline

Return the denominator of the ratio.

Definition at line 1705 of file coefficient.hpp.

Project()

void mfem::RatioCoefficient::Project ( QuadratureFunction & qf )

overridevirtual

Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points.

Reimplemented from mfem::Coefficient.

Definition at line 1142 of file coefficient.cpp.

SetACoef()

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

inline

Reset the numerator in the ratio.

Definition at line 1708 of file coefficient.hpp.

SetAConst()

void mfem::RatioCoefficient::SetAConst ( real_t A )

inline

Reset the numerator in the ratio as a constant.

Definition at line 1698 of file coefficient.hpp.

SetBCoef()

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

inline

Reset the denominator in the ratio.

Definition at line 1713 of file coefficient.hpp.

SetBConst()

void mfem::RatioCoefficient::SetBConst ( real_t B )

inline

Reset the denominator in the ratio as a constant.

Definition at line 1703 of file coefficient.hpp.

SetTime()

void mfem::RatioCoefficient::SetTime ( real_t t )

overridevirtual

Set the time for internally stored coefficients.

Reimplemented from mfem::Coefficient.

Definition at line 1135 of file coefficient.cpp.

---

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

• fem/coefficient.hpp
• fem/coefficient.cpp