Couplage_U

#include <Couplage_U.h>

class Couplage_U

How to cite this class in this doc

RST

:ref:`Couplage\_U <class-couplage-u>`

Markdown

[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

List of Public Methods

• abortTimeStep

• addProblem

• Couplage_U

• duplique

• findInputField

• findOutputField

• futureTime

• get_info

• getInputFieldsNames

• getOutputFieldsNames

• indice_probleme

• initialize

• initTimeStep

• isStationary

• iterateTimeStep

• limpr

• lsauv

• nb_problemes

• newCompute

• postraiter

• presentTime

• probleme

• probleme

• probleme

• probleme

• resetTime

• sauver

• setStationary

• taille_memoire

• terminate

• updateGivenFields

• validateTimeStep

• ~Couplage_U

List of Public Static Methods

• cree_instance

• info

• self_cast

• self_cast

List of Protected Methods

• printOn

• readOn

Complete Member Function Documentation

abortTimeStep

void Couplage_U::abortTimeStep() override

Aborts the resolution of the current time step.

Reimplements:

• abortTimeStep

References

• Probleme_U::abortTimeStep

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`void Couplage_U::abortTimeStep() override <public-void-couplage-u-aborttimestep-override>`

Markdown

[void Couplage_U::abortTimeStep() override](#public-void-couplage-u-aborttimestep-override)

addProblem

void Couplage_U::addProblem(Probleme_U &)

References

• TRUST_List<_CLASSE_>::add

Referenced By

• Probleme_Couple::ajouter

How to cite in this doc:

RST

:ref:`void Couplage_U::addProblem(Probleme_U &) <public-void-couplage-u-addproblem-probleme-u-ref>`

Markdown

[void Couplage_U::addProblem(Probleme_U &)](#public-void-couplage-u-addproblem-probleme-u-ref)

Couplage_U

Couplage_U::Couplage_U()

How to cite in this doc:

RST

:ref:`Couplage_U::Couplage_U() <public-couplage-u-couplage-u>`

Markdown

[Couplage_U::Couplage_U()](#public-couplage-u-couplage-u)

duplique

int Couplage_U::duplique() const override

Reimplements:

• duplique

How to cite in this doc:

RST

:ref:`int Couplage_U::duplique() const override <public-int-couplage-u-duplique-const-override>`

Markdown

[int Couplage_U::duplique() const override](#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.

Implementation is not optimal in 2 ways :

Reimplements:

• findInputField

References

• Probleme_U::findInputField

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`TRUST_Ref<Field_base *> Couplage_U::findInputField(const Nom &name) const override <public-trust-ref-field-base-ptr-couplage-u-findinputfield-const-nom-ref-name-const-override>`

Markdown

[TRUST_Ref<Field_base *> Couplage_U::findInputField(const Nom &name) const override](#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

Reimplements:

• findOutputField

References

• Probleme_U::findOutputField

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`TRUST_Ref<Champ_Generique_base *> Couplage_U::findOutputField(const Nom &name) const override <public-trust-ref-champ-generique-base-ptr-couplage-u-findoutputfield-const-nom-ref-name-const-override>`

Markdown

[TRUST_Ref<Champ_Generique_base *> Couplage_U::findOutputField(const Nom &name) const override](#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.

validateTimeStep or abortTimeStep. A surcharger

Reimplements:

• futureTime

References

• Probleme_U::futureTime

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`double Couplage_U::futureTime() const override <public-double-couplage-u-futuretime-const-override>`

Markdown

[double Couplage_U::futureTime() const override](#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 .

Reimplements:

• get_info

How to cite in this doc:

RST

:ref:`const Type_info * Couplage_U::get_info() const override <public-const-type-info-ptr-couplage-u-get-info-const-override>`

Markdown

[const Type_info * Couplage_U::get_info() const override](#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.

Reimplements:

• getInputFieldsNames

References

• Probleme_U::getInputFieldsNames

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`void Couplage_U::getInputFieldsNames(Noms &noms) const override <public-void-couplage-u-getinputfieldsnames-noms-ref-noms-const-override>`

Markdown

[void Couplage_U::getInputFieldsNames(Noms &noms) const override](#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.

Reimplements:

• getOutputFieldsNames

References

• Probleme_U::getOutputFieldsNames

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`void Couplage_U::getOutputFieldsNames(Noms &noms) const override <public-void-couplage-u-getoutputfieldsnames-noms-ref-noms-const-override>`

Markdown

[void Couplage_U::getOutputFieldsNames(Noms &noms) const override](#public-void-couplage-u-getoutputfieldsnames-noms-ref-noms-const-override)

indice_probleme

int Couplage_U::indice_probleme(const Nom &nom_pb) const

References

• Process::exit

• Probleme_U::le_nom

• nb_problemes

• probleme

Referenced By

• probleme

How to cite in this doc:

RST

:ref:`int Couplage_U::indice_probleme(const Nom &nom_pb) const <public-int-couplage-u-indice-probleme-const-nom-ref-nom-pb-const>`

Markdown

[int Couplage_U::indice_probleme(const Nom &nom_pb) const](#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.

Reimplements:

• initialize

References

• Probleme_U::initialize

• nb_problemes

• Probleme_U::post_initialize

• probleme

Referenced By

• Probleme_Couple::initialize

How to cite in this doc:

RST

:ref:`void Couplage_U::initialize() override <public-void-couplage-u-initialize-override>`

Markdown

[void Couplage_U::initialize() override](#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.

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

Reimplements:

• initTimeStep

References

• Probleme_U::initTimeStep

• nb_problemes

• probleme

Referenced By

• Probleme_Couple::initTimeStep

How to cite in this doc:

RST

:ref:`bool Couplage_U::initTimeStep(double dt) override <public-bool-couplage-u-inittimestep-double-dt-override>`

Markdown

[bool Couplage_U::initTimeStep(double dt) override](#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.

Reimplements:

• isStationary

References

• Probleme_U::isStationary

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`bool Couplage_U::isStationary() const override <public-bool-couplage-u-isstationary-const-override>`

Markdown

[bool Couplage_U::isStationary() const override](#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.

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:

• iterateTimeStep

References

• Probleme_U::iterateTimeStep

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`bool Couplage_U::iterateTimeStep(bool &converged) override <public-bool-couplage-u-iteratetimestep-bool-ref-converged-override>`

Markdown

[bool Couplage_U::iterateTimeStep(bool &converged) override](#public-bool-couplage-u-iteratetimestep-bool-ref-converged-override)

limpr

int Couplage_U::limpr() const override

Doit - on imprimer les statistiques d’execution maintenant ?

Reimplements:

• limpr

References

• Probleme_U::limpr

• nb_problemes

• probleme

Referenced By

• Pb_Couple_Rayonnement::postraiter

How to cite in this doc:

RST

:ref:`int Couplage_U::limpr() const override <public-int-couplage-u-limpr-const-override>`

Markdown

[int Couplage_U::limpr() const override](#public-int-couplage-u-limpr-const-override)

lsauv

int Couplage_U::lsauv() const override

Doit - on sauvegarder l’etat du probleme sur disque maintenant ?

Reimplements:

• lsauv

References

• Probleme_U::lsauv

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`int Couplage_U::lsauv() const override <public-int-couplage-u-lsauv-const-override>`

Markdown

[int Couplage_U::lsauv() const override](#public-int-couplage-u-lsauv-const-override)

nb_problemes

int Couplage_U::nb_problemes() const

References

• TRUST_List<_CLASSE_>::size

Referenced By

• abortTimeStep

• Probleme_Couple::ajouter

• Pb_Couple_Rayonnement::associer_

• Pb_Couple_rayo_semi_transp::associer_

• Probleme_Couple::associer_sch_tps_base

• Pb_Couple_Rayonnement::completer

• Probleme_Couple::computeTimeStep

• Probleme_Couple::discretiser

• RK3_FT::faire_un_pas_de_temps_pb_couple

• Schema_Euler_Implicite::faire_un_pas_de_temps_pb_couple

• Schema_Implicite_Multi_TimeStep_base::faire_un_pas_de_temps_pb_couple

• findInputField

• findOutputField

• futureTime

• getInputFieldsNames

• getOutputFieldsNames

• indice_probleme

• Pb_Couple_rayo_semi_transp::initialize

• initialize

• Probleme_Couple::initialize

• initTimeStep

• Discretiser::interpreter

• isStationary

• iterateTimeStep

• Probleme_Couple::iterateTimeStep

• Pb_Couple_rayo_semi_transp::le_modele_rayo_associe

• limpr

• lsauv

• newCompute

• postraiter

• presentTime

• Probleme_Couple::printOn

• Probleme_Couple::readOn

• Pbc_MED::readOn

• resetTime

• sauver

• Probleme_Couple::sauver

• Probleme_Couple::schema_temps

• setStationary

• Probleme_Couple::solveTimeStep

• terminate

• updateGivenFields

• validateTimeStep

How to cite in this doc:

RST

:ref:`int Couplage_U::nb_problemes() const <public-int-couplage-u-nb-problemes-const>`

Markdown

[int Couplage_U::nb_problemes() const](#public-int-couplage-u-nb-problemes-const)

newCompute

std::string Couplage_U::newCompute() override

Reimplements:

• newCompute

References

• nb_problemes

• probleme

How to cite in this doc:

RST

:ref:`std::string Couplage_U::newCompute() override <public-std-string-couplage-u-newcompute-override>`

Markdown

[std::string Couplage_U::newCompute() override](#public-std-string-couplage-u-newcompute-override)

postraiter

int Couplage_U::postraiter(int force=1) override

Demande au probleme de postraiter ses champs, sondes,.

Reimplements:

• postraiter

References

• nb_problemes

• Probleme_U::postraiter

• probleme

Referenced By

• Pb_Couple_Rayonnement::postraiter

• Pbc_MED::readOn

How to cite in this doc:

RST

:ref:`int Couplage_U::postraiter(int force=1) override <public-int-couplage-u-postraiter-int-force-equal-1-override>`

Markdown

[int Couplage_U::postraiter(int force=1) override](#public-int-couplage-u-postraiter-int-force-equal-1-override)

presentTime

double Couplage_U::presentTime() const override

Returns the present time.

This value may change only at the call of validateTimeStep. A surcharger

Reimplements:

• presentTime

References

• nb_problemes

• Probleme_U::presentTime

• probleme

Referenced By

• Pb_Couple_rayo_semi_transp::initialize

• Pb_Couple_Rayonnement::validateTimeStep

How to cite in this doc:

RST

:ref:`double Couplage_U::presentTime() const override <public-double-couplage-u-presenttime-const-override>`

Markdown

[double Couplage_U::presentTime() const override](#public-double-couplage-u-presenttime-const-override)

probleme

Probleme_U & Couplage_U::probleme(const Nom &nom_pb)

References

• indice_probleme

• probleme

How to cite in this doc:

RST

:ref:`Probleme_U & Couplage_U::probleme(const Nom &nom_pb) <public-probleme-u-ref-couplage-u-probleme-const-nom-ref-nom-pb>`

Markdown

[Probleme_U & Couplage_U::probleme(const Nom &nom_pb)](#public-probleme-u-ref-couplage-u-probleme-const-nom-ref-nom-pb)

probleme

const Probleme_U & Couplage_U::probleme(const Nom &nom_pb) const

References

• indice_probleme

• probleme

How to cite in this doc:

RST

:ref:`const Probleme_U & Couplage_U::probleme(const Nom &nom_pb) const <public-const-probleme-u-ref-couplage-u-probleme-const-nom-ref-nom-pb-const>`

Markdown

[const Probleme_U & Couplage_U::probleme(const Nom &nom_pb) const](#public-const-probleme-u-ref-couplage-u-probleme-const-nom-ref-nom-pb-const)

probleme

Probleme_U & Couplage_U::probleme(int i)

How to cite in this doc:

RST

:ref:`Probleme_U & Couplage_U::probleme(int i) <public-probleme-u-ref-couplage-u-probleme-int-i>`

Markdown

[Probleme_U & Couplage_U::probleme(int i)](#public-probleme-u-ref-couplage-u-probleme-int-i)

probleme

const Probleme_U & Couplage_U::probleme(int i) const

Referenced By

• abortTimeStep

• Probleme_Couple::ajouter

• Pb_Couple_Rayonnement::associer_

• Probleme_Couple::associer_sch_tps_base

• Pb_Couple_Rayonnement::completer

• Probleme_Couple::computeTimeStep

• Probleme_Couple::discretiser

• RK3_FT::faire_un_pas_de_temps_pb_couple

• Schema_Euler_Implicite::faire_un_pas_de_temps_pb_couple

• Schema_Implicite_Multi_TimeStep_base::faire_un_pas_de_temps_pb_couple

• findInputField

• findOutputField

• futureTime

• getInputFieldsNames

• getOutputFieldsNames

• indice_probleme

• Pb_Couple_rayo_semi_transp::initialize

• initialize

• Probleme_Couple::initialize

• initTimeStep

• Discretiser::interpreter

• isStationary

• iterateTimeStep

• Probleme_Couple::iterateTimeStep

• Pb_Couple_rayo_semi_transp::le_modele_rayo_associe

• limpr

• lsauv

• newCompute

• postraiter

• presentTime

• Probleme_Couple::printOn

• probleme

• Pbc_MED::readOn

• resetTime

• sauver

• Probleme_Couple::sauver

• Probleme_Couple::schema_temps

• setStationary

• Probleme_Couple::solveTimeStep

• terminate

• updateGivenFields

• validateTimeStep

How to cite in this doc:

RST

:ref:`const Probleme_U & Couplage_U::probleme(int i) const <public-const-probleme-u-ref-couplage-u-probleme-int-i-const>`

Markdown

[const Probleme_U & Couplage_U::probleme(int i) const](#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.

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:

• resetTime

References

• Probleme_U::getOutputStringValue

• nb_problemes

• probleme

• Probleme_U::resetTime

• Sortie_Fichier_base::root

• Sortie_Fichier_base::set_root

• Probleme_U::setInputStringValue

• Probleme_U::str_params_

How to cite in this doc:

RST

:ref:`void Couplage_U::resetTime(double t) override <public-void-couplage-u-resettime-double-t-override>`

Markdown

[void Couplage_U::resetTime(double t) override](#public-void-couplage-u-resettime-double-t-override)

sauver

void Couplage_U::sauver() const override

Sauvegarder l’etat du probleme sur disque.

Reimplements:

• sauver

References

• nb_problemes

• probleme

• Probleme_U::sauver

How to cite in this doc:

RST

:ref:`void Couplage_U::sauver() const override <public-void-couplage-u-sauver-const-override>`

Markdown

[void Couplage_U::sauver() const override](#public-void-couplage-u-sauver-const-override)

setStationary

void Couplage_U::setStationary(bool) override

Tells to the Problem that stationary is reached or not.

Reimplements:

• setStationary

References

• nb_problemes

• probleme

• Probleme_U::setStationary

How to cite in this doc:

RST

:ref:`void Couplage_U::setStationary(bool) override <public-void-couplage-u-setstationary-bool-override>`

Markdown

[void Couplage_U::setStationary(bool) override](#public-void-couplage-u-setstationary-bool-override)

taille_memoire

unsigned Couplage_U::taille_memoire() const override

Reimplements:

• taille_memoire

How to cite in this doc:

RST

:ref:`unsigned Couplage_U::taille_memoire() const override <public-unsigned-couplage-u-taille-memoire-const-override>`

Markdown

[unsigned Couplage_U::taille_memoire() const override](#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.

It frees the memory and saves anything that needs to be saved.

Reimplements:

• terminate

References

• nb_problemes

• probleme

• Probleme_U::terminate

How to cite in this doc:

RST

:ref:`void Couplage_U::terminate() override <public-void-couplage-u-terminate-override>`

Markdown

[void Couplage_U::terminate() override](#public-void-couplage-u-terminate-override)

updateGivenFields

bool Couplage_U::updateGivenFields() override

ATTENTION :

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:

• updateGivenFields

References

• nb_problemes

• probleme

• Probleme_U::updateGivenFields

How to cite in this doc:

RST

:ref:`bool Couplage_U::updateGivenFields() override <public-bool-couplage-u-updategivenfields-override>`

Markdown

[bool Couplage_U::updateGivenFields() override](#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.

This method is allowed to free past values of the unknown and given fields.

Reimplements:

• validateTimeStep

References

• nb_problemes

• probleme

• Probleme_U::validateTimeStep

Referenced By

• Pb_Couple_Rayonnement::validateTimeStep

• Pb_Couple_Optimisation_IBM::validateTimeStep

How to cite in this doc:

RST

:ref:`void Couplage_U::validateTimeStep() override <public-void-couplage-u-validatetimestep-override>`

Markdown

[void Couplage_U::validateTimeStep() override](#public-void-couplage-u-validatetimestep-override)

~Couplage_U

Couplage_U::~Couplage_U()

How to cite in this doc:

RST

:ref:`Couplage_U::~Couplage_U() <public-couplage-u-dtor-couplage-u>`

Markdown

[Couplage_U::~Couplage_U()](#public-couplage-u-dtor-couplage-u)

cree_instance

Objet_U * Couplage_U::cree_instance()

How to cite in this doc:

RST

:ref:`Objet_U * Couplage_U::cree_instance() <public-static-objet-u-ptr-couplage-u-cree-instance>`

Markdown

[Objet_U * Couplage_U::cree_instance()](#public-static-objet-u-ptr-couplage-u-cree-instance)

info

const Type_info * Couplage_U::info()

How to cite in this doc:

RST

:ref:`const Type_info * Couplage_U::info() <public-static-const-type-info-ptr-couplage-u-info>`

Markdown

[const Type_info * Couplage_U::info()](#public-static-const-type-info-ptr-couplage-u-info)

self_cast

const Couplage_U & Couplage_U::self_cast(const Objet_U &)

How to cite in this doc:

RST

:ref:`const Couplage_U & Couplage_U::self_cast(const Objet_U &) <public-static-const-couplage-u-ref-couplage-u-self-cast-const-objet-u-ref>`

Markdown

[const Couplage_U & Couplage_U::self_cast(const Objet_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 &)

How to cite in this doc:

RST

:ref:`Couplage_U & Couplage_U::self_cast(Objet_U &) <public-static-couplage-u-ref-couplage-u-self-cast-objet-u-ref>`

Markdown

[Couplage_U & Couplage_U::self_cast(Objet_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.

Reimplements:

• printOn

References

• Objet_U::que_suis_je

How to cite in this doc:

RST

:ref:`Sortie & Couplage_U::printOn(Sortie &x) const override <protected-sortie-ref-couplage-u-printon-sortie-ref-x-const-override>`

Markdown

[Sortie & Couplage_U::printOn(Sortie &x) const override](#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.

Reimplements:

• readOn

How to cite in this doc:

RST

:ref:`Entree & Couplage_U::readOn(Entree &) override <protected-entree-ref-couplage-u-readon-entree-ref-override>`

Markdown

[Entree & Couplage_U::readOn(Entree &) override](#protected-entree-ref-couplage-u-readon-entree-ref-override)

Attributes Documentation

info_obj (public)

const Type_info Couplage_U::info_obj

problems (private)

TRUST_List<TRUST_Ref<Probleme_U *>> Couplage_U::problems