https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Closures1PhaseBase Class Referenceabstract

Base class for 1-phase closures. More...

#include <Closures1PhaseBase.h>

Inheritance diagram for Closures1PhaseBase:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 Closures1PhaseBase (const InputParameters &params)
 
virtual void checkFlowChannel (const FlowChannelBase &) const
 Checks for errors associated with a flow channel component. More...
 
virtual void checkHeatTransfer (const HeatTransferBase &, const FlowChannelBase &) const
 Checks for errors associated with a heat transfer component. More...
 
virtual void addMooseObjectsFlowChannel (const FlowChannelBase &flow_channel)=0
 Adds MOOSE objects associated with a flow channel component. More...
 
virtual void addMooseObjectsHeatTransfer (const HeatTransferBase &heat_transfer, const FlowChannelBase &flow_channel)=0
 Adds MOOSE objects associated with a heat transfer component. More...
 
virtual bool enabled () const
 
std::shared_ptr< MooseObjectgetSharedPtr ()
 
std::shared_ptr< const MooseObjectgetSharedPtr () const
 
MooseAppgetMooseApp () 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 InputParametersparameters () 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
 
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
 
template<typename... Args>
void logError (Args &&... args) const
 Logs an error. More...
 
template<typename... Args>
void logComponentError (const std::string &component_name, Args &&... args) const
 Logs an error for a component. More...
 
template<typename... Args>
void logWarning (Args &&... args) const
 Logs a warning. More...
 
template<typename... Args>
void logComponentWarning (const std::string &component_name, Args &&... args) const
 Logs a warning for a component. More...
 
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
 

Protected Member Functions

void addWallFrictionFunctionMaterial (const FlowChannel1Phase &flow_channel) const
 Adds material that computes wall friction factor from a specified function. More...
 
void addAverageWallTemperatureMaterial (const FlowChannel1Phase &flow_channel) const
 Adds average wall temperature material. More...
 
void addZeroMaterial (const FlowChannelBase &flow_channel, const std::string &property_name) const
 Adds an arbitrary zero-value material. More...
 
void addWeightedAverageMaterial (const FlowChannelBase &flow_channel, const std::vector< MaterialPropertyName > &values, const std::vector< VariableName > &weights, const MaterialPropertyName &property_name) const
 Adds a weighted average material. More...
 
void addWallTemperatureFromAuxMaterial (const FlowChannelBase &flow_channel, unsigned int i=0) const
 Adds a material for wall temperature from an aux variable. More...
 

Protected Attributes

THMProblem_sim
 Simulation. More...
 
Factory_factory
 Factory associated with the MooseApp. More...
 
const bool & _enabled
 
MooseApp_app
 
const std::string _type
 
const std::string _name
 
const InputParameters_pars
 
ActionFactory_action_factory
 
const Parallel::Communicator & _communicator
 
Logger_log
 

Detailed Description

Base class for 1-phase closures.

Definition at line 19 of file Closures1PhaseBase.h.

Constructor & Destructor Documentation

◆ Closures1PhaseBase()

Closures1PhaseBase::Closures1PhaseBase ( const InputParameters params)

Definition at line 21 of file Closures1PhaseBase.C.

21 : ClosuresBase(params) {}
ClosuresBase(const InputParameters &params)
Definition: ClosuresBase.C:26

Member Function Documentation

◆ addAverageWallTemperatureMaterial()

void Closures1PhaseBase::addAverageWallTemperatureMaterial ( const FlowChannel1Phase flow_channel) const
protected

Adds average wall temperature material.

Parameters
[in]flow_channelFlow channel component

Definition at line 38 of file Closures1PhaseBase.C.

Referenced by Closures1PhaseSimple::addMooseObjectsFlowChannel(), WallTemperature1PhaseClosures::addMooseObjectsFlowChannel(), and Closures1PhaseNone::addMooseObjectsFlowChannel().

39 {
40  const std::string class_name = "ADAverageWallTemperature3EqnMaterial";
41  InputParameters params = _factory.getValidParams(class_name);
42  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
43  params.set<std::vector<VariableName>>("T_wall_sources") = flow_channel.getWallTemperatureNames();
44  params.set<std::vector<MaterialPropertyName>>("Hw_sources") =
45  flow_channel.getWallHTCNames1Phase();
46  params.set<std::vector<VariableName>>("P_hf_sources") = flow_channel.getHeatedPerimeterNames();
47  params.set<std::vector<VariableName>>("P_hf_total") = {FlowModel::HEAT_FLUX_PERIMETER};
48  params.set<std::vector<VariableName>>("T_fluid") = {FlowModelSinglePhase::TEMPERATURE};
49  _sim.addMaterial(class_name, genName(flow_channel.name(), "avg_T_wall_3eqn_mat"), params);
50 }
THMProblem & _sim
Simulation.
Definition: ClosuresBase.h:100
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::vector< VariableName > getHeatedPerimeterNames() const
Gets heated perimeter names for connected heat transfers.
static const std::string TEMPERATURE
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
std::vector< VariableName > getWallTemperatureNames() const
Gets wall temperature names for connected heat transfers.
virtual const std::string & name() const
std::vector< MaterialPropertyName > getWallHTCNames1Phase() const
Gets 1-phase wall heat transfer coefficient names for connected heat transfers.
Factory & _factory
Factory associated with the MooseApp.
Definition: ClosuresBase.h:103
static const std::string HEAT_FLUX_PERIMETER
Definition: FlowModel.h:105
virtual const std::vector< SubdomainName > & getSubdomainNames() const
Gets the subdomain names for this component.
Definition: Component.C:307

◆ addMooseObjectsFlowChannel()

virtual void ClosuresBase::addMooseObjectsFlowChannel ( const FlowChannelBase flow_channel)
pure virtualinherited

Adds MOOSE objects associated with a flow channel component.

Parameters
[in]flow_channelFlow channel component

Implemented in Closures1PhaseTHM, Closures1PhaseNone, WallTemperature1PhaseClosures, Closures1PhaseSimple, and FunctorClosures.

◆ addMooseObjectsHeatTransfer()

virtual void ClosuresBase::addMooseObjectsHeatTransfer ( const HeatTransferBase heat_transfer,
const FlowChannelBase flow_channel 
)
pure virtualinherited

Adds MOOSE objects associated with a heat transfer component.

Parameters
[in]heat_transferHeat transfer component
[in]flow_channelFlow channel component

Implemented in Closures1PhaseTHM, Closures1PhaseNone, WallTemperature1PhaseClosures, Closures1PhaseSimple, and FunctorClosures.

◆ addWallFrictionFunctionMaterial()

void Closures1PhaseBase::addWallFrictionFunctionMaterial ( const FlowChannel1Phase flow_channel) const
protected

Adds material that computes wall friction factor from a specified function.

This function assumes that the flow channel component has the parameter 'f' as a valid parameter, so this function should be guarded appropriately.

Parameters
[in]flow_channelFlow channel component

Definition at line 24 of file Closures1PhaseBase.C.

Referenced by Closures1PhaseSimple::addMooseObjectsFlowChannel(), and Closures1PhaseTHM::addMooseObjectsFlowChannel().

25 {
26  const FunctionName & f_D_fn_name = flow_channel.getParam<FunctionName>("f");
27  flow_channel.makeFunctionControllableIfConstant(f_D_fn_name, "f");
28 
29  const std::string class_name = "ADWallFrictionFunctionMaterial";
30  InputParameters params = _factory.getValidParams(class_name);
31  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
32  params.set<MaterialPropertyName>("f_D") = FlowModelSinglePhase::FRICTION_FACTOR_DARCY;
33  params.set<FunctionName>("function") = f_D_fn_name;
34  _sim.addMaterial(class_name, genName(flow_channel.name(), "f_wall_fn_mat"), params);
35 }
THMProblem & _sim
Simulation.
Definition: ClosuresBase.h:100
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.
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
void makeFunctionControllableIfConstant(const FunctionName &fn_name, const std::string &control_name, const std::string &param="value") const
Makes a function controllable if it is constant.
Definition: Component.C:141
virtual const std::string & name() const
const T & getParam(const std::string &name) const
static const std::string FRICTION_FACTOR_DARCY
Factory & _factory
Factory associated with the MooseApp.
Definition: ClosuresBase.h:103
virtual const std::vector< SubdomainName > & getSubdomainNames() const
Gets the subdomain names for this component.
Definition: Component.C:307

◆ addWallTemperatureFromAuxMaterial()

void ClosuresBase::addWallTemperatureFromAuxMaterial ( const FlowChannelBase flow_channel,
unsigned int  i = 0 
) const
protectedinherited

Adds a material for wall temperature from an aux variable.

Parameters
[in]flow_channelFlow channel component
[in]iindex of the heat transfer

Definition at line 64 of file ClosuresBase.C.

Referenced by Closures1PhaseSimple::addMooseObjectsFlowChannel(), WallTemperature1PhaseClosures::addMooseObjectsFlowChannel(), Closures1PhaseNone::addMooseObjectsFlowChannel(), and Closures1PhaseTHM::addMooseObjectsFlowChannel().

66 {
67  const std::string class_name = "ADCoupledVariableValueMaterial";
68  InputParameters params = _factory.getValidParams(class_name);
69  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
70  params.set<MaterialPropertyName>("prop_name") = {flow_channel.getWallTemperatureNames()[i]};
71  params.set<std::vector<VariableName>>("coupled_variable") = {
72  flow_channel.getWallTemperatureNames()[i]};
73  _sim.addMaterial(class_name, genName(flow_channel.name(), "coupled_var_mat", i), params);
74 }
THMProblem & _sim
Simulation.
Definition: ClosuresBase.h:100
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.
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
std::vector< VariableName > getWallTemperatureNames() const
Gets wall temperature names for connected heat transfers.
virtual const std::string & name() const
Factory & _factory
Factory associated with the MooseApp.
Definition: ClosuresBase.h:103
virtual const std::vector< SubdomainName > & getSubdomainNames() const
Gets the subdomain names for this component.
Definition: Component.C:307

◆ addWeightedAverageMaterial()

void ClosuresBase::addWeightedAverageMaterial ( const FlowChannelBase flow_channel,
const std::vector< MaterialPropertyName > &  values,
const std::vector< VariableName > &  weights,
const MaterialPropertyName &  property_name 
) const
protectedinherited

Adds a weighted average material.

Parameters
[in]flow_channelFlow channel component
[in]valuesValues to average
[in]weightsWeights for each value
[in]property_nameName of material property to create

Definition at line 49 of file ClosuresBase.C.

Referenced by Closures1PhaseSimple::addMooseObjectsFlowChannel().

53 {
54  const std::string class_name = "ADWeightedAverageMaterial";
55  InputParameters params = _factory.getValidParams(class_name);
56  params.set<MaterialPropertyName>("prop_name") = property_name;
57  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
58  params.set<std::vector<MaterialPropertyName>>("values") = values;
59  params.set<std::vector<VariableName>>("weights") = weights;
60  _sim.addMaterial(class_name, genName(flow_channel.name(), "wavg_mat", property_name), params);
61 }
THMProblem & _sim
Simulation.
Definition: ClosuresBase.h:100
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.
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
virtual const std::string & name() const
Factory & _factory
Factory associated with the MooseApp.
Definition: ClosuresBase.h:103
virtual const std::vector< SubdomainName > & getSubdomainNames() const
Gets the subdomain names for this component.
Definition: Component.C:307

◆ addZeroMaterial()

void ClosuresBase::addZeroMaterial ( const FlowChannelBase flow_channel,
const std::string &  property_name 
) const
protectedinherited

Adds an arbitrary zero-value material.

Parameters
[in]flow_channelFlow channel component
[in]property_nameName of the material property to create

Definition at line 37 of file ClosuresBase.C.

39 {
40  const std::string class_name = "ADConstantMaterial";
41  InputParameters params = _factory.getValidParams(class_name);
42  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
43  params.set<std::string>("property_name") = property_name;
44  params.set<Real>("value") = 0;
45  _sim.addMaterial(class_name, genName(flow_channel.name(), "const_mat", property_name), params);
46 }
THMProblem & _sim
Simulation.
Definition: ClosuresBase.h:100
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.
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
virtual const std::string & name() const
Factory & _factory
Factory associated with the MooseApp.
Definition: ClosuresBase.h:103
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual const std::vector< SubdomainName > & getSubdomainNames() const
Gets the subdomain names for this component.
Definition: Component.C:307

◆ checkFlowChannel()

virtual void ClosuresBase::checkFlowChannel ( const FlowChannelBase ) const
inlinevirtualinherited

Checks for errors associated with a flow channel component.

Parameters
[in]flow_channelFlow channel component

Reimplemented in Closures1PhaseTHM, Closures1PhaseNone, WallTemperature1PhaseClosures, and Closures1PhaseSimple.

Definition at line 38 of file ClosuresBase.h.

38 {}

◆ checkHeatTransfer()

virtual void ClosuresBase::checkHeatTransfer ( const HeatTransferBase ,
const FlowChannelBase  
) const
inlinevirtualinherited

Checks for errors associated with a heat transfer component.

Parameters
[in]heat_transferHeat transfer component
[in]flow_channelFlow channel component

Reimplemented in Closures1PhaseTHM, Closures1PhaseNone, WallTemperature1PhaseClosures, and Closures1PhaseSimple.

Definition at line 46 of file ClosuresBase.h.

48  {
49  }

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

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

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

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

45  {
46  std::stringstream ss;
47  ss << prefix << ":" << i << ":" << j;
48  if (!suffix.empty())
49  ss << ":" << suffix;
50  return ss.str();
51  }
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")

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

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

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

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

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

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

◆ logComponentError()

template<typename... Args>
void LoggingInterface::logComponentError ( const std::string &  component_name,
Args &&...  args 
) const
inlineinherited

Logs an error for a component.

Parameters
[in]component_nameName of the component

Definition at line 47 of file LoggingInterface.h.

Referenced by Closures1PhaseSimple::checkFlowChannel(), Closures1PhaseSimple::checkHeatTransfer(), and Component::logError().

48  {
49  _log.add(Logger::ERROR, component_name, ": ", std::forward<Args>(args)...);
50  }
void add(EMessageType type, Args &&... args)
Add a message to the log.
Definition: Logger.h:35

◆ logComponentWarning()

template<typename... Args>
void LoggingInterface::logComponentWarning ( const std::string &  component_name,
Args &&...  args 
) const
inlineinherited

Logs a warning for a component.

Parameters
[in]component_nameName of the component

Definition at line 67 of file LoggingInterface.h.

Referenced by Component::logWarning().

68  {
69  _log.add(Logger::WARNING, component_name, ": ", std::forward<Args>(args)...);
70  }
void add(EMessageType type, Args &&... args)
Add a message to the log.
Definition: Logger.h:35

◆ logError()

template<typename... Args>
void LoggingInterface::logError ( Args &&...  args) const
inlineinherited

Logs an error.

Definition at line 36 of file LoggingInterface.h.

Referenced by Simulation::addClosures(), Simulation::addComponent(), Simulation::controlDataIntegrityCheck(), Simulation::declareControlData(), Simulation::identifyLoops(), and Simulation::integrityCheck().

37  {
38  _log.add(Logger::ERROR, std::forward<Args>(args)...);
39  }
void add(EMessageType type, Args &&... args)
Add a message to the log.
Definition: Logger.h:35

◆ logWarning()

template<typename... Args>
void LoggingInterface::logWarning ( Args &&...  args) const
inlineinherited

Logs a warning.

Definition at line 56 of file LoggingInterface.h.

57  {
58  _log.add(Logger::WARNING, std::forward<Args>(args)...);
59  }
void add(EMessageType type, Args &&... args)
Add a message to the log.
Definition: Logger.h:35

◆ validParams()

InputParameters Closures1PhaseBase::validParams ( )
static

Member Data Documentation

◆ _factory

Factory& ClosuresBase::_factory
protectedinherited

◆ _log

Logger& LoggingInterface::_log
protectedinherited

◆ _sim

THMProblem& ClosuresBase::_sim
protectedinherited

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