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

#include <TestAction.h>

Inheritance diagram for TestAction:

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)

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () 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

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

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

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

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

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

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

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

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

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

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

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

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

void	mooseDeprecatedNoTrace (Args &&... args) const

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

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.

virtual void	addObjects ()
	Adds all non-mesh objects.

void	addScalarVariables (const std::vector< VariableName > &names, const std::vector< FunctionName > &values)
	Adds scalar variables.

virtual void	addAuxVariables ()
	Adds aux variables.

virtual void	addMaterials ()
	Adds materials.

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.

void	addAuxVariable (const VariableName &var_name, const std::string &fe_family, const std::string &fe_order)
	Adds an aux variable.

void	addConstantIC (const VariableName &var_name, const Real &value)
	Adds a constant initial condition.

void	addFunctionIC (const VariableName &var_name, const FunctionName &function_name)
	Adds a function initial condition.

virtual void	addMesh ()
	Adds the mesh.

virtual void	addPreconditioner ()
	Adds the preconditioner.

virtual void	addExecutioner ()
	Adds the executioner.

virtual void	addOutput ()
	Add output.

virtual void	addInitialConditions ()=0
	Adds the initial conditions.

virtual void	addSolutionVariables ()=0
	Adds the solution variables.

virtual void	addUserObjects ()=0
	Adds user objects.

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) 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.

const std::vector< VariableName >	_scalar_variables
	List of scalar variables to add.

const std::vector< FunctionName >	_scalar_variable_values
	List of values for the scalar variables to add.

const std::vector< VariableName >	_aux_variables
	List of aux variables to add.

const std::vector< FunctionName >	_aux_variable_values
	List of function names for aux variables to add.

const std::vector< std::string >	_mat_property_names
	List of material properties to add.

const std::vector< FunctionName >	_mat_property_values
	List of function names for material properties to add.

const std::string	_fe_family
	Default FE family.

const std::string	_fe_order
	Default FE order.

const bool &	_ad
	True for setting up testing with AD, false otherwise.

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

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

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 46 of file TestAction.C.

  : Action(params),
    // if a derived class should have a different default, then that class needs
    // to set this parameter in its constructor
    _default_use_transient_executioner(false),
 
    _scalar_variables(getParam<std::vector<VariableName>>("scalar_variable_names")),
    _scalar_variable_values(getParam<std::vector<FunctionName>>("scalar_variable_values")),
    _aux_variables(getParam<std::vector<VariableName>>("aux_variable_names")),
    _aux_variable_values(getParam<std::vector<FunctionName>>("aux_variable_values")),
    _mat_property_names(getParam<std::vector<std::string>>("mat_property_names")),
    _mat_property_values(getParam<std::vector<FunctionName>>("mat_property_values")),
    _fe_family(getParam<std::string>("fe_family")),
    _fe_order(getParam<std::string>("fe_order")),
    _ad(getParam<bool>("ad"))
{
  if (_scalar_variables.size() != _scalar_variable_values.size())
    mooseError(name(),
               ": The parameters 'scalar_variable_names' and ",
               "'scalar_variable_values' must have the same numbers of entries.");
  if (_aux_variables.size() != _aux_variable_values.size())
    mooseError(name(),
               ": The parameters 'aux_variable_names' and ",
               "'aux_variable_values' must have the same numbers of entries.");
  if (_mat_property_names.size() != _mat_property_values.size())
    mooseError(name(),
               ": The parameters 'mat_property_names' and ",
               "'mat_property_values' must have the same numbers of entries.");
}

Member Function Documentation

◆ act()

void TestAction::act ( )

virtual

Implements Action.

Definition at line 77 of file TestAction.C.

{
  if (_current_task == "meta_action")
  {
    if (getParam<bool>("generate_mesh"))
      addMesh();
 
    addObjects();
 
    {
      const std::string class_name = "CreateProblemAction";
      auto action_params = _action_factory.getValidParams(class_name);
      action_params.set<std::string>("type") = "FEProblem";
 
      std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
          _action_factory.create(class_name, "fe_problem", action_params));
 
      action->getObjectParams().set<MooseEnum>("kernel_coverage_check") = "false";
      _awh.addActionBlock(action);
    }
  }
}

◆ 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_name	name of the variable to add
[in]	fe_family	finite element family
[in]	fe_order	finite element order

Definition at line 250 of file TestAction.C.

{
  const std::string class_name = "AddAuxVariableAction";
  InputParameters params = _action_factory.getValidParams(class_name);
 
  params.set<MooseEnum>("family") = fe_family;
  params.set<MooseEnum>("order") = fe_order;
 
  std::shared_ptr<Action> action =
      std::static_pointer_cast<Action>(_action_factory.create(class_name, var_name, params));
 
  _awh.addActionBlock(action);
}

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

◆ addAuxVariables()

void TestAction::addAuxVariables ( )

protectedvirtual

Adds aux variables.

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

Definition at line 182 of file TestAction.C.

{
  const std::vector<VariableName> names = _aux_variables;
  const std::vector<FunctionName> values = _aux_variable_values;
  const std::string fe_family = _fe_family;
  const std::string fe_order = _fe_order;
 
  for (unsigned int i = 0; i < names.size(); ++i)
  {
    // add the aux variable
    addAuxVariable(names[i], fe_family, fe_order);
 
    // add its IC
    addFunctionIC(names[i], values[i]);
 
    // add its aux kernel
    {
      const std::string class_name = "AddKernelAction";
      InputParameters params = _action_factory.getValidParams(class_name);
      params.set<std::string>("type") = "FunctionAux";
      params.set<std::string>("task") = "add_aux_kernel";
 
      std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
          _action_factory.create(class_name, names[i] + "_aux", params));
 
      action->getObjectParams().set<AuxVariableName>("variable") = names[i];
      action->getObjectParams().set<FunctionName>("function") = values[i];
 
      _awh.addActionBlock(action);
    }
  }
}

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

◆ addConstantIC()

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

protected

Adds a constant initial condition.

Parameters

[in]	var_name	name of the variable for which to add initial condition
[in]	value	value of the initial condition

Definition at line 267 of file TestAction.C.

{
  const std::string class_name = "AddInitialConditionAction";
  InputParameters params = _action_factory.getValidParams(class_name);
  params.set<std::string>("type") = "ConstantIC";
 
  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
      _action_factory.create(class_name, var_name + "_IC", params));
 
  action->getObjectParams().set<VariableName>("variable") = var_name;
  action->getObjectParams().set<Real>("value") = value;
 
  _awh.addActionBlock(action);
}

Referenced by JacobianTest1PhaseRDGAction::addSolutionVariables().

◆ addExecutioner()

void TestAction::addExecutioner ( )

protectedvirtual

Adds the executioner.

Definition at line 304 of file TestAction.C.

{
  const std::string class_name = "CreateExecutionerAction";
 
  // determine whether to use a transient executioner - different derived
  // classes have different defaults: the declared default is irrelevant
  bool use_transient_executioner;
  if (isParamValid("use_transient_executioner"))
    use_transient_executioner = getParam<bool>("use_transient_executioner");
  else
    use_transient_executioner = _default_use_transient_executioner;
 
  // Due to more consistent divergence status reporting in PETSc (as of 5f3c5e7a), users should have
  // the option to abort on the first fail if desired. Otherwise Jacobian testing, for example,
  // could fail in undesired ways, even if the Jacobian test achieves a passing result.
  bool abort_on_solve_fail = getParam<bool>("abort_on_solve_fail");
 
  // if a time kernel is being tested, then use a transient executioner instead of steady
  if (use_transient_executioner)
  {
    InputParameters params = _action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "Transient";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _action_factory.create(class_name, "executioner", params));
 
    action->getObjectParams().set<unsigned int>("num_steps") = 1;
 
    if (abort_on_solve_fail)
      action->getObjectParams().set<bool>("abort_on_solve_fail") = abort_on_solve_fail;
 
    _awh.addActionBlock(action);
  }
  else
  {
    InputParameters params = _action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "Steady";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _action_factory.create(class_name, "executioner", params));
 
    if (abort_on_solve_fail)
      action->getObjectParams().set<bool>("abort_on_solve_fail") = abort_on_solve_fail;
 
    _awh.addActionBlock(action);
  }
}

Referenced by addObjects().

◆ addFunctionIC()

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

protected

Adds a function initial condition.

Parameters

[in]	var_name	name of the variable for which to add initial condition
[in]	function_name	names of the IC function

Definition at line 283 of file TestAction.C.

{
  const std::string class_name = "AddInitialConditionAction";
  InputParameters params = _action_factory.getValidParams(class_name);
  params.set<std::string>("type") = "FunctionIC";
 
  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
      _action_factory.create(class_name, var_name + "_IC", params));
 
  action->getObjectParams().set<VariableName>("variable") = var_name;
  action->getObjectParams().set<FunctionName>("function") = function_name;
 
  _awh.addActionBlock(action);
}

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

◆ addInitialConditions()

virtual void TestAction::addInitialConditions ( )

protectedpure virtual

Adds the initial conditions.

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

Referenced by addObjects().

◆ addMaterials()

void TestAction::addMaterials ( )

protectedvirtual

Adds materials.

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

Definition at line 216 of file TestAction.C.

{
  const std::string class_name = "AddMaterialAction";
  InputParameters params = _action_factory.getValidParams(class_name);
  params.set<std::string>("type") = "GenericFunctionMaterial";
 
  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
      _action_factory.create(class_name, "material", params));
 
  action->getObjectParams().set<std::vector<std::string>>("prop_names") = _mat_property_names;
  action->getObjectParams().set<std::vector<FunctionName>>("prop_values") = _mat_property_values;
 
  _awh.addActionBlock(action);
}

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

◆ addMesh()

void TestAction::addMesh ( )

protectedvirtual

Adds the mesh.

Reimplemented in JacobianTest1PhaseRDGAction.

Definition at line 101 of file TestAction.C.

{
  addMeshInternal(1);
}

Referenced by act().

◆ addMeshInternal()

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

protected

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

Parameters

[in] nx number of elements in x direction

Definition at line 107 of file TestAction.C.

{
  std::vector<std::string> setup_mesh_tasks{"setup_mesh", "set_mesh_base", "init_mesh"};
  for (const std::string & task : setup_mesh_tasks)
  {
    const std::string class_name = "SetupMeshAction";
    InputParameters params = _action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "GeneratedMesh";
    params.set<std::string>("task") = task;
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _action_factory.create(class_name, task, params));
 
    action->getObjectParams().set<MooseEnum>("dim") = 1;
    action->getObjectParams().set<unsigned int>("nx") = nx;
    action->getObjectParams().set<bool>("allow_renumbering") = false;
 
    _awh.addActionBlock(action);
  }
 
  std::vector<std::string> setup_mesh_complete_tasks{"prepare_mesh", "setup_mesh_complete"};
  for (const std::string & task : setup_mesh_complete_tasks)
  {
    const std::string class_name = "SetupMeshCompleteAction";
    InputParameters params = _action_factory.getValidParams(class_name);
    params.set<std::string>("task") = task;
 
    std::shared_ptr<Action> action =
        std::static_pointer_cast<Action>(_action_factory.create(class_name, task, params));
 
    _awh.addActionBlock(action);
  }
}

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

◆ addObjects()

void TestAction::addObjects ( )

protectedvirtual

Adds all non-mesh objects.

Reimplemented in JacobianTest1PhaseRDGAction.

Definition at line 142 of file TestAction.C.

{
  addSolutionVariables();
  addScalarVariables(_scalar_variables, _scalar_variable_values);
  addAuxVariables();
  addInitialConditions();
  addUserObjects();
  addMaterials();
  addPreconditioner();
  addExecutioner();
  addOutput();
}

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

◆ addOutput()

void TestAction::addOutput ( )

protectedvirtual

Add output.

Reimplemented in ClosureTestAction.

Definition at line 353 of file TestAction.C.

354{

355}

Referenced by addObjects().

◆ addPreconditioner()

void TestAction::addPreconditioner ( )

protectedvirtual

Adds the preconditioner.

Reimplemented in JacobianTestAction.

Definition at line 299 of file TestAction.C.

300{

301}

Referenced by addObjects().

◆ addScalarVariables()

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

protected

Adds scalar variables.

Parameters

[in]	names	names of the variables to add
[in]	values	values of the variables to add

Definition at line 156 of file TestAction.C.

{
  for (unsigned int i = 0; i < names.size(); ++i)
  {
    // add the scalar variable
    addSolutionVariable(names[i], "SCALAR", "FIRST");
 
    // add its IC
    {
      const std::string class_name = "AddInitialConditionAction";
      InputParameters params = _action_factory.getValidParams(class_name);
      params.set<std::string>("type") = "FunctionScalarIC";
 
      std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
          _action_factory.create(class_name, names[i] + "_IC", params));
 
      action->getObjectParams().set<VariableName>("variable") = names[i];
      action->getObjectParams().set<std::vector<FunctionName>>("function") = {values[i]};
 
      _awh.addActionBlock(action);
    }
  }
}

Referenced by addObjects().

◆ 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_name	name of the variable to add
[in]	family	variable family
[in]	order	variable order
[in]	scaling	scaling factor to apply to variable

Definition at line 232 of file TestAction.C.

{
  const std::string class_name = "AddVariableAction";
  InputParameters params = _action_factory.getValidParams(class_name);
  params.set<MooseEnum>("family") = family;
  params.set<MooseEnum>("order") = order;
  params.set<std::vector<Real>>("scaling") = {scaling};
 
  std::shared_ptr<Action> action =
      std::static_pointer_cast<Action>(_action_factory.create(class_name, var_name, params));
 
  _awh.addActionBlock(action);
}

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

◆ addSolutionVariables()

virtual void TestAction::addSolutionVariables ( )

protectedpure virtual

Adds the solution variables.

Implemented in ClosureTestAction, JacobianTest1PhaseAction, JacobianTest1PhaseRDGAction, and JacobianTestGeneralAction.

Referenced by addObjects().

◆ addUserObjects()

virtual void TestAction::addUserObjects ( )

protectedpure virtual

Adds user objects.

Implemented in ClosureTest1PhaseAction, JacobianTest1PhaseAction, JacobianTest1PhaseRDGAction, and JacobianTestGeneralAction.

Referenced by addObjects().

◆ validParams()

InputParameters TestAction::validParams ( )

static

Definition at line 17 of file TestAction.C.

{
  InputParameters params = Action::validParams();
 
  params.addParam<bool>("use_transient_executioner", "Option to use a transient executioner");
  params.addParam<bool>("generate_mesh", true, "Option to have the action generate the mesh");
  params.addParam<std::vector<VariableName>>(
      "scalar_variable_names", {}, "List of scalar variables");
  params.addParam<std::vector<FunctionName>>(
      "scalar_variable_values", {}, "List of values of the scalar variables");
  params.addParam<std::vector<VariableName>>("aux_variable_names", {}, "List of aux variables");
  params.addParam<std::vector<FunctionName>>(
      "aux_variable_values", {}, "List of values of the aux variables");
  params.addParam<std::vector<std::string>>(
      "mat_property_names", {}, "List of material property names");
  params.addParam<std::vector<FunctionName>>(
      "mat_property_values", {}, "List of values of the material properties");
  params.addParam<bool>("ad", false, "Setup for AD or non-AD testing");
 
  params.addPrivateParam<std::string>("fe_family");
  params.addPrivateParam<std::string>("fe_order");
 
  params.addParam<bool>("abort_on_solve_fail",
                        false,
                        "Abort if the solve did not converge rather than cut the timestep");
 
  return params;
}

Referenced by ClosureTestAction::validParams(), and JacobianTestAction::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

Default FE family.

Definition at line 150 of file TestAction.h.

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

◆ _fe_order

const std::string TestAction::_fe_order

protected

Default FE order.

Definition at line 152 of file TestAction.h.

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

◆ _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:

thermal_hydraulics/test/include/actions/TestAction.h
thermal_hydraulics/test/src/actions/TestAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TestAction()

Member Function Documentation

◆ act()

◆ addAuxVariable()

◆ addAuxVariables()

◆ addConstantIC()

◆ addExecutioner()

◆ addFunctionIC()

◆ addInitialConditions()

◆ addMaterials()

◆ addMesh()

◆ addMeshInternal()

◆ addObjects()

◆ addOutput()

◆ addPreconditioner()

◆ addScalarVariables()

◆ addSolutionVariable()

◆ addSolutionVariables()

◆ addUserObjects()

◆ validParams()

Member Data Documentation

◆ _ad

◆ _aux_variable_values

◆ _aux_variables

◆ _default_use_transient_executioner

◆ _fe_family

◆ _fe_order

◆ _mat_property_names

◆ _mat_property_values

◆ _scalar_variable_values

◆ _scalar_variables