group_solution_handler.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#pragma once
 
#include <deal.II/distributed/solution_transfer.h>
#include <deal.II/lac/affine_constraints.h>
#include <deal.II/lac/la_parallel_block_vector.h>
#include <deal.II/lac/la_parallel_vector.h>
#include <deal.II/matrix_free/matrix_free.h>
 
#include <prismspf/core/constraint_manager.h>
#include <prismspf/core/dof_manager.h>
#include <prismspf/core/field_attributes.h>
#include <prismspf/core/solve_block.h>
#include <prismspf/core/type_enums.h>
#include <prismspf/core/types.h>
 
#include <prismspf/config.h>
 
#include <vector>
 
PRISMS_PF_BEGIN_NAMESPACE

template <typename number>
using BlockVector = dealii::LinearAlgebra::distributed::BlockVector<number>;

template <typename number>
using SolutionVector = typename BlockVector<number>::BlockType;

using dealii::MatrixFree;

template <unsigned int dim, typename number>
struct SolutionLevel
{
  BlockVector<number>              solutions;
  std::vector<BlockVector<number>> old_solutions;
};

template <unsigned int dim, typename number>
class GroupSolutionHandler
{
public:
#if DEAL_II_VERSION_MAJOR >= 9 && DEAL_II_VERSION_MINOR >= 7
  using SolutionTransfer = dealii::SolutionTransfer<dim, SolutionVector<number>>;
#else
  using SolutionTransfer =
    dealii::parallel::distributed::SolutionTransfer<dim, SolutionVector<number>>;
#endif

  GroupSolutionHandler(SolveBlock                                  _solve_block,
                       const std::vector<FieldAttributes>         &_attributes_list,
                       const std::vector<MatrixFree<dim, number>> &_matrix_free_levels);

  [[nodiscard]] BlockVector<number> &
  get_solution_full_vector(unsigned int relative_level = 0);

  [[nodiscard]] const BlockVector<number> &
  get_solution_full_vector(unsigned int relative_level = 0) const;

  [[nodiscard]] SolutionVector<number> &
  get_solution_vector(unsigned int global_index, unsigned int relative_level = 0);

  [[nodiscard]] const SolutionVector<number> &
  get_solution_vector(unsigned int global_index, unsigned int relative_level = 0) const;

  [[nodiscard]] BlockVector<number> &
  get_old_solution_full_vector(unsigned int age, unsigned int relative_level = 0);

  [[nodiscard]] const BlockVector<number> &
  get_old_solution_full_vector(unsigned int age, unsigned int relative_level = 0) const;

  [[nodiscard]] SolutionVector<number> &
  get_old_solution_vector(unsigned int age,
                          unsigned int global_index,
                          unsigned int relative_level = 0);

  [[nodiscard]] const SolutionVector<number> &
  get_old_solution_vector(unsigned int age,
                          unsigned int global_index,
                          unsigned int relative_level = 0) const;

  [[nodiscard]] SolutionLevel<dim, number> &
  get_solution_level(unsigned int relative_level = 0);

  [[nodiscard]] const SolutionLevel<dim, number> &
  get_solution_level(unsigned int relative_level = 0) const;

  const std::vector<MatrixFree<dim, number>> &
  get_matrix_free_levels() const;

  [[nodiscard]] unsigned int
  get_block_index(unsigned int global_index) const;

  [[nodiscard]] const SolveBlock &
  get_solve_block() const;

  [[nodiscard]] const std::vector<unsigned int> &
  get_global_to_block_index() const;

  [[nodiscard]] const std::vector<unsigned int> &
  get_block_to_global_index() const;

  void
  init(unsigned int num_old_saved);

  void
  reinit();

  void
  update_ghosts(unsigned int relative_level = 0) const;

  void
  zero_out_ghosts(unsigned int relative_level = 0) const;

  void
  apply_constraints(unsigned int relative_level = 0);

  void
  apply_constraints(BlockVector<number> &solution_vector,
                    unsigned int         relative_level = 0);

  void
  apply_constraints_to_all(unsigned int relative_level);

  void
  apply_initial_condition_for_old_fields();

  void
  update(unsigned int relative_level = 0);

  void
  init_solution_transfer();

  void
  prepare_for_solution_transfer();

  void
  execute_solution_transfer();

  void
  print_solution_full_vector(std::ostream &out, unsigned int relative_level = 0) const;
 
private:
  SolveBlock solve_block;

  std::vector<unsigned int> block_to_global_index;

  std::vector<unsigned int> global_to_block_index;

  std::vector<SolutionLevel<dim, number>> solution_levels;

  const std::vector<MatrixFree<dim, number>> *matrix_free_levels = nullptr;

  std::vector<SolutionTransfer> block_solution_transfer;
};
 
PRISMS_PF_END_NAMESPACE