Terme_Source_Canal_perio

Terme_Source_Canal_perio#

#include <Terme_Source_Canal_perio.h>
Brief description

Source term to keep a constant flow rate in a channel with periodic boundary conditions.

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:`Terme\_Source\_Canal\_perio <class-terme-source-canal-perio>`

[Terme\_Source\_Canal\_perio](#class-terme-source-canal-perio)

Detailed description#

Inherits from#

Inherited by#

Inheritance graph#

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

../../../../../_images/classTerme__Source__Canal__perio__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

associer_pb#

Definition
void Terme_Source_Canal_perio::associer_pb(const Probleme_base &) 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:`void Terme_Source_Canal_perio::associer_pb(const Probleme_base &) override <terme-source-canal-perio-public-void-terme-source-canal-perio-associer-pb-const-probleme-base-ref-override>`

[void Terme_Source_Canal_perio::associer_pb(const Probleme_base &) override](#terme-source-canal-perio-public-void-terme-source-canal-perio-associer-pb-const-probleme-base-ref-override)

calculer#

Definition
DoubleTab & Terme_Source_Canal_perio::calculer(DoubleTab &resu) 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:`DoubleTab & Terme_Source_Canal_perio::calculer(DoubleTab &resu) const override <terme-source-canal-perio-public-doubletab-ref-terme-source-canal-perio-calculer-doubletab-ref-resu-const-override>`

[DoubleTab & Terme_Source_Canal_perio::calculer(DoubleTab &resu) const override](#terme-source-canal-perio-public-doubletab-ref-terme-source-canal-perio-calculer-doubletab-ref-resu-const-override)

get_info#

Definition
const Type_info * Terme_Source_Canal_perio::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 * Terme_Source_Canal_perio::get_info() const override <terme-source-canal-perio-public-const-type-info-ptr-terme-source-canal-perio-get-info-const-override>`

[const Type_info * Terme_Source_Canal_perio::get_info() const override](#terme-source-canal-perio-public-const-type-info-ptr-terme-source-canal-perio-get-info-const-override)

mettre_a_jour#

Definition
void Terme_Source_Canal_perio::mettre_a_jour(double temps) override
Brief description

DOES NOTHING - to override in derived classes.

Detailed description

Mise a jour en temps du terme source.

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 Terme_Source_Canal_perio::mettre_a_jour(double temps) override <terme-source-canal-perio-public-void-terme-source-canal-perio-mettre-a-jour-double-temps-override>`

[void Terme_Source_Canal_perio::mettre_a_jour(double temps) override](#terme-source-canal-perio-public-void-terme-source-canal-perio-mettre-a-jour-double-temps-override)

Terme_Source_Canal_perio#

Definition
Terme_Source_Canal_perio::Terme_Source_Canal_perio()
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:`Terme_Source_Canal_perio::Terme_Source_Canal_perio() <terme-source-canal-perio-public-terme-source-canal-perio-terme-source-canal-perio>`

[Terme_Source_Canal_perio::Terme_Source_Canal_perio()](#terme-source-canal-perio-public-terme-source-canal-perio-terme-source-canal-perio)

~Terme_Source_Canal_perio#

Definition
Terme_Source_Canal_perio::~Terme_Source_Canal_perio() override
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:`Terme_Source_Canal_perio::~Terme_Source_Canal_perio() override <terme-source-canal-perio-public-terme-source-canal-perio-dtor-terme-source-canal-perio-override>`

[Terme_Source_Canal_perio::~Terme_Source_Canal_perio() override](#terme-source-canal-perio-public-terme-source-canal-perio-dtor-terme-source-canal-perio-override)

info#

Definition
const Type_info * Terme_Source_Canal_perio::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 * Terme_Source_Canal_perio::info() <terme-source-canal-perio-public-static-const-type-info-ptr-terme-source-canal-perio-info>`

[const Type_info * Terme_Source_Canal_perio::info()](#terme-source-canal-perio-public-static-const-type-info-ptr-terme-source-canal-perio-info)

self_cast#

Definition
const Terme_Source_Canal_perio & Terme_Source_Canal_perio::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 Terme_Source_Canal_perio & Terme_Source_Canal_perio::self_cast(const Objet_U &) <terme-source-canal-perio-public-static-const-terme-source-canal-perio-ref-terme-source-canal-perio-self-cast-const-objet-u-ref>`

[const Terme_Source_Canal_perio & Terme_Source_Canal_perio::self_cast(const Objet_U &)](#terme-source-canal-perio-public-static-const-terme-source-canal-perio-ref-terme-source-canal-perio-self-cast-const-objet-u-ref)

self_cast#

Definition
Terme_Source_Canal_perio & Terme_Source_Canal_perio::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:`Terme_Source_Canal_perio & Terme_Source_Canal_perio::self_cast(Objet_U &) <terme-source-canal-perio-public-static-terme-source-canal-perio-ref-terme-source-canal-perio-self-cast-objet-u-ref>`

[Terme_Source_Canal_perio & Terme_Source_Canal_perio::self_cast(Objet_U &)](#terme-source-canal-perio-public-static-terme-source-canal-perio-ref-terme-source-canal-perio-self-cast-objet-u-ref)

calculer_debit#

Definition
virtual void Terme_Source_Canal_perio::calculer_debit(double &) const =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:`virtual void Terme_Source_Canal_perio::calculer_debit(double &) const =0 <terme-source-canal-perio-protected-virtual-void-terme-source-canal-perio-calculer-debit-double-ref-const-equal-0>`

[virtual void Terme_Source_Canal_perio::calculer_debit(double &) const =0](#terme-source-canal-perio-protected-virtual-void-terme-source-canal-perio-calculer-debit-double-ref-const-equal-0)

completer#

Definition
void Terme_Source_Canal_perio::completer() override
Brief description

Met a jour les references internes a l’objet Source_base .

Detailed description

Appelle 2 methodes virtuelles pures protegees: Source_base::associer_domaines(const Domaine_dis_base& ,const Domaine_Cl_dis_base&) Source_base::associer_pb(const Probleme_base&)

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 Terme_Source_Canal_perio::completer() override <terme-source-canal-perio-protected-void-terme-source-canal-perio-completer-override>`

[void Terme_Source_Canal_perio::completer() override](#terme-source-canal-perio-protected-void-terme-source-canal-perio-completer-override)

compute_heat_flux#

Definition
double Terme_Source_Canal_perio::compute_heat_flux() 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:`double Terme_Source_Canal_perio::compute_heat_flux() const <terme-source-canal-perio-protected-double-terme-source-canal-perio-compute-heat-flux-const>`

[double Terme_Source_Canal_perio::compute_heat_flux() const](#terme-source-canal-perio-protected-double-terme-source-canal-perio-compute-heat-flux-const)

lire_motcle_non_standard#

Definition
int Terme_Source_Canal_perio::lire_motcle_non_standard(const Motcle &, Entree &) override
Brief description

Lecture des parametres de type non simple d’un objet_U a partir d’un flot d’entree.

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 Terme_Source_Canal_perio::lire_motcle_non_standard(const Motcle &, Entree &) override <terme-source-canal-perio-protected-int-terme-source-canal-perio-lire-motcle-non-standard-const-motcle-ref-entree-ref-override>`

[int Terme_Source_Canal_perio::lire_motcle_non_standard(const Motcle &, Entree &) override](#terme-source-canal-perio-protected-int-terme-source-canal-perio-lire-motcle-non-standard-const-motcle-ref-entree-ref-override)

printOn#

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

DOES NOTHING - to override in derived classes.

Detailed description

Imprime la source sur un flot de sortie.

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 & Terme_Source_Canal_perio::printOn(Sortie &x) const override <terme-source-canal-perio-protected-sortie-ref-terme-source-canal-perio-printon-sortie-ref-x-const-override>`

[Sortie & Terme_Source_Canal_perio::printOn(Sortie &x) const override](#terme-source-canal-perio-protected-sortie-ref-terme-source-canal-perio-printon-sortie-ref-x-const-override)

readOn#

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

DOES NOTHING - to override in derived classes.

Detailed description

Lecture d’un terme source sur un flot d’entree.

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:`Entree & Terme_Source_Canal_perio::readOn(Entree &) override <terme-source-canal-perio-protected-entree-ref-terme-source-canal-perio-readon-entree-ref-override>`

[Entree & Terme_Source_Canal_perio::readOn(Entree &) override](#terme-source-canal-perio-protected-entree-ref-terme-source-canal-perio-readon-entree-ref-override)

set_param#

Definition
void Terme_Source_Canal_perio::set_param(Param &param)
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 Terme_Source_Canal_perio::set_param(Param &param) <terme-source-canal-perio-protected-void-terme-source-canal-perio-set-param-param-ref-param>`

[void Terme_Source_Canal_perio::set_param(Param &param)](#terme-source-canal-perio-protected-void-terme-source-canal-perio-set-param-param-ref-param)

source#

Definition
ArrOfDouble Terme_Source_Canal_perio::source() const
Brief description

Term source calculation (called by VDF and VEF implementations) TODO: returning an ArrOfDouble is baaad.

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 Terme_Source_Canal_perio::source() const <terme-source-canal-perio-protected-arrofdouble-terme-source-canal-perio-source-const>`

[ArrOfDouble Terme_Source_Canal_perio::source() const](#terme-source-canal-perio-protected-arrofdouble-terme-source-canal-perio-source-const)

source_convection_diffusion#

Definition
ArrOfDouble Terme_Source_Canal_perio::source_convection_diffusion(double debit_e) 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:`ArrOfDouble Terme_Source_Canal_perio::source_convection_diffusion(double debit_e) const <terme-source-canal-perio-protected-arrofdouble-terme-source-canal-perio-source-convection-diffusion-double-debit-e-const>`

[ArrOfDouble Terme_Source_Canal_perio::source_convection_diffusion(double debit_e) const](#terme-source-canal-perio-protected-arrofdouble-terme-source-canal-perio-source-convection-diffusion-double-debit-e-const)

write_flow_rate#

Definition
void Terme_Source_Canal_perio::write_flow_rate(const Nom &ext_nom_source, double debit) 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:`void Terme_Source_Canal_perio::write_flow_rate(const Nom &ext_nom_source, double debit) const <terme-source-canal-perio-protected-void-terme-source-canal-perio-write-flow-rate-const-nom-ref-ext-nom-source-double-debit-const>`

[void Terme_Source_Canal_perio::write_flow_rate(const Nom &ext_nom_source, double debit) const](#terme-source-canal-perio-protected-void-terme-source-canal-perio-write-flow-rate-const-nom-ref-ext-nom-source-double-debit-const)

Attributes Documentation#

info_obj (public)
const Type_info Terme_Source_Canal_perio::info_obj
bord_periodique_ (protected)
Nom Terme_Source_Canal_perio::bord_periodique_
coeff (protected)
double Terme_Source_Canal_perio::coeff
deb_ (protected)
int Terme_Source_Canal_perio::deb_
debit_impose_ (protected)
double Terme_Source_Canal_perio::debit_impose_
debit_ref_ (protected)
double Terme_Source_Canal_perio::debit_ref_
debnm1_ (protected)
double Terme_Source_Canal_perio::debnm1_
dernier_temps_calc_ (protected)
double Terme_Source_Canal_perio::dernier_temps_calc_
dir_source_ (protected)
ArrOfDouble Terme_Source_Canal_perio::dir_source_
direction_ecoulement_ (protected)
int Terme_Source_Canal_perio::direction_ecoulement_
h (protected)
double Terme_Source_Canal_perio::h
is_debit_impose_ (protected)
int Terme_Source_Canal_perio::is_debit_impose_
source_ (protected)
double Terme_Source_Canal_perio::source_
surface_bord_ (protected)
double Terme_Source_Canal_perio::surface_bord_
u_etoile (protected)
double Terme_Source_Canal_perio::u_etoile
velocity_weighting_ (protected)
int Terme_Source_Canal_perio::velocity_weighting_
flow_rate_file_ (private)
SFichier Terme_Source_Canal_perio::flow_rate_file_
pressure_gradient_file_ (private)
SFichier Terme_Source_Canal_perio::pressure_gradient_file_
restart_file_ (private)
SFichier Terme_Source_Canal_perio::restart_file_
Contents