HeatStructureInterface Class Reference

Interface class for heat structure components. More...

#include <HeatStructureInterface.h>

Inheritance diagram for HeatStructureInterface:

Public Member Functions
	HeatStructureInterface (GeometricalComponent *geometrical_component)
FunctionName	getInitialT () const
	Gets the initial temperature function name. More...
const GeometricalComponent &	getGeometricalComponent () const
	Gets the geometrical component inheriting from this interface. More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual bool	useCylindricalTransformation () const =0
	Use cylindrical transformation? More...
virtual std::shared_ptr< HeatConductionModel >	buildModel ()
	Builds the heat conduction model. More...
void	init ()
	Method to be called in the component's init() method. More...
void	check () const
	Method to be called in the component's check() method. More...
void	addVariables ()
	Method to be called in the component's addVariables() method. More...
void	addMooseObjects ()
	Method to be called in the component's addMooseObjects() method. More...

Protected Attributes
std::shared_ptr< HeatConductionModel >	_hc_model
	The heat conduction model used by this heat structure. More...

Private Attributes
GeometricalComponent &	_geometrical_component_hsi
	The geometrical component inheriting from this interface. More...

Detailed Description

Interface class for heat structure components.

Definition at line 20 of file HeatStructureInterface.h.

Constructor & Destructor Documentation

HeatStructureInterface()

HeatStructureInterface::HeatStructureInterface

(

GeometricalComponent *

geometrical_component

)

Definition at line 28 of file HeatStructureInterface.C.

  : _geometrical_component_hsi(*geometrical_component)
{
}

Member Function Documentation

addMooseObjects()

void HeatStructureInterface::addMooseObjects ( )

protected

Method to be called in the component's addMooseObjects() method.

Definition at line 72 of file HeatStructureInterface.C.

Referenced by HeatStructureBase::addMooseObjects(), and HeatStructureFromFile3D::addMooseObjects().

{
  if (useCylindricalTransformation())
    _hc_model->addHeatEquationRZ();
  else
    _hc_model->addHeatEquationXYZ();
}

addVariables()

void HeatStructureInterface::addVariables ( )

protected

Method to be called in the component's addVariables() method.

Definition at line 64 of file HeatStructureInterface.C.

Referenced by HeatStructureBase::addVariables(), and HeatStructureFromFile3D::addVariables().

{
  _hc_model->addVariables();
  if (_geometrical_component_hsi.isParamValid("initial_T"))
    _hc_model->addInitialConditions();
}

buildModel()

std::shared_ptr< HeatConductionModel > HeatStructureInterface::buildModel ( )

protectedvirtual

Builds the heat conduction model.

Definition at line 34 of file HeatStructureInterface.C.

Referenced by init().

{
  auto & factory = _geometrical_component_hsi.getMooseApp().getFactory();

  const std::string class_name = "HeatConductionModel";
  InputParameters params = factory.getValidParams(class_name);
  params.set<THMProblem *>("_thm_problem") = &_geometrical_component_hsi.getTHMProblem();
  params.set<HeatStructureInterface *>("_hs") = this;
  params.applyParameters(_geometrical_component_hsi.parameters());
  return factory.create<HeatConductionModel>(
      class_name, _geometrical_component_hsi.name(), params, 0);
}

check()

void HeatStructureInterface::check ( ) const

protected

Method to be called in the component's check() method.

Definition at line 54 of file HeatStructureInterface.C.

Referenced by HeatStructureFromFile3D::check(), and HeatStructureBase::check().

{
  auto & moose_app = _geometrical_component_hsi.getMooseApp();
  bool ics_set = _geometrical_component_hsi.getTHMProblem().hasInitialConditionsFromFile() ||
                 _geometrical_component_hsi.isParamValid("initial_T");
  if (!ics_set && !moose_app.isRestarting())
    _geometrical_component_hsi.logError("Missing initial condition for temperature.");
}

getGeometricalComponent()

const GeometricalComponent& HeatStructureInterface::getGeometricalComponent ( ) const

inline

Gets the geometrical component inheriting from this interface.

Definition at line 35 of file HeatStructureInterface.h.

Referenced by HSBoundaryExternalAppTemperature::addVariables(), HSBoundaryExternalAppConvection::addVariables(), and HSBoundaryExternalAppHeatFlux::addVariables().

  {
    return _geometrical_component_hsi;
  }

getInitialT()

FunctionName HeatStructureInterface::getInitialT

(

)

const

Gets the initial temperature function name.

Definition at line 81 of file HeatStructureInterface.C.

Referenced by HeatConductionModel::addInitialConditions(), HeatTransferFromHeatStructure3D1Phase::addVariables(), and HeatTransferFromHeatStructure1Phase::addVariables().

{
  if (_geometrical_component_hsi.isParamValid("initial_T"))
    return _geometrical_component_hsi.getParam<FunctionName>("initial_T");
  else
    _geometrical_component_hsi.mooseError(
        _geometrical_component_hsi.name(),
        ": The parameter 'initial_T' was requested but not supplied");
}

init()

void HeatStructureInterface::init ( )

protected

Method to be called in the component's init() method.

Definition at line 48 of file HeatStructureInterface.C.

Referenced by HeatStructureFromFile3D::init(), and HeatStructureBase::init().

{
  _hc_model = buildModel();
}

useCylindricalTransformation()

virtual bool HeatStructureInterface::useCylindricalTransformation ( ) const

protectedpure virtual

Use cylindrical transformation?

Implemented in HeatStructureCylindricalBase, HeatStructurePlate, and HeatStructureFromFile3D.

Referenced by addMooseObjects().

validParams()

InputParameters HeatStructureInterface::validParams ( )

static

Definition at line 15 of file HeatStructureInterface.C.

Referenced by HeatStructureFromFile3D::validParams(), and HeatStructureBase::validParams().

{
  InputParameters params = emptyInputParameters();

  params.addParam<FunctionName>("initial_T", "Initial temperature [K]");
  params.addParam<Real>(
      "scaling_factor_temperature", 1.0, "Scaling factor for solid temperature variable.");

  params.addPrivateParam<std::string>("component_type", "heat_struct");

  return params;
}

Member Data Documentation

_geometrical_component_hsi

GeometricalComponent& HeatStructureInterface::_geometrical_component_hsi

private

The geometrical component inheriting from this interface.

Definition at line 76 of file HeatStructureInterface.h.

Referenced by addVariables(), buildModel(), check(), getGeometricalComponent(), and getInitialT().

_hc_model

std::shared_ptr<HeatConductionModel> HeatStructureInterface::_hc_model

protected

The heat conduction model used by this heat structure.

Definition at line 72 of file HeatStructureInterface.h.

Referenced by HeatStructureBase::addMooseObjects(), addMooseObjects(), addVariables(), and init().

---

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

• thermal_hydraulics/include/interfaces/HeatStructureInterface.h
• thermal_hydraulics/src/interfaces/HeatStructureInterface.C