quantities.h

Go to the documentation of this file.

//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// Copyright (C) 2020 - 2025 by the ryujin authors
//
 
#pragma once
 
#include <compile_time_options.h>
 
#include "mpi_ensemble.h"
#include "observer_pointer.h"
#include "offline_data.h"
 
#include <deal.II/base/parameter_acceptor.h>
#include <deal.II/base/timer.h>
#include <deal.II/lac/la_parallel_block_vector.h>
#include <deal.II/lac/sparse_matrix.templates.h>
#include <deal.II/lac/vector.h>
 
#include <optional>
 
namespace ryujin
{
  template <typename Description, int dim, typename Number = double>
  class Quantities final : public dealii::ParameterAcceptor
  {
  public:
 
    using HyperbolicSystem = typename Description::HyperbolicSystem;
    using ParabolicSystem = typename Description::ParabolicSystem;
 
    using View = typename HyperbolicSystem::template View<dim, Number>;
 
    using state_type = typename View::state_type;
 
    using StateVector = typename View::StateVector;
 
 
 
    Quantities(const MPIEnsemble &mpi_ensemble,
               const OfflineData<dim, Number> &offline_data,
               const HyperbolicSystem &hyperbolic_system,
               const ParabolicSystem &parabolic_system,
               const std::string &subsection = "/Quantities");
 
    void prepare(const std::string &name);
 
 
 
    void accumulate(const StateVector &state_vector, const Number t);
 
    void write_out(const StateVector &state_vector,
                   const Number t,
                   unsigned int cycle);
 
  private:
 
 
    using boundary_point =
        std::tuple<dealii::types::global_dof_index /*local dof index*/,
                   dealii::Tensor<1, dim, Number> /*normal*/,
                   Number /*normal mass*/,
                   Number /*boundary mass*/,
                   dealii::types::boundary_id /*id*/,
                   dealii::Point<dim>> /*position*/;
 
    using boundary_value =
        std::tuple<state_type /* primitive state */,
                   state_type /* primitive state second moment */>;
 
    using boundary_statistic =
        std::tuple<std::vector<boundary_value> /* values old */,
                   std::vector<boundary_value> /* values new */,
                   std::vector<boundary_value> /* values sum */,
                   Number /* t old */,
                   Number /* t new */,
                   Number /* t sum */>;
 
    using interior_point =
        std::tuple<dealii::types::global_dof_index /*local dof index*/,
                   Number /*mass*/,
                   dealii::Point<dim>> /*position*/;
 
    using interior_value =
        std::tuple<state_type /* primitive state */,
                   state_type /* primitive state second moment */>;
 
    using interior_statistic =
        std::tuple<std::vector<interior_value> /* values old */,
                   std::vector<interior_value> /* values new */,
                   std::vector<interior_value> /* values sum */,
                   Number /* t old */,
                   Number /* t new */,
                   Number /* t sum */>;
 
 
 
    std::vector<std::tuple<std::string, std::string, std::string>>
        interior_manifolds_;
 
    std::vector<std::tuple<std::string, std::string, std::string>>
        boundary_manifolds_;
 
    bool clear_temporal_statistics_on_writeout_;
 
 
 
    const MPIEnsemble &mpi_ensemble_;
 
    dealii::ObserverPointer<const OfflineData<dim, Number>> offline_data_;
    dealii::ObserverPointer<const HyperbolicSystem> hyperbolic_system_;
    dealii::ObserverPointer<const ParabolicSystem> parabolic_system_;
 
    std::map<std::string, std::vector<boundary_point>> boundary_maps_;
 
    std::map<std::string, boundary_statistic> boundary_statistics_;
    std::map<std::string, std::vector<std::tuple<Number, boundary_value>>>
        boundary_time_series_;
 
    std::map<std::string, std::vector<interior_point>> interior_maps_;
 
    std::map<std::string, interior_statistic> interior_statistics_;
    std::map<std::string, std::vector<std::tuple<Number, interior_value>>>
        interior_time_series_;
 
    std::string base_name_;
    std::string header_;
    bool first_cycle_;
    std::optional<unsigned int> time_series_cycle_;
    bool mesh_files_have_been_written_;
 
 
 
    void write_mesh_files(unsigned int cycle);
 
    void clear_statistics();
 
    template <typename point_type, typename value_type>
    value_type internal_accumulate(const StateVector &state_vector,
                                   const std::vector<point_type> &interior_map,
                                   std::vector<value_type> &new_val);
 
    template <typename value_type>
    void internal_write_out(const std::string &file_name,
                            const std::string &time_stamp,
                            const std::vector<value_type> &values,
                            const Number scale);
 
    template <typename value_type>
    void internal_write_out_time_series(
        const std::string &file_name,
        const std::vector<std::tuple<Number, value_type>> &values,
        bool append);
 
  };
 
} /* namespace ryujin */