Sonde_IJK

Sonde_IJK#

#include <Sonde_IJK.h>
Brief description

class Sonde_IJK

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:`Sonde\_IJK <class-sonde-ijk>`

[Sonde\_IJK](#class-sonde-ijk)

Detailed description#

Inherits from#

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

List of Private Methods#

Complete Member Function Documentation#

completer#

Definition
void Sonde_IJK::completer() 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:`void Sonde_IJK::completer() override <sonde-ijk-public-void-sonde-ijk-completer-override>`

[void Sonde_IJK::completer() override](#sonde-ijk-public-void-sonde-ijk-completer-override)

duplique#

Definition
int Sonde_IJK::duplique() 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:`int Sonde_IJK::duplique() const override <sonde-ijk-public-int-sonde-ijk-duplique-const-override>`

[int Sonde_IJK::duplique() const override](#sonde-ijk-public-int-sonde-ijk-duplique-const-override)

get_info#

Definition
const Type_info * Sonde_IJK::get_info() const override
Brief description

Donne des informations sur le type de l’ Objet_U .

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:`const Type_info * Sonde_IJK::get_info() const override <sonde-ijk-public-const-type-info-ptr-sonde-ijk-get-info-const-override>`

[const Type_info * Sonde_IJK::get_info() const override](#sonde-ijk-public-const-type-info-ptr-sonde-ijk-get-info-const-override)

Sonde_IJK#

Definition
Sonde_IJK::Sonde_IJK()
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:`Sonde_IJK::Sonde_IJK() <sonde-ijk-public-sonde-ijk-sonde-ijk>`

[Sonde_IJK::Sonde_IJK()](#sonde-ijk-public-sonde-ijk-sonde-ijk)

taille_memoire#

Definition
unsigned Sonde_IJK::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 Sonde_IJK::taille_memoire() const override <sonde-ijk-public-unsigned-sonde-ijk-taille-memoire-const-override>`

[unsigned Sonde_IJK::taille_memoire() const override](#sonde-ijk-public-unsigned-sonde-ijk-taille-memoire-const-override)

~Sonde_IJK#

Definition
Sonde_IJK::~Sonde_IJK()
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:`Sonde_IJK::~Sonde_IJK() <sonde-ijk-public-sonde-ijk-dtor-sonde-ijk>`

[Sonde_IJK::~Sonde_IJK()](#sonde-ijk-public-sonde-ijk-dtor-sonde-ijk)

cree_instance#

Definition
Objet_U * Sonde_IJK::cree_instance()
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:`Objet_U * Sonde_IJK::cree_instance() <sonde-ijk-public-static-objet-u-ptr-sonde-ijk-cree-instance>`

[Objet_U * Sonde_IJK::cree_instance()](#sonde-ijk-public-static-objet-u-ptr-sonde-ijk-cree-instance)

info#

Definition
const Type_info * Sonde_IJK::info()
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 Type_info * Sonde_IJK::info() <sonde-ijk-public-static-const-type-info-ptr-sonde-ijk-info>`

[const Type_info * Sonde_IJK::info()](#sonde-ijk-public-static-const-type-info-ptr-sonde-ijk-info)

self_cast#

Definition
const Sonde_IJK & Sonde_IJK::self_cast(const Objet_U &)
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 Sonde_IJK & Sonde_IJK::self_cast(const Objet_U &) <sonde-ijk-public-static-const-sonde-ijk-ref-sonde-ijk-self-cast-const-objet-u-ref>`

[const Sonde_IJK & Sonde_IJK::self_cast(const Objet_U &)](#sonde-ijk-public-static-const-sonde-ijk-ref-sonde-ijk-self-cast-const-objet-u-ref)

self_cast#

Definition
Sonde_IJK & Sonde_IJK::self_cast(Objet_U &)
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:`Sonde_IJK & Sonde_IJK::self_cast(Objet_U &) <sonde-ijk-public-static-sonde-ijk-ref-sonde-ijk-self-cast-objet-u-ref>`

[Sonde_IJK & Sonde_IJK::self_cast(Objet_U &)](#sonde-ijk-public-static-sonde-ijk-ref-sonde-ijk-self-cast-objet-u-ref)

create_champ_generique#

Definition
void Sonde_IJK::create_champ_generique(Entree &is, const Motcle &motlu) override
Brief description
Detailed description

Creation des Champ_Generique_refChamp necessaire pour l initialisation de la REF a Champ_Generique_base Si le champ demande est un Champ_base connu du probleme on cree le Champ_Generique_refChamp correspondant

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:`void Sonde_IJK::create_champ_generique(Entree &is, const Motcle &motlu) override <sonde-ijk-protected-void-sonde-ijk-create-champ-generique-entree-ref-is-const-motcle-ref-motlu-override>`

[void Sonde_IJK::create_champ_generique(Entree &is, const Motcle &motlu) override](#sonde-ijk-protected-void-sonde-ijk-create-champ-generique-entree-ref-is-const-motcle-ref-motlu-override)

fill_local_values#

Definition
void Sonde_IJK::fill_local_values() override
Brief description
Detailed description

Fill the array ‘valeurs_locales’ used by each proc to store prob local values

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:`void Sonde_IJK::fill_local_values() override <sonde-ijk-protected-void-sonde-ijk-fill-local-values-override>`

[void Sonde_IJK::fill_local_values() override](#sonde-ijk-protected-void-sonde-ijk-fill-local-values-override)

fix_probe_position#

Definition
void Sonde_IJK::fix_probe_position() override
Brief description
Detailed description

Fix probe position. In IJK, if no position modifier is specified, we systematically move the probe to the center of the element for a ELEM field, and to the face corresponding to the field component if this is a FACE field.

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:`void Sonde_IJK::fix_probe_position() override <sonde-ijk-protected-void-sonde-ijk-fix-probe-position-override>`

[void Sonde_IJK::fix_probe_position() override](#sonde-ijk-protected-void-sonde-ijk-fix-probe-position-override)

fix_probe_position_grav#

Definition
void Sonde_IJK::fix_probe_position_grav() override
Brief description
Detailed description

In IJK, velocity components might be interpolated/moved to element center. This is equivalent to having a ELEM field.

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:`void Sonde_IJK::fix_probe_position_grav() override <sonde-ijk-protected-void-sonde-ijk-fix-probe-position-grav-override>`

[void Sonde_IJK::fix_probe_position_grav() override](#sonde-ijk-protected-void-sonde-ijk-fix-probe-position-grav-override)

get_domaine_geom#

Definition
const Domaine & Sonde_IJK::get_domaine_geom() const override
Brief description
Detailed description

Retrieve the domain to be used for the probe

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:`const Domaine & Sonde_IJK::get_domaine_geom() const override <sonde-ijk-protected-const-domaine-ref-sonde-ijk-get-domaine-geom-const-override>`

[const Domaine & Sonde_IJK::get_domaine_geom() const override](#sonde-ijk-protected-const-domaine-ref-sonde-ijk-get-domaine-geom-const-override)

get_nb_compo_champ#

Definition
int Sonde_IJK::get_nb_compo_champ() const override
Brief description
Detailed description

Retrieve the number of component for the field - overriden in IJK

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 Sonde_IJK::get_nb_compo_champ() const override <sonde-ijk-protected-int-sonde-ijk-get-nb-compo-champ-const-override>`

[int Sonde_IJK::get_nb_compo_champ() const override](#sonde-ijk-protected-int-sonde-ijk-get-nb-compo-champ-const-override)

get_noms_champ#

Definition
const Noms Sonde_IJK::get_noms_champ() const override
Brief description
Detailed description

Retrieve the field names - overriden in IJK

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:`const Noms Sonde_IJK::get_noms_champ() const override <sonde-ijk-protected-const-noms-sonde-ijk-get-noms-champ-const-override>`

[const Noms Sonde_IJK::get_noms_champ() const override](#sonde-ijk-protected-const-noms-sonde-ijk-get-noms-champ-const-override)

get_temps_champ#

Definition
double Sonde_IJK::get_temps_champ() const override
Brief description
Detailed description

Retrieve the current time for the field - overriden in IJK

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:`double Sonde_IJK::get_temps_champ() const override <sonde-ijk-protected-double-sonde-ijk-get-temps-champ-const-override>`

[double Sonde_IJK::get_temps_champ() const override](#sonde-ijk-protected-double-sonde-ijk-get-temps-champ-const-override)

printOn#

Definition
Sortie & Sonde_IJK::printOn(Sortie &x) const override
Brief description

Imprime le type de l’objet sur un flot de sortie.

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:`Sortie & Sonde_IJK::printOn(Sortie &x) const override <sonde-ijk-protected-sortie-ref-sonde-ijk-printon-sortie-ref-x-const-override>`

[Sortie & Sonde_IJK::printOn(Sortie &x) const override](#sonde-ijk-protected-sortie-ref-sonde-ijk-printon-sortie-ref-x-const-override)

readOn#

Definition
Entree & Sonde_IJK::readOn(Entree &) override
Brief description

Lit les specifications d’une sonde a partir d’un flot d’entree.

Detailed description

Format: Sondes { [nom_sonde nom_champ Periode dts Points n x1 y1 [z1] … xn yn [zn] [nom_sonde nom_champ Periode dts Segment ns x1 y1 [z1] x2 y2 [z2] … }

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:`Entree & Sonde_IJK::readOn(Entree &) override <sonde-ijk-protected-entree-ref-sonde-ijk-readon-entree-ref-override>`

[Entree & Sonde_IJK::readOn(Entree &) override](#sonde-ijk-protected-entree-ref-sonde-ijk-readon-entree-ref-override)

update_source#

Definition
void Sonde_IJK::update_source(double un_temps) override
Brief description
Detailed description

Update the underlying field source if needed

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:`void Sonde_IJK::update_source(double un_temps) override <sonde-ijk-protected-void-sonde-ijk-update-source-double-un-temps-override>`

[void Sonde_IJK::update_source(double un_temps) override](#sonde-ijk-protected-void-sonde-ijk-update-source-double-un-temps-override)

validate_position#

Definition
void Sonde_IJK::validate_position() const override
Brief description
Detailed description

Override. Exit if invalid localisation for the probe.

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:`void Sonde_IJK::validate_position() const override <sonde-ijk-protected-void-sonde-ijk-validate-position-const-override>`

[void Sonde_IJK::validate_position() const override](#sonde-ijk-protected-void-sonde-ijk-validate-position-const-override)

validate_type#

Definition
void Sonde_IJK::validate_type(const Motcle &loc) const override
Brief description
Detailed description

Override. Exit if invalid type for the probe.

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:`void Sonde_IJK::validate_type(const Motcle &loc) const override <sonde-ijk-protected-void-sonde-ijk-validate-type-const-motcle-ref-loc-const-override>`

[void Sonde_IJK::validate_type(const Motcle &loc) const override](#sonde-ijk-protected-void-sonde-ijk-validate-type-const-motcle-ref-loc-const-override)

fix_probe_position_generic#

Definition
void Sonde_IJK::fix_probe_position_generic(Domaine_IJK::Localisation loc)
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 Sonde_IJK::fix_probe_position_generic(Domaine_IJK::Localisation loc) <sonde-ijk-private-void-sonde-ijk-fix-probe-position-generic-domaine-ijk-localisation-loc>`

[void Sonde_IJK::fix_probe_position_generic(Domaine_IJK::Localisation loc)](#sonde-ijk-private-void-sonde-ijk-fix-probe-position-generic-domaine-ijk-localisation-loc)

Attributes Documentation#

info_obj (public)
const Type_info Sonde_IJK::info_obj
nbre_points_tot (protected)
int Sonde_IJK::nbre_points_tot
ncomp (protected)
int Sonde_IJK::ncomp = 1

Number of the component to handle.

ref_ijk_field_ (protected)
TRUST_Ref<IJK_Field_double *> Sonde_IJK::ref_ijk_field_
ref_ijk_ft_ (protected)
TRUST_Ref<Probleme_FTD_IJK_base *> Sonde_IJK::ref_ijk_ft_
tmp_storage_ (protected)
IJK_Field_double Sonde_IJK::tmp_storage_
field_name_ (private)
Nom Sonde_IJK::field_name_

In IJK we need to store the initial name of the requested field because of the switch done on some fields (see Champs_compris_IJK::switch_ft_fields() ). This switch might rename the field, but we want this to stay constant for a probe!

Contents