Base class for "interpreter" objects. More...

#include <Interprete.h>

Inherited by Ecrire_MED_32_64< int >, Ecrire_MED_32_64< trustIdType >, Interprete_geometrique_base_32_64< int >, Interprete_geometrique_base_32_64< trustIdType >, Associer, Axi, Bidim_Axi, Build_Map_to_Structured, CGNS_2_Lata, DNS_QC_double, Deactivate_SIGINT_Catch, DebogFT, DebogIJK, Debog_Pb_Wrapper, Decouper_multi, Diametre_hyd_champ, Dimension, Disable_TU, Discretiser, Ecr_fic_Ansys, Ecrire, Ecrire_Champ_MED, Ecrire_Fichier, Ecrire_MED_32_64< _SIZE_ >, EcritureLectureSpecial, Execute_parallel, IJK_Lata_Swap_JK, IJK_Test_Multigrille, Imprimer_Fichiers_RANS_VDF, Imprimer_Fichiers_RANS_VEF, Integrer_champ_med, Interprete_geometrique_base_32_64< _SIZE_ >, Lata_2_CGNS, Lata_2_MED, Lata_2_Other, Lire, Lire_Fichier, Lml_2_Lata, MaillerParallel, Merge_MED, Mkdir, ModifyDomaineAxi1D, Moyenne_volumique, MultipleFiles, My_Comm_Group, Option_CGNS, Option_DG, Option_IJK, Option_Interpolation, Option_PolyMAC_family, Option_VDF, Parallel_io_parameters, Pilote_ICoCo, Porosites_champ, PrecisionGeom, Resoudre, Scatter, Stat_per_proc_perf_log, Switch_double, System, Test_SSE_Kernels, Test_solveur, Testeur, and Testeur_MEDCoupling.

Collaboration diagram for Interprete:

[legend]

Public Member Functions
virtual Entree &	interpreter (Entree &)=0
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 ()

Static Public Member Functions
static Objet_U &	objet (const Nom &)
	See Interprete_bloc::objet_global(). BM: the Interprete class is not the best place for this.
static int	objet_existant (const Nom &)
	Returns 1 if the object exists, 0 otherwise. See Interprete_bloc::objet_global_existant().
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)

Additional Inherited Members
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 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

Detailed Description

Base class for "interpreter" objects.

These objects define actions to be performed when they are encountered in the data set. The action is triggered by a call to the interpreter() method. The interpreter can then read additional parameters from the input to perform its task. In general, the interpreter acts on other objects declared in the data set. It can access them through the objet() and objet_existant() methods. See for example the Lire or Associer class.

See also: Interprete_bloc which reads a series of instructions to execute in the data set.

Definition at line 37 of file Interprete.h.

Member Function Documentation

◆ interpreter()

virtual Entree & Interprete::interpreter ( Entree & )

pure virtual

Implemented in Associer, Axi, Bidim_Axi, Build_Map_to_Structured, CGNS_2_Lata, Deactivate_SIGINT_Catch, Debog_Pb_Wrapper, DebogFT, DebogIJK, Decouper_32_64< _SIZE_ >, Decouper_32_64< int >, Decouper_32_64< trustIdType >, Decouper_multi, Diametre_hyd_champ, Dimension, Disable_TU, Discretiser, DNS_QC_double, Ecr_fic_Ansys, Ecrire, Ecrire_Champ_MED, Ecrire_Fichier, Ecrire_Fichier_Formatte, Ecrire_MED_32_64< _SIZE_ >, Ecrire_MED_32_64< int >, Ecrire_MED_32_64< trustIdType >, EcritureLectureSpecial, Execute_parallel, IJK_Lata_Swap_JK, IJK_Test_Multigrille, Imprimer_Fichiers_RANS_VDF, Imprimer_Fichiers_RANS_VEF, Integrer_champ_med, Interprete_geometrique_base_32_64< _SIZE_ >, Interprete_geometrique_base_32_64< int >, Interprete_geometrique_base_32_64< trustIdType >, Lata_2_CGNS, Lata_2_MED, Lata_2_Other, Lire, Lire_Fichier, Lire_Fichier_Bin, Lml_2_Lata, MaillerParallel, Merge_MED, Mkdir, ModifyDomaineAxi1D, Moyenne_volumique, MultipleFiles, My_Comm_Group, Option_CGNS, Option_DG, Option_IJK, Option_Interpolation, Option_PolyMAC_family, Option_VDF, Parallel_io_parameters, Pilote_ICoCo, Porosites_champ, PrecisionGeom, Raffiner_isotrope_parallele, Resoudre, Scatter, Stat_per_proc_perf_log, Switch_double, System, Test_solveur, Test_SSE_Kernels, Testeur, Testeur_MEDCoupling, and Typer_Lire.

◆ objet()

Objet_U & Interprete::objet ( const Nom & nom )

static

See Interprete_bloc::objet_global(). BM: the Interprete class is not the best place for this.

method, but we will address that later...

Definition at line 45 of file Interprete.cpp.

◆ objet_existant()

int Interprete::objet_existant ( const Nom & nom )

static

Returns 1 if the object exists, 0 otherwise. See Interprete_bloc::objet_global_existant().

Definition at line 53 of file Interprete.cpp.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ interpreter()

◆ objet()

◆ objet_existant()