#include <Precond_base.h>

Inheritance diagram for Precond_base:

Collaboration diagram for Precond_base:

Public Types
enum	Init_Status { READY = 0 , REINIT_COEFF = 1 , REINIT_ALL = 2 }

Public Member Functions
	Precond_base ()
void	reinit (Init_Status x=REINIT_ALL)
	this method must be called before preconditionner() whenever the matrix changes (coefficients only or coefficients and structure) to
void	set_echange_espace_virtuel_resultat (int flag)
	Call this method to change the behaviour of the preconditionner() method 0-> result will not have an up-to-date virtual space.
int	preconditionner (const Matrice_Base &, const DoubleVect &src, DoubleVect &solution)
	Call to the prepare() method if reinit() has been called previously, then call to preconditionner_().
void	prepare (const Matrice_Base &, const DoubleVect &src)
	prepares the preconditionner if needed after a matrix change (reinit() call).
virtual int	supporte_matrice_morse_sym ()
	returns 1 if the implementation accepts Matrice_Morse_Sym matrices, otherwise 0.
Init_Status	get_status ()
virtual int	get_flag_updated_input () const
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 Sortie &	printOn (Sortie &) const
	Writes the object to an output stream. Virtual method to override.
virtual Entree &	readOn (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 const Nom &	le_nom () const
	Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.
virtual void	nommer (const Nom &)
	Assigns a name to the Objet_U. Virtual method to override.
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_info *	get_info () const
	Returns type information for the Objet_U.
const Nom &	que_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 Interprete &	interprete () const
Interprete &	interprete ()
Public Member Functions inherited from Process
virtual	~Process ()

Protected Member Functions
virtual int	preconditionner_ (const Matrice_Base &, const DoubleVect &src, DoubleVect &solution)=0
virtual void	prepare_ (const Matrice_Base &, const DoubleVect &)
	this method must be overloaded if some preparation is necessary.
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_U &	operator= (const Objet_U &)
	Assignment operator: does nothing (the number and identifier are preserved).
virtual void	set_param (Param &) const

Protected Attributes
int	echange_ev_solution_

Additional Inherited Members
Static Public Member Functions inherited from Objet_U
static const Nom &	nom_du_cas ()
	Returns a constant reference to the case name. This method is static.
static Nom &	get_set_nom_du_cas ()
	Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_info *	info ()
	Returns type information for the Objet_U (static version).
static const Objet_U &	self_cast (const Objet_U &)
	Method added for casting in Python.
static Objet_U &	self_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 Sortie &	Journal (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

Detailed Description

Definition at line 25 of file Precond_base.h.

Member Enumeration Documentation

◆ Init_Status

enum Precond_base::Init_Status

Enumerator
READY
REINIT_COEFF
REINIT_ALL

Definition at line 30 of file Precond_base.h.

Constructor & Destructor Documentation

◆ Precond_base()

Precond_base::Precond_base ( )

Definition at line 23 of file Precond_base.cpp.

Member Function Documentation

◆ get_flag_updated_input()

virtual int Precond_base::get_flag_updated_input ( ) const

inlinevirtual

Reimplemented in SSOR.

Definition at line 42 of file Precond_base.h.

◆ get_status()

Init_Status Precond_base::get_status ( )

inline

Definition at line 40 of file Precond_base.h.

◆ preconditionner()

int Precond_base::preconditionner	(	const Matrice_Base &	m,
		const DoubleVect &	src,
		DoubleVect &	solution )

Call to the prepare() method if reinit() has been called previously, then call to preconditionner_().

.. If echange_ev_solution is not zero, the solution vector will have an updated virtual space.

Definition at line 91 of file Precond_base.cpp.

◆ preconditionner_()

virtual int Precond_base::preconditionner_	(	const Matrice_Base &	,
		const DoubleVect &	src,
		DoubleVect &	solution )

protectedpure virtual

Implemented in Precond_local, PrecondA, PrecondSolv, and SSOR.

◆ prepare()

void Precond_base::prepare	(	const Matrice_Base &	m,
		const DoubleVect &	v )

prepares the preconditionner if needed after a matrix change (reinit() call).

prepare() is public, in case we want to perform preparation separately from preconditionning (eg nested solvers) but calling prepare() is not mandatory (done automatically in preconditionner()) m is the new matrix, and md is the descriptor of the solution vector.

Definition at line 108 of file Precond_base.cpp.

◆ prepare_()

void Precond_base::prepare_	(	const Matrice_Base &	m,
		const DoubleVect &	v )

protectedvirtual

this method must be overloaded if some preparation is necessary.

It is called after a call to reinit() and before the next call to preconditionner_(). Do not forget to call the prepare_() method of the ancestor (at the end of the routine, otherwise status will be put to READY) and use get_status() to know what should be prepared.

Reimplemented in Precond_local, PrecondA, PrecondSolv, and SSOR.

Definition at line 122 of file Precond_base.cpp.

◆ reinit()

void Precond_base::reinit ( Init_Status x = REINIT_ALL )

this method must be called before preconditionner() whenever the matrix changes (coefficients only or coefficients and structure) to

tell the object to recompute some matrix related data.

Definition at line 44 of file Precond_base.cpp.

◆ set_echange_espace_virtuel_resultat()

void Precond_base::set_echange_espace_virtuel_resultat ( int flag )

Call this method to change the behaviour of the preconditionner() method 0-> result will not have an up-to-date virtual space.

1-> yes it will (this must be the default value in the implementation)

Definition at line 80 of file Precond_base.cpp.

◆ supporte_matrice_morse_sym()

int Precond_base::supporte_matrice_morse_sym ( )

virtual

returns 1 if the implementation accepts Matrice_Morse_Sym matrices, otherwise 0.

(must be reimplemented if answer is 0)

Reimplemented in PrecondA, and PrecondSolv.

Definition at line 67 of file Precond_base.cpp.

Member Data Documentation

◆ echange_ev_solution_

int Precond_base::echange_ev_solution_

protected

Definition at line 51 of file Precond_base.h.

The documentation for this class was generated from the following files:

/home/docs/trust-code/src/Kernel/Math/SolvSys/Precond_base.h
/home/docs/trust-code/src/Kernel/Math/SolvSys/Precond_base.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members