HSBoundaryInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "InputParameters.h"
#include "HeatStructureBase.h"
#include "LoggingInterface.h"

class Component;

class HSBoundaryInterface
{
public:
  static InputParameters validParams();

  HSBoundaryInterface(Component * component);

  void check(const Component * const component) const;

protected:
  bool HSBoundaryIsValid(const Component * const component) const;

  const BoundaryName & getHSBoundaryName(const Component * const component) const;
  Component2D::ExternalBoundaryType
  getHSExternalBoundaryType(const Component * const component) const;

  const std::string & _hs_name;
  // TODO: make the following parameters private after transition to use above APIs
  Component2D::ExternalBoundaryType _hs_side;
  bool _hs_side_valid;
};