Probleme_U

Probleme_U#

#include <Probleme_U.h>

classe Probleme_U

How to cite this class in this doc#

RST

:ref:`Probleme\_U <class-probleme-u>`

Markdown

[Probleme\_U](#class-probleme-u)

Detailed description#

Cette classe ajoute des specificites TRUST a l’interface generale definie dans la classe Problem. De Probleme_U derivent : * Probleme_base pour tous les problemes individuels * Couplage_U pour les couplages de plusieurs Probleme_U Toutes ces classes doivent satisfaire l’API de Problem completee par celle de Probleme_U.

Inherits from#

public : Objet_U

Inherited by#

public : Couplage_U
public : Probleme_base

List of Protected Methods#

printOn
readOn

Complete Member Function Documentation#

abortTimeStep

void Probleme_U::abortTimeStep()

Aborts the resolution of the current time step.

computeTimeStep

double Probleme_U::computeTimeStep(bool &stop) const

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

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.

findInputField

TRUST_Ref<Field_base *> Probleme_U::findInputField(const Nom &name) const

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 :

findOutputField

TRUST_Ref<Champ_Generique_base *> Probleme_U::findOutputField(const Nom &name) const

futureTime

double Probleme_U::futureTime() const

Returns the future time (end of current computing interval) This value is valid between initTimeStep and either.

validateTimeStep or abortTimeStep. A surcharger

get_info

const Type_info * Probleme_U::get_info() const override

Donne des informations sur le type de l’ Objet_U .

Reimplements:

get_info

getInputFieldsNames

void Probleme_U::getInputFieldsNames(Noms &noms) const

This method is used to find the names of input fields understood by the Problem.

getInputFieldTemplate

void Probleme_U::getInputFieldTemplate(const Nom &name, ICoCo::TrioField &afield) const

This method is used to get a template of a field expected for the given name.

getOutputField

void Probleme_U::getOutputField(const Nom &nameField, ICoCo::TrioField &afield) const

getOutputFieldsNames

void Probleme_U::getOutputFieldsNames(Noms &noms) const

This method is used to find the names of output fields understood by the Problem.

getOutputIntValue

int Probleme_U::getOutputIntValue(const Nom &name) const

getOutputStringValue

std::string Probleme_U::getOutputStringValue(const std::string &name)

initialize

void Probleme_U::initialize()

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

initTimeStep

bool Probleme_U::initTimeStep(double dt)

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.

isStationary

bool Probleme_U::isStationary() const

Tells if the Problem unknowns have changed during the last time step.

iterateTimeStep

bool Probleme_U::iterateTimeStep(bool &converged)

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.

le_nom

const Nom & Probleme_U::le_nom() const override

Donne le nom de l’ Objet_U Methode a surcharger : renvoie “neant” dans cette implementation.

Reimplements:

le_nom

limpr

int Probleme_U::limpr() const

Doit - on imprimer les statistiques d’execution maintenant ?

lsauv

int Probleme_U::lsauv() const

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

newCompute

virtual std::string Probleme_U::newCompute()

nommer

void Probleme_U::nommer(const Nom &name) override

Donne un nom a l’ Objet_U Methode virtuelle a surcharger.

Reimplements:

nommer

post_initialize

virtual void Probleme_U::post_initialize()

postraiter

int Probleme_U::postraiter(int force=1)

Demande au probleme de postraiter ses champs, sondes,.

presentTime

double Probleme_U::presentTime() const

Returns the present time.

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

Probleme_U

Probleme_U::Probleme_U()

resetTime

void Probleme_U::resetTime(double time)

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.

run

bool Probleme_U::run()

Cette methode est une sorte de main() du Problem Elle peut etre utilisee si le probleme n’est couple a aucun autre.

(s’il n’a besoin d’aucun champ d’entree).

runUntil

bool Probleme_U::runUntil(double time)

This method has the same role as the method run, but it stops when reaching the time given in parameter.

If this time cannot be reached, the method returns false.

sauver

void Probleme_U::sauver() const

Sauvegarder l’etat du probleme sur disque.

setInputDoubleValue

void Probleme_U::setInputDoubleValue(const Nom &name, const double val)

setInputField

void Probleme_U::setInputField(const Nom &name, const ICoCo::TrioField &afield)

This method is used to provide the Problem with an input field.

setInputIntValue

void Probleme_U::setInputIntValue(const Nom &name, const int &val)

setInputStringValue

virtual void Probleme_U::setInputStringValue(const std::string &name, const std::string &val)

setStationary

void Probleme_U::setStationary(bool)

Tells to the Problem that stationary is reached or not.

solveTimeStep

bool Probleme_U::solveTimeStep()

pour recodage eventuel et appel unifie en python

terminate

void Probleme_U::terminate()

This method is called once at the end, after any other one.

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

updateGivenFields

bool Probleme_U::updateGivenFields()

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 !

validateTimeStep

void Probleme_U::validateTimeStep()

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.

~Probleme_U

Probleme_U::~Probleme_U() override

info

const Type_info * Probleme_U::info()

self_cast

const Probleme_U & Probleme_U::self_cast(const Objet_U &)

self_cast

Probleme_U & Probleme_U::self_cast(Objet_U &)

printOn

Sortie & Probleme_U::printOn(Sortie &x) const override

Ecriture de l’objet sur un flot de sortie Methode a surcharger.

Reimplements:

printOn

readOn

Entree & Probleme_U::readOn(Entree &) override

Lecture d’un Objet_U sur un flot d’entree Methode a surcharger.

Reimplements:

readOn

Attributes Documentation#

info_obj (public)

const Type_info Probleme_U::info_obj

nom_ (protected)

Nom Probleme_U::nom_

reg_ (protected)

ScalarRegister Probleme_U::reg_

str_params_ (protected)

std::map<std::string, std::string> Probleme_U::str_params_

Probleme_U

Contents

Probleme_U#

How to cite this class in this doc#

Detailed description#

Inherits from#

Inherited by#

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

Attributes Documentation#