An interface class that helps getting access to Mapping objects. More...

#include <MappingInterface.h>

Inheritance diagram for MappingInterface:

Public Member Functions
	MappingInterface (const MooseObject *moose_object)
	Construct using a moose object (usually the object which inherits from the interface)

VariableMappingBase &	getMapping (const std::string &name) const
	Get the mapping using the parameters of the moose object.

VariableMappingBase &	getMappingByName (const UserObjectName &name) const
	Get the mapping by supplying the name of the object in the warehouse.

Static Public Member Functions
static InputParameters	validParams ()

Private Attributes
const InputParameters &	_smi_params
	Parameters of the object with this interface.

FEProblemBase &	_smi_feproblem
	Reference to FEProblemBase instance.

Detailed Description

An interface class that helps getting access to Mapping objects.

Definition at line 19 of file MappingInterface.h.

Constructor & Destructor Documentation

◆ MappingInterface()

MappingInterface::MappingInterface ( const MooseObject * moose_object )

Construct using a moose object (usually the object which inherits from the interface)

Definition at line 19 of file MappingInterface.C.

  : _smi_params(moose_object->parameters()),
    _smi_feproblem(*_smi_params.get<FEProblemBase *>("_fe_problem_base"))
{
}

Member Function Documentation

◆ getMapping()

VariableMappingBase & MappingInterface::getMapping ( const std::string & name ) const

Get the mapping using the parameters of the moose object.

Parameters

name	The parameter name

Definition at line 40 of file MappingInterface.C.

{
  return getMappingByName(_smi_params.get<UserObjectName>(name));
}

Referenced by SingularTripletReporter::initialSetup(), and InverseMapping::initialSetup().

◆ getMappingByName()

VariableMappingBase & MappingInterface::getMappingByName ( const UserObjectName & name ) const

Get the mapping by supplying the name of the object in the warehouse.

Parameters

name	The name of the mapping object

Definition at line 26 of file MappingInterface.C.

{
  std::vector<VariableMappingBase *> models;
  _smi_feproblem.theWarehouse()
      .query()
      .condition<AttribName>(name)
      .condition<AttribSystem>("VariableMappingBase")
      .queryInto(models);
  if (models.empty())
    mooseError("Unable to find a Mapping object with the name '" + name + "'");
  return *(models[0]);
}

Referenced by getMapping(), MappingReporter::initialSetup(), and MappingOutput::output().

◆ validParams()

InputParameters MappingInterface::validParams ( )

static

Definition at line 14 of file MappingInterface.C.

{
  return emptyInputParameters();
}

Referenced by MappingReporter::validParams(), and SingularTripletReporter::validParams().

Member Data Documentation

◆ _smi_feproblem

FEProblemBase& MappingInterface::_smi_feproblem

private

Reference to FEProblemBase instance.

Definition at line 44 of file MappingInterface.h.

Referenced by getMappingByName().

◆ _smi_params

const InputParameters& MappingInterface::_smi_params

private

Parameters of the object with this interface.

Definition at line 41 of file MappingInterface.h.

Referenced by getMapping().

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

stochastic_tools/include/interfaces/MappingInterface.h
stochastic_tools/src/interfaces/MappingInterface.C

Public Member Functions

Static Public Member Functions

Private Attributes