Pb_MED Class Reference

class Pb_MED Class for re-reading MED files and post-processing them. More...

#include <Pb_MED.h>

Inheritance diagram for Pb_MED:

Collaboration diagram for Pb_MED:

Public Member Functions
int	nombre_d_equations () const override
	Returns the number of equations in the problem.
const Equation_base &	equation (int) const override
	Returns the MED-type equation if i = 0,.
Equation_base &	equation (int) override
	Returns the MED-type equation if i = 0,.
int	comprend_champ (const Motcle &) const
const ArrOfDouble &	temps_sauv () const
Champs_Fonc &	get_champs_fonc_post ()
void	creer_champ (const Motcle &motlu) override
const Champ_base &	get_champ (const Motcle &nom) const override
void	get_noms_champs_postraitables (Noms &nom, Option opt=NONE) const override
bool	has_champ (const Motcle &nom, OBS_PTR(Champ_base) &ref_champ) const override
bool	has_champ (const Motcle &nom) const override
void	typer_lire_milieu (Entree &is) override
Public Member Functions inherited from Probleme_base
	~Probleme_base ()
virtual void	associer ()
	Associates the problem with all its equations.
virtual Entree &	lire_equations (Entree &is, Motcle &dernier_mot)
	Reading of the equations of the problem.
virtual void	completer ()
	Completes the equations associated with the problem.
virtual int	verifier ()
	Verifies that the object is complete, coherent, .
const Equation_base &	equation (const Nom &) const
	Returns the equation whose name is specified (const version).
Equation_base &	equation (const Nom &)
	Returns the equation whose name is specified.
int	sauvegarder (Sortie &) const override
	Writing of the problem to file for restart.
int	reprendre (Entree &) override
	Reading of an input stream (file) for restart after a backup with Probleme_base::sauvegarder(Sortie& os).
int	is_sauvegarde_simple () const
const Nom &	restart_filename () const
const Nom &	checkpoint_filename () const
const Nom &	checkpoint_format () const
const Nom &	yaml_filename () const
virtual const Equation_base &	get_equation_by_name (const Nom &) const
	(B. Math): Virtual method added for problems having several equations of the same type (Probleme_FT_Disc_gen). In that case, the name of the equation is not its type...
virtual Equation_base &	getset_equation_by_name (const Nom &)
	(B. Math): Virtual method added for problems having several equations of the same type (Probleme_FT_Disc_gen). In that case, the name of the equation is not its type... Non-const version. This method is notably called when reading the problem.
virtual const Milieu_base &	milieu () const
	Returns the physical medium associated with the problem (const version).
virtual Milieu_base &	milieu ()
	Returns the physical medium associated with the problem.
virtual double	calculer_pas_de_temps () const
	Computes the value of the next time step for the problem.
virtual void	mettre_a_jour (double temps)
	Performs a time update of the problem.
virtual void	preparer_calcul ()
	Prepares the computation: initializes the medium parameters and prepares the computation of each equation.
virtual void	imprimer (Sortie &os) const
	Prints the equations associated with the problem if the associated time scheme indicates that it is necessary.
int	associer_ (Objet_U &) override
	override Objet_U::associer_(Objet_U& ob) Associates different objects with the problem by checking
virtual void	associer_sch_tps_base (const Schema_Temps_base &)
	Associates a time scheme with the problem.
virtual void	associer_domaine (const Domaine &)
	Associates a domain with the problem.
virtual void	associer_milieu_base (const Milieu_base &)
	Associates a physical medium with the problem equations.
virtual void	discretiser (Discretisation_base &)
	Assigns a discretization to the problem Discretizes the Domain associated with the problem with the discretization.
virtual void	discretiser_equations ()
virtual void	finir ()
	Finalizes post-processing and saves the problem to a file.
std::vector< OWN_PTR(Milieu_base)> &	milieu_vect ()
const std::vector< OWN_PTR(Milieu_base)> &	milieu_vect () const
const Schema_Temps_base &	schema_temps () const
	Returns the time scheme associated with the problem.
Schema_Temps_base &	schema_temps ()
	Returns the time scheme associated with the problem.
const Domaine &	domaine () const
	Returns the domain associated with the problem.
Domaine &	domaine ()
	Returns the domain associated with the problem.
bool	has_domaine_dis () const
const Domaine_dis_base &	domaine_dis () const
	Returns the discretized domain associated with the problem (const version).
Domaine_dis_base &	domaine_dis ()
	Returns the discretized domain associated with the problem.
bool	is_dilatable () const
const Discretisation_base &	discretisation () const
	Returns the discretization associated with the problem.
Postraitements &	postraitements ()
const Postraitements &	postraitements () const
void	init_postraitements ()
	Flags the first and last post-processing for each file And initializes the post-processing.
virtual int	expression_predefini (const Motcle &motlu, Nom &expression)
const char *	reprise_format_temps () const
bool &	reprise_effectuee ()
bool	reprise_effectuee () const
void	creer_champ (const Motcle &motlu) override
const Champ_base &	get_champ (const Motcle &nom) const override
void	get_noms_champs_postraitables (Noms &nom, Option opt=NONE) const override
bool	has_champ (const Motcle &nom, OBS_PTR(Champ_base) &ref_champ) const override
bool	has_champ (const Motcle &nom) const override
virtual const Champ_Generique_base &	get_champ_post (const Motcle &nom) const
virtual bool	has_champ_post (const Motcle &nom) const
virtual int	comprend_champ_post (const Motcle &nom) const
virtual int	a_pour_IntVect (const Motcle &, OBS_PTR(IntVect)&) const
virtual void	lire_postraitement_interfaces (Entree &is)
virtual void	postraiter_interfaces (const Nom &nom_fich, Sortie &s, const Nom &format, double temps)
virtual void	addInputField (Field_base &f)
bool	is_coupled () const
virtual bool	has_mod_rayo_transp () const
int	postraiter (int force=1) override
	If force=1, performs post-processing regardless of the post-processing frequencies.
int	limpr () const override
	Asks the time scheme if a print is needed.
int	lsauv () const override
	Asks the time scheme if a backup is needed.
void	sauver () const override
	Writes to file for restart (backup).
virtual void	allocation () const final
	Verifies that the necessary disk space exists.
void	initialize () override
	This method is called once at the beginning, before any other one of the interface Problem.
const bool &	is_probleme_base_initialized () const
void	terminate () override
	This method is called once at the end, after any other one.
double	presentTime () const override
	Returns the present time.
double	computeTimeStep (bool &stop) const override
	Compute the value the Problem would like for the next time step.
bool	initTimeStep (double dt) override
	This method allocates and initializes the unknown and given fields for the future time step.
bool	solveTimeStep () override
	For possible re-implementation and unified call from python.
bool	solveTimeStep_pbU ()
bool	isStationary () const override
	Tells if the Problem unknowns have changed during the last time step.
std::string	newCompute () override
	Searches for parametric fields and for each, moves to the next parameter.
void	validateTimeStep () override
	Validates the calculated unknown by moving the present time at the end of the time step.
void	setStationary (bool flag) override
	Tells to the Problem that stationary is reached or not.
void	abortTimeStep () override
	Aborts the resolution of the current time step.
void	resetTime (double time) override
	Reset the current time of the Problem to a given value.
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) override
bool	iterateTimeStep (bool &converged) override
	In the case solveTimeStep uses an iterative process, this method executes a single iteration.
void	getInputFieldsNames (Noms &noms) const override
	This method is used to find the names of input fields understood by the Problem.
void	getOutputFieldsNames (Noms &noms) const override
bool	updateGivenFields () override
	WARNING:
double	futureTime () const override
	Returns the future time (end of current computing interval) This value is valid between initTimeStep and either.
	OBS_PTR (Field_base) findInputField(const Nom &name) const override
	OBS_PTR (Champ_Generique_base) findOutputField(const Nom &name) const override
void	associer_pb_couple (const Probleme_Couple &pbc)
const Probleme_Couple &	get_pb_couple () const
Probleme_Couple &	get_pb_couple ()
	LIST (OBS_PTR(SFichier)) &get_set_out_files() const
const Correlation_base &	get_correlation (std::string nom_correlation) const
int	has_correlation (std::string nom_correlation) const
Public Member Functions inherited from Champs_compris_interface
virtual	~Champs_compris_interface ()
virtual bool	has_champ (const Motcle &nom, OBS_PTR(Champ_base)&ref_champ) const =0
Public Member Functions inherited from Probleme_U
virtual void	getInputFieldTemplate (const Nom &name, ICoCo::TrioField &afield) const
virtual void	setInputField (const Nom &name, const ICoCo::TrioField &afield)
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
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 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.
void	nommer (const Nom &name) override
	Assigns a name to the Objet_U. Virtual method to override.
const Nom &	le_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 Sortie &	printOn (Sortie &) const
	Writes the object to an output stream. Virtual method to override.
virtual Entree &	readOn (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).
int	get_object_id () const
	Returns the unique identifier of the object (object_id_).
virtual const Type_info *	get_info () const
	Returns type information for the Objet_U.
const Nom &	que_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.
const Interprete &	interprete () const
Interprete &	interprete ()
Public Member Functions inherited from Process
virtual	~Process ()
Public Member Functions inherited from Probleme_base_interface_proto
bool	initTimeStep_impl (Probleme_base &pb, double dt)
bool	solveTimeStep_impl (Probleme_base &pb)
bool	isStationary_impl (const Probleme_base &pb) const
bool	iterateTimeStep_impl (Probleme_base &pb, bool &converged)
bool	updateGivenFields_impl (Probleme_base &pb)
const bool &	is_probleme_initialized_impl () const
void	initialize_impl (Probleme_base &pb)
void	terminate_impl (Probleme_base &pb)
void	validateTimeStep_impl (Probleme_base &pb)
void	abortTimeStep_impl (Probleme_base &pb)
void	getInputFieldsNames_impl (const Probleme_base &pb, Noms &noms) const
void	getOutputFieldsNames_impl (const Probleme_base &pb, Noms &noms) const
void	addInputField_impl (Probleme_base &pb, Field_base &f)
double	presentTime_impl (const Probleme_base &pb) const
double	computeTimeStep_impl (const Probleme_base &pb, bool &stop) const
double	futureTime_impl (const Probleme_base &pb) const
void	resetTimeWithDir_impl (Probleme_base &pb, double time, std::string direname)
	OBS_PTR (Field_base) findInputField_impl(const Probleme_base &pb
	OBS_PTR (Champ_Generique_base) findOutputField_impl(const Probleme_base &pb

Protected Attributes
Champs_Fonc	champs_fonc_post
Protected Attributes inherited from Probleme_base
Save_Restart	save_restart_
std::vector< OWN_PTR(Milieu_base)>	le_milieu_
Postraitements	les_postraitements_
std::map< std::string, OWN_PTR(Correlation_base)>	correlations_
Protected Attributes inherited from Probleme_U
Nom	nom_
ScalarRegister	reg_
std::map< std::string, std::string >	str_params_
Protected Attributes inherited from Probleme_base_interface_proto
bool	initialized = false
bool	terminated = false
bool	dt_defined = false
bool	dt_validated = false

Additional Inherited Members
Static Public Member Functions inherited from Objet_U
static const Nom &	nom_du_cas ()
	Returns a constant reference to the case name. This method is static.
static Nom &	get_set_nom_du_cas ()
	Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_info *	info ()
	Returns type information for the Objet_U (static version).
static const Objet_U &	self_cast (const Objet_U &)
	Method added for casting in Python.
static Objet_U &	self_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 Sortie &	Journal (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)
Public Attributes inherited from Probleme_base_interface_proto
const Nom &name	const
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 Probleme_base
virtual void	lire_solved_equations (Entree &is)
Entree &	read_optional_equations (Entree &is, Motcle &mot)
virtual Entree &	lire_correlations (Entree &is)
virtual Entree &	lire_radiation_models (Entree &is, Motcle &mot)
	OBS_PTR (Domaine_dis_base) le_domaine_dis_
	OBS_PTR (Domaine) le_domaine_
	OBS_PTR (Schema_Temps_base) le_schema_en_temps_
	OBS_PTR (Discretisation_base) la_discretisation_
	OBS_PTR (Probleme_Couple) pbc_
	LIST (OBS_PTR(SFichier)) out_files_
	LIST (OBS_PTR(Loi_Fermeture_base)) liste_loi_fermeture_
	LIST (OBS_PTR(Champ_Parametrique)) Champs_Parametriques_
	LIST (OWN_PTR(Equation_base)) eq_opt_
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_U &	operator= (const Objet_U &)
	Assignment operator: does nothing (the number and identifier are preserved).
virtual void	set_param (Param &) const
Protected Member Functions inherited from Probleme_base_interface_proto
	LIST (OBS_PTR(Field_base)) input_fields

Detailed Description

class Pb_MED Class for re-reading MED files and post-processing them.

Definition at line 27 of file Pb_MED.h.

Member Function Documentation

comprend_champ()

int Pb_MED::comprend_champ

(

const Motcle &

mot

)

const

Definition at line 205 of file Pb_MED.cpp.

creer_champ()

void Pb_MED::creer_champ ( const Motcle & motlu )

overridevirtual

Implements Champs_compris_interface.

Definition at line 228 of file Pb_MED.cpp.

equation() [1/2]

const Equation_base & Pb_MED::equation ( int i ) const

overridevirtual

Returns the MED-type equation if i = 0,.

Otherwise triggers an error since the problem has only a single equation. (const version)

Parameters

(int	i) the index of the equation to return

Returns

(Equation_base&) the MED-type equation

Implements Probleme_base.

Definition at line 179 of file Pb_MED.cpp.

equation() [2/2]

Equation_base & Pb_MED::equation ( int i )

overridevirtual

Returns the MED-type equation if i = 0,.

Otherwise triggers an error since the problem has only a single equation.

Parameters

(int	i) the index of the equation to return

Returns

(Equation_base&) the MED-type equation

Implements Probleme_base.

Definition at line 197 of file Pb_MED.cpp.

get_champ()

const Champ_base & Pb_MED::get_champ ( const Motcle & nom ) const

overridevirtual

Implements Champs_compris_interface.

Definition at line 325 of file Pb_MED.cpp.

get_champs_fonc_post()

Champs_Fonc & Pb_MED::get_champs_fonc_post ( )

inline

Definition at line 39 of file Pb_MED.h.

get_noms_champs_postraitables()

void Pb_MED::get_noms_champs_postraitables ( Noms & nom, Option opt = NONE ) const

overridevirtual

Implements Champs_compris_interface.

Definition at line 359 of file Pb_MED.cpp.

has_champ() [1/2]

bool Pb_MED::has_champ ( const Motcle & nom ) const

overridevirtual

Implements Champs_compris_interface.

Definition at line 310 of file Pb_MED.cpp.

has_champ() [2/2]

bool Pb_MED::has_champ ( const Motcle & nom, OBS_PTR(Champ_base) & ref_champ ) const

override

Definition at line 289 of file Pb_MED.cpp.

nombre_d_equations()

int Pb_MED::nombre_d_equations ( ) const

overridevirtual

Returns the number of equations in the problem.

Always equal to 1 for a standard conduction problem.

Returns

(int) the number of equations in the problem

Implements Probleme_base.

Definition at line 165 of file Pb_MED.cpp.

temps_sauv()

const ArrOfDouble & Pb_MED::temps_sauv ( ) const

inline

Definition at line 38 of file Pb_MED.h.

typer_lire_milieu()

void Pb_MED::typer_lire_milieu ( Entree & is )

inlineoverridevirtual

Reimplemented from Probleme_base.

Definition at line 50 of file Pb_MED.h.

Member Data Documentation

champs_fonc_post

Champs_Fonc Pb_MED::champs_fonc_post

protected

Definition at line 53 of file Pb_MED.h.

---

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

• /home/docs/trust-code/src/Kernel/MEDimpl/Pb_MED.h
• /home/docs/trust-code/src/Kernel/MEDimpl/Pb_MED.cpp