Functions to handle the resolution of the turbulence modelling within the CDO framework. More...

#include "cs_defs.h"
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <bft_mem.h>
#include "cs_post.h"
#include "cs_turbulence_model.h"
#include "cs_reco.h"
#include "cs_cdo_turbulence.h"

Include dependency graph for cs_cdo_turbulence.c:

Macros
#define	CS_CDO_TURBULENCE_DBG 0

Functions
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_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...

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...

Detailed Description

Functions to handle the resolution of the turbulence modelling within the CDO framework.

Macro Definition Documentation

◆ CS_CDO_TURBULENCE_DBG

#define CS_CDO_TURBULENCE_DBG 0

Function Documentation

◆ cs_turb_compute_k_eps()

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.

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()

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.

Parameters

[in] tbm structure which defines the turbulence model

Returns: a pointer to a new allocated context structure

◆ cs_turb_update_k_eps()

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.

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]	tbs	pointer to a cs_turbulence_t structure

◆ cs_turbulence_create()

cs_turbulence_t* cs_turbulence_create ( cs_turbulence_param_t * tbp )

Allocate the structure managing the turbulence modelling.

Parameters

[in] tbp pointer to a cs_turbulence_param_t structure

Returns: a pointer to a new allocated cs_turbulence_t structure

◆ cs_turbulence_finalize_setup()

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.

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	pointer to a cs_time_step_t structure
[in,out]	tbs	pointer to the turbulence main structure

◆ cs_turbulence_free()

void cs_turbulence_free ( cs_turbulence_t ** p_turb_struct )

Free the structure managing the turbulence modelling.

Parameters

[in,out] p_turb_struct pointer to the structure to free

◆ cs_turbulence_init_setup()

void cs_turbulence_init_setup	(	cs_turbulence_t *	tbs,
		cs_equation_t *	mom_eq
	)

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()

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.

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	pointer to a cs_time_step_t structure
[in,out]	tbs	pointer to the turbulence main structure

◆ cs_turbulence_param_create()

cs_turbulence_param_t* cs_turbulence_param_create ( void )

Allocate the structure storing the set of parameters for the turbulence modelling.

Returns: a pointer to a new allocated cs_turbulence_param_t structure

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ CS_CDO_TURBULENCE_DBG

Function Documentation

◆ cs_turb_compute_k_eps()

◆ cs_turb_free_k_eps_context()

◆ cs_turb_init_k_eps_context()

◆ cs_turb_update_k_eps()

◆ cs_turbulence_create()

◆ cs_turbulence_finalize_setup()

◆ cs_turbulence_free()

◆ cs_turbulence_init_setup()

◆ cs_turbulence_init_values()

◆ cs_turbulence_param_create()