https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
TestAction Class Referenceabstract

Base class for adding common actions for testing. More...

#include <TestAction.h>

Inheritance diagram for TestAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 TestAction (const InputParameters &params)
 
virtual void act ()
 
void timedAct ()
 
virtual void addRelationshipManagers (Moose::RelationshipManagerType when_type)
 
MooseObjectName uniqueActionName () const
 
const std::string & specificTaskName () const
 
const std::set< std::string > & getAllTasks () const
 
void appendTask (const std::string &task)
 
MooseAppgetMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParametersparameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
PerfGraphperfGraph ()
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

void addMeshInternal (const unsigned int &nx)
 Adds the mesh with a provided number of elements in x direction. More...
 
virtual void addObjects ()
 Adds all non-mesh objects. More...
 
void addScalarVariables (const std::vector< VariableName > &names, const std::vector< FunctionName > &values)
 Adds scalar variables. More...
 
virtual void addAuxVariables ()
 Adds aux variables. More...
 
virtual void addMaterials ()
 Adds materials. More...
 
void addSolutionVariable (const VariableName &var_name, const std::string &family="LAGRANGE", const std::string &order="FIRST", const Real &scaling=1.0)
 Adds a solution variable. More...
 
void addAuxVariable (const VariableName &var_name, const std::string &fe_family, const std::string &fe_order)
 Adds an aux variable. More...
 
void addConstantIC (const VariableName &var_name, const Real &value)
 Adds a constant initial condition. More...
 
void addFunctionIC (const VariableName &var_name, const FunctionName &function_name)
 Adds a function initial condition. More...
 
virtual void addMesh ()
 Adds the mesh. More...
 
virtual void addPreconditioner ()
 Adds the preconditioner. More...
 
virtual void addExecutioner ()
 Adds the executioner. More...
 
virtual void addOutput ()
 Add output. More...
 
virtual void addInitialConditions ()=0
 Adds the initial conditions. More...
 
virtual void addSolutionVariables ()=0
 Adds the solution variables. More...
 
virtual void addUserObjects ()=0
 Adds user objects. More...
 
bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
void associateWithParameter (const std::string &param_name, InputParameters &params) const
 
void associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

bool _default_use_transient_executioner
 Default for option to use a transient executioner. More...
 
const std::vector< VariableName > _scalar_variables
 List of scalar variables to add. More...
 
const std::vector< FunctionName > _scalar_variable_values
 List of values for the scalar variables to add. More...
 
const std::vector< VariableName > _aux_variables
 List of aux variables to add. More...
 
const std::vector< FunctionName > _aux_variable_values
 List of function names for aux variables to add. More...
 
const std::vector< std::string > _mat_property_names
 List of material properties to add. More...
 
const std::vector< FunctionName > _mat_property_values
 List of function names for material properties to add. More...
 
const std::string _fe_family
 Default FE family. More...
 
const std::string _fe_order
 Default FE order. More...
 
const bool & _ad
 True for setting up testing with AD, false otherwise. More...
 
std::string _registered_identifier
 
std::string _specific_task_name
 
std::set< std::string > _all_tasks
 
ActionWarehouse_awh
 
const std::string & _current_task
 
std::shared_ptr< MooseMesh > & _mesh
 
std::shared_ptr< MooseMesh > & _displaced_mesh
 
std::shared_ptr< FEProblemBase > & _problem
 
PerfID _act_timer
 
MooseApp_app
 
const std::string _type
 
const std::string _name
 
const InputParameters_pars
 
Factory_factory
 
ActionFactory_action_factory
 
MooseApp_pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Detailed Description

Base class for adding common actions for testing.

Definition at line 17 of file TestAction.h.

Constructor & Destructor Documentation

◆ TestAction()

TestAction::TestAction ( const InputParameters params)

Definition at line 44 of file TestAction.C.

45  : Action(params),
46  // if a derived class should have a different default, then that class needs
47  // to set this parameter in its constructor
49 
50  _scalar_variables(getParam<std::vector<VariableName>>("scalar_variable_names")),
51  _scalar_variable_values(getParam<std::vector<FunctionName>>("scalar_variable_values")),
52  _aux_variables(getParam<std::vector<VariableName>>("aux_variable_names")),
53  _aux_variable_values(getParam<std::vector<FunctionName>>("aux_variable_values")),
54  _mat_property_names(getParam<std::vector<std::string>>("mat_property_names")),
55  _mat_property_values(getParam<std::vector<FunctionName>>("mat_property_values")),
56  _fe_family(getParam<std::string>("fe_family")),
57  _fe_order(getParam<std::string>("fe_order")),
58  _ad(getParam<bool>("ad"))
59 {
60  if (_scalar_variables.size() != _scalar_variable_values.size())
61  mooseError(name(),
62  ": The parameters 'scalar_variable_names' and ",
63  "'scalar_variable_values' must have the same numbers of entries.");
64  if (_aux_variables.size() != _aux_variable_values.size())
65  mooseError(name(),
66  ": The parameters 'aux_variable_names' and ",
67  "'aux_variable_values' must have the same numbers of entries.");
68  if (_mat_property_names.size() != _mat_property_values.size())
69  mooseError(name(),
70  ": The parameters 'mat_property_names' and ",
71  "'mat_property_values' must have the same numbers of entries.");
72 }
const std::vector< std::string > _mat_property_names
List of material properties to add.
Definition: TestAction.h:145
const std::vector< VariableName > _aux_variables
List of aux variables to add.
Definition: TestAction.h:140
Action(const InputParameters &parameters)
const std::string _fe_order
Default FE order.
Definition: TestAction.h:152
virtual const std::string & name() const
const std::vector< FunctionName > _aux_variable_values
List of function names for aux variables to add.
Definition: TestAction.h:142
const std::vector< VariableName > _scalar_variables
List of scalar variables to add.
Definition: TestAction.h:135
const T & getParam(const std::string &name) const
const bool & _ad
True for setting up testing with AD, false otherwise.
Definition: TestAction.h:154
const std::vector< FunctionName > _mat_property_values
List of function names for material properties to add.
Definition: TestAction.h:147
const std::vector< FunctionName > _scalar_variable_values
List of values for the scalar variables to add.
Definition: TestAction.h:137
const std::string _fe_family
Default FE family.
Definition: TestAction.h:150
void mooseError(Args &&... args) const
bool _default_use_transient_executioner
Default for option to use a transient executioner.
Definition: TestAction.h:132

Member Function Documentation

◆ act()

void TestAction::act ( )
virtual

Implements Action.

Definition at line 75 of file TestAction.C.

76 {
77  if (_current_task == "meta_action")
78  {
79  if (getParam<bool>("generate_mesh"))
80  addMesh();
81 
82  addObjects();
83 
84  {
85  const std::string class_name = "CreateProblemAction";
86  auto action_params = _action_factory.getValidParams(class_name);
87  action_params.set<std::string>("type") = "FEProblem";
88 
89  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
90  _action_factory.create(class_name, "fe_problem", action_params));
91 
92  action->getObjectParams().set<MooseEnum>("kernel_coverage_check") = "false";
93  _awh.addActionBlock(action);
94  }
95  }
96 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
virtual void addObjects()
Adds all non-mesh objects.
Definition: TestAction.C:140
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
InputParameters & getObjectParams()
const std::string & _current_task
ActionFactory & _action_factory
virtual void addMesh()
Adds the mesh.
Definition: TestAction.C:99

◆ addAuxVariable()

void TestAction::addAuxVariable ( const VariableName &  var_name,
const std::string &  fe_family,
const std::string &  fe_order 
)
protected

Adds an aux variable.

Parameters
[in]var_namename of the variable to add
[in]fe_familyfinite element family
[in]fe_orderfinite element order

Definition at line 248 of file TestAction.C.

Referenced by ClosureTestAction::addAuxVariables(), JacobianTest1PhaseRDGAction::addAuxVariables(), addAuxVariables(), ClosureTestAction::setupADOutput(), and ClosureTestAction::setupOutput().

251 {
252  const std::string class_name = "AddAuxVariableAction";
253  InputParameters params = _action_factory.getValidParams(class_name);
254 
255  params.set<MooseEnum>("family") = fe_family;
256  params.set<MooseEnum>("order") = fe_order;
257 
258  std::shared_ptr<Action> action =
259  std::static_pointer_cast<Action>(_action_factory.create(class_name, var_name, params));
260 
261  _awh.addActionBlock(action);
262 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
ActionFactory & _action_factory

◆ addAuxVariables()

void TestAction::addAuxVariables ( )
protectedvirtual

Adds aux variables.

Reimplemented in JacobianTestGeneralAction, JacobianTest1PhaseRDGAction, JacobianTest1PhaseAction, ClosureTest1PhaseAction, and ClosureTestAction.

Definition at line 180 of file TestAction.C.

Referenced by ClosureTestAction::addAuxVariables(), JacobianTest1PhaseAction::addAuxVariables(), JacobianTestGeneralAction::addAuxVariables(), and addObjects().

181 {
182  const std::vector<VariableName> names = _aux_variables;
183  const std::vector<FunctionName> values = _aux_variable_values;
184  const std::string fe_family = _fe_family;
185  const std::string fe_order = _fe_order;
186 
187  for (unsigned int i = 0; i < names.size(); ++i)
188  {
189  // add the aux variable
190  addAuxVariable(names[i], fe_family, fe_order);
191 
192  // add its IC
193  addFunctionIC(names[i], values[i]);
194 
195  // add its aux kernel
196  {
197  const std::string class_name = "AddKernelAction";
198  InputParameters params = _action_factory.getValidParams(class_name);
199  params.set<std::string>("type") = "FunctionAux";
200  params.set<std::string>("task") = "add_aux_kernel";
201 
202  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
203  _action_factory.create(class_name, names[i] + "_aux", params));
204 
205  action->getObjectParams().set<AuxVariableName>("variable") = names[i];
206  action->getObjectParams().set<FunctionName>("function") = values[i];
207 
208  _awh.addActionBlock(action);
209  }
210  }
211 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
const std::vector< VariableName > _aux_variables
List of aux variables to add.
Definition: TestAction.h:140
void addAuxVariable(const VariableName &var_name, const std::string &fe_family, const std::string &fe_order)
Adds an aux variable.
Definition: TestAction.C:248
T & set(const std::string &name, bool quiet_mode=false)
const std::string _fe_order
Default FE order.
Definition: TestAction.h:152
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
const std::vector< FunctionName > _aux_variable_values
List of function names for aux variables to add.
Definition: TestAction.h:142
InputParameters & getObjectParams()
ActionFactory & _action_factory
const std::string _fe_family
Default FE family.
Definition: TestAction.h:150
void addFunctionIC(const VariableName &var_name, const FunctionName &function_name)
Adds a function initial condition.
Definition: TestAction.C:281

◆ addConstantIC()

void TestAction::addConstantIC ( const VariableName &  var_name,
const Real value 
)
protected

Adds a constant initial condition.

Parameters
[in]var_namename of the variable for which to add initial condition
[in]valuevalue of the initial condition

Definition at line 265 of file TestAction.C.

Referenced by JacobianTest1PhaseRDGAction::addSolutionVariables().

266 {
267  const std::string class_name = "AddInitialConditionAction";
268  InputParameters params = _action_factory.getValidParams(class_name);
269  params.set<std::string>("type") = "ConstantIC";
270 
271  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
272  _action_factory.create(class_name, var_name + "_IC", params));
273 
274  action->getObjectParams().set<VariableName>("variable") = var_name;
275  action->getObjectParams().set<Real>("value") = value;
276 
277  _awh.addActionBlock(action);
278 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
InputParameters & getObjectParams()
ActionFactory & _action_factory
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ addExecutioner()

void TestAction::addExecutioner ( )
protectedvirtual

Adds the executioner.

Definition at line 302 of file TestAction.C.

Referenced by addObjects().

303 {
304  const std::string class_name = "CreateExecutionerAction";
305 
306  // determine whether to use a transient executioner - different derived
307  // classes have different defaults: the declared default is irrelevant
308  bool use_transient_executioner;
309  if (isParamValid("use_transient_executioner"))
310  use_transient_executioner = getParam<bool>("use_transient_executioner");
311  else
312  use_transient_executioner = _default_use_transient_executioner;
313 
314  // Due to more consistent divergence status reporting in PETSc (as of 5f3c5e7a), users should have
315  // the option to abort on the first fail if desired. Otherwise Jacobian testing, for example, could
316  // fail in undesired ways, even if the Jacobian test achieves a passing result.
317  bool abort_on_solve_fail = getParam<bool>("abort_on_solve_fail");
318 
319  // if a time kernel is being tested, then use a transient executioner instead of steady
320  if (use_transient_executioner)
321  {
322  InputParameters params = _action_factory.getValidParams(class_name);
323  params.set<std::string>("type") = "Transient";
324 
325  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
326  _action_factory.create(class_name, "executioner", params));
327 
328  action->getObjectParams().set<unsigned int>("num_steps") = 1;
329 
330  if (abort_on_solve_fail)
331  action->getObjectParams().set<bool>("abort_on_solve_fail") = abort_on_solve_fail;
332 
333  _awh.addActionBlock(action);
334  }
335  else
336  {
337  InputParameters params = _action_factory.getValidParams(class_name);
338  params.set<std::string>("type") = "Steady";
339 
340  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
341  _action_factory.create(class_name, "executioner", params));
342 
343  if (abort_on_solve_fail)
344  action->getObjectParams().set<bool>("abort_on_solve_fail") = abort_on_solve_fail;
345 
346  _awh.addActionBlock(action);
347  }
348 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
bool isParamValid(const std::string &name) const
InputParameters & getObjectParams()
ActionFactory & _action_factory
bool _default_use_transient_executioner
Default for option to use a transient executioner.
Definition: TestAction.h:132

◆ addFunctionIC()

void TestAction::addFunctionIC ( const VariableName &  var_name,
const FunctionName &  function_name 
)
protected

Adds a function initial condition.

Parameters
[in]var_namename of the variable for which to add initial condition
[in]function_namenames of the IC function

Definition at line 281 of file TestAction.C.

Referenced by JacobianTest1PhaseRDGAction::addAuxVariables(), addAuxVariables(), ClosureTestAction::addInitialConditions(), JacobianTestGeneralAction::addSolutionVariables(), and JacobianTest1PhaseRDGAction::addSolutionVariablesRiemannIC().

282 {
283  const std::string class_name = "AddInitialConditionAction";
284  InputParameters params = _action_factory.getValidParams(class_name);
285  params.set<std::string>("type") = "FunctionIC";
286 
287  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
288  _action_factory.create(class_name, var_name + "_IC", params));
289 
290  action->getObjectParams().set<VariableName>("variable") = var_name;
291  action->getObjectParams().set<FunctionName>("function") = function_name;
292 
293  _awh.addActionBlock(action);
294 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
InputParameters & getObjectParams()
ActionFactory & _action_factory

◆ addInitialConditions()

virtual void TestAction::addInitialConditions ( )
protectedpure virtual

◆ addMaterials()

void TestAction::addMaterials ( )
protectedvirtual

Adds materials.

Reimplemented in JacobianTestGeneralAction, JacobianTest1PhaseRDGAction, JacobianTest1PhaseAction, ClosureTest1PhaseAction, and ClosureTestAction.

Definition at line 214 of file TestAction.C.

Referenced by ClosureTestAction::addMaterials(), JacobianTest1PhaseAction::addMaterials(), JacobianTestGeneralAction::addMaterials(), and addObjects().

215 {
216  const std::string class_name = "AddMaterialAction";
217  InputParameters params = _action_factory.getValidParams(class_name);
218  params.set<std::string>("type") = "GenericFunctionMaterial";
219 
220  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
221  _action_factory.create(class_name, "material", params));
222 
223  action->getObjectParams().set<std::vector<std::string>>("prop_names") = _mat_property_names;
224  action->getObjectParams().set<std::vector<FunctionName>>("prop_values") = _mat_property_values;
225 
226  _awh.addActionBlock(action);
227 }
const std::vector< std::string > _mat_property_names
List of material properties to add.
Definition: TestAction.h:145
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
InputParameters & getObjectParams()
const std::vector< FunctionName > _mat_property_values
List of function names for material properties to add.
Definition: TestAction.h:147
ActionFactory & _action_factory

◆ addMesh()

void TestAction::addMesh ( )
protectedvirtual

Adds the mesh.

Reimplemented in JacobianTest1PhaseRDGAction.

Definition at line 99 of file TestAction.C.

Referenced by act().

100 {
101  addMeshInternal(1);
102 }
void addMeshInternal(const unsigned int &nx)
Adds the mesh with a provided number of elements in x direction.
Definition: TestAction.C:105

◆ addMeshInternal()

void TestAction::addMeshInternal ( const unsigned int nx)
protected

Adds the mesh with a provided number of elements in x direction.

Parameters
[in]nxnumber of elements in x direction

Definition at line 105 of file TestAction.C.

Referenced by JacobianTest1PhaseRDGAction::addMesh(), and addMesh().

106 {
107  std::vector<std::string> setup_mesh_tasks{"setup_mesh", "set_mesh_base", "init_mesh"};
108  for (const std::string & task : setup_mesh_tasks)
109  {
110  const std::string class_name = "SetupMeshAction";
111  InputParameters params = _action_factory.getValidParams(class_name);
112  params.set<std::string>("type") = "GeneratedMesh";
113  params.set<std::string>("task") = task;
114 
115  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
116  _action_factory.create(class_name, task, params));
117 
118  action->getObjectParams().set<MooseEnum>("dim") = 1;
119  action->getObjectParams().set<unsigned int>("nx") = nx;
120  action->getObjectParams().set<bool>("allow_renumbering") = false;
121 
122  _awh.addActionBlock(action);
123  }
124 
125  std::vector<std::string> setup_mesh_complete_tasks{"prepare_mesh", "setup_mesh_complete"};
126  for (const std::string & task : setup_mesh_complete_tasks)
127  {
128  const std::string class_name = "SetupMeshCompleteAction";
129  InputParameters params = _action_factory.getValidParams(class_name);
130  params.set<std::string>("task") = task;
131 
132  std::shared_ptr<Action> action =
133  std::static_pointer_cast<Action>(_action_factory.create(class_name, task, params));
134 
135  _awh.addActionBlock(action);
136  }
137 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
InputParameters & getObjectParams()
ActionFactory & _action_factory

◆ addObjects()

void TestAction::addObjects ( )
protectedvirtual

Adds all non-mesh objects.

Reimplemented in JacobianTest1PhaseRDGAction.

Definition at line 140 of file TestAction.C.

Referenced by act(), and JacobianTest1PhaseRDGAction::addObjects().

141 {
144  addAuxVariables();
146  addUserObjects();
147  addMaterials();
149  addExecutioner();
150  addOutput();
151 }
void addScalarVariables(const std::vector< VariableName > &names, const std::vector< FunctionName > &values)
Adds scalar variables.
Definition: TestAction.C:154
virtual void addPreconditioner()
Adds the preconditioner.
Definition: TestAction.C:297
virtual void addAuxVariables()
Adds aux variables.
Definition: TestAction.C:180
virtual void addInitialConditions()=0
Adds the initial conditions.
virtual void addExecutioner()
Adds the executioner.
Definition: TestAction.C:302
virtual void addOutput()
Add output.
Definition: TestAction.C:351
const std::vector< VariableName > _scalar_variables
List of scalar variables to add.
Definition: TestAction.h:135
virtual void addMaterials()
Adds materials.
Definition: TestAction.C:214
virtual void addSolutionVariables()=0
Adds the solution variables.
const std::vector< FunctionName > _scalar_variable_values
List of values for the scalar variables to add.
Definition: TestAction.h:137
virtual void addUserObjects()=0
Adds user objects.

◆ addOutput()

void TestAction::addOutput ( )
protectedvirtual

Add output.

Reimplemented in ClosureTestAction.

Definition at line 351 of file TestAction.C.

Referenced by addObjects().

352 {
353 }

◆ addPreconditioner()

void TestAction::addPreconditioner ( )
protectedvirtual

Adds the preconditioner.

Reimplemented in JacobianTestAction.

Definition at line 297 of file TestAction.C.

Referenced by addObjects().

298 {
299 }

◆ addScalarVariables()

void TestAction::addScalarVariables ( const std::vector< VariableName > &  names,
const std::vector< FunctionName > &  values 
)
protected

Adds scalar variables.

Parameters
[in]namesnames of the variables to add
[in]valuesvalues of the variables to add

Definition at line 154 of file TestAction.C.

Referenced by addObjects().

156 {
157  for (unsigned int i = 0; i < names.size(); ++i)
158  {
159  // add the scalar variable
160  addSolutionVariable(names[i], "SCALAR", "FIRST");
161 
162  // add its IC
163  {
164  const std::string class_name = "AddInitialConditionAction";
165  InputParameters params = _action_factory.getValidParams(class_name);
166  params.set<std::string>("type") = "FunctionScalarIC";
167 
168  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
169  _action_factory.create(class_name, names[i] + "_IC", params));
170 
171  action->getObjectParams().set<VariableName>("variable") = names[i];
172  action->getObjectParams().set<std::vector<FunctionName>>("function") = {values[i]};
173 
174  _awh.addActionBlock(action);
175  }
176  }
177 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
InputParameters & getObjectParams()
void addSolutionVariable(const VariableName &var_name, const std::string &family="LAGRANGE", const std::string &order="FIRST", const Real &scaling=1.0)
Adds a solution variable.
Definition: TestAction.C:230
ActionFactory & _action_factory

◆ addSolutionVariable()

void TestAction::addSolutionVariable ( const VariableName &  var_name,
const std::string &  family = "LAGRANGE",
const std::string &  order = "FIRST",
const Real scaling = 1.0 
)
protected

Adds a solution variable.

Parameters
[in]var_namename of the variable to add
[in]familyvariable family
[in]ordervariable order
[in]scalingscaling factor to apply to variable

Definition at line 230 of file TestAction.C.

Referenced by addScalarVariables(), ClosureTestAction::addSolutionVariables(), JacobianTest1PhaseRDGAction::addSolutionVariables(), JacobianTestGeneralAction::addSolutionVariables(), and JacobianTest1PhaseRDGAction::addSolutionVariablesRiemannIC().

234 {
235  const std::string class_name = "AddVariableAction";
236  InputParameters params = _action_factory.getValidParams(class_name);
237  params.set<MooseEnum>("family") = family;
238  params.set<MooseEnum>("order") = order;
239  params.set<std::vector<Real>>("scaling") = {scaling};
240 
241  std::shared_ptr<Action> action =
242  std::static_pointer_cast<Action>(_action_factory.create(class_name, var_name, params));
243 
244  _awh.addActionBlock(action);
245 }
ActionWarehouse & _awh
InputParameters getValidParams(const std::string &name)
T & set(const std::string &name, bool quiet_mode=false)
void addActionBlock(std::shared_ptr< Action > blk)
std::shared_ptr< Action > create(const std::string &action, const std::string &action_name, InputParameters &parameters)
ActionFactory & _action_factory

◆ addSolutionVariables()

virtual void TestAction::addSolutionVariables ( )
protectedpure virtual

Adds the solution variables.

Implemented in JacobianTestGeneralAction, JacobianTest1PhaseRDGAction, JacobianTest1PhaseAction, and ClosureTestAction.

Referenced by addObjects().

◆ addUserObjects()

virtual void TestAction::addUserObjects ( )
protectedpure virtual

◆ validParams()

InputParameters TestAction::validParams ( )
static

Definition at line 17 of file TestAction.C.

Referenced by JacobianTestAction::validParams(), and ClosureTestAction::validParams().

18 {
20 
21  params.addParam<bool>("use_transient_executioner", "Option to use a transient executioner");
22  params.addParam<bool>("generate_mesh", true, "Option to have the action generate the mesh");
23  params.addParam<std::vector<VariableName>>(
24  "scalar_variable_names", {}, "List of scalar variables");
25  params.addParam<std::vector<FunctionName>>(
26  "scalar_variable_values", {}, "List of values of the scalar variables");
27  params.addParam<std::vector<VariableName>>("aux_variable_names", {}, "List of aux variables");
28  params.addParam<std::vector<FunctionName>>(
29  "aux_variable_values", {}, "List of values of the aux variables");
30  params.addParam<std::vector<std::string>>(
31  "mat_property_names", {}, "List of material property names");
32  params.addParam<std::vector<FunctionName>>(
33  "mat_property_values", {}, "List of values of the material properties");
34  params.addParam<bool>("ad", false, "Setup for AD or non-AD testing");
35 
36  params.addPrivateParam<std::string>("fe_family");
37  params.addPrivateParam<std::string>("fe_order");
38 
39  params.addParam<bool>("abort_on_solve_fail", false, "Abort if the solve did not converge rather than cut the timestep");
40 
41  return params;
42 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addPrivateParam(const std::string &name, const T &value)
static InputParameters validParams()

Member Data Documentation

◆ _ad

const bool& TestAction::_ad
protected

True for setting up testing with AD, false otherwise.

Definition at line 154 of file TestAction.h.

Referenced by ClosureTestAction::addMaterials(), and JacobianTest1PhaseRDGAction::addMaterials().

◆ _aux_variable_values

const std::vector<FunctionName> TestAction::_aux_variable_values
protected

List of function names for aux variables to add.

Definition at line 142 of file TestAction.h.

Referenced by addAuxVariables(), and TestAction().

◆ _aux_variables

const std::vector<VariableName> TestAction::_aux_variables
protected

List of aux variables to add.

Definition at line 140 of file TestAction.h.

Referenced by addAuxVariables(), and TestAction().

◆ _default_use_transient_executioner

bool TestAction::_default_use_transient_executioner
protected

Default for option to use a transient executioner.

Definition at line 132 of file TestAction.h.

Referenced by addExecutioner(), and ClosureTestAction::ClosureTestAction().

◆ _fe_family

const std::string TestAction::_fe_family
protected

◆ _fe_order

const std::string TestAction::_fe_order
protected

◆ _mat_property_names

const std::vector<std::string> TestAction::_mat_property_names
protected

List of material properties to add.

Definition at line 145 of file TestAction.h.

Referenced by addMaterials(), and TestAction().

◆ _mat_property_values

const std::vector<FunctionName> TestAction::_mat_property_values
protected

List of function names for material properties to add.

Definition at line 147 of file TestAction.h.

Referenced by addMaterials(), and TestAction().

◆ _scalar_variable_values

const std::vector<FunctionName> TestAction::_scalar_variable_values
protected

List of values for the scalar variables to add.

Definition at line 137 of file TestAction.h.

Referenced by addObjects(), and TestAction().

◆ _scalar_variables

const std::vector<VariableName> TestAction::_scalar_variables
protected

List of scalar variables to add.

Definition at line 135 of file TestAction.h.

Referenced by addObjects(), and TestAction().


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