Correction_Tomiyama_PolyMAC_MPFA.cpp

/****************************************************************************
* Copyright (c) 2025, 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 <Correction_Tomiyama_PolyMAC_MPFA.h>
#include <Champ_Face_PolyMAC_MPFA.h>
#include <Milieu_composite.h>
#include <Pb_Multiphase.h>
#include <math.h>
 
Implemente_instanciable(Correction_Tomiyama_PolyMAC_MPFA, "Correction_Tomiyama_Face_PolyMAC_MPFA", Source_base);
// XD Correction_Tomiyama source_base Correction_Tomiyama BRACE Tomiyama correction source term for multiphase problem
 
Sortie& Correction_Tomiyama_PolyMAC_MPFA::printOn(Sortie& os) const
{
  return os;
}
 
Entree& Correction_Tomiyama_PolyMAC_MPFA::readOn(Entree& is)
{
  Param param(que_suis_je());
  param.ajouter("secu_diam", &secu_diam_);
  param.lire_avec_accolades_depuis(is);
 
  //identification of phases
  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!");
  for (int n = 0; n < pbm->nb_phases(); n++) //search for n_l, n_g : {liquid,gas}_continu phase with 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!");
 
  pbm->creer_champ("distance_paroi_globale"); // Need the wall distance field
 
  return is;
}
 
void Correction_Tomiyama_PolyMAC_MPFA::completer() // We must wait for all readOn's to be sure that the bubble dispersion and lift correlations are created
{
  const Pb_Multiphase& pbm = ref_cast(Pb_Multiphase, equation().probleme());
 
  if (!pbm.has_champ("diametre_bulles")) Process::exit("Correction_Lubchenko_PolyMAC_MPFA::completer() : a bubble diameter must be defined !");
}
 
void Correction_Tomiyama_PolyMAC_MPFA::ajouter_blocs(matrices_t matrices, DoubleTab& secmem, const tabs_t& semi_impl) const
{
  const Champ_Face_PolyMAC_MPFA& ch = ref_cast(Champ_Face_PolyMAC_MPFA, equation().inconnue());
  const Milieu_composite& milc = ref_cast(Milieu_composite, equation().milieu());
  const DoubleTab& pvit = ch.passe(),
                   &alpha = ref_cast(Pb_Multiphase, equation().probleme()).equation_masse().inconnue().passe(),
                    &rho   = equation().milieu().masse_volumique().passe(),
                     &d_bulles = equation().probleme().get_champ("diametre_bulles").valeurs();
  const Domaine_VF& domaine = ref_cast(Domaine_VF, equation().domaine_dis());
  const IntTab& f_e = domaine.face_voisins(),
                &fcl = ch.fcl();
  const DoubleVect& pe = equation().milieu().porosite_elem(),
                    &pf = equation().milieu().porosite_face(),
                     &ve = domaine.volumes(),
                      &vf = domaine.volumes_entrelaces(),
                       &fs = domaine.face_surfaces();
  const DoubleTab& vf_dir = domaine.volumes_entrelaces_dir(),
                   &n_f = domaine.face_normales(),
                    &y_elem = domaine.y_elem(),
                     &y_faces = domaine.y_faces(),
                      &n_y_elem = domaine.normale_paroi_elem(),
                       &n_y_faces = domaine.normale_paroi_faces();
  int N = pvit.line_size() ,
      D = dimension,
      nf_tot = domaine.nb_faces_tot(),
      nf = domaine.nb_faces(),
      ne_tot = domaine.nb_elem_tot();
 
  DoubleTrav dv(N, N), pvit_l(N,D), scal_u(N), sigma_l(N,ne_tot) ;
  int e, f, c, k, d, i;
 
  double fac, a_l, rho_l, rho_k, db_l, secmem_l, Eo, Cw, dist, correction, sig_face;
 
  // And for the span methods of the Saturation class
  for (k = 0; k < N; k++)
    {
      if (milc.has_saturation(k, n_l))
        {
          const Saturation_base& z_sat = milc.get_saturation(k, n_l);
          const DoubleTab& sig = z_sat.get_sigma_tab();
          for (int ii = 0; ii < ne_tot; ii++) sigma_l(k,ii) = sig(ii);
        }
      else if (milc.has_interface(k, n_l))
        {
          Interface_base& sat = milc.get_interface(k,n_l);
          const DoubleTab& sig = sat.get_sigma_tab();
          for (int ii = 0; ii < ne_tot; ii++) sigma_l(k,ii) = sig(ii);
        }
    }
 
  for (f = 0; f < nf; f++)
    if (fcl(f, 0) < 2)
      {
        // Calculation of correct velocity at the face
        pvit_l = 0 ;
        for (d = 0 ; d<D ; d++)
          for (k = 0 ; k<N ; k++)
            for (c=0 ; c<2 && (e = f_e(f, c)) >= 0; c++)
              pvit_l(k, d) += vf_dir(f, c)/vf(f)*pvit(nf_tot+D*e+d, k) ;
        scal_u = 0;
        for (k = 0 ; k<N ; k++)
          for (d = 0 ; d<D ; d++)
            scal_u(k) += pvit_l(k, d)*n_f(f, d)/fs(f);
        for (k = 0 ; k<N ; k++)
          for (d = 0 ; d<D ; d++)
            pvit_l(k, d) += (pvit(f, k) - scal_u(k)) * n_f(f, d)/fs(f) ;
 
        // Retract component normal to the wall
        scal_u = 0;
        for (k = 0 ; k<N ; k++)
          for (d = 0 ; d<D ; d++)
            scal_u(k) += pvit_l(k, d)*n_y_faces(f, d);
        for (k = 0 ; k<N ; k++)
          for (d = 0 ; d<D ; d++)
            pvit_l(k, d) -= scal_u(k)*n_y_faces(f, d) ;
 
        // Calculation of liquid-gas velocity difference
        dv = 0.;
        for ( k = 0; k < N; k++)
          if (k != n_l)
            {
              for (d = 0 ; d<D ; d++)  dv(k, n_l) += (pvit_l(k, d)-pvit_l(n_l, d)) * (pvit_l(k, d)-pvit_l(n_l, d));
              dv(k, n_l) = std::sqrt(dv(k, n_l));
            }
 
        for (k = 0; k < N; k++)
          if (k != n_l)
            {
              fac = 0 ;
              for (d = 0 ; d<D ; d++) fac += n_y_faces(f, d) * n_f(f, d)/fs(f);
 
              fac *= pf(f) * vf(f) ;
              a_l = (    alpha(f_e(f, 0), k)*vf_dir(f,0) +    ((e = f_e(f, 1))>0 ? alpha(e, k)*vf_dir(f,1) : 0)  ) / vf(f);
              rho_l=(    rho(f_e(f, 0), n_l)*vf_dir(f,0) +    ((e = f_e(f, 1))>0 ? rho(e, n_l)*vf_dir(f,1) : 0)  ) / vf(f);
              rho_k=(    rho(f_e(f, 0), k)*vf_dir(f,0) +    ((e = f_e(f, 1))>0 ? rho(e, k)*vf_dir(f,1) : 0)  ) / vf(f);
              db_l= ( d_bulles(f_e(f, 0), k)*vf_dir(f,0) +    ((e = f_e(f, 1))>0 ? d_bulles(e, k)*vf_dir(f,1):0) ) / vf(f);
              sig_face = (sigma_l(k,f_e(f, 0)) * vf_dir(f,0)  +  ((e = f_e(f, 1))>0 ? sigma_l(k,e)*vf_dir(f,1) : 0)  ) / vf(f) ;
 
              Eo = ( rho_l - rho_k ) * g_ * 2. * db_l / sig_face ;
 
              dist = std::max(y_faces(f), secu_diam_ * db_l);
              correction = std::max(1.- y_faces(f)/db_l, 0.) ;
 
              if (Eo < 1.) {Cw = 0.74 ;}
              else if (Eo < 5.) {Cw = exp(-0.933 * Eo + 0.179) ;}
              else if (Eo < 33.) {Cw = 0.00599 * Eo -0.187 ;}
              else {Cw = 0.179 ;}
 
              secmem_l = fac * a_l * rho_l * dv(k,n_l) * dv(k,n_l) * db_l / 2. * Cw / dist / dist * correction  ;
 
              secmem(f, k)   += secmem_l;
              secmem(f, n_l) -= secmem_l;
            }
 
      }
 
  for ( e = 0; e < ne_tot; e++)
    {
      pvit_l = 0;
      // Fill velocity at the element
      for (d = 0 ; d<D ; d++)
        for (k = 0 ; k<N ; k++)
          pvit_l(k, d) += pvit(nf_tot+D*e+d, k) ;
 
      // Retract component normal to the wall
      scal_u = 0;
      for (k = 0 ; k<N ; k++)
        for (d = 0 ; d<D ; d++)
          scal_u(k) += pvit_l(k, d)*n_y_elem(e, d);
      for (k = 0 ; k<N ; k++)
        for (d = 0 ; d<D ; d++)
          pvit_l(k, d) -= scal_u(k)*n_y_elem(e, d) ;
 
      // Calculation of norm of velocity
      dv = 0.;
      for ( k = 0; k < N; k++)
        if (k != n_l)
          {
            for (d = 0 ; d<D ; d++)  dv(k, n_l) +=  (pvit_l(k, d)-pvit_l(n_l, d)) * (pvit_l(k, d)-pvit_l(n_l, d));
            dv(k, n_l) = std::sqrt(dv(k, n_l));
          }
 
      for (k = 0; k < N; k++)
        if (k != n_l)
          {
            fac = pe(e) * ve(e) ;
            Eo = ( rho(e, n_l) - rho(e, k) ) * g_ * 2. * d_bulles(e, k) / sigma_l(k,e) ;
 
 
            dist = std::max(y_elem(e), secu_diam_ * d_bulles(e, k)); // numerical safety threshold
            correction = std::max(1.- y_elem(e)/d_bulles(e, k), 0.) ;
 
            if (Eo < 1.) {Cw = 0.74 ;}
            else if (Eo < 5.) {Cw = exp(-0.933 * Eo + 0.179) ;}
            else if (Eo < 33.) {Cw = 0.00599 * Eo -0.187 ;}
            else {Cw = 0.179 ;}
 
            secmem_l = fac * alpha(e,k) * rho(e,n_l) * dv(k,n_l) * dv(k,n_l) * d_bulles(e, k) / 2. * Cw / dist / dist * correction  ;
 
            for ( d = 0, i = nf_tot + D * e; d < D; d++, i++)
              {
                secmem(i , k)   += secmem_l * n_y_elem(e, d);
                secmem(i , n_l) -= secmem_l * n_y_elem(e, d);
              }
          }
    }
}