Schema_Euler_Implicite.h

/****************************************************************************
* 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.
*
*****************************************************************************/
 
#ifndef Schema_Euler_Implicite_included
#define Schema_Euler_Implicite_included
 
/*! @brief class Schema_Euler_Implicite It inherits from the implicit base scheme and carries a solver, for example
 *
 *   the Simpler solver, to perform the time-stepping operations.
 *
 */
 
#include <Schema_Implicite_base.h>
#include <vector>
#include <set>
class Probleme_Couple;
 
class Schema_Euler_Implicite : public Schema_Implicite_base
{
 
  Declare_instanciable(Schema_Euler_Implicite);
 
public :
 
  bool initTimeStep(double dt) override;
  void set_param(Param& ) const override;
  int lire_motcle_non_standard(const Motcle& mot, Entree& is) override;
 
  ////////////////////////////////
  //                            //
  // Schema characteristics     //
  //                            //
  ////////////////////////////////
 
  int nb_valeurs_temporelles() const override;
  int nb_valeurs_futures() const override;
  double temps_futur(int i) const override;
  double temps_defaut() const override;
 
  /////////////////////////////////////////
  //                                     //
  // End of schema characteristics       //
  //                                     //
  /////////////////////////////////////////
 
  void Initialiser_Champs(Probleme_base&);
  void test_stationnaire(Probleme_base&);
  int Iterer_Pb(Probleme_base&,int ite, int& ok);
  bool iterateTimeStep(bool& converged) override;
  virtual int faire_un_pas_de_temps_pb_couple(Probleme_Couple&, int& ok);
  int faire_un_pas_de_temps_eqn_base(Equation_base&) override;
  inline const double& residu_old() const
  {
    return residu_old_ ;
  };
  int mettre_a_jour() override;
  int reprendre(Entree& ) override;
  inline void completer() override { }
  int resolution_monolithique(const Nom& nom) const;
  Entree& lire_facsec_expert(Entree&);
  void lire_facsec_func(Entree&);
  void calcul_fac_sec(double& residu_,double& residu_old,double& facsec_);
  double facsec_cfl() const { return facsec_cfl_; }
 
protected:
  Parser_U facsec_fn_;           // parser to set facsec as a function of time
  bool facsec_func_ = false;                      // is the facsec a function of time (true) or a constant (false)
  int nb_ite_max = 200;
  double residu_old_ = 0, facsec_max_ = DMAXFLOAT;
  bool facsec_cfl_ = false; // New keyword to manage time step based on CFL: dt=min(facsec,facsec_max)*dt(convection)
  int nb_ite_sans_accel_ = -1;
  int nb_ite_sans_accel_max_ =  20000;
  double rapport_residus_ = 1.2;
  std::vector<std::set<std::string>> resolution_monolithique_;
};
 
#endif