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

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

#include <Format_Post_Lata.h>

Inheritance diagram for Format_Post_Lata:
[legend]
Collaboration diagram for Format_Post_Lata:
[legend]

Public Types

enum  Format { ASCII , BINAIRE }
enum  Options_Para { SINGLE_FILE , SINGLE_FILE_MPIIO , MULTIPLE_FILES }
enum  Status { RESET , INITIALIZED , WRITING_TIME }

Public Member Functions

void set_param (Param &param) const override
int lire_motcle_non_standard (const Motcle &, Entree &) override
 Reads non-simple-type parameters of an Objet_U from an input stream.
void reset () override
 Resets the object to the state obtained by the default constructor.
void resetTime (double t, const std::string dirname) 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 initialize_by_default (const Nom &file_basename) override
 Initializes the class with default parameters (ASCII format, SINGLE_FILE).
int initialize (const Nom &file_basename, const int format, const Nom &option_para) override
int modify_file_basename (const Nom file_basename, bool for_restart, const double tinit) override
 Modifying name of the post file, plus some clever management of previously saved data in case of restart.
int ecrire_entete (const double temps_courant, const int reprise, const int est_le_premier_post) override
 Opens the master file in ERASE mode and writes the lata file header (on the master processor only).
int ecrire_domaine (const Domaine &domaine, const int est_le_premier_post) override
 See Format_Post_base::ecrire_domaine. Writing a domain within a time step is accepted, but.
int ecrire_temps (const double temps) override
 Starts writing a new time step. For the LATA 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
 voir 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.
int finir (const int est_le_dernier_post) override
virtual int reconstruct (const Nom file_basename, const Nom, const double tinit)
virtual int finir_sans_reprise (const Nom file_basename)
void ecrire_domaine_low_level (const Nom &id_dom, const DoubleTab &sommets, const IntTab &elements, const Motcle &type_elem)
 Low level routine to write a mesh into a LATA file.
int ecrire_item_tid (const Nom &id_item, const Nom &id_du_domaine, const Nom &id_domaine, const Nom &localisation, const Nom &reference, const TIDVect &data, const int reference_size)
 Format_Post_Lata ()
 Default constructor: format_ ASCII and options_para_ = SINGLE_FILE.
virtual int initialize_lata (const Nom &file_basename, const Format format=ASCII, const Options_Para options_para=SINGLE_FILE)
 Initializes the class, opens the file and writes the header.
void set_single_lata_option (const bool sing_lata) override
Public Member Functions inherited from Format_Post_base
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_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 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 const Nomle_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_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 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 ()

Static Public Member Functions

static int ecrire_entete_lata (const Nom &base_name, const Options_Para &option, const Format &format, const int est_le_premier_post)
static int ecrire_temps_lata (const double temps, double &temps_format, const Nom &base_name, Status &stat, const Options_Para &option)
static const char * extension_lata ()
 Returns the conventional extension for lata files: ".lata".
static const char * remove_path (const char *filename)
 Returns the file name without its path: strips all characters before the last /.
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 Protected Member Functions

static trustIdType write_doubletab (Fichier_Lata &fichier, const DoubleTab &tab, int &nb_colonnes, const Options_Para &option)
 fichier is a lata data file (not the master file). The array tab is written as-is (in binary or ASCII, on one or
static trustIdType write_inttab (Fichier_Lata &fichier, bool decal_fort, trustIdType decalage_partiel, const IntTab &tab, int &nb_colonnes, const Options_Para &option)
 Writing an integer array to the given file.

Protected Attributes

Nom lata_basename_
Format format_
Options_Para options_para_
Status status
bool restart_already_moved_
double temps_courant_
double tinit_
bool un_seul_fichier_lata_ = false
long int offset_elem_ = -1
long int offset_som_ = -1

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_Uoperator= (const Objet_U &)
 Assignment operator: does nothing (the number and identifier are preserved).

Detailed Description

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

Definition at line 52 of file Format_Post_Lata.h.

Member Enumeration Documentation

◆ Format

Enumerator
ASCII 
BINAIRE 

Definition at line 100 of file Format_Post_Lata.h.

◆ Options_Para

Enumerator
SINGLE_FILE 
SINGLE_FILE_MPIIO 
MULTIPLE_FILES 

Definition at line 101 of file Format_Post_Lata.h.

◆ Status

Enumerator
RESET 
INITIALIZED 
WRITING_TIME 

Definition at line 102 of file Format_Post_Lata.h.

Constructor & Destructor Documentation

◆ Format_Post_Lata()

Format_Post_Lata::Format_Post_Lata ( )

Default constructor: format_ ASCII and options_para_ = SINGLE_FILE.

Definition at line 33 of file Format_Post_Lata.cpp.

Member Function Documentation

◆ completer_post()

int Format_Post_Lata::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 124 of file Format_Post_Lata.cpp.

◆ ecrire_champ()

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

voir Format_Post_base::ecrire_champ

Reimplemented from Format_Post_base.

Definition at line 696 of file Format_Post_Lata.cpp.

◆ ecrire_domaine()

int Format_Post_Lata::ecrire_domaine ( const Domaine & domaine,
const int est_le_premier_post )
overridevirtual

See Format_Post_base::ecrire_domaine. Writing a domain within a time step is accepted, but.

all id_domaines must be distinct. Writes the file "basename(_XXXXX).lata.nom_domaine", which contains the vertex list and element list. If the PE is master, opens the master file in APPEND mode and adds a reference to this file.

Reimplemented from Format_Post_base.

Definition at line 662 of file Format_Post_Lata.cpp.

◆ ecrire_domaine_low_level()

void Format_Post_Lata::ecrire_domaine_low_level ( const Nom & id_domaine,
const DoubleTab & sommets,
const IntTab & elements,
const Motcle & type_element )

Low level routine to write a mesh into a LATA file.

Also called directly in TrioCFD, by Postraitement_ft_lata for interface writing.

Definition at line 497 of file Format_Post_Lata.cpp.

◆ ecrire_entete()

int Format_Post_Lata::ecrire_entete ( const double temps_courant,
const int reprise,
const int est_le_premier_post )
overridevirtual

Opens the master file in ERASE mode and writes the lata file header (on the master processor only).

void Format_Post_Lata::ecrire_entete_lata()

Reimplemented from Format_Post_base.

Definition at line 118 of file Format_Post_Lata.cpp.

◆ ecrire_entete_lata()

int Format_Post_Lata::ecrire_entete_lata ( const Nom & base_name,
const Options_Para & option,
const Format & format,
const int est_le_premier_post )
static

Definition at line 919 of file Format_Post_Lata.cpp.

◆ ecrire_item_int()

int Format_Post_Lata::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 907 of file Format_Post_Lata.cpp.

◆ ecrire_item_tid()

int Format_Post_Lata::ecrire_item_tid ( const Nom & id_item,
const Nom & id_du_domaine,
const Nom & id_domaine,
const Nom & localisation,
const Nom & reference,
const TIDVect & data,
const int reference_size )

Definition at line 913 of file Format_Post_Lata.cpp.

◆ ecrire_temps()

int Format_Post_Lata::ecrire_temps ( const double temps)
overridevirtual

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

Opens the master file in APPEND mode and adds a line "TEMPS xxxxx" if this time has not yet been written.

Reimplemented from Format_Post_base.

Definition at line 687 of file Format_Post_Lata.cpp.

◆ ecrire_temps_lata()

int Format_Post_Lata::ecrire_temps_lata ( const double temps,
double & temps_format,
const Nom & base_name,
Status & stat,
const Options_Para & option )
static

Definition at line 977 of file Format_Post_Lata.cpp.

◆ extension_lata()

const char * Format_Post_Lata::extension_lata ( )
static

Returns the conventional extension for lata files: ".lata".

Definition at line 96 of file Format_Post_Lata.cpp.

◆ finir()

int Format_Post_Lata::finir ( const int est_le_dernier_post)
overridevirtual

Reimplemented from Format_Post_base.

Definition at line 994 of file Format_Post_Lata.cpp.

◆ finir_sans_reprise()

int Format_Post_Lata::finir_sans_reprise ( const Nom file_basename)
virtual

Definition at line 430 of file Format_Post_Lata.cpp.

◆ initialize()

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

Reimplemented from Format_Post_base.

Definition at line 286 of file Format_Post_Lata.cpp.

◆ initialize_by_default()

int Format_Post_Lata::initialize_by_default ( const Nom & file_basename)
overridevirtual

Initializes the class with default parameters (ASCII format, SINGLE_FILE).

Reimplemented from Format_Post_base.

Definition at line 279 of file Format_Post_Lata.cpp.

◆ initialize_lata()

int Format_Post_Lata::initialize_lata ( const Nom & file_basename,
const Format format = ASCII,
const Options_Para options_para = SINGLE_FILE )
virtual

Initializes the class, opens the file and writes the header.

Definition at line 314 of file Format_Post_Lata.cpp.

◆ lire_motcle_non_standard()

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

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

Parameters
motluThe name of the keyword to read.
isAn input stream.
Returns
Negative value if the keyword is not understood, otherwise positive value.

Reimplemented from Format_Post_base.

Definition at line 86 of file Format_Post_Lata.cpp.

◆ modify_file_basename()

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

Modifying name of the post file, plus some clever management of previously saved data in case of restart.

Reimplemented from Format_Post_base.

Definition at line 326 of file Format_Post_Lata.cpp.

◆ preparer_post()

int Format_Post_Lata::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 129 of file Format_Post_Lata.cpp.

◆ reconstruct()

int Format_Post_Lata::reconstruct ( const Nom file_basename,
const Nom before_restart,
const double tinit )
virtual

Definition at line 390 of file Format_Post_Lata.cpp.

◆ remove_path()

const char * Format_Post_Lata::remove_path ( const char * filename)
static

Returns the file name without its path: strips all characters before the last /.

Definition at line 105 of file Format_Post_Lata.cpp.

◆ reset()

void Format_Post_Lata::reset ( )
overridevirtual

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

Implements Format_Post_base.

Definition at line 41 of file Format_Post_Lata.cpp.

◆ resetTime()

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

Reimplemented from Format_Post_base.

Definition at line 52 of file Format_Post_Lata.cpp.

◆ set_param()

void Format_Post_Lata::set_param ( Param & param) const
overridevirtual

Implements Format_Post_base.

Definition at line 80 of file Format_Post_Lata.cpp.

◆ set_single_lata_option()

void Format_Post_Lata::set_single_lata_option ( const bool sing_lata)
inlineoverridevirtual

Reimplemented from Format_Post_base.

Definition at line 110 of file Format_Post_Lata.h.

◆ write_doubletab()

trustIdType Format_Post_Lata::write_doubletab ( Fichier_Lata & fichier,
const DoubleTab & tab,
int & nb_colonnes,
const Options_Para & option )
staticprotected

fichier is a lata data file (not the master file). The array tab is written as-is (in binary or ASCII, on one or

several files in parallel). nb_colonnes is filled with the product of tab.dimension(i) for i>0.

Definition at line 257 of file Format_Post_Lata.cpp.

◆ write_inttab()

trustIdType Format_Post_Lata::write_inttab ( Fichier_Lata & fichier,
bool decal_fort,
trustIdType decalage_partiel,
const IntTab & tab,
int & nb_colonnes,
const Options_Para & option )
staticprotected

Writing an integer array to the given file.

The values written are the array values incremented by "decalage". This value is used to switch to Fortran numbering (add 1), or to switch to global numbering (add the number of elements on previous processors).

nb_colonnes is filled with the sum of dimension(i) for i>0. Return value: sum of the written dimension(0) values (depending on whether all processors write to the same file or not).

Definition at line 271 of file Format_Post_Lata.cpp.

Member Data Documentation

◆ format_

Format Format_Post_Lata::format_
protected

Definition at line 120 of file Format_Post_Lata.h.

◆ lata_basename_

Nom Format_Post_Lata::lata_basename_
protected

Definition at line 119 of file Format_Post_Lata.h.

◆ offset_elem_

long int Format_Post_Lata::offset_elem_ = -1
protected

Definition at line 129 of file Format_Post_Lata.h.

◆ offset_som_

long int Format_Post_Lata::offset_som_ = -1
protected

Definition at line 129 of file Format_Post_Lata.h.

◆ options_para_

Options_Para Format_Post_Lata::options_para_
protected

Definition at line 121 of file Format_Post_Lata.h.

◆ restart_already_moved_

bool Format_Post_Lata::restart_already_moved_
protected

Definition at line 124 of file Format_Post_Lata.h.

◆ status

Status Format_Post_Lata::status
protected

Definition at line 122 of file Format_Post_Lata.h.

◆ temps_courant_

double Format_Post_Lata::temps_courant_
protected

Definition at line 126 of file Format_Post_Lata.h.

◆ tinit_

double Format_Post_Lata::tinit_
protected

Definition at line 127 of file Format_Post_Lata.h.

◆ un_seul_fichier_lata_

bool Format_Post_Lata::un_seul_fichier_lata_ = false
protected

Definition at line 128 of file Format_Post_Lata.h.


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