#include <Objet_U_ptr.h>

Inheritance diagram for Objet_U_ptr:

Collaboration diagram for Objet_U_ptr:

Public Member Functions
	Objet_U_ptr (const Objet_U_ptr &)=delete
const Objet_U_ptr &	operator= (const Objet_U_ptr &)=delete
	operator bool () const noexcept
const Nom &	le_nom () const override
	Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.
void	nommer (const Nom &) override
	Assigns a name to the Objet_U. Virtual method to override.
Objet_U *	typer (const char *nom_type)
	Tries to create an instance of type "type".
void	detach ()
int	associer_ (Objet_U &objet) override
	Associates the Objet_U with another Objet_U. Virtual method to override.
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 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	lire_motcle_non_standard (const Motcle &motlu, Entree &is)
	Reads non-simple-type parameters of an Objet_U from an input stream.
const Interprete &	interprete () const
Interprete &	interprete ()
Public Member Functions inherited from Process
virtual	~Process ()

Static Public Attributes
static constexpr bool	HAS_POINTER = true
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
	~Objet_U_ptr () override
	Destructor.
	Objet_U_ptr ()
	Builds a null pointer (key set to -1).
virtual void	set_Objet_U_ptr (Objet_U *)
	Makes this point to the object ptr. The address may be null (null pointer).
virtual Objet_U *	get_Objet_U_ptr () const
	Returns a pointer to the associated Objet_U. WARNING: the address may be null (if the pointer is null).
void	recopie (const Objet_U &)
	Duplicates the Objet_U obj and then changes the pointer to this copy.
int	change_num (const int *const) override
	Updates keys when Objet_U objects have been renumbered.
Objet_U *	get_Objet_U_ptr_check () const
	Checks if the pointer is valid.
int	check_Objet_U_ptr_type (const Objet_U *ptr) const
	Verifies that the object pointed to by ptr is of an acceptable type for the pointer (via get_info_ptr).
virtual const Type_info &	get_info_ptr () const =0
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
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)

Detailed Description

Pointer to an Objet_U.

The default constructor builds a "null" pointer.

See also: TRUST_Deriv

Definition at line 30 of file Objet_U_ptr.h.

Constructor & Destructor Documentation

◆ Objet_U_ptr() [1/2]

Objet_U_ptr::Objet_U_ptr ( const Objet_U_ptr & )

delete

◆ ~Objet_U_ptr()

Objet_U_ptr::~Objet_U_ptr ( )

overrideprotected

Destructor.

It does not destroy the referenced object.

Definition at line 59 of file Objet_U_ptr.cpp.

◆ Objet_U_ptr() [2/2]

Objet_U_ptr::Objet_U_ptr ( )

protected

Builds a null pointer (key set to -1).

Definition at line 67 of file Objet_U_ptr.cpp.

Member Function Documentation

◆ associer_()

int Objet_U_ptr::associer_ ( Objet_U & obj )

overridevirtual

Associates the Objet_U with another Objet_U. Virtual method to override.

Parameters

obj	The Objet_U to associate with.

Returns: Return code.

Reimplemented from Objet_U.

Definition at line 76 of file Objet_U_ptr.cpp.

◆ change_num()

int Objet_U_ptr::change_num ( const int * const new_ones )

overrideprotectedvirtual

Updates keys when Objet_U objects have been renumbered.

Parameters

(const int* const new_ones) array of new numbering

Returns: (int) the new key of the pointer

Reimplemented from Objet_U.

Definition at line 156 of file Objet_U_ptr.cpp.

◆ check_Objet_U_ptr_type()

int Objet_U_ptr::check_Objet_U_ptr_type ( const Objet_U * ptr ) const

protected

Verifies that the object pointed to by ptr is of an acceptable type for the pointer (via get_info_ptr).

Definition at line 123 of file Objet_U_ptr.cpp.

◆ detach()

void Objet_U_ptr::detach ( )

Definition at line 69 of file Objet_U_ptr.cpp.

◆ get_info_ptr()

virtual const Type_info & Objet_U_ptr::get_info_ptr ( ) const

protectedpure virtual

Implemented in TRUST_Deriv< _CLASSE_ >, TRUST_Deriv< Discretisation_base >, and TRUST_Deriv_Objet_U.

◆ get_Objet_U_ptr()

Objet_U * Objet_U_ptr::get_Objet_U_ptr ( ) const

protectedvirtual

Returns a pointer to the associated Objet_U. WARNING: the address may be null (if the pointer is null).

Definition at line 182 of file Objet_U_ptr.cpp.

◆ get_Objet_U_ptr_check()

Objet_U * Objet_U_ptr::get_Objet_U_ptr_check ( ) const

protected

Checks if the pointer is valid.

The pointer is valid if cle_==-1 or if la_memoire().objet_u(cle_) has the same object_id_ as the one registered in ptr_object_id_. If the pointer is not valid, the program stops. Returns the address of the pointed object (of type Objet_U).

Definition at line 94 of file Objet_U_ptr.cpp.

◆ le_nom()

const Nom & Objet_U_ptr::le_nom ( ) const

inlineoverridevirtual

Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.

Returns: The name of the Objet_U.

Reimplemented from Objet_U.

Definition at line 46 of file Objet_U_ptr.h.

◆ nommer()

void Objet_U_ptr::nommer ( const Nom & nom )

inlineoverridevirtual

Assigns a name to the Objet_U. Virtual method to override.

Parameters

nom	The name to assign to the Objet_U.

Reimplemented from Objet_U.

Definition at line 52 of file Objet_U_ptr.h.

◆ operator bool()

Objet_U_ptr::operator bool ( ) const

inlineexplicitnoexcept

Definition at line 39 of file Objet_U_ptr.h.

◆ operator=()

const Objet_U_ptr & Objet_U_ptr::operator= ( const Objet_U_ptr & )

delete

◆ recopie()

void Objet_U_ptr::recopie ( const Objet_U & obj )

protected

Duplicates the Objet_U obj and then changes the pointer to this copy.

Parameters

(const Objet_U& obj) reference to the Objet_U to copy

Definition at line 171 of file Objet_U_ptr.cpp.

◆ set_Objet_U_ptr()

void Objet_U_ptr::set_Objet_U_ptr ( Objet_U * ptr )

protectedvirtual

Makes *this point to the object *ptr. The address may be null (null pointer).

Reimplemented in TRUST_Deriv< _CLASSE_ >, TRUST_Deriv< Discretisation_base >, and TRUST_Deriv_Objet_U.

Definition at line 201 of file Objet_U_ptr.cpp.

◆ typer()

Objet_U * Objet_U_ptr::typer ( const char * type )

Tries to create an instance of type "type".

If type is not a type or type is not instantiable => stop. If type is not a subtype of the pointer type => return 0. If ok, returns the address of the created object.

Definition at line 224 of file Objet_U_ptr.cpp.

Member Data Documentation

◆ HAS_POINTER

bool Objet_U_ptr::HAS_POINTER = true

staticconstexpr

Definition at line 35 of file Objet_U_ptr.h.

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

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Objet_U_ptr() [1/2]

◆ ~Objet_U_ptr()

◆ Objet_U_ptr() [2/2]

Member Function Documentation

◆ associer_()

◆ change_num()

◆ check_Objet_U_ptr_type()

◆ detach()

◆ get_info_ptr()

◆ get_Objet_U_ptr()

◆ get_Objet_U_ptr_check()

◆ le_nom()

◆ nommer()

◆ operator bool()

◆ operator=()

◆ recopie()

◆ set_Objet_U_ptr()

◆ typer()

Member Data Documentation

◆ HAS_POINTER