init_forcage_THI#
#include <init_forcage_THI.h>
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:`init\_forcage\_THI <class-init-forcage-thi>`
[init\_forcage\_THI](#class-init-forcage-thi)
Detailed description#
Inherits from#
public : Objet_U
Inheritance graph#
If the image is too small, right-click and open in new tab
List of Public Methods#
List of Public Static Methods#
List of Protected Methods#
Complete Member Function Documentation#
activate_forcage#
int init_forcage_THI::activate_forcage(const int current_time_step, const double current_time)
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 init_forcage_THI::activate_forcage(const int current_time_step, const double current_time) <init-forcage-thi-public-int-init-forcage-thi-activate-forcage-const-int-current-time-step-const-double-current-time>`
[int init_forcage_THI::activate_forcage(const int current_time_step, const double current_time)](#init-forcage-thi-public-int-init-forcage-thi-activate-forcage-const-int-current-time-step-const-double-current-time)
compute_initial_chouippe#
void init_forcage_THI::compute_initial_chouippe(int nproc_tot, const Domaine_IJK &my_geom, int my_ni, int my_nj, int my_nk, const Domaine_IJK &my_splitting, Nom nom_sauvegarde)
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 init_forcage_THI::compute_initial_chouippe(int nproc_tot, const Domaine_IJK &my_geom, int my_ni, int my_nj, int my_nk, const Domaine_IJK &my_splitting, Nom nom_sauvegarde) <init-forcage-thi-public-void-init-forcage-thi-compute-initial-chouippe-int-nproc-tot-const-domaine-ijk-ref-my-geom-int-my-ni-int-my-nj-int-my-nk-const-domaine-ijk-ref-my-splitting-nom-nom-sauvegarde>`
[void init_forcage_THI::compute_initial_chouippe(int nproc_tot, const Domaine_IJK &my_geom, int my_ni, int my_nj, int my_nk, const Domaine_IJK &my_splitting, Nom nom_sauvegarde)](#init-forcage-thi-public-void-init-forcage-thi-compute-initial-chouippe-int-nproc-tot-const-domaine-ijk-ref-my-geom-int-my-ni-int-my-nj-int-my-nk-const-domaine-ijk-ref-my-splitting-nom-nom-sauvegarde)
compute_THI_force#
void init_forcage_THI::compute_THI_force(const int time_iteration, const double tstep, const double current_time, const Domaine_IJK &my_splitting)
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 init_forcage_THI::compute_THI_force(const int time_iteration, const double tstep, const double current_time, const Domaine_IJK &my_splitting) <init-forcage-thi-public-void-init-forcage-thi-compute-thi-force-const-int-time-iteration-const-double-tstep-const-double-current-time-const-domaine-ijk-ref-my-splitting>`
[void init_forcage_THI::compute_THI_force(const int time_iteration, const double tstep, const double current_time, const Domaine_IJK &my_splitting)](#init-forcage-thi-public-void-init-forcage-thi-compute-thi-force-const-int-time-iteration-const-double-tstep-const-double-current-time-const-domaine-ijk-ref-my-splitting)
duplique#
int init_forcage_THI::duplique() const override
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 init_forcage_THI::duplique() const override <init-forcage-thi-public-int-init-forcage-thi-duplique-const-override>`
[int init_forcage_THI::duplique() const override](#init-forcage-thi-public-int-init-forcage-thi-duplique-const-override)
get_b_flt#
ArrOfDouble init_forcage_THI::get_b_flt()
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:`ArrOfDouble init_forcage_THI::get_b_flt() <init-forcage-thi-public-arrofdouble-init-forcage-thi-get-b-flt>`
[ArrOfDouble init_forcage_THI::get_b_flt()](#init-forcage-thi-public-arrofdouble-init-forcage-thi-get-b-flt)
get_facteur_forcage#
int init_forcage_THI::get_facteur_forcage()
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 init_forcage_THI::get_facteur_forcage() <init-forcage-thi-public-int-init-forcage-thi-get-facteur-forcage>`
[int init_forcage_THI::get_facteur_forcage()](#init-forcage-thi-public-int-init-forcage-thi-get-facteur-forcage)
get_force_ph#
IJK_Field_vector3_double init_forcage_THI::get_force_ph()
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:`IJK_Field_vector3_double init_forcage_THI::get_force_ph() <init-forcage-thi-public-ijk-field-vector3-double-init-forcage-thi-get-force-ph>`
[IJK_Field_vector3_double init_forcage_THI::get_force_ph()](#init-forcage-thi-public-ijk-field-vector3-double-init-forcage-thi-get-force-ph)
get_force_ph2#
IJK_Field_vector3_double & init_forcage_THI::get_force_ph2()
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_vector3_double & init_forcage_THI::get_force_ph2() <init-forcage-thi-public-ijk-field-vector3-double-ref-init-forcage-thi-get-force-ph2>`
[IJK_Field_vector3_double & init_forcage_THI::get_force_ph2()](#init-forcage-thi-public-ijk-field-vector3-double-ref-init-forcage-thi-get-force-ph2)
get_forced_advection#
int init_forcage_THI::get_forced_advection()
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 init_forcage_THI::get_forced_advection() <init-forcage-thi-public-int-init-forcage-thi-get-forced-advection>`
[int init_forcage_THI::get_forced_advection()](#init-forcage-thi-public-int-init-forcage-thi-get-forced-advection)
get_info#
const Type_info * init_forcage_THI::get_info() const override
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 * init_forcage_THI::get_info() const override <init-forcage-thi-public-const-type-info-ptr-init-forcage-thi-get-info-const-override>`
[const Type_info * init_forcage_THI::get_info() const override](#init-forcage-thi-public-const-type-info-ptr-init-forcage-thi-get-info-const-override)
get_semi_gen#
int init_forcage_THI::get_semi_gen()
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 init_forcage_THI::get_semi_gen() <init-forcage-thi-public-int-init-forcage-thi-get-semi-gen>`
[int init_forcage_THI::get_semi_gen()](#init-forcage-thi-public-int-init-forcage-thi-get-semi-gen)
get_type_forcage#
int init_forcage_THI::get_type_forcage()
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 init_forcage_THI::get_type_forcage() <init-forcage-thi-public-int-init-forcage-thi-get-type-forcage>`
[int init_forcage_THI::get_type_forcage()](#init-forcage-thi-public-int-init-forcage-thi-get-type-forcage)
init_forcage_THI#
init_forcage_THI::init_forcage_THI()
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:`init_forcage_THI::init_forcage_THI() <init-forcage-thi-public-init-forcage-thi-init-forcage-thi>`
[init_forcage_THI::init_forcage_THI()](#init-forcage-thi-public-init-forcage-thi-init-forcage-thi)
taille_memoire#
unsigned init_forcage_THI::taille_memoire() const override
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 init_forcage_THI::taille_memoire() const override <init-forcage-thi-public-unsigned-init-forcage-thi-taille-memoire-const-override>`
[unsigned init_forcage_THI::taille_memoire() const override](#init-forcage-thi-public-unsigned-init-forcage-thi-taille-memoire-const-override)
update_advection_length#
void init_forcage_THI::update_advection_length(double dt)
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 init_forcage_THI::update_advection_length(double dt) <init-forcage-thi-public-void-init-forcage-thi-update-advection-length-double-dt>`
[void init_forcage_THI::update_advection_length(double dt)](#init-forcage-thi-public-void-init-forcage-thi-update-advection-length-double-dt)
update_advection_velocity#
void init_forcage_THI::update_advection_velocity(ArrOfDouble &value)
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 init_forcage_THI::update_advection_velocity(ArrOfDouble &value) <init-forcage-thi-public-void-init-forcage-thi-update-advection-velocity-arrofdouble-ref-value>`
[void init_forcage_THI::update_advection_velocity(ArrOfDouble &value)](#init-forcage-thi-public-void-init-forcage-thi-update-advection-velocity-arrofdouble-ref-value)
~init_forcage_THI#
init_forcage_THI::~init_forcage_THI()
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:`init_forcage_THI::~init_forcage_THI() <init-forcage-thi-public-init-forcage-thi-dtor-init-forcage-thi>`
[init_forcage_THI::~init_forcage_THI()](#init-forcage-thi-public-init-forcage-thi-dtor-init-forcage-thi)
cree_instance#
Objet_U * init_forcage_THI::cree_instance()
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 * init_forcage_THI::cree_instance() <init-forcage-thi-public-static-objet-u-ptr-init-forcage-thi-cree-instance>`
[Objet_U * init_forcage_THI::cree_instance()](#init-forcage-thi-public-static-objet-u-ptr-init-forcage-thi-cree-instance)
info#
const Type_info * init_forcage_THI::info()
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 * init_forcage_THI::info() <init-forcage-thi-public-static-const-type-info-ptr-init-forcage-thi-info>`
[const Type_info * init_forcage_THI::info()](#init-forcage-thi-public-static-const-type-info-ptr-init-forcage-thi-info)
self_cast#
const init_forcage_THI & init_forcage_THI::self_cast(const Objet_U &)
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 init_forcage_THI & init_forcage_THI::self_cast(const Objet_U &) <init-forcage-thi-public-static-const-init-forcage-thi-ref-init-forcage-thi-self-cast-const-objet-u-ref>`
[const init_forcage_THI & init_forcage_THI::self_cast(const Objet_U &)](#init-forcage-thi-public-static-const-init-forcage-thi-ref-init-forcage-thi-self-cast-const-objet-u-ref)
self_cast#
init_forcage_THI & init_forcage_THI::self_cast(Objet_U &)
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:`init_forcage_THI & init_forcage_THI::self_cast(Objet_U &) <init-forcage-thi-public-static-init-forcage-thi-ref-init-forcage-thi-self-cast-objet-u-ref>`
[init_forcage_THI & init_forcage_THI::self_cast(Objet_U &)](#init-forcage-thi-public-static-init-forcage-thi-ref-init-forcage-thi-self-cast-objet-u-ref)
printOn#
Sortie & init_forcage_THI::printOn(Sortie &x) const override
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 & init_forcage_THI::printOn(Sortie &x) const override <init-forcage-thi-protected-sortie-ref-init-forcage-thi-printon-sortie-ref-x-const-override>`
[Sortie & init_forcage_THI::printOn(Sortie &x) const override](#init-forcage-thi-protected-sortie-ref-init-forcage-thi-printon-sortie-ref-x-const-override)
readOn#
Entree & init_forcage_THI::readOn(Entree &) override
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 & init_forcage_THI::readOn(Entree &) override <init-forcage-thi-protected-entree-ref-init-forcage-thi-readon-entree-ref-override>`
[Entree & init_forcage_THI::readOn(Entree &) override](#init-forcage-thi-protected-entree-ref-init-forcage-thi-readon-entree-ref-override)
Attributes Documentation#
const Type_info init_forcage_THI::info_obj
ArrOfDouble init_forcage_THI::advection_length_
ArrOfDouble init_forcage_THI::advection_velocity_
double init_forcage_THI::amplitude = 1.
double init_forcage_THI::eps_etoile = 0.1
Force_ph init_forcage_THI::f_ph_THI
Force_sp init_forcage_THI::f_sp_THI
int init_forcage_THI::facteur_forcage_ = 0
double init_forcage_THI::forcage_t_stop = - 1
int init_forcage_THI::forcage_ts_stop = - 1
int init_forcage_THI::forced_advection_ = 0
int init_forcage_THI::i_offset = 0
int init_forcage_THI::j_offset = 0
int init_forcage_THI::k_offset = 0
int init_forcage_THI::mode_max = 0
int init_forcage_THI::mode_min = 0
Random_process init_forcage_THI::random_
double init_forcage_THI::time_to_be_del_ = 0.
double init_forcage_THI::tL = 0.02
int init_forcage_THI::type_forcage = 0