PhysicsComponentInterface.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 "PhysicsBase.h"
#include "MooseTypes.h"
#include "ComponentBoundaryConditionInterface.h"

class PhysicsComponentInterface : virtual public PhysicsBase
{
public:
  static InputParameters validParams();

  PhysicsComponentInterface(const InputParameters & parameters);

  virtual void addComponent(const ActionComponent & component) override;

  void addInitialCondition(const ComponentName & component_name,
                           const VariableName & var_name,
                           const MooseFunctorName & ic_value);

  void
  addBoundaryCondition(const ComponentName & component_name,
                       const VariableName & var_name,
                       const BoundaryName & boundary_name,
                       const MooseFunctorName & bc_value,
                       const ComponentBoundaryConditionInterface::BoundaryConditionType & bc_type);

protected:
  // TODO: add hash constructor to ComponentName to be able to use it as a key
  std::map<std::string, std::map<VariableName, MooseFunctorName>> _components_initial_conditions;
  std::map<std::string,
           std::map<std::pair<VariableName, BoundaryName>,
                    std::pair<MooseFunctorName,
                              ComponentBoundaryConditionInterface::BoundaryConditionType>>>
      _components_boundary_conditions;

private:
  virtual void actOnAdditionalTasks() override;

  // The default implementation of these routines will error if the Components have passed
  // information to the Physics, and the Physics has not implemented the expected behavior
  virtual void addInitialConditionsFromComponents();
  virtual void addBoundaryConditionsFromComponents();
};