Probleme_Couple

Probleme_Couple#

#include <Probleme_Couple.h>
Brief description

classe Probleme_Couple C’est la classe historique de couplage de TRUST.

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:`Probleme\_Couple <class-probleme-couple>`

[Probleme\_Couple](#class-probleme-couple)

Detailed description#

Il s’agit d’un Couplage_U particulier. Le Probleme_Couple ne couple que des Probleme_base, tous associes au meme schema en temps. Il possede son propre mecanisme d’echange de champs par “raccords”. Les problemes sont groupes. Chaque groupe fait un iteration, puis les nouveaux champs sont disponibles pour les groupes suivants. A l’interieur d’un groupe, ce sont les anciens champs qui sont echanges.

Inherits from#

Inherited by#

Inheritance graph#

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

../../../../../_images/classProbleme__Couple__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

ajouter#

Definition
void Probleme_Couple::ajouter(Probleme_base &)
Brief description

Ajoute un probleme a la liste des problemes couples.

Detailed description

Met en place la reference du probleme vers this. Verifie que l’ordre conduction, thHyd est respecte.

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 Probleme_Couple::ajouter(Probleme_base &) <probleme-couple-public-void-probleme-couple-ajouter-probleme-base-ref>`

[void Probleme_Couple::ajouter(Probleme_base &)](#probleme-couple-public-void-probleme-couple-ajouter-probleme-base-ref)

associer_#

Definition
int Probleme_Couple::associer_(Objet_U &) override
Brief description

Surcharge Objet_U::associer_(Objet_U&) Associe un objet au probleme couple, en verifiant le type.

Detailed description

dynamiquement. L’objet peut - etre:

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:`int Probleme_Couple::associer_(Objet_U &) override <probleme-couple-public-int-probleme-couple-associer-underscore-objet-u-ref-override>`

[int Probleme_Couple::associer_(Objet_U &) override](#probleme-couple-public-int-probleme-couple-associer-underscore-objet-u-ref-override)

associer_sch_tps_base#

Definition
void Probleme_Couple::associer_sch_tps_base(Schema_Temps_base &)
Brief description

Associe une copie du schema en temps a chaque probleme du Probleme couple.

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 Probleme_Couple::associer_sch_tps_base(Schema_Temps_base &) <probleme-couple-public-void-probleme-couple-associer-sch-tps-base-schema-temps-base-ref>`

[void Probleme_Couple::associer_sch_tps_base(Schema_Temps_base &)](#probleme-couple-public-void-probleme-couple-associer-sch-tps-base-schema-temps-base-ref)

computeTimeStep#

Definition
double Probleme_Couple::computeTimeStep(bool &stop) const override
Brief description

Compute the value the Problem would like for the next time step.

Detailed description

This value will not necessarily be used at the call of initTimeStep, but it is a hint. This method may use all the internal state of the Problem.

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 Probleme_Couple::computeTimeStep(bool &stop) const override <probleme-couple-public-double-probleme-couple-computetimestep-bool-ref-stop-const-override>`

[double Probleme_Couple::computeTimeStep(bool &stop) const override](#probleme-couple-public-double-probleme-couple-computetimestep-bool-ref-stop-const-override)

discretiser#

Definition
void Probleme_Couple::discretiser(Discretisation_base &)
Brief description

Associe une discretisation a tous les problemes du probleme couple.

Detailed description

Appelle Probleme_Base::discretiser(const Discretisation_base&) sur chacun des problemes du probleme couple. voir Probleme_Base::discretiser(const Discretisation_base&)

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 Probleme_Couple::discretiser(Discretisation_base &) <probleme-couple-public-void-probleme-couple-discretiser-discretisation-base-ref>`

[void Probleme_Couple::discretiser(Discretisation_base &)](#probleme-couple-public-void-probleme-couple-discretiser-discretisation-base-ref)

duplique#

Definition
int Probleme_Couple::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 Probleme_Couple::duplique() const override <probleme-couple-public-int-probleme-couple-duplique-const-override>`

[int Probleme_Couple::duplique() const override](#probleme-couple-public-int-probleme-couple-duplique-const-override)

get_info#

Definition
const Type_info * Probleme_Couple::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 * Probleme_Couple::get_info() const override <probleme-couple-public-const-type-info-ptr-probleme-couple-get-info-const-override>`

[const Type_info * Probleme_Couple::get_info() const override](#probleme-couple-public-const-type-info-ptr-probleme-couple-get-info-const-override)

initialize#

Definition
void Probleme_Couple::initialize() override
Brief description

This method is called once at the beginning, before any other one of the interface Problem.

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 Probleme_Couple::initialize() override <probleme-couple-public-void-probleme-couple-initialize-override>`

[void Probleme_Couple::initialize() override](#probleme-couple-public-void-probleme-couple-initialize-override)

initTimeStep#

Definition
bool Probleme_Couple::initTimeStep(double dt) override
Brief description

This method allocates and initializes the unknown and given fields for the future time step.

Detailed description

The value of the interval is imposed through the parameter dt. In case of error, returns false.

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:`bool Probleme_Couple::initTimeStep(double dt) override <probleme-couple-public-bool-probleme-couple-inittimestep-double-dt-override>`

[bool Probleme_Couple::initTimeStep(double dt) override](#probleme-couple-public-bool-probleme-couple-inittimestep-double-dt-override)

iterateTimeStep#

Definition
bool Probleme_Couple::iterateTimeStep(bool &converged) override
Brief description

In the case solveTimeStep uses an iterative process, this method executes a single iteration.

Detailed description

It is thus possible to modify the given fields between iterations. converged is set to true if the process has converged, ie if the unknown fields are solution to the problem on the next time step. Otherwise converged is set to false. The return value indicates if the convergence process behaves normally. If false, the Problem wishes to abort the time step resolution.

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:`bool Probleme_Couple::iterateTimeStep(bool &converged) override <probleme-couple-public-bool-probleme-couple-iteratetimestep-bool-ref-converged-override>`

[bool Probleme_Couple::iterateTimeStep(bool &converged) override](#probleme-couple-public-bool-probleme-couple-iteratetimestep-bool-ref-converged-override)

mettre_a_jour_modele_rayo#

Definition
void Probleme_Couple::mettre_a_jour_modele_rayo(double temps)
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:`void Probleme_Couple::mettre_a_jour_modele_rayo(double temps) <probleme-couple-public-void-probleme-couple-mettre-a-jour-modele-rayo-double-temps>`

[void Probleme_Couple::mettre_a_jour_modele_rayo(double temps)](#probleme-couple-public-void-probleme-couple-mettre-a-jour-modele-rayo-double-temps)

Probleme_Couple#

Definition
Probleme_Couple::Probleme_Couple()
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:`Probleme_Couple::Probleme_Couple() <probleme-couple-public-probleme-couple-probleme-couple>`

[Probleme_Couple::Probleme_Couple()](#probleme-couple-public-probleme-couple-probleme-couple)

sauver#

Definition
void Probleme_Couple::sauver() const override
Brief description

Sauvegarder l’etat du probleme sur disque.

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 Probleme_Couple::sauver() const override <probleme-couple-public-void-probleme-couple-sauver-const-override>`

[void Probleme_Couple::sauver() const override](#probleme-couple-public-void-probleme-couple-sauver-const-override)

schema_temps#

Definition
Schema_Temps_base & Probleme_Couple::schema_temps()
Brief description

Renvoie le schema en temps associe aux problemes couples.

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:`Schema_Temps_base & Probleme_Couple::schema_temps() <probleme-couple-public-schema-temps-base-ref-probleme-couple-schema-temps>`

[Schema_Temps_base & Probleme_Couple::schema_temps()](#probleme-couple-public-schema-temps-base-ref-probleme-couple-schema-temps)

schema_temps#

Definition
const Schema_Temps_base & Probleme_Couple::schema_temps() const
Brief description

Renvoie le schema en temps associe aux problemes couples.

Detailed description

(version const)

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 Schema_Temps_base & Probleme_Couple::schema_temps() const <probleme-couple-public-const-schema-temps-base-ref-probleme-couple-schema-temps-const>`

[const Schema_Temps_base & Probleme_Couple::schema_temps() const](#probleme-couple-public-const-schema-temps-base-ref-probleme-couple-schema-temps-const)

solveTimeStep#

Definition
bool Probleme_Couple::solveTimeStep() override
Brief description

pour recodage eventuel et appel unifie en python

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:`bool Probleme_Couple::solveTimeStep() override <probleme-couple-public-bool-probleme-couple-solvetimestep-override>`

[bool Probleme_Couple::solveTimeStep() override](#probleme-couple-public-bool-probleme-couple-solvetimestep-override)

taille_memoire#

Definition
unsigned Probleme_Couple::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 Probleme_Couple::taille_memoire() const override <probleme-couple-public-unsigned-probleme-couple-taille-memoire-const-override>`

[unsigned Probleme_Couple::taille_memoire() const override](#probleme-couple-public-unsigned-probleme-couple-taille-memoire-const-override)

updateGivenFields#

Definition
bool Probleme_Couple::updateGivenFields() override
Brief description

ATTENTION :

Detailed description

Rentre ici tout ce qui ne correspond pas a l’API normale de Problem. Actuellement on y met a jour les CLs et les termes sources, sachant que certains vont chercher eux - memes des informations dans les problemes voisins… Programme de travail : tout ce qui est dans cette methode doit etre rendu independant de l’exterieur, et peut du coup rejoindre initTimeStep. Le reste passe dans l’interface d’echange de champs. Ce travail sera fini quand updateGivenFields sera vide et supprime !

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:`bool Probleme_Couple::updateGivenFields() override <probleme-couple-public-bool-probleme-couple-updategivenfields-override>`

[bool Probleme_Couple::updateGivenFields() override](#probleme-couple-public-bool-probleme-couple-updategivenfields-override)

~Probleme_Couple#

Definition
Probleme_Couple::~Probleme_Couple()
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:`Probleme_Couple::~Probleme_Couple() <probleme-couple-public-probleme-couple-dtor-probleme-couple>`

[Probleme_Couple::~Probleme_Couple()](#probleme-couple-public-probleme-couple-dtor-probleme-couple)

cree_instance#

Definition
Objet_U * Probleme_Couple::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 * Probleme_Couple::cree_instance() <probleme-couple-public-static-objet-u-ptr-probleme-couple-cree-instance>`

[Objet_U * Probleme_Couple::cree_instance()](#probleme-couple-public-static-objet-u-ptr-probleme-couple-cree-instance)

info#

Definition
const Type_info * Probleme_Couple::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 * Probleme_Couple::info() <probleme-couple-public-static-const-type-info-ptr-probleme-couple-info>`

[const Type_info * Probleme_Couple::info()](#probleme-couple-public-static-const-type-info-ptr-probleme-couple-info)

self_cast#

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

[const Probleme_Couple & Probleme_Couple::self_cast(const Objet_U &)](#probleme-couple-public-static-const-probleme-couple-ref-probleme-couple-self-cast-const-objet-u-ref)

self_cast#

Definition
Probleme_Couple & Probleme_Couple::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:`Probleme_Couple & Probleme_Couple::self_cast(Objet_U &) <probleme-couple-public-static-probleme-couple-ref-probleme-couple-self-cast-objet-u-ref>`

[Probleme_Couple & Probleme_Couple::self_cast(Objet_U &)](#probleme-couple-public-static-probleme-couple-ref-probleme-couple-self-cast-objet-u-ref)

printOn#

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

Surcharge Objet_U::printOn(Sortie&) Imprime les problemes couples sur un flot de sortie.

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:`Sortie & Probleme_Couple::printOn(Sortie &x) const override <probleme-couple-protected-sortie-ref-probleme-couple-printon-sortie-ref-x-const-override>`

[Sortie & Probleme_Couple::printOn(Sortie &x) const override](#probleme-couple-protected-sortie-ref-probleme-couple-printon-sortie-ref-x-const-override)

readOn#

Definition
Entree & Probleme_Couple::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 & Probleme_Couple::readOn(Entree &) override <probleme-couple-protected-entree-ref-probleme-couple-readon-entree-ref-override>`

[Entree & Probleme_Couple::readOn(Entree &) override](#probleme-couple-protected-entree-ref-probleme-couple-readon-entree-ref-override)

Attributes Documentation#

info_obj (public)
const Type_info Probleme_Couple::info_obj
groupes (protected)
ArrOfInt Probleme_Couple::groupes
sch_clones (protected)
TRUST_Vector<TRUST_Deriv<Schema_Temps_base>> Probleme_Couple::sch_clones
Contents