TrioCFD 1.9.9_beta
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
 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.
 IJK_Field_vector ()
void nommer (const Nom &nam) override
 Gives a name to the field.
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
 Returns the name of the field.
const Nomsget_synonyms () const
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 ()

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

Gives a name to the field.

Parameters
(Nom&name) the name to give to the field

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

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 59 of file IJK_Field_vector.h.

◆ readOn()

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

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 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: