RelationshipManagers are used for describing what kinds of non-local resources are needed for an object's calculations. More...

#include <RelationshipManager.h>

Inheritance diagram for RelationshipManager:

[legend]

Public Member Functions
	RelationshipManager (const InputParameters &parameters)

void	init ()
	Called before this RM is attached. More...

bool	inited ()
	Whether or not this RM has been inited. More...

virtual const std::vector< std::string > &	forWhom () const
	The object (or Action) this RelationshipManager was built for. More...

void	addForWhom (const std::string &for_whom)
	Add another name to for_whom. More...

virtual std::string	getInfo () const =0
	Method for returning relationship manager information (suitable for console output). More...

Moose::RelationshipManagerType	getType () const
	Getter for returning the enum type for this RM. More...

bool	isType (const Moose::RelationshipManagerType &type) const
	Check to see if an RM is of a given type. More...

virtual bool	operator== (const RelationshipManager &) const

bool	attachGeometricEarly ()
	Whether or not this RM can be attached to the Mesh early if it's geometric. More...

bool	useDisplacedMesh () const
	Whether this should be placed on the undisplaced or displaced systems. More...

void	setDofMap (const DofMap &dof_map)
	Set the dof map. More...

const std::string &	type () const
	Get the type of this object. More...

virtual const std::string &	name () const
	Get the name of the object. More...

const InputParameters &	parameters () const
	Get the parameters of the object. More...

template<typename T >
const T &	getParamTempl (const std::string &name) const
	Retrieve a parameter for the object. More...

template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...

bool	isParamValid (const std::string &name) const
	Test if the supplied parameter is valid. More...

MooseApp &	getMooseApp () const
	Get the MooseApp this object is associated with. More...

virtual bool	enabled () const
	Return the enabled status of the object. More...

template<typename... Args>
void	paramError (const std::string &param, Args... args) const
	Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const
	Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramInfo (const std::string &param, Args... args) const
	Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	mooseError (Args &&... args) const

template<typename... Args>
void	mooseWarning (Args &&... args) const

template<typename... Args>
void	mooseDeprecated (Args &&... args) const

template<typename... Args>
void	mooseInfo (Args &&... args) const

Static Public Member Functions
static InputParameters	validParams ()

static bool	isGeometric (Moose::RelationshipManagerType input_rm)
	Whether `input_rm` is geometric. More...

static bool	isAlgebraic (Moose::RelationshipManagerType input_rm)
	Whether `input_rm` is algebraic. More...

static bool	isCoupling (Moose::RelationshipManagerType input_rm)
	Whether `input_rm` is coupling. More...

static InputParameters	zeroLayerGhosting ()
	This returns an `InputParameters` object containing an `ElementSideNeighborLayers` relationship manager with zero layers of ghosting. More...

static InputParameters	oneLayerGhosting (Moose::RelationshipManagerType rm_type)
	This returns an `InputParameters` object containing an `ElementSideNeighborLayers` relationship manager with one side layer of ghosting. More...

Public Attributes
const ConsoleStream	_console
	An instance of helper class to write streams to the Console objects. More...

Static Public Attributes
static Moose::RelationshipManagerType	geo_and_alg
	A relationship manager type that is geometric and algebraic. More...

static Moose::RelationshipManagerType	geo_alg_and_coupl
	A relationship manager type that is geometric, algebraic, and coupling. More...

Protected Member Functions
virtual void	internalInit ()=0
	Called before this RM is attached. More...

Protected Attributes
bool	_inited = false
	Whether or not this has been initialized. More...

MooseMesh &	_mesh
	Reference to the Mesh object. More...

const DofMap *	_dof_map
	Pointer to DofMap (may be null if this is geometric only). More...

const bool	_attach_geometric_early
	Boolean indicating whether this RM can be attached early (e.g. More...

Moose::RelationshipManagerType	_rm_type
	The type of RM this object is. More...

std::vector< std::string >	_for_whom
	The name of the object that requires this RelationshipManager. More...

const bool	_use_displaced_mesh
	Which system this should go to (undisplaced or displaced) More...

const Moose::RMSystemType	_system_type
	What type of systems this RM can be applied to. More...

const InputParameters &	_pars
	Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...

MooseApp &	_app
	The MooseApp this object is associated with. More...

const std::string &	_type
	The type of this object (the Class name) More...

const std::string &	_name
	The name of this object, reference to value stored in InputParameters. More...

const bool &	_enabled
	Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects. More...

Private Member Functions
template<typename... Args>
std::string	paramErrorMsg (const std::string &param, Args... args) const

Detailed Description

RelationshipManagers are used for describing what kinds of non-local resources are needed for an object's calculations.

Non-local resources include geometric element information, or solution information that may be more than a single side-neighbor away in a mesh. This includes physically disconnected elements that might be needed for contact or mortar calculations.

Definition at line 31 of file RelationshipManager.h.

Constructor & Destructor Documentation

◆ RelationshipManager()

RelationshipManager::RelationshipManager ( const InputParameters & parameters )

Definition at line 72 of file RelationshipManager.C.

   : MooseObject(parameters),
     GhostingFunctor(),
     _mesh(*getCheckedPointerParam<MooseMesh *>(
         "mesh",
         "Mesh is null in RelationshipManager constructor. This could well be because No mesh file "
         "was supplied and no generation block was provided")),
     _dof_map(nullptr),
     _attach_geometric_early(getParam<bool>("attach_geometric_early")),
     _rm_type(getParam<Moose::RelationshipManagerType>("rm_type")),
     _use_displaced_mesh(getParam<bool>("use_displaced_mesh")),
     _system_type(getParam<Moose::RMSystemType>("system_type"))
 {
   _for_whom.push_back(getParam<std::string>("for_whom"));
 }

Member Function Documentation

◆ addForWhom()

void RelationshipManager::addForWhom ( const std::string & for_whom )

inline

Add another name to for_whom.

Definition at line 61 of file RelationshipManager.h.

61 { _for_whom.push_back(for_whom); }

◆ attachGeometricEarly()

bool RelationshipManager::attachGeometricEarly ( )

inline

Whether or not this RM can be attached to the Mesh early if it's geometric.

Note: this is unused if this RM is purely Algebraic

Definition at line 93 of file RelationshipManager.h.

93 { return _attach_geometric_early; }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ forWhom()

virtual const std::vector<std::string>& RelationshipManager::forWhom ( ) const

inlinevirtual

The object (or Action) this RelationshipManager was built for.

Definition at line 56 of file RelationshipManager.h.

56 { return _for_whom; }

◆ getCheckedPointerParam()

template<typename T >

T MooseObject::getCheckedPointerParam	(	const std::string &	name,
		const std::string &	error_string = `""`
	)		const

inlineinherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 91 of file MooseObject.h.

   {
     return parameters().getCheckedPointerParam<T>(name, error_string);
   }

◆ getInfo()

virtual std::string RelationshipManager::getInfo ( ) const

pure virtual

Method for returning relationship manager information (suitable for console output).

Implemented in AugmentSparsityOnInterface, ProxyRelationshipManager, ElementPointNeighborLayers, ElementSideNeighborLayers, and MooseGhostPointNeighbors.

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

Referenced by MortarData::createMortarInterface(), Executioner::Executioner(), and ConsoleUtils::outputMeshInformation().

◆ getParamTempl()

template<typename T >

const T & MooseObject::getParamTempl ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 208 of file MooseObject.h.

 {
   return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0));
 }

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), EigenKernel::EigenKernel(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), ConsoleUtils::outputExecutionInformation(), and TimePeriod::TimePeriod().

◆ getType()

Moose::RelationshipManagerType RelationshipManager::getType ( ) const

inline

Getter for returning the enum type for this RM.

Definition at line 71 of file RelationshipManager.h.

71 { return _rm_type; }

◆ init()

void RelationshipManager::init ( )

inline

Called before this RM is attached.

Will only be called once.

Definition at line 41 of file RelationshipManager.h.

   {
     if (!_inited)
       internalInit();
     _inited = true;
   }

◆ inited()

bool RelationshipManager::inited ( )

inline

Whether or not this RM has been inited.

Definition at line 51 of file RelationshipManager.h.

51 { return _inited; }

◆ internalInit()

virtual void RelationshipManager::internalInit ( )

protectedpure virtual

Called before this RM is attached.

Only called once

Implemented in AugmentSparsityOnInterface, ProxyRelationshipManager, ElementPointNeighborLayers, ElementSideNeighborLayers, and MooseGhostPointNeighbors.

Referenced by init().

◆ isAlgebraic()

bool RelationshipManager::isAlgebraic ( Moose::RelationshipManagerType input_rm )

static

Whether input_rm is algebraic.

Definition at line 96 of file RelationshipManager.C.

 {
   return (input_rm & Moose::RelationshipManagerType::ALGEBRAIC) ==
          Moose::RelationshipManagerType::ALGEBRAIC;
 }

◆ isCoupling()

bool RelationshipManager::isCoupling ( Moose::RelationshipManagerType input_rm )

static

Whether input_rm is coupling.

Definition at line 103 of file RelationshipManager.C.

 {
   return (input_rm & Moose::RelationshipManagerType::COUPLING) ==
          Moose::RelationshipManagerType::COUPLING;
 }

◆ isGeometric()

bool RelationshipManager::isGeometric ( Moose::RelationshipManagerType input_rm )

static

Whether input_rm is geometric.

Definition at line 89 of file RelationshipManager.C.

 {
   return (input_rm & Moose::RelationshipManagerType::GEOMETRIC) ==
          Moose::RelationshipManagerType::GEOMETRIC;
 }

◆ isParamValid()

bool MooseObject::isParamValid ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 100 of file MooseObject.h.

100 { return _pars.isParamValid(name); }

◆ isType()

bool RelationshipManager::isType ( const Moose::RelationshipManagerType & type ) const

inline

Check to see if an RM is of a given type.

This is here so that the Boolean logic doesn't have to get spread everywhere in the world

Definition at line 78 of file RelationshipManager.h.

   {
     return (_rm_type & type) == type;
   }

Referenced by ProxyRelationshipManager::operator()(), MooseGhostPointNeighbors::operator==(), ElementSideNeighborLayers::operator==(), and ElementPointNeighborLayers::operator==().

◆ mooseDeprecated()

template<typename... Args>

void MooseObject::mooseDeprecated ( Args &&... args ) const

inlineinherited

Definition at line 156 of file MooseObject.h.

   {
     moose::internal::mooseDeprecatedStream(_console, false, std::forward<Args>(args)...);
   }

Referenced by FEProblemBase::addArrayVariable(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addScalarVariable(), FEProblemBase::addVariable(), ADFunctionPresetBC< compute_stage >::ADFunctionPresetBC(), ADPresetBC< compute_stage >::ADPresetBC(), ADPresetNodalBC< compute_stage >::ADPresetNodalBC(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), MaterialBase::declarePropertyOlderTempl(), MaterialBase::declarePropertyOldTempl(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint< compute_stage >::FaceFaceConstraint(), FunctionDT::FunctionDT(), FunctionPresetBC::FunctionPresetBC(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), Sampler::getSamples(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), MatDiffusionBase< Real >::MatDiffusionBase(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), PresetBC::PresetBC(), PresetNodalBC::PresetNodalBC(), Sampler::rand(), ReferenceResidualProblem::ReferenceResidualProblem(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

◆ mooseError()

template<typename... Args>

void MooseObject::mooseError ( Args &&... args ) const

inlineinherited

Definition at line 141 of file MooseObject.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
     callMooseErrorRaw(msg, &_app);
   }

◆ mooseInfo()

template<typename... Args>

void MooseObject::mooseInfo ( Args &&... args ) const

inlineinherited

Definition at line 162 of file MooseObject.h.

   {
     moose::internal::mooseInfoStream(_console, std::forward<Args>(args)...);
   }

Referenced by AStableDirk4::AStableDirk4(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), ParsedMaterialHelper::functionsOptimize(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), MooseObject::paramInfo(), DerivativeParsedMaterialHelper::recurseDerivative(), ReferenceResidualProblem::ReferenceResidualProblem(), and FEProblemBase::setRestartFile().

◆ mooseWarning()

template<typename... Args>

void MooseObject::mooseWarning ( Args &&... args ) const

inlineinherited

Definition at line 150 of file MooseObject.h.

   {
     moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
   }

Referenced by CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkMultiAppExecuteOn(), OversampleOutput::cloneMesh(), GapValueAux::computeValue(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ElementSubdomainIDGenerator::generate(), MooseMesh::getBoundaryIDs(), FEProblemBase::getInterfaceMaterial(), FEProblemBase::getMaterial(), MooseMesh::getSubdomainIDs(), ReferenceResidualProblem::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), LeastSquaresFit::LeastSquaresFit(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), AssignElementSubdomainID::modify(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MooseObject::paramWarning(), Executioner::problem(), MaterialBase::resetQpProperties(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), and Checkpoint::updateCheckpointFiles().

◆ name()

virtual const std::string& MooseObject::name ( ) const

inlinevirtualinherited

Get the name of the object.

Returns: The name of the object TODO:MooseVariableToMooseObject (see #10601)

Reimplemented in MooseVariableBase.

Definition at line 70 of file MooseObject.h.

70 { return _name; }

◆ oneLayerGhosting()

InputParameters RelationshipManager::oneLayerGhosting ( Moose::RelationshipManagerType rm_type )

static

This returns an InputParameters object containing an ElementSideNeighborLayers relationship manager with one side layer of ghosting.

Parameters

rm_type The type of relationship manager that should be added. This can be GEOMETRIC, ALGEBRAIC, COUPLING or a combination of the three

Definition at line 137 of file RelationshipManager.C.

 {
   auto params = dummyParams();
   params.addRelationshipManager("ElementSideNeighborLayers", rm_type);
   return params;
 }

Referenced by CouplingFunctorCheckAction::act().

◆ operator==()

virtual bool RelationshipManager::operator== ( const RelationshipManager & ) const

inlinevirtual

Reimplemented in ElementPointNeighborLayers, ElementSideNeighborLayers, MooseGhostPointNeighbors, AugmentSparsityOnInterface, and ProxyRelationshipManager.

Definition at line 83 of file RelationshipManager.h.

   {
     mooseError("Comparison operator required for this RelationshipManager required");
   }

◆ paramError()

template<typename... Args>

void MooseObject::paramError	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 215 of file MooseObject.h.

 {
   Moose::show_trace = false;
   mooseError(paramErrorMsg(param, std::forward<Args>(args)...));
   Moose::show_trace = true;
 }

◆ paramErrorMsg()

template<typename... Args>

std::string MooseObject::paramErrorMsg	(	const std::string &	param,
		Args...	args
	)		const

inlineprivateinherited

Definition at line 185 of file MooseObject.h.

   {
     auto prefix = paramErrorPrefix(_pars, param);
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
  
     // Wrap error message to a separate line from prefix if it is about to
     // blow past 100 chars.  But only wrap if the prefix is long enough (12
     // chars) for the wrap to buy us much extra length.
     if ((prefix.size() > 12 && msg.size() + prefix.size() > 99) ||
         msg.find("\n") != std::string::npos)
     {
       if (prefix.size() > 0 && prefix[prefix.size() - 1] != ':')
         prefix += ":";
       return prefix + "\n    " + MooseUtils::replaceAll(msg, "\n", "\n    ");
     }
     return prefix + " " + msg;
   }

Referenced by MooseObject::paramError(), MooseObject::paramInfo(), and MooseObject::paramWarning().

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

◆ paramInfo()

template<typename... Args>

void MooseObject::paramInfo	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 231 of file MooseObject.h.

 {
   mooseInfo(paramErrorMsg(param, std::forward<Args>(args)...));
 }

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

template<typename... Args>

void MooseObject::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 224 of file MooseObject.h.

 {
   mooseWarning(paramErrorMsg(param, std::forward<Args>(args)...));
 }

Referenced by Executioner::Executioner().

◆ setDofMap()

void RelationshipManager::setDofMap ( const DofMap & dof_map )

inline

Set the dof map.

Definition at line 106 of file RelationshipManager.h.

106 { _dof_map = &dof_map; }

◆ type()

const std::string& MooseObject::type ( ) const

inlineinherited

Get the type of this object.

Returns: the name of the type of this object

Definition at line 63 of file MooseObject.h.

63 { return _type; }

◆ useDisplacedMesh()

bool RelationshipManager::useDisplacedMesh ( ) const

inline

Whether this should be placed on the undisplaced or displaced systems.

Note: this says 'mesh' but that's just to match the colloquial term in MOOSE. If this thing is algebraic then it's going to the DofMap

Definition at line 101 of file RelationshipManager.h.

101 { return _use_displaced_mesh; }

Referenced by ProxyRelationshipManager::getInfo().

◆ validParams()

InputParameters RelationshipManager::validParams ( )

static

Param to indicate whether all necessary GeometricRelationshipManagers can be attached during the setup of the mesh. When true (and when running with DistributedMesh) the framework can perform two optimizations:

1) Elements not needed by any ghosting functor can be safely deleted during Mesh::init() prior to building the EquationSystems object or other MOOSE objects. This may result in significant memory savings during the setup phase.

2) A late mesh reinitialization can be skipped reducing the overall setup time of the simulation.

When in doubt and to allow for maximum flexibility, developers may choose to return false here to simplify setting up Algebraic and Geometric at the same time.

This parameter indicates which type of RelationshipManager this class represents prior to its construction. Geometric-only RelationshipManagers may be buildable early in which case the framework can optimize memory usage for Distributed Mesh by allowing remote elements to be deleted. Depending on the mesh size and EquationSystems size, this may have a significant impact on total memory usage during the problem setup phase.

This parameter is used to indicate which system and subsequent DofMap this relationship manager should be applied to. This parameter is not meaningful when the RM is of geometric type only. If this parameter is equal to ANY, then this RM can be applied to both non-linear and aux systems.

The name of the object (or Action) requesting this RM

Definition at line 16 of file RelationshipManager.C.

 {
   InputParameters params = MooseObject::validParams();
  
   params.addPrivateParam<bool>("attach_geometric_early", true);
  
   params.addPrivateParam<Moose::RelationshipManagerType>("rm_type");
  
   params.addPrivateParam<Moose::RMSystemType>("system_type", Moose::RMSystemType::NONE);
  
   params.addRequiredParam<std::string>("for_whom", "What object is requesting this RM?");
  
   params.addParam<bool>(
       "use_displaced_mesh",
       false,
       "Whether this RM should be placed on the undisplaced or displaced problem. Note: yes, it "
       "still says 'mesh' to match with common parameter name in MOOSE - but if it's purely "
       "algebraic then it's going to the DofMap no matter what!");
  
   // Set by MOOSE
   params.addPrivateParam<MooseMesh *>("mesh");
   params.registerBase("RelationshipManager");
   return params;
 }

Referenced by FunctorRelationshipManager::validParams(), ProxyRelationshipManager::validParams(), and AugmentSparsityOnInterface::validParams().

◆ zeroLayerGhosting()

InputParameters RelationshipManager::zeroLayerGhosting ( )

static

This returns an InputParameters object containing an ElementSideNeighborLayers relationship manager with zero layers of ghosting.

While zero layers may seem foolish, this is actually very useful for building the correct sparsity pattern between intra-element degrees of freedom. Since this object only has meaning for building the sparsity pattern, the relationsip manager type contained within the returned InputParameters object will be COUPLING

Definition at line 125 of file RelationshipManager.C.

 {
   auto params = dummyParams();
   params.addRelationshipManager("ElementSideNeighborLayers",
                                 Moose::RelationshipManagerType::COUPLING,
                                 [](const InputParameters &, InputParameters & rm_params) {
                                   rm_params.set<unsigned short>("layers") = 0;
                                 });
   return params;
 }

Member Data Documentation

◆ _app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), MeshGenerator::declareMeshProperty(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), NonlinearEigen::execute(), InversePowerMethod::execute(), Transient::execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MeshGenerator::getMesh(), MeshGenerator::getMeshByName(), MooseObject::getMooseApp(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), NonlinearEigen::init(), InversePowerMethod::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), ElementSideNeighborLayers::internalInit(), MeshGeneratorMesh::MeshGeneratorMesh(), MooseObject::mooseError(), EigenExecutionerBase::normalizeSolution(), AugmentSparsityOnInterface::operator()(), PerfGraphOutput::output(), Tecplot::output(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), Eigenvalue::postSolve(), Transient::preExecute(), FEProblemBase::projectSolution(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient::Transient(), and Console::write().

◆ _attach_geometric_early

const bool RelationshipManager::_attach_geometric_early

protected

Boolean indicating whether this RM can be attached early (e.g.

all parameters are known without the need for inspecting things like variables or other parts of the system that are not available.

Definition at line 127 of file RelationshipManager.h.

Referenced by attachGeometricEarly().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _dof_map

const DofMap* RelationshipManager::_dof_map

protected

Pointer to DofMap (may be null if this is geometric only).

This is useful for setting coupling matrices in call-backs from DofMap::reinit

Definition at line 122 of file RelationshipManager.h.

Referenced by ElementSideNeighborLayers::dofmap_reinit(), and setDofMap().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _for_whom

std::vector<std::string> RelationshipManager::_for_whom

protected

The name of the object that requires this RelationshipManager.

Definition at line 134 of file RelationshipManager.h.

Referenced by addForWhom(), forWhom(), and RelationshipManager().

◆ _inited

bool RelationshipManager::_inited = false

protected

Whether or not this has been initialized.

Definition at line 115 of file RelationshipManager.h.

Referenced by init(), and inited().

◆ _mesh

MooseMesh& RelationshipManager::_mesh

protected

Reference to the Mesh object.

Definition at line 118 of file RelationshipManager.h.

Referenced by MooseGhostPointNeighbors::internalInit(), ElementSideNeighborLayers::internalInit(), AugmentSparsityOnInterface::internalInit(), ProxyRelationshipManager::operator()(), and AugmentSparsityOnInterface::operator()().

◆ _name

const std::string& MooseObject::_name

protectedinherited

The name of this object, reference to value stored in InputParameters.

Definition at line 178 of file MooseObject.h.

Referenced by ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), PiecewiseBase::buildFromFile(), PiecewiseBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), MooseObject::name(), PiecewiseBilinear::parse(), PiecewiseBase::PiecewiseBase(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), DerivativeParsedMaterialHelper::recurseDerivative(), PiecewiseBase::setData(), Split::setup(), and VectorPostprocessorFunction::VectorPostprocessorFunction().

◆ _pars

const InputParameters& MooseObject::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 169 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PNGOutput::calculateRescalingValues(), BreakMeshByBlockBase::checkInputParameter(), RandomPartitioner::clone(), PetscExternalPartitioner::clone(), BlockWeightedPartitioner::clone(), GridPartitioner::clone(), Console::Console(), Eigenvalue::execute(), Executioner::Executioner(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), ExtraNodesetGenerator::generate(), MooseObject::getParamTempl(), GeneralUserObject::getPostprocessorValue(), InitialConditionBase::getUserObjectBase(), InitialConditionBase::getUserObjectTempl(), GeneralUserObject::getVectorPostprocessorValue(), Transient::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseObject::isParamValid(), AddExtraNodeset::modify(), MooseObject::paramErrorMsg(), MooseObject::parameters(), MooseMesh::setPartitionerHelper(), and Transient::setupTimeIntegrator().

◆ _rm_type

Moose::RelationshipManagerType RelationshipManager::_rm_type

protected

The type of RM this object is.

Note that the underlying enum is capable of holding multiple values simultaneously, so you must use bitwise operators to test values.

Definition at line 131 of file RelationshipManager.h.

Referenced by getType(), isType(), and MooseGhostPointNeighbors::MooseGhostPointNeighbors().

◆ _system_type

const Moose::RMSystemType RelationshipManager::_system_type

protected

What type of systems this RM can be applied to.

Definition at line 140 of file RelationshipManager.h.

Referenced by ElementSideNeighborLayers::operator==().

◆ _type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

Referenced by FEProblemBase::init(), and MooseObject::type().

◆ _use_displaced_mesh

const bool RelationshipManager::_use_displaced_mesh

protected

Which system this should go to (undisplaced or displaced)

Definition at line 137 of file RelationshipManager.h.

Referenced by AugmentSparsityOnInterface::operator()(), and useDisplacedMesh().

◆ geo_alg_and_coupl

Moose::RelationshipManagerType RelationshipManager::geo_alg_and_coupl

static

Initial value:

=
    Moose::RelationshipManagerType::GEOMETRIC | Moose::RelationshipManagerType::ALGEBRAIC |
    Moose::RelationshipManagerType::COUPLING

A relationship manager type that is geometric, algebraic, and coupling.

Definition at line 166 of file RelationshipManager.h.

◆ geo_and_alg

Moose::RelationshipManagerType RelationshipManager::geo_and_alg

static

Initial value:

=

Moose::RelationshipManagerType::GEOMETRIC | Moose::RelationshipManagerType::ALGEBRAIC

A relationship manager type that is geometric and algebraic.

Definition at line 161 of file RelationshipManager.h.

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

include/relationshipmanagers/RelationshipManager.h
src/relationshipmanagers/RelationshipManager.C

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RelationshipManager()

Member Function Documentation

◆ addForWhom()

◆ attachGeometricEarly()

◆ enabled()

◆ forWhom()

◆ getCheckedPointerParam()

◆ getInfo()

◆ getMooseApp()

◆ getParamTempl()

◆ getType()

◆ init()

◆ inited()

◆ internalInit()

◆ isAlgebraic()

◆ isCoupling()

◆ isGeometric()

◆ isParamValid()

◆ isType()

◆ mooseDeprecated()

◆ mooseError()

◆ mooseInfo()

◆ mooseWarning()

◆ name()

◆ oneLayerGhosting()

◆ operator==()

◆ paramError()

◆ paramErrorMsg()

◆ parameters()

◆ paramInfo()

◆ paramWarning()

◆ setDofMap()

◆ type()

◆ useDisplacedMesh()

◆ validParams()

◆ zeroLayerGhosting()

Member Data Documentation

◆ _app

◆ _attach_geometric_early

◆ _console

◆ _dof_map

◆ _enabled

◆ _for_whom

◆ _inited

◆ _mesh

◆ _name

◆ _pars

◆ _rm_type

◆ _system_type

◆ _type

◆ _use_displaced_mesh

◆ geo_alg_and_coupl

◆ geo_and_alg