Inherits from Objet_U, adds the very common method set_param for the Objet_U hierarchy. More...

#include <Objet_U_With_Params.h>

Inheritance diagram for Objet_U_With_Params:

Collaboration diagram for Objet_U_With_Params:

Protected Member Functions
Entree &	readOn (Entree &) override final
	Reading of the input stream (dataset) with the helper class Param.
virtual void	validate_params () const
	Called in the readOn of Objet_U_With_Params, after reading the params.
Protected Member Functions inherited from Objet_U
	Objet_U ()
	Constructeur par defaut : attribue un numero d'identifiant unique a l'objet (object_id_), et enregistre l'objet en "memoire".
	Objet_U (const Objet_U &)
	Constructeur par copie.
const Objet_U &	operator= (const Objet_U &)
	Operateur= : ne fait rien (on conserve le numero et l'identifiant).
virtual void	set_param (Param &) const

Additional Inherited Members
Public Member Functions inherited from Objet_U
	~Objet_U () override
	Destructeur, supprime l'objet de la liste d'objets enregistres dans "memoire".
int	numero () const
	Renvoie l'indice de l'objet dans Memoire::data.
virtual int	duplique () const =0
virtual Sortie &	printOn (Sortie &) const
	Ecriture de l'objet sur un flot de sortie Methode a surcharger.
virtual unsigned	taille_memoire () const =0
virtual int	est_egal_a (const Objet_U &) const
	Renvoie 1 si l'objet x et *this sont une seule et meme instance (meme adresse en memoire).
virtual const Nom &	le_nom () const
	Donne le nom de l'Objet_U Methode a surcharger : renvoie "neant" dans cette implementation.
virtual void	nommer (const Nom &)
	Donne un nom a l'Objet_U Methode virtuelle a surcharger.
virtual int	reprendre (Entree &)
	Reprise d'un Objet_U sur un flot d'entree Methode a surcharger.
virtual int	sauvegarder (Sortie &) const
	Sauvegarde d'un Objet_U sur un flot de sortie Methode a surcharger.
int	get_object_id () const
	Renvoie l'identifiant unique de l'objet object_id_.
virtual const Type_info *	get_info () const
	Donne des informations sur le type de l'Objet_U.
const Nom &	que_suis_je () const
	renvoie la chaine identifiant la classe.
const char *	le_type () const
	Donne le nom du type de l'Objet_U.
virtual int	change_num (const int *const)
	Change le numero interne de l'Objet_U.
virtual int	lire_motcle_non_standard (const Motcle &motlu, Entree &is)
	Lecture des parametres de type non simple d'un objet_U a partir d'un flot d'entree.
virtual int	associer_ (Objet_U &)
	Associe l'Objet_U a un autre Objet_U Methode virtuelle a surcharger.
const Interprete &	interprete () const
Interprete &	interprete ()
Public Member Functions inherited from Process
virtual	~Process ()
Static Public Member Functions inherited from Objet_U
static const Nom &	nom_du_cas ()
	Renvoie une reference constante vers le nom du cas.
static Nom &	get_set_nom_du_cas ()
	Renvoie une reference non constante vers le nom du cas (pour pouvoir le modifier).
static const Type_info *	info ()
	Donne des informations sur le type de l'Objet_U.
static const Objet_U &	self_cast (const Objet_U &)
	methode ajoutee pour caster en python
static Objet_U &	self_cast (Objet_U &)
Static Public Member Functions inherited from Process
static int	me ()
	renvoie mon rang dans le groupe de communication courant.
static int	nproc ()
	renvoie le nombre de processeurs dans le groupe courant Voir Comm_Group::nproc() et PE_Groups::current_group()
static bool	is_parallel ()
static void	exit (int exit_code=-1)
	Routine de sortie de TRUST dans une region Kokkos.
static double	mp_sum (double)
	Calcule la somme de x sur tous les processeurs du groupe courant.
static float	mp_sum (float)
static trustIdType	mp_sum (trustIdType)
	Calcule la somme de x sur tous les processeurs du groupe courant.
static double	mp_max (double)
static double	mp_min (double)
static int	mp_max (int)
	renvoie le plus grand int i sur l'ensemble des processeurs du groupe courant.
static int	mp_min (int)
	renvoie le plus petit int i sur l'ensemble des processeurs du groupe courant.
static double	mp_sum_as_double (int v)
static trustIdType	mppartial_sum (trustIdType i)
	Calul de la somme partielle de i sur les processeurs 0 a me()-1 (renvoie 0 sur le processeur 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)
	Calcule le 'et' logique de b sur tous les processeurs du groupe courant.
static bool	mp_or (bool)
static int	check_int_overflow (trustIdType)
static int	je_suis_maitre ()
	renvoie 1 si on est sur le processeur maitre du groupe courant (c'est a dire me() == 0), 0 sinon.
static KOKKOS_INLINE_FUNCTION void	Kokkos_exit (const char *)
	Routine de sortie de TRUST dans une region Kokkos.
static int	node_master ()
	renvoie 1 si on est sur le processeur maitre du noeud numa, 0 sinon.
static void	exit (const Nom &message, int exit_code=-1)
static bool	is_sequential ()
static void	barrier ()
	Synchronise tous les processeurs du groupe courant (attend que tous les processeurs soient arrives a la barriere).
static void	abort ()
	Routine de sortie de Trio-U sur une erreur abort().
static Sortie &	Journal (int message_level=0)
	Renvoie un objet statique de type Sortie qui sert de journal d'evenements.
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

Inherits from Objet_U, adds the very common method set_param for the Objet_U hierarchy.

All classes introducing new keywords/parameters must inherit from this class and not Objet_U. The goal is to promote the use of param.ajouter and move toward a more consistent grammar for TRUST datasets.

readOn cannot be overriden when inheriting from this class.

Method set_param can be overriden to register params with param.ajouter

Method validate_params is provided for override if complex attribute validation is needed It is called right after reading the params, and should not modify the objects.

Classes inheriting from Objet_U_With_Params must use one of the macros: Declare_base_with_param or Declare_instanciable_with_param. They do not declare the readOn function, which is not possible when deriving from this class.

Definition at line 43 of file Objet_U_With_Params.h.

Member Function Documentation

◆ readOn()

Entree & Objet_U_With_Params::readOn ( Entree & is )

finaloverrideprotectedvirtual

Reading of the input stream (dataset) with the helper class Param.

This method is 'final'. The goal is to enforce a specific flow (see details below) of the reading/initialization of TRUST Objects.

Unfolding of the method:

param is filled by the const method set_param.
params are read with param.lire_avec_accolades_depuis
params are validated by the user in the const method validate_params

The actual work is done by __readOn_Impl_DO_NOT_OVERRIDE_UNLESS_THE_WORLD_IS_ENDING.

Parameters

(Entree& is) an input stream from which param will be read

Returns: (Entree&) the input stream, after reading a block { ... }

Exceptions

wrong input format, missing brackets

Reimplemented from Objet_U.

Definition at line 53 of file Objet_U_With_Params.cpp.

◆ validate_params()

virtual void Objet_U_With_Params::validate_params ( ) const

inlineprotectedvirtual

Called in the readOn of Objet_U_With_Params, after reading the params.

Should check the coherence and validity of the params, throwing/exiting accordingly At this point, we are still const.

Reimplemented in Partitionneur_Parmetis, Partitionneur_Partition, Partitionneur_Sous_Domaine, Partitionneur_Tranche_32_64< _SIZE_ >, Partitionneur_Tranche_32_64< int >, Partitionneur_Tranche_32_64< trustIdType >, Partitionneur_Union, and Reaction.

Definition at line 55 of file Objet_U_With_Params.h.

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

/home/docs/trust-code/src/Kernel/Utilitaires/Objet_U_With_Params.h
/home/docs/trust-code/src/Kernel/Utilitaires/Objet_U_With_Params.cpp

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ readOn()

◆ validate_params()