Schema_Phase_field.cpp

/****************************************************************************
* Copyright (c) 2021, 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_Con_Phase_field_base.h>
#include <Navier_Stokes_phase_field.h>
#include <Milieu_Phase_field.h>
#include <Schema_Phase_field.h>
#include <Equation_base.h>
#include <Probleme_base.h>
#include <Param.h>
 
Implemente_instanciable(Schema_Phase_field,"Schema_Phase_field",Schema_Temps_base);
// XD schema_phase_field schema_temps_base schema_phase_field INHERITS_BRACE Keyword for the only available Scheme for
// XD_CONT time discretization of the Phase Field problem.
// XD attr schema_ch schema_temps_base schema_ch OPT Time scheme for the Cahn-Hilliard equation.
// XD attr schema_ns schema_temps_base schema_ns OPT Time scheme for the Navier-Stokes equation.
 
Sortie& Schema_Phase_field::printOn(Sortie& s) const { return Schema_Temps_base::printOn(s); }
 
Entree& Schema_Phase_field::readOn(Entree& s) { return Schema_Temps_base::readOn(s); }
 
/*! @brief Renvoie le nombre de valeurs temporelles a conserver.
 *
 * Ici : le max des deux schemas utilises.
 *
 */
int Schema_Phase_field::nb_valeurs_temporelles() const
{
  return std::max(sch_CH_->nb_valeurs_temporelles(), sch_NS_->nb_valeurs_temporelles());
}
 
/*! @brief Renvoie le nombre de valeurs temporelles futures.
 *
 * Ici : la valeur commune aux deux schemas utilises.
 *
 */
int Schema_Phase_field::nb_valeurs_futures() const
{
  int n = sch_CH_->nb_valeurs_futures();
  assert(n == sch_NS_->nb_valeurs_futures());
  return n;
}
 
/*! @brief Renvoie le le temps a la i-eme valeur future.
 *
 * Ici : la valeur commune aux deux schemas utilises.
 *
 */
double Schema_Phase_field::temps_futur(int i) const
{
  double t = sch_CH_->temps_futur(i);
  assert(est_egal(t, sch_NS_->temps_futur(i), pas_temps_min()));
  return t;
}
 
/*! @brief Renvoie le le temps le temps que doivent rendre les champs a l'appel de valeurs()
 *
 *     Ici : la valeur commune aux deux schemas utilises.
 *
 */
double Schema_Phase_field::temps_defaut() const
{
  double t = sch_CH_->temps_defaut();
  assert(est_egal(t, sch_NS_->temps_defaut(), pas_temps_min()));
  return t;
}
 
/////////////////////////////////////////
//                                     //
// Fin des caracteristiques du schema  //
//                                     //
/////////////////////////////////////////
 
void Schema_Phase_field::initialize()
{
  sch_CH_->initialize();
  sch_NS_->initialize();
  Schema_Temps_base::initialize();
}
 
bool Schema_Phase_field::initTimeStep(double dt)
{
  sch_CH_->initTimeStep(dt);
  sch_NS_->initTimeStep(dt);
  return Schema_Temps_base::initTimeStep(dt);
}
 
/*! @brief Mise a jour du temps courant (t+=dt) et du nombre de pas de temps effectue (nb_pas_dt_++).
 *
 * @return (int) retourne mettre_a_jour de la classe mere
 */
int Schema_Phase_field::mettre_a_jour()
{
  sch_CH_->mettre_a_jour();
  sch_NS_->mettre_a_jour();
 
  return Schema_Temps_base::mettre_a_jour();
}
 
/*! @brief Appel a l'objet sous-jacent Change le temps courant
 *
 * @param (double& t) la nouvelle valeur du temps courant
 */
void Schema_Phase_field::changer_temps_courant(const double t)
{
  sch_CH_->changer_temps_courant(t);
  sch_NS_->changer_temps_courant(t);
 
  Schema_Temps_base::changer_temps_courant(t);
}
 
/*! @brief Appel a l'objet sous-jacent Renvoie 1 si il y lieu de stopper le calcul pour differente raisons:
 *
 *         - le temps final est atteint
 *         - le nombre de pas de temps maximum est depasse
 *         - l'etat stationnaire est atteint
 *         - indicateur d'arret fichier
 *     Renvoie 0 sinon
 *
 * @return (entier) 1 si il y a lieu de s'arreter 0 sinon
 */
int Schema_Phase_field::stop() const
{
  int ls2 = sch_CH_->stop();
  int ls3 = sch_NS_->stop();
 
  return (ls2 | ls3 | Schema_Temps_base::stop());
}
 
/*! @brief Appel a l'objet sous-jacent Imprime le schema en temp sur un flot de sortie (si il y a lieu).
 *
 * @param (Sortie& os) le flot de sortie
 */
void Schema_Phase_field::imprimer(Sortie& os) const
{
  sch_CH_->imprimer(os);
  sch_NS_->imprimer(os);
 
  Schema_Temps_base::imprimer(os);
}
 
/*! @brief Corrige le pas de temps dt_min <= dt <= dt_max
 *
 * @return (int) 1 si il faut faire une sauvegarde 0 sinon
 * @return (int) retourne corriger_pas_temps de la classe mere
 */
bool Schema_Phase_field::corriger_dt_calcule(double& dt) const
{
  bool ok = sch_CH_->corriger_dt_calcule(dt);
  ok = ok && sch_NS_->corriger_dt_calcule(dt);
  ok = ok && Schema_Temps_base::corriger_dt_calcule(dt);
  return ok;
}
 
/*! @brief Complete les attributs de sch2
 *
 * @return retourne toujours 1
 */
void Schema_Phase_field::completer()
{
  Schema_Temps_base& le_sch2 = sch_CH_.valeur();
  le_sch2.set_temps_init() = temps_init();
  le_sch2.set_temps_max() = temps_max();
  le_sch2.set_temps_courant() = temps_courant();
  le_sch2.set_nb_pas_dt() = nb_pas_dt();
  le_sch2.set_nb_pas_dt_max() = nb_pas_dt_max();
  le_sch2.set_dt_min() = pas_temps_min();
  le_sch2.set_dt_max() = pas_temps_max();
  le_sch2.set_dt_sauv() = temps_sauv();
  le_sch2.set_dt_impr() = temps_impr();
  le_sch2.set_facsec() = facteur_securite_pas();
  le_sch2.set_seuil_statio() = seuil_statio();
  le_sch2.set_stationnaire_atteint() = isStationary();
  le_sch2.set_diffusion_implicite() = diffusion_implicite();
  le_sch2.set_seuil_diffusion_implicite() = seuil_diffusion_implicite();
  le_sch2.set_niter_max_diffusion_implicite() = niter_max_diffusion_implicite();
  le_sch2.set_dt() = pas_de_temps();
  le_sch2.set_mode_dt_start() = mode_dt_start();
  le_sch2.set_indice_tps_final_atteint() = indice_tps_final_atteint();
  le_sch2.set_indice_nb_pas_dt_max_atteint() = indice_nb_pas_dt_max_atteint();
  le_sch2.set_lu() = lu();
 
  Schema_Temps_base& le_sch3 = sch_NS_.valeur();
  le_sch3.set_temps_init() = temps_init();
  le_sch3.set_temps_max() = temps_max();
  le_sch3.set_temps_courant() = temps_courant();
  le_sch3.set_nb_pas_dt() = nb_pas_dt();
  le_sch3.set_nb_pas_dt_max() = nb_pas_dt_max();
  le_sch3.set_dt_min() = pas_temps_min();
  le_sch3.set_dt_max() = pas_temps_max();
  le_sch3.set_dt_sauv() = temps_sauv();
  le_sch3.set_dt_impr() = temps_impr();
  le_sch3.set_facsec() = facteur_securite_pas();
  le_sch3.set_seuil_statio() = seuil_statio();
  le_sch3.set_stationnaire_atteint() = isStationary();
  le_sch3.set_diffusion_implicite() = diffusion_implicite();
  le_sch3.set_seuil_diffusion_implicite() = seuil_diffusion_implicite();
  le_sch3.set_niter_max_diffusion_implicite() = niter_max_diffusion_implicite();
  le_sch3.set_dt() = pas_de_temps();
  le_sch3.set_mode_dt_start() = mode_dt_start();
  le_sch3.set_indice_tps_final_atteint() = indice_tps_final_atteint();
  le_sch3.set_indice_nb_pas_dt_max_atteint() = indice_nb_pas_dt_max_atteint();
  le_sch3.set_lu() = lu();
}
 
/*! @brief Lecture du nombre d'iterations pour l'etape de relaxation du Schema_Phase_field
 *
 * @param (const Motcle& mot) un mot cle
 * @param (Entree& is) un flot d'entree
 */
int Schema_Phase_field::lire_motcle_non_standard(const Motcle& mot, Entree& is)
{
  Cerr << "mot=" << mot << finl;
  if (mot == "schema_CH")
    {
      Nom type_sch;
      Cerr << "Lecture du schema utilise dans l'equation Phase_field" << finl;
      is >> type_sch;
      sch_CH_.typer(type_sch);
      is >> sch_CH_.valeur();
    }
  else if (mot == "schema_NS")
    {
      Nom type_sch;
      Cerr << "Lecture du schema utilise dans l'equation Navier-Stokes" << finl;
      is >> type_sch;
      sch_NS_.typer(type_sch);
      is >> sch_NS_.valeur();
    }
  else
    return Schema_Temps_base::lire_motcle_non_standard(mot, is);
  return 1;
 
}
void Schema_Phase_field::set_param(Param& param) const
{
  param.ajouter_non_std("schema_ch", this);
  param.ajouter_non_std("Schema_NS", this);
  Schema_Temps_base::set_param(param);
}
 
/*! @brief Effectue un pas de temps sur l'equation passee en parametre.
 *
 *     Le pas de temps effectue n'est pas standard si l'equation
 *     est de type Convection_Diffusion_Phase_field
 *
 * @param (Equation_base& eqn) l'equation que l'on veut faire avancer d'un pas de temps
 * @return (int) renvoie toujours 1
 */
int Schema_Phase_field::faire_un_pas_de_temps_eqn_base(Equation_base& eqn)
{
  if (eqn.que_suis_je() == "Convection_Diffusion_Phase_field")
    {
      Convection_Diffusion_Phase_field& eq_c = ref_cast(Convection_Diffusion_Phase_field, eqn);
      return faire_un_pas_de_temps_C_D_Phase_field(eq_c);
    }
  else
    {
      Navier_Stokes_phase_field& eq_ns = ref_cast(Navier_Stokes_phase_field, eqn);
      Milieu_Phase_field& mil = ref_cast(Milieu_Phase_field, eq_ns.milieu());
      mil.calculer_rho();
      sch_NS_->set_dt() = pas_de_temps();
      sch_NS_->faire_un_pas_de_temps_eqn_base(eqn);
      set_stationnaire_atteint() = sch_NS_->isStationary();
      return 1;
    }
}
 
/*! @brief faire_un_pas_de_temps_pb_base avec NS = equation(0) et CH = equation(1) Sert a calculer l'equation de Cahn-Hilliard en premier puis Navier-Stokes, en appelant
 *
 *  equation(1) d'abord puis equation(0) pour obtenir les couplages voulus.
 *  (dans le cas nb_eqn=2)
 *
 * @param (Pb_base& eqn) Pb a resoudre
 * @return (int) renvoie toujours 1
 */
bool Schema_Phase_field::iterateTimeStep(bool& converged)
{
  Probleme_base& prob = pb_base();
  double temps = temps_courant_ + dt_;
  int nb_eqn = prob.nombre_d_equations();
  // On resout dans l'ordre inverse des equations du probleme
  for (int i = nb_eqn - 1; i > -1; i--)
    {
      Equation_base& eqn_i = prob.equation(i);
      if (eqn_i.equation_non_resolue())
        {
          Cout << "====================================================" << finl;
          Cout << eqn_i.que_suis_je() << " equation is not solved." << finl;
          Cout << "====================================================" << finl;
          // On calcule une fois la derivee pour avoir les flux bord
          if (eqn_i.schema_temps().nb_pas_dt() == 0)
            {
              DoubleTab inconnue_valeurs(eqn_i.inconnue().valeurs());
              eqn_i.derivee_en_temps_inco(inconnue_valeurs);
            }
        }
      else
        {
          eqn_i.domaine_Cl_dis().mettre_a_jour(temps);
          faire_un_pas_de_temps_eqn_base(eqn_i);
        }
    }
  converged = true;
  return true;
}
 
/*! @brief Effectue un pas de temps sur l'equation de type Convection_Diffusion_Phase_field.
 *
 * @param (Convection_Diffusion_Phase_field& eq_c) l'equation que l'on veut faire avancer d'un pas de temps
 * @return (int) renvoie toujours 1
 */
int Schema_Phase_field::faire_un_pas_de_temps_C_D_Phase_field(Convection_Diffusion_Phase_field& eq_c)
{
  premier_dt(eq_c);
  deuxieme_dt(eq_c);
 
  return 1;
}
 
/*! @brief Effectue le premier demi-pas de temps1 sur l'equation de type Convection_Diffusion_Phase_field.
 *
 * @param (Convection_Diffusion_Phase_field& eq_c) l'equation que l'on veut faire avancer d'un demi-pas de temps
 * @return (int) renvoie toujours 1
 */
int Schema_Phase_field::premier_dt(Convection_Diffusion_Phase_field& eq_c)
{
  Sources& list_sources = eq_c.sources();
  Source_Con_Phase_field_base& source_pf = ref_cast(Source_Con_Phase_field_base, list_sources(0).valeur());
 
  // Calcule c_demi
  source_pf.premier_demi_dt();
 
  return 1;
}
 
/*! @brief Effectue le deuxieme demi-pas de temps sur l'equation de type Convection_Diffusion_Phase_field.
 *
 * @param (Convection_Diffusion_Phase_field& eq_c) l'equation que l'on veut faire avancer d'un demi-pas de temps
 * @return (int) renvoie toujours 1
 */
int Schema_Phase_field::deuxieme_dt(Convection_Diffusion_Phase_field& eq_c)
{
  DoubleTab& present = eq_c.inconnue().valeurs();
  DoubleTab intermediaire(present);
  intermediaire = present;
 
  sch_CH_->set_dt() = pas_de_temps();
 
  present = eq_c.get_c_demi();
  //Cerr << "present = "<<present<<finl;
 
  sch_CH_->faire_un_pas_de_temps_eqn_base(eq_c);
  set_stationnaire_atteint() = sch_CH_->isStationary();
  present = intermediaire;
  //Cerr << "present apres = "<<present<<finl;
 
  return 1;
}
 
void Schema_Phase_field::associer_pb(const Probleme_base& un_probleme)
{
  Schema_Temps_base::associer_pb(un_probleme);
  sch_CH_->associer_pb(un_probleme);
  sch_NS_->associer_pb(un_probleme);
}