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...

Coefficient *	GetACoef () const
	Return the first term in the linear combination. More...

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

Coefficient *	GetBCoef () 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 ()

Additional Inherited Members
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 888 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 900 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 905 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 935 of file coefficient.hpp.

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

inline

Return the first term in the linear combination.

Definition at line 917 of file coefficient.hpp.

double mfem::SumCoefficient::GetAConst ( ) const

inline

Return the first term in the linear combination.

Definition at line 912 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 927 of file coefficient.hpp.

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

inline

Return the second term in the linear combination.

Definition at line 922 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 932 of file coefficient.hpp.

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

inline

Reset the first term in the linear combination.

Definition at line 915 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 910 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 925 of file coefficient.hpp.

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

inline

Reset the second term in the linear combination.

Definition at line 920 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 930 of file coefficient.hpp.

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

fem/coefficient.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation