CreateDisplacedProblemAction Class Reference

#include <CreateDisplacedProblemAction.h>

Inheritance diagram for CreateDisplacedProblemAction:

Public Member Functions
	CreateDisplacedProblemAction (InputParameters parameters)
virtual void	act () override
	Method to add objects to the simulation or perform other setup tasks. More...
void	timedAct ()
	The method called externally that causes the action to act() More...
virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)
	Method to add a relationship manager for the objects being added to the system. More...
const std::string &	name () const
	The name of the action. More...
const std::string &	type () const
InputParameters &	parameters ()
const InputParameters &	parameters () const
const std::string &	specificTaskName () const
const std::set< std::string > &	getAllTasks () const
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
void	appendTask (const std::string &task)
template<typename... Args>
void	paramError (const std::string &param, Args... args)
	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)
	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)
	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...
std::string	getBaseName () const
	Deprecated name methods, use name() More...
std::string	getShortName () const
	DEPRECATED METHODS. More...
template<typename T >
const T &	getParamTempl (const std::string &name) const
	Retrieve a parameter for the object. More...

Static Public Member Functions
static InputParameters	validParams ()

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

Static Public Attributes
static constexpr auto	FILE_SUFFIX = "_mesh"
	The suffix appended when writing the restartable data file. More...
static constexpr auto	SYSTEM = "MeshMetaData"
	The system name used when initializing the Restartable interface. More...
static constexpr auto	NAME = "<empty>"
	The data name used when initializing the Restartable interface for non-MeshGenerator objects. More...

Protected Member Functions
void	addProxyAlgebraicRelationshipManagers (SystemBase &to, SystemBase &from)
	Sets up a ProxyRelationshipManager that copies algebraic ghosting from->to. More...
void	addProxyGeometricRelationshipManagers (SystemBase &to, SystemBase &from)
	Sets up a ProxyRelationshipManager that copies geometric ghosting from->to. More...
void	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
	Method to add a relationship manager for the objects being added to the system. More...
template<typename T >
const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)
	Method for retrieving a property with the given type and name exists in the mesh meta-data store. More...
PerfID	registerTimedSection (const std::string &section_name, const unsigned int level)
	Call to register a named section for timing. More...

Protected Attributes
InputParameters	_pars
	Input parameters for the action. More...
std::string	_registered_identifier
std::string	_name
	The name of the action. More...
std::string	_action_type
MooseApp &	_app
	The MOOSE application this is associated with. More...
Factory &	_factory
	The Factory associated with the MooseApp. More...
ActionFactory &	_action_factory
	Builds Actions. More...
std::string	_specific_task_name
	This member will only be populated if this Action instance is only designed to handle one task. More...
std::set< std::string >	_all_tasks
	A list of all the tasks that this Action will satisfy. More...
ActionWarehouse &	_awh
	Reference to ActionWarehouse where we store object build by actions. More...
const std::string &	_current_task
	The current action (even though we have seperate instances for each action) More...
std::shared_ptr< MooseMesh > &	_mesh
std::shared_ptr< MooseMesh > &	_displaced_mesh
std::shared_ptr< FEProblemBase > &	_problem
	Convenience reference to a problem this action works on. More...
PerfID	_act_timer
	Timers. More...
const InputParameters *	_pg_params
	Params. More...
PerfGraph &	_perf_graph
	The performance graph to add to. More...
std::string	_prefix
	A prefix to use for all sections. More...

Private Member Functions
void	addProxyRelationshipManagers (SystemBase &to, SystemBase &from, Moose::RelationshipManagerType rm_type, std::string type)
	Generic adder of ProxyRelationshipManagers. More...
void	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type)
	Method for adding a single relationship manager. More...
RestartableDataValue &	registerMetaDataOnApp (const std::string &name, std::unique_ptr< RestartableDataValue > data)
	Helper function for actually registering the restartable data. More...

Private Attributes
MooseApp &	_meta_data_app
	Reference to the application. More...

Detailed Description

Definition at line 23 of file CreateDisplacedProblemAction.h.

Constructor & Destructor Documentation

CreateDisplacedProblemAction()

CreateDisplacedProblemAction::CreateDisplacedProblemAction

(

InputParameters

parameters

)

Definition at line 45 of file CreateDisplacedProblemAction.C.

  : Action(parameters)
{
}

Member Function Documentation

act()

void CreateDisplacedProblemAction::act ( )

overridevirtual

Method to add objects to the simulation or perform other setup tasks.

Implements Action.

Definition at line 96 of file CreateDisplacedProblemAction.C.

{
  if (isParamValid("displacements") && getParam<bool>("use_displaced_mesh"))
  {
    if (_current_task == "init_displaced_problem")
    {
      if (!_displaced_mesh)
        mooseError("displacements were set but a displaced mesh wasn't created!");
 
      // Define the parameters
      InputParameters object_params = _factory.getValidParams("DisplacedProblem");
      object_params.set<std::vector<std::string>>("displacements") =
          getParam<std::vector<std::string>>("displacements");
      object_params.set<MooseMesh *>("mesh") = _displaced_mesh.get();
      object_params.set<FEProblemBase *>("_fe_problem_base") = _problem.get();
      object_params.set<bool>("default_ghosting") = _problem->defaultGhosting();
 
      // Create the object
      std::shared_ptr<DisplacedProblem> disp_problem =
          _factory.create<DisplacedProblem>("DisplacedProblem", "DisplacedProblem", object_params);
 
      // Add the Displaced Problem to FEProblemBase
      _problem->addDisplacedProblem(disp_problem);
    }
 
    if (_current_task == "add_geometric_rm")
      // We can't do anything at this time because the systems haven't been created
      // but we do need to tell the mesh to hang onto extra elements just in case
      _mesh->getMesh().allow_remote_element_removal(false);
 
    if (_current_task == "add_algebraic_rm")
    {
      auto & undisplaced_nl = _problem->getNonlinearSystemBase();
      auto & undisplaced_aux = _problem->getAuxiliarySystem();
 
      auto displaced_problem_ptr = _problem->getDisplacedProblem();
 
      auto & displaced_nl = displaced_problem_ptr->nlSys();
      auto & displaced_aux = displaced_problem_ptr->auxSys();
 
      // Note that there is no reason to copy coupling factors back and forth because the displaced
      // systems do not have their own matrices (they are constructed with their libMesh::System of
      // type TransientExplicitSystem)
 
      // Note the "to" system doesn't actually matter much - the GF will
      // get added to both systems on the receiving side
      addProxyAlgebraicRelationshipManagers(undisplaced_nl, displaced_nl);
      addProxyAlgebraicRelationshipManagers(displaced_nl, undisplaced_nl);
      addProxyAlgebraicRelationshipManagers(undisplaced_aux, displaced_aux);
      addProxyAlgebraicRelationshipManagers(displaced_aux, undisplaced_aux);
 
      addProxyGeometricRelationshipManagers(undisplaced_nl, displaced_nl);
      addProxyGeometricRelationshipManagers(displaced_nl, undisplaced_nl);
 
      // When adding the geometric relationship mangers we told the mesh not to allow remote element
      // removal during the initial MeshBase::prepare_for_use call. If we're using a distributed
      // mesh we need to make sure we now allow remote element removal and then delete the remote
      // elmeents after the EquationSystems init
      if (_mesh->isDistributedMesh())
      {
        _mesh->needsRemoteElemDeletion(true);
        if (_displaced_mesh)
          _displaced_mesh->needsRemoteElemDeletion(true);
      }
    }
  }
}

addProxyAlgebraicRelationshipManagers()

void CreateDisplacedProblemAction::addProxyAlgebraicRelationshipManagers ( SystemBase &  to, SystemBase &  from  )

protected

Sets up a ProxyRelationshipManager that copies algebraic ghosting from->to.

Definition at line 82 of file CreateDisplacedProblemAction.C.

{
  addProxyRelationshipManagers(to, from, Moose::RelationshipManagerType::ALGEBRAIC, "algebraic");
}

Referenced by act().

addProxyGeometricRelationshipManagers()

void CreateDisplacedProblemAction::addProxyGeometricRelationshipManagers ( SystemBase &  to, SystemBase &  from  )

protected

Sets up a ProxyRelationshipManager that copies geometric ghosting from->to.

Definition at line 89 of file CreateDisplacedProblemAction.C.

{
  addProxyRelationshipManagers(to, from, Moose::RelationshipManagerType::GEOMETRIC, "geometric");
}

Referenced by act().

addProxyRelationshipManagers()

void CreateDisplacedProblemAction::addProxyRelationshipManagers ( SystemBase &  to, SystemBase &  from, Moose::RelationshipManagerType  rm_type, std::string  type  )

private

Generic adder of ProxyRelationshipManagers.

Parameters

to	The system to add RelationshipManagers for
from	The system to copy RelationshipManagers over from
rm_type	The Moose::RelationshipManagerType, e.g. GEOMETRIC or ALGEBRAIC (COUPLING doesn't need to be copied back and forth)
type	A string form of the type, e.g. "geometric", "algebraic", or "coupling"

Definition at line 51 of file CreateDisplacedProblemAction.C.

{
  auto rm_params = _factory.getValidParams("ProxyRelationshipManager");
 
  rm_params.set<bool>("attach_geometric_early") = false;
  rm_params.set<MooseMesh *>("mesh") = &to.mesh();
  rm_params.set<System *>("other_system") = &from.system();
  rm_params.set<std::string>("for_whom") = "DisplacedMesh";
  rm_params.set<Moose::RelationshipManagerType>("rm_type") = rm_type;
 
  rm_params.set<bool>("use_displaced_mesh") = to.subproblem().name() == "DisplacedProblem";
 
  if (rm_params.areAllRequiredParamsValid())
  {
    auto rm_obj = _factory.create<RelationshipManager>(
        "ProxyRelationshipManager",
        to.subproblem().name() + "<-" + from.subproblem().name() + "_" + from.system().name() +
            "_" + type + "_proxy",
        rm_params);
 
    if (!_app.addRelationshipManager(rm_obj))
      _factory.releaseSharedObjects(*rm_obj);
  }
  else
    mooseError("Invalid initialization of ProxyRelationshipManager");
}

Referenced by addProxyAlgebraicRelationshipManagers(), and addProxyGeometricRelationshipManagers().

addRelationshipManager()

void Action::addRelationshipManager ( Moose::RelationshipManagerType  input_rm_type, const InputParameters &  moose_object_pars, std::string  rm_name, Moose::RelationshipManagerType  rm_type, Moose::RelationshipManagerInputParameterCallback  rm_input_parameter_func, Moose::RMSystemType  sys_type  )

privateinherited

Method for adding a single relationship manager.

Parameters

input_rm_type	What relationship manager type we are currently adding
moose_object_pars	The parameters of the MooseObject that requested the RM
rm_name	The class type of the RM, e.g. ElementSideNeighborLayers
rm_type	The RelationshipManagerType, e.g. geometric, algebraic, coupling
rm_input_parameter_func	The RM callback function, typically a lambda defined in the requesting MooseObject's validParams function
sys_type	A RMSystemType that can be used to limit the systems and consequent dof_maps that the RM can be attached to

Definition at line 97 of file Action.C.

{
  // These need unique names
  static unsigned int unique_object_id = 0;
 
  auto new_name = moose_object_pars.get<std::string>("_moose_base") + '_' + name() + '_' + rm_name +
                  "_" + Moose::stringify(rm_type) + " " + std::to_string(unique_object_id);
 
  auto rm_params = _factory.getValidParams(rm_name);
  rm_params.set<Moose::RelationshipManagerType>("rm_type") = rm_type;
  rm_params.set<Moose::RMSystemType>("system_type") = sys_type;
 
  auto for_whom = name();
  if (sys_type == Moose::RMSystemType::NONLINEAR)
    for_whom += "_nl";
  else if (sys_type == Moose::RMSystemType::AUXILIARY)
    for_whom += "_aux";
  rm_params.set<std::string>("for_whom") = for_whom;
 
  // Figure out if we shouldn't be adding this one yet
  if (((rm_type & input_rm_type) != input_rm_type)
 
      || // Or are we adding Geometric but this one needs to be delayed
 
      (((input_rm_type & Moose::RelationshipManagerType::GEOMETRIC) ==
        Moose::RelationshipManagerType::GEOMETRIC) &&
       ((rm_type & Moose::RelationshipManagerType::GEOMETRIC) ==
        Moose::RelationshipManagerType::GEOMETRIC) &&
       !rm_params.template get<bool>("attach_geometric_early"))
 
      || // Or is this an Algebraic/Coupling and Geometric one that we already added earlier?
 
      (((input_rm_type != Moose::RelationshipManagerType::GEOMETRIC) &&
        (rm_type != Moose::RelationshipManagerType::GEOMETRIC) &&
        ((rm_type & Moose::RelationshipManagerType::GEOMETRIC) ==
         Moose::RelationshipManagerType::GEOMETRIC) &&
        rm_params.template get<bool>("attach_geometric_early"))))
    return;
 
  // If there is a callback for setting the RM parameters let's use it
  if (rm_input_parameter_func)
    rm_input_parameter_func(moose_object_pars, rm_params);
 
  // If we're doing geometric but we can't build it early - then let's not build it yet
  // (It will get built when we do algebraic)
  if ((input_rm_type & Moose::RelationshipManagerType::GEOMETRIC) ==
          Moose::RelationshipManagerType::GEOMETRIC &&
      !rm_params.get<bool>("attach_geometric_early"))
  {
    // We also need to tell the mesh not to delete remote elements yet
    // Note this will get reset in AddRelationshipManager::act() when attaching Algebraic
    _mesh->getMesh().allow_remote_element_removal(false);
 
    if (_problem->getDisplacedProblem())
      _problem->getDisplacedProblem()->mesh().getMesh().allow_remote_element_removal(false);
 
    // Keep looking for more RMs
    return;
  }
  // Ok the above block may have told the mesh not to allow remote element removal during the
  // initial MeshBase::prepare_for_use, which is called after attaching geometric ghosting
  // functors. If we did tell the mesh not to allow remote element removal **and** we're using a
  // DistributedMesh, then we need to tell the mesh to allow remote element removal and ensure
  // that the mesh will delete its remote elements after the EquationSystems init
  else if (input_rm_type != Moose::RelationshipManagerType::GEOMETRIC &&
           (rm_type & Moose::RelationshipManagerType::GEOMETRIC) ==
               Moose::RelationshipManagerType::GEOMETRIC &&
           !rm_params.get<bool>("attach_geometric_early") && _mesh->isDistributedMesh())
  {
    _mesh->needsRemoteElemDeletion(true);
    if (_displaced_mesh)
      _displaced_mesh->needsRemoteElemDeletion(true);
  }
 
  rm_params.set<MooseMesh *>("mesh") = _mesh.get();
 
  if (rm_params.areAllRequiredParamsValid())
  {
    auto rm_obj = _factory.create<RelationshipManager>(rm_name, new_name, rm_params);
 
    // Delete the resources created on behalf of the RM if it ends up not being added to the App.
    if (!_app.addRelationshipManager(rm_obj))
      _factory.releaseSharedObjects(*rm_obj);
    else // we added it
      unique_object_id++;
  }
  else
    mooseError("Missing required parameters for RelationshipManager " + rm_name + " for object " +
               name());
}

Referenced by Action::addRelationshipManagers().

addRelationshipManagers() [1/2]

void Action::addRelationshipManagers ( Moose::RelationshipManagerType  when_type )

virtualinherited

Method to add a relationship manager for the objects being added to the system.

Relationship managers have to be added relatively early. In many cases before the Action::act() method is called.

Parameters

when_type

The parameter indicating the normal time for adding either Geometric or Algebraic RelationshipManagers. It may not always be possible to add your RelationshipManager as early as you'd like. In these cases, your DistributedMesh may consume more memory during the problem setup.

Reimplemented in MooseObjectAction.

Definition at line 194 of file Action.C.

{}

addRelationshipManagers() [2/2]

void Action::addRelationshipManagers ( Moose::RelationshipManagerType  when_type, const InputParameters &  moose_object_pars  )

protectedinherited

Method to add a relationship manager for the objects being added to the system.

Relationship managers have to be added relatively early. In many cases before the Action::act() method is called.

Parameters

when_type	The parameter indicating the normal time for adding either Geometric or Algebraic RelationshipManagers. It may not always be possible to add your RelationshipManager as early as you'd like. In these cases, your DistributedMesh may consume more memory during the problem setup.
moose_object_pars	The MooseObject to inspect for RelationshipManagers to add

Definition at line 197 of file Action.C.

{
  typedef RelationshipManager RM;
 
  const auto & buildable_types = moose_object_pars.getBuildableRelationshipManagerTypes();
 
  for (const auto & buildable_type : buildable_types)
  {
    auto & rm_name = std::get<0>(buildable_type);
    auto & rm_type = std::get<1>(buildable_type);
    auto rm_input_parameter_func = std::get<2>(buildable_type);
 
    // If we have an algebraic ghosting functor, then we are going to duplicate the
    // RelationshipManager object. This makes bookkeeping for relationship manager coverage more
    // straightforward, i.e. when we are deciding whether to add an algebraic relationship manager,
    // we can easily check whether a given System/DofMap is already covered or not. If we have an
    // object that is strictly a coupling functor, we will not duplicate it and we will apply it
    // just to the NonlinearSystem(Base). Duplicating RMs for the DofMaps is also very important for
    // ensuring that a non-null CouplingMatrix (reflecting coupling in the nonlinear system) doesn't
    // get applied to the auxiliary system
 
    bool is_algebraic = RM::isAlgebraic(rm_type);
    bool is_coupleable = RM::isCoupling(rm_type);
 
    auto sys_type = (is_algebraic || is_coupleable) ? Moose::RMSystemType::NONLINEAR
                                                    : Moose::RMSystemType::NONE;
 
    addRelationshipManager(
        input_rm_type, moose_object_pars, rm_name, rm_type, rm_input_parameter_func, sys_type);
 
    if (is_algebraic)
    {
      auto duplicate_rm_type = Moose::RelationshipManagerType::ALGEBRAIC;
      sys_type = Moose::RMSystemType::AUXILIARY;
      addRelationshipManager(input_rm_type,
                             moose_object_pars,
                             rm_name,
                             duplicate_rm_type,
                             rm_input_parameter_func,
                             sys_type);
    }
  }
}

Referenced by CouplingFunctorCheckAction::act().

appendTask()

void Action::appendTask ( const std::string &  task )

inlineinherited

Definition at line 146 of file Action.h.

{ _all_tasks.insert(task); }

getAllTasks()

const std::set<std::string>& Action::getAllTasks ( ) const

inlineinherited

Definition at line 122 of file Action.h.

{ return _all_tasks; }

Referenced by AddKernelAction::act().

getBaseName()

std::string Action::getBaseName ( ) const

inherited

Deprecated name methods, use name()

Definition at line 251 of file Action.C.

{
  mooseDeprecated("getBaseName() is deprecated.");
  return MooseUtils::baseName(_name);
}

getCheckedPointerParam()

template<typename T >

T Action::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 139 of file Action.h.

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

getMeshProperty()

template<typename T >

const T & MeshMetaDataInterface::getMeshProperty ( const std::string &  data_name, const std::string &  prefix  )

protectedinherited

Method for retrieving a property with the given type and name exists in the mesh meta-data store.

This method will throw an error if the property does not exist.

Definition at line 72 of file MeshMetaDataInterface.h.

{
  std::string full_name = std::string(SYSTEM) + "/" + prefix + "/" + data_name;
  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, nullptr);
 
  // Here we will create the RestartableData even though we may not use this instance.
  // If it's already in use, the App will return a reference to the existing instance and we'll
  // return that one instead. We might refactor this to have the app create the RestartableData
  // at a later date.
  auto & restartable_data_ref =
      static_cast<RestartableData<T> &>(registerMetaDataOnApp(full_name, std::move(data_ptr)));
 
  return restartable_data_ref.get();
}

getParamTempl()

template<typename T >

const T & Action::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 254 of file Action.h.

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

Referenced by MooseApp::getCheckpointDirectories().

getShortName()

std::string Action::getShortName ( ) const

inherited

DEPRECATED METHODS.

Definition at line 244 of file Action.C.

{
  mooseDeprecated("getShortName() is deprecated.");
  return MooseUtils::shortName(_name);
}

isParamValid()

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

inlineinherited

Definition at line 144 of file Action.h.

{ return _pars.isParamValid(name); }

Referenced by CopyNodalVarsAction::act(), SetAdaptivityOptionsAction::act(), SetupMeshAction::act(), act(), AddPeriodicBCAction::autoTranslationBoundaries(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and SetupMeshAction::setupMesh().

name()

const std::string& Action::name ( ) const

inlineinherited

The name of the action.

Definition at line 105 of file Action.h.

{ return _name; }

Referenced by AddElementalFieldAction::act(), CopyNodalVarsAction::act(), AdaptivityAction::act(), DeprecatedBlockAction::act(), DisplayGhostingAction::act(), AddVariableAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), Action::addRelationshipManager(), AddVariableAction::createInitialConditionAction(), Action::getCheckedPointerParam(), Action::getParamTempl(), Action::isParamValid(), GlobalParamsAction::remove(), GlobalParamsAction::setDoubleIndexParam(), GlobalParamsAction::setScalarParam(), and GlobalParamsAction::setVectorParam().

paramError()

template<typename... Args>

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

inlineinherited

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 155 of file Action.h.

  {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseError(prefix, args...);
  }

parameters() [1/2]

InputParameters& Action::parameters ( )

inlineinherited

Definition at line 117 of file Action.h.

{ return _pars; }

Referenced by Action::getCheckedPointerParam(), GlobalParamsAction::remove(), GlobalParamsAction::setDoubleIndexParam(), GlobalParamsAction::setScalarParam(), and GlobalParamsAction::setVectorParam().

parameters() [2/2]

const InputParameters& Action::parameters ( ) const

inlineinherited

Definition at line 118 of file Action.h.

{ return _pars; }

paramInfo()

template<typename... Args>

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

inlineinherited

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 186 of file Action.h.

  {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseInfo(prefix, args...);
  }

paramWarning()

template<typename... Args>

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

inlineinherited

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 170 of file Action.h.

  {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseWarning(prefix, args...);
  }

registerMetaDataOnApp()

RestartableDataValue & MeshMetaDataInterface::registerMetaDataOnApp ( const std::string &  name, std::unique_ptr< RestartableDataValue >  data  )

privateinherited

Helper function for actually registering the restartable data.

Definition at line 23 of file MeshMetaDataInterface.C.

{
  return _meta_data_app.registerRestartableData(name, std::move(data), 0, true, true);
}

Referenced by MeshMetaDataInterface::getMeshProperty().

registerTimedSection()

PerfID PerfGraphInterface::registerTimedSection ( const std::string &  section_name, const unsigned int  level  )

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns

The ID of the section - use when starting timing

Definition at line 51 of file PerfGraphInterface.C.

{
  if (_prefix != "")
    return _perf_graph.registerSection(_prefix + "::" + section_name, level);
  else
    return _perf_graph.registerSection(section_name, level);
}

specificTaskName()

const std::string& Action::specificTaskName ( ) const

inlineinherited

Definition at line 120 of file Action.h.

{ return _specific_task_name; }

timedAct()

void Action::timedAct ( )

inherited

The method called externally that causes the action to act()

Definition at line 90 of file Action.C.

{
  TIME_SECTION(_act_timer);
  act();
}

type()

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

inlineinherited

Definition at line 115 of file Action.h.

{ return _action_type; }

Referenced by CreateProblemDefaultAction::act(), SetupDebugAction::act(), addProxyRelationshipManagers(), MaterialOutputAction::getParams(), and CommonOutputAction::hasConsole().

validParams()

InputParameters CreateDisplacedProblemAction::validParams ( )

static

Definition at line 26 of file CreateDisplacedProblemAction.C.

{
  InputParameters params = Action::validParams();
  params.addParam<std::vector<std::string>>(
      "displacements",
      "The variables corresponding to the x y z displacements of the mesh.  If "
      "this is provided then the displacements will be taken into account during "
      "the computation. Creation of the displaced mesh can be suppressed even if "
      "this is set by setting 'use_displaced_mesh = false'.");
  params.addParam<bool>(
      "use_displaced_mesh",
      true,
      "Create the displaced mesh if the 'displacements' "
      "parameter is set. If this is 'false', a displaced mesh will not be created, "
      "regardless of whether 'displacements' is set.");
 
  return params;
}

Member Data Documentation

_act_timer

PerfID Action::_act_timer

protectedinherited

Timers.

Definition at line 249 of file Action.h.

Referenced by Action::timedAct().

_action_factory

ActionFactory& Action::_action_factory

protectedinherited

Builds Actions.

Definition at line 219 of file Action.h.

Referenced by CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and CreateExecutionerAction::setupAutoPreconditioning().

_action_type

std::string Action::_action_type

protectedinherited

Definition at line 210 of file Action.h.

Referenced by Action::type().

_all_tasks

std::set<std::string> Action::_all_tasks

protectedinherited

A list of all the tasks that this Action will satisfy.

Note: That this is not populated at construction time. However, all tasks will be added prior to act().

Definition at line 234 of file Action.h.

Referenced by Action::appendTask(), and Action::getAllTasks().

_app

MooseApp& Action::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 213 of file Action.h.

Referenced by CheckIntegrityAction::act(), CreateExecutionerAction::act(), ExecuteMeshGenerators::act(), CopyNodalVarsAction::act(), SetAdaptivityOptionsAction::act(), AddMeshModifierAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AddMeshGeneratorAction::act(), SplitMeshAction::act(), MeshOnlyAction::act(), SetupMeshAction::act(), AdaptivityAction::act(), SetupMeshCompleteAction::act(), SetupTimeStepperAction::act(), SetupPredictorAction::act(), CouplingFunctorCheckAction::act(), AddRelationshipManager::act(), DisplayGhostingAction::act(), SetupRecoverFileBaseAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), addProxyRelationshipManagers(), Action::addRelationshipManager(), CheckOutputAction::checkConsoleOutput(), CheckOutputAction::checkMaterialOutput(), CheckOutputAction::checkPerfLogOutput(), CheckOutputAction::checkVariableOutput(), SetupMeshCompleteAction::completeSetup(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), SetupMeshAction::modifyParamsForUseSplit(), and SetupMeshAction::setupMesh().

_awh

ActionWarehouse& Action::_awh

protectedinherited

Reference to ActionWarehouse where we store object build by actions.

Definition at line 237 of file Action.h.

Referenced by CheckIntegrityAction::act(), SetupDampersAction::act(), CreateExecutionerAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), AddRelationshipManager::act(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CommonOutputAction::hasConsole(), CreateExecutionerAction::setupAutoPreconditioning(), and SetupDebugAction::SetupDebugAction().

_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.

Referenced by IterationAdaptiveDT::acceptStep(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), SimplePredictor::apply(), MultiApp::backup(), FEProblemBase::backupMultiApps(), ReferenceResidualProblem::checkNonlinearConvergence(), FEProblemBase::checkProblemIntegrity(), CoarsenedPiecewiseLinear::CoarsenedPiecewiseLinear(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), NonlinearSystem::computeScaling(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppCopyTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), Steady::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MultiApp::globalAppToLocal(), InversePowerMethod::init(), NonlinearEigen::init(), Steady::init(), FEProblemBase::initialAdaptMesh(), FEProblemBase::initialSetup(), EigenExecutionerBase::inversePowerIteration(), Transient::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseObject::mooseDeprecated(), MooseObject::mooseInfo(), MooseObject::mooseWarning(), PerfGraphOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), MultiAppConservativeTransfer::postExecute(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), AutomaticMortarGeneration::projectMasterNodesSinglePair(), AutomaticMortarGeneration::projectSlaveNodesSinglePair(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), PicardSolve::solve(), NonlinearSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), PicardSolve::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), Transient::takeStep(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

_current_task

const std::string& Action::_current_task

protectedinherited

The current action (even though we have seperate instances for each action)

Definition at line 240 of file Action.h.

Referenced by AddDGKernelAction::act(), AddKernelAction::act(), AddScalarKernelAction::act(), SetAdaptivityOptionsAction::act(), CheckIntegrityAction::act(), CopyNodalVarsAction::act(), AddInterfaceKernelAction::act(), CreateProblemDefaultAction::act(), SetupMeshCompleteAction::act(), AdaptivityAction::act(), SetupMeshAction::act(), act(), AddRelationshipManager::act(), MaterialDerivativeTestAction::act(), DisplayGhostingAction::act(), AddOutputAction::act(), SetupRecoverFileBaseAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), and AddNodalNormalsAction::act().

_displaced_mesh

std::shared_ptr<MooseMesh>& Action::_displaced_mesh

protectedinherited

Definition at line 243 of file Action.h.

Referenced by SetupMeshAction::act(), SetupMeshCompleteAction::act(), act(), and Action::addRelationshipManager().

_factory

Factory& Action::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 216 of file Action.h.

Referenced by CreateExecutionerAction::act(), PartitionerAction::act(), SetAdaptivityOptionsAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AdaptivityAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), SetupPredictorAction::act(), SetupPreconditionerAction::act(), SetupTimeStepperAction::act(), SetupResidualDebugAction::act(), act(), MaterialDerivativeTestAction::act(), DisplayGhostingAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), AddControlAction::act(), AddNodalNormalsAction::act(), addProxyRelationshipManagers(), Action::addRelationshipManager(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and MaterialOutputAction::getParams().

_mesh

std::shared_ptr<MooseMesh>& Action::_mesh

protectedinherited

Definition at line 242 of file Action.h.

Referenced by PartitionerAction::act(), SetAdaptivityOptionsAction::act(), AddMeshGeneratorAction::act(), AddMeshModifierAction::act(), CreateProblemDefaultAction::act(), CreateProblemAction::act(), SetupMeshCompleteAction::act(), AdaptivityAction::act(), SetupMeshAction::act(), act(), AddPeriodicBCAction::act(), and Action::addRelationshipManager().

_meta_data_app

MooseApp& MeshMetaDataInterface::_meta_data_app

privateinherited

Reference to the application.

Definition at line 67 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::registerMetaDataOnApp().

_name

std::string Action::_name

protectedinherited

The name of the action.

Definition at line 207 of file Action.h.

Referenced by AddBCAction::act(), AddConstraintAction::act(), AddUserObjectAction::act(), AddInterfaceKernelAction::act(), AddMarkerAction::act(), AddMaterialAction::act(), AddScalarKernelAction::act(), AddPostprocessorAction::act(), AddDamperAction::act(), AddIndicatorAction::act(), AddTransferAction::act(), AddDiracKernelAction::act(), AddVectorPostprocessorAction::act(), AddMultiAppAction::act(), AddKernelAction::act(), AddInitialConditionAction::act(), PartitionerAction::act(), AddNodalKernelAction::act(), AddDGKernelAction::act(), AddMeshGeneratorAction::act(), AddFieldSplitAction::act(), AddMeshModifierAction::act(), SetupTimeIntegratorAction::act(), SetupPreconditionerAction::act(), AddDistributionAction::act(), AddFunctionAction::act(), AddSamplerAction::act(), AddOutputAction::act(), AddPeriodicBCAction::act(), AddControlAction::act(), SetupPostprocessorDataAction::act(), AddVariableAction::addVariable(), CouplingFunctorCheckAction::CouplingFunctorCheckAction(), Action::getBaseName(), Action::getShortName(), and Action::name().

_pars

InputParameters Action::_pars

protectedinherited

Input parameters for the action.

Definition at line 201 of file Action.h.

Referenced by AddICAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), Action::getParamTempl(), AddVariableAction::init(), Action::isParamValid(), Action::paramError(), Action::parameters(), Action::paramInfo(), Action::paramWarning(), and SetupMeshAction::setupMesh().

_perf_graph

PerfGraph& PerfGraphInterface::_perf_graph

protectedinherited

The performance graph to add to.

Definition at line 67 of file PerfGraphInterface.h.

Referenced by PerfGraphData::getValue(), and PerfGraphInterface::registerTimedSection().

_pg_params

const InputParameters* PerfGraphInterface::_pg_params

protectedinherited

Params.

Definition at line 64 of file PerfGraphInterface.h.

_prefix

std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 70 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::registerTimedSection().

_problem

std::shared_ptr<FEProblemBase>& Action::_problem

protectedinherited

Convenience reference to a problem this action works on.

Definition at line 246 of file Action.h.

Referenced by AddBCAction::act(), AddBoundsVectorsAction::act(), AddDGKernelAction::act(), AddInitialConditionAction::act(), AddConstraintAction::act(), AddInterfaceKernelAction::act(), AddVectorPostprocessorAction::act(), AddDiracKernelAction::act(), AddKernelAction::act(), AddICAction::act(), AddMultiAppAction::act(), CopyNodalVarsAction::act(), AddUserObjectAction::act(), AddTransferAction::act(), AddMarkerAction::act(), SetupDampersAction::act(), AddNodalKernelAction::act(), InitProblemAction::act(), AddDamperAction::act(), SetAdaptivityOptionsAction::act(), CreateExecutionerAction::act(), CheckIntegrityAction::act(), AddScalarKernelAction::act(), AddIndicatorAction::act(), AddPostprocessorAction::act(), AddMaterialAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AddFieldSplitAction::act(), SetupDebugAction::act(), AdaptivityAction::act(), SetupTimeStepperAction::act(), SetupPredictorAction::act(), AddDistributionAction::act(), AddFunctionAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), SetupResidualDebugAction::act(), act(), MaterialDerivativeTestAction::act(), CouplingFunctorCheckAction::act(), SetupQuadratureAction::act(), AddSamplerAction::act(), DisplayGhostingAction::act(), AddOutputAction::act(), AddExternalAuxVariableAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), AddControlAction::act(), SetupPostprocessorDataAction::act(), AddNodalNormalsAction::act(), Action::addRelationshipManager(), AddVariableAction::addVariable(), AddPeriodicBCAction::autoTranslationBoundaries(), CheckOutputAction::checkMaterialOutput(), CheckOutputAction::checkVariableOutput(), AddVariableAction::getSubdomainIDs(), MaterialOutputAction::materialOutputHelper(), and AddPeriodicBCAction::setPeriodicVars().

_registered_identifier

std::string Action::_registered_identifier

protectedinherited

Definition at line 204 of file Action.h.

Referenced by SetupMeshAction::act().

_specific_task_name

std::string Action::_specific_task_name

protectedinherited

This member will only be populated if this Action instance is only designed to handle one task.

This happens when an Action is registered with several pieces of syntax in which case separate instances are built to handle the different incoming parameter values.

Definition at line 227 of file Action.h.

Referenced by Action::specificTaskName().

FILE_SUFFIX

constexpr auto MeshMetaDataInterface::FILE_SUFFIX = "_mesh"

staticconstexprinherited

The suffix appended when writing the restartable data file.

Definition at line 32 of file MeshMetaDataInterface.h.

Referenced by SetupRecoverFileBaseAction::act(), and Checkpoint::output().

NAME

constexpr auto MeshMetaDataInterface::NAME = "<empty>"

staticconstexprinherited

The data name used when initializing the Restartable interface for non-MeshGenerator objects.

Definition at line 38 of file MeshMetaDataInterface.h.

SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticconstexprinherited

The system name used when initializing the Restartable interface.

Definition at line 35 of file MeshMetaDataInterface.h.

Referenced by MeshGenerator::declareMeshProperty(), and MeshMetaDataInterface::getMeshProperty().

---

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

• include/actions/CreateDisplacedProblemAction.h
• src/actions/CreateDisplacedProblemAction.C