Schema_Implicite_base.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 <Schema_Implicite_base.h>
#include <Param.h>
 
Implemente_base(Schema_Implicite_base,"Schema_Implicite_base",Schema_Temps_base);
// XD schema_implicite_base schema_temps_base schema_implicite_base INHERITS_BRACE Basic class for implicite time
// XD_CONT scheme.
// XD attr max_iter_implicite entier max_iter_implicite OPT Maximum number of iterations allowed for the solver (by
// XD_CONT default 200).
 
Sortie& Schema_Implicite_base::printOn(Sortie& os) const
{
  Schema_Temps_base::printOn(os);
  return os << le_solveur << finl;
}
 
Entree& Schema_Implicite_base::readOn(Entree& is)
{
  return Schema_Temps_base::readOn(is);
}
 
void Schema_Implicite_base::set_param(Param& param) const
{
  param.ajouter("solveur",&le_solveur,Param::REQUIRED);  // XD attr solveur solveur_implicite_base solveur REQ This
  // XD_CONT keyword is used to designate the solver selected in the situation where the time scheme is an implicit
  // XD_CONT scheme. solver is the name of the solver that allows equation diffusion and convection operators to be set
  // XD_CONT as implicit terms. Keywords corresponding to this functionality are Simple (SIMPLE type algorithm), Simpler
  // XD_CONT (SIMPLER type algorithm) for incompressible systems, Piso (Pressure Implicit with Split Operator), and
  // XD_CONT Implicite (similar to PISO, but as it looks like a simplified solver, it will use fewer timesteps, and ICE
  // XD_CONT (for PB_multiphase). But it may run faster because the pressure matrix is not re-assembled and thus
  // XD_CONT provides CPU gains. NL2 Advice: Since the 1.6.0 version, we recommend to use first the Implicite or Simple,
  // XD_CONT then Piso, and at least Simpler. Because the two first give a fastest convergence (several times) than Piso
  // XD_CONT and the Simpler has not been validated. It seems also than Implicite and Piso schemes give better results
  // XD_CONT than the Simple scheme when the flow is not fully stationary. Thus, if the solution obtained with Simple is
  // XD_CONT not stationary, it is recommended to switch to Piso or Implicite scheme.
  Schema_Temps_base::set_param(param);
}