limiter.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 <compile_time_options.h>
#include <multicomponent_vector.h>
#include <newton.h>
 
namespace ryujin
{
  namespace ShallowWater
  {
    template <typename ScalarNumber = double>
    class LimiterParameters : public dealii::ParameterAcceptor
    {
    public:
      LimiterParameters(const std::string &subsection = "/Limiter")
          : ParameterAcceptor(subsection)
      {
        iterations_ = 2;
        add_parameter(
            "iterations", iterations_, "Number of limiter iterations");
 
        if constexpr (std::is_same<ScalarNumber, double>::value)
          newton_tolerance_ = 1.e-10;
        else
          newton_tolerance_ = 1.e-4;
        add_parameter("newton tolerance",
                      newton_tolerance_,
                      "Tolerance for the quadratic newton stopping criterion");
 
        newton_max_iterations_ = 2;
        add_parameter("newton max iterations",
                      newton_max_iterations_,
                      "Maximal number of quadratic newton iterations performed "
                      "during limiting");
 
        relaxation_factor_ = ScalarNumber(1.);
        add_parameter("relaxation factor",
                      relaxation_factor_,
                      "Factor for scaling the relaxation window with r_i = "
                      "factor * (m_i/|Omega|)^(1.5/d).");
 
        limit_on_kinetic_energy_ = false;
        add_parameter("limit on kinetic energy",
                      limit_on_kinetic_energy_,
                      "Limit on kinetic energy");
 
        limit_on_square_velocity_ = true;
        add_parameter("limit on square velocity",
                      limit_on_square_velocity_,
                      "Limit on square velocity");
      }
 
      ACCESSOR_READ_ONLY(iterations);
      ACCESSOR_READ_ONLY(newton_tolerance);
      ACCESSOR_READ_ONLY(newton_max_iterations);
      ACCESSOR_READ_ONLY(relaxation_factor);
 
      ACCESSOR_READ_ONLY(limit_on_kinetic_energy);
      ACCESSOR_READ_ONLY(limit_on_square_velocity);
 
    private:
      unsigned int iterations_;
      ScalarNumber newton_tolerance_;
      unsigned int newton_max_iterations_;
      ScalarNumber relaxation_factor_;
 
      bool limit_on_kinetic_energy_;
      bool limit_on_square_velocity_;
    };
 
 
    template <int dim, typename Number = double>
    class Limiter
    {
    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_contribution_type = typename View::flux_contribution_type;
 
      using precomputed_type = typename View::precomputed_type;
 
      using PrecomputedVector = typename View::PrecomputedVector;
 
      using Parameters = LimiterParameters<ScalarNumber>;
 
 
 
      static constexpr unsigned int n_bounds = 5;
 
      using Bounds = std::array<Number, n_bounds>;
 
      Limiter(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,
                 const flux_contribution_type &flux_i);
 
      void accumulate(const state_type &U_j,
                      const state_type &U_star_ij,
                      const state_type &U_star_ji,
                      const dealii::Tensor<1, dim, Number> &scaled_c_ij,
                      const state_type &affine_shift);
 
      Bounds bounds(const Number hd_i) const;
 
      static Bounds combine_bounds(const Bounds &bounds_left,
                                   const Bounds &bounds_right);
 
      //*}
 
      std::tuple<Number, bool> limit(const Bounds &bounds,
                                     const state_type &U,
                                     const state_type &P,
                                     const Number t_min = Number(0.),
                                     const Number t_max = Number(1.));
 
      //*}
 
      static bool
      is_in_invariant_domain(const HyperbolicSystem & /*hyperbolic_system*/,
                             const Bounds & /*bounds*/,
                             const state_type & /*U*/);
 
    private:
 
 
      const HyperbolicSystem &hyperbolic_system;
      const Parameters &parameters;
      const PrecomputedVector &precomputed_values;
 
      state_type U_i;
 
      Bounds bounds_;
 
      /* for relaxation */
 
      Number h_relaxation_numerator;
      Number kin_relaxation_numerator;
      Number v2_relaxation_numerator;
      Number relaxation_denominator;
 
    };
 
 
    /*
     * -------------------------------------------------------------------------
     * Inline definitions
     * -------------------------------------------------------------------------
     */
 
 
    template <int dim, typename Number>
    DEAL_II_ALWAYS_INLINE inline void
    Limiter<dim, Number>::reset(unsigned int /*i*/,
                                const state_type &new_U_i,
                                const flux_contribution_type & /*new_flux_i*/)
    {
      U_i = new_U_i;
 
      auto &[h_min, h_max, h_small, kin_max, v2_max] = bounds_;
 
      h_min = Number(std::numeric_limits<ScalarNumber>::max());
      h_max = Number(0.);
      h_small = Number(0.);
      kin_max = Number(0.);
      v2_max = Number(0.);
 
      h_relaxation_numerator = Number(0.);
      kin_relaxation_numerator = Number(0.);
      v2_relaxation_numerator = Number(0.);
      relaxation_denominator = Number(0.);
    }
 
 
    template <int dim, typename Number>
    DEAL_II_ALWAYS_INLINE inline void Limiter<dim, Number>::accumulate(
        const state_type &U_j,
        const state_type &U_star_ij,
        const state_type &U_star_ji,
        const dealii::Tensor<1, dim, Number> &scaled_c_ij,
        const state_type &affine_shift)
    {
      const auto view = hyperbolic_system.view<dim, Number>();
 
      /* The bar states: */
 
      const auto f_star_ij = view.f(U_star_ij);
      const auto f_star_ji = view.f(U_star_ji);
 
      /* bar state shifted by an affine shift: */
      const auto U_ij_bar =
          ScalarNumber(0.5) *
              (U_star_ij + U_star_ji +
               contract(add(f_star_ij, -f_star_ji), scaled_c_ij)) +
          affine_shift;
 
      /* Bounds: */
 
      auto &[h_min, h_max, h_small, kin_max, v2_max] = bounds_;
 
      const auto h_bar_ij = view.water_depth(U_ij_bar);
      h_min = std::min(h_min, h_bar_ij);
      h_max = std::max(h_max, h_bar_ij);
 
      const auto kin_bar_ij = view.kinetic_energy(U_ij_bar);
      kin_max = std::max(kin_max, kin_bar_ij);
 
      const auto v_bar_ij = view.momentum(U_ij_bar) *
                            view.inverse_water_depth_mollified(U_ij_bar);
      const auto v2_bar_ij = v_bar_ij.norm_square();
      v2_max = std::max(v2_max, v2_bar_ij);
 
      /* Relaxation: */
 
      /* Use a uniform weight. */
      const auto beta_ij = Number(1.);
 
      relaxation_denominator += std::abs(beta_ij);
 
      const auto h_i = view.water_depth(U_i);
      const auto h_j = view.water_depth(U_j);
      h_relaxation_numerator += beta_ij * (h_i + h_j);
 
      const auto kin_i = view.kinetic_energy(U_i);
      const auto kin_j = view.kinetic_energy(U_j);
      kin_relaxation_numerator += beta_ij * (kin_i + kin_j);
 
      const auto vel_i =
          view.momentum(U_i) * view.inverse_water_depth_mollified(U_i);
      const auto vel_j =
          view.momentum(U_j) * view.inverse_water_depth_mollified(U_j);
      v2_relaxation_numerator +=
          beta_ij * (-vel_i.norm_square() + vel_j.norm_square());
    }
 
 
    template <int dim, typename Number>
    DEAL_II_ALWAYS_INLINE inline auto
    Limiter<dim, Number>::bounds(const Number hd_i) const -> Bounds
    {
      const auto view = hyperbolic_system.view<dim, Number>();
 
      auto relaxed_bounds = bounds_;
      auto &[h_min, h_max, h_small, kin_max, v2_max] = relaxed_bounds;
 
      /* Use r_i = factor * (m_i / |Omega|) ^ (1.5 / d): */
 
      Number r_i = std::sqrt(hd_i);                              // in 3D: ^ 3/6
      if constexpr (dim == 2)                                    //
        r_i = dealii::Utilities::fixed_power<3>(std::sqrt(r_i)); // in 2D: ^ 3/4
      else if constexpr (dim == 1)                               //
        r_i = dealii::Utilities::fixed_power<3>(r_i);            // in 1D: ^ 3/2
      r_i *= parameters.relaxation_factor();
 
      constexpr ScalarNumber eps = std::numeric_limits<ScalarNumber>::epsilon();
 
      const Number h_relaxed = ScalarNumber(2.) *
                               std::abs(h_relaxation_numerator) /
                               (relaxation_denominator + Number(eps));
 
      h_min = std::max((Number(1.) - r_i) * h_min, h_min - h_relaxed);
      h_max = std::min((Number(1.) + r_i) * h_max, h_max + h_relaxed);
 
      const Number kin_relaxed = ScalarNumber(2.) *
                                 std::abs(kin_relaxation_numerator) /
                                 (relaxation_denominator + Number(eps));
 
      kin_max = std::min((Number(1.) + r_i) * kin_max, kin_max + kin_relaxed);
 
      const Number v2_relaxed = ScalarNumber(2.) *
                                std::abs(v2_relaxation_numerator) /
                                (relaxation_denominator + Number(eps));
 
      v2_max = std::min((Number(1.) + r_i) * v2_max, v2_max + v2_relaxed);
 
      /* Use r_i = 0.2 * (m_i / |Omega|) ^ (1 / d): */
 
      r_i = hd_i;
      if constexpr (dim == 2)
        r_i = std::sqrt(hd_i);
      r_i *= view.dry_state_relaxation_factor();
 
      h_small = view.reference_water_depth() * r_i;
 
      return relaxed_bounds;
    }
 
 
    template <int dim, typename Number>
    DEAL_II_ALWAYS_INLINE inline auto
    Limiter<dim, Number>::combine_bounds(const Bounds &bounds_l,
                                         const Bounds &bounds_r) -> Bounds
    {
      const auto &[h_min_l, h_max_l, h_small_l, k_max_l, v2_max_l] = bounds_l;
      const auto &[h_min_r, h_max_r, h_small_r, k_max_r, v2_max_r] = bounds_r;
 
      return {std::min(h_min_l, h_min_r),
              std::max(h_max_l, h_max_r),
              std::min(h_small_l, h_small_r),
              std::max(k_max_l, h_max_r),
              std::max(v2_max_l, v2_max_r)};
    }
 
 
    template <int dim, typename Number>
    DEAL_II_ALWAYS_INLINE inline bool
    Limiter<dim, Number>::is_in_invariant_domain(
        const HyperbolicSystem & /*hyperbolic_system*/,
        const Bounds & /*bounds*/,
        const state_type & /*U*/)
    {
      AssertThrow(false, dealii::ExcNotImplemented());
      __builtin_trap();
      return true;
    }
 
 
  } // namespace ShallowWater
} // namespace ryujin