read_field_base.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/exceptions.h>
#include <deal.II/base/point.h>
#include <deal.II/lac/vector.h>
 
#include <prismspf/core/types.h>
 
#include <prismspf/user_inputs/spatial_discretization.h>
 
#include <prismspf/utilities/utilities.h>
 
#include <filesystem>
 
PRISMS_PF_BEGIN_NAMESPACE
 
template <unsigned int dim, typename number>
class ReadFieldBase
{
public:
  ReadFieldBase(const InitialConditionFile       &_ic_file,
                const SpatialDiscretization<dim> &_spatial_discretization);

  virtual ~ReadFieldBase() = default;

  ReadFieldBase(const ReadFieldBase &read_base) = delete;

  ReadFieldBase &
  operator=(const ReadFieldBase &read_base) = delete;

  ReadFieldBase(ReadFieldBase &&read_base) noexcept = delete;

  ReadFieldBase &
  operator=(ReadFieldBase &&read_base) noexcept = delete;

  virtual void
  print_file() = 0;

  virtual number
  get_scalar_value(const dealii::Point<dim> &point, const std::string &scalar_name) = 0;

  virtual dealii::Vector<number>
  get_vector_value(const dealii::Point<dim> &point, const std::string &vector_name) = 0;
 
protected:
  // info for file/discretization passed by dependency injection, class is non-copyable
  const SpatialDiscretization<dim> &spatial_discretization;

  const InitialConditionFile &ic_file;
};
 
template <unsigned int dim, typename number>
ReadFieldBase<dim, number>::ReadFieldBase(
  const InitialConditionFile       &_ic_file,
  const SpatialDiscretization<dim> &_spatial_discretization)
  : spatial_discretization(_spatial_discretization)
  , ic_file(_ic_file)
{
  // Check that the filename exists
  if (!std::filesystem::exists(this->ic_file.file_name))
    {
      AssertThrow(false,
                  dealii::ExcMessage("File " + this->ic_file.file_name +
                                     " does not exist"));
    }
}
 
PRISMS_PF_END_NAMESPACE