parabolic_module.h

Go to the documentation of this file.

//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// Copyright (C) 2023 - 2024 by the ryujin authors
//
 
#pragma once
 
#include <compile_time_options.h>
 
#include "convenience_macros.h"
#include "hyperbolic_module.h"
#include "initial_values.h"
#include "mpi_ensemble.h"
#include "offline_data.h"
 
#include <deal.II/base/parameter_acceptor.h>
#include <deal.II/base/timer.h>
#include <deal.II/lac/sparse_matrix.templates.h>
#include <deal.II/lac/vector.h>
 
#include <functional>
 
namespace ryujin
{
  template <typename Description, int dim, typename Number = double>
  class ParabolicModule final : public dealii::ParameterAcceptor
  {
  public:
 
    using HyperbolicSystem = typename Description::HyperbolicSystem;
 
    using View =
        typename Description::template HyperbolicSystemView<dim, Number>;
 
    using ParabolicSystem = typename Description::ParabolicSystem;
 
    using ParabolicSolver =
        typename Description::template ParabolicSolver<dim, Number>;
 
    using StateVector = typename View::StateVector;
 
 
 
    ParabolicModule(
        const MPIEnsemble &mpi_ensemble,
        std::map<std::string, dealii::Timer> &computing_timer,
        const OfflineData<dim, Number> &offline_data,
        const HyperbolicSystem &hyperbolic_system,
        const ParabolicSystem &parabolic_system,
        const InitialValues<Description, dim, Number> &initial_values,
        const std::string &subsection = "/ParabolicModule");
 
    void prepare();
 
 
 
    void prepare_state_vector(StateVector &state_vector, Number t) const;
 
    template <int stages>
    void
    backward_euler_step(const StateVector &old_state_vector,
                        const Number old_t,
                        std::array<std::reference_wrapper<const StateVector>,
                                   stages> stage_state_vectors,
                        const std::array<Number, stages> stage_weights,
                        StateVector &new_state_vector,
                        Number tau) const;
 
    void crank_nicolson_step(const StateVector &old_state_vector,
                             const Number old_t,
                             StateVector &new_state_vector,
                             Number tau) const;
 
    void print_solver_statistics(std::ostream &output) const;
 
 
    ACCESSOR_READ_ONLY(n_restarts)
 
 
    
    ACCESSOR_READ_ONLY(n_corrections)
 
    ACCESSOR_READ_ONLY(n_warnings)
 
    // FIXME: refactor to function
    mutable IDViolationStrategy id_violation_strategy_;
 
  private:
 
 
    // FIXME: refactor contents into this class.
    ParabolicSolver parabolic_solver_;
    mutable unsigned int cycle_;
 
    mutable unsigned int n_restarts_;
    mutable unsigned int n_corrections_;
    mutable unsigned int n_warnings_;
 
  };
 
} /* namespace ryujin */