MFEM  v4.2.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
mfem::VectorSumCoefficient Class Reference

Vector coefficient defined as the linear combination of two vectors. More...

#include <coefficient.hpp>

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

Public Member Functions

 VectorSumCoefficient (int dim)
 
 VectorSumCoefficient (VectorCoefficient &A, VectorCoefficient &B, double _alpha=1.0, double _beta=1.0)
 
 VectorSumCoefficient (VectorCoefficient &_A, VectorCoefficient &_B, Coefficient &_alpha, Coefficient &_beta)
 
void SetACoef (VectorCoefficient &A)
 Reset the first vector coefficient. More...
 
VectorCoefficientGetACoef () const
 Return the first vector coefficient. More...
 
void SetBCoef (VectorCoefficient &B)
 Reset the second vector coefficient. More...
 
VectorCoefficientGetBCoef () const
 Return the second vector coefficient. More...
 
void SetAlphaCoef (Coefficient &A)
 Reset the factor in front of the first vector coefficient. More...
 
CoefficientGetAlphaCoef () const
 Return the factor in front of the first vector coefficient. More...
 
void SetBetaCoef (Coefficient &B)
 Reset the factor in front of the second vector coefficient. More...
 
CoefficientGetBetaCoef () const
 Return the factor in front of the second vector coefficient. More...
 
void SetA (const Vector &_A)
 Reset the first vector as a constant. More...
 
const VectorGetA () const
 Return the first vector constant. More...
 
void SetB (const Vector &_B)
 Reset the second vector as a constant. More...
 
const VectorGetB () const
 Return the second vector constant. More...
 
void SetAlpha (double _alpha)
 Reset the factor in front of the first vector coefficient as a constant. More...
 
double GetAlpha () const
 Return the factor in front of the first vector coefficient. More...
 
void SetBeta (double _beta)
 Reset the factor in front of the second vector coefficient as a constant. More...
 
double GetBeta () const
 Return the factor in front of the second vector coefficient. More...
 
virtual void Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)
 Evaluate the coefficient at ip. More...
 
- Public Member Functions inherited from mfem::VectorCoefficient
 VectorCoefficient (int vd)
 Initialize the VectorCoefficient with vector dimension vd. More...
 
void SetTime (double t)
 Set the time for time dependent coefficients. More...
 
double GetTime ()
 Get the time for time dependent coefficients. More...
 
int GetVDim ()
 Returns dimension of the vector. More...
 
virtual void Eval (DenseMatrix &M, ElementTransformation &T, const IntegrationRule &ir)
 Evaluate the vector coefficient in the element described by T at all points of ir, storing the result in M. More...
 
virtual ~VectorCoefficient ()
 

Additional Inherited Members

- Protected Attributes inherited from mfem::VectorCoefficient
int vdim
 
double time
 

Detailed Description

Vector coefficient defined as the linear combination of two vectors.

Definition at line 1146 of file coefficient.hpp.

Constructor & Destructor Documentation

mfem::VectorSumCoefficient::VectorSumCoefficient ( int  dim)

Constructor with no coefficients. To be used with the various "Set" methods

Definition at line 477 of file coefficient.cpp.

mfem::VectorSumCoefficient::VectorSumCoefficient ( VectorCoefficient A,
VectorCoefficient B,
double  _alpha = 1.0,
double  _beta = 1.0 
)

Constructor with two vector coefficients. Result is _alpha * A + _beta * B

Definition at line 487 of file coefficient.cpp.

mfem::VectorSumCoefficient::VectorSumCoefficient ( VectorCoefficient _A,
VectorCoefficient _B,
Coefficient _alpha,
Coefficient _beta 
)

Constructor with scalar coefficients. Result is _alpha * _A + _beta * _B

Definition at line 501 of file coefficient.cpp.

Member Function Documentation

void mfem::VectorSumCoefficient::Eval ( Vector V,
ElementTransformation T,
const IntegrationPoint ip 
)
virtual

Evaluate the coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 518 of file coefficient.cpp.

const Vector& mfem::VectorSumCoefficient::GetA ( ) const
inline

Return the first vector constant.

Definition at line 1201 of file coefficient.hpp.

VectorCoefficient* mfem::VectorSumCoefficient::GetACoef ( ) const
inline

Return the first vector coefficient.

Definition at line 1181 of file coefficient.hpp.

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

Return the factor in front of the first vector coefficient.

Definition at line 1211 of file coefficient.hpp.

Coefficient* mfem::VectorSumCoefficient::GetAlphaCoef ( ) const
inline

Return the factor in front of the first vector coefficient.

Definition at line 1191 of file coefficient.hpp.

const Vector& mfem::VectorSumCoefficient::GetB ( ) const
inline

Return the second vector constant.

Definition at line 1206 of file coefficient.hpp.

VectorCoefficient* mfem::VectorSumCoefficient::GetBCoef ( ) const
inline

Return the second vector coefficient.

Definition at line 1186 of file coefficient.hpp.

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

Return the factor in front of the second vector coefficient.

Definition at line 1216 of file coefficient.hpp.

Coefficient* mfem::VectorSumCoefficient::GetBetaCoef ( ) const
inline

Return the factor in front of the second vector coefficient.

Definition at line 1196 of file coefficient.hpp.

void mfem::VectorSumCoefficient::SetA ( const Vector _A)
inline

Reset the first vector as a constant.

Definition at line 1199 of file coefficient.hpp.

void mfem::VectorSumCoefficient::SetACoef ( VectorCoefficient A)
inline

Reset the first vector coefficient.

Definition at line 1179 of file coefficient.hpp.

void mfem::VectorSumCoefficient::SetAlpha ( double  _alpha)
inline

Reset the factor in front of the first vector coefficient as a constant.

Definition at line 1209 of file coefficient.hpp.

void mfem::VectorSumCoefficient::SetAlphaCoef ( Coefficient A)
inline

Reset the factor in front of the first vector coefficient.

Definition at line 1189 of file coefficient.hpp.

void mfem::VectorSumCoefficient::SetB ( const Vector _B)
inline

Reset the second vector as a constant.

Definition at line 1204 of file coefficient.hpp.

void mfem::VectorSumCoefficient::SetBCoef ( VectorCoefficient B)
inline

Reset the second vector coefficient.

Definition at line 1184 of file coefficient.hpp.

void mfem::VectorSumCoefficient::SetBeta ( double  _beta)
inline

Reset the factor in front of the second vector coefficient as a constant.

Definition at line 1214 of file coefficient.hpp.

void mfem::VectorSumCoefficient::SetBetaCoef ( Coefficient B)
inline

Reset the factor in front of the second vector coefficient.

Definition at line 1194 of file coefficient.hpp.


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