indicator.h

Go to the documentation of this file.

//
// SPDX-License-Identifier: Apache-2.0
// [LANL Copyright Statement]
// Copyright (C) 2023 - 2026 by the ryujin authors
// Copyright (C) 2023 - 2024 by Triad National Security, LLC
//
 
#pragma once
 
#include <ryujin/base/compile_time_options.h>
#include <ryujin/base/gpu.h>
#include <ryujin/base/observer_pointer.h>
#include <ryujin/base/simd.h>
#include <ryujin/linear_algebra/multicomponent_vector.h>
#include <ryujin/shallow_water/hyperbolic_system.h>
 
#include <deal.II/base/parameter_acceptor.h>
#include <deal.II/base/vectorization.h>
 
namespace ryujin
{
  namespace ShallowWater
  {
    template <int dim,
              typename Number = double,
              typename MemorySpace = dealii::MemorySpace::Host>
    class IndicatorView;
 
    template <typename ScalarNumber = double>
    class Indicator : public dealii::ParameterAcceptor
    {
    public:
 
      struct Parameters {
        double evc_factor;
      };
 
 
 
      Indicator(const HyperbolicSystem &hyperbolic_system,
                const std::string &subsection = "/Indicator")
          : ParameterAcceptor(subsection)
          , parameters_("shallow_water_indicator_parameters",
                        TransferPolicy::implicit_transfers_host_resident)
          , hyperbolic_system_(&hyperbolic_system)
      {
        /* reference remains valid due to implicit_transfers_host_resident */
        auto &parameters = *parameters_.view();
 
        parameters.evc_factor = 1.;
        add_parameter("evc factor",
                      parameters.evc_factor,
                      "Factor for scaling the entropy viscocity commuator");
 
        /* invalidates view on default memory space */
        ParameterAcceptor::parse_parameters_call_back.connect(
            [this] { parameters_.view(); });
      }
 
      template <int dim,
                typename Number,
                typename MemorySpace = dealii::MemorySpace::Host>
      auto view() const
      {
        return IndicatorView<dim, Number, MemorySpace>{
            hyperbolic_system_->template view<dim, Number, MemorySpace>(),
            *this};
      }
 
    private:
 
 
      Mirrored<Parameters> parameters_;
 
 
 
      dealii::ObserverPointer<const HyperbolicSystem> hyperbolic_system_;
 
      template <int, typename, typename>
      friend class IndicatorView;
 
    };
 
 
    template <int dim, typename Number, typename MemorySpace>
    class IndicatorView
    {
    public:
      static_assert(
          std::is_same_v<MemorySpace, dealii::MemorySpace::Host> ||
              std::is_same_v<MemorySpace, dealii::MemorySpace::Default>,
          "Unexpected memory space");
 
 
      using View = HyperbolicSystemView<dim, Number, MemorySpace>;
 
      using ScalarNumber = typename View::ScalarNumber;
 
      static constexpr auto problem_dimension = View::problem_dimension;
 
      using state_type = typename View::state_type;
 
      using flux_contribution_type = typename View::flux_contribution_type;
 
      using flux_type = typename View::flux_type;
 
      using precomputed_type = typename View::precomputed_type;
 
      using PrecomputedVectorView = typename View::PrecomputedVectorView;
 
 
 
      IndicatorView(const View &view, const Indicator<ScalarNumber> &indicator)
          : view_(view)
          , parameters_(indicator.parameters_.template view<MemorySpace>())
      {
      }
 
      DEAL_II_HOST_DEVICE_ALWAYS_INLINE ScalarNumber evc_factor() const
      {
        return ScalarNumber(parameters_->evc_factor);
      }
 
      DEAL_II_HOST_DEVICE void reset(const PrecomputedVectorView &pv,
                                     const unsigned int i,
                                     const state_type &U_i,
                                     const flux_contribution_type &flux_i);
 
      DEAL_II_HOST_DEVICE void
      accumulate(const PrecomputedVectorView &pv,
                 const unsigned int *js,
                 const state_type &U_j,
                 const flux_contribution_type &flux_j,
                 const dealii::Tensor<1, dim, Number> &c_ij);
 
      DEAL_II_HOST_DEVICE Number alpha(const Number h_i) const;
 
 
    private:
 
 
      const View view_;
      const Indicator<ScalarNumber>::Parameters *const parameters_;
 
      Number h_i_ = 0.;
      Number eta_i_ = 0.;
      flux_type f_i_;
      state_type d_eta_i_;
      Number pressure_i_ = 0.;
 
      Number left_ = 0.;
      state_type right_;
    };
 
 
    /*
     * -------------------------------------------------------------------------
     * Inline definitions
     * -------------------------------------------------------------------------
     */
 
 
    template <int dim, typename Number, typename MemorySpace>
    DEAL_II_HOST_DEVICE_ALWAYS_INLINE void
    IndicatorView<dim, Number, MemorySpace>::reset(
        const PrecomputedVectorView &pv,
        const unsigned int i,
        const state_type &U_i,
        const flux_contribution_type & /*flux_i*/)
    {
      /* entropy viscosity commutator: */
 
      const auto &[eta_m, h_star, factor] =
          pv.template read_tensor<Number, precomputed_type>(i);
 
      h_i_ = view_.water_depth(U_i);
      eta_i_ = eta_m;
      d_eta_i_ = view_.mathematical_entropy_derivative(U_i);
      f_i_ = view_.f(U_i);
      pressure_i_ = view_.pressure(U_i);
 
      left_ = 0.;
      right_ = 0.;
    }
 
 
    template <int dim, typename Number, typename MemorySpace>
    DEAL_II_HOST_DEVICE_ALWAYS_INLINE void
    IndicatorView<dim, Number, MemorySpace>::accumulate(
        const PrecomputedVectorView &pv,
        const unsigned int *js,
        const state_type &U_j,
        const flux_contribution_type & /*flux_j*/,
        const dealii::Tensor<1, dim, Number> &c_ij)
    {
      /* entropy viscosity commutator: */
 
      const auto &[eta_j, h_star_j, factor_j] =
          pv.template read_tensor<Number, precomputed_type>(js);
 
      const auto velocity_j =
          view_.momentum(U_j) * view_.inverse_water_depth_sharp(U_j);
      const auto f_j = view_.f(U_j);
      const auto pressure_j = view_.pressure(U_j);
 
      left_ += (eta_j + pressure_j) * (velocity_j * c_ij);
 
      for (unsigned int k = 0; k < problem_dimension; ++k)
        right_[k] += (f_j[k] - f_i_[k]) * c_ij;
    }
 
 
    template <int dim, typename Number, typename MemorySpace>
    DEAL_II_HOST_DEVICE_ALWAYS_INLINE Number
    IndicatorView<dim, Number, MemorySpace>::alpha(const Number hd_i) const
    {
      Number my_sum = 0.;
      for (unsigned int k = 0; k < problem_dimension; ++k) {
        my_sum += d_eta_i_[k] * right_[k];
      }
 
      Number numerator = std::abs(left_ - my_sum);
      Number denominator = std::abs(left_) + std::abs(my_sum);
 
      const auto regularization =
          Number(100. * std::numeric_limits<ScalarNumber>::min());
 
      const auto quotient =
          std::abs(numerator) /
          (denominator + std::max(hd_i * std::abs(eta_i_), regularization));
 
      return std::min(Number(1.), evc_factor() * quotient);
    }
  } // namespace ShallowWater
} // namespace ryujin