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

Scalar turbulence model using the turbulent Schmidt number to compute turbulent diffusion: More...

#include <Modele_turbulence_scal_Schmidt.h>

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

Public Member Functions

virtual int comprend_champ (const Motcle &) const
 Returns 1 if the keyword passed as parameter is a field name of the object.
virtual int a_pour_Champ_Fonc (const Motcle &, OBS_PTR(Champ_base)&) const
 Returns 1 if a functional field (Champ_Fonc) with the specified name is owned by the turbulence model, 0 otherwise.
void mettre_a_jour (double) override
 Computes the turbulent coefficient used in the equation and the wall law.
void set_param (Param &) const override
double get_Scturb () const
Public Member Functions inherited from Modele_turbulence_scal_diffturb_base
void associer_viscosite_turbulente (const Champ_Fonc_base &)
 Associates a turbulent viscosity to the turbulence model.
void completer () override
 Completes the turbulence model: calls Modele_turbulence_scal_base::completer().
int reprendre (Entree &) override
 Does nothing.
Public Member Functions inherited from Modele_turbulence_scal_base
virtual int preparer_calcul ()
 Does nothing.
virtual bool initTimeStep (double dt)
 To be overridden in derived classes that own one or more equations. Calls preparer_pas_de_temps on those equations.
const Champ_Fonc_baseconductivite_turbulente () const
const Champ_Fonc_basediffusivite_turbulente () const
const Turbulence_paroi_scal_baseloi_paroi () const
 Returns the scalar wall-law turbulence model (const version).
int loi_paroi_non_nulle () const
 Returns whether a wall law is set (const version).
Turbulence_paroi_scal_baseloi_paroi ()
 Returns the scalar wall-law turbulence model.
virtual void discretiser ()
 Discretizes the turbulence model.
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 &)
 Does nothing.
void a_faire (Sortie &) const
 Writes an identity string to the output stream if necessary.
virtual std::vector< YAML_datadata_a_sauvegarder () const
 for PDI IO: retrieve name, type and dimensions of the fields to save/restore
int sauvegarder (Sortie &) const override
 Does nothing.
Convection_Diffusion_stdequation ()
const Convection_Diffusion_stdequation () 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
int limpr_nusselt (double, double, double, double) const
 Indicates whether local Nusselt values should be printed.
virtual void imprimer (Sortie &) const
 Performs printing if necessary.
int lire_motcle_non_standard (const Motcle &, Entree &) override
 Reads non-simple-type parameters of an Objet_U from an input stream.
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 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 ()

Protected Member Functions

Champ_Fonc_basecalculer_diffusion_turbulente ()
 Computes the turbulent diffusion.
Protected Member Functions inherited from Modele_turbulence_scal_diffturb_base
 OBS_PTR (Champ_Fonc_base) la_viscosite_turbulente_
Protected Member Functions inherited from Modele_turbulence_scal_base
 OWN_PTR (Champ_Fonc_base) conductivite_turbulente_
 OBS_PTR (Convection_Diffusion_std) mon_equation_
 OWN_PTR (Turbulence_paroi_scal_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 Attributes

double LeScturb_ = 0.7
Protected Attributes inherited from Modele_turbulence_scal_base
 diffusivite_turbulente_
double dt_impr_nusselt_ = DMAXFLOAT
double dt_impr_nusselt_mean_only_ = DMAXFLOAT
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

Scalar turbulence model using the turbulent Schmidt number to compute turbulent diffusion:

             diffu_turb = visco_turb / Sc_turb
See also
Mod_Turb_scal_diffuturb_base

Definition at line 27 of file Modele_turbulence_scal_Schmidt.h.

Member Function Documentation

◆ a_pour_Champ_Fonc()

int Modele_turbulence_scal_Schmidt::a_pour_Champ_Fonc ( const Motcle & ,
OBS_PTR(Champ_base)&  ) const
virtual

Returns 1 if a functional field (Champ_Fonc) with the specified name is owned by the turbulence model, 0 otherwise.

Parameters
motName of a functional field of the turbulence model.
ch_refReference to the found field (if found).
Returns
1 if a functional field with the given name was found, 0 otherwise.

Definition at line 62 of file Modele_turbulence_scal_Schmidt.cpp.

◆ calculer_diffusion_turbulente()

Champ_Fonc_base & Modele_turbulence_scal_Schmidt::calculer_diffusion_turbulente ( )
protected

Computes the turbulent diffusion.

turbulent_diffusion = turbulent_viscosity / turbulent_Schmidt_number

Returns
The newly computed turbulent diffusion field.
Exceptions
Ifdiffusivite_turbulente and viscosite_turbulente fields do not have the same number of nodal values.

Definition at line 99 of file Modele_turbulence_scal_Schmidt.cpp.

◆ comprend_champ()

int Modele_turbulence_scal_Schmidt::comprend_champ ( const Motcle & mot) const
virtual

Returns 1 if the keyword passed as parameter is a field name of the object.

Parameters
motThe keyword to compare against known field names.
Returns
0 if the keyword is not a field name, 1 otherwise.

Definition at line 48 of file Modele_turbulence_scal_Schmidt.cpp.

◆ get_Scturb()

double Modele_turbulence_scal_Schmidt::get_Scturb ( ) const
inline

Definition at line 37 of file Modele_turbulence_scal_Schmidt.h.

◆ mettre_a_jour()

void Modele_turbulence_scal_Schmidt::mettre_a_jour ( double )
overridevirtual

Computes the turbulent coefficient used in the equation and the wall law.

Parameters
Unusedtime parameter.

Implements Modele_turbulence_scal_base.

Definition at line 77 of file Modele_turbulence_scal_Schmidt.cpp.

◆ set_param()

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

Reimplemented from Modele_turbulence_scal_base.

Definition at line 36 of file Modele_turbulence_scal_Schmidt.cpp.

Member Data Documentation

◆ LeScturb_

double Modele_turbulence_scal_Schmidt::LeScturb_ = 0.7
protected

Definition at line 40 of file Modele_turbulence_scal_Schmidt.h.


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