FlowModelSetup Class Reference

Base helper class to provide interfaces to common flow model setup functions. More...

#include <FlowModelSetup.h>

Inheritance diagram for FlowModelSetup:

Public Member Functions
	FlowModelSetup (const InputParameters &params)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	addInitialConditions ()=0
virtual void	addSolutionVariables ()=0
virtual void	addNonConstantAuxVariables ()=0
virtual void	addMaterials ()
virtual void	addUserObjects ()=0
void	addSolutionVariable (const VariableName &var_name, const Real &scaling=1.0)
	Adds a solution variable. More...
void	addAuxVariable (const VariableName &var_name)
	Adds an aux variable. More...
void	addFunctionIC (const VariableName &var_name, const FunctionName &function_name)
	Adds a function initial condition. More...
template<typename T >
const T &	getParam (const std::string &name) const
	Retrieves a parameter. More...

Protected Attributes
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. More...

Detailed Description

Base helper class to provide interfaces to common flow model setup functions.

Definition at line 21 of file FlowModelSetup.h.

Constructor & Destructor Documentation

FlowModelSetup()

FlowModelSetup::FlowModelSetup

(

const InputParameters &

params

)

Definition at line 27 of file FlowModelSetup.C.

  : _this_params(params),
    _this_app(*_this_params.getCheckedPointerParam<MooseApp *>("_moose_app")),
    _this_action_factory(_this_app.getActionFactory()),
    _this_action_warehouse(*_this_params.getCheckedPointerParam<ActionWarehouse *>("awh")),
    _fe_family(AddVariableAction::getNonlinearVariableFamilies()),
    _fe_order(AddVariableAction::getNonlinearVariableOrders()),
    _gravity_magnitude(getParam<Real>("gravity_magnitude"))
{
  if (getParam<bool>("2nd_order_mesh"))
    _fe_order = "SECOND";
}

Member Function Documentation

addAuxVariable()

void FlowModelSetup::addAuxVariable ( const VariableName &  var_name )

protected

Adds an aux variable.

Parameters

[in]

var_name

name of the variable to add

Definition at line 56 of file FlowModelSetup.C.

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

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

addFunctionIC()

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

Referenced by FlowModelSetup1Phase::addInitialConditions().

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

addInitialConditions()

virtual void FlowModelSetup::addInitialConditions ( )

protectedpure virtual

Implemented in ClosureTest1PhaseAction, JacobianTest1PhaseAction, and FlowModelSetup1Phase.

addMaterials()

void FlowModelSetup::addMaterials ( )

protectedvirtual

Reimplemented in JacobianTest1PhaseAction, FlowModelSetup1Phase, and ClosureTest1PhaseAction.

Definition at line 84 of file FlowModelSetup.C.

Referenced by FlowModelSetup1Phase::addMaterials().

{
  {
    const std::string class_name = "AddMaterialAction";
    InputParameters params = _this_action_factory.getValidParams(class_name);
    params.set<std::string>("type") = "DirectionMaterial";

    std::shared_ptr<MooseObjectAction> action = std::static_pointer_cast<MooseObjectAction>(
        _this_action_factory.create(class_name, "direction_material", params));
    _this_action_warehouse.addActionBlock(action);
  }
}

addNonConstantAuxVariables()

virtual void FlowModelSetup::addNonConstantAuxVariables ( )

protectedpure virtual

Implemented in FlowModelSetup1Phase.

addSolutionVariable()

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

protected

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.

Referenced by FlowModelSetup1Phase::addSolutionVariables().

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

addSolutionVariables()

virtual void FlowModelSetup::addSolutionVariables ( )

protectedpure virtual

Implemented in JacobianTest1PhaseAction, and FlowModelSetup1Phase.

addUserObjects()

virtual void FlowModelSetup::addUserObjects ( )

protectedpure virtual

Implemented in JacobianTest1PhaseAction, FlowModelSetup1Phase, and ClosureTest1PhaseAction.

getParam()

template<typename T >

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

protected

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(name, _this_params, static_cast<T *>(0));
}

validParams()

InputParameters FlowModelSetup::validParams ( )

static

Definition at line 16 of file FlowModelSetup.C.

Referenced by FlowModelSetup1Phase::validParams().

{
  InputParameters params = emptyInputParameters();

  params.addParam<bool>("2nd_order_mesh", false, "Use 2nd order elements in the mesh");
  params.addParam<Real>(
      "gravity_magnitude", THM::gravity_const, "Gravitational acceleration magnitude");

  return params;
}

Member Data Documentation

_fe_family

MooseEnum FlowModelSetup::_fe_family

protected

Definition at line 70 of file FlowModelSetup.h.

Referenced by addSolutionVariable().

_fe_order

MooseEnum FlowModelSetup::_fe_order

protected

Definition at line 71 of file FlowModelSetup.h.

Referenced by addSolutionVariable(), and FlowModelSetup().

_gravity_magnitude

const Real& FlowModelSetup::_gravity_magnitude

protected

Gravitational acceleration magnitude.

Definition at line 74 of file FlowModelSetup.h.

_this_action_factory

ActionFactory& FlowModelSetup::_this_action_factory

protected

Definition at line 67 of file FlowModelSetup.h.

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

_this_action_warehouse

ActionWarehouse& FlowModelSetup::_this_action_warehouse

protected

Definition at line 68 of file FlowModelSetup.h.

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

_this_app

MooseApp& FlowModelSetup::_this_app

protected

Definition at line 66 of file FlowModelSetup.h.

_this_params

const InputParameters& FlowModelSetup::_this_params

protected

Definition at line 65 of file FlowModelSetup.h.

Referenced by getParam().

---

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

• thermal_hydraulics/include/base/FlowModelSetup.h
• thermal_hydraulics/src/base/FlowModelSetup.C