Pb_Cahn_Hilliard_Navier_Stokes.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 <Pb_Cahn_Hilliard_Navier_Stokes.h>
#include <Schema_Cahn_Hilliard_Navier_Stokes.h>
 
// XD pb_cahn_hilliard_navier_stokes pb_base pb_cahn_hilliard_navier_stokes INHERITS_BRACE Problem coupling the
// XD_CONT Cahn-Hilliard phase-field equation with a variable-density Navier-Stokes flow.
// XD attr Milieu_Incompressible_Phase_Field bloc_lecture Milieu_Incompressible_Phase_Field REQ Phase-field
// XD_CONT incompressible medium (rho, mu, beta_co, fermeture, …).
// XD attr Navier_Stokes_Variable_Density bloc_lecture Navier_Stokes_Variable_Density OPT Variable-density Navier-Stokes
// XD_CONT equation block (pressure solver, convection, diffusion, boundary conditions, …). Use this variant or
// XD_CONT Navier_Stokes_standard.
// XD attr Navier_Stokes_standard bloc_lecture Navier_Stokes_standard OPT Constant-density (standard) Navier-Stokes
// XD_CONT equation block. Use this variant or Navier_Stokes_Variable_Density.
// XD attr Cahn_Hilliard_Convection bloc_lecture Cahn_Hilliard_Convection REQ Cahn-Hilliard transport equation with
// XD_CONT convection (convection, boundary conditions on c and on the chemical potential, …).
Implemente_instanciable( Pb_Cahn_Hilliard_Navier_Stokes, "Pb_Cahn_Hilliard_Navier_Stokes", Pb_Fluide_base ) ;
 
Sortie& Pb_Cahn_Hilliard_Navier_Stokes::printOn( Sortie& os ) const
{
  Pb_Fluide_base::printOn( os );
  return os;
}
 
Entree& Pb_Cahn_Hilliard_Navier_Stokes::readOn( Entree& is )
{
  Pb_Fluide_base::readOn( is );
  return is;
}
 
const Equation_base& Pb_Cahn_Hilliard_Navier_Stokes::equation(int i) const
{
  assert((i == 0) || (i == 1));
  if (nb_equations == 2 && i == 0)
    return eq_navier_stokes;
  else
    return eq_cahn_hilliard;
}
 
Equation_base& Pb_Cahn_Hilliard_Navier_Stokes::equation(int i)
{
  assert((i == 0) || (i == 1));
  if (nb_equations == 2 && i == 0)
    return eq_navier_stokes;
  else
    return eq_cahn_hilliard;
}
 
Entree& Pb_Cahn_Hilliard_Navier_Stokes::lire_equations(Entree& is, Motcle& mot)
{
//  Pb_Fluide_base::lire_equations(is, mot);
  nb_equations = 2; // we can set the number of equations because, now, the Navier-Stokes equation will be typed
  const int nb_eq = nombre_d_equations();
  is >> mot;
  if (nb_eq == 0)
    return is;
  Cerr << "Reading of the equations" << finl;
  bool already_read = true;
  if (mot == "correlations")
    {
      lire_correlations(is);
      already_read = false;
    }
  for (int i = 0; i < nb_eq; i++)
    {
      if (!already_read)
        is >> mot;
      if (mot.debute_par("Navier_Stokes"))
        {
          Cout << "[Pb_Cahn_Hilliard_Navier_Stokes]: the selected Navier-Stokes equations is " << mot << finl;
          // here, we have to do the for the selected Navier-Stokes equation in the same ways as for an optional equation (see Probleme_base::read_optional_equations)
          eq_navier_stokes.typer(mot);
          eq_navier_stokes->associer_pb_base(*this);
          eq_navier_stokes->associer_milieu_base(le_milieu_[0]);
          const Schema_Temps_base& schema_convection = ref_cast(Schema_Cahn_Hilliard_Navier_Stokes, le_schema_en_temps_.valeur()).get_schema_convection();
          eq_navier_stokes->associer_sch_tps_base(schema_convection);
          eq_navier_stokes->associer_domaine_dis(domaine_dis());
          eq_navier_stokes->discretiser();
          is >> eq_navier_stokes.valeur();
          eq_navier_stokes->associer_milieu_equation();
        }
      else
        {
          is >> getset_equation_by_name(mot);
        }
      already_read = false;
    }
  read_optional_equations(is, mot);
  //
  // the two source terms that are associated with the coupling with Cahn-Hilliard equation are added in the Navier-Stokes equation source term list
  Cout << "[Pb_Cahn_Hilliard_Navier_Stokes]: adding capillary force in Navier-Stokes equation"<< finl;
  Source force_capillaire;
  Source& ref_force_capillaire = eq_navier_stokes->sources().add(force_capillaire);
  ref_force_capillaire.typer("Source_Force_Capillaire", eq_navier_stokes);
  ref_force_capillaire->associer_eqn(eq_navier_stokes);
  if (milieu().a_gravite())
    {
      Cout << "[Pb_Cahn_Hilliard_Navier_Stokes]: adding gravity force in Navier-Stokes equation"<< finl;
      Source force_gravite;
      Source& ref_force_gravite = eq_navier_stokes->sources().add(force_gravite);
      if (sub_type(Navier_Stokes_Variable_Density, eq_navier_stokes.valeur()))
        {
          ref_force_gravite.typer("Gravite", eq_navier_stokes);
        }
      else
        {
          ref_force_gravite.typer("Source_Force_Boussinesq", eq_navier_stokes);
        }
      ref_force_gravite->associer_eqn(eq_navier_stokes);
    }
  return is;
}