correction_one_direction#

#include <corrections_qdm.h>
Brief description

: class correction_one_direction

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:`correction\_one\_direction <class-correction-one-direction>`
[correction\_one\_direction](#class-correction-one-direction)

Detailed description#

<Correction : “vitesse_corrigee_ = vitesse-vitesse_correction_” A partir de qdm_cible, calcule vitesse_correction_ et vitesse_corrigee_ pour une direction u_i * = u_i - {u_correction}_i correct_velocity_ = vel_ijk_t - value_correction_ value_correction_ = ({rho u}_i _moyen - qdm_cible) / rho_moyen qdm_cible : calculee par une des sous - classes.

Inherits from#

Inheritance graph#

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

../../../../../_images/classcorrection__one__direction__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

compute_correct_velocity#

Definition
void correction_one_direction::compute_correct_velocity(double vel_ijk_t)
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 correction_one_direction::compute_correct_velocity(double vel_ijk_t) <correction-one-direction-public-void-correction-one-direction-compute-correct-velocity-double-vel-ijk-t>`
[void correction_one_direction::compute_correct_velocity(double vel_ijk_t)](#correction-one-direction-public-void-correction-one-direction-compute-correct-velocity-double-vel-ijk-t)

compute_correction_value#

Definition
void correction_one_direction::compute_correction_value()
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 correction_one_direction::compute_correction_value() <correction-one-direction-public-void-correction-one-direction-compute-correction-value>`
[void correction_one_direction::compute_correction_value()](#correction-one-direction-public-void-correction-one-direction-compute-correction-value)

correction_one_direction#

Definition
correction_one_direction::correction_one_direction()
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:`correction_one_direction::correction_one_direction() <correction-one-direction-public-correction-one-direction-correction-one-direction>`
[correction_one_direction::correction_one_direction()](#correction-one-direction-public-correction-one-direction-correction-one-direction)

duplique#

Definition
int correction_one_direction::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 correction_one_direction::duplique() const override <correction-one-direction-public-int-correction-one-direction-duplique-const-override>`
[int correction_one_direction::duplique() const override](#correction-one-direction-public-int-correction-one-direction-duplique-const-override)

get_cible_constante#

Definition
cible_donnee correction_one_direction::get_cible_constante() 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:`cible_donnee correction_one_direction::get_cible_constante() const <correction-one-direction-public-cible-donnee-correction-one-direction-get-cible-constante-const>`
[cible_donnee correction_one_direction::get_cible_constante() const](#correction-one-direction-public-cible-donnee-correction-one-direction-get-cible-constante-const)

get_consigne_initiale#

Definition
consigne_initiale correction_one_direction::get_consigne_initiale() 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:`consigne_initiale correction_one_direction::get_consigne_initiale() const <correction-one-direction-public-consigne-initiale-correction-one-direction-get-consigne-initiale-const>`
[consigne_initiale correction_one_direction::get_consigne_initiale() const](#correction-one-direction-public-consigne-initiale-correction-one-direction-get-consigne-initiale-const)

get_correct_velocity#

Definition
double correction_one_direction::get_correct_velocity()
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:`double correction_one_direction::get_correct_velocity() <correction-one-direction-public-double-correction-one-direction-get-correct-velocity>`
[double correction_one_direction::get_correct_velocity()](#correction-one-direction-public-double-correction-one-direction-get-correct-velocity)

get_correction_value#

Definition
double correction_one_direction::get_correction_value()
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:`double correction_one_direction::get_correction_value() <correction-one-direction-public-double-correction-one-direction-get-correction-value>`
[double correction_one_direction::get_correction_value()](#correction-one-direction-public-double-correction-one-direction-get-correction-value)

get_info#

Definition
const Type_info * correction_one_direction::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 * correction_one_direction::get_info() const override <correction-one-direction-public-const-type-info-ptr-correction-one-direction-get-info-const-override>`
[const Type_info * correction_one_direction::get_info() const override](#correction-one-direction-public-const-type-info-ptr-correction-one-direction-get-info-const-override)

get_moyenne_glissante#

Definition
moyenne_glissante correction_one_direction::get_moyenne_glissante() 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:`moyenne_glissante correction_one_direction::get_moyenne_glissante() const <correction-one-direction-public-moyenne-glissante-correction-one-direction-get-moyenne-glissante-const>`
[moyenne_glissante correction_one_direction::get_moyenne_glissante() const](#correction-one-direction-public-moyenne-glissante-correction-one-direction-get-moyenne-glissante-const)

get_moyenne_par_morceaux#

Definition
moyenne_par_morceaux correction_one_direction::get_moyenne_par_morceaux() 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:`moyenne_par_morceaux correction_one_direction::get_moyenne_par_morceaux() const <correction-one-direction-public-moyenne-par-morceaux-correction-one-direction-get-moyenne-par-morceaux-const>`
[moyenne_par_morceaux correction_one_direction::get_moyenne_par_morceaux() const](#correction-one-direction-public-moyenne-par-morceaux-correction-one-direction-get-moyenne-par-morceaux-const)

get_need_for_rho_liq#

Definition
int correction_one_direction::get_need_for_rho_liq()
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:`int correction_one_direction::get_need_for_rho_liq() <correction-one-direction-public-int-correction-one-direction-get-need-for-rho-liq>`
[int correction_one_direction::get_need_for_rho_liq()](#correction-one-direction-public-int-correction-one-direction-get-need-for-rho-liq)

get_need_for_vit_rel#

Definition
int correction_one_direction::get_need_for_vit_rel()
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:`int correction_one_direction::get_need_for_vit_rel() <correction-one-direction-public-int-correction-one-direction-get-need-for-vit-rel>`
[int correction_one_direction::get_need_for_vit_rel()](#correction-one-direction-public-int-correction-one-direction-get-need-for-vit-rel)

get_need_to_compute_correction_value#

Definition
int correction_one_direction::get_need_to_compute_correction_value()
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:`int correction_one_direction::get_need_to_compute_correction_value() <correction-one-direction-public-int-correction-one-direction-get-need-to-compute-correction-value>`
[int correction_one_direction::get_need_to_compute_correction_value()](#correction-one-direction-public-int-correction-one-direction-get-need-to-compute-correction-value)

get_type_corr#

Definition
correction_one_direction::type_correction correction_one_direction::get_type_corr() 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:`correction_one_direction::type_correction correction_one_direction::get_type_corr() const <correction-one-direction-public-correction-one-direction-type-correction-correction-one-direction-get-type-corr-const>`
[correction_one_direction::type_correction correction_one_direction::get_type_corr() const](#correction-one-direction-public-correction-one-direction-type-correction-correction-one-direction-get-type-corr-const)

get_value#

Definition
double correction_one_direction::get_value()
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:`double correction_one_direction::get_value() <correction-one-direction-public-double-correction-one-direction-get-value>`
[double correction_one_direction::get_value()](#correction-one-direction-public-double-correction-one-direction-get-value)

get_velocity_correction#

Definition
double correction_one_direction::get_velocity_correction()
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:`double correction_one_direction::get_velocity_correction() <correction-one-direction-public-double-correction-one-direction-get-velocity-correction>`
[double correction_one_direction::get_velocity_correction()](#correction-one-direction-public-double-correction-one-direction-get-velocity-correction)

set_correction#

Definition
void correction_one_direction::set_correction(correction_one_direction &correction_in)
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 correction_one_direction::set_correction(correction_one_direction &correction_in) <correction-one-direction-public-void-correction-one-direction-set-correction-correction-one-direction-ref-correction-in>`
[void correction_one_direction::set_correction(correction_one_direction &correction_in)](#correction-one-direction-public-void-correction-one-direction-set-correction-correction-one-direction-ref-correction-in)

set_mean_values_for_correction#

Definition
void correction_one_direction::set_mean_values_for_correction(double rho_vel_moyen, double rho_moyen, double alpha_l)
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 correction_one_direction::set_mean_values_for_correction(double rho_vel_moyen, double rho_moyen, double alpha_l) <correction-one-direction-public-void-correction-one-direction-set-mean-values-for-correction-double-rho-vel-moyen-double-rho-moyen-double-alpha-l>`
[void correction_one_direction::set_mean_values_for_correction(double rho_vel_moyen, double rho_moyen, double alpha_l)](#correction-one-direction-public-void-correction-one-direction-set-mean-values-for-correction-double-rho-vel-moyen-double-rho-moyen-double-alpha-l)

set_rho_liq#

Definition
void correction_one_direction::set_rho_liq(double rho_liquide)
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 correction_one_direction::set_rho_liq(double rho_liquide) <correction-one-direction-public-void-correction-one-direction-set-rho-liq-double-rho-liquide>`
[void correction_one_direction::set_rho_liq(double rho_liquide)](#correction-one-direction-public-void-correction-one-direction-set-rho-liq-double-rho-liquide)

set_rho_moyen_alpha_l_for_correction#

Definition
void correction_one_direction::set_rho_moyen_alpha_l_for_correction(double rho_moyen, double alpha_l)
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 correction_one_direction::set_rho_moyen_alpha_l_for_correction(double rho_moyen, double alpha_l) <correction-one-direction-public-void-correction-one-direction-set-rho-moyen-alpha-l-for-correction-double-rho-moyen-double-alpha-l>`
[void correction_one_direction::set_rho_moyen_alpha_l_for_correction(double rho_moyen, double alpha_l)](#correction-one-direction-public-void-correction-one-direction-set-rho-moyen-alpha-l-for-correction-double-rho-moyen-double-alpha-l)

set_rho_vel_moyen_for_correction#

Definition
void correction_one_direction::set_rho_vel_moyen_for_correction(double rho_vel_moyen)
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 correction_one_direction::set_rho_vel_moyen_for_correction(double rho_vel_moyen) <correction-one-direction-public-void-correction-one-direction-set-rho-vel-moyen-for-correction-double-rho-vel-moyen>`
[void correction_one_direction::set_rho_vel_moyen_for_correction(double rho_vel_moyen)](#correction-one-direction-public-void-correction-one-direction-set-rho-vel-moyen-for-correction-double-rho-vel-moyen)

set_time_for_correction#

Definition
void correction_one_direction::set_time_for_correction(double time, double time_step, int time_iteration)
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 correction_one_direction::set_time_for_correction(double time, double time_step, int time_iteration) <correction-one-direction-public-void-correction-one-direction-set-time-for-correction-double-time-double-time-step-int-time-iteration>`
[void correction_one_direction::set_time_for_correction(double time, double time_step, int time_iteration)](#correction-one-direction-public-void-correction-one-direction-set-time-for-correction-double-time-double-time-step-int-time-iteration)

set_vl_vv#

Definition
void correction_one_direction::set_vl_vv(double vl_vv)
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 correction_one_direction::set_vl_vv(double vl_vv) <correction-one-direction-public-void-correction-one-direction-set-vl-vv-double-vl-vv>`
[void correction_one_direction::set_vl_vv(double vl_vv)](#correction-one-direction-public-void-correction-one-direction-set-vl-vv-double-vl-vv)

taille_memoire#

Definition
unsigned correction_one_direction::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 correction_one_direction::taille_memoire() const override <correction-one-direction-public-unsigned-correction-one-direction-taille-memoire-const-override>`
[unsigned correction_one_direction::taille_memoire() const override](#correction-one-direction-public-unsigned-correction-one-direction-taille-memoire-const-override)

~correction_one_direction#

Definition
correction_one_direction::~correction_one_direction()
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:`correction_one_direction::~correction_one_direction() <correction-one-direction-public-correction-one-direction-dtor-correction-one-direction>`
[correction_one_direction::~correction_one_direction()](#correction-one-direction-public-correction-one-direction-dtor-correction-one-direction)

cree_instance#

Definition
Objet_U * correction_one_direction::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 * correction_one_direction::cree_instance() <correction-one-direction-public-static-objet-u-ptr-correction-one-direction-cree-instance>`
[Objet_U * correction_one_direction::cree_instance()](#correction-one-direction-public-static-objet-u-ptr-correction-one-direction-cree-instance)

info#

Definition
const Type_info * correction_one_direction::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 * correction_one_direction::info() <correction-one-direction-public-static-const-type-info-ptr-correction-one-direction-info>`
[const Type_info * correction_one_direction::info()](#correction-one-direction-public-static-const-type-info-ptr-correction-one-direction-info)

self_cast#

Definition
const correction_one_direction & correction_one_direction::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 correction_one_direction & correction_one_direction::self_cast(const Objet_U &) <correction-one-direction-public-static-const-correction-one-direction-ref-correction-one-direction-self-cast-const-objet-u-ref>`
[const correction_one_direction & correction_one_direction::self_cast(const Objet_U &)](#correction-one-direction-public-static-const-correction-one-direction-ref-correction-one-direction-self-cast-const-objet-u-ref)

self_cast#

Definition
correction_one_direction & correction_one_direction::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:`correction_one_direction & correction_one_direction::self_cast(Objet_U &) <correction-one-direction-public-static-correction-one-direction-ref-correction-one-direction-self-cast-objet-u-ref>`
[correction_one_direction & correction_one_direction::self_cast(Objet_U &)](#correction-one-direction-public-static-correction-one-direction-ref-correction-one-direction-self-cast-objet-u-ref)

printOn#

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

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

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 & correction_one_direction::printOn(Sortie &x) const override <correction-one-direction-protected-sortie-ref-correction-one-direction-printon-sortie-ref-x-const-override>`
[Sortie & correction_one_direction::printOn(Sortie &x) const override](#correction-one-direction-protected-sortie-ref-correction-one-direction-printon-sortie-ref-x-const-override)

readOn#

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

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

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:`Entree & correction_one_direction::readOn(Entree &) override <correction-one-direction-protected-entree-ref-correction-one-direction-readon-entree-ref-override>`
[Entree & correction_one_direction::readOn(Entree &) override](#correction-one-direction-protected-entree-ref-correction-one-direction-readon-entree-ref-override)

Attributes Documentation#

info_obj (public)
const Type_info correction_one_direction::info_obj
alpha_l_ (protected)
double correction_one_direction::alpha_l_
correct_velocity_ (protected)
double correction_one_direction::correct_velocity_
i_need_vitesse_relative_ (protected)
int correction_one_direction::i_need_vitesse_relative_
parametres_cible_constante_ (protected)
cible_donnee correction_one_direction::parametres_cible_constante_
parametres_consigne_initiale_ (protected)
consigne_initiale correction_one_direction::parametres_consigne_initiale_
parametres_moyenne_glissante_ (protected)
moyenne_glissante correction_one_direction::parametres_moyenne_glissante_
parametres_moyenne_par_morceaux_ (protected)
moyenne_par_morceaux correction_one_direction::parametres_moyenne_par_morceaux_
qdm_cible_ (protected)
double correction_one_direction::qdm_cible_
rho_moyen_ (protected)
double correction_one_direction::rho_moyen_
rho_vel_moyen_ (protected)
double correction_one_direction::rho_vel_moyen_
type_corr_ (protected)
int correction_one_direction::type_corr_
value_correction_ (protected)
double correction_one_direction::value_correction_
vitesse_relative_ (protected)
double correction_one_direction::vitesse_relative_

Enums#

correction_one_direction::type_correction#

Location: triocfd-code/src/Multiphase/Front_tracking_discontinu/IJK/Sources/corrections_qdm.h:279

How to cite in this doc: 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:`correction\_one\_direction::type\_correction <enum-none-correction-one-direction-type-correction>`
[correction\_one\_direction::type\_correction](#enum-none-correction-one-direction-type-correction)
  • CIBLE_CONSTANTE

  • MOYENNE_PAR_MORCEAUX

  • MOYENNE_GLISSANTE

  • REGIME_ETABLI

  • CONSIGNE_INITIALE