Op_Conv_VEF_base.cpp

/****************************************************************************
* Copyright (c) 2026, 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.
*
*****************************************************************************/
 
#include <Op_Conv_VEF_base.h>
 
#include <Milieu_base.h>
#include <Schema_Temps_base.h>
#include <Probleme_base.h>
#include <TRUSTTrav.h>
#include <Discretisation_base.h>
 
#include <Modifier_pour_fluide_dilatable.h>
#include <Dirichlet_homogene.h>
#include <Periodique.h>
 
Implemente_base(Op_Conv_VEF_base,"Op_Conv_VEF_base",Operateur_Conv_base);
 
Sortie& Op_Conv_VEF_base::printOn(Sortie& s ) const
{
  return s << que_suis_je() ;
}
 
Entree& Op_Conv_VEF_base::readOn(Entree& s )
{
  return s ;
}
 
 
/*! @brief Defines whether psi is convected with phi*u or with u.
 *
 */
int  Op_Conv_VEF_base::phi_u_transportant(const Equation_base& eq) const
{
  if (eq.inconnue().le_nom()=="vitesse")
    return 0;
  return 1;
}
 
 
void Op_Conv_VEF_base::associer_vitesse(const Champ_base& vit)
{
  vitesse_ = ref_cast(Champ_Inc_base,vit);
}
 
 
void Op_Conv_VEF_base::abortTimeStep()
{
  Operateur_Conv_base::abortTimeStep();
}
 
double Op_Conv_VEF_base::calculer_dt_stab() const
{
  const Domaine_Cl_VEF& domaine_Cl_VEF = la_zcl_vef.valeur();
  const Domaine_VEF& domaine_VEF = le_dom_vef.valeur();
  remplir_fluent();
  if (vitesse().le_nom()=="rho_u" && equation().probleme().is_dilatable())
    diviser_par_rho_si_dilatable(fluent_,equation().milieu());
 
  // Fill faces_entrelaces_Cl_ which contains non-Dirichlet boundary faces
  // and non-standard internal faces for which volumes_entrelaces_Cl is used.
  // This temporary array was created to merge several
  // Kokkos kernels into one
  if (faces_entrelaces_Cl_.size_array()==0)
    {
      faces_entrelaces_Cl_.resize(domaine_VEF.premiere_face_std());
      int ind_face=-1;
      // Process boundary conditions.
      // If a face carries a Dirichlet condition, it is not taken into account
      // in the computation of dt_stab.
      for (int n_bord = 0; n_bord < domaine_VEF.nb_front_Cl(); n_bord++)
        {
          const Cond_lim& la_cl = domaine_Cl_VEF.les_conditions_limites(n_bord);
          if (!sub_type(Dirichlet, la_cl.valeur()) && !sub_type(Dirichlet_homogene, la_cl.valeur()))
            {
              const Front_VF& le_bord = ref_cast(Front_VF, la_cl->frontiere_dis());
              int ndeb = le_bord.num_premiere_face();
              int nfin = ndeb + le_bord.nb_faces();
              for (int num_face = ndeb; num_face < nfin; num_face++)
                faces_entrelaces_Cl_(++ind_face) = num_face;
            }
        }
      // Non-standard internal faces:
      int ndeb = domaine_VEF.premiere_face_int();
      int nfin = domaine_VEF.premiere_face_std();
      for (int num_face = ndeb; num_face < nfin; num_face++)
        faces_entrelaces_Cl_(++ind_face) = num_face;
      faces_entrelaces_Cl_.resize(ind_face+1);
    }
 
  double dt_stab = 1.e30;
  CIntArrView faces_entrelaces_Cl = faces_entrelaces_Cl_.view_ro();
  CDoubleArrView fluent = fluent_.view_ro();
  CDoubleArrView volumes_entrelaces_Cl = domaine_Cl_VEF.volumes_entrelaces_Cl().view_ro();
  start_gpu_timer(__KERNEL_NAME__);
  Kokkos::parallel_reduce(__KERNEL_NAME__,
                          range_1D(0, faces_entrelaces_Cl_.size_array()),
                          KOKKOS_LAMBDA(const int ind_face, double& dtstab)
  {
    int num_face = faces_entrelaces_Cl(ind_face);
    double dt_face = volumes_entrelaces_Cl(num_face)/(fluent(num_face)+DMINFLOAT);
    if (dt_face < dtstab) dtstab = dt_face;
  }, Kokkos::Min<double>(dt_stab));
  end_gpu_timer(__KERNEL_NAME__);
 
  // Process standard internal faces
  int ndeb = domaine_VEF.premiere_face_std();
  int nfin = domaine_VEF.nb_faces();
 
  const DoubleVect& tab_volumes_entrelaces = domaine_VEF.volumes_entrelaces();
  CDoubleArrView volumes_entrelaces = tab_volumes_entrelaces.view_ro();
  // Necessary because Kokkos::parallel_reduce() overwrites dt_stab with the
  // result of the reduction regardless of the initial value (in
  // particular, the value from a previous reduction, as here).
  double dt_stab_2 = dt_stab;
  Kokkos::parallel_reduce(
    start_gpu_timer(__KERNEL_NAME__),
    range_1D(ndeb, nfin),
    KOKKOS_LAMBDA(const int num_face, double& dtstab)
  {
    double dt_face = volumes_entrelaces(num_face) / (fluent(num_face) + DMINFLOAT);
    if (dt_face < dtstab) dtstab = dt_face;
  }, Kokkos::Min<double>(dt_stab_2));
  end_gpu_timer(__KERNEL_NAME__);
  if (dt_stab_2 < dt_stab) dt_stab = dt_stab_2;
 
  // Min over all processors
  dt_stab = Process::mp_min(dt_stab);
  // trick to work around the const type of the method
  Op_Conv_VEF_base& op = ref_cast_non_const(Op_Conv_VEF_base,*this);
  op.fixer_dt_stab_conv(dt_stab);
  if (vitesse().le_nom()=="rho_u" && equation().probleme().is_dilatable())
    multiplier_par_rho_si_dilatable(fluent_,equation().milieu());
 
  return dt_stab;
}
 
// cf Op_Conv_VEF_base::calculer_dt_stab() for the choice of dt_stab computation
void Op_Conv_VEF_base::calculer_pour_post(Champ_base& espace_stockage,const Nom& option,int comp) const
{
  if (Motcle(option)=="stabilite")
    {
      DoubleTab& es_valeurs = espace_stockage.valeurs();
      es_valeurs = 1.e30;
 
      if ((bool(le_dom_vef)) && (bool(la_zcl_vef)))
        {
          const Domaine_Cl_VEF& domaine_Cl_VEF = la_zcl_vef.valeur();
          const Domaine_VEF& domaine_VEF = le_dom_vef.valeur();
          const DoubleVect& volumes_entrelaces = domaine_VEF.volumes_entrelaces();
          const DoubleVect& volumes_entrelaces_Cl = domaine_Cl_VEF.volumes_entrelaces_Cl();
          double dt_face;
          remplir_fluent();
          if (vitesse().le_nom()=="rho_u" && equation().probleme().is_dilatable())
            diviser_par_rho_si_dilatable(fluent_,equation().milieu());
 
          // Process boundary conditions.
          // If a face carries a Dirichlet condition, it is not taken into account
          // in the computation of dt_stab.
          for (int n_bord=0; n_bord<domaine_VEF.nb_front_Cl(); n_bord++)
            {
              const Cond_lim& la_cl = domaine_Cl_VEF.les_conditions_limites(n_bord);
              if ((sub_type(Dirichlet, la_cl.valeur())) || (sub_type(Dirichlet_homogene, la_cl.valeur())))
                { /* Do nothing */}
              else
                {
                  const Front_VF& le_bord = ref_cast(Front_VF,la_cl->frontiere_dis());
                  int ndeb = le_bord.num_premiere_face();
                  int nfin = ndeb + le_bord.nb_faces();
                  for (int num_face=ndeb; num_face<nfin; num_face++)
                    {
                      dt_face = volumes_entrelaces_Cl(num_face)/(fluent_[num_face]+1.e-30);
                      es_valeurs(num_face) = dt_face;
                    }
                }
            }
 
          // Process non-standard internal faces
          int ndeb = domaine_VEF.premiere_face_int();
          int nfin = domaine_VEF.premiere_face_std();
 
          for (int num_face=ndeb; num_face<nfin; num_face++)
            {
              dt_face = volumes_entrelaces_Cl(num_face)/(fluent_[num_face]+1.e-30);
              es_valeurs(num_face) = dt_face;
            }
 
          // Process standard internal faces
          ndeb = nfin;
          nfin = domaine_VEF.nb_faces();
          for (int num_face=ndeb; num_face<nfin; num_face++)
            {
              dt_face = volumes_entrelaces(num_face)/(fluent_[num_face]+1.e-30);
              es_valeurs(num_face) = dt_face;
            }
          if (vitesse().le_nom()=="rho_u" && equation().probleme().is_dilatable())
            multiplier_par_rho_si_dilatable(fluent_,equation().milieu());
        }
    }
  else
    Operateur_Conv_base::calculer_pour_post(espace_stockage,option,comp);
}
 
Motcle Op_Conv_VEF_base::get_localisation_pour_post(const Nom& option) const
{
  Motcle loc;
  if (Motcle(option)=="stabilite")
    loc = "face";
  else
    return Operateur_Conv_base::get_localisation_pour_post(option);
  return loc;
}
void Op_Conv_VEF_base::associer_domaine_cl_dis(const Domaine_Cl_dis_base& domaine_cl_dis)
{
  const Domaine_Cl_VEF& zclvef = ref_cast(Domaine_Cl_VEF,domaine_cl_dis);
  la_zcl_vef = zclvef;
}
 
void Op_Conv_VEF_base::associer(const Domaine_dis_base& domaine_dis,
                                const Domaine_Cl_dis_base& domaine_cl_dis,
                                const Champ_Inc_base& )
{
  const Domaine_VEF& zvef = ref_cast(Domaine_VEF,domaine_dis);
  const Domaine_Cl_VEF& zclvef = ref_cast(Domaine_Cl_VEF,domaine_cl_dis);
 
  le_dom_vef = zvef;
  la_zcl_vef = zclvef;
  //******************************************************************************
  // Initialization of tokens for alternation (kamoulox!)
 
  //******************************************************************************
  Cerr << "Initialization of the wheel for permutation of convection schemes" << finl;
  roue= -1;
  //  roue2=-1;
 
  le_dom_vef->creer_tableau_faces(fluent_);
}
 
int Op_Conv_VEF_base::impr(Sortie& os) const
{
  return Op_VEF_Face::impr(os, *this );
}
 
DoubleTab& Op_Conv_VEF_base::calculer(const DoubleTab& transporte,
                                      DoubleTab& resu) const
{
  resu = 0;
  return ajouter(transporte,resu);
}
void Op_Conv_VEF_base::remplir_fluent() const
{
  // Fill the fluent array by calling ajouter.
  // This is expensive but at least it fixes (while waiting
  // to optimize) the problem of a convection time step
  // computed with velocities from the past.
  DoubleTrav tmp(equation().inconnue().valeurs());
  DoubleTab flux_bords_sauve(flux_bords_);  // Save flux_bords, otherwise set to 0
  ajouter(tmp,tmp);
  flux_bords_=flux_bords_sauve;
  // PL: This is really heavy, but what else? fluent depends on
  // the scheme, so something like fluent=velocity*surface*porosity
  // could be coded in this method
}
 
 
// Calculation of local time: Vect of size number of faces of the domain
// This is the equivalent of "Op_Conv_VEF_base :: calculer_dt_stab ()"
void Op_Conv_VEF_base::calculer_dt_local(DoubleTab& dt_face) const
{
  const Domaine_Cl_VEF& domaine_Cl_VEF = la_zcl_vef.valeur();
  const Domaine_VEF& domaine_VEF = le_dom_vef.valeur();
  const DoubleVect& volumes_entrelaces =  domaine_VEF.volumes_entrelaces();
  const DoubleVect& volumes_entrelaces_Cl = domaine_Cl_VEF.volumes_entrelaces_Cl();
 
  int nb_faces= domaine_VEF.nb_faces();
  dt_face=(volumes_entrelaces);
  remplir_fluent();
 
  for (int n_bord=0; n_bord<domaine_VEF.nb_front_Cl(); n_bord++)
    {
      const Cond_lim& la_cl = domaine_Cl_VEF.les_conditions_limites(n_bord);
      const Front_VF& le_bord = ref_cast(Front_VF,la_cl->frontiere_dis());
      int ndeb = le_bord.num_premiere_face();
      int nfin = ndeb + le_bord.nb_faces();
      for (int num_face=ndeb; num_face<nfin; num_face++)
        {
          if( sup_strict(fluent_[num_face], 1.e-30) )
            dt_face(num_face)= volumes_entrelaces_Cl(num_face)/fluent_[num_face];
          else
            dt_face(num_face) = -1.;
        }
    }
 
  //Non-standard internal faces
  int ndeb = domaine_VEF.premiere_face_int();
  int nfin = domaine_VEF.premiere_face_std();
 
  for (int num_face=ndeb; num_face<nfin; num_face++)
    {
      if( sup_strict(fluent_[num_face], 1.e-30) )
        dt_face(num_face)= volumes_entrelaces(num_face)/fluent_[num_face];
      else
        dt_face(num_face) = -1.;
    }
 
  //The standard internal faces
  ndeb = nfin;
  nfin = domaine_VEF.nb_faces();
  for (int num_face=ndeb; num_face<nfin; num_face++)
    {
      if( sup_strict(fluent_[num_face], 1.e-30) )
        dt_face(num_face)= volumes_entrelaces(num_face)/fluent_[num_face];
      else
        dt_face(num_face) = -1.;
    }
 
  double max_dt_local= dt_face.mp_max_abs_vect();
  for(int i=0; i<nb_faces; i++)
    {
      if(! sup_strict(dt_face(i), 1.e-16))
        dt_face(i) = max_dt_local;
    }
  dt_face.echange_espace_virtuel();
 
  for (int n_bord=0; n_bord<domaine_VEF.nb_front_Cl(); n_bord++)
    {
      const Cond_lim& la_cl = domaine_Cl_VEF.les_conditions_limites(n_bord);
      if (sub_type(Periodique,la_cl.valeur()))
        {
          const Periodique& la_cl_perio = ref_cast(Periodique,la_cl.valeur());
          const Front_VF& le_bord = ref_cast(Front_VF,la_cl->frontiere_dis());
          int nb_faces_bord=le_bord.nb_faces();
          for (int ind_face=0; ind_face<nb_faces_bord; ind_face++)
            {
              int ind_face_associee = la_cl_perio.face_associee(ind_face);
              int face = le_bord.num_face(ind_face);
              int face_associee = le_bord.num_face(ind_face_associee);
              if (!est_egal(dt_face(face),dt_face(face_associee),1.e-8))
                {
                  dt_face(face) = std::min(dt_face(face),dt_face(face_associee));
                }
            }
        }
    }
  dt_face.echange_espace_virtuel();
 
// dt_conv_locaux=dt_face;
}