Source_Portance_interfaciale_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 <Source_Portance_interfaciale_base.h>
#include <Portance_interfaciale_base.h>
#include <Pb_Multiphase.h>
#include <Discret_Thyd.h>
 
Implemente_base(Source_Portance_interfaciale_base, "Source_Portance_interfaciale_base", Sources_Multiphase_base);
// XD Portance_interfaciale source_base Portance_interfaciale BRACE Base class for source term of lift force in momentum
// XD_CONT equation.
// XD attr beta floattant beta OPT Multiplying factor for the bubble lift force source term.
 
Sortie& Source_Portance_interfaciale_base::printOn(Sortie& os) const { return os; }
 
Entree& Source_Portance_interfaciale_base::readOn(Entree& is)
{
  Param param(que_suis_je());
  param.ajouter("beta", &beta_);
  param.ajouter("g", &g_);
  param.lire_avec_accolades_depuis(is);
 
  Pb_Multiphase *pbm = sub_type(Pb_Multiphase, equation().probleme()) ? &ref_cast(Pb_Multiphase, equation().probleme()) : nullptr;
 
  if (!pbm || pbm->nb_phases() == 1) Process::exit(que_suis_je() + " : not needed for single-phase flow!");
 
  const bool res_en_T = pbm ? pbm->resolution_en_T() : true;
  if (!res_en_T) Process::exit("Source_Portance_interfaciale_base::readOn NOT YET PORTED TO ENTHALPY EQUATION ! TODO FIXME !!");
 
  for (int n = 0; n < pbm->nb_phases(); n++) // search for n_l, n_g: {liquid,gas}_continuous phase in priority
    if (pbm->nom_phase(n).debute_par("liquide") && (n_l < 0 || pbm->nom_phase(n).finit_par("continu")))  n_l = n;
 
  if (n_l < 0) Process::exit(que_suis_je() + " : liquid phase not found!");
 
  if (pbm->has_correlation("Portance_interfaciale")) correlation_ = pbm->get_correlation("Portance_interfaciale"); // correlation provided by the correlation block
  else Correlation_base::typer_lire_correlation(correlation_, (*pbm), "Portance_interfaciale", is); // otherwise read it
 
  pbm->creer_champ("vorticite"); // vorticity is needed
 
  return is;
}
 
void Source_Portance_interfaciale_base::creer_champ(const Motcle& motlu)
{
  if (motlu == "wobble")
    if (!wobble)
      {
        Pb_Multiphase& pb = ref_cast(Pb_Multiphase, equation().probleme());
        int N = pb.nb_phases();
        const Discret_Thyd& dis=ref_cast(Discret_Thyd,pb.discretisation());
        Noms noms(N), unites(N);
        noms[0] = "wobble";
        unites[0] = "none";
        Motcle typeChamp = "champ_elem" ;
        const Domaine_dis_base& z = pb.domaine_dis();
        dis.discretiser_champ(typeChamp, z, scalaire, noms , unites, N, 0, wobble);
        champs_compris_.ajoute_champ(wobble);
      }
  if (motlu == "C_lift")
    if (!C_lift)
      {
        Pb_Multiphase& pb = ref_cast(Pb_Multiphase, equation().probleme());
        int N = pb.nb_phases();
        const Discret_Thyd& dis=ref_cast(Discret_Thyd,pb.discretisation());
        Noms noms(N), unites(N);
        noms[0] = "C_lift";
        unites[0] = "none";
        Motcle typeChamp = "champ_elem" ;
        const Domaine_dis_base& z = pb.domaine_dis();
        dis.discretiser_champ(typeChamp, z, scalaire, noms , unites, N, 0, C_lift);
        champs_compris_.ajoute_champ(C_lift);
      }
}
 
void Source_Portance_interfaciale_base::completer()
{
  if (wobble && !equation().probleme().has_champ("diametre_bulles")) Process::exit(que_suis_je() + " : there must be a bubble diameter field for there to be a wobble number !!") ;
  if (wobble && !equation().probleme().has_champ("k")) Process::exit(que_suis_je() + " : there must be a turbulent kinetic energy field for there to be a wobble number !!") ;
}