TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
SNES_JFNK Class Reference

classe SNES_JFNK More...

#include <SNES_JFNK.h>

Inheritance diagram for SNES_JFNK:
[legend]
Collaboration diagram for SNES_JFNK:
[legend]

Public Member Functions

const Nomle_nom () const override
 Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.
void nommer (const Nom &name) override
 Assigns a name to the Objet_U. Virtual method to override.
bool iterer_eqn (Equation_base &equation, const DoubleTab &inconnue, DoubleTab &result, double dt, int numero_iteration, int &ok) override
 FormFunction de PETSc : calcule le résidu du JFNK.
Public Member Functions inherited from Solveur_Implicite_base
virtual bool iterer_eqs (LIST(OBS_PTR(Equation_base)) eqs, int n, int &ok)
virtual bool est_compatible_avec_th_mono () const
virtual int nb_valeurs_temporelles_pression () const
virtual double get_default_facsec_max () const
virtual double get_default_growth_factor () const
virtual OWN_PTR (Parametre_equation_base) &get_and_set_parametre_equation(Equation_base &)
Parametre_impliciteget_and_set_parametre_implicite (Equation_base &eqn)
Public Member Functions inherited from Objet_U
 ~Objet_U () override
 Destructor. Removes the object from the list of objects registered in "memory".
int numero () const
 Returns the index of the object in Memoire::data.
virtual int duplique () const =0
virtual SortieprintOn (Sortie &) const
 Writes the object to an output stream. Virtual method to override.
virtual EntreereadOn (Entree &)
 Reads an Objet_U from an input stream. Virtual method to override.
virtual unsigned taille_memoire () const =0
virtual int est_egal_a (const Objet_U &) const
 Returns 1 if x and *this are the same instance (same memory address).
virtual int reprendre (Entree &)
 Restores an Objet_U from an input stream. Virtual method to override.
virtual int sauvegarder (Sortie &) const
 Saves an Objet_U to an output stream. Virtual method to override.
int get_object_id () const
 Returns the unique identifier of the object (object_id_).
virtual const Type_infoget_info () const
 Returns type information for the Objet_U.
const Nomque_suis_je () const
 Returns the string identifying the class.
const char * le_type () const
 Returns the type name of the Objet_U.
virtual int change_num (const int *const)
 Changes the internal number of the Objet_U.
virtual int lire_motcle_non_standard (const Motcle &motlu, Entree &is)
 Reads non-simple-type parameters of an Objet_U from an input stream.
virtual int associer_ (Objet_U &)
 Associates the Objet_U with another Objet_U. Virtual method to override.
const Interpreteinterprete () const
Interpreteinterprete ()
Public Member Functions inherited from Process
virtual ~Process ()
Public Member Functions inherited from Solv_tools
void construit_renum (const DoubleVect &)
const ArrOfTID & get_ix () const

Protected Attributes

Nom nom_
double atol_ = -123.
double rtol_ = -123.
double stol_ = -123.
int maxit_newton_ = -123
int maxit_gmres_ = -123
int nkr_ = -123
double erel_ = -123.
double umin_ = -123.
Protected Attributes inherited from Solveur_Implicite_base
Parametre_implicite param_defaut_
int is_seuil_convg_variable
double facteur_convg_
int controle_residu_
Protected Attributes inherited from Solv_tools
TIDTab renum_
IntTab index_
ArrOfBit items_to_keep_
ArrOfTID ix
int nb_items_to_keep_ = -1
int nb_rows_ = -1
trustIdType nb_rows_tot_ = -1
trustIdType decalage_local_global_ = -1
int secmem_sz_ = -1

Additional Inherited Members

Static Public Member Functions inherited from Objet_U
static const Nomnom_du_cas ()
 Returns a constant reference to the case name. This method is static.
static Nomget_set_nom_du_cas ()
 Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_infoinfo ()
 Returns type information for the Objet_U (static version).
static const Objet_Uself_cast (const Objet_U &)
 Method added for casting in Python.
static Objet_Uself_cast (Objet_U &)
Static Public Member Functions inherited from Process
static int me ()
 Returns the rank of the local processor in the current communication group. See Comm_Group::rank() and PE_Groups::current_group().
static int nproc ()
 Returns the number of processors in the current group. See Comm_Group::nproc() and PE_Groups::current_group().
static bool is_parallel ()
static void exit (int exit_code=-1)
 Exit routine for TRUST within a Kokkos region.
static double mp_sum (double)
 Computes the sum of x over all processors in the current group.
static float mp_sum (float)
static trustIdType mp_sum (trustIdType)
 Computes the sum of x over all processors in the current group.
static double mp_max (double)
static double mp_min (double)
static int mp_max (int)
 Returns the maximum value of x across all processors in the current group.
static int mp_min (int)
 Returns the minimum value of x across all processors in the current group.
static double mp_sum_as_double (int v)
static trustIdType mppartial_sum (trustIdType i)
 Computes the partial sum of x over processors 0 to me()-1 (returns 0 on processor 0).
template<typename T>
static void mp_sum_for_each (T &arg1, T &arg2)
 C++14 compatible mp_sum_for_each: combine multiple mp_sum calls into one collective operation Usage: mp_sum_for_each(a, b); mp_sum_for_each(a, b, c); mp_sum_for_each(a, b, c, d); mp_sum_for_each(a, b, c, d, e); All arguments must be of the same type (double or int) and are modified in place. Supports 2-5 parameters.
template<typename T>
static void mp_sum_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void mp_sum_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void mp_sum_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename T>
static void mp_max_for_each (T &arg1, T &arg2)
 C++14 compatible mp_max_for_each: combine multiple mp_max calls into one collective operation.
template<typename T>
static void mp_max_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void mp_max_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void mp_max_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename T>
static void mp_min_for_each (T &arg1, T &arg2)
 C++14 compatible mp_min_for_each: combine multiple mp_min calls into one collective operation.
template<typename T>
static void mp_min_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void mp_min_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void mp_min_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename _TYPE_>
static void mp_sum_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
template<typename _TYPE_>
static void mp_max_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
template<typename _TYPE_>
static void mp_min_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
static bool mp_and (bool)
 Computes the logical AND of b across all processors in the current group.
static bool mp_or (bool)
static int check_int_overflow (trustIdType)
static int je_suis_maitre ()
 Returns 1 if on the master processor of the current group (i.e. me() == 0), 0 otherwise.
static KOKKOS_INLINE_FUNCTION void Kokkos_exit (const char *)
 Exit routine for TRUST within a Kokkos region.
static int node_master ()
 Returns 1 if on the NUMA node master processor, 0 otherwise.
static void exit (const Nom &message, int exit_code=-1)
static bool is_sequential ()
static void barrier ()
 Synchronizes all processors in the current group (waits until all processors have reached the barrier).
static void abort ()
 Abort routine for TRUST on a fatal error.
static SortieJournal (int message_level=0)
 Returns a static Sortie object used as an event journal.
static double ram_processeur ()
static void imprimer_ram_totale (int all_process=0)
static bool force_single_file (const int ranks, const Nom &filename)
Static Public Attributes inherited from Objet_U
static double precision_geom = 1e-10
static constexpr bool HAS_POINTER = false
static int dimension =0
static int format_precision_geom =11
static int axi =0
static int bidim_axi =0
static int DEACTIVATE_SIGINT_CATCH =0
static Type_info info_obj
static bool disable_TU =false
 Flag to disable or not the writing of the .TU files.
static bool stat_per_proc_perf_log =false
 Flag to enable the writing of the statistics detailed per processor in _csv.TU file.
Static Public Attributes inherited from Process
static int exception_sur_exit =0
static int multiple_files =5120
Protected Member Functions inherited from Solveur_Implicite_base
virtual Entreelire (const Motcle &, Entree &)
virtual int get_controle_residu () const
Protected Member Functions inherited from Objet_U
 Objet_U ()
 Default constructor: assigns a unique identifier to the object (object_id_) and registers the object in "memory" by giving it a num_obj number.
 Objet_U (const Objet_U &)
 Copy constructor.
const Objet_Uoperator= (const Objet_U &)
 Assignment operator: does nothing (the number and identifier are preserved).
virtual void set_param (Param &) const

Detailed Description

classe SNES_JFNK

Classe solveur JFNK liée à la librairie SNES de PETSC.

See also
Solveur_non_lineaire

Definition at line 42 of file SNES_JFNK.h.

Member Function Documentation

◆ iterer_eqn()

bool SNES_JFNK::iterer_eqn ( Equation_base & equation,
const DoubleTab & inconnue,
DoubleTab & result,
double dt,
int numero_iteration,
int & ok )
overridevirtual

FormFunction de PETSc : calcule le résidu du JFNK.

Le vecteur v en entrée est uniquement la concentration

Permet de résoudre l'équation non linéaire H(c) = c_theta - c_n - theta * dt * M^-1 * D * mu_theta = 0

inconnue = passe result = present

Implements Solveur_Implicite_base.

Definition at line 137 of file SNES_JFNK.cpp.

◆ le_nom()

const Nom & SNES_JFNK::le_nom ( ) const
inlineoverridevirtual

Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.

Returns
The name of the Objet_U.

Reimplemented from Objet_U.

Definition at line 48 of file SNES_JFNK.h.

◆ nommer()

void SNES_JFNK::nommer ( const Nom & nom)
inlineoverridevirtual

Assigns a name to the Objet_U. Virtual method to override.

Parameters
nomThe name to assign to the Objet_U.

Reimplemented from Objet_U.

Definition at line 49 of file SNES_JFNK.h.

Member Data Documentation

◆ atol_

double SNES_JFNK::atol_ = -123.
protected

Definition at line 57 of file SNES_JFNK.h.

◆ erel_

double SNES_JFNK::erel_ = -123.
protected

Definition at line 63 of file SNES_JFNK.h.

◆ maxit_gmres_

int SNES_JFNK::maxit_gmres_ = -123
protected

Definition at line 61 of file SNES_JFNK.h.

◆ maxit_newton_

int SNES_JFNK::maxit_newton_ = -123
protected

Definition at line 60 of file SNES_JFNK.h.

◆ nkr_

int SNES_JFNK::nkr_ = -123
protected

Definition at line 62 of file SNES_JFNK.h.

◆ nom_

Nom SNES_JFNK::nom_
protected

Definition at line 56 of file SNES_JFNK.h.

◆ rtol_

double SNES_JFNK::rtol_ = -123.
protected

Definition at line 58 of file SNES_JFNK.h.

◆ stol_

double SNES_JFNK::stol_ = -123.
protected

Definition at line 59 of file SNES_JFNK.h.

◆ umin_

double SNES_JFNK::umin_ = -123.
protected

Definition at line 64 of file SNES_JFNK.h.


The documentation for this class was generated from the following files:
  • /home/docs/checkouts/readthedocs.org/user_builds/triocfd-documentation/checkouts/next/src/Multiphase/Phase_field/Solveurs/SNES_JFNK.h
  • /home/docs/checkouts/readthedocs.org/user_builds/triocfd-documentation/checkouts/next/src/Multiphase/Phase_field/Solveurs/SNES_JFNK.cpp