: Post-processing class for Eulerian fields in LML format. More...

#include <Format_Post_Lml.h>

Inheritance diagram for Format_Post_Lml:

Collaboration diagram for Format_Post_Lml:

Public Member Functions
void	reset () override
	Resets the object to the state obtained by the default constructor.
void	set_param (Param &param) const override
int	initialize_by_default (const Nom &file_basename) override
	Initializes the class with default parameters.
int	initialize (const Nom &file_basename, const int format, const Nom &option_para) override
int	ecrire_entete (const double temps_courant, const int reprise, const int est_le_premier_post) override
int	completer_post (const Domaine &dom, const int axi, const Nature_du_champ &nature, const int nb_compo, const Noms &noms_compo, const Motcle &loc_post, const Nom &le_nom_champ_post) override
int	preparer_post (const Nom &id_du_domaine, const int est_le_premier_post, const int reprise, const double t_init) override
int	finir (const int est_le_dernier_post) override
int	ecrire_domaine (const Domaine &domaine, const int est_le_premie_post) override
	see Format_Post_base::ecrire_domaine
int	ecrire_temps (const double temps) override
	Starts writing a new time step. For the LML format specifically:
int	ecrire_champ (const Domaine &domaine, const Noms &unite_, const Noms &noms_compo, int ncomp, double temps_, const Nom &id_du_champ, const Nom &id_du_domaine, const Nom &localisation, const Nom &nature, const DoubleTab &data) override
	see Format_Post_base::ecrire_champ
int	ecrire_item_int (const Nom &id_item, const Nom &id_du_domaine, const Nom &id_domaine, const Nom &localisation, const Nom &reference, const IntVect &data, const int reference_size) override
	Writing an integer array to the post-processing file.
	Format_Post_Lml ()
	Default constructor: specify in comments what is set by default.
Public Member Functions inherited from Format_Post_base
virtual void	resetTime (double t, const std::string dirname)
int	lire_motcle_non_standard (const Motcle &, Entree &) override
	Reads non-simple-type parameters of an Objet_U from an input stream.
virtual int	modify_file_basename (const Nom file_basename, bool for_restart, const double tinit)
	Modification of the post processing file name. For save/restart this might also move and rename files around to avoid overriding existing files.
virtual int	init_ecriture (double temps_courant, double temps_post, int est_le_premier_postraitement_pour_nom_fich_, const Domaine &domaine)
virtual int	finir_ecriture (double temps_courant)
virtual void	ecrire_domaine_dual (const Domaine &domaine, const int est_le_premier_post)
virtual int	ecrire_domaine_dis (const Domaine &domaine, const OBS_PTR(Domaine_dis_base)&domaine_dis_base, const int est_le_premier_post)
virtual void	set_single_lata_option (const bool)
virtual void	set_postraiter_domain ()
virtual void	set_deformable_domain ()
virtual void	set_lagrangian_domain ()
virtual void	set_discr_type (const Nom &)
virtual void	set_loc_vector (const std::vector< std::string > &)
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).
virtual const Nom &	le_nom () const
	Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.
virtual void	nommer (const Nom &)
	Assigns a name to the Objet_U. Virtual method to override.
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_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	associer_ (Objet_U &)
	Associates the Objet_U with another Objet_U. Virtual method to override.
const Interprete &	interprete () const
Interprete &	interprete ()
Public Member Functions inherited from Process
virtual	~Process ()

Static Public Member Functions
static int	ecrire_domaine_lml (const Domaine &domaine, Nom &nom_fic)
static int	ecrire_temps_lml (const double temps, Nom &nom_fic)
static int	ecrire_champ_lml (const Domaine &domaine, const Noms &unite_, const Noms &noms_compo, int ncomp, double temps_, const Nom &id_du_champ, const Nom &id_du_domaine, const Nom &localisation, const DoubleTab &data, Nom &nom_fic)
static int	ecrire_item_int_lml (const Nom &id_item, const Nom &id_domaine, const IntVect &data, const Nom &nom_fic)
static int	ecrire_entete_lml (Nom &nom_fic, const int est_le_premier_post)
static int	finir_lml (Nom &nom_fic, const int est_le_dernier_post)
static int	completer_post_lml ()
static int	preparer_post_lml ()
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)

Protected Attributes
Nom	lml_basename_

Additional Inherited Members
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 Format_Post_base
	OBS_PTR (Domaine_dis_base) domaine_dis_
	Reference to the discretized domain - used for face fields.
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).

Detailed Description

: Post-processing class for Eulerian fields in LML format.

Only works for small enough domains (domain exceeding the 32b limit can not be written in LML).

To create a valid file, the following steps are needed: (initialization) initialize("base_file_name",...); // base_file_name specifies the file name without the ".lml" extension // optionally involves information from other post-processings ecrire_entete(temps_courant,reprise,est_le_premier_post) ecrire_domaine(domaine,est_le_premier_post)

(for each dt) ecrire_temps(temps_courant) ecrire_champ(const Domaine& domaine, const Noms& unite_, const Noms& noms_compo, int ncomp,double temps_,double temps_courant const Nom & id_du_champ, const Nom & id_du_domaine, const Nom & localisation, const DoubleTab & data) [ecrire_champ(..., data)]

(finalize) finir(est_le_dernier_post)

Definition at line 44 of file Format_Post_Lml.h.

Constructor & Destructor Documentation

◆ Format_Post_Lml()

Format_Post_Lml::Format_Post_Lml ( )

Default constructor: specify in comments what is set by default.

Definition at line 35 of file Format_Post_Lml.cpp.

Member Function Documentation

◆ completer_post()

int Format_Post_Lml::completer_post	(	const Domaine &	dom,
		const int	axi,
		const Nature_du_champ &	nature,
		const int	nb_compo,
		const Noms &	noms_compo,
		const Motcle &	loc_post,
		const Nom &	le_nom_champ_post )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 117 of file Format_Post_Lml.cpp.

◆ completer_post_lml()

int Format_Post_Lml::completer_post_lml ( )

static

Definition at line 260 of file Format_Post_Lml.cpp.

◆ ecrire_champ()

int Format_Post_Lml::ecrire_champ	(	const Domaine &	domaine,
		const Noms &	unite_,
		const Noms &	noms_compo,
		int	ncomp,
		double	temps_,
		const Nom &	id_du_champ,
		const Nom &	id_du_domaine,
		const Nom &	localisation,
		const Nom &	nature,
		const DoubleTab &	data )

overridevirtual

see Format_Post_base::ecrire_champ

Reimplemented from Format_Post_base.

Definition at line 173 of file Format_Post_Lml.cpp.

◆ ecrire_champ_lml()

int Format_Post_Lml::ecrire_champ_lml	(	const Domaine &	domaine,
		const Noms &	unite_,
		const Noms &	noms_compo,
		int	ncomp,
		double	temps_,
		const Nom &	id_du_champ,
		const Nom &	id_du_domaine,
		const Nom &	localisation,
		const DoubleTab &	data,
		Nom &	nom_fic )

static

Definition at line 476 of file Format_Post_Lml.cpp.

◆ ecrire_domaine()

int Format_Post_Lml::ecrire_domaine	(	const Domaine &	domaine,
		const int	est_le_premie_post )

overridevirtual

see Format_Post_base::ecrire_domaine

Reimplemented from Format_Post_base.

Definition at line 140 of file Format_Post_Lml.cpp.

◆ ecrire_domaine_lml()

int Format_Post_Lml::ecrire_domaine_lml	(	const Domaine &	domaine,
		Nom &	nom_fic )

static

Definition at line 270 of file Format_Post_Lml.cpp.

◆ ecrire_entete()

int Format_Post_Lml::ecrire_entete	(	const double	temps_courant,
		const int	reprise,
		const int	est_le_premier_post )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 91 of file Format_Post_Lml.cpp.

◆ ecrire_entete_lml()

int Format_Post_Lml::ecrire_entete_lml	(	Nom &	nom_fic,
		const int	est_le_premier_post )

static

Definition at line 218 of file Format_Post_Lml.cpp.

◆ ecrire_item_int()

int Format_Post_Lml::ecrire_item_int	(	const Nom &	id_item,
		const Nom &	id_du_domaine,
		const Nom &	id_domaine,
		const Nom &	localisation,
		const Nom &	reference,
		const IntVect &	data,
		const int	reference_size )

overridevirtual

Writing an integer array to the post-processing file.

See also: ecrire_champ

Parameters

(reference)	Name of another array already written. data[i] is an index into that array (e.g., the FACES_VOISINS array can be written with localisation=FACES, reference=ELEMENTS because the array is indexed by face number and contains element indices). Writing a domain automatically creates a SOMMETS array and an ELEMENTS array.
(reference_size)	the (local) size of the referenced array (dimension(0) of the array). This dimension is used to renumber the contents of the data array to create a global numbering when all processors write to a single file.

Reimplemented from Format_Post_base.

Definition at line 197 of file Format_Post_Lml.cpp.

◆ ecrire_item_int_lml()

int Format_Post_Lml::ecrire_item_int_lml	(	const Nom &	id_item,
		const Nom &	id_domaine,
		const IntVect &	data,
		const Nom &	nom_fic )

static

Definition at line 611 of file Format_Post_Lml.cpp.

◆ ecrire_temps()

int Format_Post_Lml::ecrire_temps ( const double temps )

overridevirtual

Starts writing a new time step. For the LML format specifically:

Opens the master file in APPEND mode and adds a line "TEMPS xxxxx"

Reimplemented from Format_Post_base.

Definition at line 157 of file Format_Post_Lml.cpp.

◆ ecrire_temps_lml()

int Format_Post_Lml::ecrire_temps_lml	(	const double	temps,
		Nom &	nom_fic )

static

Definition at line 463 of file Format_Post_Lml.cpp.

◆ finir()

int Format_Post_Lml::finir ( const int est_le_dernier_post )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 104 of file Format_Post_Lml.cpp.

◆ finir_lml()

int Format_Post_Lml::finir_lml	(	Nom &	nom_fic,
		const int	est_le_dernier_post )

static

Definition at line 240 of file Format_Post_Lml.cpp.

◆ initialize()

int Format_Post_Lml::initialize	(	const Nom &	file_basename,
		const int	format,
		const Nom &	option_para )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 84 of file Format_Post_Lml.cpp.

◆ initialize_by_default()

int Format_Post_Lml::initialize_by_default ( const Nom & file_basename )

overridevirtual

Initializes the class with default parameters.

Reimplemented from Format_Post_base.

Definition at line 78 of file Format_Post_Lml.cpp.

◆ preparer_post()

int Format_Post_Lml::preparer_post	(	const Nom &	id_du_domaine,
		const int	est_le_premier_post,
		const int	reprise,
		const double	t_init )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 127 of file Format_Post_Lml.cpp.

◆ preparer_post_lml()

int Format_Post_Lml::preparer_post_lml ( )

static

Definition at line 265 of file Format_Post_Lml.cpp.

◆ reset()

void Format_Post_Lml::reset ( )

overridevirtual

Resets the object to the state obtained by the default constructor.

Implements Format_Post_base.

Definition at line 43 of file Format_Post_Lml.cpp.

◆ set_param()

void Format_Post_Lml::set_param ( Param & param ) const

overridevirtual

Implements Format_Post_base.

Definition at line 70 of file Format_Post_Lml.cpp.

Member Data Documentation

◆ lml_basename_

Nom Format_Post_Lml::lml_basename_

protected

Definition at line 85 of file Format_Post_Lml.h.

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

/home/docs/trust-code/src/Kernel/Postraitement/Misc/Format_Post_Lml.h
/home/docs/trust-code/src/Kernel/Postraitement/Misc/Format_Post_Lml.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Format_Post_Lml()

Member Function Documentation

◆ completer_post()

◆ completer_post_lml()

◆ ecrire_champ()

◆ ecrire_champ_lml()

◆ ecrire_domaine()

◆ ecrire_domaine_lml()

◆ ecrire_entete()

◆ ecrire_entete_lml()

◆ ecrire_item_int()

◆ ecrire_item_int_lml()

◆ ecrire_temps()

◆ ecrire_temps_lml()

◆ finir()

◆ finir_lml()

◆ initialize()

◆ initialize_by_default()

◆ preparer_post()

◆ preparer_post_lml()

◆ reset()

◆ set_param()

Member Data Documentation

◆ lml_basename_