Navier_Stokes_IBM_Turbulent.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 <Navier_Stokes_IBM_Turbulent.h>
#include <Modele_turbulence_hyd_base.h>
#include <Op_Diff_Turbulent_base.h>
#include <Fluide_Incompressible.h>
#include <Discretisation_base.h>
#include <Schema_Temps_base.h>
#include <Champ_Uniforme.h>
#include <Probleme_base.h>
#include <Discret_Thyd.h>
#include <TRUST_2_PDI.h>
#include <Domaine.h>
#include <Avanc.h>
#include <Param.h>
 
Implemente_instanciable(Navier_Stokes_IBM_Turbulent, "Navier_Stokes_IBM_Turbulent", Navier_Stokes_IBM);
// XD navier_stokes_ibm_turbulent navier_stokes_standard navier_stokes_ibm_turbulent INHERITS_BRACE IBM Navier-Stokes
// XD_CONT equations as well as the associated turbulence model equations.
// XD attr modele_turbulence modele_turbulence_hyd_deriv modele_turbulence OPT Turbulence model for Navier-Stokes
// XD_CONT equations.
 
Sortie& Navier_Stokes_IBM_Turbulent::printOn(Sortie& is) const { return Equation_base::printOn(is); }
 
Entree& Navier_Stokes_IBM_Turbulent::readOn(Entree& is) { return Navier_Stokes_IBM::readOn(is); }
 
void Navier_Stokes_IBM_Turbulent::set_param(Param& param) const
{
  Navier_Stokes_IBM::set_param(param);
  param.ajouter_non_std("modele_turbulence", (this), Param::REQUIRED);
}
 
int Navier_Stokes_IBM_Turbulent::lire_motcle_non_standard(const Motcle& mot, Entree& is)
{
  if (mot == "diffusion")
    {
      Cerr << "Reading and typing of the diffusion operator : ";
      terme_diffusif.associer_diffusivite(diffusivite_pour_transport());
      lire_op_diff_turbulent(is);
      terme_diffusif.associer_diffusivite_pour_pas_de_temps(diffusivite_pour_pas_de_temps());
      return 1;
    }
  else if (mot == "modele_turbulence")
    return typer_lire_mod_turb_hyd(is);
  else
    return Navier_Stokes_IBM::lire_motcle_non_standard(mot, is);
}
 
int Navier_Stokes_IBM_Turbulent::typer_lire_mod_turb_hyd(Entree& s)
{
  Cerr << "Reading and typing of the turbulence model : ";
 
  Motcle typ;
  s >> typ;
  Motcle nom1("Modele_turbulence_hyd_");
  nom1 += typ;
  Nom discr = discretisation().que_suis_je();
 
  if (typ.debute_par("SOUS_MAILLE") || discr == "VDF_Hyper" || typ.debute_par("LONGUEUR_MELANGE") || (typ == "K_Epsilon_V2"))
    {
      if (dimension == 2 && discr != "VDF_Hyper")
        {
          Cerr << "You are solving a turbulent case in 2D with a subgrid-scale model" << finl;
          Cerr << "Be careful with the interpretation of the results !!" << finl;
        }
 
      nom1 += "_";
      // the diffusion operators are shared between VEF and VEFP1B discretizations
      if (discr == "VEFPreP1B") discr = "VEF";
      nom1 += discr;
    }
  if (nom1 == "MODELE_TURBULENCE_HYD_SOUS_MAILLE_LM_VEF")
    {
      Cerr << "The keyword Sous_maille_LM is now called Longueur_Melange for consistency between VDF and VEF." << finl;
      Cerr << "Please update your data file." << finl;
      Process::exit();
    }
 
  Cerr << nom1 << finl;
 
  le_modele_turbulence.typer(nom1);
  le_modele_turbulence->associer_eqn(*this);
  le_modele_turbulence->associer(domaine_dis(), domaine_Cl_dis());
  s >> le_modele_turbulence.valeur(); // read it!
 
  le_modele_turbulence->discretiser();
  RefObjU le_modele;
  le_modele = le_modele_turbulence.valeur();
  liste_modeles_.add_if_not(le_modele);
 
  return 1;
}
 
const Champ_Don_base& Navier_Stokes_IBM_Turbulent::diffusivite_pour_transport() const
{
  return fluide().viscosite_cinematique();
}
 
const Champ_base& Navier_Stokes_IBM_Turbulent::diffusivite_pour_pas_de_temps() const
{
  return fluide().viscosite_cinematique();
}
 
// Reading and typing of the turbulent diffusion operator.
// Note: "terme_diffusif.associer_diffusivite" must have been called before entering here.
Entree& Navier_Stokes_IBM_Turbulent::lire_op_diff_turbulent(Entree& is)
{
  Motcle accouverte = "{", accfermee = "}";
  Nom type = "Op_Dift_";
 
  Nom discr = discretisation().que_suis_je();
  // diffusion operators are shared between VEF and VEFP1B discretisations
  if (discr == "VEFPreP1B") discr = "VEF";
 
  type += discr;
 
  Nom nb_inc;
  if (terme_diffusif.diffusivite().nb_comp() == 1)
    nb_inc = "_";
  else
    nb_inc = "_Multi_inco_";
  type += nb_inc;
 
  Nom type_inco = inconnue().que_suis_je();
  if (type_inco == "Champ_Q1_EF") type += "Q1";
  else type += (type_inco.suffix("Champ_"));
 
  if (axi) type += "_Axi";
 
  Motcle motbidon;
  is >> motbidon;
  if (motbidon != accouverte)
    {
      Cerr << "A { was expected while reading the turbulent diffusive term" << finl;
      Process::exit();
    }
  is >> motbidon;
  if (motbidon == "negligeable")
    {
      type = "Op_Dift_negligeable";
      terme_diffusif.typer(type);
      terme_diffusif.l_op_base().associer_eqn(*this);
      terme_diffusif->associer_diffusivite(terme_diffusif.diffusivite());
      is >> motbidon;
      //read the closing brace of diffusion { }
      if (motbidon != accfermee)
        Cerr << " No options can be entered after negligeable " << finl;
    }
  else if (motbidon == "tenseur_Reynolds_externe")
    {
      terme_diffusif.typer(type);
      terme_diffusif.l_op_base().associer_eqn(*this);
      Cerr << terme_diffusif->que_suis_je() << finl;
      terme_diffusif->associer_diffusivite(terme_diffusif.diffusivite());
      is >> motbidon;
      //read the closing brace of diffusion { }
      if (motbidon != accfermee)
        Cerr << " No options can be entered after tenseur_Reynolds_externe " << finl;
    }
  else if (motbidon == "standard")
    {
      type += "_standard";
      terme_diffusif.typer(type);
      terme_diffusif.l_op_base().associer_eqn(*this);
      terme_diffusif->associer_diffusivite(terme_diffusif.diffusivite());
      is >> terme_diffusif.valeur();
    }
  else if (motbidon == accfermee)
    {
      terme_diffusif.typer(type);
      terme_diffusif.l_op_base().associer_eqn(*this);
      Cerr << terme_diffusif->que_suis_je() << finl;
      terme_diffusif->associer_diffusivite(terme_diffusif.diffusivite());
    }
  else if (motbidon == "stab")
    {
      type += "_stab";
      terme_diffusif.typer(type);
      terme_diffusif.l_op_base().associer_eqn(*this);
      terme_diffusif->associer_diffusivite(terme_diffusif.diffusivite());
      is >> terme_diffusif.valeur();
    }
  else if (motbidon == "option")
    {
      type += "option";
      if (discr == "EF")
        type = "Op_Dift_EF_Q1_option";
      terme_diffusif.typer(type);
      Cerr << terme_diffusif->que_suis_je() << finl;
      terme_diffusif.l_op_base().associer_eqn(*this);
      terme_diffusif->associer_diffusivite(terme_diffusif.diffusivite());
      is >> terme_diffusif.valeur();
      is >> motbidon;
      //read the closing brace of diffusion { }
      if (motbidon != accfermee)
        Cerr << " No options can be entered after option " << finl;
    }
  else
    {
      type += motbidon;
      is >> motbidon;
      if (motbidon != accfermee)
        Cerr << " No option are now readable for the turbulent diffusive term" << finl;
 
      if (discr == "VEF")
        type += "_P1NC";
      terme_diffusif.typer(type);
      terme_diffusif.l_op_base().associer_eqn(*this);
      Cerr << terme_diffusif->que_suis_je() << finl;
      terme_diffusif->associer_diffusivite(terme_diffusif.diffusivite());
    }
  return is;
}
 
/*! @brief Prepares the computation.
 *
 * @brief Simple call to Modele_turbulence_hyd_base->preparer_calcul() on the turbulence member.
 *
 * @return Always returns 1.
 */
int Navier_Stokes_IBM_Turbulent::preparer_calcul()
{
 
  Turbulence_paroi_base& loipar = le_modele_turbulence->loi_paroi();
  if (le_modele_turbulence->has_loi_paroi_hyd())
    loipar.init_lois_paroi();
 
  Navier_Stokes_IBM::preparer_calcul();
  le_modele_turbulence->preparer_calcul();
  return 1;
}
 
bool Navier_Stokes_IBM_Turbulent::initTimeStep(double dt)
{
  bool ok = Navier_Stokes_IBM::initTimeStep(dt);
  ok = ok && le_modele_turbulence->initTimeStep(dt);
  return ok;
}
 
/*! @brief for PDI IO: retrieve name, type and dimensions of the fields to save/restore
 *
 */
std::vector<YAML_data> Navier_Stokes_IBM_Turbulent::data_a_sauvegarder() const
{
  std::vector<YAML_data> data = Navier_Stokes_IBM::data_a_sauvegarder();
  std::vector<YAML_data> mod_turb = le_modele_turbulence->data_a_sauvegarder();
  data.insert(data.end(), mod_turb.begin(), mod_turb.end());
  return data;
}
 
/*! @brief Saves the equation (and its turbulence model) to an output stream.
 *
 * @param os The output stream.
 * @return Always returns 1.
 */
int Navier_Stokes_IBM_Turbulent::sauvegarder(Sortie& os) const
{
  int bytes = 0;
  bytes += Navier_Stokes_IBM::sauvegarder(os);
  assert(bytes % 4 == 0);
  bytes += le_modele_turbulence->sauvegarder(os);
  assert(bytes % 4 == 0);
  return bytes;
}
 
/*! @brief Restores the equation and its turbulence model from an input stream.
 *
 * @param is The input stream.
 * @return Always returns 1.
 * @throws End of file encountered during restart.
 */
int Navier_Stokes_IBM_Turbulent::reprendre(Entree& is)
{
  Navier_Stokes_IBM::reprendre(is);
  if(!TRUST_2_PDI::is_PDI_restart())
    {
      double temps = schema_temps().temps_courant();
      Nom ident_modele(le_modele_turbulence->que_suis_je());
      ident_modele += probleme().domaine().le_nom();
      ident_modele += Nom(temps, probleme().reprise_format_temps());
 
      if (probleme().discretisation().is_poly_family())
        {
          Nom field_tag_syno = create_polymacfamily_syno(ident_modele);
          avancer_fichier_with_syno(is,ident_modele,field_tag_syno);
        }
      // end of the backward compatibility
      else
        avancer_fichier(is,ident_modele);
    }
  le_modele_turbulence->reprendre(is);
 
  return 1;
}
 
/*! @brief Successive calls to: Navier_Stokes_IBM::completer()
 *
 *       Mod_Turb_Hyd::completer() [on the relevant member]
 *
 */
void Navier_Stokes_IBM_Turbulent::completer()
{
  Navier_Stokes_IBM::completer();
  le_modele_turbulence->completer();
  le_modele_turbulence->loi_paroi().completer();
}
 
/*! @brief Performs a time update of the equation.
 *
 * @param temps The update time.
 */
void Navier_Stokes_IBM_Turbulent::mettre_a_jour(double temps)
{
  Navier_Stokes_IBM::mettre_a_jour(temps);
  le_modele_turbulence->mettre_a_jour(temps);
}
 
bool Navier_Stokes_IBM_Turbulent::has_champ(const Motcle& nom, OBS_PTR(Champ_base)& ref_champ) const
{
  if (Navier_Stokes_IBM::has_champ(nom, ref_champ))
    return true;
 
  if (le_modele_turbulence)
    if (le_modele_turbulence->has_champ(nom, ref_champ))
      return true;
 
  return false; /* nothing found */
}
 
bool Navier_Stokes_IBM_Turbulent::has_champ(const Motcle& nom) const
{
  if (Navier_Stokes_IBM::has_champ(nom))
    return true;
 
  if (le_modele_turbulence)
    if (le_modele_turbulence->has_champ(nom))
      return true;
 
  return false; /* nothing found */
}
 
const Champ_base& Navier_Stokes_IBM_Turbulent::get_champ(const Motcle& nom) const
{
  OBS_PTR(Champ_base) ref_champ;
 
  if (Navier_Stokes_IBM::has_champ(nom, ref_champ))
    return ref_champ;
 
  if (le_modele_turbulence)
    if (le_modele_turbulence->has_champ(nom, ref_champ))
      return ref_champ;
 
  throw std::runtime_error(std::string("Field ") + nom.getString() + std::string(" not found !"));
}
 
void Navier_Stokes_IBM_Turbulent::get_noms_champs_postraitables(Noms& nom, Option opt) const
{
  Navier_Stokes_IBM::get_noms_champs_postraitables(nom, opt);
  if (le_modele_turbulence)
    le_modele_turbulence->get_noms_champs_postraitables(nom, opt);
}
 
void Navier_Stokes_IBM_Turbulent::imprimer(Sortie& os) const
{
  Navier_Stokes_IBM::imprimer(os);
  le_modele_turbulence->imprimer(os);
}
 
const RefObjU& Navier_Stokes_IBM_Turbulent::get_modele(Type_modele type) const
{
  for (const auto &itr : liste_modeles_)
    {
      const RefObjU& mod = itr;
      if (mod)
        if ((sub_type(Modele_turbulence_hyd_base, mod.valeur())) && (type == TURBULENCE))
          return mod;
    }
  return Equation_base::get_modele(type);
}
 
void Navier_Stokes_IBM_Turbulent::creer_champ(const Motcle& motlu)
{
  Navier_Stokes_IBM::creer_champ(motlu);
 
  if (le_modele_turbulence) le_modele_turbulence->creer_champ(motlu);
}
 
void Navier_Stokes_IBM_Turbulent::imprime_residu(SFichier& fic)
{
  Equation_base::imprime_residu(fic);
}
 
Nom Navier_Stokes_IBM_Turbulent::expression_residu()
{
  Nom tmp = Equation_base::expression_residu();
  return tmp;
}