#include <Sonde_Int.h>

Inheritance diagram for Sonde_Int:

Collaboration diagram for Sonde_Int:

Public Member Functions
	Sonde_Int (const Nom &)
	Constructor for a probe given its name.
void	associer_post (const Postraitement &)
	Associates a post-processing object with the probe.
void	initialiser (const Domaine &)
	Initialises the probe.
void	mettre_a_jour (double temps, double tinit)
	Updates the probe in time and performs post-processing.
void	postraiter (double)
	Performs post-processing.
void	ouvrir_fichier ()
	Opens the file associated with the probe.
void	fermer_fichier ()
	Closes the file to which the probe writes.
const IntVect &	le_tableau () const
	Returns the associated array.
const DoubleTab &	les_positions () const
	Returns the array of probed positions.
const IntVect &	les_poly () const
	Returns the array of elements being probed.
void	fixer_periode (double)
	Sets the sampling period for probing the field.
double	temps () const
	Returns the elapsed time.
SFichier &	fichier ()
	Returns the output file stream used by the probe.
	~Sonde_Int () override
	Destructor.
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 ()

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
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

class Sonde_Int

Allows tracking the evolution of an integer array over time.

 A set of points at which the array is to be probed is chosen,
 along with the observation period. Postraitement objects hold probes
 for the fields to monitor; each probe in turn holds a reference to
 its post-processing object.

See also: Postraitement Sonde_Ints

Definition at line 36 of file Sonde_Int.h.

Constructor & Destructor Documentation

◆ Sonde_Int()

Sonde_Int::Sonde_Int ( const Nom & nom )

inline

Constructor for a probe given its name.

Parameters

nom	the name of the probe to construct

Definition at line 21 of file Sonde_Int.cpp.

◆ ~Sonde_Int()

Sonde_Int::~Sonde_Int ( )

inlineoverride

Destructor.

Closes the file before destroying the object.

Definition at line 163 of file Sonde_Int.h.

Member Function Documentation

◆ associer_post()

void Sonde_Int::associer_post ( const Postraitement & le_post )

Associates a post-processing object with the probe.

Parameters

le_post the post-processing object to associate

Definition at line 245 of file Sonde_Int.cpp.

◆ fermer_fichier()

void Sonde_Int::fermer_fichier ( )

inline

Closes the file to which the probe writes.

Definition at line 100 of file Sonde_Int.h.

◆ fichier()

SFichier & Sonde_Int::fichier ( )

inline

Returns the output file stream used by the probe.

Returns: the output file stream used by the probe

Definition at line 153 of file Sonde_Int.h.

◆ fixer_periode()

void Sonde_Int::fixer_periode ( double pe )

inline

Sets the sampling period for probing the field.

Parameters

pe	the sampling period

Definition at line 113 of file Sonde_Int.h.

◆ initialiser()

void Sonde_Int::initialiser ( const Domaine & domaine_geom )

Initialises the probe.

Sizes the value arrays and checks that the specified points lie within the computation domain.

Parameters

domaine_geom the computation domain to be probed

Exceptions

probe point outside the computation domain

Definition at line 267 of file Sonde_Int.cpp.

◆ le_tableau()

const IntVect & Sonde_Int::le_tableau ( ) const

inline

Returns the associated array.

Returns: the associated integer array

Definition at line 123 of file Sonde_Int.h.

◆ les_poly()

const IntVect & Sonde_Int::les_poly ( ) const

inline

Returns the array of elements being probed.

Returns: the elements being probed

Definition at line 143 of file Sonde_Int.h.

◆ les_positions()

const DoubleTab & Sonde_Int::les_positions ( ) const

inline

Returns the array of probed positions.

Returns: the probed positions

Definition at line 133 of file Sonde_Int.h.

◆ mettre_a_jour()

void Sonde_Int::mettre_a_jour	(	double	un_temps,
		double	tinit )

Updates the probe in time and performs post-processing.

Parameters

un_temps	the update time
tinit	the initial time of the probe

Definition at line 438 of file Sonde_Int.cpp.

◆ ouvrir_fichier()

void Sonde_Int::ouvrir_fichier ( )

Opens the file associated with the probe.

(*.son)

Definition at line 294 of file Sonde_Int.cpp.

◆ postraiter()

void Sonde_Int::postraiter ( double un_temps )

Performs post-processing.

Writes the array values at the requested positions to the associated file.

Parameters

un_temps the current time

Definition at line 456 of file Sonde_Int.cpp.

◆ temps()

double Sonde_Int::temps ( ) const

inline

Returns the elapsed time.

Returns: the elapsed time

Definition at line 90 of file Sonde_Int.h.

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

/home/docs/trust-code/src/Kernel/Postraitement/Sonde_Int.h
/home/docs/trust-code/src/Kernel/Postraitement/Sonde_Int.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Sonde_Int()

◆ ~Sonde_Int()

Member Function Documentation

◆ associer_post()

◆ fermer_fichier()

◆ fichier()

◆ fixer_periode()

◆ initialiser()

◆ le_tableau()

◆ les_poly()

◆ les_positions()

◆ mettre_a_jour()

◆ ouvrir_fichier()

◆ postraiter()

◆ temps()