HSBoundaryInterface Class Reference

Interface class for coupling to a heat structure boundary. More...

#include <HSBoundaryInterface.h>

Inheritance diagram for HSBoundaryInterface:

Public Member Functions
	HSBoundaryInterface (Component *component)
void	check (const Component *const component) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
const BoundaryName &	getHSBoundaryName (const Component *const component) const
	Gets the boundary name corresponding to the heat structure and side. More...

Protected Attributes
const std::string &	_hs_name
	Heat structure name. More...
const MooseEnum &	_hs_side_enum
	Heat structure side enum. More...
const Component2D::ExternalBoundaryType	_hs_side
	Heat structure side. More...
const bool	_hs_side_valid
	True if valid heat structure side was provided. More...

Detailed Description

Interface class for coupling to a heat structure boundary.

Definition at line 21 of file HSBoundaryInterface.h.

Constructor & Destructor Documentation

HSBoundaryInterface()

HSBoundaryInterface::HSBoundaryInterface

(

Component *

component

)

Definition at line 26 of file HSBoundaryInterface.C.

  : _hs_name(component->getParam<std::string>("hs")),
    _hs_side_enum(component->getParam<MooseEnum>("hs_side")),
    _hs_side(component->getEnumParam<Component2D::ExternalBoundaryType>("hs_side")),
    _hs_side_valid(static_cast<int>(_hs_side) >= 0)
{
  component->addDependency(_hs_name);
}

Member Function Documentation

check()

void HSBoundaryInterface::check

(

const Component *const

component

)

const

Definition at line 36 of file HSBoundaryInterface.C.

Referenced by HeatTransferFromHeatStructure1Phase::check().

{
  component->checkComponentOfTypeExistsByName<HeatStructureBase>(_hs_name);

  if (component->hasComponentByName<HeatStructureBase>(_hs_name))
  {
    const HeatStructureBase & hs = component->getComponentByName<HeatStructureBase>(_hs_name);

    if (_hs_side_valid)
    {
      const Real & P_hs = hs.getUnitPerimeter(_hs_side);
      if (MooseUtils::absoluteFuzzyEqual(P_hs, 0.))
        component->logError("'hs_side' parameter is set to '",
                            _hs_side_enum,
                            "', but this side of the heat structure '",
                            _hs_name,
                            "' has radius of zero.");

      if (std::isnan(P_hs))
        component->logError("Invalid side '",
                            _hs_side_enum,
                            "'. This side does not have unit perimeter. You probably want to use "
                            "'INNER' or 'OUTER' side instead.");
    }
  }
}

getHSBoundaryName()

const BoundaryName & HSBoundaryInterface::getHSBoundaryName ( const Component *const  component ) const

protected

Gets the boundary name corresponding to the heat structure and side.

Parameters

[in]

component

Component pointer

Definition at line 64 of file HSBoundaryInterface.C.

Referenced by HeatTransferFromHeatStructure1Phase::getHeatStructureSideName().

{
  const HeatStructureBase & hs = component->getComponentByName<HeatStructureBase>(_hs_name);
  return hs.getExternalBoundaryName(_hs_side);
}

validParams()

InputParameters HSBoundaryInterface::validParams ( )

static

Definition at line 15 of file HSBoundaryInterface.C.

Referenced by HeatTransferFromHeatStructure1Phase::validParams().

{
  InputParameters params = emptyInputParameters();

  params.addRequiredParam<std::string>("hs", "Heat structure name");
  params.addRequiredParam<MooseEnum>(
      "hs_side", Component2D::getExternalBoundaryTypeMooseEnum(), "Heat structure side");

  return params;
}

Member Data Documentation

_hs_name

const std::string& HSBoundaryInterface::_hs_name

protected

Heat structure name.

Definition at line 37 of file HSBoundaryInterface.h.

Referenced by HeatTransferFromHeatStructure1Phase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addVariables(), check(), HeatTransferFromHeatStructure1Phase::check(), getHSBoundaryName(), HSBoundaryInterface(), and HeatTransferFromHeatStructure1Phase::setupMesh().

_hs_side

const Component2D::ExternalBoundaryType HSBoundaryInterface::_hs_side

protected

Heat structure side.

Definition at line 41 of file HSBoundaryInterface.h.

Referenced by HeatTransferFromHeatStructure1Phase::addMooseObjects(), check(), getHSBoundaryName(), and HeatTransferFromHeatStructure1Phase::setupMesh().

_hs_side_enum

const MooseEnum& HSBoundaryInterface::_hs_side_enum

protected

Heat structure side enum.

Definition at line 39 of file HSBoundaryInterface.h.

Referenced by check().

_hs_side_valid

const bool HSBoundaryInterface::_hs_side_valid

protected

True if valid heat structure side was provided.

Definition at line 43 of file HSBoundaryInterface.h.

Referenced by check(), HeatTransferFromHeatStructure1Phase::check(), and HeatTransferFromHeatStructure1Phase::setupMesh().

---

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

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