#include <Format_Post_CGNS.h>

Inheritance diagram for Format_Post_CGNS:

Collaboration diagram for Format_Post_CGNS:

Public Member Functions
	Format_Post_CGNS ()
void	reset () override
void	set_param (Param &param) const override
void	set_postraiter_domain () override
void	set_deformable_domain () override
void	set_lagrangian_domain () override
void	set_discr_type (const Nom &) override
void	set_loc_vector (const std::vector< std::string > &) override
void	resetTime (double t, const std::string dirname) override
int	initialize_by_default (const Nom &) override
	Initializes the file with parameters appropriate to its format (e.g. ascii format, deletes the existing file, a.
int	initialize (const Nom &, const int, const Nom &) override
int	completer_post (const Domaine &, const int, const Nature_du_champ &, const int, const Noms &, const Motcle &, const Nom &) override
int	preparer_post (const Nom &, const int, const int, const double) override
int	ecrire_entete (const double, const int, const int) override
int	ecrire_temps (const double) override
	Starts writing a time step.
int	finir (const int) override
int	finir_ecriture (double) override
void	ecrire_domaine_dual (const Domaine &, const int) override
int	ecrire_domaine_dis (const Domaine &, const OBS_PTR(Domaine_dis_base)&, const int) override
int	ecrire_domaine (const Domaine &, const int) override
	Writing a mesh.
int	ecrire_domaine_low_level (const Domaine *, const Nom &, const DoubleTab &, const IntTab &, const Motcle &)
int	ecrire_item_int (const Nom &, const Nom &, const Nom &, const Nom &, const Nom &, const IntVect &, const int) override
	Writing an integer array to the post-processing file.
int	ecrire_champ (const Domaine &, const Noms &, const Noms &, int, double, const Nom &, const Nom &, const Nom &, const Nom &, const DoubleTab &) override
	Writing a field to the post-processing file.
Public Member Functions inherited from Format_Post_base
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 void	set_single_lata_option (const bool)
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 ()

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

class Format_Post_CGNS

The CFD General Notation System (CGNS) provides a general, portable, and extensible standard for the storage and retrieval of computational fluid dynamics (CFD) analysis data. It consists of a collection of conventions, and free and open software implementing those conventions. It is self-descriptive, machine-independent, well-documented, and administered by an international steering committee.

It is also an American Institute of Aeronautics and Astronautics (AIAA) Recommended Practice. The system consists of two parts: (1) a standard data model and mapping format for recording the data, and (2) software that reads, writes, and modifies data in that format. The format is a conceptual entity established by the documentation; the software is a physical product supplied to enable developers to access and produce data recorded in that format.

The CGNS system is designed to facilitate the exchange of data between sites and applications, and to help stabilize the archiving of aerodynamic data. The data are stored in a compact, binary format and are accessible through a complete and extensible library of functions. The API (Application Program Interface) is platform independent and can be easily implemented in C, C++, Fortran and Fortran90 applications.

CGNS is self-describing, allowing an application to interpret the structure and contents of a file without any outside information. CGNS can make use of either two different low-level data formats:

an internally developed and supported method called Advanced Data Format (ADF), based on a common file format system previously in use at McDonnell Douglas,

- HDF5, a widely used hierarchical data format

see : https://cgns.github.io/cgns-modern.github.io/index.html https://en.wikipedia.org/wiki/CGNS

Definition at line 55 of file Format_Post_CGNS.h.

Constructor & Destructor Documentation

◆ Format_Post_CGNS()

Format_Post_CGNS::Format_Post_CGNS ( )

Definition at line 47 of file Format_Post_CGNS.cpp.

Member Function Documentation

◆ completer_post()

int Format_Post_CGNS::completer_post	(	const Domaine &	,
		const int	,
		const Nature_du_champ &	,
		const int	,
		const Noms &	,
		const Motcle &	,
		const Nom &	)

inlineoverridevirtual

Reimplemented from Format_Post_base.

Definition at line 72 of file Format_Post_CGNS.h.

◆ ecrire_champ()

int Format_Post_CGNS::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

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 from Format_Post_base.

Definition at line 223 of file Format_Post_CGNS.cpp.

◆ ecrire_domaine()

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

overridevirtual

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 from Format_Post_base.

Definition at line 212 of file Format_Post_CGNS.cpp.

◆ ecrire_domaine_dis()

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

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 200 of file Format_Post_CGNS.cpp.

◆ ecrire_domaine_dual()

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

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 185 of file Format_Post_CGNS.cpp.

◆ ecrire_domaine_low_level()

int Format_Post_CGNS::ecrire_domaine_low_level	(	const Domaine *	dom,
		const Nom &	nom_dom,
		const DoubleTab &	som,
		const IntTab &	elem,
		const Motcle &	type_e )

Definition at line 192 of file Format_Post_CGNS.cpp.

◆ ecrire_entete()

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

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 110 of file Format_Post_CGNS.cpp.

◆ ecrire_item_int()

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

inlineoverridevirtual

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 84 of file Format_Post_CGNS.h.

◆ ecrire_temps()

int Format_Post_CGNS::ecrire_temps ( const double temps )

overridevirtual

Starts writing a time step.

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

Reimplemented from Format_Post_base.

Definition at line 158 of file Format_Post_CGNS.cpp.

◆ finir()

int Format_Post_CGNS::finir ( const int est_le_dernier_post )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 174 of file Format_Post_CGNS.cpp.

◆ finir_ecriture()

int Format_Post_CGNS::finir_ecriture ( double temps_courant )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 166 of file Format_Post_CGNS.cpp.

◆ initialize()

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

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 99 of file Format_Post_CGNS.cpp.

◆ initialize_by_default()

int Format_Post_CGNS::initialize_by_default ( const Nom & file_basename )

overridevirtual

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 from Format_Post_base.

Definition at line 88 of file Format_Post_CGNS.cpp.

◆ preparer_post()

int Format_Post_CGNS::preparer_post	(	const Nom &	,
		const int	,
		const int	,
		const double	)

inlineoverridevirtual

Reimplemented from Format_Post_base.

Definition at line 73 of file Format_Post_CGNS.h.

◆ reset()

void Format_Post_CGNS::reset ( )

overridevirtual

Implements Format_Post_base.

Definition at line 52 of file Format_Post_CGNS.cpp.

◆ resetTime()

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

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 78 of file Format_Post_CGNS.cpp.

◆ set_deformable_domain()

void Format_Post_CGNS::set_deformable_domain ( )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 137 of file Format_Post_CGNS.cpp.

◆ set_discr_type()

void Format_Post_CGNS::set_discr_type ( const Nom & type )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 123 of file Format_Post_CGNS.cpp.

◆ set_lagrangian_domain()

void Format_Post_CGNS::set_lagrangian_domain ( )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 144 of file Format_Post_CGNS.cpp.

◆ set_loc_vector()

void Format_Post_CGNS::set_loc_vector ( const std::vector< std::string > & vec )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 151 of file Format_Post_CGNS.cpp.

◆ set_param()

void Format_Post_CGNS::set_param ( Param & param ) const

overridevirtual

Implements Format_Post_base.

Definition at line 71 of file Format_Post_CGNS.cpp.

◆ set_postraiter_domain()

void Format_Post_CGNS::set_postraiter_domain ( )

overridevirtual

Reimplemented from Format_Post_base.

Definition at line 130 of file Format_Post_CGNS.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Format_Post_CGNS()

Member Function Documentation

◆ completer_post()

◆ ecrire_champ()

◆ ecrire_domaine()

◆ ecrire_domaine_dis()

◆ ecrire_domaine_dual()

◆ ecrire_domaine_low_level()

◆ ecrire_entete()

◆ ecrire_item_int()

◆ ecrire_temps()

◆ finir()

◆ finir_ecriture()

◆ initialize()

◆ initialize_by_default()

◆ preparer_post()

◆ reset()

◆ resetTime()

◆ set_deformable_domain()

◆ set_discr_type()

◆ set_lagrangian_domain()

◆ set_loc_vector()

◆ set_param()

◆ set_postraiter_domain()