A matrix coefficient with an optional scalar coefficient multiplier q. The matrix function can either be represented by a std function or a constant matrix provided when constructing this object. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::MatrixFunctionCoefficient:

[legend]

Collaboration diagram for mfem::MatrixFunctionCoefficient:

[legend]

Public Member Functions
	MatrixFunctionCoefficient (int dim, std::function< void(const Vector &, DenseMatrix &)> F, Coefficient *q=nullptr)
	Define a time-independent square matrix coefficient from a std function. More...

	MatrixFunctionCoefficient (const DenseMatrix &m, Coefficient &q)
	Define a constant matrix coefficient times a scalar Coefficient. More...

	MatrixFunctionCoefficient (int dim, std::function< void(const Vector &, double, DenseMatrix &)> TDF, Coefficient *q=nullptr)
	Define a time-dependent square matrix coefficient from a std function. More...

	MatrixFunctionCoefficient (int dim, std::function< void(const Vector &, Vector &)> SymmF, Coefficient *q=NULL)
	Define a time-independent symmetric square matrix coefficient from a std function. More...

virtual void	Eval (DenseMatrix &K, ElementTransformation &T, const IntegrationPoint &ip)
	Evaluate the matrix coefficient at ip. More...

virtual void	EvalSymmetric (Vector &K, ElementTransformation &T, const IntegrationPoint &ip)
	Evaluate the symmetric matrix coefficient at ip. More...

virtual	~MatrixFunctionCoefficient ()

Public Member Functions inherited from mfem::MatrixCoefficient
	MatrixCoefficient (int dim, bool symm=false)
	Construct a dim x dim matrix coefficient. More...

	MatrixCoefficient (int h, int w, bool symm=false)
	Construct a h x w matrix coefficient. More...

void	SetTime (double t)
	Set the time for time dependent coefficients. More...

double	GetTime ()
	Get the time for time dependent coefficients. More...

int	GetHeight () const
	Get the height of the matrix. More...

int	GetWidth () const
	Get the width of the matrix. More...

int	GetVDim () const
	For backward compatibility get the width of the matrix. More...

bool	IsSymmetric () const

virtual	~MatrixCoefficient ()

Additional Inherited Members
Protected Attributes inherited from mfem::MatrixCoefficient
int	height

int	width

double	time

bool	symmetric

Detailed Description

A matrix coefficient with an optional scalar coefficient multiplier q. The matrix function can either be represented by a std function or a constant matrix provided when constructing this object.

Definition at line 766 of file coefficient.hpp.

Constructor & Destructor Documentation

mfem::MatrixFunctionCoefficient::MatrixFunctionCoefficient	(	int	dim,
		std::function< void(const Vector &, DenseMatrix &)>	F,
		Coefficient *	q = `nullptr`
	)

inline

Define a time-independent square matrix coefficient from a std function.

Parameters

dim	- the size of the matrix
F	- time-independent function
q	- optional scalar Coefficient to scale the matrix coefficient

Definition at line 781 of file coefficient.hpp.

mfem::MatrixFunctionCoefficient::MatrixFunctionCoefficient	(	const DenseMatrix &	m,
		Coefficient &	q
	)

inline

Define a constant matrix coefficient times a scalar Coefficient.

Parameters

m	- constant matrix
q	- optional scalar Coefficient to scale the matrix coefficient

Definition at line 790 of file coefficient.hpp.

mfem::MatrixFunctionCoefficient::MatrixFunctionCoefficient	(	int	dim,
		std::function< void(const Vector &, double, DenseMatrix &)>	TDF,
		Coefficient *	q = `nullptr`
	)

inline

Define a time-dependent square matrix coefficient from a std function.

Parameters

dim	- the size of the matrix
TDF	- time-dependent function
q	- optional scalar Coefficient to scale the matrix coefficient

Definition at line 798 of file coefficient.hpp.

mfem::MatrixFunctionCoefficient::MatrixFunctionCoefficient	(	int	dim,
		std::function< void(const Vector &, Vector &)>	SymmF,
		Coefficient *	q = `NULL`
	)

inline

Define a time-independent symmetric square matrix coefficient from a std function.

Parameters

dim	- the size of the matrix
SymmF	- function used in EvalSymmetric
q	- optional scalar Coefficient to scale the matrix coefficient

Definition at line 809 of file coefficient.hpp.

virtual mfem::MatrixFunctionCoefficient::~MatrixFunctionCoefficient ( )

inlinevirtual

Definition at line 823 of file coefficient.hpp.

Member Function Documentation

void mfem::MatrixFunctionCoefficient::Eval	(	DenseMatrix &	K,
		ElementTransformation &	T,
		const IntegrationPoint &	ip
	)

virtual

Evaluate the matrix coefficient at ip.

Implements mfem::MatrixCoefficient.

Definition at line 294 of file coefficient.cpp.

void mfem::MatrixFunctionCoefficient::EvalSymmetric	(	Vector &	K,
		ElementTransformation &	T,
		const IntegrationPoint &	ip
	)

virtual

Evaluate the symmetric matrix coefficient at ip.

Reimplemented from mfem::MatrixCoefficient.

Definition at line 349 of file coefficient.cpp.

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

fem/coefficient.hpp
fem/coefficient.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation