constraint_parameters.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2026 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#pragma once
 
#include <deal.II/base/parameter_handler.h>
#include <deal.II/base/point.h>
#include <deal.II/base/tensor.h>
#include <deal.II/base/types.h>
#include <deal.II/base/utilities.h>
 
#include <boost/algorithm/string/predicate.hpp>
 
#include <prismspf/core/conditional_ostreams.h>
#include <prismspf/core/exceptions.h>
#include <prismspf/core/type_enums.h>
#include <prismspf/core/types.h>
 
#include <prismspf/user_inputs/parameter_base.h>
 
#include <prismspf/config.h>
 
#include <map>
#include <string>
 
PRISMS_PF_BEGIN_NAMESPACE

enum Condition
{
  Natural,
  Dirichlet,
  Neumann,
  Periodic,
};

[[nodiscard]] inline Condition
condition_from_string(const std::string &boundary_string)
{
  if (boundary_string == "Natural")
    {
      return Condition::Natural;
    }
  if (boundary_string == "Dirichlet")
    {
      return Condition::Dirichlet;
    }
  if (boundary_string == "Neumann")
    {
      return Condition::Neumann;
    }
  if (boundary_string == "Periodic")
    {
      return Condition::Periodic;
    }
  AssertThrow(false, dealii::ExcMessage("Invalid boundary condition " + boundary_string));
  return Condition::Natural;
}

using ComponentConditions = std::map<unsigned int, Condition>;
 
struct BoundaryConditionSet
{
  std::map<unsigned int, ComponentConditions> component_constraints;
 
  bool time_dependent = false;
};

struct BoundaryParameters
{
  static void
  declare(dealii::ParameterHandler &parameter_handler,
          unsigned int              n_subsections = Numbers::default_subsections);

  template <unsigned int dim = 3>
  void
  assign(dealii::ParameterHandler &parameter_handler,
         unsigned int              n_subsections = Numbers::default_subsections);

  void
  validate(const std::vector<FieldAttributes> &field_attributes,
           const std::vector<SolveBlock>      &solve_blocks) const;
 
  // Map of boundary conditions. The first key is the field name.
  std::unordered_map<std::string, BoundaryConditionSet> boundary_condition_list;
};
 
PRISMS_PF_END_NAMESPACE