TrioCFD 1.9.8
TrioCFD documentation
Loading...
Searching...
No Matches
IJK_Field_vector< T, N > Class Template Reference

The class IJK_Field_vector is a fixed array of polymorphic IJK fields. More...

#include <IJK_Field_vector.h>

Inheritance diagram for IJK_Field_vector< T, N >:
[legend]
Collaboration diagram for IJK_Field_vector< T, N >:
[legend]

Public Member Functions

unsigned taille_memoire () const override
int duplique () const override
SortieprintOn (Sortie &os) const override
 Ecriture de l'objet sur un flot de sortie Methode a surcharger.
EntreereadOn (Entree &is) override
 Lecture d'un Objet_U sur un flot d'entree Methode a surcharger.
 IJK_Field_vector ()
void nommer (const Nom &nam) override
 Donne un nom au champ.
void add_synonymous (const Nom &nam) override
Entity & localisation ()
const Entity & localisation () const
IJK_Field_template< T, TRUSTArray< T > > & operator[] (int i)
const IJK_Field_template< T, TRUSTArray< T > > & operator[] (int i) const
std::shared_ptr< IJK_Field_template< T, TRUSTArray< T > > > & get_ptr (int i)
const std::shared_ptr< IJK_Field_template< T, TRUSTArray< T > > > & get_ptr (int i) const
void echange_espace_virtuel ()
const Domaine_IJKget_domaine () const
Public Member Functions inherited from FixedVector< std::shared_ptr< IJK_Field_template< T, TRUSTArray< T > > >, N >
 FixedVector (int i, int j, int k)
T & operator[] (int i)
void echange_espace_virtuel ()
const Domaine_IJKget_domaine () const
Public Member Functions inherited from Field_base
 Field_base ()
 Field_base (const Field_base &other)=default
const Nomle_nom () const override
 Renvoie le nom du champ.
const Nomsget_synonyms () const
virtual int nb_comp () const
virtual void fixer_nb_comp (int i)
 Fixe le nombre de composantes du champ.
virtual int nb_vect_comp () const
const Nomsnoms_compo () const
 Renvoie le tableau des noms des composantes du champ.
const Nomnom_compo (int) const
 Renvoie le nom de la ieme composante du champ.
const Nomnom_compo () const
 Renvoie le nom d'un champ scalaire.
virtual const Nomsfixer_noms_compo (const Noms &)
 Fixe le nom des composantes du champ.
virtual const Nomfixer_nom_compo (int, const Nom &)
 Fixe le nom de la i-eme composante du champ.
virtual const Nomfixer_nom_compo (const Nom &)
 Fixe le nom d'un champ scalaire.
const Nomsunites () const
 Renvoie les unites des composantes du champ.
const Nomunite () const
 Renvoie l'unite d'un champ scalaire dont toutes les composantes ont la meme unite.
const Nomunite (int) const
 Renvoie l'unite de la i-eme composante du champ.
virtual const Nomsfixer_unites (const Noms &)
 Specifie les unites des composantes du champ.
virtual const Nomfixer_unite (const Nom &)
 Specifie l'unite d'un champ scalaire ou dont toutes les composantes ont la meme unite.
virtual const Nomfixer_unite (int i, const Nom &)
 Specifie l'unite de la i-eme composante du champ Signification: l'index de la composante du champ dont on veut specifier l'unite.
virtual Nature_du_champ nature_du_champ () const
virtual Nature_du_champ fixer_nature_du_champ (Nature_du_champ nat)
 Fixer la nature d'un champ: scalaire, multiscalaire, vectoriel.
bool is_basis_function () const
bool is_quadrature () const
bool is_vectorial () const
bool is_scalar () const
int order_field () const
 Renvoie l'ordre des fonctions de base.
Public Member Functions inherited from Objet_U
 ~Objet_U () override
 Destructeur, supprime l'objet de la liste d'objets enregistres dans "memoire".
int numero () const
 Renvoie l'indice de l'objet dans Memoire::data.
virtual int est_egal_a (const Objet_U &) const
 Renvoie 1 si l'objet x et *this sont une seule et meme instance (meme adresse en memoire).
virtual int reprendre (Entree &)
 Reprise d'un Objet_U sur un flot d'entree Methode a surcharger.
virtual int sauvegarder (Sortie &) const
 Sauvegarde d'un Objet_U sur un flot de sortie Methode a surcharger.
int get_object_id () const
 Renvoie l'identifiant unique de l'objet object_id_.
virtual const Type_infoget_info () const
 Donne des informations sur le type de l'Objet_U.
const Nomque_suis_je () const
 renvoie la chaine identifiant la classe.
const char * le_type () const
 Donne le nom du type de l'Objet_U.
virtual int change_num (const int *const)
 Change le numero interne de l'Objet_U.
virtual int lire_motcle_non_standard (const Motcle &motlu, Entree &is)
 Lecture des parametres de type non simple d'un objet_U a partir d'un flot d'entree.
virtual int associer_ (Objet_U &)
 Associe l'Objet_U a un autre Objet_U Methode virtuelle a surcharger.
const Interpreteinterprete () const
Interpreteinterprete ()
Public Member Functions inherited from Process
virtual ~Process ()

Additional Inherited Members

Static Public Member Functions inherited from FixedVector< std::shared_ptr< IJK_Field_template< T, TRUSTArray< T > > >, N >
static int size ()
Static Public Member Functions inherited from Objet_U
static const Nomnom_du_cas ()
 Renvoie une reference constante vers le nom du cas.
static Nomget_set_nom_du_cas ()
 Renvoie une reference non constante vers le nom du cas (pour pouvoir le modifier).
static const Type_infoinfo ()
 Donne des informations sur le type de l'Objet_U.
static const Objet_Uself_cast (const Objet_U &)
 methode ajoutee pour caster en python
static Objet_Uself_cast (Objet_U &)
Static Public Member Functions inherited from Process
static int me ()
 renvoie mon rang dans le groupe de communication courant.
static int nproc ()
 renvoie le nombre de processeurs dans le groupe courant Voir Comm_Group::nproc() et PE_Groups::current_group()
static bool is_parallel ()
static void exit (int exit_code=-1)
 Routine de sortie de TRUST dans une region Kokkos.
static double mp_sum (double)
 Calcule la somme de x sur tous les processeurs du groupe courant.
static float mp_sum (float)
static trustIdType mp_sum (trustIdType)
 Calcule la somme de x sur tous les processeurs du groupe courant.
static double mp_max (double)
static double mp_min (double)
static int mp_max (int)
 renvoie le plus grand int i sur l'ensemble des processeurs du groupe courant.
static int mp_min (int)
 renvoie le plus petit int i sur l'ensemble des processeurs du groupe courant.
static double mp_sum_as_double (int v)
static trustIdType mppartial_sum (trustIdType i)
 Calul de la somme partielle de i sur les processeurs 0 a me()-1 (renvoie 0 sur le processeur 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)
 Calcule le 'et' logique de b sur tous les processeurs du groupe courant.
static bool mp_or (bool)
static int check_int_overflow (trustIdType)
static int je_suis_maitre ()
 renvoie 1 si on est sur le processeur maitre du groupe courant (c'est a dire me() == 0), 0 sinon.
static KOKKOS_INLINE_FUNCTION void Kokkos_exit (const char *)
 Routine de sortie de TRUST dans une region Kokkos.
static int node_master ()
 renvoie 1 si on est sur le processeur maitre du noeud numa, 0 sinon.
static void exit (const Nom &message, int exit_code=-1)
static bool is_sequential ()
static void barrier ()
 Synchronise tous les processeurs du groupe courant (attend que tous les processeurs soient arrives a la barriere).
static void abort ()
 Routine de sortie de Trio-U sur une erreur abort().
static SortieJournal (int message_level=0)
 Renvoie un objet statique de type Sortie qui sert de journal d'evenements.
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 ()
 Constructeur par defaut : attribue un numero d'identifiant unique a l'objet (object_id_), et enregistre l'objet en "memoire".
 Objet_U (const Objet_U &)
 Constructeur par copie.
const Objet_Uoperator= (const Objet_U &)
 Operateur= : ne fait rien (on conserve le numero et l'identifiant).
virtual void set_param (Param &) const
Protected Attributes inherited from FixedVector< std::shared_ptr< IJK_Field_template< T, TRUSTArray< T > > >, N >
data_ [N]
Protected Attributes inherited from Field_base
Nom nom_
Noms noms_synonymes_
Noms noms_compo_
Noms unite_
int nb_compo_
Nature_du_champ nature_

Detailed Description

template<class T, int N>
class IJK_Field_vector< T, N >

The class IJK_Field_vector is a fixed array of polymorphic IJK fields.

For example, the velocity is a fixed vector with 3 components. Each component is a (smart) pointer, thus allowing any derived class of IJK_Field_template to be used (this is used for example in cut-cell methods).

The bracket '[]' operator allows the direct retrieval of a reference to one of the components.

The function IJK_Navier_stokes_tools.h::allocate_velocity() gives an example on how the object is instanciated:

  // Construction of the IJK_Field_template objects
  v.get_ptr(0) = std::make_shared<IJK_Field_template<T,TRUSTArray<T>>>();
  v.get_ptr(1) = std::make_shared<IJK_Field_template<T,TRUSTArray<T>>>();
  v.get_ptr(2) = std::make_shared<IJK_Field_template<T,TRUSTArray<T>>>();

  // Allocation of the fields
  v[0].allocate(s, Domaine_IJK::FACES_I, ghost);
  v[1].allocate(s, Domaine_IJK::FACES_J, ghost);
  v[2].allocate(s, Domaine_IJK::FACES_K, ghost);

The class inherits from Field_base and a IJK_Field_vector can thus be named. It has a default Nature of 'vectoriel'.

Definition at line 48 of file IJK_Field_vector.h.

Constructor & Destructor Documentation

◆ IJK_Field_vector()

template<class T, int N>
IJK_Field_vector< T, N >::IJK_Field_vector ( )
inline

Definition at line 63 of file IJK_Field_vector.h.

Member Function Documentation

◆ add_synonymous()

template<class T, int N>
void IJK_Field_vector< T, N >::add_synonymous ( const Nom & nam)
inlineoverridevirtual

Reimplemented from Field_base.

Definition at line 85 of file IJK_Field_vector.h.

◆ duplique()

template<class T, int N>
int IJK_Field_vector< T, N >::duplique ( ) const
inlineoverridevirtual

Implements Objet_U.

Definition at line 53 of file IJK_Field_vector.h.

◆ echange_espace_virtuel()

template<class T, int N>
void IJK_Field_vector< T, N >::echange_espace_virtuel ( )
inline

Definition at line 120 of file IJK_Field_vector.h.

◆ get_domaine()

template<class T, int N>
const Domaine_IJK & IJK_Field_vector< T, N >::get_domaine ( ) const
inline

Definition at line 126 of file IJK_Field_vector.h.

◆ get_ptr() [1/2]

template<class T, int N>
std::shared_ptr< IJK_Field_template< T, TRUSTArray< T > > > & IJK_Field_vector< T, N >::get_ptr ( int i)
inline

Definition at line 108 of file IJK_Field_vector.h.

◆ get_ptr() [2/2]

template<class T, int N>
const std::shared_ptr< IJK_Field_template< T, TRUSTArray< T > > > & IJK_Field_vector< T, N >::get_ptr ( int i) const
inline

Definition at line 114 of file IJK_Field_vector.h.

◆ localisation() [1/2]

template<class T, int N>
Entity & IJK_Field_vector< T, N >::localisation ( )
inline

Definition at line 93 of file IJK_Field_vector.h.

◆ localisation() [2/2]

template<class T, int N>
const Entity & IJK_Field_vector< T, N >::localisation ( ) const
inline

Definition at line 94 of file IJK_Field_vector.h.

◆ nommer()

template<class T, int N>
void IJK_Field_vector< T, N >::nommer ( const Nom & name)
inlineoverridevirtual

Donne un nom au champ.

Parameters
(Nom&name) le nom a donner au champ

Reimplemented from Field_base.

Definition at line 70 of file IJK_Field_vector.h.

◆ operator[]() [1/2]

template<class T, int N>
IJK_Field_template< T, TRUSTArray< T > > & IJK_Field_vector< T, N >::operator[] ( int i)
inline

Definition at line 96 of file IJK_Field_vector.h.

◆ operator[]() [2/2]

template<class T, int N>
const IJK_Field_template< T, TRUSTArray< T > > & IJK_Field_vector< T, N >::operator[] ( int i) const
inline

Definition at line 102 of file IJK_Field_vector.h.

◆ printOn()

template<class T, int N>
Sortie & IJK_Field_vector< T, N >::printOn ( Sortie & s) const
inlineoverridevirtual

Ecriture de l'objet sur un flot de sortie Methode a surcharger.

Parameters
(Sortie&s) flot de sortie
Returns
(Sortie&) flot de sortie modifie

Reimplemented from Objet_U.

Definition at line 59 of file IJK_Field_vector.h.

◆ readOn()

template<class T, int N>
Entree & IJK_Field_vector< T, N >::readOn ( Entree & s)
inlineoverridevirtual

Lecture d'un Objet_U sur un flot d'entree Methode a surcharger.

Parameters
(Entree&s) flot d'entree
Returns
(Entree& s) flot d'entree modifie

Reimplemented from Objet_U.

Definition at line 60 of file IJK_Field_vector.h.

◆ taille_memoire()

template<class T, int N>
unsigned IJK_Field_vector< T, N >::taille_memoire ( ) const
inlineoverridevirtual

Implements Objet_U.

Definition at line 52 of file IJK_Field_vector.h.


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