https://mooseframework.inl.gov
Loading...
Searching...
No Matches
HSBoundaryInterface.h
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#pragma once
11
12#include "InputParameters.h"
13#include "HeatStructureBase.h"
14#include "LoggingInterface.h"
15
16class Component;
17
22{
23public:
25
26 HSBoundaryInterface(Component * component);
27
28 void check(const Component * const component) const;
29
30protected:
34 bool HSBoundaryIsValid(const Component * const component) const;
35
41 const BoundaryName & getHSBoundaryName(const Component * const component) const;
48 getHSExternalBoundaryType(const Component * const component) const;
49
51 const std::string & _hs_name;
52 // TODO: make the following parameters private after transition to use above APIs
57};
ExternalBoundaryType
External boundary type.
Definition Component2D.h:19
Base class for THM components.
Definition Component.h:32
Interface class for coupling to a heat structure boundary.
const std::string & _hs_name
Heat structure name.
const BoundaryName & getHSBoundaryName(const Component *const component) const
Gets the boundary name corresponding to the heat structure and side.
Component2D::ExternalBoundaryType _hs_side
Heat structure side.
static InputParameters validParams()
bool HSBoundaryIsValid(const Component *const component) const
Returns true if the specified heat structure boundary is valid.
bool _hs_side_valid
True if the heat structure side enum is valid.
Component2D::ExternalBoundaryType getHSExternalBoundaryType(const Component *const component) const
Gets the external boundary type for the coupled heat structure boundary.
void check(const Component *const component) const