www.mooseframework.org
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
AddPeriodicBCAction Class Reference

This Action adds a periodic boundary to the problem. More...

#include <AddPeriodicBCAction.h>

Inheritance diagram for AddPeriodicBCAction:
[legend]

Public Member Functions

 AddPeriodicBCAction (InputParameters params)
 
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
 
InputParametersparameters ()
 
const InputParametersparameters () const
 
const std::string & specificTaskName () const
 
const std::set< std::string > & getAllTasks () const
 
template<typename 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

bool autoTranslationBoundaries ()
 This function will automatically add the correct translation vectors for each requested dimension when using GeneratedMesh. More...
 
void setPeriodicVars (PeriodicBoundaryBase &p, const std::vector< VariableName > &var_names)
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level)
 Call to register a named section for timing. More...
 

Protected Attributes

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

Detailed Description

This Action adds a periodic boundary to the problem.

Note that Periodic Boundaries are not MooseObjects so you need not specify a type for these boundaries. If you do, it will currently be ignored by this Action.

Definition at line 30 of file AddPeriodicBCAction.h.

Constructor & Destructor Documentation

◆ AddPeriodicBCAction()

AddPeriodicBCAction::AddPeriodicBCAction ( InputParameters  params)

Definition at line 51 of file AddPeriodicBCAction.C.

51 : Action(params) {}
Action(InputParameters parameters)
Definition: Action.C:47

Member Function Documentation

◆ act()

void AddPeriodicBCAction::act ( )
overridevirtual

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

Implements Action.

Definition at line 150 of file AddPeriodicBCAction.C.

151 {
152  NonlinearSystemBase & nl = _problem->getNonlinearSystemBase();
153  _mesh = &_problem->mesh();
154  auto displaced_problem = _problem->getDisplacedProblem();
155 
157  return;
158 
159  if (_pars.isParamValid("translation"))
160  {
161  RealVectorValue translation = getParam<RealVectorValue>("translation");
162 
163  PeriodicBoundary p(translation);
164  p.myboundary = _mesh->getBoundaryID(getParam<BoundaryName>("primary"));
165  p.pairedboundary = _mesh->getBoundaryID(getParam<BoundaryName>("secondary"));
166  setPeriodicVars(p, getParam<std::vector<VariableName>>("variable"));
167 
168  _problem->addGhostedBoundary(p.myboundary);
169  _problem->addGhostedBoundary(p.pairedboundary);
170 
171  nl.dofMap().add_periodic_boundary(p);
172  if (displaced_problem)
173  displaced_problem->nlSys().dofMap().add_periodic_boundary(p);
174  }
175  else if (getParam<std::vector<std::string>>("transform_func") != std::vector<std::string>())
176  {
177  std::vector<std::string> inv_fn_names =
178  getParam<std::vector<std::string>>("inv_transform_func");
179  std::vector<std::string> fn_names = getParam<std::vector<std::string>>("transform_func");
180 
181  // If the user provided a forward transformation, he must also provide an inverse -- we can't
182  // form the inverse of an arbitrary function automatically...
183  if (inv_fn_names == std::vector<std::string>())
184  mooseError("You must provide an inv_transform_func for FunctionPeriodicBoundary!");
185 
186  FunctionPeriodicBoundary pb(*_problem, fn_names);
187  pb.myboundary = _mesh->getBoundaryID(getParam<BoundaryName>("primary"));
188  pb.pairedboundary = _mesh->getBoundaryID(getParam<BoundaryName>("secondary"));
189  setPeriodicVars(pb, getParam<std::vector<VariableName>>("variable"));
190 
191  FunctionPeriodicBoundary ipb(*_problem, inv_fn_names);
192  ipb.myboundary = _mesh->getBoundaryID(getParam<BoundaryName>("secondary")); // these are swapped
193  ipb.pairedboundary =
194  _mesh->getBoundaryID(getParam<BoundaryName>("primary")); // these are swapped
195  setPeriodicVars(ipb, getParam<std::vector<VariableName>>("variable"));
196 
197  _problem->addGhostedBoundary(ipb.myboundary);
198  _problem->addGhostedBoundary(ipb.pairedboundary);
199 
200  // Add the pair of periodic boundaries to the dof map
201  nl.dofMap().add_periodic_boundary(pb, ipb);
202  if (displaced_problem)
203  displaced_problem->nlSys().dofMap().add_periodic_boundary(pb, ipb);
204  }
205  else
206  {
207  mooseError("You have to specify either 'auto_direction', 'translation' or 'trans_func' in your "
208  "period boundary section '" +
209  _name + "'");
210  }
211 }
void setPeriodicVars(PeriodicBoundaryBase &p, const std::vector< VariableName > &var_names)
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:208
Periodic boundary for calculation periodic BC on domains where the translation is given by functions...
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
Definition: Action.h:211
bool autoTranslationBoundaries()
This function will automatically add the correct translation vectors for each requested dimension whe...
std::string _name
The name of the action.
Definition: Action.h:164
NonlinearSystemBase * nl
Nonlinear system to be solved.
virtual DofMap & dofMap()
Gets the dof map.
Definition: SystemBase.C:885
InputParameters _pars
Input parameters for the action.
Definition: Action.h:158
std::shared_ptr< FEProblemBase > & _problem
Convenience reference to a problem this action works on.
Definition: Action.h:203
BoundaryID getBoundaryID(const BoundaryName &boundary_name) const
Get the associated BoundaryID for the boundary name.
Definition: MooseMesh.C:1043
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.

◆ addRelationshipManagers()

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_typeThe 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 MooseADObjectAction, and MooseObjectAction.

Definition at line 89 of file Action.C.

89 {}

◆ appendTask()

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

Definition at line 103 of file Action.h.

103 { _all_tasks.insert(task); }
std::set< std::string > _all_tasks
A list of all the tasks that this Action will satisfy.
Definition: Action.h:191

◆ autoTranslationBoundaries()

bool AddPeriodicBCAction::autoTranslationBoundaries ( )
protected

This function will automatically add the correct translation vectors for each requested dimension when using GeneratedMesh.

Returns
a boolean indicating whether or not these boundaries were automatically added

Definition at line 78 of file AddPeriodicBCAction.C.

Referenced by act().

79 {
80  auto displaced_problem = _problem->getDisplacedProblem();
81 
82  if (isParamValid("auto_direction"))
83  {
84  // If we are working with a parallel mesh then we're going to ghost all the boundaries
85  // everywhere because we don't know what we need...
86  if (_mesh->isDistributedMesh())
87  {
88  const std::set<BoundaryID> & ids = _mesh->meshBoundaryIds();
89  for (const auto & bid : ids)
90  _problem->addGhostedBoundary(bid);
91 
92  _problem->ghostGhostedBoundaries();
93 
94  bool is_orthogonal_mesh = _mesh->detectOrthogonalDimRanges();
95 
96  // If we can't detect the orthogonal dimension ranges for this
97  // Mesh, then auto_direction periodicity isn't going to work.
98  if (!is_orthogonal_mesh)
99  mooseError("Could not detect orthogonal dimension ranges for DistributedMesh.");
100  }
101 
102  NonlinearSystemBase & nl = _problem->getNonlinearSystemBase();
103  std::vector<std::string> auto_dirs = getParam<std::vector<std::string>>("auto_direction");
104 
105  int dim_offset = _mesh->dimension() - 2;
106  for (const auto & dir : auto_dirs)
107  {
108  int component = -1;
109  if (dir == "X" || dir == "x")
110  component = 0;
111  else if (dir == "Y" || dir == "y")
112  {
113  if (dim_offset < 0)
114  mooseError("Cannot wrap 'Y' direction when using a 1D mesh");
115  component = 1;
116  }
117  else if (dir == "Z" || dir == "z")
118  {
119  if (dim_offset <= 0)
120  mooseError("Cannot wrap 'Z' direction when using a 1D or 2D mesh");
121  component = 2;
122  }
123 
124  if (component >= 0)
125  {
126  const std::pair<BoundaryID, BoundaryID> * boundary_ids =
127  _mesh->getPairedBoundaryMapping(component);
128  RealVectorValue v;
129  v(component) = _mesh->dimensionWidth(component);
130  PeriodicBoundary p(v);
131 
132  if (boundary_ids == NULL)
133  mooseError(
134  "Couldn't auto-detect a paired boundary for use with periodic boundary conditions");
135 
136  p.myboundary = boundary_ids->first;
137  p.pairedboundary = boundary_ids->second;
138  setPeriodicVars(p, getParam<std::vector<VariableName>>("variable"));
139  nl.dofMap().add_periodic_boundary(p);
140  if (displaced_problem)
141  displaced_problem->nlSys().dofMap().add_periodic_boundary(p);
142  }
143  }
144  return true;
145  }
146  return false;
147 }
bool isParamValid(const std::string &name) const
Definition: Action.h:101
void setPeriodicVars(PeriodicBoundaryBase &p, const std::vector< VariableName > &var_names)
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:208
bool isDistributedMesh() const
Returns the final Mesh distribution type.
Definition: MooseMesh.h:750
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
Definition: Action.h:211
const std::set< BoundaryID > & meshBoundaryIds() const
Returns a read-only reference to the set of boundary IDs currently present in the Mesh...
Definition: MooseMesh.C:2267
NonlinearSystemBase * nl
Nonlinear system to be solved.
virtual DofMap & dofMap()
Gets the dof map.
Definition: SystemBase.C:885
virtual unsigned int dimension() const
Returns MeshBase::mesh_dimsension(), (not MeshBase::spatial_dimension()!) of the underlying libMesh m...
Definition: MooseMesh.C:2099
const std::pair< BoundaryID, BoundaryID > * getPairedBoundaryMapping(unsigned int component)
This function attempts to return the paired boundary ids for the given component. ...
Definition: MooseMesh.C:1585
bool detectOrthogonalDimRanges(Real tol=1e-6)
This routine determines whether the Mesh is a regular orthogonal mesh (i.e.
Definition: MooseMesh.C:1319
Real dimensionWidth(unsigned int component) const
Returns the width of the requested dimension.
Definition: MooseMesh.C:1500
std::shared_ptr< FEProblemBase > & _problem
Convenience reference to a problem this action works on.
Definition: Action.h:203

◆ getAllTasks()

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

Definition at line 79 of file Action.h.

Referenced by AddKernelAction::act().

79 { return _all_tasks; }
std::set< std::string > _all_tasks
A list of all the tasks that this Action will satisfy.
Definition: Action.h:191

◆ getBaseName()

std::string Action::getBaseName ( ) const
inherited

Deprecated name methods, use name()

Definition at line 100 of file Action.C.

101 {
102  mooseDeprecated("getBaseName() is deprecated.");
103  return MooseUtils::baseName(_name);
104 }
std::string _name
The name of the action.
Definition: Action.h:164
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
Definition: MooseError.h:237
std::string baseName(const std::string &name)
Function for string the information before the final / in a parser block.
Definition: MooseUtils.C:366

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

97  {
98  return parameters().getCheckedPointerParam<T>(name, error_string);
99  }
const std::string & name() const
The name of the action.
Definition: Action.h:62
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...
InputParameters & parameters()
Definition: Action.h:74

◆ getParam()

template<typename T >
const T & Action::getParam ( const std::string &  name) const
inherited

Retrieve a parameter for the object.

Parameters
nameThe name of the parameter
Returns
The value of the parameter

Definition at line 211 of file Action.h.

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

212 {
213  return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0));
214 }
static const T & getParamHelper(const std::string &name, const InputParameters &pars, const T *the_type)
const std::string & name() const
The name of the action.
Definition: Action.h:62
InputParameters _pars
Input parameters for the action.
Definition: Action.h:158

◆ getShortName()

std::string Action::getShortName ( ) const
inherited

DEPRECATED METHODS.

Definition at line 93 of file Action.C.

94 {
95  mooseDeprecated("getShortName() is deprecated.");
97 }
std::string shortName(const std::string &name)
Function for stripping name after the file / in parser block.
Definition: MooseUtils.C:360
std::string _name
The name of the action.
Definition: Action.h:164
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
Definition: MooseError.h:237

◆ isParamValid()

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

Definition at line 101 of file Action.h.

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

101 { return _pars.isParamValid(name); }
const std::string & name() const
The name of the action.
Definition: Action.h:62
InputParameters _pars
Input parameters for the action.
Definition: Action.h:158
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.

◆ name()

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

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

113  {
114  auto prefix = param + ": ";
115  if (!_pars.inputLocation(param).empty())
116  prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
117  mooseError(prefix, args...);
118  }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:208
InputParameters _pars
Input parameters for the action.
Definition: Action.h:158
const std::string & inputLocation(const std::string &param) const
Get/set a string representing the location in the input text the parameter originated from (i...
const std::string & paramFullpath(const std::string &param) const
Get/set a string representing the full HIT parameter path from the input file (e.g.

◆ parameters() [1/2]

InputParameters& Action::parameters ( )
inlineinherited

Definition at line 74 of file Action.h.

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

74 { return _pars; }
InputParameters _pars
Input parameters for the action.
Definition: Action.h:158

◆ parameters() [2/2]

const InputParameters& Action::parameters ( ) const
inlineinherited

Definition at line 75 of file Action.h.

75 { return _pars; }
InputParameters _pars
Input parameters for the action.
Definition: Action.h:158

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

144  {
145  auto prefix = param + ": ";
146  if (!_pars.inputLocation(param).empty())
147  prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
148  mooseInfo(prefix, args...);
149  }
void mooseInfo(Args &&... args)
Emit an informational message with the given stringified, concatenated args.
Definition: MooseError.h:253
InputParameters _pars
Input parameters for the action.
Definition: Action.h:158
const std::string & inputLocation(const std::string &param) const
Get/set a string representing the location in the input text the parameter originated from (i...
const std::string & paramFullpath(const std::string &param) const
Get/set a string representing the full HIT parameter path from the input file (e.g.

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

128  {
129  auto prefix = param + ": ";
130  if (!_pars.inputLocation(param).empty())
131  prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
132  mooseWarning(prefix, args...);
133  }
void mooseWarning(Args &&... args)
Emit a warning message with the given stringified, concatenated args.
Definition: MooseError.h:220
InputParameters _pars
Input parameters for the action.
Definition: Action.h:158
const std::string & inputLocation(const std::string &param) const
Get/set a string representing the location in the input text the parameter originated from (i...
const std::string & paramFullpath(const std::string &param) const
Get/set a string representing the full HIT parameter path from the input file (e.g.

◆ registerTimedSection()

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

Call to register a named section for timing.

Parameters
section_nameThe name of the code section to be timed
levelThe 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.

51 {
52  if (_prefix != "")
53  return _perf_graph.registerSection(_prefix + "::" + section_name, level);
54  else
55  return _perf_graph.registerSection(section_name, level);
56 }
PerfGraph & _perf_graph
The performance graph to add to.
std::string _prefix
A prefix to use for all sections.
PerfID registerSection(const std::string &section_name, unsigned int level)
Registers a named section of code.
Definition: PerfGraph.C:41

◆ setPeriodicVars()

void AddPeriodicBCAction::setPeriodicVars ( PeriodicBoundaryBase &  p,
const std::vector< VariableName > &  var_names 
)
protected

Definition at line 54 of file AddPeriodicBCAction.C.

Referenced by act(), and autoTranslationBoundaries().

56 {
57  NonlinearSystemBase & nl = _problem->getNonlinearSystemBase();
58  const std::vector<VariableName> * var_names_ptr;
59 
60  // If var_names is empty - then apply this periodic condition to all variables in the system
61  if (var_names.empty())
62  var_names_ptr = &nl.getVariableNames();
63  else
64  var_names_ptr = &var_names;
65 
66  for (const auto & var_name : *var_names_ptr)
67  {
68  if (!nl.hasScalarVariable(var_name))
69  {
70  unsigned int var_num = nl.getVariable(0, var_name).number();
71  p.set_variable(var_num);
72  _mesh->addPeriodicVariable(var_num, p.myboundary, p.pairedboundary);
73  }
74  }
75 }
unsigned int number() const
Get variable number coming from libMesh.
NonlinearSystemBase * nl
Nonlinear system to be solved.
MooseVariableFEBase & getVariable(THREAD_ID tid, const std::string &var_name)
Gets a reference to a variable of with specified name.
Definition: SystemBase.C:101
void addPeriodicVariable(unsigned int var_num, BoundaryID primary, BoundaryID secondary)
For "regular orthogonal" meshes, determine if variable var_num is periodic with respect to the primar...
Definition: MooseMesh.C:1522
const std::vector< VariableName > & getVariableNames() const
Definition: SystemBase.h:651
std::shared_ptr< FEProblemBase > & _problem
Convenience reference to a problem this action works on.
Definition: Action.h:203
virtual bool hasScalarVariable(const std::string &var_name) const
Definition: SystemBase.C:646

◆ specificTaskName()

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

Definition at line 77 of file Action.h.

77 { return _specific_task_name; }
std::string _specific_task_name
This member will only be populated if this Action instance is only designed to handle one task...
Definition: Action.h:184

◆ timedAct()

void Action::timedAct ( )
inherited

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

Definition at line 83 of file Action.C.

84 {
85  TIME_SECTION(_act_timer);
86  act();
87 }
PerfID _act_timer
Timers.
Definition: Action.h:206
virtual void act()=0
Method to add objects to the simulation or perform other setup tasks.

◆ type()

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

Member Data Documentation

◆ _act_timer

PerfID Action::_act_timer
protectedinherited

Timers.

Definition at line 206 of file Action.h.

Referenced by Action::timedAct().

◆ _action_factory

ActionFactory& Action::_action_factory
protectedinherited

◆ _action_type

std::string Action::_action_type
protectedinherited

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

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

◆ _app

MooseApp& Action::_app
protectedinherited

◆ _awh

ActionWarehouse& Action::_awh
protectedinherited

◆ _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(), FEProblemBase::backupMultiApps(), FEProblemBase::checkProblemIntegrity(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), AB2PredictorCorrector::converged(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppUserObjectTransfer::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(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), NonlinearSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), Transient::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

◆ _current_task

const std::string& Action::_current_task
protectedinherited

◆ _displaced_mesh

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

◆ _factory

Factory& Action::_factory
protectedinherited

◆ _mesh

MooseMesh* AddPeriodicBCAction::_mesh
protected

Definition at line 47 of file AddPeriodicBCAction.h.

Referenced by act(), autoTranslationBoundaries(), and setPeriodicVars().

◆ _name

std::string Action::_name
protectedinherited

◆ _pars

InputParameters Action::_pars
protectedinherited

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

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

◆ _registered_identifier

std::string Action::_registered_identifier
protectedinherited

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

Referenced by Action::specificTaskName().


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