Moose::MFEM::CoefficientMap< T, Tpw > Class Template Reference

Class to manage MFEM coefficient objects representing material properties. More...

#include <CoefficientMap.h>

Public Member Functions
	CoefficientMap ()=default
template<class P , class... Args>
std::shared_ptr< P >	make (Args &&... args)
	Make arbitrary coefficients which will be tracked by this object. More...
void	addCoefficient (const std::string &name, std::shared_ptr< T > coeff)
	Add a named global coefficient. More...
void	addPiecewiseBlocks (const std::string &name, std::shared_ptr< T > coeff, const std::vector< std::string > &blocks)
	Add piecewise material property. More...
T &	getCoefficient (const std::string &name)
std::shared_ptr< T >	getCoefficientPtr (const std::string &name)
bool	hasCoefficient (const std::string &name) const
bool	propertyDefinedOnBlock (const std::string &name, const std::string &block) const
void	setTime (const mfem::real_t time)
template<class F >
void	apply (F &&func)
	Apply a function to every coefficient created by this map. More...

Private Types
using	PWData = std::tuple< std::shared_ptr< Tpw >, std::map< const std::string, std::shared_ptr< T > >>

Private Member Functions
PWData	emptyPWData (std::shared_ptr< T >)
void	checkPWData (std::shared_ptr< T >, std::shared_ptr< Tpw >, const std::string &)

Private Attributes
std::map< const std::string, std::variant< std::shared_ptr< T >, PWData > >	_coefficients
std::vector< std::shared_ptr< T > >	_iterable_coefficients

Detailed Description

template<class T, class Tpw>
class Moose::MFEM::CoefficientMap< T, Tpw >

Class to manage MFEM coefficient objects representing material properties.

It can build up piecewise coefficients representing properties defined across multiple materials.

Definition at line 35 of file CoefficientMap.h.

Member Typedef Documentation

PWData

template<class T, class Tpw>

using Moose::MFEM::CoefficientMap< T, Tpw >::PWData = std::tuple<std::shared_ptr<Tpw>, std::map<const std::string, std::shared_ptr<T> >>

private

Definition at line 155 of file CoefficientMap.h.

Constructor & Destructor Documentation

CoefficientMap()

template<class T, class Tpw>

Moose::MFEM::CoefficientMap< T, Tpw >::CoefficientMap ( )

default

Member Function Documentation

addCoefficient()

template<class T, class Tpw>

void Moose::MFEM::CoefficientMap< T, Tpw >::addCoefficient ( const std::string &  name, std::shared_ptr< T >  coeff  )

inline

Add a named global coefficient.

It must have been created with the make method on this object.

Definition at line 51 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::addPiecewiseBlocks(), Moose::MFEM::CoefficientManager::declareMatrix(), Moose::MFEM::CoefficientManager::declareScalar(), and Moose::MFEM::CoefficientManager::declareVector().

  {
    mooseAssert(std::find(this->_iterable_coefficients.cbegin(),
                          this->_iterable_coefficients.cend(),
                          coeff) != this->_iterable_coefficients.cend(),
                "Coefficient object was not created by this CoefficientMap.");

    const auto [_, inserted] = this->_coefficients.emplace(name, std::move(coeff));
    if (!inserted)
      mooseError("Coefficient with name '" + name + "' already present in CoefficientMap object");
  }

addPiecewiseBlocks()

template<class T, class Tpw>

void Moose::MFEM::CoefficientMap< T, Tpw >::addPiecewiseBlocks ( const std::string &  name, std::shared_ptr< T >  coeff, const std::vector< std::string > &  blocks  )

inline

Add piecewise material property.

The coefficient must have been created with the make method on this object.

Note: If you attempt to overwrite an existing block then an exception will be thrown and data for that property will be left in an undefined state.

Definition at line 67 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientManager::declareMatrixProperty(), Moose::MFEM::CoefficientManager::declareScalarProperty(), and Moose::MFEM::CoefficientManager::declareVectorProperty().

  {
    // If list of blocks is empty then treat as a global coefficient
    if (blocks.size() == 0)
    {
      this->addCoefficient(name, coeff);
      return;
    }

    // Initialise property with empty coefficients, if it does not already exist
    if (!this->hasCoefficient(name))
      this->_coefficients.insert({name, this->emptyPWData(coeff)});
    PWData * data = std::get_if<PWData>(&this->_coefficients[name]);
    // Throw an exception if the data is not piecewise
    if (!data)
      mooseError("Global coefficient with name '" + name + "' already present in CoefficientMap");
    mooseAssert(std::find(this->_iterable_coefficients.cbegin(),
                          this->_iterable_coefficients.cend(),
                          coeff) != this->_iterable_coefficients.cend(),
                "Coefficient object was not created by the appropriate coefficient manager.");
    auto & [pw_coeff, coeff_map] = *data;
    this->checkPWData(coeff, pw_coeff, name);

    for (const auto & block : blocks)
    {
      if (coeff_map.count(block) > 0)
        mooseError("Property with name '" + name + "' already assigned to block " + block +
                   " in CoefficientMap object");
      coeff_map[block] = coeff;
      pw_coeff->UpdateCoefficient(std::stoi(block), *coeff);
    }
  }

apply()

template<class T, class Tpw>

template<class F >

void Moose::MFEM::CoefficientMap< T, Tpw >::apply ( F &&  func )

inline

Apply a function to every coefficient created by this map.

Definition at line 148 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientManager::markSolutionChanged().

  {
    for (auto & coef : this->_iterable_coefficients)
      func(*coef);
  }

checkPWData()

template<class T, class Tpw>

void Moose::MFEM::CoefficientMap< T, Tpw >::checkPWData ( std::shared_ptr< T >  , std::shared_ptr< Tpw >  , const std::string &    )

inlineprivate

Definition at line 164 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::addPiecewiseBlocks().

  {
  }

emptyPWData()

template<class T, class Tpw>

PWData Moose::MFEM::CoefficientMap< T, Tpw >::emptyPWData ( std::shared_ptr< T >  )

inlineprivate

Definition at line 159 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::addPiecewiseBlocks().

  {
    return std::make_tuple(this->template make<Tpw>(),
                           std::map<const std::string, std::shared_ptr<T>>());
  }

getCoefficient()

template<class T, class Tpw>

T& Moose::MFEM::CoefficientMap< T, Tpw >::getCoefficient ( const std::string &  name )

inline

Definition at line 102 of file CoefficientMap.h.

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

getCoefficientPtr()

template<class T, class Tpw>

std::shared_ptr<T> Moose::MFEM::CoefficientMap< T, Tpw >::getCoefficientPtr ( const std::string &  name )

inline

Definition at line 104 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::getCoefficient(), Moose::MFEM::CoefficientManager::getMatrixCoefficientPtr(), Moose::MFEM::CoefficientManager::getScalarCoefficientPtr(), and Moose::MFEM::CoefficientManager::getVectorCoefficientPtr().

  {
    try
    {
      auto & coeff = this->_coefficients.at(name);
      try
      {
        return std::get<std::shared_ptr<T>>(coeff);
      }
      catch (const std::bad_variant_access &)
      {
        return std::get<0>(std::get<PWData>(coeff));
      }
    }
    catch (const std::out_of_range &)
    {
      mooseError("Property with name '" + name + "' has not been declared.");
    }
  }

hasCoefficient()

template<class T, class Tpw>

bool Moose::MFEM::CoefficientMap< T, Tpw >::hasCoefficient ( const std::string &  name ) const

inline

Definition at line 124 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::addPiecewiseBlocks(), Moose::MFEM::CoefficientManager::getScalarCoefficientPtr(), Moose::MFEM::CoefficientManager::getVectorCoefficientPtr(), and Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::propertyDefinedOnBlock().

  {
    return this->_coefficients.count(name) > 0;
  }

make()

template<class T, class Tpw>

template<class P , class... Args>

std::shared_ptr<P> Moose::MFEM::CoefficientMap< T, Tpw >::make ( Args &&...  args )

inline

Make arbitrary coefficients which will be tracked by this object.

Definition at line 42 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientManager::declareMatrix(), Moose::MFEM::CoefficientManager::declareMatrixProperty(), Moose::MFEM::CoefficientManager::declareScalar(), Moose::MFEM::CoefficientManager::declareScalarProperty(), Moose::MFEM::CoefficientManager::declareVector(), and Moose::MFEM::CoefficientManager::declareVectorProperty().

  {
    auto result = std::make_shared<P>(args...);
    this->_iterable_coefficients.push_back(result);
    return result;
  }

propertyDefinedOnBlock()

template<class T, class Tpw>

bool Moose::MFEM::CoefficientMap< T, Tpw >::propertyDefinedOnBlock ( const std::string &  name, const std::string &  block  ) const

inline

Definition at line 129 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientManager::matrixPropertyIsDefined(), Moose::MFEM::CoefficientManager::scalarPropertyIsDefined(), and Moose::MFEM::CoefficientManager::vectorPropertyIsDefined().

  {
    if (!this->hasCoefficient(name))
      return false;
    auto & coeff = libmesh_map_find(this->_coefficients, name);
    if (std::holds_alternative<std::shared_ptr<T>>(coeff))
      return true;
    auto block_map = std::get<1>(std::get<PWData>(coeff));
    return block_map.count(block) > 0;
  }

setTime()

template<class T, class Tpw>

void Moose::MFEM::CoefficientMap< T, Tpw >::setTime ( const mfem::real_t  time )

inline

Definition at line 140 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientManager::setTime().

  {
    for (auto & coef : this->_iterable_coefficients)
      coef->SetTime(time);
  }

Member Data Documentation

_coefficients

template<class T, class Tpw>

std::map<const std::string, std::variant<std::shared_ptr<T>, PWData> > Moose::MFEM::CoefficientMap< T, Tpw >::_coefficients

private

Definition at line 156 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::addCoefficient(), Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::addPiecewiseBlocks(), Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::getCoefficientPtr(), Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::hasCoefficient(), and Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::propertyDefinedOnBlock().

_iterable_coefficients

template<class T, class Tpw>

std::vector<std::shared_ptr<T> > Moose::MFEM::CoefficientMap< T, Tpw >::_iterable_coefficients

private

Definition at line 157 of file CoefficientMap.h.

Referenced by Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::addCoefficient(), Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::addPiecewiseBlocks(), Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::apply(), Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::make(), and Moose::MFEM::CoefficientMap< mfem::MatrixCoefficient, mfem::PWMatrixCoefficient >::setTime().

---

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

• include/mfem/utils/CoefficientMap.h