Fermeture_Systeme_Naire.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 <Fermeture_Systeme_Naire.h>
#include <Source_Con_Phase_field.h>
#include <Param.h>
 
Implemente_instanciable(Fermeture_Systeme_Naire, "Systeme_Naire|Nary_System", Fermeture_Phase_field_base);
 
Sortie& Fermeture_Systeme_Naire::printOn(Sortie& os) const
{
  return os << que_suis_je() << " " << le_nom() << finl;
}
 
Entree& Fermeture_Systeme_Naire::readOn(Entree& is)
{
  Cerr << "Reading the " << que_suis_je() << " closures ..." << finl;
  type_systeme_naire_ = 1;
 
  Param param(que_suis_je());
  param.ajouter("nb_constituants|nb_equation_CH", &nb_constituants_, Param::REQUIRED);
  param.ajouter("prefacteur_a", &prefactor_, Param::REQUIRED);
  param.ajouter("multiplicateur_de_kappa", &mult_kappa_, Param::REQUIRED);
  param.ajouter_non_std("alpha_rotation", (this), Param::REQUIRED);
  param.ajouter_non_std("potentiel_chimique", (this), Param::REQUIRED);
  param.ajouter_non_std("beta", (this), Param::REQUIRED);
  param.ajouter_non_std("kappa_auto_diffusion", (this), Param::REQUIRED);
  param.lire_avec_accolades_depuis(is);
 
  if (type_kappa_auto_diffusion_ == 1)
    kappa_ind_ = 1;
  else if (type_kappa_auto_diffusion_ == 0)
    kappa_ind_ = 0;
 
  return is;
}
 
int Fermeture_Systeme_Naire::lire_motcle_non_standard(const Motcle& mot, Entree& is)
{
  Motcle motlu;
  if (mot == "alpha_rotation")
    {
      assert(nb_constituants_ > -1);
      is >> motlu;
      if (motlu == "oui")
        {
          alphaMatrix_.resize(nb_constituants_ * nb_constituants_);
          type_alpha_rotation_ = 1;
 
          if (nb_constituants_ == 2)
            {
              Param param("lire_alpha_rotation");
              param.ajouter("alpha_ref", &alpha_ref_, Param::REQUIRED);
              param.ajouter("rotation_angle", &angle_alphaMatrix_, Param::REQUIRED);
              param.ajouter("diagonal_coefficient", &diagonal_coeff_, Param::REQUIRED);
              param.lire_avec_accolades_depuis(is);
 
              double coeff_mult = alpha_ref_ / (2 * pow(cos(angle_alphaMatrix_ * PI / 180.0), 2) + diagonal_coeff_ * pow(sin(angle_alphaMatrix_ * PI / 180.0), 2));
              alphaMatrix_(0) = 2 * pow(cos(angle_alphaMatrix_ * PI / 180.0), 2) + diagonal_coeff_ * pow(sin(angle_alphaMatrix_ * PI / 180.0), 2);
              alphaMatrix_(1) = 2 * cos(angle_alphaMatrix_ * PI / 180.0) * sin(angle_alphaMatrix_ * PI / 180.0)
                                - diagonal_coeff_ * sin(angle_alphaMatrix_ * PI / 180.0) * cos(angle_alphaMatrix_ * PI / 180.0);
              alphaMatrix_(2) = alphaMatrix_(1);
              alphaMatrix_(3) = 2 * pow(sin(angle_alphaMatrix_ * PI / 180.0), 2) + diagonal_coeff_ * pow(cos(angle_alphaMatrix_ * PI / 180.0), 2);
              alphaMatrix_ *= coeff_mult;
            }
          else
            {
              Cerr << "alpha rotation not yet implemented for nb_equation_CH>2" << finl;
              Process::exit();
            }
        }
      else if (motlu == "non")
        {
          type_alpha_rotation_ = 0;
          is >> motlu;
          if (motlu != "{")
            {
              Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting { after 'non' instead of " << motlu << finl;
              Process::exit();
            }
          is >> motlu;
          if (motlu == "alpha")
            {
              alphaMatrix_.resize(nb_constituants_ * nb_constituants_);
              for (int i = 0; i < alphaMatrix_.size(); i++)
                is >> alphaMatrix_(i);
            }
          else
            {
              Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading alpha_rotation " << finl;
              Cerr << motlu << " is not understood. We are expecting the keyword alpha !! " << finl;
              Process::exit();
            }
 
          is >> motlu;
          if (motlu != "}")
            {
              Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting } instead of " << motlu << finl;
              Process::exit();
            }
        }
      return 1;
    }
  else if (mot == "potentiel_chimique")
    {
      assert(nb_constituants_ > -1);
      Motcle temp_potentiel_chimique;
      is >> temp_potentiel_chimique;
      if (temp_potentiel_chimique == "defaut")
        {
          type_potentiel_analytique_ = 0;
          is >> motlu;
          if (motlu != "{")
            {
              Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting { after 'defaut' instead of " << motlu << finl;
              Process::exit();
            }
          is >> motlu;
          int cpt1 = 0;
          Motcles param_potentiel_chimique(2);
          param_potentiel_chimique[0] = "xEq_phase1";
          param_potentiel_chimique[1] = "xEq_phase2";
          while (motlu != "}")
            {
              int rang0 = param_potentiel_chimique.search(motlu);
              switch(rang0)
                {
                case 0:
                  {
                    cpt1++;
                    DoubleVect temp_equilibre_phase1(nb_constituants_); //define temp to avoid resize here
                    eq1_ = temp_equilibre_phase1;
                    for (int i = 0; i < temp_equilibre_phase1.size(); i++)
                      is >> eq1_(i);
                    break;
                  }
                case 1:
                  {
                    cpt1++;
                    DoubleVect temp_equilibre_phase2(nb_constituants_); //define temp to avoid resize here
                    eq2_ = temp_equilibre_phase2;
                    for (int i = 0; i < temp_equilibre_phase2.size(); i++)
                      is >> eq2_(i);
                    break;
                  }
                default:
                  {
                    Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading potentiel_chimique " << finl;
                    Cerr << motlu << " is not understood." << finl;
                    Cerr << "We are expecting a keyword among " << param_potentiel_chimique << finl;
                    Process::exit();
                  }
                }
              is >> motlu;
            }
          if (cpt1 != 2)
            {
              Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading Fermeture_Systeme_Naire: wrong number of parameters" << finl;
              Cerr << "You should specify all these parameters: " << param_potentiel_chimique << finl;
              Process::exit();
            }
          dWdc_naire = &Fermeture_Phase_field_base::dWdc_naire_defaut;
        }
      else if (temp_potentiel_chimique == "fonction_analytique")
        {
          type_potentiel_analytique_ = 1;
          if (nb_constituants_ == 2)
            {
              is >> motlu;
              if (motlu != "{")
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting { after 'fonction_analytique' instead of " << motlu << finl;
                  Process::exit();
                }
              is >> motlu;
              int cpt1 = 0;
              Motcles param_potentiel_analytique_ternaire(5);
              param_potentiel_analytique_ternaire[0] = "psi";
              param_potentiel_analytique_ternaire[1] = "xEqComp0";
              param_potentiel_analytique_ternaire[2] = "xEqComp1";
              param_potentiel_analytique_ternaire[3] = "aEqComp0";
              param_potentiel_analytique_ternaire[4] = "aEqComp1";
              while (motlu != "}")
                {
                  int rang0 = param_potentiel_analytique_ternaire.search(motlu);
                  switch(rang0)
                    {
                    case 0:
                      {
                        cpt1++;
                        DoubleVect temp_psi(2); //define temp to avoid resize here
                        angle_psi_ = temp_psi;
                        for (int i = 0; i < 2; i++)
                          is >> angle_psi_(i);
                        break;
                      }
                    case 1:
                      {
                        cpt1++;
                        DoubleVect temp_x0Eq(2); //define temp to avoid resize here
                        x0Eq_ = temp_x0Eq;
                        for (int i = 0; i < 2; i++)
                          is >> x0Eq_(i);
                        break;
                      }
                    case 2:
                      {
                        cpt1++;
                        DoubleVect temp_x1Eq(2); //define temp to avoid resize here
                        x1Eq_ = temp_x1Eq;
                        for (int i = 0; i < 2; i++)
                          is >> x1Eq_(i);
                        break;
                      }
                    case 3:
                      {
                        cpt1++;
                        DoubleVect temp_a0Eq(2); //define temp to avoid resize here
                        a0Eq_ = temp_a0Eq;
                        for (int i = 0; i < 2; i++)
                          is >> a0Eq_(i);
                        break;
                      }
                    case 4:
                      {
                        cpt1++;
                        DoubleVect temp_a1Eq(2); //define temp to avoid resize here
                        a1Eq_ = temp_a1Eq;
                        for (int i = 0; i < 2; i++)
                          is >> a1Eq_(i);
                        break;
                      }
                    default:
                      {
                        Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading potentiel_chimique " << finl;
                        Cerr << motlu << " is not understood." << finl;
                        Cerr << "We are expecting a keyword among " << param_potentiel_analytique_ternaire << finl;
                        Process::exit();
                      }
                    }
                  is >> motlu;
                }
              if (cpt1 != 5)
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading Fermeture_Systeme_Naire: wrong number of parameters" << finl;
                  Cerr << "You should specify all these parameters: " << param_potentiel_analytique_ternaire << finl;
                  Process::exit();
                }
              dWdc_naire = &Fermeture_Phase_field_base::dWdc_naire_analytique_ternaire;
            }
          else if (nb_constituants_ == 3)
            {
              is >> motlu;
              if (motlu != "{")
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting { after 'fonction_analytique' instead of " << motlu << finl;
                  Process::exit();
                }
              is >> motlu;
              int cpt1 = 0;
              Motcles param_potentiel_analytique_quaternaire(8);
              param_potentiel_analytique_quaternaire[0] = "psi";
              param_potentiel_analytique_quaternaire[1] = "phi";
              param_potentiel_analytique_quaternaire[2] = "xEqComp0";
              param_potentiel_analytique_quaternaire[3] = "xEqComp1";
              param_potentiel_analytique_quaternaire[4] = "xEqComp2";
              param_potentiel_analytique_quaternaire[5] = "aEqComp0";
              param_potentiel_analytique_quaternaire[6] = "aEqComp1";
              param_potentiel_analytique_quaternaire[7] = "aEqComp2";
 
              while (motlu != "}")
                {
                  int rang0 = param_potentiel_analytique_quaternaire.search(motlu);
                  switch(rang0)
                    {
                    case 0:
                      {
                        cpt1++;
                        DoubleVect temp_psi(2); //define temp to avoid resize here
                        angle_psi_ = temp_psi;
                        for (int i = 0; i < 2; i++)
                          is >> angle_psi_(i);
                        break;
                      }
                    case 1:
                      {
                        cpt1++;
                        DoubleVect temp_phi(2); //define temp to avoid resize here
                        angle_phi_ = temp_phi;
                        for (int i = 0; i < 2; i++)
                          is >> angle_phi_(i);
                        break;
                      }
                    case 2:
                      {
                        cpt1++;
                        DoubleVect temp_x0Eq(2); //define temp to avoid resize here
                        x0Eq_ = temp_x0Eq;
                        for (int i = 0; i < 2; i++)
                          is >> x0Eq_(i);
                        break;
                      }
                    case 3:
                      {
                        cpt1++;
                        DoubleVect temp_x1Eq(2); //define temp to avoid resize here
                        x1Eq_ = temp_x1Eq;
                        for (int i = 0; i < 2; i++)
                          is >> x1Eq_(i);
                        break;
                      }
                    case 4:
                      {
                        cpt1++;
                        DoubleVect temp_x2Eq(2); //define temp to avoid resize here
                        x2Eq_ = temp_x2Eq;
                        for (int i = 0; i < 2; i++)
                          is >> x2Eq_(i);
                        break;
                      }
                    case 5:
                      {
                        cpt1++;
                        DoubleVect temp_a0Eq(2); //define temp to avoid resize here
                        a0Eq_ = temp_a0Eq;
                        for (int i = 0; i < 2; i++)
                          is >> a0Eq_(i);
                        break;
                      }
                    case 6:
                      {
                        cpt1++;
                        DoubleVect temp_a1Eq(2); //define temp to avoid resize here
                        a1Eq_ = temp_a1Eq;
                        for (int i = 0; i < 2; i++)
                          is >> a1Eq_(i);
                        break;
                      }
                    case 7:
                      {
                        cpt1++;
                        DoubleVect temp_a2Eq(2); //define temp to avoid resize here
                        a2Eq_ = temp_a2Eq;
                        for (int i = 0; i < 2; i++)
                          is >> a2Eq_(i);
                        break;
                      }
                    default:
                      {
                        Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading potentiel_chimique " << finl;
                        Cerr << motlu << " is not understood." << finl;
                        Cerr << "We are expecting a keyword among " << param_potentiel_analytique_quaternaire << finl;
                        Process::exit();
                      }
                    }
                  is >> motlu;
                }
              if (cpt1 != 8)
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading Fermeture_Systeme_Naire: wrong number of parameters" << finl;
                  Cerr << "You should specify all these parameters: " << param_potentiel_analytique_quaternaire << finl;
                  Process::exit();
                }
              dWdc_naire = &Fermeture_Phase_field_base::dWdc_naire_analytique_quaternaire;
            }
        }
      else if (temp_potentiel_chimique == "fonction")
        {
          type_potentiel_analytique_ = 0;
          potentiel_chimique_expr_.lire_f(is, nb_constituants_);
          dWdc_naire = &Fermeture_Phase_field_base::dWdc_naire_general;
        }
      else
        {
          Cerr << "Fermeture_Systeme_Naire::readOn: " << temp_potentiel_chimique << " is not a valid keyword in potentiel_chimique block" << finl;
          Process::exit();
        }
      return 1;
    }
  else if (mot == "beta")
    {
      assert(nb_constituants_ > -1);
      betaMatrix_.resize(nb_constituants_);
      for (int i = 0; i < nb_constituants_; i++)
        is >> betaMatrix_(i);
      return 1;
    }
  else if (mot == "kappa_auto_diffusion")
    {
      assert(nb_constituants_ > -1);
      is >> motlu;
      if (motlu == "oui")
        {
          type_kappa_auto_diffusion_ = 1;
          if (nb_constituants_ == 1)
            {
              is >> motlu;
              if (motlu != "{")
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting { after 'oui' instead of " << motlu << finl;
                  exit();
                }
              is >> motlu;
              while (motlu != "}")
                {
                  if (motlu == "kappa")
                    is >> kappa_;
                  else if (motlu == "fonction")
                    {
                      kappa_forme_expr_.lire_f(is, 1);
                      kappa_func_c_naire = &Fermeture_Phase_field_base::kappa_func_c_naire_general;
                    }
                  else
                    Process::exit("Problem in kappa_auto_diffusion readOn : Only kappa & fonction keywords are known !");
                  is >> motlu;
                }
            }
          else
            {
              is >> motlu;
              if (motlu != "{")
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting { after 'oui' instead of " << motlu << finl;
                  exit();
                }
              is >> motlu;
              int cpt1 = 0;
              Motcles param_mobilite(3);
              param_mobilite[0] = "coefficient_auto_diffusion";
              param_mobilite[1] = "temperature";
              param_mobilite[2] = "volume_molaire";
              while (motlu != "}")
                {
                  int rang0 = param_mobilite.search(motlu);
                  switch(rang0)
                    {
                    case 0:
                      {
                        cpt1++;
                        coeff_auto_diffusion_.resize(nb_constituants_ + 1);
                        for (int i = 0; i < coeff_auto_diffusion_.size(); i++)
                          is >> coeff_auto_diffusion_(i);
                        break;
                      }
                    case 1:
                      {
                        cpt1++;
                        is >> temperature_; //temperature en Kelvin
                        break;
                      }
                    case 2:
                      {
                        cpt1++;
                        is >> molarVolume_;
                        break;
                      }
                    default:
                      {
                        Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading kappa_auto_diffusion " << finl;
                        Cerr << motlu << " is not understood." << finl;
                        Cerr << "We are expecting a keyword among " << param_mobilite << finl;
                        exit();
                      }
 
                    }
                  is >> motlu;
                }
              if (cpt1 != 3)
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading Fermeture_Systeme_Naire: wrong number of parameters" << finl;
                  Cerr << "You should specify all these parameters: " << param_mobilite << finl;
                  exit();
                }
              kappa_func_c_naire = &Fermeture_Phase_field_base::kappa_func_auto_diffusion;
            }
 
        }
      else if (motlu == "non")
        {
          type_kappa_auto_diffusion_ = 0;
          is >> motlu;
          if (motlu != "{")
            {
              Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting { after 'non' instead of " << motlu << finl;
              Process::exit();
            }
          is >> motlu;
          while (motlu != "}")
            {
              if (motlu == "kappa")
                {
                  kappaMatrix_.resize(nb_constituants_ * nb_constituants_);
                  for (int i = 0; i < kappaMatrix_.size(); i++)
                    is >> kappaMatrix_(i);
                }
              else
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading kappa_auto_diffusion " << finl;
                  Cerr << motlu << " is not understood. We are expecting the keyword kappa !!" << finl;
                  Process::exit();
                }
              is >> motlu;
            }
        }
      else if (motlu == "defaut")
        {
          type_kappa_auto_diffusion_ = 1;
 
          if (nb_constituants_ == 1)
            {
              is >> motlu;
              if (motlu != "{")
                {
                  Cerr << "Fermeture_Systeme_Naire::readOn: We are expecting { after 'defaut' instead of " << motlu << finl;
                  exit();
                }
              is >> motlu;
              while (motlu != "}")
                {
                  if (motlu == "kappa")
                    is >> kappa_;
                  else
                    {
                      Cerr << "Fermeture_Systeme_Naire::readOn: Error while reading defaut option. " << finl;
                      Cerr << motlu << " is not understood. We are expecting the keyword kappa !!" << finl;
                      Process::exit();
                    }
                  is >> motlu;
                }
            }
          kappa_func_c_naire = &Fermeture_Phase_field_base::kappa_func_c_naire_defaut;
        }
      return 1;
    }
  return -1;
}