Action for setting up a Jacobian test for 1-phase flow. More...

#include <JacobianTest1PhaseAction.h>

Inheritance diagram for JacobianTest1PhaseAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	JacobianTest1PhaseAction (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
virtual void	addInitialConditions () override
	Adds the initial conditions.

virtual void	addSolutionVariables () override
	Adds the solution variables.

virtual void	addAuxVariables () override
	Adds aux variables.

virtual void	addMaterials () override
	Adds materials.

virtual void	addUserObjects () override
	Adds user objects.

virtual void	addPreconditioner () override
	Adds the preconditioner.

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.

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	addExecutioner ()
	Adds the executioner.

virtual void	addOutput ()
	Add output.

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

virtual void	addNonConstantAuxVariables () override

void	addSolutionVariable (const VariableName &var_name, const Real &scaling=1.0)
	Adds a solution variable.

void	addAuxVariable (const VariableName &var_name)
	Adds an aux variable.

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

template<typename T >
const T &	getParam (const std::string &name) const
	Retrieves a parameter.

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
const std::string	_snes_test_err
	Finite differencing parameter.

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

const FunctionName	_p_fn
	Pressure function name.

const FunctionName	_T_fn
	Temperature function name.

const FunctionName	_vel_fn
	Velocity function name.

const FunctionName	_A_fn
	Area function name.

const FunctionName	_D_h_fn
	Hydraulic diameter function name.

const UserObjectName	_fp_1phase_name
	Single-phase fluid properties object name.

const VariableName	_unity_name
	Name of unity.

const VariableName	_A_name
	Name of area variable.

const VariableName	_D_h_name
	Name of the hydraulic diameter.

const VariableName	_rhoA_name
	Name of rho*A variable.

const VariableName	_rhouA_name
	Name of rhouA variable.

const VariableName	_rhoEA_name
	Name of rhoEA variable.

const VariableName	_rho_name
	Name of rho variable.

const VariableName	_vel_name
	Name of velocity variable.

const VariableName	_p_name
	Name of pressure variable.

const VariableName	_T_name
	Name of temperature variable.

const VariableName	_v_name
	Name of specific volume variable.

const VariableName	_e_name
	Name of specific internal energy variable.

const VariableName	_H_name
	Name of specific total enthalpy variable.

const VariableName	_mu_name
	Name of dynamic viscosity variable.

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

const InputParameters &	_this_params

MooseApp &	_this_app

ActionFactory &	_this_action_factory

ActionWarehouse &	_this_action_warehouse

MooseEnum	_fe_family

MooseEnum	_fe_order

const Real &	_gravity_magnitude
	Gravitational acceleration magnitude.

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

Action for setting up a Jacobian test for 1-phase flow.

Definition at line 18 of file JacobianTest1PhaseAction.h.

Constructor & Destructor Documentation

◆ JacobianTest1PhaseAction()

JacobianTest1PhaseAction::JacobianTest1PhaseAction ( const InputParameters & params )

Definition at line 27 of file JacobianTest1PhaseAction.C.

  : JacobianTestAction(params), FlowModelSetup1Phase(params)
{
}

Member Function Documentation

◆ act()

void TestAction::act ( )

virtualinherited

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() [1/2]

void FlowModelSetup::addAuxVariable ( const VariableName & var_name )

protectedinherited

Adds an aux variable.

Parameters

[in] var_name name of the variable to add

Definition at line 56 of file FlowModelSetup.C.

{
  const std::string class_name = "AddAuxVariableAction";
  InputParameters params = _this_action_factory.getValidParams(class_name);
 
  std::shared_ptr<Action> action =
      std::static_pointer_cast<Action>(_this_action_factory.create(class_name, var_name, params));
 
  _this_action_warehouse.addActionBlock(action);
}

Referenced by ClosureTest1PhaseAction::addAuxVariables(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ addAuxVariable() [2/2]

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

protectedinherited

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 TestAction::addAuxVariables(), ClosureTestAction::addAuxVariables(), JacobianTest1PhaseRDGAction::addAuxVariables(), ClosureTestAction::setupADOutput(), and ClosureTestAction::setupOutput().

◆ addAuxVariables()

void JacobianTest1PhaseAction::addAuxVariables ( )

overrideprotectedvirtual

Adds aux variables.

Reimplemented from TestAction.

Definition at line 45 of file JacobianTest1PhaseAction.C.

{
  TestAction::addAuxVariables();
  FlowModelSetup1Phase::addNonConstantAuxVariables();
}

◆ addConstantIC()

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

protectedinherited

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

protectedvirtualinherited

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 TestAction::addObjects().

◆ addFunctionIC() [1/2]

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

protectedinherited

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 68 of file FlowModelSetup.C.

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

Referenced by FlowModelSetup1Phase::addInitialConditions().

◆ addFunctionIC() [2/2]

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

protectedinherited

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 TestAction::addAuxVariables(), JacobianTest1PhaseRDGAction::addAuxVariables(), ClosureTestAction::addInitialConditions(), JacobianTestGeneralAction::addSolutionVariables(), and JacobianTest1PhaseRDGAction::addSolutionVariablesRiemannIC().

◆ addInitialConditions()

void JacobianTest1PhaseAction::addInitialConditions ( )

overrideprotectedvirtual

Adds the initial conditions.

Implements TestAction.

Definition at line 33 of file JacobianTest1PhaseAction.C.

{
  FlowModelSetup1Phase::addInitialConditions();
}

◆ addMaterials()

void JacobianTest1PhaseAction::addMaterials ( )

overrideprotectedvirtual

Adds materials.

Reimplemented from TestAction.

Definition at line 52 of file JacobianTest1PhaseAction.C.

{
  TestAction::addMaterials();
  FlowModelSetup1Phase::addMaterials();
}

◆ addMesh()

void TestAction::addMesh ( )

protectedvirtualinherited

Adds the mesh.

Reimplemented in JacobianTest1PhaseRDGAction.

Definition at line 101 of file TestAction.C.

{
  addMeshInternal(1);
}

Referenced by TestAction::act().

◆ addMeshInternal()

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

protectedinherited

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 TestAction::addMesh(), and JacobianTest1PhaseRDGAction::addMesh().

◆ addNonConstantAuxVariables()

void FlowModelSetup1Phase::addNonConstantAuxVariables ( )

overrideprotectedvirtualinherited

Implements FlowModelSetup.

Definition at line 192 of file FlowModelSetup1Phase.C.

{
  // area
  addAuxVariable(_A_name);
  {
    const std::string class_name = "AddKernelAction";
    InputParameters params = _this_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>(
        _this_action_factory.create(class_name, _A_name + "_aux", params));
 
    action->getObjectParams().set<AuxVariableName>("variable") = _A_name;
    action->getObjectParams().set<FunctionName>("function") = _A_fn;
 
    _this_action_warehouse.addActionBlock(action);
  }
 
  // rho
  addAuxVariable(_rho_name);
  {
    const std::string class_name = "AddKernelAction";
    InputParameters params = _this_action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "QuotientAux";
    params.set<std::string>("task") = "add_aux_kernel";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _this_action_factory.create(class_name, _rho_name + "_aux", params));
 
    action->getObjectParams().set<AuxVariableName>("variable") = _rho_name;
    action->getObjectParams().set<std::vector<VariableName>>("numerator") = {_rhoA_name};
    action->getObjectParams().set<std::vector<VariableName>>("denominator") = {_A_name};
 
    _this_action_warehouse.addActionBlock(action);
  }
 
  // velocity
  addAuxVariable(_vel_name);
  {
    const std::string class_name = "AddKernelAction";
    InputParameters params = _this_action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "QuotientAux";
    params.set<std::string>("task") = "add_aux_kernel";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _this_action_factory.create(class_name, _vel_name + "_aux", params));
 
    action->getObjectParams().set<AuxVariableName>("variable") = _vel_name;
    action->getObjectParams().set<std::vector<VariableName>>("numerator") = {_rhouA_name};
    action->getObjectParams().set<std::vector<VariableName>>("denominator") = {_rhoA_name};
 
    _this_action_warehouse.addActionBlock(action);
  }
 
  // pressure
  addAuxVariable(_p_name);
  {
    const std::string class_name = "AddKernelAction";
    InputParameters params = _this_action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "PressureAux";
    params.set<std::string>("task") = "add_aux_kernel";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _this_action_factory.create(class_name, _p_name + "_aux", params));
 
    action->getObjectParams().set<AuxVariableName>("variable") = _p_name;
    action->getObjectParams().set<std::vector<VariableName>>("e") = {_e_name};
    action->getObjectParams().set<std::vector<VariableName>>("v") = {_v_name};
    action->getObjectParams().set<UserObjectName>("fp") = _fp_1phase_name;
 
    _this_action_warehouse.addActionBlock(action);
  }
 
  // temperature
  addAuxVariable(_T_name);
  {
    const std::string class_name = "AddKernelAction";
    InputParameters params = _this_action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "TemperatureAux";
    params.set<std::string>("task") = "add_aux_kernel";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _this_action_factory.create(class_name, _T_name + "_aux", params));
 
    action->getObjectParams().set<AuxVariableName>("variable") = _T_name;
    action->getObjectParams().set<std::vector<VariableName>>("e") = {_e_name};
    action->getObjectParams().set<std::vector<VariableName>>("v") = {_v_name};
    action->getObjectParams().set<UserObjectName>("fp") = _fp_1phase_name;
 
    _this_action_warehouse.addActionBlock(action);
  }
 
  // specific volume
  addAuxVariable(_v_name);
  {
    const std::string class_name = "AddKernelAction";
    InputParameters params = _this_action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "THMSpecificVolumeAux";
    params.set<std::string>("task") = "add_aux_kernel";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _this_action_factory.create(class_name, _v_name + "_aux", params));
 
    action->getObjectParams().set<AuxVariableName>("variable") = _v_name;
    action->getObjectParams().set<std::vector<VariableName>>("rhoA") = {_rhoA_name};
    action->getObjectParams().set<std::vector<VariableName>>("A") = {_A_name};
 
    _this_action_warehouse.addActionBlock(action);
  }
 
  // specific internal energy
  addAuxVariable(_e_name);
  {
    const std::string class_name = "AddKernelAction";
    InputParameters params = _this_action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "THMSpecificInternalEnergyAux";
    params.set<std::string>("task") = "add_aux_kernel";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _this_action_factory.create(class_name, _e_name + "_aux", params));
 
    action->getObjectParams().set<AuxVariableName>("variable") = _e_name;
    action->getObjectParams().set<std::vector<VariableName>>("rhoA") = {_rhoA_name};
    action->getObjectParams().set<std::vector<VariableName>>("rhouA") = {_rhouA_name};
    action->getObjectParams().set<std::vector<VariableName>>("rhoEA") = {_rhoEA_name};
 
    _this_action_warehouse.addActionBlock(action);
  }
 
  // specific total enthalpy
  addAuxVariable(_H_name);
  {
    const std::string class_name = "AddKernelAction";
    InputParameters params = _this_action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "SpecificTotalEnthalpyAux";
    params.set<std::string>("task") = "add_aux_kernel";
 
    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _this_action_factory.create(class_name, _H_name + "_aux", params));
 
    action->getObjectParams().set<AuxVariableName>("variable") = _H_name;
    action->getObjectParams().set<std::vector<VariableName>>("rhoA") = {_rhoA_name};
    action->getObjectParams().set<std::vector<VariableName>>("rhoEA") = {_rhoEA_name};
    action->getObjectParams().set<std::vector<VariableName>>("p") = {_p_name};
    action->getObjectParams().set<std::vector<VariableName>>("A") = {_A_name};
 
    _this_action_warehouse.addActionBlock(action);
  }
}

Referenced by ClosureTest1PhaseAction::addAuxVariables(), and addAuxVariables().

◆ addObjects()

void TestAction::addObjects ( )

protectedvirtualinherited

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 TestAction::act(), and JacobianTest1PhaseRDGAction::addObjects().

◆ addOutput()

void TestAction::addOutput ( )

protectedvirtualinherited

Add output.

Reimplemented in ClosureTestAction.

Definition at line 353 of file TestAction.C.

354{

355}

Referenced by TestAction::addObjects().

◆ addPreconditioner()

void JacobianTestAction::addPreconditioner ( )

overrideprotectedvirtualinherited

Adds the preconditioner.

Reimplemented from TestAction.

Definition at line 34 of file JacobianTestAction.C.

{
  const std::string class_name = "SetupPreconditionerAction";
  InputParameters params = _action_factory.getValidParams(class_name);
  params.set<std::string>("type") = "SMP";
 
  std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
      _action_factory.create(class_name, "smp", params));
 
  action->getObjectParams().set<bool>("full") = true;
  action->getObjectParams().set<MooseEnum>("solve_type") = "newton";
#if PETSC_VERSION_LESS_THAN(3, 9, 0)
  action->getObjectParams().set<MultiMooseEnum>("petsc_options_iname") =
      "-snes_type -snes_test_err";
  action->getObjectParams().set<std::vector<std::string>>("petsc_options_value") = {"test",
                                                                                    _snes_test_err};
#else
  action->getObjectParams().set<MultiMooseEnum>("petsc_options") = "-snes_test_jacobian";
  action->getObjectParams().set<MultiMooseEnum>("petsc_options_iname") = "-snes_test_err";
  action->getObjectParams().set<std::vector<std::string>>("petsc_options_value") = {_snes_test_err};
#endif
 
  _awh.addActionBlock(action);
}

◆ addScalarVariables()

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

protectedinherited

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 TestAction::addObjects().

◆ addSolutionVariable() [1/2]

void FlowModelSetup::addSolutionVariable	(	const VariableName &	var_name,
		const Real &	scaling = `1.0`
	)

protectedinherited

Adds a solution variable.

Parameters

[in]	var_name	name of the variable to add
[in]	scaling	scaling factor to apply to variable

Definition at line 41 of file FlowModelSetup.C.

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

Referenced by FlowModelSetup1Phase::addSolutionVariables().

◆ addSolutionVariable() [2/2]

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

protectedinherited

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 TestAction::addScalarVariables(), ClosureTestAction::addSolutionVariables(), JacobianTest1PhaseRDGAction::addSolutionVariables(), JacobianTestGeneralAction::addSolutionVariables(), and JacobianTest1PhaseRDGAction::addSolutionVariablesRiemannIC().

◆ addSolutionVariables()

void JacobianTest1PhaseAction::addSolutionVariables ( )

overrideprotectedvirtual

Adds the solution variables.

Implements TestAction.

Definition at line 39 of file JacobianTest1PhaseAction.C.

{
  FlowModelSetup1Phase::addSolutionVariables();
}

◆ addUserObjects()

void JacobianTest1PhaseAction::addUserObjects ( )

overrideprotectedvirtual

Adds user objects.

Implements TestAction.

Definition at line 59 of file JacobianTest1PhaseAction.C.

{
  FlowModelSetup1Phase::addUserObjects();
}

◆ getParam()

template<typename T >

const T & FlowModelSetup::getParam ( const std::string & name ) const

protectedinherited

Retrieves a parameter.

Parameters

[in] name name of the parameter

Returns: value of the parameter

Definition at line 82 of file FlowModelSetup.h.

{
  return InputParameters::getParamHelper<T>(name, _this_params);
}

◆ validParams()

InputParameters JacobianTest1PhaseAction::validParams ( )

static

Definition at line 15 of file JacobianTest1PhaseAction.C.

{
  InputParameters params = emptyInputParameters();
  params += JacobianTestAction::validParams();
  params += FlowModelSetup1Phase::validParams();
 
  params.set<std::string>("fe_family") = "LAGRANGE";
  params.set<std::string>("fe_order") = "FIRST";
 
  return params;
}

Member Data Documentation

◆ _A_fn

const FunctionName FlowModelSetup1Phase::_A_fn

protectedinherited

Area function name.

Definition at line 36 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _A_name

const VariableName FlowModelSetup1Phase::_A_name

protectedinherited

Name of area variable.

Definition at line 46 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup1Phase::addMaterials(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _ad [1/2]

const bool& FlowModelSetup1Phase::_ad

protectedinherited

True for setting up testing with AD, false otherwise.

Definition at line 73 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addMaterials().

◆ _ad [2/2]

const bool& TestAction::_ad

protectedinherited

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

protectedinherited

List of function names for aux variables to add.

Definition at line 142 of file TestAction.h.

Referenced by TestAction::addAuxVariables(), and TestAction::TestAction().

◆ _aux_variables

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

protectedinherited

List of aux variables to add.

Definition at line 140 of file TestAction.h.

Referenced by TestAction::addAuxVariables(), and TestAction::TestAction().

◆ _D_h_fn

const FunctionName FlowModelSetup1Phase::_D_h_fn

protectedinherited

Hydraulic diameter function name.

Definition at line 38 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addMaterials().

◆ _D_h_name

const VariableName FlowModelSetup1Phase::_D_h_name

protectedinherited

Name of the hydraulic diameter.

Definition at line 48 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addMaterials().

◆ _default_use_transient_executioner

bool TestAction::_default_use_transient_executioner

protectedinherited

Default for option to use a transient executioner.

Definition at line 132 of file TestAction.h.

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

◆ _e_name

const VariableName FlowModelSetup1Phase::_e_name

protectedinherited

Name of specific internal energy variable.

Definition at line 66 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup1Phase::addMaterials(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _fe_family [1/2]

MooseEnum FlowModelSetup::_fe_family

protectedinherited

Definition at line 70 of file FlowModelSetup.h.

Referenced by FlowModelSetup::addSolutionVariable().

◆ _fe_family [2/2]

const std::string TestAction::_fe_family

protectedinherited

Default FE family.

Definition at line 150 of file TestAction.h.

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

◆ _fe_order [1/2]

MooseEnum FlowModelSetup::_fe_order

protectedinherited

Definition at line 71 of file FlowModelSetup.h.

Referenced by FlowModelSetup::addSolutionVariable(), and FlowModelSetup::FlowModelSetup().

◆ _fe_order [2/2]

const std::string TestAction::_fe_order

protectedinherited

Default FE order.

Definition at line 152 of file TestAction.h.

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

◆ _fp_1phase_name

const UserObjectName FlowModelSetup1Phase::_fp_1phase_name

protectedinherited

Single-phase fluid properties object name.

Definition at line 41 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup1Phase::addMaterials(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _gravity_magnitude

const Real& FlowModelSetup::_gravity_magnitude

protectedinherited

Gravitational acceleration magnitude.

Definition at line 74 of file FlowModelSetup.h.

◆ _H_name

const VariableName FlowModelSetup1Phase::_H_name

protectedinherited

Name of specific total enthalpy variable.

Definition at line 68 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _mat_property_names

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

protectedinherited

List of material properties to add.

Definition at line 145 of file TestAction.h.

Referenced by TestAction::addMaterials(), and TestAction::TestAction().

◆ _mat_property_values

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

protectedinherited

List of function names for material properties to add.

Definition at line 147 of file TestAction.h.

Referenced by TestAction::addMaterials(), and TestAction::TestAction().

◆ _mu_name

const VariableName FlowModelSetup1Phase::_mu_name

protectedinherited

Name of dynamic viscosity variable.

Definition at line 70 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addMaterials().

◆ _p_fn

const FunctionName FlowModelSetup1Phase::_p_fn

protectedinherited

Pressure function name.

Definition at line 30 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions().

◆ _p_name

const VariableName FlowModelSetup1Phase::_p_name

protectedinherited

Name of pressure variable.

Definition at line 60 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _rho_name

const VariableName FlowModelSetup1Phase::_rho_name

protectedinherited

Name of rho variable.

Definition at line 56 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _rhoA_name

const VariableName FlowModelSetup1Phase::_rhoA_name

protectedinherited

Name of rho*A variable.

Definition at line 50 of file FlowModelSetup1Phase.h.

Referenced by ClosureTest1PhaseAction::addAuxVariables(), FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup1Phase::addMaterials(), FlowModelSetup1Phase::addNonConstantAuxVariables(), and FlowModelSetup1Phase::addSolutionVariables().

◆ _rhoEA_name

const VariableName FlowModelSetup1Phase::_rhoEA_name

protectedinherited

Name of rho*E*A variable.

Definition at line 54 of file FlowModelSetup1Phase.h.

Referenced by ClosureTest1PhaseAction::addAuxVariables(), FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup1Phase::addMaterials(), FlowModelSetup1Phase::addNonConstantAuxVariables(), and FlowModelSetup1Phase::addSolutionVariables().

◆ _rhouA_name

const VariableName FlowModelSetup1Phase::_rhouA_name

protectedinherited

Name of rho*u*A variable.

Definition at line 52 of file FlowModelSetup1Phase.h.

Referenced by ClosureTest1PhaseAction::addAuxVariables(), FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup1Phase::addMaterials(), FlowModelSetup1Phase::addNonConstantAuxVariables(), and FlowModelSetup1Phase::addSolutionVariables().

◆ _scalar_variable_values

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

protectedinherited

List of values for the scalar variables to add.

Definition at line 137 of file TestAction.h.

Referenced by TestAction::addObjects(), and TestAction::TestAction().

◆ _scalar_variables

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

protectedinherited

List of scalar variables to add.

Definition at line 135 of file TestAction.h.

Referenced by TestAction::addObjects(), and TestAction::TestAction().

◆ _snes_test_err

const std::string JacobianTestAction::_snes_test_err

protectedinherited

Finite differencing parameter.

Definition at line 26 of file JacobianTestAction.h.

Referenced by JacobianTestAction::addPreconditioner().

◆ _T_fn

const FunctionName FlowModelSetup1Phase::_T_fn

protectedinherited

Temperature function name.

Definition at line 32 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions().

◆ _T_name

const VariableName FlowModelSetup1Phase::_T_name

protectedinherited

Name of temperature variable.

Definition at line 62 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _this_action_factory

ActionFactory& FlowModelSetup::_this_action_factory

protectedinherited

Definition at line 67 of file FlowModelSetup.h.

Referenced by FlowModelSetup::addAuxVariable(), FlowModelSetup::addFunctionIC(), FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup::addMaterials(), FlowModelSetup1Phase::addMaterials(), FlowModelSetup1Phase::addNonConstantAuxVariables(), and FlowModelSetup::addSolutionVariable().

◆ _this_action_warehouse

ActionWarehouse& FlowModelSetup::_this_action_warehouse

protectedinherited

Definition at line 68 of file FlowModelSetup.h.

Referenced by FlowModelSetup::addAuxVariable(), FlowModelSetup::addFunctionIC(), FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup::addMaterials(), FlowModelSetup1Phase::addMaterials(), FlowModelSetup1Phase::addNonConstantAuxVariables(), and FlowModelSetup::addSolutionVariable().

◆ _this_app

MooseApp& FlowModelSetup::_this_app

protectedinherited

Definition at line 66 of file FlowModelSetup.h.

◆ _this_params

const InputParameters& FlowModelSetup::_this_params

protectedinherited

Definition at line 65 of file FlowModelSetup.h.

Referenced by FlowModelSetup::getParam().

◆ _unity_name

const VariableName FlowModelSetup1Phase::_unity_name

protectedinherited

Name of unity.

Definition at line 44 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addMaterials().

◆ _v_name

const VariableName FlowModelSetup1Phase::_v_name

protectedinherited

Name of specific volume variable.

Definition at line 64 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), FlowModelSetup1Phase::addMaterials(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

◆ _vel_fn

const FunctionName FlowModelSetup1Phase::_vel_fn

protectedinherited

Velocity function name.

Definition at line 34 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions().

◆ _vel_name

const VariableName FlowModelSetup1Phase::_vel_name

protectedinherited

Name of velocity variable.

Definition at line 58 of file FlowModelSetup1Phase.h.

Referenced by FlowModelSetup1Phase::addInitialConditions(), and FlowModelSetup1Phase::addNonConstantAuxVariables().

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

thermal_hydraulics/test/include/actions/JacobianTest1PhaseAction.h
thermal_hydraulics/test/src/actions/JacobianTest1PhaseAction.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

◆ JacobianTest1PhaseAction()

Member Function Documentation

◆ act()

◆ addAuxVariable() [1/2]

◆ addAuxVariable() [2/2]

◆ addAuxVariables()

◆ addConstantIC()

◆ addExecutioner()

◆ addFunctionIC() [1/2]

◆ addFunctionIC() [2/2]

◆ addInitialConditions()

◆ addMaterials()

◆ addMesh()

◆ addMeshInternal()

◆ addNonConstantAuxVariables()

◆ addObjects()

◆ addOutput()

◆ addPreconditioner()

◆ addScalarVariables()

◆ addSolutionVariable() [1/2]

◆ addSolutionVariable() [2/2]

◆ addSolutionVariables()

◆ addUserObjects()

◆ getParam()

◆ validParams()

Member Data Documentation

◆ _A_fn

◆ _A_name

◆ _ad [1/2]

◆ _ad [2/2]

◆ _aux_variable_values

◆ _aux_variables

◆ _D_h_fn

◆ _D_h_name

◆ _default_use_transient_executioner

◆ _e_name

◆ _fe_family [1/2]

◆ _fe_family [2/2]

◆ _fe_order [1/2]

◆ _fe_order [2/2]

◆ _fp_1phase_name

◆ _gravity_magnitude

◆ _H_name

◆ _mat_property_names

◆ _mat_property_values

◆ _mu_name

◆ _p_fn

◆ _p_name

◆ _rho_name

◆ _rhoA_name

◆ _rhoEA_name

◆ _rhouA_name

◆ _scalar_variable_values

◆ _scalar_variables

◆ _snes_test_err

◆ _T_fn

◆ _T_name

◆ _this_action_factory

◆ _this_action_warehouse

◆ _this_app

◆ _this_params

◆ _unity_name

◆ _v_name

◆ _vel_fn

◆ _vel_name