Modele_turbulence_hyd_RANS_Gen.h

/****************************************************************************
* Copyright (c) 2024, CEA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************/
 
#ifndef Modele_turbulence_hyd_RANS_Gen_included
#define Modele_turbulence_hyd_RANS_Gen_included
 
#include <Modifier_pour_fluide_dilatable.h>
#include <Schema_Temps_base.h>
#include <Champ_Inc_P0_base.h>
#include <Equation_base.h>
#include <Process.h>
#include <type_traits>
 
enum class MODELE_TYPE
{
  K_EPS, K_EPS_2_COUCHES,
  K_EPS_BAS_REYNOLDS, K_EPS_REALISABLE,
  K_EPS_BICEPHALE, K_EPS_REALISABLE_BICEPHALE,
  K_OMEGA
};
 
template <typename MODELE>
class Modele_turbulence_hyd_RANS_Gen
{
private:
  template <MODELE_TYPE M_TYPE>
  void print_evolution(const Champ_Inc_base& , const Schema_Temps_base& , double , int , const Champ_Inc_base* = nullptr /* Seulement si Bicephale */);
 
public:
  DoubleTab& complete_viscosity_field(const int , const Domaine_dis_base& , Champ_Inc_base& );
 
  template <MODELE_TYPE M_TYPE> std::enable_if_t<(M_TYPE ==  MODELE_TYPE::K_EPS || M_TYPE ==  MODELE_TYPE::K_EPS_REALISABLE || M_TYPE ==  MODELE_TYPE::K_OMEGA), void>
  calculate_limit_viscosity(Champ_Inc_base& , double );
 
  template <MODELE_TYPE M_TYPE> std::enable_if_t<M_TYPE ==  MODELE_TYPE::K_EPS_2_COUCHES, void>
  calculate_limit_viscosity(Champ_Inc_base& , double );
 
  template <MODELE_TYPE M_TYPE> std::enable_if_t<M_TYPE ==  MODELE_TYPE::K_EPS_BAS_REYNOLDS, void>
  calculate_limit_viscosity(Champ_Inc_base& , double );
 
  template <MODELE_TYPE M_TYPE> std::enable_if_t<(M_TYPE ==  MODELE_TYPE::K_EPS_BICEPHALE || M_TYPE ==  MODELE_TYPE::K_EPS_REALISABLE_BICEPHALE), void>
  calculate_limit_viscosity(Champ_Inc_base&, Champ_Inc_base& , double );
};
 
template <typename MODELE>
DoubleTab& Modele_turbulence_hyd_RANS_Gen<MODELE>::complete_viscosity_field(const int n, const Domaine_dis_base& dom_dis, Champ_Inc_base& visc)
{
  visc.associer_domaine_dis_base(dom_dis);
  visc.nommer("diffusivite_turbulente");
  visc.fixer_nb_comp(1);
  visc.fixer_nb_valeurs_nodales(n);
  visc.fixer_unite("inconnue");
  visc.changer_temps(0.);
  return visc.valeurs();
}
 
template<typename MODELE> template<MODELE_TYPE M_TYPE>
std::enable_if_t<(M_TYPE ==  MODELE_TYPE::K_EPS || M_TYPE ==  MODELE_TYPE::K_EPS_REALISABLE || M_TYPE ==  MODELE_TYPE::K_OMEGA), void>
Modele_turbulence_hyd_RANS_Gen<MODELE>::calculate_limit_viscosity(Champ_Inc_base& ch_K_Eps_ou_Omega, double LeCmu)
{
  constexpr bool IS_K_OMEGA = (M_TYPE == MODELE_TYPE::K_OMEGA);
  auto *z_class = static_cast<MODELE*>(this); // CRTP --> I love you :*
  const Milieu_base& mil = z_class->equation().probleme().milieu();
 
  // on divise par rho en QC pour revenir a K et Eps/Omega
  if (z_class->equation().probleme().is_dilatable())
    diviser_par_rho_si_dilatable(ch_K_Eps_ou_Omega.valeurs(), mil);
 
  print_evolution<M_TYPE>(ch_K_Eps_ou_Omega, z_class->equation().schema_temps(), LeCmu, 1);
 
  z_class->loi_paroi().calculer_hyd(ch_K_Eps_ou_Omega);
  z_class->controler();
  z_class->calculer_viscosite_turbulente(ch_K_Eps_ou_Omega.temps());
  z_class->limiter_viscosite_turbulente();
 
  // on remultiplie par rho
  if (z_class->equation().probleme().is_dilatable())
    {
      multiplier_par_rho_si_dilatable(ch_K_Eps_ou_Omega.valeurs(), mil);
      if constexpr (!IS_K_OMEGA)
        correction_nut_et_cisaillement_paroi_si_qc(*z_class);
    }
 
  z_class->viscosite_turbulente().valeurs().echange_espace_virtuel();
 
  print_evolution<M_TYPE>(ch_K_Eps_ou_Omega, z_class->equation().schema_temps(), LeCmu, 0);
}
 
 
// note: LeCmu maybe unused because of if constexpr branches
template<typename MODELE> template<MODELE_TYPE M_TYPE>
std::enable_if_t<(M_TYPE ==  MODELE_TYPE::K_EPS_BICEPHALE || M_TYPE ==  MODELE_TYPE::K_EPS_REALISABLE_BICEPHALE), void>
Modele_turbulence_hyd_RANS_Gen<MODELE>::calculate_limit_viscosity(Champ_Inc_base& ch_K, Champ_Inc_base& ch_Eps, [[maybe_unused]] double LeCmu)
{
  constexpr bool IS_K_EPS_REALISABLE_BICEPHALE = (M_TYPE == MODELE_TYPE::K_EPS_REALISABLE_BICEPHALE);
 
  auto *z_class = static_cast<MODELE*>(this); // CRTP --> I love you :*
  const Milieu_base& mil = z_class->equation().probleme().milieu();
 
  // on divise par rho en QC pour revenir a K et Eps/Omega
  if (z_class->equation().probleme().is_dilatable())
    {
      diviser_par_rho_si_dilatable(ch_K.valeurs(), mil);
      diviser_par_rho_si_dilatable(ch_Eps.valeurs(), mil);
    }
 
  if constexpr (!IS_K_EPS_REALISABLE_BICEPHALE)
    print_evolution<M_TYPE>(ch_K, z_class->equation().schema_temps(), LeCmu, 1, &ch_Eps);
 
  z_class->loi_paroi().calculer_hyd_BiK(ch_K.valeurs(), ch_Eps.valeurs());
  z_class->controler();
  z_class->calculer_viscosite_turbulente(ch_K.temps());
  z_class->limiter_viscosite_turbulente();
 
  // on remultiplie par rho
  if (z_class->equation().probleme().is_dilatable())
    {
      multiplier_par_rho_si_dilatable(ch_K.valeurs(), mil);
      multiplier_par_rho_si_dilatable(ch_Eps.valeurs(), mil);
      correction_nut_et_cisaillement_paroi_si_qc(*z_class);
    }
 
  z_class->viscosite_turbulente().valeurs().echange_espace_virtuel();
 
  if constexpr (!IS_K_EPS_REALISABLE_BICEPHALE)
    print_evolution<M_TYPE>(ch_K, z_class->equation().schema_temps(), LeCmu, 0, &ch_Eps);
}
 
template<typename MODELE> template<MODELE_TYPE M_TYPE>
std::enable_if_t<M_TYPE == MODELE_TYPE::K_EPS_2_COUCHES, void>
Modele_turbulence_hyd_RANS_Gen<MODELE>::calculate_limit_viscosity(Champ_Inc_base& ch_K_Eps_ou_Omega, double LeCmu)
{
  auto *z_class = static_cast<MODELE*>(this); // CRTP --> I love you :*
  const Milieu_base& mil = z_class->equation().probleme().milieu();
 
  z_class->controler();
 
  // on divise par rho en QC pour revenir a K et Eps/Omega
  if (z_class->equation().probleme().is_dilatable())
    diviser_par_rho_si_dilatable(ch_K_Eps_ou_Omega.valeurs(), mil);
 
  z_class->calculer_viscosite_turbulente(ch_K_Eps_ou_Omega.temps());
  z_class->loi_paroi().calculer_hyd(ch_K_Eps_ou_Omega);
  z_class->limiter_viscosite_turbulente();
 
  // on remultiplie par rho
  if (z_class->equation().probleme().is_dilatable())
    {
      multiplier_par_rho_si_dilatable(ch_K_Eps_ou_Omega.valeurs(), mil);
      correction_nut_et_cisaillement_paroi_si_qc(*z_class);
    }
 
  z_class->viscosite_turbulente().valeurs().echange_espace_virtuel();
}
 
template<typename MODELE> template<MODELE_TYPE M_TYPE>
std::enable_if_t<M_TYPE == MODELE_TYPE::K_EPS_BAS_REYNOLDS, void>
Modele_turbulence_hyd_RANS_Gen<MODELE>::calculate_limit_viscosity(Champ_Inc_base& ch_K_Eps_ou_Omega, [[maybe_unused]] double LeCmu)
{
  auto *z_class = static_cast<MODELE*>(this); // CRTP --> I love you :*
  z_class->controler();
  z_class->calculer_viscosite_turbulente(ch_K_Eps_ou_Omega.temps());
  z_class->limiter_viscosite_turbulente();
  z_class->viscosite_turbulente().valeurs().echange_espace_virtuel();
}
 
template <typename MODELE> template <MODELE_TYPE M_TYPE>
void Modele_turbulence_hyd_RANS_Gen<MODELE>::print_evolution(const Champ_Inc_base& le_champ_K_Eps_ou_Omega, const Schema_Temps_base& sch, const double LeCmu, const int avant, const Champ_Inc_base* le_champ_Eps)
{
 
  constexpr bool IS_K_OMEGA = (M_TYPE == MODELE_TYPE::K_OMEGA);
  constexpr bool IS_2_COUCHES = (M_TYPE == MODELE_TYPE::K_EPS_2_COUCHES);
  constexpr bool IS_BAS_REYNOLDS = (M_TYPE == MODELE_TYPE::K_EPS_BAS_REYNOLDS);
  constexpr bool IS_K_EPS_BICEPHALE = (M_TYPE == MODELE_TYPE::K_EPS_BICEPHALE);
  constexpr bool IS_K_EPS_REALISABLE_BICEPHALE = (M_TYPE == MODELE_TYPE::K_EPS_REALISABLE_BICEPHALE);
 
  assert (!IS_K_EPS_BICEPHALE || (IS_K_EPS_BICEPHALE && le_champ_Eps != nullptr));
 
  if constexpr (IS_2_COUCHES || IS_BAS_REYNOLDS || IS_K_EPS_REALISABLE_BICEPHALE) return; /* Do nothing */
 
  if (sch.nb_pas_dt() == 0 || sch.limpr())
    {
      const DoubleTab& tab_K_Eps_ou_Omega = le_champ_K_Eps_ou_Omega.valeurs();
      double k_min = DMAXFLOAT, eps_ou_omega_min = DMAXFLOAT, nut_min = DMAXFLOAT;
      double k_max = 0, eps_ou_omega_max = 0, nut_max = 0;
      int loc_k_min = -1, loc_eps_ou_omega_min = -1, loc_nut_min = -1;
      int loc_k_max = -1, loc_eps_ou_omega_max = -1, loc_nut_max = -1;
      int size = tab_K_Eps_ou_Omega.dimension(0);
 
      if (size < 0)
        {
          if (!sub_type(Champ_Inc_P0_base, le_champ_K_Eps_ou_Omega))
            {
              Cerr << "Unsupported field in Modele_turbulence_hyd_RANS_Gen::imprimer_evolution()" << finl;
              Process::exit(-1);
            }
 
          size = le_champ_K_Eps_ou_Omega.equation().domaine_dis().domaine().nb_elem();
 
          if constexpr (IS_K_EPS_BICEPHALE)
            {
              if (!sub_type(Champ_Inc_P0_base, (*le_champ_Eps)))
                {
                  Cerr << "Unsupported field in Modele_turbulence_hyd_RANS_Gen::imprimer_evolution()" << finl;
                  Process::exit(-1);
                }
              assert (size == (*le_champ_Eps).equation().domaine_dis().domaine().nb_elem());
            }
        }
      // Structure to hold min/max values and their locations for reduction
      struct MinMaxResult
      {
        double k_min, k_max;
        double eps_ou_omega_min, eps_ou_omega_max;
        double nut_min, nut_max;
        int loc_k_min, loc_k_max;
        int loc_eps_ou_omega_min, loc_eps_ou_omega_max;
        int loc_nut_min, loc_nut_max;
 
        KOKKOS_INLINE_FUNCTION
        MinMaxResult() : k_min(DMAXFLOAT), k_max(-DMAXFLOAT), eps_ou_omega_min(DMAXFLOAT), eps_ou_omega_max(-DMAXFLOAT),
          nut_min(DMAXFLOAT), nut_max(-DMAXFLOAT), loc_k_min(-1), loc_k_max(-1),
          loc_eps_ou_omega_min(-1), loc_eps_ou_omega_max(-1), loc_nut_min(-1), loc_nut_max(-1) {}
 
        KOKKOS_INLINE_FUNCTION
        MinMaxResult(const MinMaxResult& rhs) : k_min(rhs.k_min), k_max(rhs.k_max),
          eps_ou_omega_min(rhs.eps_ou_omega_min), eps_ou_omega_max(rhs.eps_ou_omega_max),
          nut_min(rhs.nut_min), nut_max(rhs.nut_max),
          loc_k_min(rhs.loc_k_min), loc_k_max(rhs.loc_k_max),
          loc_eps_ou_omega_min(rhs.loc_eps_ou_omega_min), loc_eps_ou_omega_max(rhs.loc_eps_ou_omega_max),
          loc_nut_min(rhs.loc_nut_min), loc_nut_max(rhs.loc_nut_max) {}
 
        KOKKOS_INLINE_FUNCTION
        MinMaxResult& operator=(const MinMaxResult&) = default;
 
        KOKKOS_INLINE_FUNCTION
        void operator += (const MinMaxResult& rhs)
        {
          if (rhs.k_min < k_min) { k_min = rhs.k_min; loc_k_min = rhs.loc_k_min; }
          if (rhs.k_max > k_max) { k_max = rhs.k_max; loc_k_max = rhs.loc_k_max; }
          if (rhs.eps_ou_omega_min < eps_ou_omega_min) { eps_ou_omega_min = rhs.eps_ou_omega_min; loc_eps_ou_omega_min = rhs.loc_eps_ou_omega_min; }
          if (rhs.eps_ou_omega_max > eps_ou_omega_max) { eps_ou_omega_max = rhs.eps_ou_omega_max; loc_eps_ou_omega_max = rhs.loc_eps_ou_omega_max; }
          if (rhs.nut_min < nut_min) { nut_min = rhs.nut_min; loc_nut_min = rhs.loc_nut_min; }
          if (rhs.nut_max > nut_max) { nut_max = rhs.nut_max; loc_nut_max = rhs.loc_nut_max; }
        }
      };
 
      MinMaxResult result;
      CDoubleTabView K_Eps_ou_Omega = tab_K_Eps_ou_Omega.view_ro();
      CDoubleArrView Eps;
      if constexpr (IS_K_EPS_BICEPHALE) Eps = static_cast<const ArrOfDouble&>((*le_champ_Eps).valeurs()).view_ro();
      Kokkos::parallel_reduce(start_gpu_timer(__KERNEL_NAME__), size,
                              KOKKOS_LAMBDA(const int n, MinMaxResult& local_result)
      {
        const double k = IS_K_EPS_BICEPHALE ? K_Eps_ou_Omega(n, 0) : K_Eps_ou_Omega(n, 0);
        const double epsOuomega = IS_K_EPS_BICEPHALE ? Eps(n) : K_Eps_ou_Omega(n, 1);
        double nut = 0;
 
        const double num = IS_K_OMEGA ? k : LeCmu * k * k;
 
        if (epsOuomega > 0)
          nut = num / epsOuomega;
 
        // Always update k min/max (k is always computed)
        if (local_result.loc_k_min == -1 || k < local_result.k_min)
          {
            local_result.k_min = k;
            local_result.loc_k_min = n;
          }
        if (local_result.loc_k_max == -1 || k > local_result.k_max)
          {
            local_result.k_max = k;
            local_result.loc_k_max = n;
          }
 
        // Always update eps/omega min/max (epsOuomega is always computed)
        if (local_result.loc_eps_ou_omega_min == -1 || epsOuomega < local_result.eps_ou_omega_min)
          {
            local_result.eps_ou_omega_min = epsOuomega;
            local_result.loc_eps_ou_omega_min = n;
          }
        if (local_result.loc_eps_ou_omega_max == -1 || epsOuomega > local_result.eps_ou_omega_max)
          {
            local_result.eps_ou_omega_max = epsOuomega;
            local_result.loc_eps_ou_omega_max = n;
          }
 
        // Always update nut min/max (nut is always computed, even if 0)
        if (local_result.loc_nut_min == -1 || nut < local_result.nut_min)
          {
            local_result.nut_min = nut;
            local_result.loc_nut_min = n;
          }
        if (local_result.loc_nut_max == -1 || nut > local_result.nut_max)
          {
            local_result.nut_max = nut;
            local_result.loc_nut_max = n;
          }
      }, result);
      end_gpu_timer(__KERNEL_NAME__);
 
      // Extract results
      k_min = result.k_min;
      k_max = result.k_max;
      eps_ou_omega_min = result.eps_ou_omega_min;
      eps_ou_omega_max = result.eps_ou_omega_max;
      nut_min = result.nut_min;
      nut_max = result.nut_max;
      loc_k_min = result.loc_k_min;
      loc_k_max = result.loc_k_max;
      loc_eps_ou_omega_min = result.loc_eps_ou_omega_min;
      loc_eps_ou_omega_max = result.loc_eps_ou_omega_max;
      loc_nut_min = result.loc_nut_min;
      loc_nut_max = result.loc_nut_max;
 
 
      // min values
      Process::mp_min_for_each(k_min, eps_ou_omega_min, nut_min);
 
      // max values
      Process::mp_max_for_each(k_max, eps_ou_omega_max, nut_max);
 
      // ecriture
      if (Process::je_suis_maitre())
        {
          Cout << finl << "K_Eps/Omega evolution (" << (avant ? "before" : "after") << " law of the wall applies) at time " << le_champ_K_Eps_ou_Omega.temps() << ":" << finl;
          Cout << "std::min(k)=" << k_min;
          if (Process::is_sequential()) Cout << " located at node " << loc_k_min;
          Cout << finl;
          Cout << "std::min(eps/omega)=" << eps_ou_omega_min;
          if (Process::is_sequential()) Cout << " located at node " << loc_eps_ou_omega_min;
          Cout << finl;
          Cout << "std::min(nut)=" << nut_min;
          if (Process::is_sequential()) Cout << " located at node " << loc_nut_min;
          Cout << finl;
          Cout << "std::max(k)=" << k_max;
          if (Process::is_sequential()) Cout << " located at node " << loc_k_max;
          Cout << finl;
          Cout << "std::max(eps/omega)=" << eps_ou_omega_max;
          if (Process::is_sequential()) Cout << " located at node " << loc_eps_ou_omega_max;
          Cout << finl;
          Cout << "std::max(nut)=" << nut_max;
          if (Process::is_sequential()) Cout << " located at node " << loc_nut_max;
          Cout << finl;
        }
    }
}
 
#endif /* Modele_turbulence_hyd_RANS_Gen_included */