TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Joint_Items_32_64< _SIZE_ > Class Template Reference

Joint_Items holds the parallel distribution information for a particular geometric item type with a particular neighboring domain (item = vertex, element, face, etc.). More...

#include <Joint_Items.h>

Public Types

using int_t = _SIZE_
using ArrOfInt_t = ArrOfInt_T<_SIZE_>
using IntTab_t = IntTab_T<_SIZE_>

Public Member Functions

 Joint_Items_32_64 ()
 default constructor
void reset ()
 Resets to the initial state obtained after the default constructor.
int nb_items_reels () const
 Returns the number of real items. Not yet used.
const ArrOfInt_t & items_communs () const
const ArrOfInt_t & items_distants () const
 Returns the items_distants_ array (read-only). See items_distants_.
int nb_items_virtuels () const
 Returns the number of virtual items. See nb_items_virtuels_.
const IntTab_t & renum_items_communs () const
 Returns the renum_items_communs_ array (read-only). See renum_items_communs_.
void set_nb_items_reels (int n)
 Sets the number of real items. Not yet used.
ArrOfInt_t & set_items_communs ()
 Returns the items_communs_ array for filling.
ArrOfInt_t & set_items_distants ()
 Returns the items_distants_ array for filling.
void set_nb_items_virtuels (int n)
 Sets the number of virtual items. See nb_items_virtuels_.
IntTab_t & set_renum_items_communs ()
 Returns the renum_items_communs_ array for filling. See renum_items_communs_.

Detailed Description

template<typename _SIZE_>
class Joint_Items_32_64< _SIZE_ >

Joint_Items holds the parallel distribution information for a particular geometric item type with a particular neighboring domain (item = vertex, element, face, etc.).

These structures are initialised in Scatter and are then used, for example, to create a distributed array indexed by geometric item indices.

See also
class Joint

Definition at line 30 of file Joint_Items.h.

Member Typedef Documentation

◆ ArrOfInt_t

template<typename _SIZE_>
using Joint_Items_32_64< _SIZE_ >::ArrOfInt_t = ArrOfInt_T<_SIZE_>

Definition at line 35 of file Joint_Items.h.

◆ int_t

template<typename _SIZE_>
using Joint_Items_32_64< _SIZE_ >::int_t = _SIZE_

Definition at line 34 of file Joint_Items.h.

◆ IntTab_t

template<typename _SIZE_>
using Joint_Items_32_64< _SIZE_ >::IntTab_t = IntTab_T<_SIZE_>

Definition at line 36 of file Joint_Items.h.

Constructor & Destructor Documentation

◆ Joint_Items_32_64()

template<typename _SIZE_>
Joint_Items_32_64< _SIZE_ >::Joint_Items_32_64 ( )

default constructor

Definition at line 26 of file Joint_Items.cpp.

Member Function Documentation

◆ items_communs()

template<typename _SIZE_>
const ArrOfInt_t & Joint_Items_32_64< _SIZE_ >::items_communs ( ) const
inline

Definition at line 44 of file Joint_Items.h.

◆ items_distants()

template<typename _SIZE_>
const Joint_Items_32_64< _SIZE_ >::ArrOfInt_t & Joint_Items_32_64< _SIZE_ >::items_distants ( ) const

Returns the items_distants_ array (read-only). See items_distants_.

Returns
Const reference to the items_distants_ array.

Definition at line 65 of file Joint_Items.cpp.

◆ nb_items_reels()

template<typename _SIZE_>
int Joint_Items_32_64< _SIZE_ >::nb_items_reels ( ) const

Returns the number of real items. Not yet used.

Intended to facilitate creation of distributed arrays, but joints are not the right place to store this value: it must be storable even when there is no neighboring processor.

Returns
Number of real items.

Definition at line 152 of file Joint_Items.cpp.

◆ nb_items_virtuels()

template<typename _SIZE_>
int Joint_Items_32_64< _SIZE_ >::nb_items_virtuels ( ) const

Returns the number of virtual items. See nb_items_virtuels_.

Returns
Number of virtual items received from the neighboring domain.

Definition at line 102 of file Joint_Items.cpp.

◆ renum_items_communs()

template<typename _SIZE_>
const Joint_Items_32_64< _SIZE_ >::IntTab_t & Joint_Items_32_64< _SIZE_ >::renum_items_communs ( ) const

Returns the renum_items_communs_ array (read-only). See renum_items_communs_.

Returns
Const reference to the renum_items_communs_ array.

Definition at line 126 of file Joint_Items.cpp.

◆ reset()

template<typename _SIZE_>
void Joint_Items_32_64< _SIZE_ >::reset ( )

Resets to the initial state obtained after the default constructor.

Definition at line 37 of file Joint_Items.cpp.

◆ set_items_communs()

template<typename _SIZE_>
Joint_Items_32_64< _SIZE_ >::ArrOfInt_t & Joint_Items_32_64< _SIZE_ >::set_items_communs ( )

Returns the items_communs_ array for filling.

Note
(BM: this array is not yet filled)
Returns
Reference to the items_communs_ array.

Definition at line 54 of file Joint_Items.cpp.

◆ set_items_distants()

template<typename _SIZE_>
Joint_Items_32_64< _SIZE_ >::ArrOfInt_t & Joint_Items_32_64< _SIZE_ >::set_items_distants ( )

Returns the items_distants_ array for filling.

See also
Scatter::calculer_espace_distant, Scatter::calculer_espace_distant_faces_frontieres, Scatter::calculer_espace_distant_elements
Returns
Reference to the items_distants_ array.

Definition at line 79 of file Joint_Items.cpp.

◆ set_nb_items_reels()

template<typename _SIZE_>
void Joint_Items_32_64< _SIZE_ >::set_nb_items_reels ( int n)

Sets the number of real items. Not yet used.

Parameters
nNumber of real items.

Definition at line 137 of file Joint_Items.cpp.

◆ set_nb_items_virtuels()

template<typename _SIZE_>
void Joint_Items_32_64< _SIZE_ >::set_nb_items_virtuels ( int n)

Sets the number of virtual items. See nb_items_virtuels_.

See also
Scatter::calculer_nb_items_virtuels
Parameters
nNumber of virtual items received from the neighboring domain.

Definition at line 91 of file Joint_Items.cpp.

◆ set_renum_items_communs()

template<typename _SIZE_>
Joint_Items_32_64< _SIZE_ >::IntTab_t & Joint_Items_32_64< _SIZE_ >::set_renum_items_communs ( )

Returns the renum_items_communs_ array for filling. See renum_items_communs_.

See also
Scatter::calculer_colonne0_renum_faces_communes, Scatter::construire_correspondance_sommets_par_coordonnees
Returns
Reference to the renum_items_communs_ array.

Definition at line 115 of file Joint_Items.cpp.

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