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

Base class for the turbulence model hierarchy for Navier-Stokes equations. More...

#include <Modele_turbulence_hyd_base.h>

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

Public Member Functions

const Champ_Fonc_baseviscosite_turbulente () const
Champ_Fonc_baseviscosite_turbulente ()
Equation_baseequation ()
 Returns the equation associated with the turbulence model.
const Equation_baseequation () const
const Turbulence_paroi_baseloi_paroi () const
Turbulence_paroi_baseloi_paroi ()
bool utiliser_loi_paroi () const
bool has_loi_paroi_hyd () const
virtual bool calcul_tenseur_Re (const DoubleTab &nu_turb, const DoubleTab &grad, DoubleTab &Re) const
virtual 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.
virtual int preparer_calcul ()
 Prepares the computation.
virtual bool initTimeStep (double dt)
virtual void mettre_a_jour (double)=0
virtual void discretiser ()
 Discretizes the turbulence model.
void discretiser_visc_turb (const Schema_Temps_base &, Domaine_dis_base &, OWN_PTR(Champ_Fonc_base)&) const
void discretiser_corr_visc_turb (const Schema_Temps_base &, Domaine_dis_base &, OWN_PTR(Champ_Fonc_base)&) const
void discretiser_K (const Schema_Temps_base &, Domaine_dis_base &, OWN_PTR(Champ_Fonc_base)&) const
virtual void completer ()
void associer_eqn (const Equation_base &)
 Associates the equation passed as parameter to the turbulence model.
virtual void associer (const Domaine_dis_base &, const Domaine_Cl_dis_base &)
int reprendre (Entree &) override
 Restores the wall law from a checkpoint.
void creer_champ (const Motcle &motlu) override
const Champ_baseget_champ (const Motcle &nom) const override
void get_noms_champs_postraitables (Noms &nom, Option opt=NONE) const override
bool has_champ (const Motcle &nom, OBS_PTR(Champ_base) &ref_champ) const override
bool has_champ (const Motcle &nom) const override
Champs_compris & champs_compris ()
virtual void imprimer (Sortie &) const
 Performs printing if necessary.
void a_faire (Sortie &) const
 Writes an identity record to the output stream if required.
int sauvegarder (Sortie &) const override
 Saves the turbulence model to an output stream.
virtual std::vector< YAML_datadata_a_sauvegarder () const
 for PDI IO: retrieve name, type and dimensions of the fields to save/restore
int limpr_ustar (double, double, double, double) const
double get_Cmu () const
void lire_distance_paroi ()
 Reads the domain Wall_length.xyz file to populate the wall_length field for distance_paroi post-processing.
void limiter_viscosite_turbulente ()
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.
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 Member Functions inherited from Support_Champ_Masse_Volumique
 Support_Champ_Masse_Volumique ()
 Constructor of the class.
virtual ~Support_Champ_Masse_Volumique ()
 Virtual destructor (to avoid warnings).
virtual void associer_champ_masse_volumique (const Champ_base &)
 Method to be called during problem preparation to ask the object to take into account the density field passed as parameter.
virtual void dissocier_champ_masse_volumique ()
 Cancels the reference to the density field.
virtual int has_champ_masse_volumique () const
 Returns 1 if the density field has been associated, 0 otherwise.
virtual const Champ_baseget_champ_masse_volumique () const
 Returns the density field.
const int & support_ok () const
Public Member Functions inherited from Champs_compris_interface
virtual ~Champs_compris_interface ()
virtual bool has_champ (const Motcle &nom, OBS_PTR(Champ_base)&ref_champ) const =0

Protected Member Functions

 OWN_PTR (Champ_Fonc_base) la_viscosite_turbulente_
 OBS_PTR (Equation_base) mon_equation_
 OWN_PTR (Turbulence_paroi_base) loipar_
 LIST (Nom) boundaries_list_
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 Member Functions inherited from Support_Champ_Masse_Volumique
virtual void declare_support_masse_volumique (int ok)
 The constructor of a derived class that uses the density field must call this function with the value 1.

Protected Attributes

double LeCmu_ = CMU
 wall_length_
double dt_impr_ustar_ = 1.e20
double dt_impr_ustar_mean_only_ = 1.e20
int boundaries_ = 0
Nom nom_fichier_ = ""
Champs_compris champs_compris_

Additional Inherited Members

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

Detailed Description

Base class for the turbulence model hierarchy for Navier-Stokes equations.

Two derived classes already exist representing the (k,e) turbulence model and the subgrid-scale turbulence model. Both models share the computation of a turbulent viscosity.

B.Mat.: the class inherits from Support_Champ_Masse_Volumique. In Front-Tracking (and later in QC), it provides the mechanism to retrieve rho.

Definition at line 38 of file Modele_turbulence_hyd_base.h.

Member Function Documentation

◆ a_faire()

void Modele_turbulence_hyd_base::a_faire ( Sortie & os) const

Writes an identity record to the output stream if required.

Definition at line 452 of file Modele_turbulence_hyd_base.cpp.

◆ associer()

virtual void Modele_turbulence_hyd_base::associer ( const Domaine_dis_base & ,
const Domaine_Cl_dis_base &  )
inlinevirtual

◆ associer_eqn()

void Modele_turbulence_hyd_base::associer_eqn ( const Equation_base & eqn)

Associates the equation passed as parameter to the turbulence model.

Parameters
eqnThe equation to associate with this object.

Definition at line 190 of file Modele_turbulence_hyd_base.cpp.

◆ calcul_tenseur_Re()

virtual bool Modele_turbulence_hyd_base::calcul_tenseur_Re ( const DoubleTab & nu_turb,
const DoubleTab & grad,
DoubleTab & Re ) const
inlinevirtual

Reimplemented in Modele_turbulence_hyd_RANS_K_Eps_base.

Definition at line 50 of file Modele_turbulence_hyd_base.h.

◆ champs_compris()

Champs_compris & Modele_turbulence_hyd_base::champs_compris ( )
inline

Definition at line 70 of file Modele_turbulence_hyd_base.h.

◆ completer()

◆ creer_champ()

void Modele_turbulence_hyd_base::creer_champ ( const Motcle & motlu)
overridevirtual

Implements Champs_compris_interface.

Definition at line 306 of file Modele_turbulence_hyd_base.cpp.

◆ data_a_sauvegarder()

std::vector< YAML_data > Modele_turbulence_hyd_base::data_a_sauvegarder ( ) const
virtual

for PDI IO: retrieve name, type and dimensions of the fields to save/restore

Reimplemented in Modele_turbulence_hyd_RANS_Bicephale_base, Modele_turbulence_hyd_RANS_K_Eps_base, and Modele_turbulence_hyd_RANS_K_Omega_base.

Definition at line 401 of file Modele_turbulence_hyd_base.cpp.

◆ discretiser()

◆ discretiser_corr_visc_turb()

void Modele_turbulence_hyd_base::discretiser_corr_visc_turb ( const Schema_Temps_base & sch,
Domaine_dis_base & z,
OWN_PTR(Champ_Fonc_base)& ch ) const

Definition at line 250 of file Modele_turbulence_hyd_base.cpp.

◆ discretiser_K()

void Modele_turbulence_hyd_base::discretiser_K ( const Schema_Temps_base & sch,
Domaine_dis_base & z,
OWN_PTR(Champ_Fonc_base)& ch ) const

Definition at line 257 of file Modele_turbulence_hyd_base.cpp.

◆ discretiser_visc_turb()

void Modele_turbulence_hyd_base::discretiser_visc_turb ( const Schema_Temps_base & sch,
Domaine_dis_base & z,
OWN_PTR(Champ_Fonc_base)& ch ) const

Definition at line 237 of file Modele_turbulence_hyd_base.cpp.

◆ equation() [1/2]

Equation_base & Modele_turbulence_hyd_base::equation ( )
inline

Returns the equation associated with the turbulence model.

Returns the equation associated with the turbulence model (of type Equation_base).

Returns
(Equation_base&) the equation associated with the turbulence model

Definition at line 106 of file Modele_turbulence_hyd_base.h.

◆ equation() [2/2]

const Equation_base & Modele_turbulence_hyd_base::equation ( ) const
inline

Definition at line 116 of file Modele_turbulence_hyd_base.h.

◆ get_champ()

◆ get_Cmu()

double Modele_turbulence_hyd_base::get_Cmu ( ) const
inline

Definition at line 78 of file Modele_turbulence_hyd_base.h.

◆ get_noms_champs_postraitables()

◆ has_champ() [1/2]

◆ has_champ() [2/2]

bool Modele_turbulence_hyd_base::has_champ ( const Motcle & nom,
OBS_PTR(Champ_base) & ref_champ ) const
override

◆ has_loi_paroi_hyd()

bool Modele_turbulence_hyd_base::has_loi_paroi_hyd ( ) const
inline

Definition at line 49 of file Modele_turbulence_hyd_base.h.

◆ imprimer()

void Modele_turbulence_hyd_base::imprimer ( Sortie & os) const
virtual

Performs printing if necessary.

Parameters
osOutput stream.

Reimplemented in Modele_turbulence_hyd_0_eq_base, Modele_turbulence_hyd_combinaison, Modele_turbulence_hyd_K_Eps_Bas_Reynolds, and Modele_turbulence_hyd_LES_base.

Definition at line 367 of file Modele_turbulence_hyd_base.cpp.

◆ initTimeStep()

◆ limiter_viscosite_turbulente()

void Modele_turbulence_hyd_base::limiter_viscosite_turbulente ( )

Definition at line 469 of file Modele_turbulence_hyd_base.cpp.

◆ limpr_ustar()

int Modele_turbulence_hyd_base::limpr_ustar ( double temps_courant,
double temps_prec,
double dt,
double dt_ustar ) const

Definition at line 378 of file Modele_turbulence_hyd_base.cpp.

◆ lire_distance_paroi()

void Modele_turbulence_hyd_base::lire_distance_paroi ( )

Reads the domain Wall_length.xyz file to populate the wall_length field for distance_paroi post-processing.

Definition at line 198 of file Modele_turbulence_hyd_base.cpp.

◆ lire_motcle_non_standard()

int Modele_turbulence_hyd_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
motluThe name of the keyword to read.
isAn input stream.
Returns
Negative value if the keyword is not understood, otherwise positive value.

< list storing all boundary names of the domain

Reimplemented from Objet_U.

Reimplemented in Modele_turbulence_hyd_K_Eps, Modele_turbulence_hyd_K_Eps_Bas_Reynolds, Modele_turbulence_hyd_K_Eps_Bicephale, Modele_turbulence_hyd_K_Eps_Realisable, Modele_turbulence_hyd_K_Eps_Realisable_Bicephale, Modele_turbulence_hyd_LES_selectif_mod_VDF, Modele_turbulence_hyd_LES_SMAGO_DYN_VDF, Modele_turbulence_hyd_LES_VDF, Modele_turbulence_hyd_Longueur_Melange_VEF, and Modele_turbulence_hyd_RANS_Bicephale_base.

Definition at line 88 of file Modele_turbulence_hyd_base.cpp.

◆ LIST()

Modele_turbulence_hyd_base::LIST ( Nom )
protected

◆ loi_paroi() [1/2]

Turbulence_paroi_base & Modele_turbulence_hyd_base::loi_paroi ( )
inline

Definition at line 47 of file Modele_turbulence_hyd_base.h.

◆ loi_paroi() [2/2]

const Turbulence_paroi_base & Modele_turbulence_hyd_base::loi_paroi ( ) const
inline

Definition at line 46 of file Modele_turbulence_hyd_base.h.

◆ mettre_a_jour()

◆ OBS_PTR()

Modele_turbulence_hyd_base::OBS_PTR ( Equation_base )
protected

◆ OWN_PTR() [1/2]

Modele_turbulence_hyd_base::OWN_PTR ( Champ_Fonc_base )
protected

◆ OWN_PTR() [2/2]

Modele_turbulence_hyd_base::OWN_PTR ( Turbulence_paroi_base )
protected

◆ preparer_calcul()

◆ reprendre()

int Modele_turbulence_hyd_base::reprendre ( Entree & is)
overridevirtual

Restores the wall law from a checkpoint.

Parameters
(Entree&)an input stream
Returns
(int) always returns 0

Reimplemented from Objet_U.

Reimplemented in Modele_turbulence_hyd_combinaison, Modele_turbulence_hyd_LES_base, Modele_turbulence_hyd_RANS_Bicephale_base, Modele_turbulence_hyd_RANS_K_Eps_base, and Modele_turbulence_hyd_RANS_K_Omega_base.

Definition at line 442 of file Modele_turbulence_hyd_base.cpp.

◆ sauvegarder()

int Modele_turbulence_hyd_base::sauvegarder ( Sortie & os) const
overridevirtual

Saves the turbulence model to an output stream.

Saves the object type.

Parameters
(Sortie&os) an output stream
Returns
(int) always returns 1

Reimplemented from Objet_U.

Reimplemented in Modele_turbulence_hyd_null, Modele_turbulence_hyd_RANS_Bicephale_base, Modele_turbulence_hyd_RANS_K_Eps_base, and Modele_turbulence_hyd_RANS_K_Omega_base.

Definition at line 418 of file Modele_turbulence_hyd_base.cpp.

◆ set_param()

◆ utiliser_loi_paroi()

bool Modele_turbulence_hyd_base::utiliser_loi_paroi ( ) const
inline

Definition at line 48 of file Modele_turbulence_hyd_base.h.

◆ viscosite_turbulente() [1/2]

Champ_Fonc_base & Modele_turbulence_hyd_base::viscosite_turbulente ( )
inline

Definition at line 43 of file Modele_turbulence_hyd_base.h.

◆ viscosite_turbulente() [2/2]

const Champ_Fonc_base & Modele_turbulence_hyd_base::viscosite_turbulente ( ) const
inline

Definition at line 42 of file Modele_turbulence_hyd_base.h.

Member Data Documentation

◆ boundaries_

int Modele_turbulence_hyd_base::boundaries_ = 0
protected

Definition at line 89 of file Modele_turbulence_hyd_base.h.

◆ champs_compris_

Champs_compris Modele_turbulence_hyd_base::champs_compris_
protected

Definition at line 92 of file Modele_turbulence_hyd_base.h.

◆ dt_impr_ustar_

double Modele_turbulence_hyd_base::dt_impr_ustar_ = 1.e20
protected

Definition at line 88 of file Modele_turbulence_hyd_base.h.

◆ dt_impr_ustar_mean_only_

double Modele_turbulence_hyd_base::dt_impr_ustar_mean_only_ = 1.e20
protected

Definition at line 88 of file Modele_turbulence_hyd_base.h.

◆ LeCmu_

double Modele_turbulence_hyd_base::LeCmu_ = CMU
protected

Definition at line 84 of file Modele_turbulence_hyd_base.h.

◆ nom_fichier_

Nom Modele_turbulence_hyd_base::nom_fichier_ = ""
protected

Definition at line 91 of file Modele_turbulence_hyd_base.h.

◆ wall_length_

Modele_turbulence_hyd_base::wall_length_
protected

Definition at line 85 of file Modele_turbulence_hyd_base.h.


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