IJK_Field_vector#

#include <IJK_Field_vector.h>
Brief description

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

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\_vector <class-template-ijk-field-vector>`
[IJK\_Field\_vector](#class-template-ijk-field-vector)

Detailed description#

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’.

Inherits from#

Inherited by#

Inheritance graph#

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

../../../../../_images/classIJK__Field__vector__inherit__graph.png

List of Public Methods#

Complete Member Function Documentation#

add_synonymous#

Definition
void IJK_Field_vector<T, N>::add_synonymous(const Nom &nam) override
Brief description
Detailed description

Reimplements:

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:`void IJK_Field_vector<T, N>::add_synonymous(const Nom &nam) override <ijk-field-vector-public-void-ijk-field-vector-t-n-add-synonymous-const-nom-ref-nam-override>`
[void IJK_Field_vector<T, N>::add_synonymous(const Nom &nam) override](#ijk-field-vector-public-void-ijk-field-vector-t-n-add-synonymous-const-nom-ref-nam-override)

duplique#

Definition
int IJK_Field_vector<T, N>::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_vector<T, N>::duplique() const override <ijk-field-vector-public-int-ijk-field-vector-t-n-duplique-const-override>`
[int IJK_Field_vector<T, N>::duplique() const override](#ijk-field-vector-public-int-ijk-field-vector-t-n-duplique-const-override)

echange_espace_virtuel#

Definition
void IJK_Field_vector<T, N>::echange_espace_virtuel()
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:`void IJK_Field_vector<T, N>::echange_espace_virtuel() <ijk-field-vector-public-void-ijk-field-vector-t-n-echange-espace-virtuel>`
[void IJK_Field_vector<T, N>::echange_espace_virtuel()](#ijk-field-vector-public-void-ijk-field-vector-t-n-echange-espace-virtuel)

get_domaine#

Definition
const Domaine_IJK & IJK_Field_vector<T, N>::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_vector<T, N>::get_domaine() const <ijk-field-vector-public-const-domaine-ijk-ref-ijk-field-vector-t-n-get-domaine-const>`
[const Domaine_IJK & IJK_Field_vector<T, N>::get_domaine() const](#ijk-field-vector-public-const-domaine-ijk-ref-ijk-field-vector-t-n-get-domaine-const)

get_ptr#

Definition
std::shared_ptr<IJK_Field_template<T, TRUSTArray<T>>> & IJK_Field_vector<T, N>::get_ptr(int i)
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:`std::shared_ptr<IJK_Field_template<T, TRUSTArray<T>>> & IJK_Field_vector<T, N>::get_ptr(int i) <ijk-field-vector-public-std-shared-ptr-ijk-field-template-t-trustarray-t-ref-ijk-field-vector-t-n-get-ptr-int-i>`
[std::shared_ptr<IJK_Field_template<T, TRUSTArray<T>>> & IJK_Field_vector<T, N>::get_ptr(int i)](#ijk-field-vector-public-std-shared-ptr-ijk-field-template-t-trustarray-t-ref-ijk-field-vector-t-n-get-ptr-int-i)

get_ptr#

Definition
const std::shared_ptr<IJK_Field_template<T, TRUSTArray<T>>> & IJK_Field_vector<T, N>::get_ptr(int i) 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 std::shared_ptr<IJK_Field_template<T, TRUSTArray<T>>> & IJK_Field_vector<T, N>::get_ptr(int i) const <ijk-field-vector-public-const-std-shared-ptr-ijk-field-template-t-trustarray-t-ref-ijk-field-vector-t-n-get-ptr-int-i-const>`
[const std::shared_ptr<IJK_Field_template<T, TRUSTArray<T>>> & IJK_Field_vector<T, N>::get_ptr(int i) const](#ijk-field-vector-public-const-std-shared-ptr-ijk-field-template-t-trustarray-t-ref-ijk-field-vector-t-n-get-ptr-int-i-const)

IJK_Field_vector#

Definition
IJK_Field_vector<T, N>::IJK_Field_vector()
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_Field_vector<T, N>::IJK_Field_vector() <ijk-field-vector-public-ijk-field-vector-t-n-ijk-field-vector>`
[IJK_Field_vector<T, N>::IJK_Field_vector()](#ijk-field-vector-public-ijk-field-vector-t-n-ijk-field-vector)

localisation#

Definition
Entity & IJK_Field_vector<T, N>::localisation()
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:`Entity & IJK_Field_vector<T, N>::localisation() <ijk-field-vector-public-entity-ref-ijk-field-vector-t-n-localisation>`
[Entity & IJK_Field_vector<T, N>::localisation()](#ijk-field-vector-public-entity-ref-ijk-field-vector-t-n-localisation)

localisation#

Definition
const Entity & IJK_Field_vector<T, N>::localisation() const
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:`const Entity & IJK_Field_vector<T, N>::localisation() const <ijk-field-vector-public-const-entity-ref-ijk-field-vector-t-n-localisation-const>`
[const Entity & IJK_Field_vector<T, N>::localisation() const](#ijk-field-vector-public-const-entity-ref-ijk-field-vector-t-n-localisation-const)

nommer#

Definition
void IJK_Field_vector<T, N>::nommer(const Nom &nam) override
Brief description

Donne un nom au champ.

Detailed description

Reimplements:

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:`void IJK_Field_vector<T, N>::nommer(const Nom &nam) override <ijk-field-vector-public-void-ijk-field-vector-t-n-nommer-const-nom-ref-nam-override>`
[void IJK_Field_vector<T, N>::nommer(const Nom &nam) override](#ijk-field-vector-public-void-ijk-field-vector-t-n-nommer-const-nom-ref-nam-override)

operator[]#

Definition
IJK_Field_template<T, TRUSTArray<T>> & IJK_Field_vector<T, N>::operator[](int i)
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_Field_template<T, TRUSTArray<T>> & IJK_Field_vector<T, N>::operator[](int i) <ijk-field-vector-public-ijk-field-template-t-trustarray-t-ref-ijk-field-vector-t-n-operator[]-int-i>`
[IJK_Field_template<T, TRUSTArray<T>> & IJK_Field_vector<T, N>::operator[](int i)](#ijk-field-vector-public-ijk-field-template-t-trustarray-t-ref-ijk-field-vector-t-n-operator[]-int-i)

operator[]#

Definition
const IJK_Field_template<T, TRUSTArray<T>> & IJK_Field_vector<T, N>::operator[](int i) 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_Field_template<T, TRUSTArray<T>> & IJK_Field_vector<T, N>::operator[](int i) const <ijk-field-vector-public-const-ijk-field-template-t-trustarray-t-ref-ijk-field-vector-t-n-operator[]-int-i-const>`
[const IJK_Field_template<T, TRUSTArray<T>> & IJK_Field_vector<T, N>::operator[](int i) const](#ijk-field-vector-public-const-ijk-field-template-t-trustarray-t-ref-ijk-field-vector-t-n-operator[]-int-i-const)

printOn#

Definition
Sortie & IJK_Field_vector<T, N>::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_vector<T, N>::printOn(Sortie &os) const override <ijk-field-vector-public-sortie-ref-ijk-field-vector-t-n-printon-sortie-ref-os-const-override>`
[Sortie & IJK_Field_vector<T, N>::printOn(Sortie &os) const override](#ijk-field-vector-public-sortie-ref-ijk-field-vector-t-n-printon-sortie-ref-os-const-override)

readOn#

Definition
Entree & IJK_Field_vector<T, N>::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_vector<T, N>::readOn(Entree &is) override <ijk-field-vector-public-entree-ref-ijk-field-vector-t-n-readon-entree-ref-is-override>`
[Entree & IJK_Field_vector<T, N>::readOn(Entree &is) override](#ijk-field-vector-public-entree-ref-ijk-field-vector-t-n-readon-entree-ref-is-override)

taille_memoire#

Definition
unsigned IJK_Field_vector<T, N>::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_vector<T, N>::taille_memoire() const override <ijk-field-vector-public-unsigned-ijk-field-vector-t-n-taille-memoire-const-override>`
[unsigned IJK_Field_vector<T, N>::taille_memoire() const override](#ijk-field-vector-public-unsigned-ijk-field-vector-t-n-taille-memoire-const-override)

Attributes Documentation#

loc_ (private)
Entity IJK_Field_vector<T, N>::loc_