TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Discretisation_base Class Referenceabstract

class Discretisation_base This class represents a spatial discretization scheme, which More...

#include <Discretisation_base.h>

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

Public Types

enum  type_calcul_du_residu { VIA_CONTRIBUER_AU_SECOND_MEMBRE = 0 , VIA_AJOUTER = 1 }

Public Member Functions

virtual type_calcul_du_residu codage_du_calcul_du_residu () const
void associer_domaine (const Domaine &dom)
virtual Nom domaine_cl_dis_type () const =0
virtual void discretiser_variables () const
virtual Domaine_dis_basediscretiser () const
void discretiser_champ (const Motcle &directive, const Domaine_dis_base &z, const Nom &nom, const Nom &unite, int nb_comp, int nb_pas_dt, double temps, OWN_PTR(Champ_Inc_base)&champ, const Nom &sous_type=NOM_VIDE) const
void discretiser_champ (const Motcle &directive, const Domaine_dis_base &z, const Nom &nom, const Nom &unite, int nb_comp, double temps, OWN_PTR(Champ_Fonc_base)&champ) const
void discretiser_champ (const Motcle &directive, const Domaine_dis_base &z, const Nom &nom, const Nom &unite, int nb_comp, double temps, OWN_PTR(Champ_Don_base)&champ) const
virtual void discretiser_champ (const Motcle &directive, const Domaine_dis_base &z, Nature_du_champ nature, const Noms &nom, const Noms &unite, int nb_comp, int nb_pas_dt, double temps, OWN_PTR(Champ_Inc_base)&champ, const Nom &sous_type=NOM_VIDE) const
 Discretization of a field depending on the directive and other parameters.
virtual void discretiser_champ (const Motcle &directive, const Domaine_dis_base &z, Nature_du_champ nature, const Noms &nom, const Noms &unite, int nb_comp, double temps, OWN_PTR(Champ_Fonc_base)&champ) const
 idem
virtual void discretiser_champ (const Motcle &directive, const Domaine_dis_base &z, Nature_du_champ nature, const Noms &nom, const Noms &unite, int nb_comp, double temps, OWN_PTR(Champ_Don_base)&champ) const
 idem
void nommer_completer_champ_physique (const Domaine_dis_base &domaine_vdf, const Nom &nom_champ, const Nom &unite, Champ_base &champ, const Probleme_base &pbi) const
int verifie_sous_type (Nom &type, const Nom &sous_type, const Motcle &directive) const
void volume_maille (const Schema_Temps_base &sch, const Domaine_dis_base &z, OWN_PTR(Champ_Fonc_base)&ch) const
void mesh_numbering (const Schema_Temps_base &sch, const Domaine_dis_base &z, OWN_PTR(Champ_Fonc_base)&ch) const
virtual void residu (const Domaine_dis_base &, const Champ_Inc_base &, OWN_PTR(Champ_Fonc_base)&) const
virtual Nom get_name_of_type_for (const Nom &class_operateur, const Nom &type_operteur, const Equation_base &eqn, const OBS_PTR(Champ_base)&champ_supp=OBS_PTR(Champ_base)()) const
 Fills the Nom type depending on the class of operator, the type of operator and the equation.
virtual bool is_ef () const
virtual bool is_dg () const
virtual bool is_vdf () const
virtual bool is_vef () const
virtual bool is_PolyMAC_CDO () const
virtual bool is_PolyMAC_MPFA () const
virtual bool is_PolyMAC_HFV () const
virtual bool is_poly_family () const
virtual bool is_coloc () const
const Reorder_Meshget_reorder () const
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 lire_motcle_non_standard (const Motcle &motlu, Entree &is)
 Reads non-simple-type parameters of an Objet_U from an input stream.
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 void creer_champ (OWN_PTR(Champ_Inc_base)&ch, const Domaine_dis_base &z, const Nom &type, const Nom &nom, const Nom &unite, int nb_comp, int nb_ddl, int nb_pas_dt, double temps, const Nom &directive=NOM_VIDE, const Nom &nom_discretisation=NOM_VIDE)
 Static method that creates an OWN_PTR(Champ_Inc_base) of the specified type.
static void creer_champ (OWN_PTR(Champ_Fonc_base)&ch, const Domaine_dis_base &z, const Nom &type, const Nom &nom, const Nom &unite, int nb_comp, int nb_ddl, double temps, const Nom &directive=NOM_VIDE, const Nom &nom_discretisation=NOM_VIDE)
 Static method that creates an OWN_PTR(Champ_Fonc_base) of the specified type.
static void creer_champ (OWN_PTR(Champ_Don_base)&ch, const Domaine_dis_base &z, const Nom &type, const Nom &nom, const Nom &unite, int nb_comp, int nb_ddl, double temps, const Nom &directive=NOM_VIDE, const Nom &nom_discretisation=NOM_VIDE)
 Static method that creates an OWN_PTR(Champ_Don_base) of the specified type.
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)

Protected Member Functions

 OBS_PTR (Domaine) le_domaine_
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).
virtual void set_param (Param &) const

Protected Attributes

Reorder_Mesh reorder_
 Helper object to renumber entities (nodes, elems, faces) if requested.

Static Protected Attributes

static const Motcle DEMANDE_DESCRIPTION = Motcle("demande_description")
static const Nom NOM_VIDE = Nom("-")

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

Detailed Description

class Discretisation_base This class represents a spatial discretization scheme, which

will be associated with a problem. Discretisation_base is the
abstract class that is the basis of the hierarchy of
spatial discretizations.
See also
Probleme_base, Abstract class from which all spatial discretizations must derive., Abstract method:, void domaine_Cl_dis(Domaine_dis_base& , Domaine_Cl_dis_base& ) const

Definition at line 44 of file Discretisation_base.h.

Member Enumeration Documentation

◆ type_calcul_du_residu

Enumerator
VIA_CONTRIBUER_AU_SECOND_MEMBRE 
VIA_AJOUTER 

Definition at line 58 of file Discretisation_base.h.

Member Function Documentation

◆ associer_domaine()

void Discretisation_base::associer_domaine ( const Domaine & dom)

Definition at line 36 of file Discretisation_base.cpp.

◆ codage_du_calcul_du_residu()

virtual type_calcul_du_residu Discretisation_base::codage_du_calcul_du_residu ( ) const
inlinevirtual

◆ creer_champ() [1/3]

void Discretisation_base::creer_champ ( OWN_PTR(Champ_Don_base)& ch,
const Domaine_dis_base & z,
const Nom & type,
const Nom & nom,
const Nom & unite,
int nb_comp,
int nb_ddl,
double temps,
const Nom & directive = NOM_VIDE,
const Nom & nom_discretisation = NOM_VIDE )
static

Static method that creates an OWN_PTR(Champ_Don_base) of the specified type.

The parameters "directive" and "nom_discretisation" are used for display only and are optional

Definition at line 241 of file Discretisation_base.cpp.

◆ creer_champ() [2/3]

void Discretisation_base::creer_champ ( OWN_PTR(Champ_Fonc_base)& ch,
const Domaine_dis_base & z,
const Nom & type,
const Nom & nom,
const Nom & unite,
int nb_comp,
int nb_ddl,
double temps,
const Nom & directive = NOM_VIDE,
const Nom & nom_discretisation = NOM_VIDE )
static

Static method that creates an OWN_PTR(Champ_Fonc_base) of the specified type.

The parameters "directive" and "nom_discretisation" are used for display only and are optional

Definition at line 226 of file Discretisation_base.cpp.

◆ creer_champ() [3/3]

void Discretisation_base::creer_champ ( OWN_PTR(Champ_Inc_base)& ch,
const Domaine_dis_base & z,
const Nom & type,
const Nom & nom,
const Nom & unite,
int nb_comp,
int nb_ddl,
int nb_pas_dt,
double temps,
const Nom & directive = NOM_VIDE,
const Nom & nom_discretisation = NOM_VIDE )
static

Static method that creates an OWN_PTR(Champ_Inc_base) of the specified type.

The parameters "directive" and "nom_discretisation" are used for display only and are optional

Definition at line 210 of file Discretisation_base.cpp.

◆ discretiser()

Domaine_dis_base & Discretisation_base::discretiser ( ) const
virtual

Reimplemented in Discret_Thyd.

Definition at line 250 of file Discretisation_base.cpp.

◆ discretiser_champ() [1/6]

void Discretisation_base::discretiser_champ ( const Motcle & directive,
const Domaine_dis_base & z,
const Nom & nom,
const Nom & unite,
int nb_comp,
double temps,
OWN_PTR(Champ_Don_base)& champ ) const

Definition at line 80 of file Discretisation_base.cpp.

◆ discretiser_champ() [2/6]

void Discretisation_base::discretiser_champ ( const Motcle & directive,
const Domaine_dis_base & z,
const Nom & nom,
const Nom & unite,
int nb_comp,
double temps,
OWN_PTR(Champ_Fonc_base)& champ ) const

Definition at line 70 of file Discretisation_base.cpp.

◆ discretiser_champ() [3/6]

void Discretisation_base::discretiser_champ ( const Motcle & directive,
const Domaine_dis_base & z,
const Nom & nom,
const Nom & unite,
int nb_comp,
int nb_pas_dt,
double temps,
OWN_PTR(Champ_Inc_base)& champ,
const Nom & sous_type = NOM_VIDE ) const

Definition at line 59 of file Discretisation_base.cpp.

◆ discretiser_champ() [4/6]

void Discretisation_base::discretiser_champ ( const Motcle & directive,
const Domaine_dis_base & z,
Nature_du_champ nature,
const Noms & nom,
const Noms & unite,
int nb_comp,
double temps,
OWN_PTR(Champ_Don_base)& champ ) const
virtual

◆ discretiser_champ() [5/6]

void Discretisation_base::discretiser_champ ( const Motcle & directive,
const Domaine_dis_base & z,
Nature_du_champ nature,
const Noms & nom,
const Noms & unite,
int nb_comp,
double temps,
OWN_PTR(Champ_Fonc_base)& champ ) const
virtual

◆ discretiser_champ() [6/6]

void Discretisation_base::discretiser_champ ( const Motcle & directive,
const Domaine_dis_base & z,
Nature_du_champ nature,
const Noms & noms,
const Noms & unites,
int nb_comp,
int nb_pas_dt,
double temps,
OWN_PTR(Champ_Inc_base)& champ,
const Nom & sous_type = NOM_VIDE ) const
virtual

Discretization of a field depending on the directive and other parameters.

See derived classes. This method does not handle any directive, it displays the list of directives understood by the derived classes. See for example VDF_discretisation.cpp and VEF...

Reimplemented in Coloc_discretisation, DG_discretisation, PolyMAC_CDO_discretisation, PolyMAC_HFV_discretisation, and VEF_discretisation.

Definition at line 119 of file Discretisation_base.cpp.

◆ discretiser_variables()

void Discretisation_base::discretiser_variables ( ) const
virtual

Definition at line 167 of file Discretisation_base.cpp.

◆ domaine_cl_dis_type()

virtual Nom Discretisation_base::domaine_cl_dis_type ( ) const
pure virtual

◆ get_name_of_type_for()

Nom Discretisation_base::get_name_of_type_for ( const Nom & class_operateur,
const Nom & type_operteur,
const Equation_base & eqn,
const OBS_PTR(Champ_base)& champ_supp = OBS_PTR(Champ_base)() ) const
virtual

Fills the Nom type depending on the class of operator, the type of operator and the equation.

Parameters
(class_operateur)This name corresponds to the type of the base class of the object to be constructed. Examples: "source","Op_conv","Op_diff","Op_div","Op_grad","solveur_masse" Example: get_name_of_type_for("Op_conv","amont",eqn,type); get_name_of_type_for("Op_diff"," ",eqn,type,champ_diffusisivite);

Definition at line 341 of file Discretisation_base.cpp.

◆ get_reorder()

const Reorder_Mesh & Discretisation_base::get_reorder ( ) const
inline

Definition at line 110 of file Discretisation_base.h.

◆ is_coloc()

virtual bool Discretisation_base::is_coloc ( ) const
inlinevirtual

Reimplemented in Coloc_discretisation.

Definition at line 108 of file Discretisation_base.h.

◆ is_dg()

virtual bool Discretisation_base::is_dg ( ) const
inlinevirtual

Reimplemented in DG_discretisation.

Definition at line 101 of file Discretisation_base.h.

◆ is_ef()

virtual bool Discretisation_base::is_ef ( ) const
inlinevirtual

Reimplemented in EF_discretisation.

Definition at line 100 of file Discretisation_base.h.

◆ is_poly_family()

virtual bool Discretisation_base::is_poly_family ( ) const
inlinevirtual

Reimplemented in DG_discretisation, and PolyMAC_CDO_discretisation.

Definition at line 107 of file Discretisation_base.h.

◆ is_PolyMAC_CDO()

virtual bool Discretisation_base::is_PolyMAC_CDO ( ) const
inlinevirtual

◆ is_PolyMAC_HFV()

virtual bool Discretisation_base::is_PolyMAC_HFV ( ) const
inlinevirtual

Reimplemented in PolyMAC_HFV_discretisation, and PolyMAC_MPFA_discretisation.

Definition at line 106 of file Discretisation_base.h.

◆ is_PolyMAC_MPFA()

virtual bool Discretisation_base::is_PolyMAC_MPFA ( ) const
inlinevirtual

Reimplemented in PolyMAC_MPFA_discretisation.

Definition at line 105 of file Discretisation_base.h.

◆ is_vdf()

virtual bool Discretisation_base::is_vdf ( ) const
inlinevirtual

Reimplemented in VDF_discretisation.

Definition at line 102 of file Discretisation_base.h.

◆ is_vef()

virtual bool Discretisation_base::is_vef ( ) const
inlinevirtual

Reimplemented in VEF_discretisation.

Definition at line 103 of file Discretisation_base.h.

◆ mesh_numbering()

void Discretisation_base::mesh_numbering ( const Schema_Temps_base & sch,
const Domaine_dis_base & z,
OWN_PTR(Champ_Fonc_base)& ch ) const

Definition at line 269 of file Discretisation_base.cpp.

◆ nommer_completer_champ_physique()

void Discretisation_base::nommer_completer_champ_physique ( const Domaine_dis_base & domaine_vdf,
const Nom & nom_champ,
const Nom & unite,
Champ_base & champ,
const Probleme_base & pbi ) const

Definition at line 314 of file Discretisation_base.cpp.

◆ OBS_PTR()

Discretisation_base::OBS_PTR ( Domaine )
protected

◆ residu()

void Discretisation_base::residu ( const Domaine_dis_base & ,
const Champ_Inc_base & ,
OWN_PTR(Champ_Fonc_base)&  ) const
virtual

◆ verifie_sous_type()

int Discretisation_base::verifie_sous_type ( Nom & type,
const Nom & sous_type,
const Motcle & directive ) const

Definition at line 527 of file Discretisation_base.cpp.

◆ volume_maille()

void Discretisation_base::volume_maille ( const Schema_Temps_base & sch,
const Domaine_dis_base & z,
OWN_PTR(Champ_Fonc_base)& ch ) const

Definition at line 259 of file Discretisation_base.cpp.

Member Data Documentation

◆ DEMANDE_DESCRIPTION

const Motcle Discretisation_base::DEMANDE_DESCRIPTION = Motcle("demande_description")
staticprotected

Definition at line 113 of file Discretisation_base.h.

◆ NOM_VIDE

const Nom Discretisation_base::NOM_VIDE = Nom("-")
staticprotected

Definition at line 114 of file Discretisation_base.h.

◆ reorder_

Reorder_Mesh Discretisation_base::reorder_
protected

Helper object to renumber entities (nodes, elems, faces) if requested.

Definition at line 116 of file Discretisation_base.h.


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