TrioCFD 1.9.9_beta
TrioCFD documentation
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
 Gives a name to the field.
const Nomle_nom () const override
 Returns the name of the field.
const Nomsget_synonyms () const
virtual void add_synonymous (const Nom &nom)
virtual int nb_comp () const
virtual void fixer_nb_comp (int i)
 Sets the number of components of the field.
virtual int nb_vect_comp () const
const Nomsnoms_compo () const
 Returns the array of names of the field components.
const Nomnom_compo (int) const
 Returns the name of the i-th component of the field.
const Nomnom_compo () const
 Returns the name of a scalar field.
virtual const Nomsfixer_noms_compo (const Noms &)
 Sets the names of the field components.
virtual const Nomfixer_nom_compo (int, const Nom &)
 Sets the name of the i-th component of the field.
virtual const Nomfixer_nom_compo (const Nom &)
 Sets the name of a scalar field.
const Nomsunites () const
 Returns the units of the field components.
const Nomunite () const
 Returns the unit of a scalar field whose all components have the same unit.
const Nomunite (int) const
 Returns the unit of the i-th component of the field.
virtual const Nomsfixer_unites (const Noms &)
 Specifies the units of the field components.
virtual const Nomfixer_unite (const Nom &)
 Specifies the unit of a scalar field or whose all components have the same unit.
virtual const Nomfixer_unite (int i, const Nom &)
 Specifies the unit of the i-th component of the field Meaning: the index of the field component whose unit we want to specify.
virtual Nature_du_champ nature_du_champ () const
virtual Nature_du_champ fixer_nature_du_champ (Nature_du_champ nat)
 Sets the nature of a field: scalar, multiscalar, vectorial.
bool is_basis_function () const
bool is_quadrature () const
bool is_vectorial () const
bool is_scalar () const
int order_field () const
 Returns the order of the basis functions.
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 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 ()

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 ()
 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)

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.
 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 ()
 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

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()

◆ 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

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

Parameters
sOutput stream.
Returns
Modified output stream.

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

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

Parameters
sInput stream.
Returns
Modified input stream.

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: