Data Types
interface	boundary_conditions_mapped_set
	Set mapped boundary conditions for a given field and mapping locator. More...

interface	cs_boundary_conditions_legacy_turbulence
	Define automatic turbulence values for specific physical modules. More...

interface	cs_f_field_get_key_struct_var_cal_opt

interface	cs_f_field_set_key_struct_var_cal_opt

interface	cs_f_scalar_clipping

interface	cs_gas_combustion_h_to_t
	Convert enthalpy to temperature for gas combustion. More...

interface	cs_gas_combustion_t_to_h
	Convert temperature to enthalpy for gas combustion. More...

interface	cs_intprf

interface	cs_intprz

interface	cs_log_default_activate

interface	cs_log_default_is_active

interface	cs_set_type_order_turbulence_model

interface	cs_time_moment_is_active
	Return if moment is active (1) or not (0). More...

interface	cs_time_moment_n_moments
	Return the number of temporal moments. More...

interface	cs_turb_model_init

interface	csexit

interface	equation_param_from_vcopt

interface	les_filter
	Compute filters for dynamic models. More...

interface	time_moment_field_id
	Get field id associated with a given moment. More...

interface	timer_stats_set_plot
	Enable or disable plotting for a timer statistic. More...

interface	timer_stats_start
	Start a timer for a given statistic. More...

interface	timer_stats_switch
	Start a timer for a given statistic, stopping previous timers of the same type which are not a parent, and starting inactive parent timers if necessary. More...

interface	turbulence_bc_ke_turb_intensity
	Calculation of and $\varepsilon$ from a diameter , a turbulent intensity and the reference velocity $U_{ref}$ for a circular duct flow with smooth wall (for inlet boundary conditions). More...

interface	turbulence_bc_rij_transform
	Compute matrix $\tens{alpha}$ used in the computation of the Reynolds stress tensor boundary conditions. More...

type	var_cal_opt

interface	yg2xye
	Compute molar and mass fractions of elementary species Ye, Xe (fuel, O2, CO2, H2O, N2) from global species Yg (fuel, oxidant, products) More...

Functions/Subroutines
subroutine	balance_by_zone (sel_crit, name)
	Compute balance on a given zone for a given scalar. More...

subroutine	intprf (nprofz, nproft, profz, proft, profv, xz, temps, var)
	Temporal and z-axis interpolation for meteorological profiles. More...

subroutine	intprz (nprofz, profz, profv, xz, iz1, iz2, var)
	z-axis interpolation for meteorological profiles More...

subroutine	pressure_drop_by_zone (sel_crit)
	Compute pressure drop for a given zone. More...

subroutine	surface_balance (sel_crit, name, normal)
	Compute surface scalar balance for a given surface area. More...

subroutine	boundary_conditions_error (bc_type)
	Handle boundary condition definition errors and associated output. More...

type(c_ptr) function	boundary_conditions_map (location_type, n_location_elts, n_faces, location_elts, faces, coord_shift, coord_stride, tolerance)
	Locate shifted boundary face coordinates on possibly filtered cells or boundary faces for later interpolation. More...

subroutine	field_set_key_struct_var_cal_opt (f_id, k_value)
	Assign a var_cal_opt for a cs_var_cal_opt_t key to a field. More...

subroutine	field_get_key_struct_var_cal_opt (f_id, k_value)
	Return a pointer to the var_cal_opt structure for cs_var_cal_opt key associated with a field. More...

subroutine	gradient_hn_s (f_id, imrgra, inc, nswrgp, imligp, iwarnp, epsrgp, climgp, pvar, grad)
	Compute cell gradient for scalar with homegeneous gradient. More...

subroutine	user_f_boundary_conditions (itypfb, izfppp, dt)
	Wrapper to Fortran user boundary condition definitions. More...

subroutine	user_f_initialization (dt)
	Wrapper to Fortran user initialization definitions. More...

subroutine	cs_f_usppmo ()
	Wrapper to Fortran user parameters, model choice. More...

subroutine	cs_f_usipsu (nmodpp)
	Wrapper to Fortran user parameters. More...

subroutine	cs_f_usipes (nmodpp)
	Wrapper to Fortran user parameters, additional parameters. More...

subroutine	variable_field_create (name, label, location_id, dim, id)
	Add field defining a general solved variable, with default options. More...

double precision function	notebook_parameter_value_by_name (name)
	Return notebook parameter value. More...

subroutine	clpsca (iscal)
	brief Clipping scalar field. More...

Variables
integer	mesh_location_none

integer	mesh_location_cells

integer	mesh_location_interior_faces

integer	mesh_location_boundary_faces

integer	mesh_location_vertices

integer	mesh_location_particles

integer	mesh_location_other

integer	post_on_location

integer	post_boundary_nr

integer	post_monitor

integer	restart_val_type_int_t

integer	restart_val_type_real_t

integer	restart_disabled

integer	restart_main

integer	restart_auxiliary

integer	restart_rad_transfer

integer	restart_lagr

integer	restart_lagr_stat

integer	restart_1d_wall_thermal

integer	restart_les_inflow

integer	volume_zone_initialization

integer	volume_zone_porosity

integer	volume_zone_head_loss

integer	volume_zone_source_term

integer	volume_zone_mass_source_term

Function/Subroutine Documentation

◆ balance_by_zone()

subroutine balance_by_zone	(	character(len=*), intent(in)	sel_crit,
		character(len=*), intent(in)	name
	)

Compute balance on a given zone for a given scalar.

param[in] sel_crit selection criteria of a volume zone param[in] name scalar name

◆ boundary_conditions_error()

subroutine boundary_conditions_error ( integer(c_int), dimension(*), intent(in) bc_type )

Handle boundary condition definition errors and associated output.

For each boundary face, bc_type defines the boundary condition type. As a convention here, zero values correspond to undefined types, positive values to defined types (with no error), and negative values to defined types with inconsistent or incompatible values, the absolute value indicating the original boundary condition type. param[in] bc_type array og BC type ids

◆ boundary_conditions_map()

type(c_ptr) function boundary_conditions_map	(	integer, intent(in)	location_type,
		integer, intent(in)	n_location_elts,
		integer, intent(in)	n_faces,
		integer, dimension(*), intent(in)	location_elts,
		integer, dimension(*), intent(in)	faces,
		real(kind=c_double), dimension(*)	coord_shift,
		integer, intent(in)	coord_stride,
		double precision, intent(in)	tolerance
	)

Locate shifted boundary face coordinates on possibly filtered cells or boundary faces for later interpolation.

param[in] location_type matching values location (CS_MESH_LOCATION_CELLS or CS_MESH_LOCATION_BOUNDARY_FACES) param[in] n_location_elts number of selected location elements param[in] n_faces number of selected boundary faces param[in] location_elts list of selected location elements (1 to n), or NULL if no indirection is needed param[in] faces list of selected boundary faces (1 to n), or NULL if no indirection is needed param[in] coord_shift array of coordinates shift relative to selected boundary faces param[in] coord_stride access stride in coord_shift: 0 for uniform shift, 1 for "per face" shift. param[in] tolerance relative tolerance for point location. return associated locator structure

◆ clpsca()

subroutine clpsca ( integer, intent(in) iscal )

brief Clipping scalar field.

◆ cs_f_usipes()

subroutine cs_f_usipes ( integer(c_int) nmodpp )

Wrapper to Fortran user parameters, additional parameters.

◆ cs_f_usipsu()

subroutine cs_f_usipsu ( integer(c_int) nmodpp )

Wrapper to Fortran user parameters.

◆ cs_f_usppmo()

subroutine cs_f_usppmo

Wrapper to Fortran user parameters, model choice.

◆ field_get_key_struct_var_cal_opt()

subroutine field_get_key_struct_var_cal_opt	(	integer, intent(in)	f_id,
		type(var_cal_opt), intent(out), target	k_value
	)

Return a pointer to the var_cal_opt structure for cs_var_cal_opt key associated with a field.

If the field category is not compatible, a fatal error is provoked.

Parameters

[in]	f_id	field id
[out]	k_value	integer value associated with key id for this field

◆ field_set_key_struct_var_cal_opt()

subroutine field_set_key_struct_var_cal_opt	(	integer, intent(in)	f_id,
		type(var_cal_opt), intent(in), target	k_value
	)

Assign a var_cal_opt for a cs_var_cal_opt_t key to a field.

If the field category is not compatible, a fatal error is provoked.

Parameters

[in]	f_id	field id
[in]	k_value	structure associated with key

◆ gradient_hn_s()

subroutine gradient_hn_s	(	integer, intent(in)	f_id,
		integer, intent(in)	imrgra,
		integer, intent(in)	inc,
		integer, intent(in)	nswrgp,
		integer, intent(in)	imligp,
		integer, intent(in)	iwarnp,
		double precision, intent(in)	epsrgp,
		double precision, intent(in)	climgp,
		real(kind=c_double), dimension(ncelet), intent(inout)	pvar,
		real(kind=c_double), dimension(3, ncelet), intent(out)	grad
	)

Compute cell gradient for scalar with homegeneous gradient.

Parameters

[in]	f_id	field id, or -1
[in]	imrgra	gradient computation mode
[in]	inc	0: increment; 1: do not increment
[in]	nswrgp	number of sweeps for reconstruction
[in]	imligp	gradient limitation method: < 0 no limitation = 0 based on neighboring gradients = 1 based on mean gradient
[in]	iwarnp	verbosity
[in]	epsrgp	relative precision for reconstruction
[in]	climgp	limiter coefficient for imligp
[in,out]	pvar	cell values whose gradient is computed
[out]	grad	resulting gradient

◆ intprf()

subroutine intprf	(	integer(c_int), intent(in), value	nprofz,
		integer(c_int), intent(in), value	nproft,
		real(kind=c_double), dimension(nprofz), intent(in)	profz,
		real(kind=c_double), dimension(nproft), intent(in)	proft,
		real(kind=c_double), dimension(nprofz, nproft), intent(in)	profv,
		real(kind=c_double), intent(in), value	xz,
		real(kind=c_double), intent(in), value	temps,
		real(kind=c_double), intent(out)	var
	)

Temporal and z-axis interpolation for meteorological profiles.

An optimized linear interpolation is used.

◆ intprz()

subroutine intprz	(	integer(c_int), intent(in), value	nprofz,
		real(kind=c_double), dimension(nprofz), intent(in)	profz,
		real(kind=c_double), dimension(nprofz), intent(in)	profv,
		real(kind=c_double), intent(in), value	xz,
		integer(c_int), intent(out)	iz1,
		integer(c_int), intent(out)	iz2,
		real(kind=c_double), intent(out)	var
	)

z-axis interpolation for meteorological profiles

An optimized linear interpolation is used.

◆ notebook_parameter_value_by_name()

double precision function notebook_parameter_value_by_name ( character(len=*), intent(in) name )

Return notebook parameter value.

Parameters

[in] name name of the notebook parameter

Returns: val

◆ pressure_drop_by_zone()

subroutine pressure_drop_by_zone ( character(len=*), intent(in) sel_crit )

Compute pressure drop for a given zone.

param[in] sel_crit selection criteria of a volume zone

◆ surface_balance()

subroutine surface_balance	(	character(len=*), intent(in)	sel_crit,
		character(len=*), intent(in)	name,
		real(kind=c_double), dimension(3), intent(in)	normal
	)

Compute surface scalar balance for a given surface area.

param[in] sel_crit selection criteria of a volume zone

◆ user_f_boundary_conditions()

subroutine user_f_boundary_conditions	(	integer(kind=c_int), dimension(*), intent(inout)	itypfb,
		integer(kind=c_int), dimension(*), intent(inout)	izfppp,
		real(c_double), dimension(*), intent(in)	dt
	)

Wrapper to Fortran user boundary condition definitions.

Parameters

[in,out] bc_type boundary face types

◆ user_f_initialization()

subroutine user_f_initialization ( real(c_double), dimension(*), intent(in) dt )

Wrapper to Fortran user initialization definitions.

Parameters

[in,out] bc_type boundary face types

◆ variable_field_create()

subroutine variable_field_create	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	label,
		integer, intent(in)	location_id,
		integer, intent(in)	dim,
		integer, intent(out)	id
	)

Add field defining a general solved variable, with default options.

Parameters

[in]	name	field name
[in]	label	field default label, or empty
[in]	location_id	field location type: 0: none 1: cells 2: interior faces 3: interior faces 4: vertices
[in]	dim	field dimension
[out]	id	id of defined field

Variable Documentation

◆ mesh_location_boundary_faces

integer mesh_location_boundary_faces

◆ mesh_location_cells

integer mesh_location_cells

◆ mesh_location_interior_faces

integer mesh_location_interior_faces

◆ mesh_location_none

integer mesh_location_none

◆ mesh_location_other

integer mesh_location_other

◆ mesh_location_particles

integer mesh_location_particles

◆ mesh_location_vertices

integer mesh_location_vertices

◆ post_boundary_nr

integer post_boundary_nr

◆ post_monitor

integer post_monitor

◆ post_on_location

integer post_on_location

◆ restart_1d_wall_thermal

integer restart_1d_wall_thermal

◆ restart_auxiliary

integer restart_auxiliary

◆ restart_disabled

integer restart_disabled

◆ restart_lagr

integer restart_lagr

◆ restart_lagr_stat

integer restart_lagr_stat

◆ restart_les_inflow

integer restart_les_inflow

◆ restart_main

integer restart_main

◆ restart_rad_transfer

integer restart_rad_transfer

◆ restart_val_type_int_t

integer restart_val_type_int_t

◆ restart_val_type_real_t

integer restart_val_type_real_t

◆ volume_zone_head_loss

integer volume_zone_head_loss

◆ volume_zone_initialization

integer volume_zone_initialization

◆ volume_zone_mass_source_term

integer volume_zone_mass_source_term

◆ volume_zone_porosity

integer volume_zone_porosity

◆ volume_zone_source_term

integer volume_zone_source_term

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ balance_by_zone()

◆ boundary_conditions_error()

◆ boundary_conditions_map()

◆ clpsca()

◆ cs_f_usipes()

◆ cs_f_usipsu()

◆ cs_f_usppmo()

◆ field_get_key_struct_var_cal_opt()

◆ field_set_key_struct_var_cal_opt()

◆ gradient_hn_s()

◆ intprf()

◆ intprz()

◆ notebook_parameter_value_by_name()

◆ pressure_drop_by_zone()

◆ surface_balance()

◆ user_f_boundary_conditions()

◆ user_f_initialization()

◆ variable_field_create()

Variable Documentation

◆ mesh_location_boundary_faces

◆ mesh_location_cells

◆ mesh_location_interior_faces

◆ mesh_location_none

◆ mesh_location_other

◆ mesh_location_particles

◆ mesh_location_vertices

◆ post_boundary_nr

◆ post_monitor

◆ post_on_location

◆ restart_1d_wall_thermal

◆ restart_auxiliary

◆ restart_disabled

◆ restart_lagr

◆ restart_lagr_stat

◆ restart_les_inflow

◆ restart_main

◆ restart_rad_transfer

◆ restart_val_type_int_t

◆ restart_val_type_real_t

◆ volume_zone_head_loss

◆ volume_zone_initialization

◆ volume_zone_mass_source_term

◆ volume_zone_porosity

◆ volume_zone_source_term