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

class Champ_Generique_Morceau_Equation OWN_PTR(Champ_base) intended to post-process a quantity related to an equation piece More...

#include <Champ_Generique_Morceau_Equation.h>

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

Public Member Functions

void set_param (Param &param) const override
const Noms get_property (const Motcle &query) const override
 Returns the requested property.
Entity get_localisation (const int index=-1) const override
 Returns the type of geometric entities on which the discrete values are attached (NODE for a P1 field, FACE for a P1NC field, ELEMENT for a.
const Motcle get_directive_pour_discr () const override
 Returns the directive (champ_elem, champ_sommets, champ_face or pression) to launch the discretization of the storage space returned by get_champ().
const Champ_baseget_champ (OWN_PTR(Champ_base)&espace_stockage) const override
const Champ_baseget_champ_without_evaluation (OWN_PTR(Champ_base)&espace_stockage) const override
 OWN_PTR (Champ_Fonc_base) &creer_espace_stockage(const Nature_du_champ &nature
const int OWN_PTR (Champ_Fonc_base) &es_tmp) const override
const MorEqnmorceau () const
MorEqnmorceau ()
void completer (const Postraitement_base &post) override
void nommer_source () override
Public Member Functions inherited from Champ_Gen_de_Champs_Gen
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
std::vector< YAML_datadata_a_sauvegarder () const override
 for PDI IO: retrieve name, type and dimensions of the field to save/restore
int sauvegarder (Sortie &os) const override
 save the different sources
int reprendre (Entree &is) override
 resume the different sources
void mettre_a_jour (double temps) override
virtual const int OWN_PTR (Champ_Fonc_base) &es_tmp) const
virtual const Champ_Generique_baseget_source (int i) const
virtual Champ_Generique_baseset_source (int i)
virtual int get_nb_sources () const
int get_dimension () const override
 Returns the dimension of the space in which the field is defined.
void get_property_names (Motcles &list) const override
 Returns the list of possible "queries" for the field.
double get_time () const override
 Returns the time of the Champ_Generique_base.
const Probleme_baseget_ref_pb_base () const override
 Returns the problem that carries the target field.
const Discretisation_baseget_discretisation () const override
 Returns the discretization associated with the problem.
const DoubleTab & get_ref_values () const override
 Returns a reference to the array of discrete values if it exists in memory.
void get_copy_values (DoubleTab &) const override
 Fills the values array with the discrete values of the field (creates a copy).
void get_xyz_values (const DoubleTab &coords, DoubleTab &values, ArrOfBit &validity_flag) const override
 Computes the point value of the field at the coordinates given in coords and puts them in values.
const Domaine & get_ref_domain () const override
 Returns a ref to the domain on which the storage space will be evaluated.
void get_copy_domain (Domaine &) const override
 Creates a copy of the domain on which the storage space will be evaluated.
const Domaine_dis_baseget_ref_domaine_dis_base () const override
 Returns a ref to the discretized domain on which the storage space will be evaluated.
const Domaine_Cl_dis_baseget_ref_zcl_dis_base () const override
 Returns a ref to the discretized boundary conditions domain of the equation carrying the target field.
const DoubleTab & get_ref_coordinates () const override
 Returns a reference to the array of coordinates of the vertices of the mesh supporting the field, if it exists.
void get_copy_coordinates (DoubleTab &) const override
const IntTab & get_ref_connectivity (Entity index1, Entity index2) const override
 Returns the connectivity array between the geometric entity index1 and entity index2.
void get_copy_connectivity (Entity index1, Entity index2, IntTab &) const override
void nommer_sources (const Postraitement_base &post)
void set_parent_name (const Nom &nom)
const Nomget_parent_name () const
int get_info_type_post () const override
const Champ_Generique_baseget_champ_post (const Motcle &nom) const override
bool has_champ_post (const Motcle &nom) const override
int comprend_champ_post (const Motcle &identifiant) const override
virtual void fixer_serie (const double t1, const double t2)
virtual void fixer_tstat_deb (const double t1, const double t2)
virtual void lire_bidon (Entree &is) const
Public Member Functions inherited from Champ_Generique_base
int sauvegarder (Sortie &os) const override
 Saves an Objet_U to an output stream. Virtual method to override.
int reprendre (Entree &is) override
 Restores an Objet_U from an input stream. Virtual method to override.
int lire_motcle_non_standard (const Motcle &, Entree &) override
 Reads non-simple-type parameters of an Objet_U from an input stream.
void nommer (const Nom &nom) override
 Assigns a name to the Objet_U. Virtual method to override.
virtual const Nomget_nom_post () const
virtual int get_nb_localisations () const
virtual const Champ_baseget_champ (OWN_PTR(Champ_base) &espace_stockage) const =0
void fixer_identifiant_appel (const Nom &identifiant)
virtual const Nomsfixer_noms_compo (const Noms &noms)
virtual const Nomsfixer_noms_synonyms (const Noms &noms)
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.
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 ()

Public Attributes

const int nb_comp
Public Attributes inherited from Champ_Gen_de_Champs_Gen
virtual const int nb_comp

Protected Member Functions

 OBS_PTR (Equation_base) ref_eq_
Protected Member Functions inherited from Champ_Gen_de_Champs_Gen
 LIST (OWN_PTR(Champ_Generique_base)) sources_
 LIST (Nom) noms_sources_ref_
 LIST (OBS_PTR(Champ_Generique_base)) sources_reference_
Protected Member Functions inherited from Champ_Generique_base
 OBS_PTR (Probleme_base) ref_pb_
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).

Protected Attributes

int numero_morceau_ =-1
Nom type_morceau_
Nom option_
int compo_ =0
Motcle localisation_
Nom unite_
Protected Attributes inherited from Champ_Gen_de_Champs_Gen
Nom parent_name_
Protected Attributes inherited from Champ_Generique_base
Nom nom_post_
Nom identifiant_appel_
Nom nom_pb_

Additional Inherited Members

Static Public Member Functions inherited from Champ_Generique_base
static int composante (const Nom &nom_test, const Nom &nom, const Noms &composantes, const Noms &synonyms)
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 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
Static Protected Member Functions inherited from Champ_Generique_base
static void assert_parallel (int)

Detailed Description

class Champ_Generique_Morceau_Equation OWN_PTR(Champ_base) intended to post-process a quantity related to an equation piece

See the MorEqn hierarchy to know the available equation pieces Syntax to follow in the data file

"field_name" Morceau_Equation { type "type_moreqn" numero "numero_moreqn" option "type_option" [ compo "num_compo" ] source Champ_Post_ref_Champ { Pb_champ "pb_name" "discrete_field_name" } } "field_name" set by the user will be the name of the generic field "unite" set by the user for readability in post-processing "type_moreqn" designates the type of equation piece (currently available: "operateur") "numero_moreqn" designates the piece number ex: operator case: 0 (diffusion) 1 (convection) 2 (gradient) 3 (divergence) "type_option" chosen option ("stabilite" or "flux_bords") "num_compo" component number to post-process (to consider only for "flux_bords" if multiple components)

Definition at line 43 of file Champ_Generique_Morceau_Equation.h.

Member Function Documentation

◆ completer()

void Champ_Generique_Morceau_Equation::completer ( const Postraitement_base & post)
overridevirtual

Reimplemented from Champ_Gen_de_Champs_Gen.

Definition at line 73 of file Champ_Generique_Morceau_Equation.cpp.

◆ get_champ()

const Champ_base & Champ_Generique_Morceau_Equation::get_champ ( OWN_PTR(Champ_base)& espace_stockage) const
override

◆ get_champ_without_evaluation()

const Champ_base & Champ_Generique_Morceau_Equation::get_champ_without_evaluation ( OWN_PTR(Champ_base)& espace_stockage) const
overridevirtual

Implements Champ_Generique_base.

◆ get_directive_pour_discr()

const Motcle Champ_Generique_Morceau_Equation::get_directive_pour_discr ( ) const
overridevirtual

Returns the directive (champ_elem, champ_sommets, champ_face or pression) to launch the discretization of the storage space returned by get_champ().

Reimplemented from Champ_Gen_de_Champs_Gen.

Definition at line 351 of file Champ_Generique_Morceau_Equation.cpp.

◆ get_localisation()

Entity Champ_Generique_Morceau_Equation::get_localisation ( const int index = -1) const
overridevirtual

Returns the type of geometric entities on which the discrete values are attached (NODE for a P1 field, FACE for a P1NC field, ELEMENT for a.

P0 field, etc). It is recommended to use the get_localisation() syntax without parameter, unless you know what to do for multi-support fields.

See also
get_nb_localisations() Parameter : index Meaning : index of the requested localization (for multi-support fields). If index = -1 : if the field is multi-support an exception is raised, otherwise the support is returned. If index >= 0 : returns the i-th support. Default value : -1 Exceptions:
  • GenericFieldError::INVALID : the field is not discretized on these geometric entities (it can be an analytical field or a multi-localization field), or the field is multi-support while index = -1 was requested, or the support "index" does not exist.

Reimplemented from Champ_Gen_de_Champs_Gen.

◆ get_property()

const Noms Champ_Generique_Morceau_Equation::get_property ( const Motcle & query) const
overridevirtual

Returns the requested property.

Examples: "DISCRETISATION" : type of discrete field (P0, P1, P1NC, etc...) "ELEMENT_TYPE" : type of element with the largest dimension ({TRIANGLE}, {TETRAHEDRA}, {QUAD}, {HEXA}, etc) "DYNAMIC_MESH" : is the mesh dynamic or not ({STATIC}, {DYNAMIC}) "NAME" : name of the field "COMPONENT_NAMES" : name of the field components ({K,EPSILON} or {VITESSE_X,VITESSE_Y,VITESSE_Z}) "BOUNDARY_NAMES" : name of the boundaries "COORDINATES" : coordinate system of the nodes ({X}, {X,Y}, {X,Y,Z}, {R,THETA}, etc...) Exceptions:

  • GenericFieldError::INVALID : query not understood

Reimplemented from Champ_Gen_de_Champs_Gen.

◆ morceau() [1/2]

MorEqn & Champ_Generique_Morceau_Equation::morceau ( )

Definition at line 342 of file Champ_Generique_Morceau_Equation.cpp.

◆ morceau() [2/2]

const MorEqn & Champ_Generique_Morceau_Equation::morceau ( ) const

Definition at line 333 of file Champ_Generique_Morceau_Equation.cpp.

◆ nommer_source()

void Champ_Generique_Morceau_Equation::nommer_source ( )
overridevirtual

Reimplemented from Champ_Gen_de_Champs_Gen.

◆ OBS_PTR()

Champ_Generique_Morceau_Equation::OBS_PTR ( Equation_base )
protected

◆ OWN_PTR() [1/2]

Champ_Generique_Morceau_Equation::OWN_PTR ( Champ_Fonc_base ) const &
virtual

Reimplemented from Champ_Gen_de_Champs_Gen.

◆ OWN_PTR() [2/2]

const int Champ_Generique_Morceau_Equation::OWN_PTR ( Champ_Fonc_base ) const &
overridevirtual

Reimplemented from Champ_Gen_de_Champs_Gen.

◆ set_param()

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

Reimplemented from Champ_Gen_de_Champs_Gen.

Definition at line 52 of file Champ_Generique_Morceau_Equation.cpp.

Member Data Documentation

◆ compo_

int Champ_Generique_Morceau_Equation::compo_ =0
protected

Definition at line 71 of file Champ_Generique_Morceau_Equation.h.

◆ localisation_

Motcle Champ_Generique_Morceau_Equation::localisation_
protected

Definition at line 73 of file Champ_Generique_Morceau_Equation.h.

◆ nb_comp

const int Champ_Generique_Morceau_Equation::nb_comp

Definition at line 59 of file Champ_Generique_Morceau_Equation.h.

◆ numero_morceau_

int Champ_Generique_Morceau_Equation::numero_morceau_ =-1
protected

Definition at line 68 of file Champ_Generique_Morceau_Equation.h.

◆ option_

Nom Champ_Generique_Morceau_Equation::option_
protected

Definition at line 70 of file Champ_Generique_Morceau_Equation.h.

◆ type_morceau_

Nom Champ_Generique_Morceau_Equation::type_morceau_
protected

Definition at line 69 of file Champ_Generique_Morceau_Equation.h.

◆ unite_

Nom Champ_Generique_Morceau_Equation::unite_
protected

Definition at line 74 of file Champ_Generique_Morceau_Equation.h.


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