Base class for diffused inputs: the master processor reads data from get_entree_master() and broadcasts it. More...

#include <Lec_Diffuse_base.h>

Inheritance diagram for Lec_Diffuse_base:

Collaboration diagram for Lec_Diffuse_base:

Public Member Functions
Entree &	operator>> (int &ob) override
Entree &	operator>> (long &ob) override
Entree &	operator>> (long long &ob) override
Entree &	operator>> (float &ob) override
Entree &	operator>> (double &ob) override
int	get (int *ob, std::streamsize n) override
int	get (long *ob, std::streamsize n) override
int	get (long long *ob, std::streamsize n) override
int	get (float *ob, std::streamsize n) override
int	get (double *ob, std::streamsize n) override
int	get (char *buf, std::streamsize bufsize) override
	Reads a string from ostream_. bufsize is the size of the buffer allocated for ob (including.
int	eof () override
int	good () override
int	fail () override
void	set_bin (bool bin) override
	Calls get_entree_master().
void	set_check_types (bool flag) override
	Calls get_entree_master().
void	set_diffuse (bool diffuse) override
	Sets the diffuse flag for this input stream.
Entree &	operator>> (Entree &(*f)(Entree &))
Entree &	operator>> (istream &(*f)(istream &))
Entree &	operator>> (ios &(*f)(ios &))
template<typename T>
Entree &	operator>> (const TRUST_Ref< T > &)
Entree &	operator>> (const TRUST_Ref_Objet_U &)
virtual Entree &	operator>> (std::string &ob)
virtual Entree &	operator>> (Objet_U &ob) final
Public Member Functions inherited from EFichier
	EFichier (const char *name, IOS_OPEN_MODE mode=ios::in)
Public Member Functions inherited from Entree_Fichier_base
	Entree_Fichier_base ()
	Entree_Fichier_base (const Entree_Fichier_base &)=default
	Entree_Fichier_base (const char *name, IOS_OPEN_MODE mode=ios::in)
ifstream &	get_ifstream ()
void	close ()
void	precision (int pre)
void	setf (IOS_FORMAT code)
virtual int	ouvrir (const char *name, IOS_OPEN_MODE mode=ios::in)
Public Member Functions inherited from Entree
	Entree ()
	Entree (istream &is)
	Entree (const Entree &is)
virtual	~Entree ()
Entree &	operator= (istream &is)
Entree &	operator= (Entree &is)
virtual istream &	get_istream ()
virtual const istream &	get_istream () const
void	set_istream (istream *is)
Entree &	operator>> (Entree &(*f)(Entree &))
Entree &	operator>> (istream &(*f)(istream &))
Entree &	operator>> (ios &(*f)(ios &))
template<typename T>
Entree &	operator>> (const TRUST_Ref< T > &)
Entree &	operator>> (const TRUST_Ref_Objet_U &)
virtual int	jumpOfLines ()
bool	check_types () const
virtual void	set_error_action (Error_Action)
	Changes the error behaviour of the input; see error_handle_() and get_error_action().
Error_Action	get_error_action ()
	Returns error_action_ for this input (allows modifying it and restoring the previous value afterwards).
	operator istream & ()
istream &	putback (char ch)
bool	get_diffuse ()
Public Member Functions inherited from AbstractIO
bool	is_64b () const
virtual void	set_64b (bool is_64b)
bool	is_bin ()
void	set_avoid_conversion (bool avoid)
bool	avoid_conversion ()
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
	Lec_Diffuse_base ()
	Does nothing (protected constructor since this is a base class).
	Lec_Diffuse_base (const Lec_Diffuse_base &)=default
Lec_Diffuse_base &	operator= (const Lec_Diffuse_base &)
	Error.
virtual Entree &	get_entree_master ()=0
Protected Member Functions inherited from Entree
int	error_handle (int fail_flag)
virtual int	error_handle_ (int fail_flag)
	This function is called by operator>>, get, get_nom, ouvrir, fermer, lire, etc.
Protected Member Functions inherited from AbstractIO
	AbstractIO ()
virtual	~AbstractIO ()
template<typename _TYPE_>
bool	must_convert () const
	Whether to convert an int into a long when reading/writing out data.
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

Additional Inherited Members
Public Types inherited from Entree
enum	Error_Action { ERROR_EXIT , ERROR_CONTINUE , ERROR_EXCEPTION }
Static Public Member Functions inherited from Entree_Fichier_base
static bool	Can_be_read (const char *name)
	Return True if the file can be opened for reading, false otherwise.
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
Protected Attributes inherited from Entree_Fichier_base
ifstream *	ifstream_
Protected Attributes inherited from Entree
bool	check_types_ = false
Error_Action	error_action_
bool	diffuse_
Protected Attributes inherited from AbstractIO
bool	bin_ = false
	Is this a binary flux?
bool	is_64b_
	Will we be reading/writing in 64b? (Init in ctor to avoid including arch.h probably).
bool	avoid_conversion_ = false

Detailed Description

Base class for diffused inputs: the master processor reads data from get_entree_master() and broadcasts it.

to all processors. Warning: the methods operator>>(), get(), eof(), good() and bad() must be called simultaneously on all processors. Derived classes must reimplement get_entree_master(). The get_entree_master() method must return a reference to the input that serves as source on the master processor; it is never called on other processors. Warning: the source input must have set_error_action(ERROR_CONTINUE).

Definition at line 37 of file Lec_Diffuse_base.h.

Constructor & Destructor Documentation

◆ Lec_Diffuse_base() [1/2]

Lec_Diffuse_base::Lec_Diffuse_base ( )

protected

Does nothing (protected constructor since this is a base class).

Definition at line 36 of file Lec_Diffuse_base.cpp.

◆ Lec_Diffuse_base() [2/2]

Lec_Diffuse_base::Lec_Diffuse_base ( const Lec_Diffuse_base & )

protecteddefault

Member Function Documentation

◆ eof()

int Lec_Diffuse_base::eof ( )

overridevirtual

Reimplemented from Entree_Fichier_base.

Definition at line 88 of file Lec_Diffuse_base.cpp.

◆ fail()

int Lec_Diffuse_base::fail ( )

overridevirtual

Reimplemented from Entree_Fichier_base.

Definition at line 112 of file Lec_Diffuse_base.cpp.

◆ get() [1/6]

int Lec_Diffuse_base::get	(	char *	ob,
		std::streamsize	bufsize )

overridevirtual

Reads a string from ostream_. bufsize is the size of the buffer allocated for ob (including.

the final null character). The string always contains a null character even on failure. The method returns 1 if reading is successful, 0 otherwise. If the buffer is too small, we currently call exit(), but in the future we could test: if strlen(ob)==bufsize-1, then call lire() again until the end is reached. If the next lire() returns a string of length zero, it means the string length was exactly bufsize-1. Warning: the behaviour differs between binary and ASCII mode. In binary mode, the string is read until the next '\0'. In ASCII mode, the string is read until the next separator (space, tab, newline).

Reimplemented from Entree.

Definition at line 63 of file Lec_Diffuse_base.cpp.

◆ get() [2/6]

int Lec_Diffuse_base::get	(	double *	ob,
		std::streamsize	n )

overridevirtual

Reimplemented from Entree.

Definition at line 61 of file Lec_Diffuse_base.cpp.

◆ get() [3/6]

int Lec_Diffuse_base::get	(	float *	ob,
		std::streamsize	n )

overridevirtual

Reimplemented from Entree.

Definition at line 58 of file Lec_Diffuse_base.cpp.

◆ get() [4/6]

int Lec_Diffuse_base::get	(	int *	ob,
		std::streamsize	n )

overridevirtual

Reimplemented from Entree.

Definition at line 49 of file Lec_Diffuse_base.cpp.

◆ get() [5/6]

int Lec_Diffuse_base::get	(	long *	ob,
		std::streamsize	n )

overridevirtual

Reimplemented from Entree.

Definition at line 52 of file Lec_Diffuse_base.cpp.

◆ get() [6/6]

int Lec_Diffuse_base::get	(	long long *	ob,
		std::streamsize	n )

overridevirtual

Reimplemented from Entree.

Definition at line 55 of file Lec_Diffuse_base.cpp.

◆ get_entree_master()

virtual Entree & Lec_Diffuse_base::get_entree_master ( )

protectedpure virtual

Implemented in LecFicDiffuse, and LecFicDiffuse_JDD.

◆ good()

int Lec_Diffuse_base::good ( )

overridevirtual

Reimplemented from Entree_Fichier_base.

Definition at line 100 of file Lec_Diffuse_base.cpp.

◆ operator=()

Lec_Diffuse_base & Lec_Diffuse_base::operator= ( const Lec_Diffuse_base & )

protected

Error.

Definition at line 41 of file Lec_Diffuse_base.cpp.

◆ operator>>() [1/12]

template<typename T>

Entree & Entree::operator>> ( const TRUST_Ref< T > & )

inline

Definition at line 65 of file Entree.h.

◆ operator>>() [2/12]

Entree & Entree::operator>> ( const TRUST_Ref_Objet_U & )

inline

Definition at line 67 of file Entree.h.

◆ operator>>() [3/12]

Entree & Lec_Diffuse_base::operator>> ( double & ob )

overridevirtual

Reimplemented from Entree.

Definition at line 60 of file Lec_Diffuse_base.cpp.

◆ operator>>() [4/12]

Entree & Entree::operator>> ( Entree &(* f )(Entree &) )

Definition at line 60 of file Entree.cpp.

◆ operator>>() [5/12]

Entree & Lec_Diffuse_base::operator>> ( float & ob )

overridevirtual

Reimplemented from Entree.

Definition at line 57 of file Lec_Diffuse_base.cpp.

◆ operator>>() [6/12]

Entree & Lec_Diffuse_base::operator>> ( int & ob )

overridevirtual

Reimplemented from Entree.

Definition at line 48 of file Lec_Diffuse_base.cpp.

◆ operator>>() [7/12]

Entree & Entree::operator>> ( ios &(* f )(ios &) )

Definition at line 62 of file Entree.cpp.

◆ operator>>() [8/12]

Entree & Entree::operator>> ( istream &(* f )(istream &) )

Definition at line 61 of file Entree.cpp.

◆ operator>>() [9/12]

Entree & Lec_Diffuse_base::operator>> ( long & ob )

overridevirtual

Reimplemented from Entree.

Definition at line 51 of file Lec_Diffuse_base.cpp.

◆ operator>>() [10/12]

Entree & Lec_Diffuse_base::operator>> ( long long & ob )

overridevirtual

Reimplemented from Entree.

Definition at line 54 of file Lec_Diffuse_base.cpp.

◆ operator>>() [11/12]

Entree & Entree::operator>> ( Objet_U & ob )

finalvirtual

Reimplemented from Entree.

Definition at line 77 of file Entree.cpp.

◆ operator>>() [12/12]

Entree & Entree::operator>> ( std::string & ob )

virtual

Reimplemented from Entree.

Definition at line 74 of file Entree.cpp.

◆ set_bin()

void Lec_Diffuse_base::set_bin ( bool bin )

overridevirtual

Calls get_entree_master().

set_bin(bin)

Reimplemented from Entree.

Definition at line 129 of file Lec_Diffuse_base.cpp.

◆ set_check_types()

void Lec_Diffuse_base::set_check_types ( bool flag )

overridevirtual

Calls get_entree_master().

set_check_types(flag)

Reimplemented from Entree.

Definition at line 145 of file Lec_Diffuse_base.cpp.

◆ set_diffuse()

void Lec_Diffuse_base::set_diffuse ( bool diffuse )

overridevirtual

Sets the diffuse flag for this input stream.

This virtual method does nothing in the base class; see override in Lec_Diffuse_base.

Parameters

diffuse Whether to diffuse data to other processes.

Reimplemented from Entree.

Definition at line 152 of file Lec_Diffuse_base.cpp.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Lec_Diffuse_base() [1/2]

◆ Lec_Diffuse_base() [2/2]

Member Function Documentation

◆ eof()

◆ fail()

◆ get() [1/6]

◆ get() [2/6]

◆ get() [3/6]

◆ get() [4/6]

◆ get() [5/6]

◆ get() [6/6]

◆ get_entree_master()

◆ good()

◆ operator=()

◆ operator>>() [1/12]

◆ operator>>() [2/12]

◆ operator>>() [3/12]

◆ operator>>() [4/12]

◆ operator>>() [5/12]

◆ operator>>() [6/12]

◆ operator>>() [7/12]

◆ operator>>() [8/12]

◆ operator>>() [9/12]

◆ operator>>() [10/12]

◆ operator>>() [11/12]

◆ operator>>() [12/12]

◆ set_bin()

◆ set_check_types()

◆ set_diffuse()