SetupMeshAction Class Reference

#include <SetupMeshAction.h>

Inheritance diagram for SetupMeshAction:

Public Member Functions
	SetupMeshAction (InputParameters params)
virtual void	act () override
	Method to add objects to the simulation or perform other setup tasks. More...
virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type) override
	Method to add a relationship manager for the objects being added to the system. 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...
virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)
	Method to add a relationship manager for the objects being added to the system. More...
InputParameters &	getObjectParams ()
	Retreive the parameters of the object to be created by this action. More...
const InputParameters &	getObjectParams () const
	Constant version of retreiving the parameters of the object to be created by this action. More...
const std::string &	getMooseObjectType () const
	Return the object type to be created. More...
void	timedAct ()
	The method called externally that causes the action to act() 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 &	getParam (const std::string &name) const
	Retrieve a parameter for the object. More...

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

Protected Member Functions
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...
PerfID	registerTimedSection (const std::string &section_name, const unsigned int level)
	Call to register a named section for timing. More...

Protected Attributes
std::string	_type
	The Object type that is being created. More...
InputParameters	_moose_object_pars
	The parameters for the object to be created. More...
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	setupMesh (MooseMesh *mesh)

Detailed Description

Definition at line 22 of file SetupMeshAction.h.

Constructor & Destructor Documentation

SetupMeshAction()

SetupMeshAction::SetupMeshAction

(

InputParameters

params

)

Definition at line 88 of file SetupMeshAction.C.

: MooseObjectAction(params) {}

Member Function Documentation

act()

void SetupMeshAction::act ( )

overridevirtual

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

Implements Action.

Definition at line 165 of file SetupMeshAction.C.

{
  // Create the mesh object and tell it to build itself
  if (_current_task == "setup_mesh")
  {
    // switch non-file meshes to be a file-mesh if using a pre-split mesh configuration.
    if (_app.isUseSplit())
    {
      auto split_file = _app.parameters().get<std::string>("split_file");

      // Get the split_file extension, if there is one, and use that to decide
      // between .cpr and .cpa
      std::string split_file_ext;
      auto pos = split_file.rfind(".");
      if (pos != std::string::npos)
        split_file_ext = split_file.substr(pos + 1, std::string::npos);

      // If split_file already has the .cpr or .cpa extension, we go with
      // that, otherwise we strip off the extension and append ".cpr".
      if (split_file != "" && split_file_ext != "cpr" && split_file_ext != "cpa")
        split_file = MooseUtils::stripExtension(split_file) + ".cpr";

      if (_type != "FileMesh")
      {
        if (split_file == "")
        {
          if (_app.processor_id() == 0)
            mooseError(
                "Cannot use split mesh for a non-file mesh without specifying --split-file on "
                "command line");
        }

        _type = "FileMesh";
        auto new_pars = validParams<FileMesh>();

        // Keep existing parameters where possible
        new_pars.applyParameters(_moose_object_pars);

        new_pars.set<MeshFileName>("file") = split_file;
        new_pars.set<MooseApp *>("_moose_app") = _moose_object_pars.get<MooseApp *>("_moose_app");
        _moose_object_pars = new_pars;
      }
      else
      {
        if (split_file != "")
          _moose_object_pars.set<MeshFileName>("file") = split_file;
        else
          _moose_object_pars.set<MeshFileName>("file") =
              MooseUtils::stripExtension(_moose_object_pars.get<MeshFileName>("file")) + ".cpr";
      }
    }

    _mesh = _factory.create<MooseMesh>(_type, "mesh", _moose_object_pars);
  }

  else if (_current_task == "set_mesh_base")
    _mesh->setMeshBase(_mesh->buildMeshBaseObject());

  else if (_current_task == "init_mesh")
  {
    _mesh->init();

    if (isParamValid("displacements") && getParam<bool>("use_displaced_mesh"))
    {
      _displaced_mesh = _mesh->safeClone();
      _displaced_mesh->getMesh().allow_remote_element_removal(
          _mesh->getMesh().allow_remote_element_removal());

      std::vector<std::string> displacements = getParam<std::vector<std::string>>("displacements");
      if (displacements.size() < _displaced_mesh->dimension())
        mooseError(
            "Number of displacements must be greater than or equal to the dimension of the mesh!");
    }

    setupMesh(_mesh.get());

    if (_displaced_mesh)
      setupMesh(_displaced_mesh.get());
  }
}

addRelationshipManagers() [1/4]

void Action::addRelationshipManagers

inherited

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 95 of file Action.C.

{
  const auto & buildable_types = moose_object_pars.getBuildableRelationshipManagerTypes();

  // These need unique names
  static unsigned int unique_object_id = 0;

  for (const auto & buildable_type : buildable_types)
  {
    unique_object_id++;

    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);

    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<std::string>("for_whom") = name();

    // Figure out if we shouldn't be adding this one yet
    if (((rm_type & input_rm_type) != input_rm_type) // Does this RM not have the type passed in?

        || // 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 and Geometric one that we already added earlier?

        (((input_rm_type & Moose::RelationshipManagerType::ALGEBRAIC) ==
          Moose::RelationshipManagerType::ALGEBRAIC) &&
         (rm_type == (Moose::RelationshipManagerType::GEOMETRIC |
                      Moose::RelationshipManagerType::ALGEBRAIC)) &&
         rm_params.template get<bool>("attach_geometric_early")))
      continue;

    // 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
      continue;
    }
    // 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::ALGEBRAIC &&
             (rm_params.get<Moose::RelationshipManagerType>("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
      mooseError("Missing required parameters for RelationshipManager " + rm_name + " for object " +
                 name());
  }
}

addRelationshipManagers() [2/4]

void Action::addRelationshipManagers

inherited

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.

Definition at line 92 of file Action.C.

{}

addRelationshipManagers() [3/4]

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

overridevirtualinherited

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 from Action.

Definition at line 48 of file MooseObjectAction.C.

{
  addRelationshipManagers(input_rm_type, _moose_object_pars);
}

addRelationshipManagers() [4/4]

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 95 of file Action.C.

{
  const auto & buildable_types = moose_object_pars.getBuildableRelationshipManagerTypes();

  // These need unique names
  static unsigned int unique_object_id = 0;

  for (const auto & buildable_type : buildable_types)
  {
    unique_object_id++;

    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);

    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<std::string>("for_whom") = name();

    // Figure out if we shouldn't be adding this one yet
    if (((rm_type & input_rm_type) != input_rm_type) // Does this RM not have the type passed in?

        || // 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 and Geometric one that we already added earlier?

        (((input_rm_type & Moose::RelationshipManagerType::ALGEBRAIC) ==
          Moose::RelationshipManagerType::ALGEBRAIC) &&
         (rm_type == (Moose::RelationshipManagerType::GEOMETRIC |
                      Moose::RelationshipManagerType::ALGEBRAIC)) &&
         rm_params.template get<bool>("attach_geometric_early")))
      continue;

    // 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
      continue;
    }
    // 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::ALGEBRAIC &&
             (rm_params.get<Moose::RelationshipManagerType>("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
      mooseError("Missing required parameters for RelationshipManager " + rm_name + " for object " +
                 name());
  }
}

appendTask()

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

inlineinherited

Definition at line 118 of file Action.h.

{ _all_tasks.insert(task); }

getAllTasks()

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

inlineinherited

Definition at line 94 of file Action.h.

Referenced by AddKernelAction::act().

{ return _all_tasks; }

getBaseName()

std::string Action::getBaseName ( ) const

inherited

Deprecated name methods, use name()

Definition at line 200 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 111 of file Action.h.

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

getMooseObjectType()

const std::string& MooseObjectAction::getMooseObjectType ( ) const

inlineinherited

Return the object type to be created.

Definition at line 43 of file MooseObjectAction.h.

Referenced by CommonOutputAction::hasConsole().

{ return _type; }

getObjectParams() [1/2]

InputParameters& MooseObjectAction::getObjectParams ( )

inlineinherited

Retreive the parameters of the object to be created by this action.

Definition at line 33 of file MooseObjectAction.h.

Referenced by CreateProblemDefaultAction::act(), MaterialOutputAction::act(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), MooseApp::getCheckpointDirectories(), CommonOutputAction::hasConsole(), ActionWarehouse::printInputFile(), and Parser::walkRaw().

{ return _moose_object_pars; }

getObjectParams() [2/2]

const InputParameters& MooseObjectAction::getObjectParams ( ) const

inlineinherited

Constant version of retreiving the parameters of the object to be created by this action.

Definition at line 38 of file MooseObjectAction.h.

{ return _moose_object_pars; }

getParam()

template<typename T >

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

Referenced by CreateDisplacedProblemAction::act(), AddPeriodicBCAction::act(), AddPeriodicBCAction::autoTranslationBoundaries(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and MooseApp::getCheckpointDirectories().

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

getShortName()

std::string Action::getShortName ( ) const

inherited

DEPRECATED METHODS.

Definition at line 193 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 116 of file Action.h.

Referenced by CopyNodalVarsAction::act(), SetAdaptivityOptionsAction::act(), act(), CreateDisplacedProblemAction::act(), AddAuxVariableAction::act(), AddVariableAction::act(), AddVariableAction::addVariable(), AddPeriodicBCAction::autoTranslationBoundaries(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and setupMesh().

{ return _pars.isParamValid(name); }

name()

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

inlineinherited

The name of the action.

Definition at line 77 of file Action.h.

Referenced by AddElementalFieldAction::act(), CopyNodalVarsAction::act(), AdaptivityAction::act(), DeprecatedBlockAction::act(), AddMortarInterfaceAction::act(), DisplayGhostingAction::act(), AddAuxVariableAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), AddVariableAction::act(), Action::addRelationshipManagers(), CheckOutputAction::checkVariableOutput(), AddVariableAction::createInitialConditionAction(), Action::getCheckedPointerParam(), Action::getParam(), Action::isParamValid(), GlobalParamsAction::remove(), GlobalParamsAction::setDoubleIndexParam(), GlobalParamsAction::setScalarParam(), and GlobalParamsAction::setVectorParam().

{ return _name; }

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

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

{ return _pars; }

parameters() [2/2]

const InputParameters& Action::parameters ( ) const

inlineinherited

Definition at line 90 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 157 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 141 of file Action.h.

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

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 50 of file PerfGraphInterface.C.

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

setupMesh()

void SetupMeshAction::setupMesh ( MooseMesh *  mesh )

private

Definition at line 91 of file SetupMeshAction.C.

Referenced by act().

{
  std::vector<BoundaryName> ghosted_boundaries =
      getParam<std::vector<BoundaryName>>("ghosted_boundaries");

  for (const auto & bnd_name : ghosted_boundaries)
    mesh->addGhostedBoundary(mesh->getBoundaryID(bnd_name));

  if (isParamValid("ghosted_boundaries_inflation"))
  {
    std::vector<Real> ghosted_boundaries_inflation =
        getParam<std::vector<Real>>("ghosted_boundaries_inflation");
    mesh->setGhostedBoundaryInflation(ghosted_boundaries_inflation);
  }

  mesh->ghostGhostedBoundaries();

  if (getParam<bool>("second_order"))
    mesh->getMesh().all_second_order(true);

#ifdef LIBMESH_ENABLE_AMR
  unsigned int level = getParam<unsigned int>("uniform_refine");

  // Did they specify extra refinement levels on the command-line?
  level += _app.getParam<unsigned int>("refinements");

  mesh->setUniformRefineLevel(level);
#endif // LIBMESH_ENABLE_AMR

  // Add entity names to the mesh
  if (_pars.isParamValid("block_id") && _pars.isParamValid("block_name"))
  {
    std::vector<SubdomainID> ids = getParam<std::vector<SubdomainID>>("block_id");
    std::vector<SubdomainName> names = getParam<std::vector<SubdomainName>>("block_name");
    std::set<SubdomainName> seen_it;

    if (ids.size() != names.size())
      mooseError("You must supply the same number of block ids and names parameters");

    for (unsigned int i = 0; i < ids.size(); ++i)
    {
      if (seen_it.find(names[i]) != seen_it.end())
        mooseError("The following dynamic block name is not unique: " + names[i]);
      seen_it.insert(names[i]);
      mesh->setSubdomainName(ids[i], names[i]);
    }
  }
  if (_pars.isParamValid("boundary_id") && _pars.isParamValid("boundary_name"))
  {
    std::vector<BoundaryID> ids = getParam<std::vector<BoundaryID>>("boundary_id");
    std::vector<BoundaryName> names = getParam<std::vector<BoundaryName>>("boundary_name");
    std::set<SubdomainName> seen_it;

    if (ids.size() != names.size())
      mooseError("You must supply the same number of boundary ids and names parameters");

    for (unsigned int i = 0; i < ids.size(); ++i)
    {
      if (seen_it.find(names[i]) != seen_it.end())
        mooseError("The following dynamic boundary name is not unique: " + names[i]);
      mesh->setBoundaryName(ids[i], names[i]);
      seen_it.insert(names[i]);
    }
  }

  if (getParam<bool>("construct_side_list_from_node_list"))
    mesh->getMesh().get_boundary_info().build_side_list_from_node_list();

  // Here we can override the partitioning for special cases
  if (getParam<bool>("skip_partitioning"))
    mesh->getMesh().skip_partitioning(getParam<bool>("skip_partitioning"));
}

specificTaskName()

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

inlineinherited

Definition at line 92 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 86 of file Action.C.

{
  TIME_SECTION(_act_timer);
  act();
}

type()

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

inlineinherited

Definition at line 87 of file Action.h.

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

{ return _action_type; }

Member Data Documentation

_act_timer

PerfID Action::_act_timer

protectedinherited

Timers.

Definition at line 220 of file Action.h.

Referenced by Action::timedAct().

_action_factory

ActionFactory& Action::_action_factory

protectedinherited

Builds Actions.

Definition at line 190 of file Action.h.

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

_action_type

std::string Action::_action_type

protectedinherited

Definition at line 181 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 205 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 184 of file Action.h.

Referenced by CheckIntegrityAction::act(), ExecuteMeshGenerators::act(), CopyNodalVarsAction::act(), CreateExecutionerAction::act(), SetAdaptivityOptionsAction::act(), AddMeshModifierAction::act(), AddMeshGeneratorAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SplitMeshAction::act(), MeshOnlyAction::act(), act(), SetupMeshCompleteAction::act(), AdaptivityAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), AddRelationshipManager::act(), DisplayGhostingAction::act(), SetupRecoverFileBaseAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), CreateDisplacedProblemAction::addProxyAlgebraicRelationshipManagers(), CreateDisplacedProblemAction::addProxyGeometricRelationshipManagers(), Action::addRelationshipManagers(), CheckOutputAction::checkConsoleOutput(), CheckOutputAction::checkMaterialOutput(), CheckOutputAction::checkPerfLogOutput(), SetupMeshCompleteAction::completeSetup(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and setupMesh().

_awh

ActionWarehouse& Action::_awh

protectedinherited

Reference to ActionWarehouse where we store object build by actions.

Definition at line 208 of file Action.h.

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

_console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 32 of file ConsoleStreamInterface.h.

Referenced by IterationAdaptiveDT::acceptStep(), SetupRecoverFileBaseAction::act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), SimplePredictor::apply(), MultiApp::backup(), FEProblemBase::backupMultiApps(), FEProblemBase::checkProblemIntegrity(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppCopyTransfer::execute(), Steady::execute(), MultiAppDTKUserObjectTransfer::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), FEProblemBase::FEProblemBase(), 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(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), NonlinearSystem::solve(), PicardSolve::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), PicardSolve::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::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 211 of file Action.h.

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

_displaced_mesh

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

protectedinherited

Definition at line 214 of file Action.h.

Referenced by act(), SetupMeshCompleteAction::act(), AddMortarInterfaceAction::act(), CreateDisplacedProblemAction::act(), and Action::addRelationshipManagers().

_factory

Factory& Action::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 187 of file Action.h.

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

_mesh

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

protectedinherited

Definition at line 213 of file Action.h.

Referenced by PartitionerAction::act(), SetAdaptivityOptionsAction::act(), CreateProblemAction::act(), AddMeshModifierAction::act(), CreateProblemDefaultAction::act(), AddMeshGeneratorAction::act(), SetupMeshCompleteAction::act(), AdaptivityAction::act(), act(), AddMortarInterfaceAction::act(), CreateDisplacedProblemAction::act(), AddPeriodicBCAction::act(), and Action::addRelationshipManagers().

_moose_object_pars

InputParameters MooseObjectAction::_moose_object_pars

protectedinherited

The parameters for the object to be created.

Definition at line 50 of file MooseObjectAction.h.

Referenced by AddBCAction::act(), AddDamperAction::act(), AddInitialConditionAction::act(), AddUserObjectAction::act(), AddVectorPostprocessorAction::act(), AddTransferAction::act(), AddPostprocessorAction::act(), AddKernelAction::act(), AddDiracKernelAction::act(), AddScalarKernelAction::act(), AddICAction::act(), AddConstraintAction::act(), AddMarkerAction::act(), AddIndicatorAction::act(), AddNodalKernelAction::act(), AddInterfaceKernelAction::act(), CreateExecutionerAction::act(), AddDGKernelAction::act(), AddMultiAppAction::act(), PartitionerAction::act(), AddMaterialAction::act(), AddFieldSplitAction::act(), AddMeshGeneratorAction::act(), CreateProblemAction::act(), AddMeshModifierAction::act(), act(), AddDistributionAction::act(), SetupTimeStepperAction::act(), AddFunctionAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), SetupPredictorAction::act(), AddSamplerAction::act(), AddOutputAction::act(), AddControlAction::act(), MooseObjectAction::addRelationshipManagers(), MooseObjectAction::getObjectParams(), and MooseObjectAction::MooseObjectAction().

_name

std::string Action::_name

protectedinherited

The name of the action.

Definition at line 178 of file Action.h.

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

_pars

InputParameters Action::_pars

protectedinherited

Input parameters for the action.

Definition at line 172 of file Action.h.

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

_perf_graph

PerfGraph& PerfGraphInterface::_perf_graph

protectedinherited

The performance graph to add to.

Definition at line 66 of file PerfGraphInterface.h.

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

_pg_params

const InputParameters* PerfGraphInterface::_pg_params

protectedinherited

Params.

Definition at line 63 of file PerfGraphInterface.h.

_prefix

std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 69 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 217 of file Action.h.

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

_registered_identifier

std::string Action::_registered_identifier

protectedinherited

Definition at line 175 of file Action.h.

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

Referenced by Action::specificTaskName().

_type

std::string MooseObjectAction::_type

protectedinherited

The Object type that is being created.

Definition at line 47 of file MooseObjectAction.h.

Referenced by AddBCAction::act(), AddDamperAction::act(), AddInitialConditionAction::act(), AddScalarKernelAction::act(), AddTransferAction::act(), AddPostprocessorAction::act(), CreateExecutionerAction::act(), AddKernelAction::act(), AddDiracKernelAction::act(), AddIndicatorAction::act(), AddMultiAppAction::act(), AddVectorPostprocessorAction::act(), AddMarkerAction::act(), AddDGKernelAction::act(), AddNodalKernelAction::act(), AddInterfaceKernelAction::act(), AddUserObjectAction::act(), AddConstraintAction::act(), PartitionerAction::act(), AddICAction::act(), AddMaterialAction::act(), AddMeshModifierAction::act(), CreateProblemAction::act(), AddFieldSplitAction::act(), AddMeshGeneratorAction::act(), act(), SetupTimeStepperAction::act(), SetupPredictorAction::act(), AddDistributionAction::act(), AddFunctionAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), AddSamplerAction::act(), AddOutputAction::act(), AddControlAction::act(), and MooseObjectAction::getMooseObjectType().

---

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

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