Go to the source code of this file.
|  | 
| struct | cs_turbulence_param_t | 
|  | Structure storing the parameters related to the resolution of the turbulence modelling. Several members are structures defined in cs_turbulence_model.h as a global variable. The purpose of this structure is to store all parameters in one place.  More... 
 | 
|  | 
| struct | cs_turbulence_t | 
|  | 
|  | 
| cs_turbulence_param_t * | cs_turbulence_param_create (void) | 
|  | Allocate the structure storing the set of parameters for the turbulence modelling.  More... 
 | 
|  | 
| cs_turbulence_t * | cs_turbulence_create (cs_turbulence_param_t *tbp) | 
|  | Allocate the structure managing the turbulence modelling.  More... 
 | 
|  | 
| void | cs_turbulence_free (cs_turbulence_t **p_turb_struct) | 
|  | Free the structure managing the turbulence modelling.  More... 
 | 
|  | 
| void | cs_turbulence_init_setup (cs_turbulence_t *tbs, cs_equation_t *mom_eq) | 
|  | Initialize the structure managing the turbulence modelling.  More... 
 | 
|  | 
| void | cs_turbulence_finalize_setup (const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_time_step_t *time_step, cs_turbulence_t *tbs) | 
|  | Finalize the setup of the turbulence modelling and especially the equations/properties and other related quantities.  More... 
 | 
|  | 
| void | cs_turbulence_init_values (const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_time_step_t *time_step, cs_turbulence_t *tbs) | 
|  | Initialize the values of quantities related to a turbulence model.  More... 
 | 
|  | 
| void * | cs_turb_init_k_eps_context (const cs_turb_model_t *tbm) | 
|  | Allocate and initialize the context structure related to the k-epsilon turbulence model.  More... 
 | 
|  | 
| void * | cs_turb_free_k_eps_context (void *tbc) | 
|  | Free the context structure related to the k-epsilon turbulence model.  More... 
 | 
|  | 
| void | cs_turb_compute_k_eps (const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_time_step_t *time_step, cs_turbulence_t *tbs) | 
|  | Compute for the current time step the new state for the turbulence model. This means that all related equations are built and then solved.  More... 
 | 
|  | 
| void | cs_turb_update_k_eps (const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_time_step_t *time_step, const cs_turbulence_t *tbs) | 
|  | Update for the current time step the new state for the turbulence model. This is used to update the turbulent viscosity.  More... 
 | 
|  | 
◆ CS_NAVSTO_LAM_VISCOSITY
      
        
          | #define CS_NAVSTO_LAM_VISCOSITY   "laminar_viscosity" | 
      
 
 
◆ CS_NAVSTO_TOTAL_VISCOSITY
      
        
          | #define CS_NAVSTO_TOTAL_VISCOSITY   "total_viscosity" | 
      
 
 
◆ CS_NAVSTO_TURB_VISCOSITY
      
        
          | #define CS_NAVSTO_TURB_VISCOSITY   "turbulent_viscosity" | 
      
 
 
◆ cs_turb_compute_t
Compute for the current time step the new state for the turbulence model. This means that all related equations are built and then solved. 
- Parameters
- 
  
    | [in] | mesh | pointer to a cs_mesh_t structure |  | [in] | connect | pointer to a cs_cdo_connect_t structure |  | [in] | quant | pointer to a cs_cdo_quantities_t structure |  | [in] | time_step | structure managing the time stepping |  | [in,out] | tbs | pointer to turbulence structure |  
 
 
 
◆ cs_turb_free_context_t
      
        
          | typedef void*() cs_turb_free_context_t(void *turb_context) | 
      
 
Free the context structure related to a given turbulence modelling. 
- Parameters
- 
  
    | [in,out] | tbc | pointer to a structure cast on-the-fly to free |  
 
- Returns
- a NULL pointer 
 
 
◆ cs_turb_init_context_t
Allocate and initialize the context structure related to a given turbulence modelling. 
- Parameters
- 
  
  
- Returns
- a pointer to a new allocated turbulence context structure 
 
 
◆ cs_turb_update_t
Update properties, arrays related to the turbulent variables. 
- Parameters
- 
  
  
 
 
◆ cs_turb_compute_k_eps()
Compute for the current time step the new state for the turbulence model. This means that all related equations are built and then solved. 
- Parameters
- 
  
    | [in] | mesh | pointer to a cs_mesh_t structure |  | [in] | connect | pointer to a cs_cdo_connect_t structure |  | [in] | quant | pointer to a cs_cdo_quantities_t structure |  | [in] | time_step | structure managing the time stepping |  | [in,out] | tbs | pointer to turbulence structure |  
 
 
 
◆ cs_turb_free_k_eps_context()
      
        
          | void* cs_turb_free_k_eps_context | ( | void * | tbc | ) |  | 
      
 
Free the context structure related to the k-epsilon turbulence model. 
- Parameters
- 
  
    | [in,out] | tbc | pointer to a structure context cast on-the-fly |  
 
- Returns
- a NULL pointer 
 
 
◆ cs_turb_init_k_eps_context()
Allocate and initialize the context structure related to the k-epsilon turbulence model. 
- Parameters
- 
  
    | [in] | tbm | structure which defines the turbulence model |  
 
- Returns
- a pointer to a new allocated context structure 
 
 
◆ cs_turb_update_k_eps()
Update for the current time step the new state for the turbulence model. This is used to update the turbulent viscosity. 
- Parameters
- 
  
  
 
 
◆ cs_turbulence_create()
Allocate the structure managing the turbulence modelling. 
- Parameters
- 
  
  
- Returns
- a pointer to a new allocated cs_turbulence_t structure 
 
 
◆ cs_turbulence_finalize_setup()
Finalize the setup of the turbulence modelling and especially the equations/properties and other related quantities. 
- Parameters
- 
  
  
 
 
◆ cs_turbulence_free()
Free the structure managing the turbulence modelling. 
- Parameters
- 
  
    | [in,out] | p_turb_struct | pointer to the structure to free |  
 
 
 
◆ cs_turbulence_init_setup()
Initialize the structure managing the turbulence modelling. 
- Parameters
- 
  
    | [in,out] | tbs | pointer to the structure to initialize |  | [in] | mom_eq | pointer to the structure mom_eq |  
 
 
 
◆ cs_turbulence_init_values()
Initialize the values of quantities related to a turbulence model. 
- Parameters
- 
  
  
 
 
◆ cs_turbulence_param_create()
Allocate the structure storing the set of parameters for the turbulence modelling. 
- Returns
- a pointer to a new allocated cs_turbulence_param_t structure