#include <Sonde_IJK.h>

Inheritance diagram for Sonde_IJK:

Collaboration diagram for Sonde_IJK:

Public Member Functions
void	completer () override
Public Member Functions inherited from Sonde
	Sonde ()
	Default constructor for a probe.
	Sonde (const Nom &)
	Constructor for a probe, given its name.
void	associer_post (const Postraitement &)
	Associates the post-processing object with the probe.
virtual void	initialiser ()
	Initialises the probe.
virtual void	mettre_a_jour (double temps, double tinit)
	Updates the probe in time and performs the post-processing.
virtual void	postraiter ()
	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 Champ_Generique_base &	le_champ () const
	Returns the associated field.
const DoubleTab &	les_positions_sondes_initiales () const
	Returns the array of positions of the field that are probed.
const DoubleTab &	les_positions_sondes () const
const DoubleTab &	les_positions () const
const IntVect &	les_poly () const
	Returns the array of elements that are probed.
void	fixer_periode (double)
	Sets the period at which the field is probed.
double	temps () const
	The elapsed time.
SFichier &	fichier ()
	Returns an output file stream pointing to the output file used by the probe.
	~Sonde () override
	Destructor.
const Nom &	get_nom () const
const Nom &	get_type () const
const int &	get_dim () const
void	nommer (const Nom &n) override
	Assigns a name to the Objet_U. Virtual method to override.
virtual void	ajouter_bords (const DoubleTab &coords_bords)
virtual void	init_bords ()
virtual void	mettre_a_jour_bords ()
void	resetTime (double time)
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 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
const Domaine &	get_domaine_geom () const override
const Noms	get_noms_champ () const override
int	get_nb_compo_champ () const override
double	get_temps_champ () const override
void	validate_type (const Motcle &loc) const override
void	validate_position () const override
void	create_champ_generique (Entree &is, const Motcle &motlu) override
void	fix_probe_position () override
void	fix_probe_position_grav () override
void	fill_local_values () override
void	update_source (double un_temps) override
	OBS_PTR (Probleme_FTD_IJK_base) ref_ijk_ft_
	OBS_PTR (IJK_Field_double) ref_ijk_field_
Protected Member Functions inherited from Sonde
	OBS_PTR (Postraitement) mon_post
	OBS_PTR (Champ_Generique_base) mon_champ
	OBS_PTR (Operateur_Statistique_tps_base) operateur_statistique_
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
IJK_Field_double	tmp_storage_
int	ncomp = 1
	Number of the component to handle.
int	nbre_points_tot
Protected Attributes inherited from Sonde
Nom	nom_
	the probe name
Nom	nom_fichier_
	the name of the file containing the probe
int	dim
	the dimension of the probe (point:0,segment:1,plan:2,volume:3)
int	ncomp
DoubleTab	les_positions_sondes_initiales_
	coordinates of the initial point probes
DoubleTab	les_positions_sondes_
	coordinates of probes across the whole domain after displacement (master only)
DoubleTab	les_positions_
	coordinates of probes local to each proc
int	numero_elem_
	equals -1 if undefined, otherwise the element number on the master
IntVect	elem_
	elements containing the local point probes
double	periode
	sampling period
bool	nodes = false
bool	chsom = false
bool	grav = false
bool	gravcl = false
bool	som = false
DoubleTab	valeurs_locales
DoubleTab	valeurs_sur_maitre
	valeurs_locales: values on each proc, valeurs_sur_maitre: values gathered on the master
double	nb_bip
SFichier	le_fichier_
Motcle	nom_champ_lu_
ArrsOfInt	participant
Nom	type_
int	orientation_faces_
ArrOfInt	faces_bords_
	array containing the indices of the boundary faces hit by the probe
IntTab	rang_cl_
	for a given face, index of the CL that this face bears
int	nbre_points1 = -1
int	nbre_points2 = -1
int	nbre_points3 = -1
	used to create sonde_segment, sonde_plan, etc...

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

class Sonde_IJK

Definition at line 28 of file Sonde_IJK.h.

Member Function Documentation

◆ completer()

void Sonde_IJK::completer ( )

overridevirtual

Reimplemented from Sonde.

Definition at line 34 of file Sonde_IJK.cpp.

◆ create_champ_generique()

void Sonde_IJK::create_champ_generique	(	Entree &	is,
		const Motcle &	motlu )

inlineoverrideprotectedvirtual

Creation of Champ_Generique_refChamp objects needed for initializing the REF to Champ_Generique_base. If the requested field is a Champ_base known to the problem, the corresponding Champ_Generique_refChamp is created.

Reimplemented from Sonde.

Definition at line 44 of file Sonde_IJK.h.

◆ fill_local_values()

void Sonde_IJK::fill_local_values ( )

overrideprotectedvirtual

Fill the array 'valeurs_locales' used by each proc to store prob local values

Reimplemented from Sonde.

Definition at line 186 of file Sonde_IJK.cpp.

◆ fix_probe_position()

void Sonde_IJK::fix_probe_position ( )

overrideprotectedvirtual

Fix probe position. In IJK, if no position modifier is specified, we systematically move the probe to the center of the element for a ELEM field, and to the face corresponding to the field component if this is a FACE field.

Reimplemented from Sonde.

Definition at line 180 of file Sonde_IJK.cpp.

◆ fix_probe_position_grav()

void Sonde_IJK::fix_probe_position_grav ( )

overrideprotectedvirtual

In IJK, velocity components might be interpolated/moved to element center. This is equivalent to having a ELEM field.

Reimplemented from Sonde.

Definition at line 107 of file Sonde_IJK.cpp.

◆ get_domaine_geom()

const Domaine & Sonde_IJK::get_domaine_geom ( ) const

overrideprotectedvirtual

Retrieve the domain to be used for the probe

Reimplemented from Sonde.

Definition at line 79 of file Sonde_IJK.cpp.

◆ get_nb_compo_champ()

int Sonde_IJK::get_nb_compo_champ ( ) const

overrideprotectedvirtual

Retrieve the number of component for the field - overriden in IJK

Reimplemented from Sonde.

Definition at line 92 of file Sonde_IJK.cpp.

◆ get_noms_champ()

const Noms Sonde_IJK::get_noms_champ ( ) const

overrideprotectedvirtual

Retrieve the field names - overriden in IJK

Reimplemented from Sonde.

Definition at line 85 of file Sonde_IJK.cpp.

◆ get_temps_champ()

double Sonde_IJK::get_temps_champ ( ) const

overrideprotectedvirtual

Retrieve the current time for the field - overriden in IJK

Reimplemented from Sonde.

Definition at line 98 of file Sonde_IJK.cpp.

◆ OBS_PTR() [1/2]

Sonde_IJK::OBS_PTR ( IJK_Field_double )

protected

◆ OBS_PTR() [2/2]

Sonde_IJK::OBS_PTR ( Probleme_FTD_IJK_base )

protected

◆ update_source()

void Sonde_IJK::update_source ( double un_temps )

inlineoverrideprotectedvirtual

Update the underlying field source if needed

Reimplemented from Sonde.

Definition at line 48 of file Sonde_IJK.h.

◆ validate_position()

void Sonde_IJK::validate_position ( ) const

overrideprotectedvirtual

Override. Exit if invalid localisation for the probe.

Reimplemented from Sonde.

Definition at line 73 of file Sonde_IJK.cpp.

◆ validate_type()

void Sonde_IJK::validate_type ( const Motcle & loc ) const

overrideprotectedvirtual

Override. Exit if invalid type for the probe.

Reimplemented from Sonde.

Definition at line 54 of file Sonde_IJK.cpp.

Member Data Documentation

◆ nbre_points_tot

int Sonde_IJK::nbre_points_tot

protected

Definition at line 55 of file Sonde_IJK.h.

◆ ncomp

int Sonde_IJK::ncomp = 1

protected

Number of the component to handle.

Definition at line 54 of file Sonde_IJK.h.

◆ tmp_storage_

IJK_Field_double Sonde_IJK::tmp_storage_

protected

Definition at line 52 of file Sonde_IJK.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/triocfd-documentation/checkouts/next/src/Multiphase/Front_tracking_discontinu/IJK/Kernel/Postraitement/Sonde_IJK.h
/home/docs/checkouts/readthedocs.org/user_builds/triocfd-documentation/checkouts/next/src/Multiphase/Front_tracking_discontinu/IJK/Kernel/Postraitement/Sonde_IJK.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ completer()

◆ create_champ_generique()

◆ fill_local_values()

◆ fix_probe_position()

◆ fix_probe_position_grav()

◆ get_domaine_geom()

◆ get_nb_compo_champ()

◆ get_noms_champ()

◆ get_temps_champ()

◆ OBS_PTR() [1/2]

◆ OBS_PTR() [2/2]

◆ update_source()

◆ validate_position()

◆ validate_type()

Member Data Documentation

◆ nbre_points_tot

◆ ncomp

◆ tmp_storage_