TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ > Class Template Reference

This is an array with [] operator. More...

#include <IJKArray_with_ghost.h>

Inheritance diagram for IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >:
[legend]
Collaboration diagram for IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >:
[legend]

Public Member Functions

 IJKArray_with_ghost ()
void resize (int n, int new_ghost)
_TYPE_ operator[] (int i) const
_TYPE_ & operator[] (int i)
const _TYPE_ARRAY_ & data () const
int size () const
int ghost () const
void echange_espace_virtuel (int pe_min, int pe_max)
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 est_egal_a (const Objet_U &) const
 Returns 1 if x and *this are the same instance (same memory address).
virtual const Nomle_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_infoget_info () const
 Returns type information for the Objet_U.
const Nomque_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 Interpreteinterprete () const
Interpreteinterprete ()
Public Member Functions inherited from Process
virtual ~Process ()

Protected Member Functions

unsigned taille_memoire () const override
int duplique () const override
SortieprintOn (Sortie &os) const override
 Writes the object to an output stream. Virtual method to override.
EntreereadOn (Entree &is) override
 Reads an Objet_U from an input stream. Virtual method to override.
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_Uoperator= (const Objet_U &)
 Assignment operator: does nothing (the number and identifier are preserved).
virtual void set_param (Param &) const

Protected Attributes

_TYPE_ARRAY_ tab_
int ghost_

Additional Inherited Members

Static Public Member Functions inherited from Objet_U
static const Nomnom_du_cas ()
 Returns a constant reference to the case name. This method is static.
static Nomget_set_nom_du_cas ()
 Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_infoinfo ()
 Returns type information for the Objet_U (static version).
static const Objet_Uself_cast (const Objet_U &)
 Method added for casting in Python.
static Objet_Uself_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 SortieJournal (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

template<typename _TYPE_, typename _TYPE_ARRAY_>
class IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >

This is an array with [] operator.

Allocate array with resize(n, ghost). tab[i] is valid for "-ghost <= i < n + ghost"

Definition at line 33 of file IJKArray_with_ghost.h.

Constructor & Destructor Documentation

◆ IJKArray_with_ghost()

template<typename _TYPE_, typename _TYPE_ARRAY_>
IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::IJKArray_with_ghost ( )
inline

Definition at line 50 of file IJKArray_with_ghost.h.

Member Function Documentation

◆ data()

template<typename _TYPE_, typename _TYPE_ARRAY_>
const _TYPE_ARRAY_ & IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::data ( ) const
inline

Definition at line 58 of file IJKArray_with_ghost.h.

◆ duplique()

template<typename _TYPE_, typename _TYPE_ARRAY_>
int IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::duplique ( ) const
inlineoverrideprotectedvirtual

Implements Objet_U.

Definition at line 38 of file IJKArray_with_ghost.h.

◆ echange_espace_virtuel()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::echange_espace_virtuel ( int pe_min,
int pe_max )
inline

Definition at line 72 of file IJKArray_with_ghost.h.

◆ ghost()

template<typename _TYPE_, typename _TYPE_ARRAY_>
int IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::ghost ( ) const
inline

Definition at line 60 of file IJKArray_with_ghost.h.

◆ operator[]() [1/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>
_TYPE_ & IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::operator[] ( int i)
inline

Definition at line 57 of file IJKArray_with_ghost.h.

◆ operator[]() [2/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>
_TYPE_ IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::operator[] ( int i) const
inline

Definition at line 56 of file IJKArray_with_ghost.h.

◆ printOn()

template<typename _TYPE_, typename _TYPE_ARRAY_>
Sortie & IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::printOn ( Sortie & s) const
inlineoverrideprotectedvirtual

Writes the object to an output stream. Virtual method to override.

Parameters
sOutput stream.
Returns
Modified output stream.

Reimplemented from Objet_U.

Definition at line 45 of file IJKArray_with_ghost.h.

◆ readOn()

template<typename _TYPE_, typename _TYPE_ARRAY_>
Entree & IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::readOn ( Entree & s)
inlineoverrideprotectedvirtual

Reads an Objet_U from an input stream. Virtual method to override.

Parameters
sInput stream.
Returns
Modified input stream.

Reimplemented from Objet_U.

Definition at line 47 of file IJKArray_with_ghost.h.

◆ resize()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::resize ( int n,
int new_ghost )
inline

Definition at line 51 of file IJKArray_with_ghost.h.

◆ size()

template<typename _TYPE_, typename _TYPE_ARRAY_>
int IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::size ( ) const
inline

Definition at line 59 of file IJKArray_with_ghost.h.

◆ taille_memoire()

template<typename _TYPE_, typename _TYPE_ARRAY_>
unsigned IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::taille_memoire ( ) const
inlineoverrideprotectedvirtual

Implements Objet_U.

Definition at line 36 of file IJKArray_with_ghost.h.

Member Data Documentation

◆ ghost_

template<typename _TYPE_, typename _TYPE_ARRAY_>
int IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::ghost_
protected

Definition at line 65 of file IJKArray_with_ghost.h.

◆ tab_

template<typename _TYPE_, typename _TYPE_ARRAY_>
_TYPE_ARRAY_ IJKArray_with_ghost< _TYPE_, _TYPE_ARRAY_ >::tab_
protected

Definition at line 64 of file IJKArray_with_ghost.h.


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