ComponentBoundaryConditionInterface.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 "ActionComponent.h"
#include "InputParameters.h"
#include "MooseTypes.h"

class ComponentBoundaryConditionInterface : public virtual ActionComponent
{
public:
  static InputParameters validParams();

  ComponentBoundaryConditionInterface(const InputParameters & params);

  enum BoundaryConditionType
  {
    FIXED_VALUE,
    FLUX
  };

  bool hasBoundaryCondition(const VariableName & variable) const;
  bool hasBoundaryCondition(const VariableName & variable, const BoundaryName & boundary) const;
  std::vector<BoundaryName> getBoundaryConditionBoundaries(const VariableName & variable) const;
  MooseFunctorName getBoundaryCondition(const VariableName & variable,
                                        const BoundaryName & boundary,
                                        const std::string & requestor_name,
                                        BoundaryConditionType & bc_type) const;

protected:
  virtual void checkIntegrity() override { checkBoundaryConditionsAllRequested(); }

  const std::vector<VariableName> _fixed_value_bc_variables;
  const std::vector<VariableName> _flux_bc_variables;

  // TODO: make our custom string types hashable
  // This would let us return the boundary condition functor name by reference too

  std::map<std::string, std::map<std::string, std::string>> _fixed_value_bcs;
  std::map<std::string, std::map<std::string, std::string>> _flux_bcs;

  mutable std::set<std::pair<VariableName, BoundaryName>> _requested_bc_variables;

private:
  void checkBoundaryConditionsAllRequested() const;
};