ClosuresBase Class Reference

Base class for closures implementations. More...

#include <ClosuresBase.h>

Inheritance diagram for ClosuresBase:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	ClosuresBase (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< 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
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	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 closures implementations.

The responsibilities of the closures objects depend on the flow model that uses them. Examples of responsibilities will be to provide material properties for friction factors and heat transfer coefficients.

Definition at line 28 of file ClosuresBase.h.

Constructor & Destructor Documentation

ClosuresBase()

ClosuresBase::ClosuresBase

(

const InputParameters &

params

)

Definition at line 26 of file ClosuresBase.C.

  : MooseObject(params),
    LoggingInterface(*params.getCheckedPointerParam<Logger *>("_logger")),
    NamingInterface(),

    _sim(*params.getCheckedPointerParam<THMProblem *>("_thm_problem")),
    _factory(_app.getFactory())
{
}

Member Function Documentation

addMooseObjectsFlowChannel()

virtual void ClosuresBase::addMooseObjectsFlowChannel ( const FlowChannelBase &  flow_channel )

pure virtual

Adds MOOSE objects associated with a flow channel component.

Parameters

[in]

flow_channel

Flow channel component

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

addMooseObjectsHeatTransfer()

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

pure virtual

Adds MOOSE objects associated with a heat transfer component.

Parameters

[in]	heat_transfer	Heat transfer component
[in]	flow_channel	Flow channel component

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

addWallTemperatureFromAuxMaterial()

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

protected

Adds a material for wall temperature from an aux variable.

Parameters

[in]	flow_channel	Flow channel component
[in]	i	index of the heat transfer

Definition at line 64 of file ClosuresBase.C.

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

{
  const std::string class_name = "ADCoupledVariableValueMaterial";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
  params.set<MaterialPropertyName>("prop_name") = {flow_channel.getWallTemperatureNames()[i]};
  params.set<std::vector<VariableName>>("coupled_variable") = {
      flow_channel.getWallTemperatureNames()[i]};
  _sim.addMaterial(class_name, genName(flow_channel.name(), "coupled_var_mat", i), params);
}

addWeightedAverageMaterial()

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

protected

Adds a weighted average material.

Parameters

[in]	flow_channel	Flow channel component
[in]	values	Values to average
[in]	weights	Weights for each value
[in]	property_name	Name of material property to create

Definition at line 49 of file ClosuresBase.C.

Referenced by Closures1PhaseSimple::addMooseObjectsFlowChannel().

{
  const std::string class_name = "ADWeightedAverageMaterial";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<MaterialPropertyName>("prop_name") = property_name;
  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
  params.set<std::vector<MaterialPropertyName>>("values") = values;
  params.set<std::vector<VariableName>>("weights") = weights;
  _sim.addMaterial(class_name, genName(flow_channel.name(), "wavg_mat", property_name), params);
}

addZeroMaterial()

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

protected

Adds an arbitrary zero-value material.

Parameters

[in]	flow_channel	Flow channel component
[in]	property_name	Name of the material property to create

Definition at line 37 of file ClosuresBase.C.

{
  const std::string class_name = "ADConstantMaterial";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
  params.set<std::string>("property_name") = property_name;
  params.set<Real>("value") = 0;
  _sim.addMaterial(class_name, genName(flow_channel.name(), "const_mat", property_name), params);
}

checkFlowChannel()

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

inlinevirtual

Checks for errors associated with a flow channel component.

Parameters

[in]

flow_channel

Flow channel component

Reimplemented in Closures1PhaseTHM, Closures1PhaseNone, WallTemperature1PhaseClosures, and Closures1PhaseSimple.

Definition at line 38 of file ClosuresBase.h.

{}

checkHeatTransfer()

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

inlinevirtual

Checks for errors associated with a heat transfer component.

Parameters

[in]	heat_transfer	Heat transfer component
[in]	flow_channel	Flow channel component

Reimplemented in Closures1PhaseTHM, Closures1PhaseNone, WallTemperature1PhaseClosures, and Closures1PhaseSimple.

Definition at line 46 of file ClosuresBase.h.

  {
  }

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 Closures1PhaseBase::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(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), FormLossFromFunction1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatStructure2DCoupler::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(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), FlowBoundary1Phase::addWeakBCs(), FlowBoundaryGasMix::addWeakBCs(), addWeightedAverageMaterial(), FlowModelGasMix::addXiRhoAIC(), addZeroMaterial(), Component2D::buildMesh(), FileMeshComponent::buildMesh(), Component1D::buildMesh(), HeatSourceBase::HeatSourceBase(), and Simulation::setupInitialConditionsFromFile().

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

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_name

Name of the component

Definition at line 47 of file LoggingInterface.h.

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

  {
    _log.add(Logger::ERROR, component_name, ": ", std::forward<Args>(args)...);
  }

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_name

Name of the component

Definition at line 67 of file LoggingInterface.h.

Referenced by Component::logWarning().

  {
    _log.add(Logger::WARNING, component_name, ": ", std::forward<Args>(args)...);
  }

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

  {
    _log.add(Logger::ERROR, std::forward<Args>(args)...);
  }

logWarning()

template<typename... Args>

void LoggingInterface::logWarning ( Args &&...  args ) const

inlineinherited

Logs a warning.

Definition at line 56 of file LoggingInterface.h.

  {
    _log.add(Logger::WARNING, std::forward<Args>(args)...);
  }

validParams()

InputParameters ClosuresBase::validParams ( )

static

Definition at line 14 of file ClosuresBase.C.

Referenced by FunctorClosures::validParams(), and Closures1PhaseBase::validParams().

{
  InputParameters params = MooseObject::validParams();

  params.addPrivateParam<THMProblem *>("_thm_problem");
  params.addPrivateParam<Logger *>("_logger");

  params.registerBase("Closures");

  return params;
}

Member Data Documentation

_factory

Factory& ClosuresBase::_factory

protected

Factory associated with the MooseApp.

Definition at line 103 of file ClosuresBase.h.

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), Closures1PhaseTHM::addTemperatureWallFromHeatFluxMaterial(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), addWeightedAverageMaterial(), and addZeroMaterial().

_log

Logger& LoggingInterface::_log

protectedinherited

Definition at line 73 of file LoggingInterface.h.

Referenced by LoggingInterface::logComponentError(), LoggingInterface::logComponentWarning(), LoggingInterface::logError(), and LoggingInterface::logWarning().

_sim

THMProblem& ClosuresBase::_sim

protected

Simulation.

Definition at line 100 of file ClosuresBase.h.

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), Closures1PhaseTHM::addTemperatureWallFromHeatFluxMaterial(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), addWeightedAverageMaterial(), and addZeroMaterial().

---

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

• thermal_hydraulics/include/closures/ClosuresBase.h
• thermal_hydraulics/src/closures/ClosuresBase.C