HeatConductionModel Class Reference

Provides functions to setup the heat conduction model. More...

#include <HeatConductionModel.h>

Inheritance diagram for HeatConductionModel:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	HeatConductionModel (const InputParameters &params)
virtual void	addVariables ()
	Add field variables used by this model. More...
virtual void	addInitialConditions ()
	Add initial conditions. More...
virtual void	addMaterials ()
	Add materials used by this model. More...
virtual void	addHeatEquationXYZ ()
	Add heat conduction equation for cartesian coordinate system. More...
virtual void	addHeatEquationRZ ()
	Add heat conduction equation for RZ coordinate system. More...
virtual bool	enabled () const
std::shared_ptr< MooseObject >	getSharedPtr ()
std::shared_ptr< const MooseObject >	getSharedPtr () const
MooseApp &	getMooseApp () const
const std::string &	type () const
virtual const std::string &	name () const
std::string	typeAndName () const
std::string	errorPrefix (const std::string &error_type) const
void	callMooseError (std::string msg, const bool with_prefix) const
MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
const InputParameters &	parameters () const
MooseObjectName	uniqueName () const
const T &	getParam (const std::string &name) const
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
const T *	queryParam (const std::string &name) const
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
bool	isParamValid (const std::string &name) const
bool	isParamSetByUser (const std::string &nm) const
void	paramError (const std::string &param, Args... args) const
void	paramWarning (const std::string &param, Args... args) const
void	paramInfo (const std::string &param, Args... args) const
void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
void	mooseError (Args &&... args) const
void	mooseErrorNonPrefixed (Args &&... args) const
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
void	mooseWarning (Args &&... args) const
void	mooseWarningNonPrefixed (Args &&... args) const
void	mooseDeprecated (Args &&... args) const
void	mooseInfo (Args &&... args) const
std::string	getDataFileName (const std::string &param) const
std::string	getDataFileNameByName (const std::string &relative_path) const
std::string	getDataFilePath (const std::string &relative_path) const
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const
std::string	genName (const std::string &prefix, unsigned int id, const std::string &suffix="") const
	Build a name from a prefix, number and possible suffix. More...
std::string	genName (const std::string &prefix, unsigned int i, unsigned int j, const std::string &suffix="") const
	Build a name from a prefix, 2 numbers and possible suffix. More...
std::string	genName (const std::string &prefix, const std::string &name, unsigned int i) const
	Build a name from 2 strings and a number. More...
std::string	genName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings. More...
std::string	genSafeName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings that is safe to use in input files (i.e. More...

Static Public Member Functions
static const libMesh::FEType &	feType ()
	Get the FE type used for heat conduction. More...
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static const std::string	DENSITY = "density"
static const std::string	TEMPERATURE = "T_solid"
static const std::string	THERMAL_CONDUCTIVITY = "thermal_conductivity"
static const std::string	SPECIFIC_HEAT_CONSTANT_PRESSURE = "specific_heat"

Protected Attributes
THMProblem &	_sim
Factory &	_factory
	The Factory associated with the MooseApp. More...
HeatStructureInterface &	_hs_interface
	The heat structure interface that built this class. More...
GeometricalComponent &	_geometrical_component
	The geometrical component that built this class. More...
const std::string	_comp_name
	Name of the component. More...
const bool &	_enabled
MooseApp &	_app
const std::string	_type
const std::string	_name
const InputParameters &	_pars
ActionFactory &	_action_factory
const Parallel::Communicator &	_communicator

Static Protected Attributes
static libMesh::FEType	_fe_type

Friends
class	Simulation

Detailed Description

Provides functions to setup the heat conduction model.

This is a proxy class for the MOOSE Modules' heat conduction model

Definition at line 27 of file HeatConductionModel.h.

Constructor & Destructor Documentation

HeatConductionModel()

HeatConductionModel::HeatConductionModel

(

const InputParameters &

params

)

Definition at line 41 of file HeatConductionModel.C.

  : MooseObject(params),
    _sim(*params.getCheckedPointerParam<THMProblem *>("_thm_problem")),
    _factory(_app.getFactory()),
    _hs_interface(*params.getCheckedPointerParam<HeatStructureInterface *>("_hs")),
    _geometrical_component(
        dynamic_cast<GeometricalComponent &>(_hs_interface)), // TODO: do something safer
    _comp_name(name())
{
}

Member Function Documentation

addHeatEquationRZ()

void HeatConductionModel::addHeatEquationRZ ( )

virtual

Add heat conduction equation for RZ coordinate system.

Definition at line 116 of file HeatConductionModel.C.

{
  HeatStructureCylindricalBase & hs_cyl =
      dynamic_cast<HeatStructureCylindricalBase &>(_geometrical_component);

  const auto & blocks = hs_cyl.getSubdomainNames();
  const auto & position = hs_cyl.getPosition();
  const auto & direction = hs_cyl.getDirection();

  // add transient term
  if (_geometrical_component.problemIsTransient())
  {
    std::string class_name = "ADHeatConductionTimeDerivativeRZ";
    InputParameters pars = _factory.getValidParams(class_name);
    pars.set<NonlinearVariableName>("variable") = TEMPERATURE;
    pars.set<std::vector<SubdomainName>>("block") = blocks;
    pars.set<MaterialPropertyName>("specific_heat") = SPECIFIC_HEAT_CONSTANT_PRESSURE;
    pars.set<MaterialPropertyName>("density_name") = DENSITY;
    pars.set<bool>("use_displaced_mesh") = false;
    pars.set<Point>("axis_point") = position;
    pars.set<RealVectorValue>("axis_dir") = direction;
    _sim.addKernel(class_name, genName(_comp_name, "td"), pars);
  }
  // add diffusion term
  {
    std::string class_name = "ADHeatConductionRZ";
    InputParameters pars = _factory.getValidParams(class_name);
    pars.set<NonlinearVariableName>("variable") = TEMPERATURE;
    pars.set<std::vector<SubdomainName>>("block") = blocks;
    pars.set<MaterialPropertyName>("thermal_conductivity") = THERMAL_CONDUCTIVITY;
    pars.set<bool>("use_displaced_mesh") = false;
    pars.set<Point>("axis_point") = position;
    pars.set<RealVectorValue>("axis_dir") = direction;
    _sim.addKernel(class_name, genName(_comp_name, "hc"), pars);
  }
}

addHeatEquationXYZ()

void HeatConductionModel::addHeatEquationXYZ ( )

virtual

Add heat conduction equation for cartesian coordinate system.

Definition at line 87 of file HeatConductionModel.C.

{
  const auto & blocks = _geometrical_component.getSubdomainNames();

  // add transient term
  if (_geometrical_component.problemIsTransient())
  {
    std::string class_name = "ADHeatConductionTimeDerivative";
    InputParameters pars = _factory.getValidParams(class_name);
    pars.set<NonlinearVariableName>("variable") = TEMPERATURE;
    pars.set<std::vector<SubdomainName>>("block") = blocks;
    pars.set<MaterialPropertyName>("specific_heat") = SPECIFIC_HEAT_CONSTANT_PRESSURE;
    pars.set<MaterialPropertyName>("density_name") = DENSITY;
    pars.set<bool>("use_displaced_mesh") = false;
    _sim.addKernel(class_name, genName(_comp_name, "td"), pars);
  }
  // add diffusion term
  {
    std::string class_name = "ADHeatConduction";
    InputParameters pars = _factory.getValidParams(class_name);
    pars.set<NonlinearVariableName>("variable") = TEMPERATURE;
    pars.set<std::vector<SubdomainName>>("block") = blocks;
    pars.set<MaterialPropertyName>("thermal_conductivity") = THERMAL_CONDUCTIVITY;
    pars.set<bool>("use_displaced_mesh") = false;
    _sim.addKernel(class_name, genName(_comp_name, "hc"), pars);
  }
}

addInitialConditions()

void HeatConductionModel::addInitialConditions ( )

virtual

Add initial conditions.

Definition at line 62 of file HeatConductionModel.C.

{
  const auto & subdomain_names = _geometrical_component.getSubdomainNames();
  _sim.addFunctionIC(TEMPERATURE, _hs_interface.getInitialT(), subdomain_names);
}

addMaterials()

void HeatConductionModel::addMaterials ( )

virtual

Add materials used by this model.

Definition at line 69 of file HeatConductionModel.C.

{
  const auto & blocks = _geometrical_component.getSubdomainNames();
  const auto & material_names =
      _geometrical_component.getParam<std::vector<std::string>>("materials");

  for (std::size_t i = 0; i < blocks.size(); i++)
  {
    std::string class_name = "ADSolidMaterial";
    InputParameters params = _factory.getValidParams(class_name);
    params.set<std::vector<SubdomainName>>("block") = {blocks[i]};
    params.set<std::vector<VariableName>>("T") = {TEMPERATURE};
    params.set<UserObjectName>("properties") = material_names[i];
    _sim.addMaterial(class_name, genName(blocks[i], "mat"), params);
  }
}

addVariables()

void HeatConductionModel::addVariables ( )

virtual

Add field variables used by this model.

Definition at line 53 of file HeatConductionModel.C.

{
  const auto & subdomain_names = _geometrical_component.getSubdomainNames();
  const Real & scaling_factor = getParam<Real>("scaling_factor_temperature");

  _sim.addSimVariable(true, TEMPERATURE, _fe_type, subdomain_names, scaling_factor);
}

feType()

static const libMesh::FEType& HeatConductionModel::feType ( )

inlinestatic

Get the FE type used for heat conduction.

Returns

The finite element type

Definition at line 61 of file HeatConductionModel.h.

Referenced by HSBoundaryExternalAppTemperature::addVariables(), HSBoundaryExternalAppConvection::addVariables(), HeatTransferFromHeatStructure1Phase::getFEType(), HeatTransferFromHeatStructure3D1Phase::getFEType(), Simulation::setupQuadrature(), and HeatStructureBase::usingSecondOrderMesh().

{ return _fe_type; }

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(), addHeatEquationRZ(), addHeatEquationXYZ(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), addMaterials(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), HSBoundarySpecifiedTemperature::addMooseObjects(), FormLossFromFunction1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), InletVelocityTemperature1Phase::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(), Closures1PhaseTHM::addTemperatureWallFromHeatFluxMaterial(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowChannelBase::addVariables(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), VolumeJunction1Phase::addVolumeJunctionIC(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::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().

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

validParams()

InputParameters HeatConductionModel::validParams ( )

static

Definition at line 21 of file HeatConductionModel.C.

{
  InputParameters params = MooseObject::validParams();
  params.addPrivateParam<THMProblem *>("_thm_problem");
  params.addPrivateParam<HeatStructureInterface *>("_hs");
  params.addRequiredParam<Real>("scaling_factor_temperature",
                                "Scaling factor for solid temperature variable.");
  params.registerBase("THM:heat_conduction_model");
  return params;
}

Friends And Related Function Documentation

Simulation

friend class Simulation

friend

Definition at line 87 of file HeatConductionModel.h.

Member Data Documentation

_comp_name

const std::string HeatConductionModel::_comp_name

protected

Name of the component.

Definition at line 72 of file HeatConductionModel.h.

Referenced by addHeatEquationRZ(), and addHeatEquationXYZ().

_factory

Factory& HeatConductionModel::_factory

protected

The Factory associated with the MooseApp.

Definition at line 66 of file HeatConductionModel.h.

Referenced by addHeatEquationRZ(), addHeatEquationXYZ(), and addMaterials().

_fe_type

FEType HeatConductionModel::_fe_type

staticprotected

Definition at line 85 of file HeatConductionModel.h.

Referenced by addVariables(), feType(), and Simulation::Simulation().

_geometrical_component

GeometricalComponent& HeatConductionModel::_geometrical_component

protected

The geometrical component that built this class.

Definition at line 70 of file HeatConductionModel.h.

Referenced by addHeatEquationRZ(), addHeatEquationXYZ(), addInitialConditions(), addMaterials(), and addVariables().

_hs_interface

HeatStructureInterface& HeatConductionModel::_hs_interface

protected

The heat structure interface that built this class.

Definition at line 68 of file HeatConductionModel.h.

Referenced by addInitialConditions().

_sim

THMProblem& HeatConductionModel::_sim

protected

Definition at line 64 of file HeatConductionModel.h.

Referenced by addHeatEquationRZ(), addHeatEquationXYZ(), addInitialConditions(), addMaterials(), and addVariables().

DENSITY

const std::string HeatConductionModel::DENSITY = "density"

static

Definition at line 76 of file HeatConductionModel.h.

Referenced by addHeatEquationRZ(), and addHeatEquationXYZ().

SPECIFIC_HEAT_CONSTANT_PRESSURE

const std::string HeatConductionModel::SPECIFIC_HEAT_CONSTANT_PRESSURE = "specific_heat"

static

Definition at line 79 of file HeatConductionModel.h.

Referenced by addHeatEquationRZ(), and addHeatEquationXYZ().

TEMPERATURE

const std::string HeatConductionModel::TEMPERATURE = "T_solid"

static

Definition at line 77 of file HeatConductionModel.h.

Referenced by HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), addHeatEquationRZ(), addHeatEquationXYZ(), addInitialConditions(), addMaterials(), HSBoundaryRadiation::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), addVariables(), and OneDHeatFluxBase::computeOffDiagJacobian().

THERMAL_CONDUCTIVITY

const std::string HeatConductionModel::THERMAL_CONDUCTIVITY = "thermal_conductivity"

static

Definition at line 78 of file HeatConductionModel.h.

Referenced by addHeatEquationRZ(), and addHeatEquationXYZ().

---

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

• thermal_hydraulics/include/base/HeatConductionModel.h
• thermal_hydraulics/src/base/HeatConductionModel.C