Moose::MFEM::CoefficientManager Class Reference

Front-end class for creating and storing MFEM coefficients. More...

#include <CoefficientManager.h>

Public Member Functions
	CoefficientManager ()=default
mfem::Coefficient &	declareScalar (const std::string &name, const std::string &existing_or_literal)
	Declare an alias to an existing scalar coefficient or, if it does not exist, try interpreting the name as a number with which to create a new constant coefficient. More...
template<class P , class... Args>
P &	declareScalar (const std::string &name, Args &&... args)
	Create a new scalar coefficient, constructed from the argument pack. More...
mfem::Coefficient &	declareScalarProperty (const std::string &name, const std::vector< std::string > &blocks, const std::string &existing_or_literal)
	Use an existing scalar coefficient for a property on some blocks of the mesh. More...
template<class P , class... Args>
mfem::Coefficient &	declareScalarProperty (const std::string &name, const std::vector< std::string > &blocks, Args &&... args)
	Use a new scalar coefficient, constructed from the argument pack, for a property on some blocks of the mesh. More...
mfem::VectorCoefficient &	declareVector (const std::string &name, const std::string &existing_or_literal)
	Declare an alias to an existing vector coefficientor or, if it does not exist, try interpreting the name as a vector of numbers with which to create a new constant vector coefficient. More...
template<class P , class... Args>
P &	declareVector (const std::string &name, Args &&... args)
	Create a new vector coefficient, constructed from the argument pack. More...
mfem::VectorCoefficient &	declareVectorProperty (const std::string &name, const std::vector< std::string > &blocks, const std::string &existing_or_literal)
	Use an existing vector coefficient for a property on some blocks of the mesh. More...
template<class P , class... Args>
mfem::VectorCoefficient &	declareVectorProperty (const std::string &name, const std::vector< std::string > &blocks, Args &&... args)
	Use a new vector coefficient, constructed from the argument pack, for a property on some blocks of the mesh. More...
mfem::MatrixCoefficient &	declareMatrix (const std::string &name, const std::string &existing_coef)
	Declare an alias to an existing matrix coefficient. More...
template<class P , class... Args>
P &	declareMatrix (const std::string &name, Args &&... args)
	Create a new matrix coefficient, constructed from the argument pack. More...
mfem::MatrixCoefficient &	declareMatrixProperty (const std::string &name, const std::vector< std::string > &blocks, const std::string &existing_coef)
	Use an existing matrix coefficient for a property on some blocks of the mesh. More...
template<class P , class... Args>
mfem::MatrixCoefficient &	declareMatrixProperty (const std::string &name, const std::vector< std::string > &blocks, Args &&... args)
	Use a new matrix coefficient, constructed from the argument pack, for a property on some blocks of the mesh. More...
mfem::Coefficient &	getScalarCoefficient (const std::string &name)
	Return a scalar coefficient with the given name or, if that doesn't exists, try interpreting the name as a number with which to build a new constant coefficient. More...
mfem::VectorCoefficient &	getVectorCoefficient (const std::string &name)
	Return a vector coefficient with the given name or, if that doesn't exists, try interpreting the name as a vector of number with which to build a new constant vector coefficient. More...
mfem::MatrixCoefficient &	getMatrixCoefficient (const std::string &name)
	Return scalar coefficient with the given name. More...
bool	scalarPropertyIsDefined (const std::string &name, const std::string &block) const
bool	vectorPropertyIsDefined (const std::string &name, const std::string &block) const
bool	matrixPropertyIsDefined (const std::string &name, const std::string &block) const
void	setTime (const double time)

Private Member Functions
mfem::Coefficient &	declareScalar (const std::string &name, std::shared_ptr< mfem::Coefficient > coef)
mfem::Coefficient &	declareScalarProperty (const std::string &name, const std::vector< std::string > &blocks, std::shared_ptr< mfem::Coefficient > coef)
mfem::VectorCoefficient &	declareVector (const std::string &name, std::shared_ptr< mfem::VectorCoefficient > coef)
mfem::VectorCoefficient &	declareVectorProperty (const std::string &name, const std::vector< std::string > &blocks, std::shared_ptr< mfem::VectorCoefficient > coef)
mfem::MatrixCoefficient &	declareMatrix (const std::string &name, std::shared_ptr< mfem::MatrixCoefficient > coef)
mfem::MatrixCoefficient &	declareMatrixProperty (const std::string &name, const std::vector< std::string > &blocks, std::shared_ptr< mfem::MatrixCoefficient > coef)
std::shared_ptr< mfem::Coefficient >	getScalarCoefficientPtr (const std::string &name)
std::shared_ptr< mfem::VectorCoefficient >	getVectorCoefficientPtr (const std::string &name)
std::shared_ptr< mfem::MatrixCoefficient >	getMatrixCoefficientPtr (const std::string &name)

Private Attributes
ScalarMap	_scalar_coeffs
VectorMap	_vector_coeffs
MatrixMap	_matrix_coeffs

Detailed Description

Front-end class for creating and storing MFEM coefficients.

They can be created so they are global (defined across the entire domain) or as piecewise material properties.

Definition at line 35 of file CoefficientManager.h.

Constructor & Destructor Documentation

CoefficientManager()

Moose::MFEM::CoefficientManager::CoefficientManager ( )

default

Member Function Documentation

declareMatrix() [1/3]

mfem::MatrixCoefficient & Moose::MFEM::CoefficientManager::declareMatrix	(	const std::string &	name,
		const std::string &	existing_coef
	)

Declare an alias to an existing matrix coefficient.

Unlike for the scalar and vector counterparts, there is currently no way to try interpreting the name as numbers with which to construct a constant matrix coefficient.

Definition at line 96 of file CoefficientManager.C.

Referenced by declareMatrix().

{
  return this->declareMatrix(name, this->getMatrixCoefficientPtr(existing_coef));
}

declareMatrix() [2/3]

template<class P , class... Args>

P& Moose::MFEM::CoefficientManager::declareMatrix ( const std::string &  name, Args &&...  args  )

inline

Create a new matrix coefficient, constructed from the argument pack.

Definition at line 125 of file CoefficientManager.h.

  {
    auto coef = _matrix_coeffs.make<P>(args...);
    this->declareMatrix(name, coef);
    return *coef;
  }

declareMatrix() [3/3]

mfem::MatrixCoefficient & Moose::MFEM::CoefficientManager::declareMatrix ( const std::string &  name, std::shared_ptr< mfem::MatrixCoefficient >  coef  )

private

Definition at line 88 of file CoefficientManager.C.

{
  this->_matrix_coeffs.addCoefficient(name, coef);
  return *coef;
}

declareMatrixProperty() [1/3]

mfem::MatrixCoefficient & Moose::MFEM::CoefficientManager::declareMatrixProperty	(	const std::string &	name,
		const std::vector< std::string > &	blocks,
		const std::string &	existing_coef
	)

Use an existing matrix coefficient for a property on some blocks of the mesh.

The property will be a piecewise coefficient and it will have the value of existing_coef on these blocks. Unlike for the scalar and vector counterparts, there is currently no way to try interpreting the name as numbers with which to construct a constant matrix coefficient.

Definition at line 111 of file CoefficientManager.C.

Referenced by declareMatrixProperty().

{
  std::shared_ptr<mfem::MatrixCoefficient> coef = this->getMatrixCoefficientPtr(existing_coef);
  if (std::dynamic_pointer_cast<mfem::PWMatrixCoefficient>(coef))
    mooseError("Properties must not be defined out of other properties or piecewise coefficients.");
  return this->declareMatrixProperty(name, blocks, coef);
}

declareMatrixProperty() [2/3]

template<class P , class... Args>

mfem::MatrixCoefficient& Moose::MFEM::CoefficientManager::declareMatrixProperty ( const std::string &  name, const std::vector< std::string > &  blocks, Args &&...  args  )

inline

Use a new matrix coefficient, constructed from the argument pack, for a property on some blocks of the mesh.

The property will be a piecewise coefficient and it will have the value of the new coefficient on these blocks.

Definition at line 150 of file CoefficientManager.h.

  {
    return this->declareMatrixProperty(name, blocks, _matrix_coeffs.make<P>(args...));
  }

declareMatrixProperty() [3/3]

mfem::MatrixCoefficient & Moose::MFEM::CoefficientManager::declareMatrixProperty ( const std::string &  name, const std::vector< std::string > &  blocks, std::shared_ptr< mfem::MatrixCoefficient >  coef  )

private

Definition at line 102 of file CoefficientManager.C.

{
  this->_matrix_coeffs.addPiecewiseBlocks(name, coef, blocks);
  return getMatrixCoefficient(name);
}

declareScalar() [1/3]

mfem::Coefficient & Moose::MFEM::CoefficientManager::declareScalar	(	const std::string &	name,
		const std::string &	existing_or_literal
	)

Declare an alias to an existing scalar coefficient or, if it does not exist, try interpreting the name as a number with which to create a new constant coefficient.

Definition at line 27 of file CoefficientManager.C.

Referenced by MFEMProblem::addFunction(), MFEMProblem::addGridFunction(), MFEMProblem::addPostprocessor(), and declareScalar().

{
  return this->declareScalar(name, this->getScalarCoefficientPtr(existing_or_literal));
}

declareScalar() [2/3]

template<class P , class... Args>

P& Moose::MFEM::CoefficientManager::declareScalar ( const std::string &  name, Args &&...  args  )

inline

Create a new scalar coefficient, constructed from the argument pack.

Definition at line 47 of file CoefficientManager.h.

  {
    auto coef = _scalar_coeffs.make<P>(args...);
    this->declareScalar(name, coef);
    return *coef;
  }

declareScalar() [3/3]

mfem::Coefficient & Moose::MFEM::CoefficientManager::declareScalar ( const std::string &  name, std::shared_ptr< mfem::Coefficient >  coef  )

private

Definition at line 20 of file CoefficientManager.C.

{
  this->_scalar_coeffs.addCoefficient(name, coef);
  return *coef;
}

declareScalarProperty() [1/3]

mfem::Coefficient & Moose::MFEM::CoefficientManager::declareScalarProperty	(	const std::string &	name,
		const std::vector< std::string > &	blocks,
		const std::string &	existing_or_literal
	)

Use an existing scalar coefficient for a property on some blocks of the mesh.

The property will be a piecewise coefficient and it will have the value of existing_coef on these blocks. If no such scalar coefficient exists, try interpreting the name as a number with which to create a new constant coefficient.

Definition at line 42 of file CoefficientManager.C.

Referenced by declareScalarProperty(), and MFEMGenericFunctorMaterial::MFEMGenericFunctorMaterial().

{
  std::shared_ptr<mfem::Coefficient> coef = this->getScalarCoefficientPtr(existing_or_literal);
  if (std::dynamic_pointer_cast<mfem::PWCoefficient>(coef))
    mooseError("Properties must not be defined out of other properties or piecewise coefficients.");
  return this->declareScalarProperty(name, blocks, coef);
}

declareScalarProperty() [2/3]

template<class P , class... Args>

mfem::Coefficient& Moose::MFEM::CoefficientManager::declareScalarProperty ( const std::string &  name, const std::vector< std::string > &  blocks, Args &&...  args  )

inline

Use a new scalar coefficient, constructed from the argument pack, for a property on some blocks of the mesh.

The property will be a piecewise coefficient and it will have the value of the new coefficient on these blocks.

Definition at line 71 of file CoefficientManager.h.

  {
    return this->declareScalarProperty(name, blocks, _scalar_coeffs.make<P>(args...));
  }

declareScalarProperty() [3/3]

mfem::Coefficient & Moose::MFEM::CoefficientManager::declareScalarProperty ( const std::string &  name, const std::vector< std::string > &  blocks, std::shared_ptr< mfem::Coefficient >  coef  )

private

Definition at line 33 of file CoefficientManager.C.

{
  this->_scalar_coeffs.addPiecewiseBlocks(name, coef, blocks);
  return getScalarCoefficient(name);
}

declareVector() [1/3]

mfem::VectorCoefficient & Moose::MFEM::CoefficientManager::declareVector	(	const std::string &	name,
		const std::string &	existing_or_literal
	)

Declare an alias to an existing vector coefficientor or, if it does not exist, try interpreting the name as a vector of numbers with which to create a new constant vector coefficient.

Definition at line 61 of file CoefficientManager.C.

Referenced by MFEMProblem::addFunction(), MFEMProblem::addGridFunction(), and declareVector().

{
  return this->declareVector(name, this->getVectorCoefficientPtr(existing_or_literal));
}

declareVector() [2/3]

template<class P , class... Args>

P& Moose::MFEM::CoefficientManager::declareVector ( const std::string &  name, Args &&...  args  )

inline

Create a new vector coefficient, constructed from the argument pack.

Definition at line 85 of file CoefficientManager.h.

  {
    auto coef = _vector_coeffs.make<P>(args...);
    this->declareVector(name, coef);
    return *coef;
  }

declareVector() [3/3]

mfem::VectorCoefficient & Moose::MFEM::CoefficientManager::declareVector ( const std::string &  name, std::shared_ptr< mfem::VectorCoefficient >  coef  )

private

Definition at line 53 of file CoefficientManager.C.

{
  this->_vector_coeffs.addCoefficient(name, coef);
  return *coef;
}

declareVectorProperty() [1/3]

mfem::VectorCoefficient & Moose::MFEM::CoefficientManager::declareVectorProperty	(	const std::string &	name,
		const std::vector< std::string > &	blocks,
		const std::string &	existing_or_literal
	)

Use an existing vector coefficient for a property on some blocks of the mesh.

The property will be a piecewise coefficient and it will have the value of existing_coef on these blocks. If no such vector coefficient exists, try interpreting the name as a vector of numbers with which to create a new constant vector coefficient.

Definition at line 76 of file CoefficientManager.C.

Referenced by declareVectorProperty(), and MFEMGenericFunctorVectorMaterial::MFEMGenericFunctorVectorMaterial().

{
  std::shared_ptr<mfem::VectorCoefficient> coef =
      this->getVectorCoefficientPtr(existing_or_literal);
  if (std::dynamic_pointer_cast<mfem::PWVectorCoefficient>(coef))
    mooseError("Properties must not be defined out of other properties or piecewise coefficients.");
  return this->declareVectorProperty(name, blocks, coef);
}

declareVectorProperty() [2/3]

template<class P , class... Args>

mfem::VectorCoefficient& Moose::MFEM::CoefficientManager::declareVectorProperty ( const std::string &  name, const std::vector< std::string > &  blocks, Args &&...  args  )

inline

Use a new vector coefficient, constructed from the argument pack, for a property on some blocks of the mesh.

The property will be a piecewise coefficient and it will have the value of the new coefficient on these blocks.

Definition at line 110 of file CoefficientManager.h.

  {
    return this->declareVectorProperty(name, blocks, _vector_coeffs.make<P>(args...));
  }

declareVectorProperty() [3/3]

mfem::VectorCoefficient & Moose::MFEM::CoefficientManager::declareVectorProperty ( const std::string &  name, const std::vector< std::string > &  blocks, std::shared_ptr< mfem::VectorCoefficient >  coef  )

private

Definition at line 67 of file CoefficientManager.C.

{
  this->_vector_coeffs.addPiecewiseBlocks(name, coef, blocks);
  return getVectorCoefficient(name);
}

getMatrixCoefficient()

mfem::MatrixCoefficient & Moose::MFEM::CoefficientManager::getMatrixCoefficient

(

const std::string &

name

)

Return scalar coefficient with the given name.

Unlike for the scalar and vector counterparts, there is currently no way to try interpreting the name as numbers with which to construct a constant matrix coefficient.

Definition at line 173 of file CoefficientManager.C.

Referenced by declareMatrixProperty(), and MFEMGeneralUserObject::getMatrixCoefficient().

{
  return *this->getMatrixCoefficientPtr(name);
}

getMatrixCoefficientPtr()

std::shared_ptr< mfem::MatrixCoefficient > Moose::MFEM::CoefficientManager::getMatrixCoefficientPtr ( const std::string &  name )

private

Definition at line 154 of file CoefficientManager.C.

Referenced by declareMatrix(), declareMatrixProperty(), and getMatrixCoefficient().

{
  return this->_matrix_coeffs.getCoefficientPtr(name);
  // TODO: Work out how to parse literal matrices from input.
}

getScalarCoefficient()

mfem::Coefficient & Moose::MFEM::CoefficientManager::getScalarCoefficient

(

const std::string &

name

)

Return a scalar coefficient with the given name or, if that doesn't exists, try interpreting the name as a number with which to build a new constant coefficient.

Definition at line 161 of file CoefficientManager.C.

Referenced by declareScalarProperty(), and MFEMGeneralUserObject::getScalarCoefficient().

{
  return *this->getScalarCoefficientPtr(name);
}

getScalarCoefficientPtr()

std::shared_ptr< mfem::Coefficient > Moose::MFEM::CoefficientManager::getScalarCoefficientPtr ( const std::string &  name )

private

Definition at line 122 of file CoefficientManager.C.

Referenced by declareScalar(), declareScalarProperty(), and getScalarCoefficient().

{
  if (this->_scalar_coeffs.hasCoefficient(name))
    return this->_scalar_coeffs.getCoefficientPtr(name);
  // If name not present, check if it can be parsed cleanly into a real number
  std::istringstream ss(MooseUtils::trim(name));
  mfem::real_t real_value;
  if (ss >> real_value && ss.eof())
  {
    this->declareScalar<mfem::ConstantCoefficient>(name, real_value);
    return this->_scalar_coeffs.getCoefficientPtr(name);
  }
  mooseError("Scalar coefficient with name '" + name + "' has not been declared.");
}

getVectorCoefficient()

mfem::VectorCoefficient & Moose::MFEM::CoefficientManager::getVectorCoefficient

(

const std::string &

name

)

Return a vector coefficient with the given name or, if that doesn't exists, try interpreting the name as a vector of number with which to build a new constant vector coefficient.

Definition at line 167 of file CoefficientManager.C.

Referenced by declareVectorProperty(), and MFEMGeneralUserObject::getVectorCoefficient().

{
  return *this->getVectorCoefficientPtr(name);
}

getVectorCoefficientPtr()

std::shared_ptr< mfem::VectorCoefficient > Moose::MFEM::CoefficientManager::getVectorCoefficientPtr ( const std::string &  name )

private

Definition at line 138 of file CoefficientManager.C.

Referenced by declareVector(), declareVectorProperty(), and getVectorCoefficient().

{
  if (this->_vector_coeffs.hasCoefficient(name))
    return this->_vector_coeffs.getCoefficientPtr(name);
  // If name not present, check if it can be parsed cleanly into a vector of real numbers
  std::vector<mfem::real_t> vec_values;
  if (MooseUtils::tokenizeAndConvert(name, vec_values) && vec_values.size() > 0)
  {
    this->declareVector<mfem::VectorConstantCoefficient>(
        name, mfem::Vector(vec_values.data(), vec_values.size()));
    return this->_vector_coeffs.getCoefficientPtr(name);
  }
  mooseError("Vector coefficient with name '" + name + "' has not been declared.");
}

matrixPropertyIsDefined()

bool Moose::MFEM::CoefficientManager::matrixPropertyIsDefined	(	const std::string &	name,
		const std::string &	block
	)		const

Definition at line 193 of file CoefficientManager.C.

{
  return this->_matrix_coeffs.propertyDefinedOnBlock(name, block);
}

scalarPropertyIsDefined()

bool Moose::MFEM::CoefficientManager::scalarPropertyIsDefined	(	const std::string &	name,
		const std::string &	block
	)		const

Definition at line 179 of file CoefficientManager.C.

{
  return this->_scalar_coeffs.propertyDefinedOnBlock(name, block);
}

setTime()

void Moose::MFEM::CoefficientManager::setTime

(

const double

time

)

Definition at line 200 of file CoefficientManager.C.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve().

{
  this->_scalar_coeffs.setTime(time);
  this->_vector_coeffs.setTime(time);
  this->_matrix_coeffs.setTime(time);
}

vectorPropertyIsDefined()

bool Moose::MFEM::CoefficientManager::vectorPropertyIsDefined	(	const std::string &	name,
		const std::string &	block
	)		const

Definition at line 186 of file CoefficientManager.C.

{
  return this->_vector_coeffs.propertyDefinedOnBlock(name, block);
}

Member Data Documentation

_matrix_coeffs

MatrixMap Moose::MFEM::CoefficientManager::_matrix_coeffs

private

Definition at line 181 of file CoefficientManager.h.

Referenced by declareMatrix(), declareMatrixProperty(), getMatrixCoefficientPtr(), matrixPropertyIsDefined(), and setTime().

_scalar_coeffs

ScalarMap Moose::MFEM::CoefficientManager::_scalar_coeffs

private

Definition at line 179 of file CoefficientManager.h.

Referenced by declareScalar(), declareScalarProperty(), getScalarCoefficientPtr(), scalarPropertyIsDefined(), and setTime().

_vector_coeffs

VectorMap Moose::MFEM::CoefficientManager::_vector_coeffs

private

Definition at line 180 of file CoefficientManager.h.

Referenced by declareVector(), declareVectorProperty(), getVectorCoefficientPtr(), setTime(), and vectorPropertyIsDefined().

---

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

• include/mfem/utils/CoefficientManager.h
• src/mfem/utils/CoefficientManager.C