TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Probleme_U Class Reference

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 ()
 For possible re-implementation and unified call from 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)
 Asks the problem to post-process its fields, probes, etc.
virtual int limpr () const
 Should we print the execution statistics now?
virtual int lsauv () const
 Should we save the problem state to disk now?
virtual void sauver () const
 Save the problem state to disk.
virtual bool updateGivenFields ()
 WARNING:
virtual double futureTime () const
 Returns the future time (end of current computing interval) This value is valid between initTimeStep and either.
virtual bool run ()
 This method is a sort of main() for the Problem. It can be used if the problem is not coupled with any other.
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
 Assigns a name to the Objet_U. Virtual method to override.
const Nomle_nom () const override
 Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.
Public Member Functions inherited from Objet_U
 ~Objet_U () override
 Destructor. Removes the object from the list of objects registered in "memory".
int numero () const
 Returns the index of the object in Memoire::data.
virtual int duplique () const =0
virtual SortieprintOn (Sortie &) const
 Writes the object to an output stream. Virtual method to override.
virtual EntreereadOn (Entree &)
 Reads an Objet_U from an input stream. Virtual method to override.
virtual unsigned taille_memoire () const =0
virtual int est_egal_a (const Objet_U &) const
 Returns 1 if x and *this are the same instance (same memory address).
virtual int reprendre (Entree &)
 Restores an Objet_U from an input stream. Virtual method to override.
virtual int sauvegarder (Sortie &) const
 Saves an Objet_U to an output stream. Virtual method to override.
int get_object_id () const
 Returns the unique identifier of the object (object_id_).
virtual const Type_infoget_info () const
 Returns type information for the Objet_U.
const Nomque_suis_je () const
 Returns the string identifying the class.
const char * le_type () const
 Returns the type name of the Objet_U.
virtual int change_num (const int *const)
 Changes the internal number of the Objet_U.
virtual int lire_motcle_non_standard (const Motcle &motlu, Entree &is)
 Reads non-simple-type parameters of an Objet_U from an input stream.
virtual int associer_ (Objet_U &)
 Associates the Objet_U with another Objet_U. Virtual method to override.
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 ()
 Returns a constant reference to the case name. This method is static.
static Nomget_set_nom_du_cas ()
 Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_infoinfo ()
 Returns type information for the Objet_U (static version).
static const Objet_Uself_cast (const Objet_U &)
 Method added for casting in Python.
static Objet_Uself_cast (Objet_U &)
Static Public Member Functions inherited from Process
static int me ()
 Returns the rank of the local processor in the current communication group. See Comm_Group::rank() and PE_Groups::current_group().
static int nproc ()
 Returns the number of processors in the current group. See Comm_Group::nproc() and PE_Groups::current_group().
static bool is_parallel ()
static void exit (int exit_code=-1)
 Exit routine for TRUST within a Kokkos region.
static double mp_sum (double)
 Computes the sum of x over all processors in the current group.
static float mp_sum (float)
static trustIdType mp_sum (trustIdType)
 Computes the sum of x over all processors in the current group.
static double mp_max (double)
static double mp_min (double)
static int mp_max (int)
 Returns the maximum value of x across all processors in the current group.
static int mp_min (int)
 Returns the minimum value of x across all processors in the current group.
static double mp_sum_as_double (int v)
static trustIdType mppartial_sum (trustIdType i)
 Computes the partial sum of x over processors 0 to me()-1 (returns 0 on processor 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)
 Computes the logical AND of b across all processors in the current group.
static bool mp_or (bool)
static int check_int_overflow (trustIdType)
static int je_suis_maitre ()
 Returns 1 if on the master processor of the current group (i.e. me() == 0), 0 otherwise.
static KOKKOS_INLINE_FUNCTION void Kokkos_exit (const char *)
 Exit routine for TRUST within a Kokkos region.
static int node_master ()
 Returns 1 if on the NUMA node master processor, 0 otherwise.
static void exit (const Nom &message, int exit_code=-1)
static bool is_sequential ()
static void barrier ()
 Synchronizes all processors in the current group (waits until all processors have reached the barrier).
static void abort ()
 Abort routine for TRUST on a fatal error.
static SortieJournal (int message_level=0)
 Returns a static Sortie object used as an event journal.
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 ()
 Default constructor: assigns a unique identifier to the object (object_id_) and registers the object in "memory" by giving it a num_obj number.
 Objet_U (const Objet_U &)
 Copy constructor.
const Objet_Uoperator= (const Objet_U &)
 Assignment operator: does nothing (the number and identifier are preserved).
virtual void set_param (Param &) const

Detailed Description

Probleme_U.

This class adds TRUST-specific features to the general
interface defined in the Problem class.

Derived from Probleme_U:
* Probleme_base for all individual problems
* Couplage_U for couplings of several Probleme_U objects

All these classes must satisfy the Problem API
extended by the Probleme_U API.

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 585 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 450 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 459 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 537 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 580 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 590 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 565 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

Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.

Returns
The name of the Objet_U.

Reimplemented from Objet_U.

Definition at line 109 of file Probleme_U.h.

◆ limpr()

int Probleme_U::limpr ( ) const
virtual

Should we print the execution statistics now?

Reimplemented in Couplage_U, and Probleme_base.

Definition at line 191 of file Probleme_U.cpp.

◆ lsauv()

int Probleme_U::lsauv ( ) const
virtual

Should we save the problem state to disk now?

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 & nom)
inlineoverridevirtual

Assigns a name to the Objet_U. Virtual method to override.

Parameters
nomThe name to assign to the 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

Asks the problem to post-process its fields, probes, etc.

In Probleme_U::run(), postraiter() is called at each time step with force=0 and at the beginning and end of the computation with force=1. WEC: it would be good if, one day, postraiter were const.

Parameters
(force)1=post-process unconditionally, 0=post-process if necessary.
Returns
(0 on error, 1 otherwise.)

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

This method is a sort of main() for the Problem. It can be used if the problem is not coupled with any other.

(if it does not need any input field).

Returns
(bool) true=OK, false=error

Reimplemented in Probleme_FTD_IJK_base.

Definition at line 240 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 357 of file Probleme_U.cpp.

◆ sauver()

void Probleme_U::sauver ( ) const
virtual

Save the problem state to disk.

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 550 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 574 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

For possible re-implementation and unified call from python.

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

Definition at line 428 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

WARNING:

Everything that does not fit the normal Problem API goes here.

Currently it updates boundary conditions and source terms, knowing that some of them fetch information from neighboring problems themselves...

Work plan: everything in this method must be made independent of external state, and can then be merged into initTimeStep. The rest moves into the field exchange interface. This work will be done when updateGivenFields is empty and removed!

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 228 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: