https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Private Member Functions | Private Attributes | List of all members
FlowModel Class Referenceabstract

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

#include <FlowModel.h>

Inheritance diagram for FlowModel:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 FlowModel (const InputParameters &params)
 
virtual void init ()
 Initialize the model.
 
virtual void addVariables ()=0
 Add variables the model uses.
 
virtual void addInitialConditions ()=0
 Add initial conditions.
 
virtual void addMooseObjects ()=0
 Add MOOSE objects this model uses.
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
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
 
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.
 
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.
 
std::string genName (const std::string &prefix, const std::string &name, unsigned int i) const
 Build a name from 2 strings and a number.
 
std::string genName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
 Build a name from strings.
 
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.
 

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

Protected Member Functions

const FunctionName & getVariableFn (const FunctionName &fn_param_name)
 
virtual void addCommonVariables ()
 Adds variables common to any flow model (A, P_hf, ...)
 
virtual void addCommonInitialConditions ()
 Adds initial conditions common to any flow model.
 
virtual void addCommonMooseObjects ()
 Adds common MOOSE objects.
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 

Protected Attributes

THMProblem & _sim
 
Factory & _factory
 The Factory associated with the MooseApp.
 
FlowChannelBase & _flow_channel
 The flow channel component that built this class.
 
const libMesh::FEType & _fe_type
 The type of FE used for flow.
 
const UserObjectName _fp_name
 The name of the user object that defines fluid properties.
 
const std::string _comp_name
 The component name.
 
const RealVectorValue & _gravity_vector
 Gravitational acceleration vector.
 
const Real _gravity_magnitude
 Gravitational acceleration magnitude.
 
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.
 
const bool & _enabled
 
MooseApp & _app
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
const Parallel::Communicator & _communicator
 

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
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 

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.

42 : MooseObject(params),
43 _sim(*params.getCheckedPointerParam<THMProblem *>("_thm_problem")),
44 _factory(_app.getFactory()),
45 _flow_channel(*params.getCheckedPointerParam<FlowChannelBase *>("_flow_channel")),
46 _fe_type(_sim.getFlowFEType()),
47 _fp_name(params.get<UserObjectName>("fp")),
48 _comp_name(name()),
49 _gravity_vector(_flow_channel.getParam<RealVectorValue>("gravity_vector")),
50 _gravity_magnitude(_gravity_vector.norm()),
51 _output_vector_velocity(params.get<bool>("output_vector_velocity"))
52{
53}
FlowChannelBase
A base class for flow channels.
Definition FlowChannelBase.h:23
FlowModel::_gravity_magnitude
const Real _gravity_magnitude
Gravitational acceleration magnitude.
Definition FlowModel.h:73
FlowModel::_flow_channel
FlowChannelBase & _flow_channel
The flow channel component that built this class.
Definition FlowModel.h:59
FlowModel::_comp_name
const std::string _comp_name
The component name.
Definition FlowModel.h:68
FlowModel::_output_vector_velocity
const bool & _output_vector_velocity
True if we output velocity as a vector-value field, false for outputting velocity as a scalar.
Definition FlowModel.h:82
FlowModel::_factory
Factory & _factory
The Factory associated with the MooseApp.
Definition FlowModel.h:56
FlowModel::_fe_type
const libMesh::FEType & _fe_type
The type of FE used for flow.
Definition FlowModel.h:62
FlowModel::_fp_name
const UserObjectName _fp_name
The name of the user object that defines fluid properties.
Definition FlowModel.h:65
FlowModel::_gravity_vector
const RealVectorValue & _gravity_vector
Gravitational acceleration vector.
Definition FlowModel.h:71
FlowModel::_sim
THMProblem & _sim
Definition FlowModel.h:53
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
InputParameters::getCheckedPointerParam
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
MooseApp::getFactory
Factory & getFactory()
MooseObject::name
const std::string & name() const
MooseObject::getParam
const T & getParam(const std::string &name) const
MooseObject::_app
MooseApp & _app
Simulation::getFlowFEType
const libMesh::FEType & getFlowFEType() const
Gets the FE type for the flow in this simulation.
Definition Simulation.h:48
THMProblem
Specialization of FEProblem to run with component subsystem.
Definition THMProblem.h:19

Member Function Documentation

◆ addCommonInitialConditions()

void FlowModel::addCommonInitialConditions ( )
protectedvirtual

Adds initial conditions common to any flow model.

Definition at line 80 of file FlowModel.C.

81{
82 if (_flow_channel.isParamValid("A") && !_app.isRestarting())
83 {
84 const std::vector<SubdomainName> & block = _flow_channel.getSubdomainNames();
85 const FunctionName & area_function = _flow_channel.getAreaFunctionName();
86
87 if (!_sim.hasFunction(area_function))
88 {
89 const Function & fn = _sim.getFunction(area_function);
90 _sim.addConstantIC(AREA, fn.value(0, Point()), block);
91 _sim.addConstantIC(AREA_LINEAR, fn.value(0, Point()), block);
92 }
93 else
94 {
95 _sim.addFunctionIC(AREA_LINEAR, area_function, block);
96
97 {
98 const std::string class_name = "FunctionNodalAverageIC";
99 InputParameters params = _factory.getValidParams(class_name);
100 params.set<VariableName>("variable") = AREA;
101 params.set<std::vector<SubdomainName>>("block") = block;
102 params.set<FunctionName>("function") = area_function;
103 _sim.addSimInitialCondition(class_name, genName(_comp_name, AREA, "ic"), params);
104 }
105 }
106 }
107}
Component::getSubdomainNames
virtual const std::vector< SubdomainName > & getSubdomainNames() const
Gets the subdomain names for this component.
Definition Component.C:345
FEProblem::hasFunction
virtual bool hasFunction(const std::string &name, const THREAD_ID tid=0)
FEProblem::getFunction
virtual Function & getFunction(const std::string &name, const THREAD_ID tid=0)
FlowChannelBase::getAreaFunctionName
const FunctionName & getAreaFunctionName() const
Get the name of the function describing the flow channel area.
Definition FlowChannelBase.C:144
FlowModel::AREA
static const std::string AREA
Definition FlowModel.h:102
FlowModel::AREA_LINEAR
static const std::string AREA_LINEAR
Definition FlowModel.h:103
Function::value
virtual Real value(Real t, const Point &p) const
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
MooseApp::isRestarting
bool isRestarting() const
MooseObject::isParamValid
bool isParamValid(const std::string &name) const
NamingInterface::genName
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.
Definition NamingInterface.h:29
Simulation::addConstantIC
void addConstantIC(const VariableName &var_name, Real value, const std::vector< SubdomainName > &block_names)
Definition Simulation.C:512
Simulation::addFunctionIC
void addFunctionIC(const VariableName &var_name, const std::string &func_name, const std::vector< SubdomainName > &block_names)
Definition Simulation.C:532
Simulation::addSimInitialCondition
void addSimInitialCondition(const std::string &type, const std::string &name, InputParameters params)
Definition Simulation.C:495

Referenced by FlowModel1PhaseBase::addInitialConditions().

◆ addCommonMooseObjects()

void FlowModel::addCommonMooseObjects ( )
protectedvirtual

Adds common MOOSE objects.

Definition at line 110 of file FlowModel.C.

111{
112 // add material property equal to one, useful for dummy multiplier values
113 {
114 const std::string class_name = "ConstantMaterial";
115 InputParameters params = _factory.getValidParams(class_name);
116 params.set<std::vector<SubdomainName>>("block") = _flow_channel.getSubdomainNames();
117 params.set<std::string>("property_name") = FlowModel::UNITY;
118 params.set<Real>("value") = 1.0;
119 params.set<std::vector<VariableName>>("derivative_vars") = _derivative_vars;
120 _sim.addMaterial(class_name, genName(_comp_name, FlowModel::UNITY), params);
121 }
122}
FEProblem::addMaterial
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
FlowModel::UNITY
static const std::string UNITY
Definition FlowModel.h:109
FlowModel::_derivative_vars
std::vector< VariableName > _derivative_vars
Definition FlowModel.h:79
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Referenced by FlowModel1PhaseBase::addMooseObjects().

◆ addCommonVariables()

void FlowModel::addCommonVariables ( )
protectedvirtual

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

Definition at line 70 of file FlowModel.C.

71{
72 const std::vector<SubdomainName> & subdomains = _flow_channel.getSubdomainNames();
73
74 _sim.addSimVariable(false, AREA, _fe_type, subdomains);
75 _sim.addSimVariable(false, HEAT_FLUX_PERIMETER, _fe_type, subdomains);
76 _sim.addSimVariable(false, AREA_LINEAR, FEType(FIRST, LAGRANGE), subdomains);
77}
FlowModel::HEAT_FLUX_PERIMETER
static const std::string HEAT_FLUX_PERIMETER
Definition FlowModel.h:105
Simulation::addSimVariable
void addSimVariable(bool nl, const VariableName &name, libMesh::FEType fe_type, Real scaling_factor=1.0)
Queues a variable of type MooseVariableScalar to be added to the nonlinear or aux system.
Definition Simulation.C:271

Referenced by FlowModel1PhaseBase::addVariables().

◆ addInitialConditions()

virtual void FlowModel::addInitialConditions ( )
pure virtual

Add initial conditions.

Implemented in FlowModel1PhaseBase, FlowModelGasMix, and FlowModelSinglePhase.

◆ 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, FlowModelGasMix, and FlowModelSinglePhase.

◆ genName() [1/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.

69 {
70 std::stringstream ss;
71 ss << prefix << ":" << middle;
72 if (!suffix.empty())
73 ss << ":" << suffix;
74 return ss.str();
75 }

◆ genName() [2/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.

57 {
58 std::stringstream ss;
59 ss << prefix << ":" << name << ":" << i;
60 return ss.str();
61 }
name
const std::string name
Definition Setup.h:21

◆ genName() [3/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.

45 {
46 std::stringstream ss;
47 ss << prefix << ":" << i << ":" << j;
48 if (!suffix.empty())
49 ss << ":" << suffix;
50 return ss.str();
51 }

◆ genName() [4/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.

30 {
31 std::stringstream ss;
32 ss << prefix << ":" << id;
33 if (!suffix.empty())
34 ss << ":" << suffix;
35 return ss.str();
36 }

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), addCommonInitialConditions(), addCommonMooseObjects(), FlowChannelBase::addCommonObjects(), Simulation::addComponentScalarIC(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), Simulation::addConstantIC(), Simulation::addConstantScalarIC(), FlowModel1PhaseBase::addDensityAux(), FlowModelGasMix::addDensityIC(), FlowModelSinglePhase::addDensityIC(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowChannel1Phase::addFlowChannel1PhaseFunctorMaterial(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModelSinglePhase::addFluidPropertiesMaterials(), VolumeJunctionCoupledFlux1Phase::addFluxTransfer(), FlowModel1PhaseBase::addFunctionIC(), Simulation::addFunctionIC(), FlowModel1PhaseBase::addHeatConductionDGKernel(), HeatTransferBase::addHeatedPerimeter(), HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), FlowChannel1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), FormLossFromFunction1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatTransferBase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Shaft::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), Component::addNonlinearStepFunctorMaterial(), FlowChannel1Phase::addNormalized1PhaseResidualNorm(), FlowModelSinglePhase::addPassiveTransportIC(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addPressureAux(), VolumeJunctionCoupledFlux1Phase::addPropertyTransfer(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelGasMix::addRhoEAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelGasMix::addTemperatureAux(), FlowModelSinglePhase::addTemperatureAux(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowChannelBase::addVariables(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), VolumeJunction1Phase::addVolumeJunctionIC(), VolumeJunctionCoupledFlux1Phase::addVolumeJunctionKernel(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), ClosuresBase::addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), FlowBoundary1Phase::addWeakBCs(), FlowBoundaryGasMix::addWeakBCs(), ClosuresBase::addWeightedAverageMaterial(), FlowModelGasMix::addXiRhoAIC(), ClosuresBase::addZeroMaterial(), FileMeshComponent::buildMesh(), Component1D::buildMesh(), Component2D::buildMesh(), HeatSourceBase::HeatSourceBase(), Component::nonlinearConvergenceName(), and Simulation::setupInitialConditionsFromFile().

◆ 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.

83 {
84 std::stringstream ss;
85 ss << prefix << "_" << middle;
86 if (!suffix.empty())
87 ss << "_" << suffix;
88 return ss.str();
89 }

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

◆ getVariableFn()

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

Definition at line 56 of file FlowModel.C.

57{
58 const FunctionName & fn_name = _flow_channel.getParam<FunctionName>(fn_param_name);
59 const Function & fn = _sim.getFunction(fn_name);
60
61 if (dynamic_cast<const ConstantFunction *>(&fn) != nullptr)
62 {
63 _flow_channel.connectObject(fn.parameters(), fn_name, fn_param_name, "value");
64 }
65
66 return fn_name;
67}
Component::connectObject
void connectObject(const InputParameters &obj_params, const std::string &obj_name, const std::string &param) const
Connects a controllable parameter of the component to a controllable parameter of a constituent objec...
Definition Component.C:98

Referenced by FlowModelSinglePhase::addRhoEAIC().

◆ 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.

20{
21 InputParameters params = MooseObject::validParams();
22 params.addPrivateParam<THMProblem *>("_thm_problem");
23 params.addPrivateParam<FlowChannelBase *>("_flow_channel");
24 params.addRequiredParam<UserObjectName>(
25 "fp", "The name of the user object that defines fluid properties");
26 params.addRequiredParam<bool>("output_vector_velocity",
27 "True if velocity is put out as a vector field.");
28 params.registerBase("THM:flow_model");
29 return params;
30}
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addPrivateParam
void addPrivateParam(const std::string &name, const T &value)
InputParameters::registerBase
void registerBase(const std::string &value)
MooseObject::validParams
static InputParameters validParams()

Referenced by FlowModel1PhaseBase::validParams().

Member Data Documentation

◆ _comp_name

const std::string FlowModel::_comp_name
protected

The component name.

Definition at line 68 of file FlowModel.h.

Referenced by addCommonInitialConditions(), addCommonMooseObjects(), FlowModel1PhaseBase::addDensityAux(), FlowModelGasMix::addDensityIC(), FlowModelSinglePhase::addDensityIC(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModelSinglePhase::addFluidPropertiesMaterials(), FlowModel1PhaseBase::addFunctionIC(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), FlowModelSinglePhase::addPassiveTransportIC(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addPressureAux(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelGasMix::addRhoEAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelGasMix::addTemperatureAux(), FlowModelSinglePhase::addTemperatureAux(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), and FlowModelGasMix::addXiRhoAIC().

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

Referenced by addCommonInitialConditions(), addCommonMooseObjects(), FlowModel1PhaseBase::addDensityAux(), FlowModelGasMix::addDensityIC(), FlowModelSinglePhase::addDensityIC(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModelSinglePhase::addFluidPropertiesMaterials(), FlowModel1PhaseBase::addFunctionIC(), FlowModel1PhaseBase::addHeatConductionDGKernel(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), FlowModelGasMix::addNumericalFluxUserObject(), FlowModelSinglePhase::addNumericalFluxUserObject(), FlowModelSinglePhase::addPassiveTransportIC(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addPressureAux(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelGasMix::addRhoEAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelGasMix::addTemperatureAux(), FlowModelSinglePhase::addTemperatureAux(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), and FlowModelGasMix::addXiRhoAIC().

◆ _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(), FlowModel1PhaseBase::addVariables(), FlowModelGasMix::addVariables(), and FlowModelSinglePhase::addVariables().

◆ _flow_channel

FlowChannelBase& FlowModel::_flow_channel
protected

The flow channel component that built this class.

Definition at line 59 of file FlowModel.h.

Referenced by addCommonInitialConditions(), addCommonMooseObjects(), addCommonVariables(), FlowModel1PhaseBase::addDensityAux(), FlowModelGasMix::addDensityIC(), FlowModelSinglePhase::addDensityIC(), FlowModel1PhaseBase::addDGKernels(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModelSinglePhase::addFluidPropertiesMaterials(), FlowModel1PhaseBase::addFunctionIC(), FlowModel1PhaseBase::addHeatConductionDGKernel(), FlowModel1PhaseBase::addInitialConditions(), FlowModelGasMix::addInitialConditions(), FlowModelSinglePhase::addInitialConditions(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), FlowModelSinglePhase::addPassiveTransportIC(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addPressureAux(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelGasMix::addRhoEAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelGasMix::addTemperatureAux(), FlowModelSinglePhase::addTemperatureAux(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowModel1PhaseBase::addVariables(), FlowModelGasMix::addVariables(), FlowModelSinglePhase::addVariables(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), FlowModelGasMix::addXiRhoAIC(), FlowModelSinglePhase::FlowModelSinglePhase(), getVariableFn(), and FlowModel1PhaseBase::ICParametersAreValid().

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

Referenced by FlowModelGasMix::addDensityIC(), FlowModelSinglePhase::addDensityIC(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModelSinglePhase::addFluidPropertiesMaterials(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addNumericalFluxUserObject(), FlowModelSinglePhase::addNumericalFluxUserObject(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addPressureAux(), FlowModelGasMix::addRhoEAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModelGasMix::addTemperatureAux(), and FlowModelSinglePhase::addTemperatureAux().

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

Referenced by addCommonInitialConditions(), addCommonMooseObjects(), addCommonVariables(), FlowModel1PhaseBase::addDensityAux(), FlowModelGasMix::addDensityIC(), FlowModelSinglePhase::addDensityIC(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModelSinglePhase::addFluidPropertiesMaterials(), FlowModel1PhaseBase::addFunctionIC(), FlowModel1PhaseBase::addHeatConductionDGKernel(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), FlowModelGasMix::addNumericalFluxUserObject(), FlowModelSinglePhase::addNumericalFluxUserObject(), FlowModelSinglePhase::addPassiveTransportIC(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addPressureAux(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelGasMix::addRhoEAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelGasMix::addTemperatureAux(), FlowModelSinglePhase::addTemperatureAux(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowModel1PhaseBase::addVariables(), FlowModelGasMix::addVariables(), FlowModelSinglePhase::addVariables(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), FlowModelGasMix::addXiRhoAIC(), and getVariableFn().

◆ _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(), FormLoss1PhaseBase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), FlowModelSinglePhase::addRhoEAIC(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), Pump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), and SimpleTurbine1Phase::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(), GateValve1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), VolumeJunction1Phase::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(), HeatTransferBase::initSecondary(), and HeatTransferFromHeatStructure3D1Phase::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(), HeatTransferBase::initSecondary(), and HeatTransferFromHeatStructure3D1Phase::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.

Referenced by HeatTransferFromHeatStructure3D1Phase::addVariables(), HeatTransferBase::initSecondary(), HeatTransferFromHeatStructure3D1Phase::initSecondary(), ADWallHeatTransferCoefficientGnielinskiMaterial::validParams(), ADWallHeatTransferCoefficientKazimiMaterial::validParams(), ADWallHeatTransferCoefficientLyonMaterial::validParams(), ADWallHeatTransferCoefficientMikityukMaterial::validParams(), ADWallHeatTransferCoefficientSchadMaterial::validParams(), ADWallHeatTransferCoefficientWeismanMaterial::validParams(), ADWallHeatTransferCoefficientWolfMcCarthyMaterial::validParams(), ADWallHTCGnielinskiAnnularMaterial::validParams(), ADHeatRateConvection1Phase::validParams(), and HeatRateConvection1Phase::validParams().

◆ 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:
Generated on Fri Aug 21 2026 13:42:45 for https://mooseframework.inl.gov by doxygen 1.9.8