TRUST 1.9.8
HPC thermohydraulic platform
Loading...
Searching...
No Matches
IJK_Field_template< _TYPE_, _TYPE_ARRAY_ > Class Template Reference

: This class is an IJK_Field_local with parallel informations. More...

#include <IJK_Field_template.h>

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

Public Member Functions

 IJK_Field_template ()
void allocate (const Domaine_IJK &d, Domaine_IJK::Localisation l, int ghost_size, int additional_k_layers=0, int nb_compo=1, const Nom &name=Nom(), bool external_storage=false, int monofluide=0, double rov=0., double rol=0., int use_inv_rho_in_pressure_solver=0)
void allocate (const Domaine_IJK &d, Domaine_IJK::Localisation l, int ghost_size, const Nom &name)
virtual void dumplata_scalar (const char *filename, int step) const
const Domaine_IJKget_domaine () const
Domaine_IJK::Localisation get_localisation () const
void echange_espace_virtuel (int ghost)
 Exchange data over "ghost" number of cells.
_TYPE_ interpolation_for_shear_periodicity_IJK_Field (const int send_j, const int send_k)
void interpolation_for_shear_periodicity_I_sig_kappa (const int send_j, const int send_k_zmin, const int send_k_zmax, _TYPE_ &Isigkappazmin, _TYPE_ &Isigkappazmax)
void redistribute_with_shear_domain_ft (const IJK_Field_double &input, double DU_perio, const int ft_extension)
void ajouter_second_membre_shear_perio (IJK_Field_double &resu)
IJK_Shear_Periodic_helplerget_shear_BC_helpler ()
const IJK_Shear_Periodic_helplerget_shear_BC_helpler () const
Public Member Functions inherited from IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ >
 IJK_Field_local_template ()
void allocate (int ni, int nj, int nk, int ghosts, int additional_k_layers=0, int nb_compo=1, bool external_storage=false)
void shift_k_origin (int n)
void ref_ij (IJK_Field_local_template &src, int k_layer)
int linear_index (int i, int j, int k) const
int linear_index (int i, int j, int k, int compo) const
_TYPE_ & operator() (int i, int j, int k)
const _TYPE_ & operator() (int i, int j, int k) const
_TYPE_ & operator() (int i, int j, int k, int compo)
const _TYPE_ & operator() (int i, int j, int k, int compo) const
int linear_index_relaxed_test (int i, int j, int k) const
int linear_index_relaxed_test (int i, int j, int k, int compo) const
_TYPE_ & get_in_allocated_area (int i, int j, int k)
const _TYPE_ & get_in_allocated_area (int i, int j, int k) const
_TYPE_ & get_in_allocated_area (int i, int j, int k, int compo)
const _TYPE_ & get_in_allocated_area (int i, int j, int k, int compo) const
_TYPE_ * k_layer (int k)
const _TYPE_ * k_layer (int k) const
_TYPE_ * k_layer (int k, int compo)
const _TYPE_ * k_layer (int k, int compo) const
int ni () const
int nj () const
int nk () const
int nb_elem_local (int dir) const
int j_stride () const
int compo_stride () const
int k_stride () const
int ghost () const
int k_shift () const
int k_shift_max () const
int get_allocated_size () const
_TYPE_ARRAY_ & data ()
const _TYPE_ARRAY_ & data () const
void ref_ij (IJK_Field_local_float &src, int k_lay)
void ref_ij (IJK_Field_local_double &src, int k_lay)
Public Member Functions inherited from Field_base
 Field_base ()
 Field_base (const Field_base &other)=default
void nommer (const Nom &) override
 Donne un nom au champ.
const Nomle_nom () const override
 Renvoie le nom du champ.
const Nomsget_synonyms () const
virtual void add_synonymous (const Nom &nom)
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 ()

Static Public Member Functions

static void increase_alloc_counter (int i=1)
static int alloc_counter ()
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)

Protected 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.
 OBS_PTR (Domaine_IJK) domaine_ref_
void exchange_data (int pe_imin_, int is, int js, int ks, int pe_imax_, int ir, int jr, int kr, int isz, int jsz, int ksz, double offset_i=0., double jump_i=0., int nb_ghost=0)
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

Domaine_IJK::Localisation localisation_
IJK_Shear_Periodic_helpler shear_BC_helpler_
Protected Attributes inherited from IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ >
int ni_
int nj_
int nk_
int ghost_size_
int j_stride_
int compo_stride_
int offset_
int k_layer_shift_
int additional_k_layers_
int allocated_size_
_TYPE_ARRAY_ data_
Protected Attributes inherited from Field_base
Nom nom_
Noms noms_synonymes_
Noms noms_compo_
Noms unite_
int nb_compo_
Nature_du_champ nature_

Static Protected Attributes

static int alloc_counter_
 To monitor how many field allocations we perform.

Additional Inherited Members

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 IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >

: This class is an IJK_Field_local with parallel informations.

Each processor has a sub_box of the global box, and echange_espace_virtuel(n) exchanges n layers of ghost cells, echange_espace_virtuel handles periodicity by copying the first layer into the ghost layer on the opposite side.

Definition at line 37 of file IJK_Field_template.h.

Constructor & Destructor Documentation

◆ IJK_Field_template()

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

Definition at line 54 of file IJK_Field_template.h.

Member Function Documentation

◆ ajouter_second_membre_shear_perio()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::ajouter_second_membre_shear_perio ( IJK_Field_double & resu)

Definition at line 452 of file IJK_Field_template.tpp.

◆ alloc_counter()

template<typename _TYPE_, typename _TYPE_ARRAY_>
int IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::alloc_counter ( )
inlinestatic

Definition at line 80 of file IJK_Field_template.h.

◆ allocate() [1/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::allocate ( const Domaine_IJK & d,
Domaine_IJK::Localisation l,
int ghost_size,
const Nom & name )
inline

Definition at line 59 of file IJK_Field_template.h.

◆ allocate() [2/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::allocate ( const Domaine_IJK & d,
Domaine_IJK::Localisation l,
int ghost_size,
int additional_k_layers = 0,
int nb_compo = 1,
const Nom & name = Nom(),
bool external_storage = false,
int monofluide = 0,
double rov = 0.,
double rol = 0.,
int use_inv_rho_in_pressure_solver = 0 )

Definition at line 562 of file IJK_Field_template.tpp.

◆ dumplata_scalar()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::dumplata_scalar ( const char * filename,
int step ) const
virtual

Definition at line 576 of file IJK_Field_template.tpp.

◆ duplique()

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

Reimplemented from IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ >.

Definition at line 42 of file IJK_Field_template.h.

◆ echange_espace_virtuel()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::echange_espace_virtuel ( int ghost)

Exchange data over "ghost" number of cells.

Definition at line 287 of file IJK_Field_template.tpp.

◆ exchange_data()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::exchange_data ( int pe_imin_,
int is,
int js,
int ks,
int pe_imax_,
int ir,
int jr,
int kr,
int isz,
int jsz,
int ksz,
double offset_i = 0.,
double jump_i = 0.,
int nb_ghost = 0 )
protected

Definition at line 31 of file IJK_Field_template.tpp.

◆ get_domaine()

template<typename _TYPE_, typename _TYPE_ARRAY_>
const Domaine_IJK & IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::get_domaine ( ) const
inline

Definition at line 66 of file IJK_Field_template.h.

◆ get_localisation()

template<typename _TYPE_, typename _TYPE_ARRAY_>
Domaine_IJK::Localisation IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::get_localisation ( ) const
inline

Definition at line 67 of file IJK_Field_template.h.

◆ get_shear_BC_helpler() [1/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>
IJK_Shear_Periodic_helpler & IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::get_shear_BC_helpler ( )
inline

Definition at line 75 of file IJK_Field_template.h.

◆ get_shear_BC_helpler() [2/2]

template<typename _TYPE_, typename _TYPE_ARRAY_>
const IJK_Shear_Periodic_helpler & IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::get_shear_BC_helpler ( ) const
inline

Definition at line 76 of file IJK_Field_template.h.

◆ increase_alloc_counter()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::increase_alloc_counter ( int i = 1)
inlinestatic

Definition at line 79 of file IJK_Field_template.h.

◆ interpolation_for_shear_periodicity_I_sig_kappa()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::interpolation_for_shear_periodicity_I_sig_kappa ( const int send_j,
const int send_k_zmin,
const int send_k_zmax,
_TYPE_ & Isigkappazmin,
_TYPE_ & Isigkappazmax )

Definition at line 375 of file IJK_Field_template.tpp.

◆ interpolation_for_shear_periodicity_IJK_Field()

template<typename _TYPE_, typename _TYPE_ARRAY_>
_TYPE_ IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::interpolation_for_shear_periodicity_IJK_Field ( const int send_j,
const int send_k )

Definition at line 361 of file IJK_Field_template.tpp.

◆ OBS_PTR()

template<typename _TYPE_, typename _TYPE_ARRAY_>
IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::OBS_PTR ( Domaine_IJK )
protected

◆ printOn()

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

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 IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ >.

Definition at line 49 of file IJK_Field_template.h.

◆ readOn()

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

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 IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ >.

Definition at line 51 of file IJK_Field_template.h.

◆ redistribute_with_shear_domain_ft()

template<typename _TYPE_, typename _TYPE_ARRAY_>
void IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::redistribute_with_shear_domain_ft ( const IJK_Field_double & input,
double DU_perio,
const int ft_extension )

Definition at line 393 of file IJK_Field_template.tpp.

◆ taille_memoire()

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

Reimplemented from IJK_Field_local_template< _TYPE_, _TYPE_ARRAY_ >.

Definition at line 40 of file IJK_Field_template.h.

Member Data Documentation

◆ alloc_counter_

template<typename _TYPE_, typename _TYPE_ARRAY_>
int IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::alloc_counter_
staticprotected

To monitor how many field allocations we perform.

Definition at line 87 of file IJK_Field_template.h.

◆ localisation_

template<typename _TYPE_, typename _TYPE_ARRAY_>
Domaine_IJK::Localisation IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::localisation_
protected

Definition at line 84 of file IJK_Field_template.h.

◆ shear_BC_helpler_

template<typename _TYPE_, typename _TYPE_ARRAY_>
IJK_Shear_Periodic_helpler IJK_Field_template< _TYPE_, _TYPE_ARRAY_ >::shear_BC_helpler_
protected

Definition at line 85 of file IJK_Field_template.h.


The documentation for this class was generated from the following files:
  • /home/docs/checkouts/readthedocs.org/user_builds/cea-trust-platform/checkouts/master/src/Kernel/IJK/Champs/IJK_Field_forward.h
  • /home/docs/checkouts/readthedocs.org/user_builds/cea-trust-platform/checkouts/master/src/Kernel/IJK/Champs/IJK_Field_template.h
  • /home/docs/checkouts/readthedocs.org/user_builds/cea-trust-platform/checkouts/master/src/Kernel/IJK/Champs/IJK_Field_template.tpp