Couplage_U#
#include <Couplage_U.h>
class Couplage_U
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:`Couplage\_U <class-couplage-u>`
[Couplage\_U](#class-couplage-u)
Detailed description#
Cette classe implemente Probleme_U dans le cas d’un probleme composite couplant plusieurs Probleme_U.
Inherits from#
public : Probleme_U
Inherited by#
public : Probleme_Couple
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#
abortTimeStep#
void Couplage_U::abortTimeStep() override
Aborts the resolution of the current time step.
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 Couplage_U::abortTimeStep() override <couplage-u-public-void-couplage-u-aborttimestep-override>`
[void Couplage_U::abortTimeStep() override](#couplage-u-public-void-couplage-u-aborttimestep-override)
addProblem#
void Couplage_U::addProblem(Probleme_U &)
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 Couplage_U::addProblem(Probleme_U &) <couplage-u-public-void-couplage-u-addproblem-probleme-u-ref>`
[void Couplage_U::addProblem(Probleme_U &)](#couplage-u-public-void-couplage-u-addproblem-probleme-u-ref)
Couplage_U#
Couplage_U::Couplage_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:`Couplage_U::Couplage_U() <couplage-u-public-couplage-u-couplage-u>`
[Couplage_U::Couplage_U()](#couplage-u-public-couplage-u-couplage-u)
duplique#
int Couplage_U::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 Couplage_U::duplique() const override <couplage-u-public-int-couplage-u-duplique-const-override>`
[int Couplage_U::duplique() const override](#couplage-u-public-int-couplage-u-duplique-const-override)
findInputField#
TRUST_Ref<Field_base *> Couplage_U::findInputField(const Nom &name) const override
This method is used to find in a hierarchy of problems the Champ_Input_Proto of a given name.
Detailed description
Implementation is not optimal in 2 ways :
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:`TRUST_Ref<Field_base *> Couplage_U::findInputField(const Nom &name) const override <couplage-u-public-trust-ref-field-base-ptr-couplage-u-findinputfield-const-nom-ref-name-const-override>`
[TRUST_Ref<Field_base *> Couplage_U::findInputField(const Nom &name) const override](#couplage-u-public-trust-ref-field-base-ptr-couplage-u-findinputfield-const-nom-ref-name-const-override)
findOutputField#
TRUST_Ref<Champ_Generique_base *> Couplage_U::findOutputField(const Nom &name) const override
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:`TRUST_Ref<Champ_Generique_base *> Couplage_U::findOutputField(const Nom &name) const override <couplage-u-public-trust-ref-champ-generique-base-ptr-couplage-u-findoutputfield-const-nom-ref-name-const-override>`
[TRUST_Ref<Champ_Generique_base *> Couplage_U::findOutputField(const Nom &name) const override](#couplage-u-public-trust-ref-champ-generique-base-ptr-couplage-u-findoutputfield-const-nom-ref-name-const-override)
futureTime#
double Couplage_U::futureTime() const override
Returns the future time (end of current computing interval) This value is valid between initTimeStep and either.
Detailed description
validateTimeStep or abortTimeStep. A surcharger
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 Couplage_U::futureTime() const override <couplage-u-public-double-couplage-u-futuretime-const-override>`
[double Couplage_U::futureTime() const override](#couplage-u-public-double-couplage-u-futuretime-const-override)
get_info#
const Type_info * Couplage_U::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 * Couplage_U::get_info() const override <couplage-u-public-const-type-info-ptr-couplage-u-get-info-const-override>`
[const Type_info * Couplage_U::get_info() const override](#couplage-u-public-const-type-info-ptr-couplage-u-get-info-const-override)
getInputFieldsNames#
void Couplage_U::getInputFieldsNames(Noms &noms) const override
This method is used to find the names of input fields understood by the Problem.
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 Couplage_U::getInputFieldsNames(Noms &noms) const override <couplage-u-public-void-couplage-u-getinputfieldsnames-noms-ref-noms-const-override>`
[void Couplage_U::getInputFieldsNames(Noms &noms) const override](#couplage-u-public-void-couplage-u-getinputfieldsnames-noms-ref-noms-const-override)
getOutputFieldsNames#
void Couplage_U::getOutputFieldsNames(Noms &noms) const override
This method is used to find the names of output fields understood by the Problem.
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 Couplage_U::getOutputFieldsNames(Noms &noms) const override <couplage-u-public-void-couplage-u-getoutputfieldsnames-noms-ref-noms-const-override>`
[void Couplage_U::getOutputFieldsNames(Noms &noms) const override](#couplage-u-public-void-couplage-u-getoutputfieldsnames-noms-ref-noms-const-override)
indice_probleme#
int Couplage_U::indice_probleme(const Nom &nom_pb) const
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 Couplage_U::indice_probleme(const Nom &nom_pb) const <couplage-u-public-int-couplage-u-indice-probleme-const-nom-ref-nom-pb-const>`
[int Couplage_U::indice_probleme(const Nom &nom_pb) const](#couplage-u-public-int-couplage-u-indice-probleme-const-nom-ref-nom-pb-const)
initialize#
void Couplage_U::initialize() override
This method is called once at the beginning, before any other one of the interface Problem.
Detailed description
Reimplements:
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 Couplage_U::initialize() override <couplage-u-public-void-couplage-u-initialize-override>`
[void Couplage_U::initialize() override](#couplage-u-public-void-couplage-u-initialize-override)
initTimeStep#
bool Couplage_U::initTimeStep(double dt) override
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
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:`bool Couplage_U::initTimeStep(double dt) override <couplage-u-public-bool-couplage-u-inittimestep-double-dt-override>`
[bool Couplage_U::initTimeStep(double dt) override](#couplage-u-public-bool-couplage-u-inittimestep-double-dt-override)
isStationary#
bool Couplage_U::isStationary() const override
Tells if the Problem unknowns have changed during the last time step.
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 Couplage_U::isStationary() const override <couplage-u-public-bool-couplage-u-isstationary-const-override>`
[bool Couplage_U::isStationary() const override](#couplage-u-public-bool-couplage-u-isstationary-const-override)
iterateTimeStep#
bool Couplage_U::iterateTimeStep(bool &converged) override
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 Couplage_U::iterateTimeStep(bool &converged) override <couplage-u-public-bool-couplage-u-iteratetimestep-bool-ref-converged-override>`
[bool Couplage_U::iterateTimeStep(bool &converged) override](#couplage-u-public-bool-couplage-u-iteratetimestep-bool-ref-converged-override)
limpr#
int Couplage_U::limpr() const override
Doit - on imprimer les statistiques d’execution maintenant ?
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:`int Couplage_U::limpr() const override <couplage-u-public-int-couplage-u-limpr-const-override>`
[int Couplage_U::limpr() const override](#couplage-u-public-int-couplage-u-limpr-const-override)
lsauv#
int Couplage_U::lsauv() const override
Doit - on sauvegarder l’etat du probleme sur disque maintenant ?
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 Couplage_U::lsauv() const override <couplage-u-public-int-couplage-u-lsauv-const-override>`
[int Couplage_U::lsauv() const override](#couplage-u-public-int-couplage-u-lsauv-const-override)
nb_problemes#
int Couplage_U::nb_problemes() const
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:`int Couplage_U::nb_problemes() const <couplage-u-public-int-couplage-u-nb-problemes-const>`
[int Couplage_U::nb_problemes() const](#couplage-u-public-int-couplage-u-nb-problemes-const)
newCompute#
std::string Couplage_U::newCompute() override
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:`std::string Couplage_U::newCompute() override <couplage-u-public-std-string-couplage-u-newcompute-override>`
[std::string Couplage_U::newCompute() override](#couplage-u-public-std-string-couplage-u-newcompute-override)
postraiter#
int Couplage_U::postraiter(int force=1) override
Demande au probleme de postraiter ses champs, sondes,.
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:`int Couplage_U::postraiter(int force=1) override <couplage-u-public-int-couplage-u-postraiter-int-force-equal-1-override>`
[int Couplage_U::postraiter(int force=1) override](#couplage-u-public-int-couplage-u-postraiter-int-force-equal-1-override)
presentTime#
double Couplage_U::presentTime() const override
Returns the present time.
Detailed description
This value may change only at the call of validateTimeStep. A surcharger
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 Couplage_U::presentTime() const override <couplage-u-public-double-couplage-u-presenttime-const-override>`
[double Couplage_U::presentTime() const override](#couplage-u-public-double-couplage-u-presenttime-const-override)
probleme#
Probleme_U & Couplage_U::probleme(const Nom &nom_pb)
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:`Probleme_U & Couplage_U::probleme(const Nom &nom_pb) <couplage-u-public-probleme-u-ref-couplage-u-probleme-const-nom-ref-nom-pb>`
[Probleme_U & Couplage_U::probleme(const Nom &nom_pb)](#couplage-u-public-probleme-u-ref-couplage-u-probleme-const-nom-ref-nom-pb)
probleme#
const Probleme_U & Couplage_U::probleme(const Nom &nom_pb) const
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:`const Probleme_U & Couplage_U::probleme(const Nom &nom_pb) const <couplage-u-public-const-probleme-u-ref-couplage-u-probleme-const-nom-ref-nom-pb-const>`
[const Probleme_U & Couplage_U::probleme(const Nom &nom_pb) const](#couplage-u-public-const-probleme-u-ref-couplage-u-probleme-const-nom-ref-nom-pb-const)
probleme#
Probleme_U & Couplage_U::probleme(int i)
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_U & Couplage_U::probleme(int i) <couplage-u-public-probleme-u-ref-couplage-u-probleme-int-i>`
[Probleme_U & Couplage_U::probleme(int i)](#couplage-u-public-probleme-u-ref-couplage-u-probleme-int-i)
probleme#
const Probleme_U & Couplage_U::probleme(int i) const
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_U & Couplage_U::probleme(int i) const <couplage-u-public-const-probleme-u-ref-couplage-u-probleme-int-i-const>`
[const Probleme_U & Couplage_U::probleme(int i) const](#couplage-u-public-const-probleme-u-ref-couplage-u-probleme-int-i-const)
resetTime#
void Couplage_U::resetTime(double t) override
Reset the current time of the Problem to a given value.
Detailed description
Particularly useful for the initialization of complex transients: the starting point of the transient of interest is computed first, the time is reset to 0, and then the actual transient of interest starts with proper initial conditions, and global time 0.
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 Couplage_U::resetTime(double t) override <couplage-u-public-void-couplage-u-resettime-double-t-override>`
[void Couplage_U::resetTime(double t) override](#couplage-u-public-void-couplage-u-resettime-double-t-override)
sauver#
void Couplage_U::sauver() const override
Sauvegarder l’etat du probleme sur disque.
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 Couplage_U::sauver() const override <couplage-u-public-void-couplage-u-sauver-const-override>`
[void Couplage_U::sauver() const override](#couplage-u-public-void-couplage-u-sauver-const-override)
setStationary#
void Couplage_U::setStationary(bool) override
Tells to the Problem that stationary is reached or not.
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 Couplage_U::setStationary(bool) override <couplage-u-public-void-couplage-u-setstationary-bool-override>`
[void Couplage_U::setStationary(bool) override](#couplage-u-public-void-couplage-u-setstationary-bool-override)
taille_memoire#
unsigned Couplage_U::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 Couplage_U::taille_memoire() const override <couplage-u-public-unsigned-couplage-u-taille-memoire-const-override>`
[unsigned Couplage_U::taille_memoire() const override](#couplage-u-public-unsigned-couplage-u-taille-memoire-const-override)
terminate#
void Couplage_U::terminate() override
This method is called once at the end, after any other one.
Detailed description
It frees the memory and saves anything that needs to be saved.
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 Couplage_U::terminate() override <couplage-u-public-void-couplage-u-terminate-override>`
[void Couplage_U::terminate() override](#couplage-u-public-void-couplage-u-terminate-override)
updateGivenFields#
bool Couplage_U::updateGivenFields() override
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:
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 Couplage_U::updateGivenFields() override <couplage-u-public-bool-couplage-u-updategivenfields-override>`
[bool Couplage_U::updateGivenFields() override](#couplage-u-public-bool-couplage-u-updategivenfields-override)
validateTimeStep#
void Couplage_U::validateTimeStep() override
Validates the calculated unknown by moving the present time at the end of the time step.
Detailed description
This method is allowed to free past values of the unknown and given fields.
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 Couplage_U::validateTimeStep() override <couplage-u-public-void-couplage-u-validatetimestep-override>`
[void Couplage_U::validateTimeStep() override](#couplage-u-public-void-couplage-u-validatetimestep-override)
~Couplage_U#
Couplage_U::~Couplage_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:`Couplage_U::~Couplage_U() <couplage-u-public-couplage-u-dtor-couplage-u>`
[Couplage_U::~Couplage_U()](#couplage-u-public-couplage-u-dtor-couplage-u)
cree_instance#
Objet_U * Couplage_U::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 * Couplage_U::cree_instance() <couplage-u-public-static-objet-u-ptr-couplage-u-cree-instance>`
[Objet_U * Couplage_U::cree_instance()](#couplage-u-public-static-objet-u-ptr-couplage-u-cree-instance)
info#
const Type_info * Couplage_U::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 * Couplage_U::info() <couplage-u-public-static-const-type-info-ptr-couplage-u-info>`
[const Type_info * Couplage_U::info()](#couplage-u-public-static-const-type-info-ptr-couplage-u-info)
self_cast#
const Couplage_U & Couplage_U::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 Couplage_U & Couplage_U::self_cast(const Objet_U &) <couplage-u-public-static-const-couplage-u-ref-couplage-u-self-cast-const-objet-u-ref>`
[const Couplage_U & Couplage_U::self_cast(const Objet_U &)](#couplage-u-public-static-const-couplage-u-ref-couplage-u-self-cast-const-objet-u-ref)
self_cast#
Couplage_U & Couplage_U::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:`Couplage_U & Couplage_U::self_cast(Objet_U &) <couplage-u-public-static-couplage-u-ref-couplage-u-self-cast-objet-u-ref>`
[Couplage_U & Couplage_U::self_cast(Objet_U &)](#couplage-u-public-static-couplage-u-ref-couplage-u-self-cast-objet-u-ref)
printOn#
Sortie & Couplage_U::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 & Couplage_U::printOn(Sortie &x) const override <couplage-u-protected-sortie-ref-couplage-u-printon-sortie-ref-x-const-override>`
[Sortie & Couplage_U::printOn(Sortie &x) const override](#couplage-u-protected-sortie-ref-couplage-u-printon-sortie-ref-x-const-override)
readOn#
Entree & Couplage_U::readOn(Entree &) override
Lecture d’un Objet_U sur un flot d’entree Methode a surcharger.
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:`Entree & Couplage_U::readOn(Entree &) override <couplage-u-protected-entree-ref-couplage-u-readon-entree-ref-override>`
[Entree & Couplage_U::readOn(Entree &) override](#couplage-u-protected-entree-ref-couplage-u-readon-entree-ref-override)
Attributes Documentation#
const Type_info Couplage_U::info_obj
TRUST_List<TRUST_Ref<Probleme_U *>> Couplage_U::problems