indicator.h

Go to the documentation of this file.

//
// SPDX-License-Identifier: Apache-2.0
// [LANL Copyright Statement]
// Copyright (C) 2023 - 2024 by the ryujin authors
// Copyright (C) 2023 - 2024 by Triad National Security, LLC
//
 
#pragma once
 
#include "hyperbolic_system.h"
 
#include <multicomponent_vector.h>
 
#include <deal.II/base/parameter_acceptor.h>
#include <deal.II/base/vectorization.h>
 
 
namespace ryujin
{
  namespace ShallowWater
  {
    template <typename ScalarNumber = double>
    class IndicatorParameters : public dealii::ParameterAcceptor
    {
    public:
      IndicatorParameters(const std::string &subsection = "/Indicator")
          : ParameterAcceptor(subsection)
      {
        evc_factor_ = ScalarNumber(1.);
        add_parameter("evc factor",
                      evc_factor_,
                      "Factor for scaling the entropy viscocity commuator");
      }
 
      ACCESSOR_READ_ONLY(evc_factor);
 
    private:
      ScalarNumber evc_factor_;
    };
 
 
    template <int dim, typename Number = double>
    class Indicator
    {
    public:
 
      using View = HyperbolicSystemView<dim, Number>;
 
      using ScalarNumber = typename View::ScalarNumber;
 
      static constexpr auto problem_dimension = View::problem_dimension;
 
      using state_type = typename View::state_type;
 
      using flux_type = typename View::flux_type;
 
      using precomputed_type = typename View::precomputed_type;
 
      using PrecomputedVector = typename View::PrecomputedVector;
 
      using Parameters = IndicatorParameters<ScalarNumber>;
 
 
 
      Indicator(const HyperbolicSystem &hyperbolic_system,
                const Parameters &parameters,
                const PrecomputedVector &precomputed_values)
          : hyperbolic_system(hyperbolic_system)
          , parameters(parameters)
          , precomputed_values(precomputed_values)
      {
      }
 
      void reset(const unsigned int /*i*/, const state_type &U_i);
 
      void accumulate(const unsigned int *js,
                      const state_type &U_j,
                      const dealii::Tensor<1, dim, Number> &c_ij);
 
      Number alpha(const Number h_i);
 
 
    private:
 
      const HyperbolicSystem &hyperbolic_system;
      const Parameters &parameters;
      const PrecomputedVector &precomputed_values;
 
      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>
    DEAL_II_ALWAYS_INLINE inline void
    Indicator<dim, Number>::reset(const unsigned int i, const state_type &U_i)
    {
      /* entropy viscosity commutator: */
 
      const auto view = hyperbolic_system.view<dim, Number>();
 
      const auto &[eta_m, h_star] =
          precomputed_values.template get_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>
    DEAL_II_ALWAYS_INLINE inline void Indicator<dim, Number>::accumulate(
        const unsigned int *js,
        const state_type &U_j,
        const dealii::Tensor<1, dim, Number> &c_ij)
    {
      /* entropy viscosity commutator: */
 
      const auto view = hyperbolic_system.view<dim, Number>();
 
      const auto &[eta_j, h_star_j] =
          precomputed_values.template get_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>
    DEAL_II_ALWAYS_INLINE inline Number
    Indicator<dim, Number>::alpha(const Number hd_i)
    {
      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.), parameters.evc_factor() * quotient);
    }
 
 
  } // namespace ShallowWater
} // namespace ryujin