Provides functions to setup the flow model. More...

#include <FlowModel.h>

Inheritance diagram for FlowModel:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	FlowModel (const InputParameters &params)

virtual void	init ()
	Initialize the model. More...

virtual void	addVariables ()=0
	Add variables the model uses. More...

virtual void	addInitialConditions ()=0
	Add initial conditions. More...

virtual void	addMooseObjects ()=0
	Add MOOSE objects this model uses. More...

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () 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 InputParameters &	parameters () 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

T	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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	genName (const std::string &prefix, unsigned int id, const std::string &suffix="") const
	Build a name from a prefix, number and possible suffix. More...

std::string	genName (const std::string &prefix, unsigned int i, unsigned int j, const std::string &suffix="") const
	Build a name from a prefix, 2 numbers and possible suffix. More...

std::string	genName (const std::string &prefix, const std::string &name, unsigned int i) const
	Build a name from 2 strings and a number. More...

std::string	genName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings. More...

std::string	genSafeName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings that is safe to use in input files (i.e. More...

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static const std::string	AREA = THM::AREA

static const std::string	AREA_LINEAR = THM::AREA_LINEAR

static const std::string	HEAT_FLUX_WALL = THM::HEAT_FLUX_WALL

static const std::string	HEAT_FLUX_PERIMETER = THM::HEAT_FLUX_PERIMETER

static const std::string	NUSSELT_NUMBER = THM::NUSSELT_NUMBER

static const std::string	SURFACE_TENSION

static const std::string	TEMPERATURE_WALL = THM::TEMPERATURE_WALL

static const std::string	UNITY = THM::UNITY

static const std::string	DIRECTION = THM::DIRECTION

Protected Member Functions
const FunctionName &	getVariableFn (const FunctionName &fn_param_name)

virtual void	addCommonVariables ()
	Adds variables common to any flow model (A, P_hf, ...) More...

virtual void	addCommonInitialConditions ()
	Adds initial conditions common to any flow model. More...

virtual void	addCommonMooseObjects ()
	Adds common MOOSE objects. More...

Protected Attributes
THMProblem &	_sim

Factory &	_factory
	The Factory associated with the MooseApp. More...

FlowChannelBase &	_flow_channel
	The flow channel component that built this class. More...

const libMesh::FEType &	_fe_type
	The type of FE used for flow. More...

const UserObjectName	_fp_name
	The name of the user object that defines fluid properties. More...

const std::string	_comp_name
	The component name. More...

const RealVectorValue &	_gravity_vector
	Gravitational acceleration vector. More...

const Real	_gravity_magnitude
	Gravitational acceleration magnitude. More...

std::vector< VariableName >	_solution_vars

std::vector< VariableName >	_derivative_vars

const bool &	_output_vector_velocity
	True if we output velocity as a vector-value field, false for outputting velocity as a scalar. More...

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

ActionFactory &	_action_factory

const Parallel::Communicator &	_communicator

Detailed Description

Provides functions to setup the flow model.

Should be used by components that has flow in them

Definition at line 27 of file FlowModel.h.

Constructor & Destructor Documentation

◆ FlowModel()

FlowModel::FlowModel ( const InputParameters & params )

Definition at line 41 of file FlowModel.C.

   : MooseObject(params),
     _sim(*params.getCheckedPointerParam<THMProblem *>("_thm_problem")),
     _factory(_app.getFactory()),
     _flow_channel(*params.getCheckedPointerParam<FlowChannelBase *>("_flow_channel")),
     _fe_type(_sim.getFlowFEType()),
     _fp_name(params.get<UserObjectName>("fp")),
     _comp_name(name()),
     _gravity_vector(_flow_channel.getParam<RealVectorValue>("gravity_vector")),
     _gravity_magnitude(_gravity_vector.norm()),
     _output_vector_velocity(params.get<bool>("output_vector_velocity"))
 {
 }

Member Function Documentation

◆ addCommonInitialConditions()

void FlowModel::addCommonInitialConditions ( )

protectedvirtual

Adds initial conditions common to any flow model.

Definition at line 80 of file FlowModel.C.

Referenced by FlowModel1PhaseBase::addInitialConditions().

 {
   if (_flow_channel.isParamValid("A") && !_app.isRestarting())
   {
     const std::vector<SubdomainName> & block = _flow_channel.getSubdomainNames();
     const FunctionName & area_function = _flow_channel.getAreaFunctionName();
 
     if (!_sim.hasFunction(area_function))
     {
       const Function & fn = _sim.getFunction(area_function);
       _sim.addConstantIC(AREA, fn.value(0, Point()), block);
       _sim.addConstantIC(AREA_LINEAR, fn.value(0, Point()), block);
 
       _flow_channel.makeFunctionControllableIfConstant(area_function, "Area", "value");
     }
     else
     {
       _sim.addFunctionIC(AREA_LINEAR, area_function, block);
 
       {
         const std::string class_name = "FunctionNodalAverageIC";
         InputParameters params = _factory.getValidParams(class_name);
         params.set<VariableName>("variable") = AREA;
         params.set<std::vector<SubdomainName>>("block") = block;
         params.set<FunctionName>("function") = area_function;
         _sim.addSimInitialCondition(class_name, genName(_comp_name, AREA, "ic"), params);
       }
     }
   }
 }

◆ addCommonMooseObjects()

void FlowModel::addCommonMooseObjects ( )

protectedvirtual

Adds common MOOSE objects.

Definition at line 112 of file FlowModel.C.

Referenced by FlowModel1PhaseBase::addMooseObjects().

 {
   // add material property equal to one, useful for dummy multiplier values
   {
     const std::string class_name = "ConstantMaterial";
     InputParameters params = _factory.getValidParams(class_name);
     params.set<std::vector<SubdomainName>>("block") = _flow_channel.getSubdomainNames();
     params.set<std::string>("property_name") = FlowModel::UNITY;
     params.set<Real>("value") = 1.0;
     params.set<std::vector<VariableName>>("derivative_vars") = _derivative_vars;
     _sim.addMaterial(class_name, genName(_comp_name, FlowModel::UNITY), params);
   }
 }

◆ addCommonVariables()

void FlowModel::addCommonVariables ( )

protectedvirtual

Adds variables common to any flow model (A, P_hf, ...)

Definition at line 70 of file FlowModel.C.

Referenced by FlowModel1PhaseBase::addVariables().

 {
   const std::vector<SubdomainName> & subdomains = _flow_channel.getSubdomainNames();
 
   _sim.addSimVariable(false, AREA, _fe_type, subdomains);
   _sim.addSimVariable(false, HEAT_FLUX_PERIMETER, _fe_type, subdomains);
   _sim.addSimVariable(false, AREA_LINEAR, FEType(FIRST, LAGRANGE), subdomains);
 }

◆ addInitialConditions()

virtual void FlowModel::addInitialConditions ( )

pure virtual

Add initial conditions.

Implemented in FlowModel1PhaseBase, and FlowModelGasMix.

◆ addMooseObjects()

virtual void FlowModel::addMooseObjects ( )

pure virtual

Add MOOSE objects this model uses.

Implemented in FlowModel1PhaseBase.

◆ addVariables()

virtual void FlowModel::addVariables ( )

pure virtual

Add variables the model uses.

Implemented in FlowModel1PhaseBase, and FlowModelGasMix.

◆ genName() [1/4]

std::string NamingInterface::genName	(	const std::string &	prefix,
		unsigned int	id,
		const std::string &	suffix = `""`
	)		const

inlineinherited

Build a name from a prefix, number and possible suffix.

Definition at line 29 of file NamingInterface.h.

   {
     std::stringstream ss;
     ss << prefix << ":" << id;
     if (!suffix.empty())
       ss << ":" << suffix;
     return ss.str();
   }

◆ genName() [2/4]

std::string NamingInterface::genName	(	const std::string &	prefix,
		unsigned int	i,
		unsigned int	j,
		const std::string &	suffix = `""`
	)		const

inlineinherited

Build a name from a prefix, 2 numbers and possible suffix.

Definition at line 41 of file NamingInterface.h.

   {
     std::stringstream ss;
     ss << prefix << ":" << i << ":" << j;
     if (!suffix.empty())
       ss << ":" << suffix;
     return ss.str();
   }

◆ genName() [3/4]

std::string NamingInterface::genName	(	const std::string &	prefix,
		const std::string &	name,
		unsigned int	i
	)		const

inlineinherited

Build a name from 2 strings and a number.

Definition at line 56 of file NamingInterface.h.

   {
     std::stringstream ss;
     ss << prefix << ":" << name << ":" << i;
     return ss.str();
   }

◆ genName() [4/4]

std::string NamingInterface::genName	(	const std::string &	prefix,
		const std::string &	middle,
		const std::string &	suffix = `""`
	)		const

inlineinherited

Build a name from strings.

Definition at line 66 of file NamingInterface.h.

   {
     std::stringstream ss;
     ss << prefix << ":" << middle;
     if (!suffix.empty())
       ss << ":" << suffix;
     return ss.str();
   }

◆ genSafeName()

std::string NamingInterface::genSafeName	(	const std::string &	prefix,
		const std::string &	middle,
		const std::string &	suffix = `""`
	)		const

inlineinherited

Build a name from strings that is safe to use in input files (i.e.

can be exposed to users)

Definition at line 80 of file NamingInterface.h.

Referenced by HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), and HSBoundaryExternalAppHeatFlux::addMooseObjects().

   {
     std::stringstream ss;
     ss << prefix << "_" << middle;
     if (!suffix.empty())
       ss << "_" << suffix;
     return ss.str();
   }

◆ getVariableFn()

const FunctionName & FlowModel::getVariableFn ( const FunctionName & fn_param_name )

protected

Definition at line 56 of file FlowModel.C.

Referenced by FlowModelSinglePhase::addRhoEAIC().

 {
   const FunctionName & fn_name = _flow_channel.getParam<FunctionName>(fn_param_name);
   const Function & fn = _sim.getFunction(fn_name);
 
   if (dynamic_cast<const ConstantFunction *>(&fn) != nullptr)
   {
     _flow_channel.connectObject(fn.parameters(), fn_name, fn_param_name, "value");
   }
 
   return fn_name;
 }

◆ init()

virtual void FlowModel::init ( )

inlinevirtual

Initialize the model.

Definition at line 35 of file FlowModel.h.

35 {}

◆ validParams()

InputParameters FlowModel::validParams ( )

static

Definition at line 19 of file FlowModel.C.

Referenced by FlowModel1PhaseBase::validParams().

 {
   InputParameters params = MooseObject::validParams();
   params.addPrivateParam<THMProblem *>("_thm_problem");
   params.addPrivateParam<FlowChannelBase *>("_flow_channel");
   params.addRequiredParam<UserObjectName>(
       "fp", "The name of the user object that defines fluid properties");
   params.addRequiredParam<bool>("output_vector_velocity",
                                 "True if velocity is put out as a vector field.");
   params.registerBase("THM:flow_model");
   return params;
 }

Member Data Documentation

◆ _comp_name

const std::string FlowModel::_comp_name

protected

The component name.

Definition at line 68 of file FlowModel.h.

◆ _derivative_vars

std::vector<VariableName> FlowModel::_derivative_vars

protected

Definition at line 79 of file FlowModel.h.

Referenced by addCommonMooseObjects(), and FlowModel1PhaseBase::addVariables().

◆ _factory

Factory& FlowModel::_factory

protected

The Factory associated with the MooseApp.

Definition at line 56 of file FlowModel.h.

◆ _fe_type

const libMesh::FEType& FlowModel::_fe_type

protected

The type of FE used for flow.

Definition at line 62 of file FlowModel.h.

Referenced by addCommonVariables(), FlowModelGasMix::addVariables(), and FlowModel1PhaseBase::addVariables().

◆ _flow_channel

FlowChannelBase& FlowModel::_flow_channel

protected

The flow channel component that built this class.

Definition at line 59 of file FlowModel.h.

◆ _fp_name

const UserObjectName FlowModel::_fp_name

protected

The name of the user object that defines fluid properties.

Definition at line 65 of file FlowModel.h.

◆ _gravity_magnitude

const Real FlowModel::_gravity_magnitude

protected

Gravitational acceleration magnitude.

Definition at line 73 of file FlowModel.h.

◆ _gravity_vector

const RealVectorValue& FlowModel::_gravity_vector

protected

Gravitational acceleration vector.

Definition at line 71 of file FlowModel.h.

Referenced by FlowModel1PhaseBase::addEnergyGravityKernel(), and FlowModel1PhaseBase::addMomentumGravityKernel().

◆ _output_vector_velocity

const bool& FlowModel::_output_vector_velocity

protected

True if we output velocity as a vector-value field, false for outputting velocity as a scalar.

Definition at line 82 of file FlowModel.h.

Referenced by FlowModel1PhaseBase::addVariables(), FlowModel1PhaseBase::addVelocityAux(), and FlowModel1PhaseBase::addVelocityIC().

◆ _sim

THMProblem& FlowModel::_sim

protected

Definition at line 53 of file FlowModel.h.

◆ _solution_vars

std::vector<VariableName> FlowModel::_solution_vars

protected

Definition at line 76 of file FlowModel.h.

Referenced by FlowModel1PhaseBase::addVariables().

◆ AREA

const std::string FlowModel::AREA = THM::AREA

static

Definition at line 102 of file FlowModel.h.

Referenced by addCommonInitialConditions(), FlowChannelBase::addCommonObjects(), addCommonVariables(), FlowModelSinglePhase::addFluidPropertiesMaterials(), GateValve1Phase::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), FlowModelSinglePhase::addRhoEAIC(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ AREA_LINEAR

const std::string FlowModel::AREA_LINEAR = THM::AREA_LINEAR

static

Definition at line 103 of file FlowModel.h.

Referenced by addCommonInitialConditions(), FlowChannelBase::addCommonObjects(), addCommonVariables(), VolumeJunction1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), and FlowModelSinglePhase::addSlopeReconstructionMaterial().

◆ DIRECTION

const std::string FlowModel::DIRECTION = THM::DIRECTION

static

Definition at line 110 of file FlowModel.h.

Referenced by FlowModelSinglePhase::addSlopeReconstructionMaterial().

◆ HEAT_FLUX_PERIMETER

const std::string FlowModel::HEAT_FLUX_PERIMETER = THM::HEAT_FLUX_PERIMETER

static

Definition at line 105 of file FlowModel.h.

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), addCommonVariables(), FlowChannelBase::addMooseObjects(), FlowChannelBase::addVariables(), HeatTransferFromHeatStructure3D1Phase::initSecondary(), and HeatTransferBase::initSecondary().

◆ HEAT_FLUX_WALL

const std::string FlowModel::HEAT_FLUX_WALL = THM::HEAT_FLUX_WALL

static

Definition at line 104 of file FlowModel.h.

Referenced by FlowChannelBase::addMooseObjects(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), HeatTransferFromHeatStructure3D1Phase::initSecondary(), and HeatTransferBase::initSecondary().

◆ NUSSELT_NUMBER

const std::string FlowModel::NUSSELT_NUMBER = THM::NUSSELT_NUMBER

static

Definition at line 106 of file FlowModel.h.

◆ SURFACE_TENSION

const std::string FlowModel::SURFACE_TENSION

static

Definition at line 107 of file FlowModel.h.

◆ TEMPERATURE_WALL

const std::string FlowModel::TEMPERATURE_WALL = THM::TEMPERATURE_WALL

static

Definition at line 108 of file FlowModel.h.

◆ UNITY

const std::string FlowModel::UNITY = THM::UNITY

static

Definition at line 109 of file FlowModel.h.

Referenced by addCommonMooseObjects().

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

thermal_hydraulics/include/base/FlowModel.h
thermal_hydraulics/src/base/FlowModel.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FlowModel()

Member Function Documentation

◆ addCommonInitialConditions()

◆ addCommonMooseObjects()

◆ addCommonVariables()

◆ addInitialConditions()

◆ addMooseObjects()

◆ addVariables()

◆ genName() [1/4]

◆ genName() [2/4]

◆ genName() [3/4]

◆ genName() [4/4]

◆ genSafeName()

◆ getVariableFn()

◆ init()

◆ validParams()

Member Data Documentation

◆ _comp_name

◆ _derivative_vars

◆ _factory

◆ _fe_type

◆ _flow_channel

◆ _fp_name

◆ _gravity_magnitude

◆ _gravity_vector

◆ _output_vector_velocity

◆ _sim

◆ _solution_vars

◆ AREA

◆ AREA_LINEAR

◆ DIRECTION

◆ HEAT_FLUX_PERIMETER

◆ HEAT_FLUX_WALL

◆ NUSSELT_NUMBER

◆ SURFACE_TENSION

◆ TEMPERATURE_WALL

◆ UNITY