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

Base class for the hierarchy of wall-law models computing turbulent quantities near walls. Contains a reference to a turbulence model. More...

#include <Turbulence_paroi_base.h>

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

Public Member Functions

virtual void set_param (Param &param) const override
void associer_modele (const Modele_turbulence_hyd_base &)
 Associates a turbulence model to the object.
virtual void associer (const Domaine_dis_base &, const Domaine_Cl_dis_base &)=0
virtual void completer ()
virtual int init_lois_paroi ()=0
int calculer_hyd (Champ_Inc_base &)
 Simple call to int calculer_hyd(DoubleTab& ).
int calculer_hyd (Champ_Fonc_base &, Champ_Fonc_base &)
 Simple call to int calculer_hyd(DoubleTab&, DoubleTab&).
virtual int calculer_hyd (DoubleTab &)=0
virtual int calculer_hyd (DoubleTab &, DoubleTab &)=0
virtual int calculer_hyd_BiK (DoubleTab &, DoubleTab &)=0
virtual DoubleTab & corriger_derivee_impl (DoubleTab &d) const
virtual void imprimer_ustar (Sortie &) const
virtual void imprimer_premiere_ligne_ustar (int, const LIST(Nom)&, const Nom &) const
 Writes header line for u* (friction velocity) statistics file.
virtual void imprimer_ustar_mean_only (Sortie &, int, const LIST(Nom)&, const Nom &) const
 Prints mean friction velocity (u*) statistics to a file for specified boundaries.
const DoubleTab & Cisaillement_paroi () const
const DoubleVect & tab_u_star () const
double tab_u_star (int face) const
const DoubleVect & tab_d_plus () const
double tab_d_plus (int face) const
int sauvegarder (Sortie &) const override
 Saves an Objet_U to an output stream. Virtual method to override.
int reprendre (Entree &) override
 Restores an Objet_U from an input stream. Virtual method to override.
virtual std::vector< YAML_datadata_a_sauvegarder () const
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
void ouvrir_fichier_partage (EcrFicPartage &, const Nom &) const
 Opens or creates a print file for Face, uplus_, dplus_, tab_u_star, Cisaillement_paroi_.
void ouvrir_fichier_partage (EcrFicPartage &, const Nom &, const Nom &) const
 Opens or creates a file for printing mean values of uplus_, dplus_, tab_u_star.
virtual bool use_shear () 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
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 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 typer_lire_turbulence_paroi (OWN_PTR(Turbulence_paroi_base)&, const Modele_turbulence_hyd_base &, Entree &)
 Reads the characteristics of the wall law from an input stream.
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 (Modele_turbulence_hyd_base) mon_modele_turb_hyd
 OWN_PTR (Champ_Fonc_base) champ_u_star_
 OBS_PTR (Domaine_VF) le_dom_dis_
 OBS_PTR (Domaine_Cl_dis_base) le_dom_Cl_dis_
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

DoubleTab Cisaillement_paroi_
DoubleVect tab_u_star_
DoubleVect tab_d_plus_
int nb_impr_ = 0
int nb_impr0_ = 0
Champs_compris champs_compris_

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

Base class for the hierarchy of wall-law models computing turbulent quantities near walls. Contains a reference to a turbulence model.

See also
Paroi_std_hyd_VDF Paroi_std_scal_hyd_VDF

Definition at line 35 of file Turbulence_paroi_base.h.

Member Function Documentation

◆ associer()

virtual void Turbulence_paroi_base::associer ( const Domaine_dis_base & ,
const Domaine_Cl_dis_base &  )
pure virtual

◆ associer_modele()

void Turbulence_paroi_base::associer_modele ( const Modele_turbulence_hyd_base & le_modele)
inline

Associates a turbulence model to the object.

Associates a hydraulic turbulence model to the object.

Parameters
(Modele_turbulence_hyd_base&le_modele) the hydraulic turbulence model to associate with the object

Definition at line 99 of file Turbulence_paroi_base.h.

◆ calculer_hyd() [1/4]

int Turbulence_paroi_base::calculer_hyd ( Champ_Fonc_base & ch1,
Champ_Fonc_base & ch2 )
inline

Simple call to int calculer_hyd(DoubleTab&, DoubleTab&).

Parameters
(Champ_Inc_base&ch1)
(Champ_Inc_base&ch2)
Returns
(int) propagated return code

Definition at line 120 of file Turbulence_paroi_base.h.

◆ calculer_hyd() [2/4]

int Turbulence_paroi_base::calculer_hyd ( Champ_Inc_base & ch)
inline

Simple call to int calculer_hyd(DoubleTab& ).

Parameters
(Champ_Inc_base&ch)
Returns
(int) propagated return code

Definition at line 109 of file Turbulence_paroi_base.h.

◆ calculer_hyd() [3/4]

◆ calculer_hyd() [4/4]

◆ calculer_hyd_BiK()

◆ Cisaillement_paroi()

const DoubleTab & Turbulence_paroi_base::Cisaillement_paroi ( ) const
inline

Definition at line 125 of file Turbulence_paroi_base.h.

◆ completer()

virtual void Turbulence_paroi_base::completer ( )
inlinevirtual

Definition at line 45 of file Turbulence_paroi_base.h.

◆ corriger_derivee_impl()

virtual DoubleTab & Turbulence_paroi_base::corriger_derivee_impl ( DoubleTab & d) const
inlinevirtual

Reimplemented in Paroi_hyd_base_EF, and Paroi_hyd_base_VEF.

Definition at line 52 of file Turbulence_paroi_base.h.

◆ creer_champ()

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

Implements Champs_compris_interface.

Definition at line 95 of file Turbulence_paroi_base.cpp.

◆ data_a_sauvegarder()

virtual std::vector< YAML_data > Turbulence_paroi_base::data_a_sauvegarder ( ) const
inlinevirtual

Definition at line 67 of file Turbulence_paroi_base.h.

◆ get_champ()

const Champ_base & Turbulence_paroi_base::get_champ ( const Motcle & nom) const
overridevirtual

Implements Champs_compris_interface.

Definition at line 131 of file Turbulence_paroi_base.cpp.

◆ get_noms_champs_postraitables()

void Turbulence_paroi_base::get_noms_champs_postraitables ( Noms & nom,
Option opt = NONE ) const
overridevirtual

Implements Champs_compris_interface.

Definition at line 162 of file Turbulence_paroi_base.cpp.

◆ has_champ() [1/2]

bool Turbulence_paroi_base::has_champ ( const Motcle & nom) const
overridevirtual

Implements Champs_compris_interface.

Definition at line 123 of file Turbulence_paroi_base.cpp.

◆ has_champ() [2/2]

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

◆ imprimer_premiere_ligne_ustar()

void Turbulence_paroi_base::imprimer_premiere_ligne_ustar ( int ,
const LIST(Nom)& ,
const Nom &  ) const
virtual

Writes header line for u* (friction velocity) statistics file.

Parameters
boundaries_Flag to control boundary selection (0: all boundaries, 1: specified boundaries)
boundaries_listList of boundary names to process
nom_fichier_Output filename

Creates header line with column names for u* and d+ statistics. Format: "Time Mean(u*) Mean(d+) [boundary1(u*) boundary1(d+) ...]" Writes warning messages if specified boundaries are not of correct wall type (Dirichlet_paroi_fixe or Dirichlet_paroi_defilante).

Definition at line 236 of file Turbulence_paroi_base.cpp.

◆ imprimer_ustar()

virtual void Turbulence_paroi_base::imprimer_ustar ( Sortie & ) const
inlinevirtual

◆ imprimer_ustar_mean_only()

void Turbulence_paroi_base::imprimer_ustar_mean_only ( Sortie & ,
int ,
const LIST(Nom)& ,
const Nom &  ) const
virtual

Prints mean friction velocity (u*) statistics to a file for specified boundaries.

Parameters
osOutput stream for messages
boundaries_Flag to control boundary selection (0: all boundaries, 1: specified boundaries)
boundaries_listList of boundary names to process when boundaries_=1
nom_fichier_Output filename

Calculates and writes average u* (friction velocity) and d+ values for wall boundaries. Results are written for all boundaries combined and then for each boundary separately. Only processes fixed walls (Dirichlet_paroi_fixe) and moving walls (Dirichlet_paroi_defilante). Output format: time mean_u* mean_d+ [boundary1_u* boundary1_d+ boundary2_u* boundary2_d+ ...]

Definition at line 290 of file Turbulence_paroi_base.cpp.

◆ init_lois_paroi()

◆ OBS_PTR() [1/3]

Turbulence_paroi_base::OBS_PTR ( Domaine_Cl_dis_base )
protected

◆ OBS_PTR() [2/3]

Turbulence_paroi_base::OBS_PTR ( Domaine_VF )
protected

◆ OBS_PTR() [3/3]

Turbulence_paroi_base::OBS_PTR ( Modele_turbulence_hyd_base )
protected

◆ ouvrir_fichier_partage() [1/2]

void Turbulence_paroi_base::ouvrir_fichier_partage ( EcrFicPartage & Ustar,
const Nom & extension ) const

Opens or creates a print file for Face, uplus_, dplus_, tab_u_star, Cisaillement_paroi_.

Definition at line 175 of file Turbulence_paroi_base.cpp.

◆ ouvrir_fichier_partage() [2/2]

void Turbulence_paroi_base::ouvrir_fichier_partage ( EcrFicPartage & fichier,
const Nom & nom_fichier,
const Nom & extension ) const

Opens or creates a file for printing mean values of uplus_, dplus_, tab_u_star.

Definition at line 206 of file Turbulence_paroi_base.cpp.

◆ OWN_PTR()

Turbulence_paroi_base::OWN_PTR ( Champ_Fonc_base )
mutableprotected

◆ reprendre()

int Turbulence_paroi_base::reprendre ( Entree & is)
inlineoverridevirtual

Restores an Objet_U from an input stream. Virtual method to override.

Parameters
isInput stream to use for restoration.
Returns
Return code.

Reimplemented from Objet_U.

Definition at line 66 of file Turbulence_paroi_base.h.

◆ sauvegarder()

int Turbulence_paroi_base::sauvegarder ( Sortie & os) const
inlineoverridevirtual

Saves an Objet_U to an output stream. Virtual method to override.

Parameters
osOutput stream to use for saving.
Returns
Return code.

Reimplemented from Objet_U.

Definition at line 65 of file Turbulence_paroi_base.h.

◆ set_param()

virtual void Turbulence_paroi_base::set_param ( Param & param) const
inlineoverridevirtual

◆ tab_d_plus() [1/2]

const DoubleVect & Turbulence_paroi_base::tab_d_plus ( ) const
inline

Definition at line 140 of file Turbulence_paroi_base.h.

◆ tab_d_plus() [2/2]

double Turbulence_paroi_base::tab_d_plus ( int face) const
inline

Definition at line 145 of file Turbulence_paroi_base.h.

◆ tab_u_star() [1/2]

const DoubleVect & Turbulence_paroi_base::tab_u_star ( ) const
inline

Definition at line 130 of file Turbulence_paroi_base.h.

◆ tab_u_star() [2/2]

double Turbulence_paroi_base::tab_u_star ( int face) const
inline

Definition at line 135 of file Turbulence_paroi_base.h.

◆ typer_lire_turbulence_paroi()

void Turbulence_paroi_base::typer_lire_turbulence_paroi ( OWN_PTR(Turbulence_paroi_base)& ,
const Modele_turbulence_hyd_base & ,
Entree &  )
static

Reads the characteristics of the wall law from an input stream.

Format: type_de_loi_de_paroi Possible values for the wall law type:

  • "loi_standard_hydr"
  • "negligeable"
  • "loi_VanDriest"
Parameters
loi_parWall law object to type and initialize.
mod_turb_hydReference to the hydraulic turbulence model.
sInput stream.

Definition at line 66 of file Turbulence_paroi_base.cpp.

◆ use_shear()

virtual bool Turbulence_paroi_base::use_shear ( ) const
inlinevirtual

Member Data Documentation

◆ champs_compris_

Champs_compris Turbulence_paroi_base::champs_compris_
protected

Definition at line 89 of file Turbulence_paroi_base.h.

◆ Cisaillement_paroi_

DoubleTab Turbulence_paroi_base::Cisaillement_paroi_
protected

Definition at line 83 of file Turbulence_paroi_base.h.

◆ nb_impr0_

int Turbulence_paroi_base::nb_impr0_ = 0
protected

Definition at line 88 of file Turbulence_paroi_base.h.

◆ nb_impr_

int Turbulence_paroi_base::nb_impr_ = 0
mutableprotected

Definition at line 88 of file Turbulence_paroi_base.h.

◆ tab_d_plus_

DoubleVect Turbulence_paroi_base::tab_d_plus_
protected

Definition at line 86 of file Turbulence_paroi_base.h.

◆ tab_u_star_

DoubleVect Turbulence_paroi_base::tab_u_star_
protected

Definition at line 85 of file Turbulence_paroi_base.h.


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