IJK_Field_template#

#include <IJK_Field_template.h>
Brief description

: This class is an IJK_Field_local with parallel informations.

How to reference this class#

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`IJK\_Field\_template <class-template-ijk-field-template>`
[IJK\_Field\_template](#class-template-ijk-field-template)

Detailed description#

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.

Inherits from#

Inherited by#

Inheritance graph#

If the image is too small, right-click and open in new tab

../../../../../_images/classIJK__Field__template__inherit__graph.png

List of Protected Methods#

List of Public Methods#

List of Public Static Methods#

Complete Member Function Documentation#

duplique#

Definition
int IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::duplique() const override
Brief description
Detailed description

Reimplements:

References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`int IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::duplique() const override <ijk-field-template-protected-int-ijk-field-template-type-type-array-duplique-const-override>`
[int IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::duplique() const override](#ijk-field-template-protected-int-ijk-field-template-type-type-array-duplique-const-override)

exchange_data#

Definition
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)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`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) <ijk-field-template-protected-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-equal-0.-double-jump-i-equal-0.-int-nb-ghost-equal-0>`
[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)](#ijk-field-template-protected-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-equal-0.-double-jump-i-equal-0.-int-nb-ghost-equal-0)

printOn#

Definition
Sortie & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::printOn(Sortie &os) const override
Brief description

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

Detailed description

Reimplements:

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`Sortie & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::printOn(Sortie &os) const override <ijk-field-template-protected-sortie-ref-ijk-field-template-type-type-array-printon-sortie-ref-os-const-override>`
[Sortie & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::printOn(Sortie &os) const override](#ijk-field-template-protected-sortie-ref-ijk-field-template-type-type-array-printon-sortie-ref-os-const-override)

readOn#

Definition
Entree & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::readOn(Entree &is) override
Brief description

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

Detailed description

Reimplements:

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`Entree & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::readOn(Entree &is) override <ijk-field-template-protected-entree-ref-ijk-field-template-type-type-array-readon-entree-ref-is-override>`
[Entree & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::readOn(Entree &is) override](#ijk-field-template-protected-entree-ref-ijk-field-template-type-type-array-readon-entree-ref-is-override)

taille_memoire#

Definition
unsigned IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::taille_memoire() const override
Brief description
Detailed description

Reimplements:

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`unsigned IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::taille_memoire() const override <ijk-field-template-protected-unsigned-ijk-field-template-type-type-array-taille-memoire-const-override>`
[unsigned IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::taille_memoire() const override](#ijk-field-template-protected-unsigned-ijk-field-template-type-type-array-taille-memoire-const-override)

ajouter_second_membre_shear_perio#

Definition
void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::ajouter_second_membre_shear_perio(IJK_Field_double &resu)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::ajouter_second_membre_shear_perio(IJK_Field_double &resu) <ijk-field-template-public-void-ijk-field-template-type-type-array-ajouter-second-membre-shear-perio-ijk-field-double-ref-resu>`
[void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::ajouter_second_membre_shear_perio(IJK_Field_double &resu)](#ijk-field-template-public-void-ijk-field-template-type-type-array-ajouter-second-membre-shear-perio-ijk-field-double-ref-resu)

allocate#

Definition
void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::allocate(const Domaine_IJK &d, Domaine_IJK::Localisation l, int ghost_size, const Nom &name)
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::allocate(const Domaine_IJK &d, Domaine_IJK::Localisation l, int ghost_size, const Nom &name) <ijk-field-template-public-void-ijk-field-template-type-type-array-allocate-const-domaine-ijk-ref-d-domaine-ijk-localisation-l-int-ghost-size-const-nom-ref-name>`
[void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::allocate(const Domaine_IJK &d, Domaine_IJK::Localisation l, int ghost_size, const Nom &name)](#ijk-field-template-public-void-ijk-field-template-type-type-array-allocate-const-domaine-ijk-ref-d-domaine-ijk-localisation-l-int-ghost-size-const-nom-ref-name)

allocate#

Definition
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())
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`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()) <ijk-field-template-public-void-ijk-field-template-type-type-array-allocate-const-domaine-ijk-ref-d-domaine-ijk-localisation-l-int-ghost-size-int-additional-k-layers-equal-0-int-nb-compo-equal-1-const-nom-ref-name-equal-nom>`
[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())](#ijk-field-template-public-void-ijk-field-template-type-type-array-allocate-const-domaine-ijk-ref-d-domaine-ijk-localisation-l-int-ghost-size-int-additional-k-layers-equal-0-int-nb-compo-equal-1-const-nom-ref-name-equal-nom)

allocate_shear_BC#

Definition
void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::allocate_shear_BC(int monofluide, double rov, double rol, int use_inv_rho_in_pressure_solver=0)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::allocate_shear_BC(int monofluide, double rov, double rol, int use_inv_rho_in_pressure_solver=0) <ijk-field-template-public-void-ijk-field-template-type-type-array-allocate-shear-bc-int-monofluide-double-rov-double-rol-int-use-inv-rho-in-pressure-solver-equal-0>`
[void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::allocate_shear_BC(int monofluide, double rov, double rol, int use_inv_rho_in_pressure_solver=0)](#ijk-field-template-public-void-ijk-field-template-type-type-array-allocate-shear-bc-int-monofluide-double-rov-double-rol-int-use-inv-rho-in-pressure-solver-equal-0)

dumplata_scalar#

Definition
virtual void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::dumplata_scalar(const char *filename, int step) const
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`virtual void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::dumplata_scalar(const char *filename, int step) const <ijk-field-template-public-virtual-void-ijk-field-template-type-type-array-dumplata-scalar-const-char-ptr-filename-int-step-const>`
[virtual void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::dumplata_scalar(const char *filename, int step) const](#ijk-field-template-public-virtual-void-ijk-field-template-type-type-array-dumplata-scalar-const-char-ptr-filename-int-step-const)

echange_espace_virtuel#

Definition
void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::echange_espace_virtuel(int ghost)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::echange_espace_virtuel(int ghost) <ijk-field-template-public-void-ijk-field-template-type-type-array-echange-espace-virtuel-int-ghost>`
[void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::echange_espace_virtuel(int ghost)](#ijk-field-template-public-void-ijk-field-template-type-type-array-echange-espace-virtuel-int-ghost)

get_domaine#

Definition
const Domaine_IJK & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_domaine() const
Brief description
Detailed description
References
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const Domaine_IJK & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_domaine() const <ijk-field-template-public-const-domaine-ijk-ref-ijk-field-template-type-type-array-get-domaine-const>`
[const Domaine_IJK & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_domaine() const](#ijk-field-template-public-const-domaine-ijk-ref-ijk-field-template-type-type-array-get-domaine-const)

get_localisation#

Definition
Domaine_IJK::Localisation IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_localisation() const
Brief description
Detailed description
References
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`Domaine_IJK::Localisation IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_localisation() const <ijk-field-template-public-domaine-ijk-localisation-ijk-field-template-type-type-array-get-localisation-const>`
[Domaine_IJK::Localisation IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_localisation() const](#ijk-field-template-public-domaine-ijk-localisation-ijk-field-template-type-type-array-get-localisation-const)

get_shear_BC_helpler#

Definition
IJK_Shear_Periodic_helpler & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_shear_BC_helpler()
Brief description
Detailed description
References
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`IJK_Shear_Periodic_helpler & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_shear_BC_helpler() <ijk-field-template-public-ijk-shear-periodic-helpler-ref-ijk-field-template-type-type-array-get-shear-bc-helpler>`
[IJK_Shear_Periodic_helpler & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_shear_BC_helpler()](#ijk-field-template-public-ijk-shear-periodic-helpler-ref-ijk-field-template-type-type-array-get-shear-bc-helpler)

get_shear_BC_helpler#

Definition
const IJK_Shear_Periodic_helpler & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_shear_BC_helpler() const
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const IJK_Shear_Periodic_helpler & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_shear_BC_helpler() const <ijk-field-template-public-const-ijk-shear-periodic-helpler-ref-ijk-field-template-type-type-array-get-shear-bc-helpler-const>`
[const IJK_Shear_Periodic_helpler & IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::get_shear_BC_helpler() const](#ijk-field-template-public-const-ijk-shear-periodic-helpler-ref-ijk-field-template-type-type-array-get-shear-bc-helpler-const)

IJK_Field_template#

Definition
IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::IJK_Field_template()
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::IJK_Field_template() <ijk-field-template-public-ijk-field-template-type-type-array-ijk-field-template>`
[IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::IJK_Field_template()](#ijk-field-template-public-ijk-field-template-type-type-array-ijk-field-template)

interpolation_for_shear_periodicity_I_sig_kappa#

Definition
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)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`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) <ijk-field-template-public-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>`
[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)](#ijk-field-template-public-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)

interpolation_for_shear_periodicity_IJK_Field#

Definition
_TYPE_ IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::interpolation_for_shear_periodicity_IJK_Field(const int send_j, const int send_k)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`_TYPE_ IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::interpolation_for_shear_periodicity_IJK_Field(const int send_j, const int send_k) <ijk-field-template-public-type-ijk-field-template-type-type-array-interpolation-for-shear-periodicity-ijk-field-const-int-send-j-const-int-send-k>`
[_TYPE_ IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::interpolation_for_shear_periodicity_IJK_Field(const int send_j, const int send_k)](#ijk-field-template-public-type-ijk-field-template-type-type-array-interpolation-for-shear-periodicity-ijk-field-const-int-send-j-const-int-send-k)

redistribute_with_shear_domain_ft#

Definition
void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::redistribute_with_shear_domain_ft(const IJK_Field_double &input, double DU_perio, const int ft_extension)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::redistribute_with_shear_domain_ft(const IJK_Field_double &input, double DU_perio, const int ft_extension) <ijk-field-template-public-void-ijk-field-template-type-type-array-redistribute-with-shear-domain-ft-const-ijk-field-double-ref-input-double-du-perio-const-int-ft-extension>`
[void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::redistribute_with_shear_domain_ft(const IJK_Field_double &input, double DU_perio, const int ft_extension)](#ijk-field-template-public-void-ijk-field-template-type-type-array-redistribute-with-shear-domain-ft-const-ijk-field-double-ref-input-double-du-perio-const-int-ft-extension)

alloc_counter#

Definition
static int IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::alloc_counter()
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`static int IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::alloc_counter() <ijk-field-template-public-static-static-int-ijk-field-template-type-type-array-alloc-counter>`
[static int IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::alloc_counter()](#ijk-field-template-public-static-static-int-ijk-field-template-type-type-array-alloc-counter)

increase_alloc_counter#

Definition
static void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::increase_alloc_counter(int i=1)
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`static void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::increase_alloc_counter(int i=1) <ijk-field-template-public-static-static-void-ijk-field-template-type-type-array-increase-alloc-counter-int-i-equal-1>`
[static void IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::increase_alloc_counter(int i=1)](#ijk-field-template-public-static-static-void-ijk-field-template-type-type-array-increase-alloc-counter-int-i-equal-1)

Attributes Documentation#

domaine_ref_ (protected)
TRUST_Ref<Domaine_IJK *> IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::domaine_ref_
localisation_ (protected)
Domaine_IJK::Localisation IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::localisation_
shear_BC_helpler_ (protected)
IJK_Shear_Periodic_helpler IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::shear_BC_helpler_
alloc_counter_ (protected)
int IJK_Field_template<_TYPE_, _TYPE_ARRAY_>::alloc_counter_

To monitor how many field allocations we perform.