initial_conditions.h

// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#ifndef initial_conditions_h
#define initial_conditions_h
 
#include <deal.II/base/function.h>
#include <deal.II/base/point.h>
#include <deal.II/lac/vector.h>
 
#include <prismspf/config.h>
#include <prismspf/core/type_enums.h>
#include <prismspf/user_inputs/user_input_parameters.h>
 
PRISMS_PF_BEGIN_NAMESPACE
 
template <int dim>
class customInitialCondition;
 
template <int dim>
class initialCondition : public dealii::Function<dim, double>
{
public:
  initialCondition(const unsigned int             &_index,
                   const fieldType                &field_type,
                   const userInputParameters<dim> &_user_inputs);
 
  void
  vector_value(const dealii::Point<dim> &p, dealii::Vector<double> &value) const override;
 
private:
  const unsigned int index;
 
  const userInputParameters<dim> *user_inputs;
 
  customInitialCondition<dim> custom_initial_condition;
};
class initialCondition : public dealii::Function<dim, double> {…};
 
template <int dim>
initialCondition<dim>::initialCondition(const unsigned int             &_index,
                                        const fieldType                &field_type,
                                        const userInputParameters<dim> &_user_inputs)
  : dealii::Function<dim>((field_type == fieldType::VECTOR) ? dim : 1)
  , index(_index)
  , user_inputs(&_user_inputs)
{}
initialCondition<dim>::initialCondition(const unsigned int             &_index, {…}
 
template <int dim>
inline void
initialCondition<dim>::vector_value(const dealii::Point<dim> &p,
                                    dealii::Vector<double>   &value) const
{
  // Initialize passed variables to zero
  dealii::Vector<double> vector_value(dim);
 
  // Pass variables to user-facing function to evaluate
  for (unsigned int i = 0; i < dim; i++)
    {
      custom_initial_condition.set_initial_condition(index,
                                                     i,
                                                     p,
                                                     vector_value(0),
                                                     vector_value(i),
                                                     *user_inputs);
    }
 
  value = vector_value;
}
initialCondition<dim>::vector_value(const dealii::Point<dim> &p, {…}
 
template <int dim>
class customInitialCondition
{
public:
  customInitialCondition() = default;
 
  void
  set_initial_condition(const unsigned int             &index,
                        const unsigned int             &component,
                        const dealii::Point<dim>       &point,
                        double                         &scalar_value,
                        double                         &vector_component_value,
                        const userInputParameters<dim> &user_inputs) const;
};
class customInitialCondition {…};
 
PRISMS_PF_END_NAMESPACE
 
#endif