TrioCFD 1.9.8
TrioCFD documentation
Loading...
Searching...
No Matches
Probleme_U Class Reference

classe Probleme_U More...

#include <Probleme_U.h>

Inheritance diagram for Probleme_U:
[legend]
Collaboration diagram for Probleme_U:
[legend]

Public Member Functions

virtual void initialize ()
 This method is called once at the beginning, before any other one of the interface Problem.
virtual void terminate ()
 This method is called once at the end, after any other one.
virtual double presentTime () const
 Returns the present time.
virtual double computeTimeStep (bool &stop) const
 Compute the value the Problem would like for the next time step.
virtual bool initTimeStep (double dt)
 This method allocates and initializes the unknown and given fields for the future time step.
virtual bool solveTimeStep ()
 pour recodage eventuel et appel unifie en python
virtual void validateTimeStep ()
 Validates the calculated unknown by moving the present time at the end of the time step.
virtual bool isStationary () const
 Tells if the Problem unknowns have changed during the last time step.
virtual std::string newCompute ()
virtual void setStationary (bool)
 Tells to the Problem that stationary is reached or not.
virtual void abortTimeStep ()
 Aborts the resolution of the current time step.
virtual void resetTime (double time)
 Reset the current time of the Problem to a given value.
virtual bool iterateTimeStep (bool &converged)
 In the case solveTimeStep uses an iterative process, this method executes a single iteration.
virtual void getInputFieldsNames (Noms &noms) const
 This method is used to find the names of input fields understood by the Problem.
virtual void getInputFieldTemplate (const Nom &name, ICoCo::TrioField &afield) const
virtual void setInputField (const Nom &name, const ICoCo::TrioField &afield)
virtual void getOutputFieldsNames (Noms &noms) const
virtual void getOutputField (const Nom &nameField, ICoCo::TrioField &afield) const
virtual void setInputIntValue (const Nom &name, const int &val)
virtual int getOutputIntValue (const Nom &name) const
virtual bool checkOutputIntEntry (const Nom &name) const
virtual void getOutputPointValues (const Nom &name, const std::vector< double > &x, const std::vector< double > &y, const std::vector< double > &z, std::vector< double > &vals, int compo)
double getOutputPointValues (const Nom &name, const double x, const double y, const double z, int compo)
virtual void setInputDoubleValue (const Nom &name, const double val)
virtual void setInputStringValue (const std::string &name, const std::string &val)
virtual std::string getOutputStringValue (const std::string &name)
virtual void post_initialize ()
virtual int postraiter (int force=1)
 Demande au probleme de postraiter ses champs, sondes,.
virtual int limpr () const
 Doit-on imprimer les statistiques d'execution maintenant ?
virtual int lsauv () const
 Doit-on sauvegarder l'etat du probleme sur disque maintenant ?
virtual void sauver () const
 Sauvegarder l'etat du probleme sur disque.
virtual bool updateGivenFields ()
 ATTENTION :
virtual double futureTime () const
 Returns the future time (end of current computing interval) This value is valid between initTimeStep and either.
virtual bool run ()
 Cette methode est une sorte de main() du Problem Elle peut etre utilisee si le probleme n'est couple a aucun autre.
virtual bool runUntil (double time)
 This method has the same role as the method run, but it stops when reaching the time given in parameter.
virtual OBS_PTR (Field_base) findInputField(const Nom &name) const
virtual OBS_PTR (Champ_Generique_base) findOutputField(const Nom &name) const
void nommer (const Nom &name) override
 Donne un nom a l'Objet_U Methode virtuelle a surcharger.
const Nomle_nom () const override
 Donne le nom de l'Objet_U Methode a surcharger : renvoie "neant" dans cette implementation.
Public Member Functions inherited from Objet_U
 ~Objet_U () override
 Destructeur, supprime l'objet de la liste d'objets enregistres dans "memoire".
int numero () const
 Renvoie l'indice de l'objet dans Memoire::data.
virtual int duplique () const =0
virtual SortieprintOn (Sortie &) const
 Ecriture de l'objet sur un flot de sortie Methode a surcharger.
virtual EntreereadOn (Entree &)
 Lecture d'un Objet_U sur un flot d'entree Methode a surcharger.
virtual unsigned taille_memoire () const =0
virtual int est_egal_a (const Objet_U &) const
 Renvoie 1 si l'objet x et *this sont une seule et meme instance (meme adresse en memoire).
virtual int reprendre (Entree &)
 Reprise d'un Objet_U sur un flot d'entree Methode a surcharger.
virtual int sauvegarder (Sortie &) const
 Sauvegarde d'un Objet_U sur un flot de sortie Methode a surcharger.
int get_object_id () const
 Renvoie l'identifiant unique de l'objet object_id_.
virtual const Type_infoget_info () const
 Donne des informations sur le type de l'Objet_U.
const Nomque_suis_je () const
 renvoie la chaine identifiant la classe.
const char * le_type () const
 Donne le nom du type de l'Objet_U.
virtual int change_num (const int *const)
 Change le numero interne de l'Objet_U.
virtual int lire_motcle_non_standard (const Motcle &motlu, Entree &is)
 Lecture des parametres de type non simple d'un objet_U a partir d'un flot d'entree.
virtual int associer_ (Objet_U &)
 Associe l'Objet_U a un autre Objet_U Methode virtuelle a surcharger.
const Interpreteinterprete () const
Interpreteinterprete ()
Public Member Functions inherited from Process
virtual ~Process ()

Protected Attributes

Nom nom_
ScalarRegister reg_
std::map< std::string, std::string > str_params_

Additional Inherited Members

Static Public Member Functions inherited from Objet_U
static const Nomnom_du_cas ()
 Renvoie une reference constante vers le nom du cas.
static Nomget_set_nom_du_cas ()
 Renvoie une reference non constante vers le nom du cas (pour pouvoir le modifier).
static const Type_infoinfo ()
 Donne des informations sur le type de l'Objet_U.
static const Objet_Uself_cast (const Objet_U &)
 methode ajoutee pour caster en python
static Objet_Uself_cast (Objet_U &)
Static Public Member Functions inherited from Process
static int me ()
 renvoie mon rang dans le groupe de communication courant.
static int nproc ()
 renvoie le nombre de processeurs dans le groupe courant Voir Comm_Group::nproc() et PE_Groups::current_group()
static bool is_parallel ()
static void exit (int exit_code=-1)
 Routine de sortie de TRUST dans une region Kokkos.
static double mp_sum (double)
 Calcule la somme de x sur tous les processeurs du groupe courant.
static float mp_sum (float)
static trustIdType mp_sum (trustIdType)
 Calcule la somme de x sur tous les processeurs du groupe courant.
static double mp_max (double)
static double mp_min (double)
static int mp_max (int)
 renvoie le plus grand int i sur l'ensemble des processeurs du groupe courant.
static int mp_min (int)
 renvoie le plus petit int i sur l'ensemble des processeurs du groupe courant.
static double mp_sum_as_double (int v)
static trustIdType mppartial_sum (trustIdType i)
 Calul de la somme partielle de i sur les processeurs 0 a me()-1 (renvoie 0 sur le processeur 0).
template<typename T>
static void mp_sum_for_each (T &arg1, T &arg2)
 C++14 compatible mp_sum_for_each: combine multiple mp_sum calls into one collective operation Usage: mp_sum_for_each(a, b); mp_sum_for_each(a, b, c); mp_sum_for_each(a, b, c, d); mp_sum_for_each(a, b, c, d, e); All arguments must be of the same type (double or int) and are modified in place. Supports 2-5 parameters.
template<typename T>
static void mp_sum_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void mp_sum_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void mp_sum_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename T>
static void mp_max_for_each (T &arg1, T &arg2)
 C++14 compatible mp_max_for_each: combine multiple mp_max calls into one collective operation.
template<typename T>
static void mp_max_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void mp_max_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void mp_max_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename T>
static void mp_min_for_each (T &arg1, T &arg2)
 C++14 compatible mp_min_for_each: combine multiple mp_min calls into one collective operation.
template<typename T>
static void mp_min_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void mp_min_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void mp_min_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename _TYPE_>
static void mp_sum_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
template<typename _TYPE_>
static void mp_max_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
template<typename _TYPE_>
static void mp_min_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
static bool mp_and (bool)
 Calcule le 'et' logique de b sur tous les processeurs du groupe courant.
static bool mp_or (bool)
static int check_int_overflow (trustIdType)
static int je_suis_maitre ()
 renvoie 1 si on est sur le processeur maitre du groupe courant (c'est a dire me() == 0), 0 sinon.
static KOKKOS_INLINE_FUNCTION void Kokkos_exit (const char *)
 Routine de sortie de TRUST dans une region Kokkos.
static int node_master ()
 renvoie 1 si on est sur le processeur maitre du noeud numa, 0 sinon.
static void exit (const Nom &message, int exit_code=-1)
static bool is_sequential ()
static void barrier ()
 Synchronise tous les processeurs du groupe courant (attend que tous les processeurs soient arrives a la barriere).
static void abort ()
 Routine de sortie de Trio-U sur une erreur abort().
static SortieJournal (int message_level=0)
 Renvoie un objet statique de type Sortie qui sert de journal d'evenements.
static double ram_processeur ()
static void imprimer_ram_totale (int all_process=0)
static bool force_single_file (const int ranks, const Nom &filename)
Static Public Attributes inherited from Objet_U
static double precision_geom = 1e-10
static constexpr bool HAS_POINTER = false
static int dimension =0
static int format_precision_geom =11
static int axi =0
static int bidim_axi =0
static int DEACTIVATE_SIGINT_CATCH =0
static Type_info info_obj
static bool disable_TU =false
 Flag to disable or not the writing of the .TU files.
static bool stat_per_proc_perf_log =false
 Flag to enable the writing of the statistics detailed per processor in _csv.TU file.
Static Public Attributes inherited from Process
static int exception_sur_exit =0
static int multiple_files =5120
Protected Member Functions inherited from Objet_U
 Objet_U ()
 Constructeur par defaut : attribue un numero d'identifiant unique a l'objet (object_id_), et enregistre l'objet en "memoire".
 Objet_U (const Objet_U &)
 Constructeur par copie.
const Objet_Uoperator= (const Objet_U &)
 Operateur= : ne fait rien (on conserve le numero et l'identifiant).
virtual void set_param (Param &) const

Detailed Description

classe Probleme_U

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.

Definition at line 45 of file Probleme_U.h.

Member Function Documentation

◆ abortTimeStep()

void Probleme_U::abortTimeStep ( )
virtual

Aborts the resolution of the current time step.

Exceptions
WrongContext

Reimplemented in Couplage_U, Probleme_base, and Probleme_FTD_IJK_base.

Definition at line 138 of file Probleme_U.cpp.

◆ checkOutputIntEntry()

bool Probleme_U::checkOutputIntEntry ( const Nom & name) const
virtual

Definition at line 587 of file Probleme_U.cpp.

◆ computeTimeStep()

double Probleme_U::computeTimeStep ( bool & stop) const
virtual

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.

Parameters
(stop)Does the Problem want to stop ?
Returns
(double) The desired time step
Exceptions
WrongContext

Reimplemented in Pb_rayo_semi_transp, Probleme_base, Probleme_Couple, and Probleme_FTD_IJK_base.

Definition at line 86 of file Probleme_U.cpp.

◆ futureTime()

double Probleme_U::futureTime ( ) const
virtual

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

validateTimeStep or abortTimeStep. A surcharger

Returns
(double) future time
Exceptions
WrongContext

Reimplemented in Couplage_U, and Probleme_base.

Definition at line 452 of file Probleme_U.cpp.

◆ getInputFieldsNames()

void Probleme_U::getInputFieldsNames ( Noms & noms) const
virtual

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

Parameters
(Noms)list of names where the Problem appends its input field names.

Reimplemented in Couplage_U, and Probleme_base.

Definition at line 461 of file Probleme_U.cpp.

◆ getInputFieldTemplate()

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

◆ getOutputField()

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

Definition at line 539 of file Probleme_U.cpp.

◆ getOutputFieldsNames()

virtual void Probleme_U::getOutputFieldsNames ( Noms & noms) const
virtual

Reimplemented in Couplage_U, and Probleme_base.

◆ getOutputIntValue()

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

Definition at line 582 of file Probleme_U.cpp.

◆ getOutputPointValues() [1/2]

double Probleme_U::getOutputPointValues ( const Nom & name,
const double x,
const double y,
const double z,
int compo )

Definition at line 592 of file Probleme_U.cpp.

◆ getOutputPointValues() [2/2]

virtual void Probleme_U::getOutputPointValues ( const Nom & name,
const std::vector< double > & x,
const std::vector< double > & y,
const std::vector< double > & z,
std::vector< double > & vals,
int compo )
inlinevirtual

Reimplemented in Probleme_base.

Definition at line 74 of file Probleme_U.h.

◆ getOutputStringValue()

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

Definition at line 567 of file Probleme_U.cpp.

◆ initialize()

void Probleme_U::initialize ( )
virtual

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

Exceptions
WrongContext

Reimplemented in Couplage_U, Pb_Couple_Optimisation_IBM, Pb_Couple_rayo_semi_transp, Probleme_base, Probleme_Couple, Probleme_FTD_IJK, Probleme_FTD_IJK_base, and Probleme_FTD_IJK_cut_cell.

Definition at line 49 of file Probleme_U.cpp.

◆ initTimeStep()

bool Probleme_U::initTimeStep ( double dt)
virtual

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.

Parameters
(doubledt) the time interval to allocate
Returns
(bool) true=OK, false=error, not able to tackle this dt
Exceptions
WrongContext,WrongArgument

Reimplemented in Couplage_U, Pb_Couple_Optimisation_IBM, Pb_Dilatable_base, Pb_rayo_semi_transp, Probleme_base, Probleme_Couple, and Probleme_FTD_IJK_base.

Definition at line 101 of file Probleme_U.cpp.

◆ isStationary()

bool Probleme_U::isStationary ( ) const
virtual

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

Returns
(bool) true=stationary, false=not stationary
Exceptions
WrongContext

Reimplemented in Couplage_U, and Probleme_base.

Definition at line 122 of file Probleme_U.cpp.

◆ iterateTimeStep()

bool Probleme_U::iterateTimeStep ( bool & converged)
virtual

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.

Parameters
(bool&converged) It is a return value : true if the process has converged, false otherwise.
Returns
(bool) true=OK, false=unable to converge
Exceptions
WrongContext

Reimplemented in Couplage_U, Pb_Dilatable_base, Pb_rayo_semi_transp, Probleme_base, Probleme_Couple, and Probleme_FTD_IJK_base.

Definition at line 169 of file Probleme_U.cpp.

◆ le_nom()

const Nom & Probleme_U::le_nom ( ) const
inlineoverridevirtual

Donne le nom de l'Objet_U Methode a surcharger : renvoie "neant" dans cette implementation.

Returns
(Nom&) le nom de l'Objet_U

Reimplemented from Objet_U.

Definition at line 109 of file Probleme_U.h.

◆ limpr()

int Probleme_U::limpr ( ) const
virtual

Doit-on imprimer les statistiques d'execution maintenant ?

Reimplemented in Couplage_U, and Probleme_base.

Definition at line 191 of file Probleme_U.cpp.

◆ lsauv()

int Probleme_U::lsauv ( ) const
virtual

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

Reimplemented in Couplage_U, and Probleme_base.

Definition at line 199 of file Probleme_U.cpp.

◆ newCompute()

virtual std::string Probleme_U::newCompute ( )
inlinevirtual

Reimplemented in Couplage_U, and Probleme_base.

Definition at line 60 of file Probleme_U.h.

◆ nommer()

void Probleme_U::nommer ( const Nom & )
inlineoverridevirtual

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

Parameters
(constNom&) le nom a affectuer a l'Objet_U

Reimplemented from Objet_U.

Definition at line 108 of file Probleme_U.h.

◆ OBS_PTR() [1/2]

virtual Probleme_U::OBS_PTR ( Champ_Generique_base ) const &
virtual

Reimplemented in Couplage_U, and Probleme_base.

◆ OBS_PTR() [2/2]

virtual Probleme_U::OBS_PTR ( Field_base ) const &
virtual

Reimplemented in Couplage_U, and Probleme_base.

◆ post_initialize()

virtual void Probleme_U::post_initialize ( )
inlinevirtual

Definition at line 91 of file Probleme_U.h.

◆ postraiter()

int Probleme_U::postraiter ( int force = 1)
virtual

Demande au probleme de postraiter ses champs, sondes,.

.. Dans Probleme_U::run(), postraiter() est appele a chaque pas de temps avec force=0 et au debut et a la fin du calcul avec force=1. WEC : il serait bon que, un jour, postraiter soit const

Parameters
(force)1=postraiter absolument, 0=postraiter si c'est necessaire.
Returns
(0 en cas d'erreur, 1 sinon.)

Reimplemented in Couplage_U, Pb_Fluide_base, and Probleme_base.

Definition at line 183 of file Probleme_U.cpp.

◆ presentTime()

double Probleme_U::presentTime ( ) const
virtual

Returns the present time.

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

Returns
(double) present time
Exceptions
WrongContext

Reimplemented in Couplage_U, Probleme_base, and Probleme_FTD_IJK_base.

Definition at line 71 of file Probleme_U.cpp.

◆ resetTime()

void Probleme_U::resetTime ( double time)
virtual

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.

Parameters
[in]timethe new current time.
Exceptions
ICoCo::WrongContextexception if called before initialize() or after terminate().
ICoCo::WrongContextexception if called inside the TIME_STEP_DEFINED context (see Problem documentation)

Reimplemented in Couplage_U, Probleme_base, and Probleme_FTD_IJK_base.

Definition at line 152 of file Probleme_U.cpp.

◆ run()

bool Probleme_U::run ( )
virtual

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).

Returns
(bool) true=OK, false=error

Reimplemented in Probleme_FTD_IJK_base.

Definition at line 242 of file Probleme_U.cpp.

◆ runUntil()

bool Probleme_U::runUntil ( double time)
virtual

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.

Parameters
(doubletime) time to reach
Returns
(true=OK, false=error)

Definition at line 359 of file Probleme_U.cpp.

◆ sauver()

void Probleme_U::sauver ( ) const
virtual

Sauvegarder l'etat du probleme sur disque.

Reimplemented in Couplage_U, Probleme_base, Probleme_Couple, and Probleme_FTD_IJK_base.

Definition at line 207 of file Probleme_U.cpp.

◆ setInputDoubleValue()

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

Definition at line 552 of file Probleme_U.cpp.

◆ setInputField()

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

◆ setInputIntValue()

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

Definition at line 576 of file Probleme_U.cpp.

◆ setInputStringValue()

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

Definition at line 88 of file Probleme_U.h.

◆ setStationary()

void Probleme_U::setStationary ( bool )
virtual

Tells to the Problem that stationary is reached or not.

Reimplemented in Couplage_U, Probleme_base, and Probleme_FTD_IJK_base.

Definition at line 130 of file Probleme_U.cpp.

◆ solveTimeStep()

bool Probleme_U::solveTimeStep ( )
virtual

pour recodage eventuel et appel unifie en python

Reimplemented in Pb_Couple_Optimisation_IBM, Probleme_base, Probleme_Couple, Probleme_Couple_Point_Fixe, and Probleme_FTD_IJK_base.

Definition at line 430 of file Probleme_U.cpp.

◆ terminate()

void Probleme_U::terminate ( )
virtual

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

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

Exceptions
WrongContext

Reimplemented in Couplage_U, Pb_rayo_semi_transp, Probleme_base, and Probleme_FTD_IJK_base.

Definition at line 59 of file Probleme_U.cpp.

◆ updateGivenFields()

bool Probleme_U::updateGivenFields ( )
virtual

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 !

Returns
(true=OK, false=error)

Reimplemented in Couplage_U, Probleme_base, Probleme_Couple, Probleme_FT_Disc_gen, and Probleme_FTD_IJK_base.

Definition at line 230 of file Probleme_U.cpp.

◆ validateTimeStep()

void Probleme_U::validateTimeStep ( )
virtual

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.

Exceptions
WrongContext

Reimplemented in Couplage_U, Pb_Fluide_base, Pb_rayo_semi_transp, Probleme_base, and Probleme_FTD_IJK_base.

Definition at line 113 of file Probleme_U.cpp.

Member Data Documentation

◆ nom_

Nom Probleme_U::nom_
protected

Definition at line 112 of file Probleme_U.h.

◆ reg_

ScalarRegister Probleme_U::reg_
protected

Definition at line 113 of file Probleme_U.h.

◆ str_params_

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

Definition at line 114 of file Probleme_U.h.


The documentation for this class was generated from the following files: