Base class for post-processing output formats for fields (lata, med, cgns, lml, single_lata). More...

#include <Format_Post_base.h>

Inheritance diagram for Format_Post_base:

Collaboration diagram for Format_Post_base:

Public Member Functions
virtual void	reset ()=0
virtual void	resetTime (double t, const std::string dirname)
virtual void	set_param (Param &param) const override=0
int	lire_motcle_non_standard (const Motcle &, Entree &) override
	Reads non-simple-type parameters of an Objet_U from an input stream.
virtual int	initialize_by_default (const Nom &file_basename)
	Initializes the file with parameters appropriate to its format (e.g. ascii format, deletes the existing file, a.
virtual int	initialize (const Nom &file_basename, const int format, const Nom &option_para)
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	ecrire_entete (const double temps_courant, const int reprise, const int est_le_premier_post)
virtual 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)
virtual int	preparer_post (const Nom &id_du_domaine, const int est_le_premier_post, const int reprise, const double t_init)
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 int	finir (const int est_le_dernier_post)
virtual int	ecrire_domaine (const Domaine &domaine, const int est_le_premier_post)
	Writing a mesh.
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 int	ecrire_temps (const double temps)
	Starts writing a time step.
virtual 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)
	Writing a field to the post-processing file.
virtual 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)
	Writing an integer array to the post-processing file.
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 ()

Protected Member Functions
	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).

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

Detailed Description

Base class for post-processing output formats for fields (lata, med, cgns, lml, single_lata).

Using the class through the generic interface:

type a post-processing format object
initialize the post-processing format object
perform completion and verification operations
write a domain
ecrire_temps
ecrire_champ (supported field types: at elements or at nodes, or at faces if the domain faces have been written and if faces are supported by the post-processing format)

Definition at line 100 of file Format_Post_base.h.

Member Function Documentation

◆ completer_post()

int Format_Post_base::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 )

virtual

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 109 of file Format_Post_base.cpp.

◆ ecrire_champ()

int Format_Post_base::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 )

virtual

Writing a field to the post-processing file.

Parameters

(id_du_champ)	field identifier (allows identifying a unique field when combined with a time step number)
(id_du_domaine)	identifier of the domain on which the field is defined. This domain must have been written before by "ecrire_domaine".
(localisation)	location of field values (SOMMETS, ELEMENTS, or any other id of an already written array) (not everything is necessarily supported by all post-processing formats)
(data)	array of values to post-process. The number of rows must equal the number of rows of the "localisation" array (number of vertices, elements, faces, etc.). Return value: 1 if the operation succeeded, 0 otherwise (e.g., preconditions not met or feature not supported by the format).

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 185 of file Format_Post_base.cpp.

◆ ecrire_domaine()

int Format_Post_base::ecrire_domaine	(	const Domaine &	domaine,
		const int	est_le_premier_post )

virtual

Writing a mesh.

The domain is written either at the beginning, before the first call to ecrire_temps, or later (dynamic mesh), but this is not necessarily supported by all post-processing formats.

Parameters

(id_domaine)	the name assigned to the domain in the lata file.
(type_elem)	the type of geometric element (a type supported by the derived class; in general at least "TETRAEDRE", "HEXAEDRE", "TRIANGLE" and "RECTANGLE" are understood)
(dimension)	the dimension of the domain (number of vertex coordinates). A 3D domain may contain triangle elements (post-processing of an interface or of the boundary of a volumetric domain).
(sommets)	Vertex coordinates. If non-empty, dimension(1) must equal dimension.
(elements)	Indices of vertices for each element. dimension(1) must match the element type (3 for a triangle, 4 for a rectangle or tetrahedron, etc.)

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 145 of file Format_Post_base.cpp.

◆ ecrire_domaine_dis()

int Format_Post_base::ecrire_domaine_dis	(	const Domaine &	domaine,
		const OBS_PTR(Domaine_dis_base)&	domaine_dis_base,
		const int	est_le_premier_post )

virtual

Reimplemented in Format_Post_CGNS, and Format_Post_Med.

Definition at line 158 of file Format_Post_base.cpp.

◆ ecrire_domaine_dual()

void Format_Post_base::ecrire_domaine_dual	(	const Domaine &	domaine,
		const int	est_le_premier_post )

virtual

Reimplemented in Format_Post_CGNS, and Format_Post_Med.

Definition at line 152 of file Format_Post_base.cpp.

◆ ecrire_entete()

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

virtual

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 84 of file Format_Post_base.cpp.

◆ ecrire_item_int()

int Format_Post_base::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 )

virtual

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 in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 205 of file Format_Post_base.cpp.

◆ ecrire_temps()

int Format_Post_base::ecrire_temps ( const double temps )

virtual

Starts writing a time step.

The derived class must accept receiving multiple consecutive calls to this method with the same time.

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 170 of file Format_Post_base.cpp.

◆ finir()

int Format_Post_base::finir ( const int est_le_dernier_post )

virtual

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 90 of file Format_Post_base.cpp.

◆ finir_ecriture()

int Format_Post_base::finir_ecriture ( double temps_courant )

virtual

Reimplemented in Format_Post_CGNS.

Definition at line 102 of file Format_Post_base.cpp.

◆ init_ecriture()

int Format_Post_base::init_ecriture	(	double	temps_courant,
		double	temps_post,
		int	est_le_premier_postraitement_pour_nom_fich_,
		const Domaine &	domaine )

virtual

Definition at line 96 of file Format_Post_base.cpp.

◆ initialize()

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

virtual

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 69 of file Format_Post_base.cpp.

◆ initialize_by_default()

int Format_Post_base::initialize_by_default ( const Nom & file_basename )

virtual

Initializes the file with parameters appropriate to its format (e.g. ascii format, deletes the existing file, a.

single file for all processors, etc.) Method to override in derived classes. Return value: 1 if the operation succeeded, 0 otherwise.

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 62 of file Format_Post_base.cpp.

◆ lire_motcle_non_standard()

int Format_Post_base::lire_motcle_non_standard	(	const Motcle &	motlu,
		Entree &	is )

overridevirtual

Reads non-simple-type parameters of an Objet_U from an input stream.

Parameters

motlu	The name of the keyword to read.
is	An input stream.

Returns: Negative value if the keyword is not understood, otherwise positive value.

Reimplemented from Objet_U.

Reimplemented in Format_Post_Lata.

Definition at line 50 of file Format_Post_base.cpp.

◆ modify_file_basename()

int Format_Post_base::modify_file_basename	(	const Nom	file_basename,
		bool	for_restart,
		const double	tinit )

virtual

Modification of the post processing file name. For save/restart this might also move and rename files around to avoid overriding existing files.

Reimplemented in Format_Post_Lata.

Definition at line 79 of file Format_Post_base.cpp.

◆ OBS_PTR()

Format_Post_base::OBS_PTR ( Domaine_dis_base )

protected

Reference to the discretized domain - used for face fields.

◆ preparer_post()

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

virtual

Reimplemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

Definition at line 120 of file Format_Post_base.cpp.

◆ reset()

virtual void Format_Post_base::reset ( )

pure virtual

Implemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

◆ resetTime()

void Format_Post_base::resetTime	(	double	t,
		const std::string	dirname )

virtual

Reimplemented in Format_Post_CGNS, and Format_Post_Lata.

Definition at line 40 of file Format_Post_base.cpp.

◆ set_deformable_domain()

virtual void Format_Post_base::set_deformable_domain ( )

inlinevirtual

Reimplemented in Format_Post_CGNS.

Definition at line 134 of file Format_Post_base.h.

◆ set_discr_type()

virtual void Format_Post_base::set_discr_type ( const Nom & )

inlinevirtual

Reimplemented in Format_Post_CGNS.

Definition at line 136 of file Format_Post_base.h.

◆ set_lagrangian_domain()

virtual void Format_Post_base::set_lagrangian_domain ( )

inlinevirtual

Reimplemented in Format_Post_CGNS.

Definition at line 135 of file Format_Post_base.h.

◆ set_loc_vector()

virtual void Format_Post_base::set_loc_vector ( const std::vector< std::string > & )

inlinevirtual

Reimplemented in Format_Post_CGNS.

Definition at line 137 of file Format_Post_base.h.

◆ set_param()

virtual void Format_Post_base::set_param ( Param & param ) const

overridepure virtual

Reimplemented from Objet_U.

Implemented in Format_Post_CGNS, Format_Post_Lata, Format_Post_Lml, and Format_Post_Med.

◆ set_postraiter_domain()

virtual void Format_Post_base::set_postraiter_domain ( )

inlinevirtual

Reimplemented in Format_Post_CGNS.

Definition at line 133 of file Format_Post_base.h.

◆ set_single_lata_option()

virtual void Format_Post_base::set_single_lata_option ( const bool )

inlinevirtual

Reimplemented in Format_Post_Lata.

Definition at line 132 of file Format_Post_base.h.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ completer_post()

◆ ecrire_champ()

◆ ecrire_domaine()

◆ ecrire_domaine_dis()

◆ ecrire_domaine_dual()

◆ ecrire_entete()

◆ ecrire_item_int()

◆ ecrire_temps()

◆ finir()

◆ finir_ecriture()

◆ init_ecriture()

◆ initialize()

◆ initialize_by_default()

◆ lire_motcle_non_standard()

◆ modify_file_basename()

◆ OBS_PTR()

◆ preparer_post()

◆ reset()

◆ resetTime()

◆ set_deformable_domain()

◆ set_discr_type()

◆ set_lagrangian_domain()

◆ set_loc_vector()

◆ set_param()

◆ set_postraiter_domain()

◆ set_single_lata_option()