9.2
general documentation
cs_turbulence_t Struct Reference

#include <cs_cdo_turbulence.h>

+ Collaboration diagram for cs_turbulence_t:

Public Attributes

Turbulence modelling

Set of parameters to handle turbulence modelling.

cs_turbulence_param_tparam
 
cs_equation_tmom_eq
 
Main properties related to the turbulence modelling
cs_property_trho
 
cs_property_tmu_tot
 
cs_property_tmu_l
 
cs_property_tmu_t
 
cs_real_tmu_tot_array
 
Main related fields
cs_field_tmu_t_field
 
cs_field_trij
 

Main structure and function pointers

The context structure is a structure cast on-the-fly and function pointers are a limited set of functions associated to the main operations for this structure: initialization, destruction, computation and update.

void * context
 
cs_turb_init_context_tinit_context
 
cs_turb_free_context_tfree_context
 
cs_turb_compute_tcompute
 
cs_turb_compute_tcompute_steady
 
cs_turb_update_tupdate
 
void add_boundary_stress (const cs_mesh_t *m, cs_field_t *boundary_stress) const
 Compute and add the turbulent part of the boundray stress. More...
 
void check_convergence (const cs_cdo_quantities_t *quant, const cs_time_step_t *ts, const cs_param_psteady_t &psp, cs_cdo_navsto_psteady_cvg_t &ps_cvg) const
 Check the convergence of the pseudo-steady algorithm when the unsteady Navier-Stokes system with a CDO face-based scheme is used. More...
 

Member Function Documentation

◆ add_boundary_stress()

void add_boundary_stress ( const cs_mesh_t m,
cs_field_t boundary_stress 
) const

Compute and add the turbulent part of the boundray stress.

Parameters
[in]meshpointer to a cs_mesh_t structure
[in]boundary_stresspointer to a cs_field_t structure

◆ check_convergence()

void check_convergence ( const cs_cdo_quantities_t quant,
const cs_time_step_t ts,
const cs_param_psteady_t psp,
cs_cdo_navsto_psteady_cvg_t ps_cvg 
) const

Check the convergence of the pseudo-steady algorithm when the unsteady Navier-Stokes system with a CDO face-based scheme is used.

Parameters
[in]quantpointer to a cs_cdo_quantities_t struct.
[in]tspointer to a cs_time_step_t structure
[in]psppointer to a cs_param_psteady_t struct.
[in]ps_cvgpointer to a cs_cdo_navsto_psteady_cvg_t struct.

Member Data Documentation

◆ compute

compute

Function pointer to compute all variables related to a turbulence model

◆ compute_steady

compute_steady

Function pointer to compute in steady mode all variables related to a turbulence model

◆ context

context

Context related to the turbulence modelling. This structure is cast on-the-fly according to the modelling choices

◆ free_context

free_context

Function pointer to de-allocate memory owned by the context structure

◆ init_context

init_context

Function pointer to initialize the context structure

◆ mom_eq

mom_eq

Pointer to the momentum equation structure.

◆ mu_l

mu_l

laminar viscosity

◆ mu_t

mu_t

total viscosity (dynamic turbulent + laminar)

dynamic turbulent viscosity

◆ mu_t_field

cs_field_t* mu_t_field

Reynolds stress tensor

◆ mu_tot

cs_property_t* mu_tot

mass density

◆ mu_tot_array

mu_tot_array

Array storing the value of the total viscosity in each cell

◆ param

param

Main set of parameters to handle turbulence modelling. The members of this structure are shared with the legacy part.

◆ rho

rho

mass density

◆ rij

rij

Reynolds stress tensor

◆ update

update

Function pointer to perform the update step (properties or arrays associated to the variables of a turbulence model are updated)


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