Moose::MFEM::TimeDerivativeMap Class Reference

Lightweight adaptor over a std::map relating names of GridFunctions with the name of their time derivatives. More...

#include <MFEMContainers.h>

Public Types
using	MapType = std::map< std::string, std::string >
using	const_iterator = typename MapType::const_iterator

Public Member Functions
void	addTimeDerivativeAssociation (const std::string &var_name, const std::string &time_derivative_var_name)
bool	isTimeDerivative (const std::string &time_derivative_var_name) const
bool	hasTimeDerivative (const std::string &var_name) const
const std::string &	getTimeDerivativeName (const std::string &var_name) const
const std::string &	getTimeIntegralName (const std::string &time_derivative_var_name) const

Static Public Member Functions
static std::string	createTimeDerivativeName (std::string_view name)

Private Attributes
MapType	_field_map
const std::string	null_str

Detailed Description

Lightweight adaptor over a std::map relating names of GridFunctions with the name of their time derivatives.

Definition at line 182 of file MFEMContainers.h.

Member Typedef Documentation

const_iterator

using Moose::MFEM::TimeDerivativeMap::const_iterator = typename MapType::const_iterator

Definition at line 186 of file MFEMContainers.h.

MapType

using Moose::MFEM::TimeDerivativeMap::MapType = std::map<std::string, std::string>

Definition at line 185 of file MFEMContainers.h.

Member Function Documentation

addTimeDerivativeAssociation()

void Moose::MFEM::TimeDerivativeMap::addTimeDerivativeAssociation ( const std::string &  var_name, const std::string &  time_derivative_var_name  )

inline

Definition at line 188 of file MFEMContainers.h.

  {
    _field_map.emplace(var_name, time_derivative_var_name);
  }

Referenced by MFEMProblem::addVariable().

createTimeDerivativeName()

static std::string Moose::MFEM::TimeDerivativeMap::createTimeDerivativeName ( std::string_view  name )

inlinestatic

Definition at line 233 of file MFEMContainers.h.

  {
    return std::string("d") + std::string(name) + std::string("_dt");
  }

getTimeDerivativeName()

const std::string & Moose::MFEM::TimeDerivativeMap::getTimeDerivativeName ( const std::string &  var_name ) const

inline

Definition at line 209 of file MFEMContainers.h.

  {
    auto it = _field_map.find(var_name);
    if (it != _field_map.end())
      return it->second;
    else
    {
      mooseError("No variable representing the time derivative of ", var_name, " found.");
      return null_str;
    }
  }

getTimeIntegralName()

const std::string & Moose::MFEM::TimeDerivativeMap::getTimeIntegralName ( const std::string &  time_derivative_var_name ) const

inline

Definition at line 221 of file MFEMContainers.h.

  {
    for (auto const & [map_var_name, map_time_derivative_var_name] : _field_map)
    {
      if (map_time_derivative_var_name == time_derivative_var_name)
        return map_var_name;
    }
    mooseError(
        "No variable representing the time integral of ", time_derivative_var_name, " found.");
    return null_str;
  }

Referenced by Moose::MFEM::TimeDependentEquationSystem::AddKernel().

hasTimeDerivative()

bool Moose::MFEM::TimeDerivativeMap::hasTimeDerivative ( const std::string &  var_name ) const

inline

Definition at line 204 of file MFEMContainers.h.

  {
    return _field_map.count(var_name);
  }

isTimeDerivative()

bool Moose::MFEM::TimeDerivativeMap::isTimeDerivative ( const std::string &  time_derivative_var_name ) const

inline

Definition at line 194 of file MFEMContainers.h.

  {
    for (auto const & [map_var_name, map_time_derivative_var_name] : _field_map)
    {
      if (map_time_derivative_var_name == time_derivative_var_name)
        return true;
    }
    return false;
  }

Referenced by Moose::MFEM::TimeDependentEquationSystem::AddKernel().

Member Data Documentation

_field_map

MapType Moose::MFEM::TimeDerivativeMap::_field_map

private

Definition at line 239 of file MFEMContainers.h.

Referenced by addTimeDerivativeAssociation(), getTimeDerivativeName(), getTimeIntegralName(), hasTimeDerivative(), and isTimeDerivative().

null_str

const std::string Moose::MFEM::TimeDerivativeMap::null_str

private

Definition at line 240 of file MFEMContainers.h.

Referenced by getTimeDerivativeName(), and getTimeIntegralName().

---

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

• include/mfem/containers/MFEMContainers.h