Base class for scalar turbulence models coupled to a Navier-Stokes convection-diffusion equation. More...

#include <Modele_turbulence_scal_base.h>

Inheritance diagram for Modele_turbulence_scal_base:

Collaboration diagram for Modele_turbulence_scal_base:

Public Member Functions
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.
virtual void	mettre_a_jour (double)=0
const Champ_Fonc_base &	conductivite_turbulente () const
const Champ_Fonc_base &	diffusivite_turbulente () const
const Turbulence_paroi_scal_base &	loi_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_base &	loi_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	completer ()
	Completes the turbulence model: updates object references.
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_data >	data_a_sauvegarder () const
	for PDI IO: retrieve name, type and dimensions of the fields to save/restore
int	sauvegarder (Sortie &) const override
	Does nothing.
int	reprendre (Entree &) override
	Does nothing.
Convection_Diffusion_std &	equation ()
const Convection_Diffusion_std &	equation () const
void	creer_champ (const Motcle &motlu) override
const Champ_base &	get_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.
virtual void	set_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.
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 Sortie &	printOn (Sortie &) const
	Writes the object to an output stream. Virtual method to override.
virtual Entree &	readOn (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 Nom &	le_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_info *	get_info () const
	Returns type information for the Objet_U.
const Nom &	que_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 Interprete &	interprete () const
Interprete &	interprete ()
Public Member Functions inherited from Process
virtual	~Process ()

Protected Member Functions
	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_U &	operator= (const Objet_U &)
	Assignment operator: does nothing (the number and identifier are preserved).

Protected Attributes
	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 Nom &	nom_du_cas ()
	Returns a constant reference to the case name. This method is static.
static Nom &	get_set_nom_du_cas ()
	Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_info *	info ()
	Returns type information for the Objet_U (static version).
static const Objet_U &	self_cast (const Objet_U &)
	Method added for casting in Python.
static Objet_U &	self_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 Sortie &	Journal (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 scalar turbulence models coupled to a Navier-Stokes convection-diffusion equation.

Two main derived categories exist: k-epsilon models and sub-grid scale models.
Both share the computation of a turbulent diffusivity.

See also: Modele_turbulence_scal_Prandtl Modele_turb_scal_Prandtl_sous_maille

Definition at line 37 of file Modele_turbulence_scal_base.h.

Member Function Documentation

◆ a_faire()

void Modele_turbulence_scal_base::a_faire ( Sortie & os ) const

Writes an identity string to the output stream if necessary.

Parameters

os	Output stream.

Definition at line 258 of file Modele_turbulence_scal_base.cpp.

◆ associer()

void Modele_turbulence_scal_base::associer	(	const Domaine_dis_base &	,
		const Domaine_Cl_dis_base &	)

virtual

Does nothing.

Parameters

Discretized	domain (unused).
Discretized	boundary conditions domain (unused).

Reimplemented in Modele_turbulence_scal_LES_dyn_VDF.

Definition at line 180 of file Modele_turbulence_scal_base.cpp.

◆ associer_eqn()

void Modele_turbulence_scal_base::associer_eqn ( const Equation_base & eqn )

Associates the equation passed as parameter to the turbulence model.

The equation is cast to Convection_Diffusion_std.

Parameters

eqn	The equation to associate with this object.

Definition at line 170 of file Modele_turbulence_scal_base.cpp.

◆ completer()

void Modele_turbulence_scal_base::completer ( )

virtual

Completes the turbulence model: updates object references.

Reimplemented in Modele_turbulence_scal_diffturb_base, Modele_turbulence_scal_Fluctuation_Temperature, Modele_turbulence_scal_Fluctuation_Temperature_W, and Modele_turbulence_scal_Fluctuation_Temperature_W_Bas_Re.

Definition at line 202 of file Modele_turbulence_scal_base.cpp.

◆ conductivite_turbulente()

const Champ_Fonc_base & Modele_turbulence_scal_base::conductivite_turbulente ( ) const

inline

Definition at line 44 of file Modele_turbulence_scal_base.h.

◆ creer_champ()

void Modele_turbulence_scal_base::creer_champ ( const Motcle & motlu )

overridevirtual

Implements Champs_compris_interface.

Definition at line 288 of file Modele_turbulence_scal_base.cpp.

◆ data_a_sauvegarder()

std::vector< YAML_data > Modele_turbulence_scal_base::data_a_sauvegarder ( ) const

virtual

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

Definition at line 233 of file Modele_turbulence_scal_base.cpp.

◆ diffusivite_turbulente()

const Champ_Fonc_base & Modele_turbulence_scal_base::diffusivite_turbulente ( ) const

inline

Definition at line 45 of file Modele_turbulence_scal_base.h.

◆ discretiser()

void Modele_turbulence_scal_base::discretiser ( )

virtual

Discretizes the turbulence model.

Definition at line 188 of file Modele_turbulence_scal_base.cpp.

◆ equation() [1/2]

Convection_Diffusion_std & Modele_turbulence_scal_base::equation ( )

inline

Definition at line 111 of file Modele_turbulence_scal_base.h.

◆ equation() [2/2]

const Convection_Diffusion_std & Modele_turbulence_scal_base::equation ( ) const

inline

Definition at line 121 of file Modele_turbulence_scal_base.h.

◆ get_champ()

const Champ_base & Modele_turbulence_scal_base::get_champ ( const Motcle & nom ) const

overridevirtual

Implements Champs_compris_interface.

Reimplemented in Modele_turbulence_scal_Fluctuation_Temperature, Modele_turbulence_scal_Fluctuation_Temperature_W, and Modele_turbulence_scal_Fluctuation_Temperature_W_Bas_Re.

Definition at line 318 of file Modele_turbulence_scal_base.cpp.

◆ get_noms_champs_postraitables()

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

overridevirtual

Implements Champs_compris_interface.

Reimplemented in Modele_turbulence_scal_Fluctuation_Temperature, Modele_turbulence_scal_Fluctuation_Temperature_W, and Modele_turbulence_scal_Fluctuation_Temperature_W_Bas_Re.

Definition at line 332 of file Modele_turbulence_scal_base.cpp.

◆ has_champ() [1/2]

bool Modele_turbulence_scal_base::has_champ ( const Motcle & nom ) const

overridevirtual

Implements Champs_compris_interface.

Reimplemented in Modele_turbulence_scal_Fluctuation_Temperature, Modele_turbulence_scal_Fluctuation_Temperature_W, and Modele_turbulence_scal_Fluctuation_Temperature_W_Bas_Re.

Definition at line 306 of file Modele_turbulence_scal_base.cpp.

◆ has_champ() [2/2]

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

override

◆ imprimer()

void Modele_turbulence_scal_base::imprimer ( Sortie & os ) const

virtual

Performs printing if necessary.

Parameters

os	Output stream.

Reimplemented in Modele_turbulence_scal_Fluctuation_Temperature, and Modele_turbulence_scal_Fluctuation_Temperature_W.

Definition at line 374 of file Modele_turbulence_scal_base.cpp.

◆ initTimeStep()

bool Modele_turbulence_scal_base::initTimeStep ( double dt )

virtual

To be overridden in derived classes that own one or more equations. Calls preparer_pas_de_temps on those equations.

Parameters

dt	Time step.

Returns: True if successful.

Reimplemented in Modele_turbulence_scal_Fluctuation_Temperature, and Modele_turbulence_scal_Fluctuation_Temperature_W.

Definition at line 211 of file Modele_turbulence_scal_base.cpp.

◆ limpr_nusselt()

int Modele_turbulence_scal_base::limpr_nusselt	(	double	temps_courant,
		double	temps_prec,
		double	dt,
		double	dt_nusselt ) const

Indicates whether local Nusselt values should be printed.

Parameters

temps_courant	Current time.
temps_prec	Previous time.
dt	Current time step.
dt_nusselt	Nusselt printing period.

Returns: 1 if printing is required, 0 otherwise.

Definition at line 351 of file Modele_turbulence_scal_base.cpp.

◆ lire_motcle_non_standard()

int Modele_turbulence_scal_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

motlu	The name of the keyword to read.
is	An 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_scal_Fluctuation_Temperature, Modele_turbulence_scal_Fluctuation_Temperature_W, Modele_turbulence_scal_Fluctuation_Temperature_W_Bas_Re, and Modele_turbulence_scal_LES_dyn_VDF.

Definition at line 73 of file Modele_turbulence_scal_base.cpp.

◆ LIST()

Modele_turbulence_scal_base::LIST ( Nom )

protected

◆ loi_paroi() [1/2]

Turbulence_paroi_scal_base & Modele_turbulence_scal_base::loi_paroi ( )

inline

Returns the scalar wall-law turbulence model.

Returns: (Turbulence_paroi_scal_base&) the scalar wall-law turbulence model

Definition at line 106 of file Modele_turbulence_scal_base.h.

◆ loi_paroi() [2/2]

const Turbulence_paroi_scal_base & Modele_turbulence_scal_base::loi_paroi ( ) const

inline

Returns the scalar wall-law turbulence model (const version).

Returns: (Turbulence_paroi_scal_base&) the scalar wall-law turbulence model

Definition at line 88 of file Modele_turbulence_scal_base.h.

◆ loi_paroi_non_nulle()

int Modele_turbulence_scal_base::loi_paroi_non_nulle ( ) const

inline

Returns whether a wall law is set (const version).

Returns: (int) 1 if a wall law is set, 0 otherwise

Definition at line 97 of file Modele_turbulence_scal_base.h.

◆ mettre_a_jour()

virtual void Modele_turbulence_scal_base::mettre_a_jour ( double )

pure virtual

Implemented in Modele_turbulence_scal_Fluctuation_Temperature, Modele_turbulence_scal_Fluctuation_Temperature_W, Modele_turbulence_scal_Fluctuation_Temperature_W_Bas_Re, Modele_turbulence_scal_LES_dyn_VDF, Modele_turbulence_scal_null, Modele_turbulence_scal_Prandtl, and Modele_turbulence_scal_Schmidt.

◆ OBS_PTR()

Modele_turbulence_scal_base::OBS_PTR ( Convection_Diffusion_std )

protected

◆ OWN_PTR() [1/2]

Modele_turbulence_scal_base::OWN_PTR ( Champ_Fonc_base )

protected

◆ OWN_PTR() [2/2]

Modele_turbulence_scal_base::OWN_PTR ( Turbulence_paroi_scal_base )

protected

◆ preparer_calcul()

int Modele_turbulence_scal_base::preparer_calcul ( )

virtual

Does nothing.

Returns: Always returns 1.

Reimplemented in Modele_turbulence_scal_Fluctuation_Temperature, Modele_turbulence_scal_Fluctuation_Temperature_W, and Modele_turbulence_scal_Fluctuation_Temperature_W_Bas_Re.

Definition at line 220 of file Modele_turbulence_scal_base.cpp.

◆ reprendre()

int Modele_turbulence_scal_base::reprendre ( Entree & is )

overridevirtual

Does nothing.

Parameters

is	Input stream.

Returns: Always returns 1.

Reimplemented from Objet_U.

Reimplemented in Modele_turbulence_scal_diffturb_base, Modele_turbulence_scal_Fluctuation_Temperature, and Modele_turbulence_scal_Fluctuation_Temperature_W.

Definition at line 280 of file Modele_turbulence_scal_base.cpp.

◆ sauvegarder()

int Modele_turbulence_scal_base::sauvegarder ( Sortie & os ) const

overridevirtual

Does nothing.

Parameters

os	Output stream.

Returns: Always returns 1.

Reimplemented from Objet_U.

Reimplemented in Modele_turbulence_scal_Fluctuation_Temperature, and Modele_turbulence_scal_Fluctuation_Temperature_W.

Definition at line 246 of file Modele_turbulence_scal_base.cpp.

◆ set_param()

void Modele_turbulence_scal_base::set_param ( Param & param ) const

overridevirtual

Reimplemented from Objet_U.

Reimplemented in Modele_turbulence_scal_Fluctuation_Temperature, Modele_turbulence_scal_Fluctuation_Temperature_W, Modele_turbulence_scal_Fluctuation_Temperature_W_Bas_Re, Modele_turbulence_scal_LES_dyn_VDF, Modele_turbulence_scal_Prandtl, and Modele_turbulence_scal_Schmidt.

Definition at line 59 of file Modele_turbulence_scal_base.cpp.

Member Data Documentation

◆ boundaries_

int Modele_turbulence_scal_base::boundaries_ = 0

protected

Definition at line 78 of file Modele_turbulence_scal_base.h.

◆ champs_compris_

Champs_compris Modele_turbulence_scal_base::champs_compris_

protected

Definition at line 81 of file Modele_turbulence_scal_base.h.

◆ diffusivite_turbulente_

Modele_turbulence_scal_base::diffusivite_turbulente_

protected

Definition at line 74 of file Modele_turbulence_scal_base.h.

◆ dt_impr_nusselt_

double Modele_turbulence_scal_base::dt_impr_nusselt_ = DMAXFLOAT

protected

Definition at line 77 of file Modele_turbulence_scal_base.h.

◆ dt_impr_nusselt_mean_only_

double Modele_turbulence_scal_base::dt_impr_nusselt_mean_only_ = DMAXFLOAT

protected

Definition at line 77 of file Modele_turbulence_scal_base.h.

◆ nom_fichier_

Nom Modele_turbulence_scal_base::nom_fichier_ = ""

protected

Definition at line 80 of file Modele_turbulence_scal_base.h.

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

/home/docs/trust-code/src/ThHyd/Turbulence/Modeles/scal/Modele_turbulence_scal_base.h
/home/docs/trust-code/src/ThHyd/Turbulence/Modeles/scal/Modele_turbulence_scal_base.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ a_faire()

◆ associer()

◆ associer_eqn()

◆ completer()

◆ conductivite_turbulente()

◆ creer_champ()

◆ data_a_sauvegarder()

◆ diffusivite_turbulente()

◆ discretiser()

◆ equation() [1/2]

◆ equation() [2/2]

◆ get_champ()

◆ get_noms_champs_postraitables()

◆ has_champ() [1/2]

◆ has_champ() [2/2]

◆ imprimer()

◆ initTimeStep()

◆ limpr_nusselt()

◆ lire_motcle_non_standard()

◆ LIST()

◆ loi_paroi() [1/2]

◆ loi_paroi() [2/2]

◆ loi_paroi_non_nulle()

◆ mettre_a_jour()

◆ OBS_PTR()

◆ OWN_PTR() [1/2]

◆ OWN_PTR() [2/2]

◆ preparer_calcul()

◆ reprendre()

◆ sauvegarder()

◆ set_param()

Member Data Documentation

◆ boundaries_

◆ champs_compris_

◆ diffusivite_turbulente_

◆ dt_impr_nusselt_

◆ dt_impr_nusselt_mean_only_

◆ nom_fichier_