Closures1PhaseTHM Class Reference

THM 1-phase closures. More...

#include <Closures1PhaseTHM.h>

Inheritance diagram for Closures1PhaseTHM:

Public Types
enum	WallHTCClosureType {   WallHTCClosureType::DITTUS_BOELTER, WallHTCClosureType::KAZIMI_CARELLI, WallHTCClosureType::LYON, WallHTCClosureType::MIKITYUK,   WallHTCClosureType::SCHAD, WallHTCClosureType::WEISMAN, WallHTCClosureType::WOLF_MCCARTHY, WallHTCClosureType::GNIELINSKI }
	Fluid heat transfer coefficient closure type. More...
enum	WallFFClosureType { WallFFClosureType::CHENG_TODREAS, WallFFClosureType::CHURCHILL }
	Fluid friction factor closure type. More...
typedef DataFileName	DataFileParameterType

Public Member Functions
	Closures1PhaseTHM (const InputParameters &params)
virtual void	checkFlowChannel (const FlowChannelBase &flow_channel) const override
	Checks for errors associated with a flow channel component. More...
virtual void	checkHeatTransfer (const HeatTransferBase &heat_transfer, const FlowChannelBase &flow_channel) const override
	Checks for errors associated with a heat transfer component. More...
virtual void	addMooseObjectsFlowChannel (const FlowChannelBase &flow_channel) override
	Adds MOOSE objects associated with a flow channel component. More...
virtual void	addMooseObjectsHeatTransfer (const HeatTransferBase &, const FlowChannelBase &) override
	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	addWallFFMaterial (const FlowChannel1Phase &flow_channel) const
	Adds material that computes wall friction factor. More...
void	addWallHTCMaterial (const FlowChannel1Phase &flow_channel, unsigned int i) const
	Adds wall heat transfer coefficient material. More...
void	addTemperatureWallFromHeatFluxMaterial (const FlowChannel1Phase &flow_channel, unsigned int i) const
	Adds computation of wall temperature when heat flux is specified. More...
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
const WallHTCClosureType	_wall_htc_closure
	Wall heat transfer coefficient closure. More...
const WallFFClosureType	_wall_ff_closure
	Wall friction factor closure. More...
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

THM 1-phase closures.

Definition at line 17 of file Closures1PhaseTHM.h.

Member Enumeration Documentation

WallFFClosureType

enum Closures1PhaseTHM::WallFFClosureType

strong

Fluid friction factor closure type.

Enumerator
CHENG_TODREAS
CHURCHILL

Definition at line 36 of file Closures1PhaseTHM.h.

  {
    CHENG_TODREAS,
    CHURCHILL
  };

WallHTCClosureType

enum Closures1PhaseTHM::WallHTCClosureType

strong

Fluid heat transfer coefficient closure type.

Enumerator
DITTUS_BOELTER
KAZIMI_CARELLI
LYON
MIKITYUK
SCHAD
WEISMAN
WOLF_MCCARTHY
GNIELINSKI

Definition at line 23 of file Closures1PhaseTHM.h.

  {
    DITTUS_BOELTER,
    KAZIMI_CARELLI,
    LYON,
    MIKITYUK,
    SCHAD,
    WEISMAN,
    WOLF_MCCARTHY,
    GNIELINSKI
  };

Constructor & Destructor Documentation

Closures1PhaseTHM()

Closures1PhaseTHM::Closures1PhaseTHM

(

const InputParameters &

params

)

Definition at line 33 of file Closures1PhaseTHM.C.

  : Closures1PhaseBase(params),
    _wall_htc_closure(getParam<MooseEnum>("wall_htc_closure").getEnum<WallHTCClosureType>()),
    _wall_ff_closure(getParam<MooseEnum>("wall_ff_closure").getEnum<WallFFClosureType>())
{
}

Member Function Documentation

addAverageWallTemperatureMaterial()

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

protectedinherited

Adds average wall temperature material.

Parameters

[in]

flow_channel

Flow channel component

Definition at line 38 of file Closures1PhaseBase.C.

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

{
  const std::string class_name = "ADAverageWallTemperature3EqnMaterial";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
  params.set<std::vector<VariableName>>("T_wall_sources") = flow_channel.getWallTemperatureNames();
  params.set<std::vector<MaterialPropertyName>>("Hw_sources") =
      flow_channel.getWallHTCNames1Phase();
  params.set<std::vector<VariableName>>("P_hf_sources") = flow_channel.getHeatedPerimeterNames();
  params.set<std::vector<VariableName>>("P_hf_total") = {FlowModel::HEAT_FLUX_PERIMETER};
  params.set<std::vector<VariableName>>("T_fluid") = {FlowModelSinglePhase::TEMPERATURE};
  _sim.addMaterial(class_name, genName(flow_channel.name(), "avg_T_wall_3eqn_mat"), params);
}

addMooseObjectsFlowChannel()

void Closures1PhaseTHM::addMooseObjectsFlowChannel ( const FlowChannelBase &  flow_channel )

overridevirtual

Adds MOOSE objects associated with a flow channel component.

Parameters

[in]

flow_channel

Flow channel component

Implements ClosuresBase.

Definition at line 52 of file Closures1PhaseTHM.C.

{
  const FlowChannel1Phase & flow_channel_1phase =
      dynamic_cast<const FlowChannel1Phase &>(flow_channel);

  // wall friction material
  if (flow_channel.isParamValid("f"))
    addWallFrictionFunctionMaterial(flow_channel_1phase);
  else
    addWallFFMaterial(flow_channel_1phase);

  const unsigned int n_ht_connections = flow_channel_1phase.getNumberOfHeatTransferConnections();
  if (n_ht_connections > 0)
  {

    for (unsigned int i = 0; i < n_ht_connections; i++)
    {
      // wall heat transfer coefficient material
      addWallHTCMaterial(flow_channel_1phase, i);

      // wall temperature material
      if (flow_channel.getTemperatureMode())
        addWallTemperatureFromAuxMaterial(flow_channel_1phase, i);
      else
        addTemperatureWallFromHeatFluxMaterial(flow_channel_1phase, i);
    }
  }
}

addMooseObjectsHeatTransfer()

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

inlineoverridevirtual

Adds MOOSE objects associated with a heat transfer component.

Parameters

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

Implements ClosuresBase.

Definition at line 46 of file Closures1PhaseTHM.h.

                                                                              {};

addTemperatureWallFromHeatFluxMaterial()

void Closures1PhaseTHM::addTemperatureWallFromHeatFluxMaterial ( const FlowChannel1Phase &  flow_channel, unsigned int  i  ) const

protected

Adds computation of wall temperature when heat flux is specified.

Parameters

[in]	flow_channel	Flow channel component
[in]	i	Heat transfer index

Definition at line 308 of file Closures1PhaseTHM.C.

Referenced by addMooseObjectsFlowChannel().

{
  const std::string class_name = "TemperatureWallFromHeatFlux3EqnTHMMaterial";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
  params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
  params.set<MaterialPropertyName>("D_h") = FlowModelSinglePhase::HYDRAULIC_DIAMETER;
  params.set<MaterialPropertyName>("rho") = FlowModelSinglePhase::DENSITY;
  params.set<MaterialPropertyName>("vel") = FlowModelSinglePhase::VELOCITY;
  params.set<MaterialPropertyName>("T") = FlowModelSinglePhase::TEMPERATURE;
  params.set<MaterialPropertyName>("k") = FlowModelSinglePhase::THERMAL_CONDUCTIVITY;
  params.set<MaterialPropertyName>("mu") = FlowModelSinglePhase::DYNAMIC_VISCOSITY;
  params.set<MaterialPropertyName>("cp") = FlowModelSinglePhase::SPECIFIC_HEAT_CONSTANT_PRESSURE;
  params.set<MaterialPropertyName>("q_wall") = flow_channel.getWallHeatFluxNames()[i];
  _sim.addMaterial(class_name, genName(flow_channel.name(), "T_from_q_wall_mat", i), params);
}

addWallFFMaterial()

void Closures1PhaseTHM::addWallFFMaterial ( const FlowChannel1Phase &  flow_channel ) const

protected

Adds material that computes wall friction factor.

Parameters

[in]

flow_channel

Flow channel component

Definition at line 81 of file Closures1PhaseTHM.C.

Referenced by addMooseObjectsFlowChannel().

{
  switch (_wall_ff_closure)
  {
    case WallFFClosureType::CHURCHILL:
    {
      const std::string class_name = "ADWallFrictionChurchillMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      params.set<MaterialPropertyName>("rho") = FlowModelSinglePhase::DENSITY;
      params.set<MaterialPropertyName>("vel") = FlowModelSinglePhase::VELOCITY;
      params.set<MaterialPropertyName>("D_h") = FlowModelSinglePhase::HYDRAULIC_DIAMETER;
      params.set<MaterialPropertyName>("f_D") = FlowModelSinglePhase::FRICTION_FACTOR_DARCY;
      params.set<MaterialPropertyName>("mu") = FlowModelSinglePhase::DYNAMIC_VISCOSITY;
      params.set<Real>("roughness") = flow_channel.getParam<Real>("roughness");
      const std::string obj_name = genName(flow_channel.name(), "wall_friction_mat");
      _sim.addMaterial(class_name, obj_name, params);
      flow_channel.connectObject(params, obj_name, "roughness");
      break;
    }
    case WallFFClosureType::CHENG_TODREAS:
    {
      const std::string class_name = "ADWallFrictionChengMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      params.set<MaterialPropertyName>("f_D") = FlowModelSinglePhase::FRICTION_FACTOR_DARCY;
      params.set<Real>("PoD") = flow_channel.getParam<Real>("PoD");
      if (flow_channel.getParam<Real>("PoD") == 1.0)
      {
        mooseDoOnce(mooseWarning(
            "You are using a rod bundle correlation with the default Pitch-to-Diameter "
            "ratio value, P/D=1.0. It can be set using the PoD parameter in the corresponding "
            "FlowChannel1Phase component"));
      }
      if (flow_channel.getHeatTransferGeometry() == FlowChannelBase::EConvHeatTransGeom::PIPE)
      {
        mooseError("The Cheng-Todreas correlation was made to be used in rod bundles, your "
                   "geometry type is "
                   "PIPE, please change heat_transfer_geom to ROD_BUNDLE or HEX_ROD_BUNDLE, or "
                   "choose a correlation valid for PIPES");
      }
      else if (flow_channel.getHeatTransferGeometry() ==
               FlowChannelBase::EConvHeatTransGeom::ROD_BUNDLE)
      {
        params.set<MooseEnum>("bundle_array") = "SQUARE";
      }
      else if (flow_channel.getHeatTransferGeometry() ==
               FlowChannelBase::EConvHeatTransGeom::HEX_ROD_BUNDLE)
      {
        params.set<MooseEnum>("bundle_array") = "HEXAGONAL";
      }
      if (flow_channel.getPipeLocation() == FlowChannelBase::EPipeLocation::INTERIOR)
      {
        params.set<MooseEnum>("subchannel_type") = "INTERIOR";
      }
      else if (flow_channel.getPipeLocation() == FlowChannelBase::EPipeLocation::EDGE)
      {
        params.set<MooseEnum>("subchannel_type") = "EDGE";
      }
      else if (flow_channel.getPipeLocation() == FlowChannelBase::EPipeLocation::CORNER)
      {
        params.set<MooseEnum>("subchannel_type") = "CORNER";
      }
      const std::string obj_name = genName(flow_channel.name(), "wall_friction_mat");
      _sim.addMaterial(class_name, obj_name, params);
      break;
    }
    default:
      mooseError("Invalid WallFFClosureType");
  }
}

addWallFrictionFunctionMaterial()

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

protectedinherited

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_channel

Flow channel component

Definition at line 24 of file Closures1PhaseBase.C.

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

{
  const FunctionName & f_D_fn_name = flow_channel.getParam<FunctionName>("f");
  flow_channel.makeFunctionControllableIfConstant(f_D_fn_name, "f");

  const std::string class_name = "ADWallFrictionFunctionMaterial";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
  params.set<MaterialPropertyName>("f_D") = FlowModelSinglePhase::FRICTION_FACTOR_DARCY;
  params.set<FunctionName>("function") = f_D_fn_name;
  _sim.addMaterial(class_name, genName(flow_channel.name(), "f_wall_fn_mat"), params);
}

addWallHTCMaterial()

void Closures1PhaseTHM::addWallHTCMaterial ( const FlowChannel1Phase &  flow_channel, unsigned int  i  ) const

protected

Adds wall heat transfer coefficient material.

Parameters

[in]	flow_channel	Flow channel component
[in]	i	Heat transfer index

Definition at line 154 of file Closures1PhaseTHM.C.

Referenced by addMooseObjectsFlowChannel().

{

  switch (_wall_htc_closure)
  {
    case WallHTCClosureType::DITTUS_BOELTER:
    {
      const std::string class_name = "ADWallHeatTransferCoefficient3EqnDittusBoelterMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<MaterialPropertyName>("Hw") = flow_channel.getWallHTCNames1Phase()[i];
      params.set<MaterialPropertyName>("D_h") = FlowModelSinglePhase::HYDRAULIC_DIAMETER;
      params.set<MaterialPropertyName>("rho") = FlowModelSinglePhase::DENSITY;
      params.set<MaterialPropertyName>("vel") = FlowModelSinglePhase::VELOCITY;
      params.set<MaterialPropertyName>("T") = FlowModelSinglePhase::TEMPERATURE;
      params.set<MaterialPropertyName>("k") = FlowModelSinglePhase::THERMAL_CONDUCTIVITY;
      params.set<MaterialPropertyName>("mu") = FlowModelSinglePhase::DYNAMIC_VISCOSITY;
      params.set<MaterialPropertyName>("cp") =
          FlowModelSinglePhase::SPECIFIC_HEAT_CONSTANT_PRESSURE;
      params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      _sim.addMaterial(class_name, genName(flow_channel.name(), "whtc_mat", i), params);

      break;
    }
    case WallHTCClosureType::WOLF_MCCARTHY:
    {
      const std::string class_name = "ADWallHeatTransferCoefficientWolfMcCarthyMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<MaterialPropertyName>("Hw") = flow_channel.getWallHTCNames1Phase()[i];
      params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      _sim.addMaterial(class_name, genName(flow_channel.name(), "whtc_mat", i), params);

      break;
    }
    case WallHTCClosureType::WEISMAN:
    {

      const std::string class_name = "ADWallHeatTransferCoefficientWeismanMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<MaterialPropertyName>("Hw") = flow_channel.getWallHTCNames1Phase()[i];
      params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      params.set<Real>("PoD") = flow_channel.getParam<Real>("PoD");
      if (flow_channel.getParam<Real>("PoD") == 1.0)
      {
        mooseDoOnce(mooseWarning(
            "You are using a rod bundle correlation with the default Pitch-to-Diameter "
            "ratio value, P/D=1.0. It can be set using the PoD parameter in the corresponding "
            "FlowChannel1Phase component"));
      }

      if (flow_channel.getHeatTransferGeometry() == FlowChannelBase::EConvHeatTransGeom::PIPE)
      {
        mooseError("Weiman's correlation was made to be used in rod bundles, your geometry type is "
                   "PIPE, please change heat_transfer_geom to ROD_BUNDLE or HEX_ROD_BUNDLE, or "
                   "choose a correlation valid for PIPES");
      }
      else if (flow_channel.getHeatTransferGeometry() ==
               FlowChannelBase::EConvHeatTransGeom::ROD_BUNDLE)
      {
        params.set<MooseEnum>("bundle_array") = "SQUARE";
      }
      else if (flow_channel.getHeatTransferGeometry() ==
               FlowChannelBase::EConvHeatTransGeom::HEX_ROD_BUNDLE)
      {
        params.set<MooseEnum>("bundle_array") = "TRIANGULAR";
      }
      _sim.addMaterial(class_name, genName(flow_channel.name(), "whtc_mat", i), params);
      break;
    }
    case WallHTCClosureType::LYON:
    {
      const std::string class_name = "ADWallHeatTransferCoefficientLyonMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<MaterialPropertyName>("Hw") = flow_channel.getWallHTCNames1Phase()[i];
      params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      _sim.addMaterial(class_name, genName(flow_channel.name(), "whtc_mat", i), params);
      break;
    }
    case WallHTCClosureType::KAZIMI_CARELLI:
    {

      const std::string class_name = "ADWallHeatTransferCoefficientKazimiMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<MaterialPropertyName>("Hw") = flow_channel.getWallHTCNames1Phase()[i];
      params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      params.set<Real>("PoD") = flow_channel.getParam<Real>("PoD");
      if (flow_channel.getParam<Real>("PoD") == 1.0)
      {
        mooseDoOnce(mooseWarning(
            "You are using a rod bundle correlation with the default Pitch-to-Diameter "
            "ratio value, P/D=1.0. It can be set using the PoD parameter in the corresponding "
            "FlowChannel1Phase component"));
      }
      _sim.addMaterial(class_name, genName(flow_channel.name(), "whtc_mat", i), params);
      break;
    }
    case WallHTCClosureType::MIKITYUK:
    {

      const std::string class_name = "ADWallHeatTransferCoefficientMikityukMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<MaterialPropertyName>("Hw") = flow_channel.getWallHTCNames1Phase()[i];
      params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      params.set<Real>("PoD") = flow_channel.getParam<Real>("PoD");
      if (flow_channel.getParam<Real>("PoD") == 1.0)
      {
        mooseDoOnce(mooseWarning(
            "You are using a rod bundle correlation with the default Pitch-to-Diameter "
            "ratio value, P/D=1.0. It can be set using the PoD parameter in the corresponding "
            "FlowChannel1Phase component"));
      }
      _sim.addMaterial(class_name, genName(flow_channel.name(), "whtc_mat", i), params);
      break;
    }
    case WallHTCClosureType::SCHAD:
    {

      const std::string class_name = "ADWallHeatTransferCoefficientSchadMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<MaterialPropertyName>("Hw") = flow_channel.getWallHTCNames1Phase()[i];
      params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      params.set<Real>("PoD") = flow_channel.getParam<Real>("PoD");
      if (flow_channel.getParam<Real>("PoD") == 1.0)
      {
        mooseDoOnce(mooseWarning(
            "You are using a rod bundle correlation with the default Pitch-to-Diameter "
            "ratio value, P/D=1.0. It can be set using the PoD parameter in the corresponding "
            "FlowChannel1Phase component"));
      }
      _sim.addMaterial(class_name, genName(flow_channel.name(), "whtc_mat", i), params);
      break;
    }
    case WallHTCClosureType::GNIELINSKI:
    {

      const std::string class_name = "ADWallHeatTransferCoefficientGnielinskiMaterial";
      InputParameters params = _factory.getValidParams(class_name);
      params.set<MaterialPropertyName>("Hw") = flow_channel.getWallHTCNames1Phase()[i];
      params.set<MaterialPropertyName>("T_wall") = flow_channel.getWallTemperatureNames()[i];
      params.set<std::vector<SubdomainName>>("block") = flow_channel.getSubdomainNames();
      _sim.addMaterial(class_name, genName(flow_channel.name(), "whtc_mat", i), params);
      break;
    }
    default:
      mooseError("Invalid WallHTCClosureType");
  }
}

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

protectedinherited

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

protectedinherited

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

void Closures1PhaseTHM::checkFlowChannel ( const FlowChannelBase &  ) const

overridevirtual

Checks for errors associated with a flow channel component.

Parameters

[in]

flow_channel

Flow channel component

Reimplemented from ClosuresBase.

Definition at line 41 of file Closures1PhaseTHM.C.

{
}

checkHeatTransfer()

void Closures1PhaseTHM::checkHeatTransfer ( const HeatTransferBase &  , const FlowChannelBase &    ) const

overridevirtual

Checks for errors associated with a heat transfer component.

Parameters

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

Reimplemented from ClosuresBase.

Definition at line 46 of file Closures1PhaseTHM.C.

{
}

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(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), FormLossFromFunction1Phase::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(), HeatTransferBase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::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(), addTemperatureWallFromHeatFluxMaterial(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowChannelBase::addVariables(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), VolumeJunction1Phase::addVolumeJunctionIC(), addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), 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().

  {
    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 Closures1PhaseTHM::validParams ( )

static

Definition at line 18 of file Closures1PhaseTHM.C.

{
  InputParameters params = Closures1PhaseBase::validParams();

  MooseEnum wall_htc_closure("dittus_boelter=0 kazimi_carelli=1 lyon=2 mikityuk=3 schad=4 "
                             "weisman=5 wolf_mccarthy=6 gnielinski=7",
                             "dittus_boelter");
  params.addParam<MooseEnum>(
      "wall_htc_closure", wall_htc_closure, "Heat transfer coefficient closure");
  MooseEnum wall_ff_closure("cheng_todreas=0 churchill=1", "churchill");
  params.addParam<MooseEnum>("wall_ff_closure", wall_ff_closure, "Friction factor closure");
  params.addClassDescription("Closures for 1-phase flow channels");
  return params;
}

Member Data Documentation

_factory

Factory& ClosuresBase::_factory

protectedinherited

Factory associated with the MooseApp.

Definition at line 103 of file ClosuresBase.h.

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), addTemperatureWallFromHeatFluxMaterial(), addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), addWallHTCMaterial(), ClosuresBase::addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), ClosuresBase::addWeightedAverageMaterial(), and ClosuresBase::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

protectedinherited

Simulation.

Definition at line 100 of file ClosuresBase.h.

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

_wall_ff_closure

const WallFFClosureType Closures1PhaseTHM::_wall_ff_closure

protected

Wall friction factor closure.

Definition at line 77 of file Closures1PhaseTHM.h.

Referenced by addWallFFMaterial().

_wall_htc_closure

const WallHTCClosureType Closures1PhaseTHM::_wall_htc_closure

protected

Wall heat transfer coefficient closure.

Definition at line 74 of file Closures1PhaseTHM.h.

Referenced by addWallHTCMaterial().

---

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

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