fldvar.f90 File Reference

Variables definition initialization, according to calculation type selected by the user. More...

Functions/Subroutines
subroutine	fldvar (nmodpp)
subroutine	add_variable_field (name, label, dim, ivar)
	add field defining a general solved variable, with default options More...
subroutine	add_user_scalar_fields
	add fields defining user solved scalar variables, with default options More...
subroutine	add_model_scalar_field (name, label, iscal)
	add field defining a non-user solved scalar variable, with default options More...
subroutine	add_model_field (name, label, dim, iscal)
	add field defining a non-user solved variable, with default options More...
subroutine	add_variable_field_indexes (f_id, ivar)
	add field indexes associated with a new non-user solved scalar variable, with default options More...
subroutine	add_model_field_indexes (f_id, iscal)
	add field indexes associated with a new non-user solved scalar variable, with default options More...
subroutine	map_variable_field_try (name, ivar)
	Map field defining a general solved variable to Fortran id. More...
subroutine	fldvar_check_nvar
	Check nvarmx is sufficient for the required number of variables. More...
subroutine	init_var_cal_opt (id)
	Initialize the given variable calculation option structure with legacy values (iniini) allowing to later test user modification. More...
subroutine	fldvar_check_nscapp
	Check nscamx is sufficient for the required number of model scalars. More...
integer(c_int) function	cs_add_variable_field_indexes (f_id)
	add field indexes associated with a new non-user solved variable, with default options More...
integer(c_int) function	cs_c_add_model_field_indexes (f_id)
	add field indexes associated with a new non-user solved variable, with default options More...
subroutine	cs_c_add_model_thermal_field_indexes (f_id)
	add field indexes associated with a new solved thermal variable, with default options More...

Detailed Description

Variables definition initialization, according to calculation type selected by the user.

Function/Subroutine Documentation

add_model_field()

subroutine add_model_field	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	label,
		integer, intent(in)	dim,
		integer, intent(out)	iscal
	)

add field defining a non-user solved variable, with default options

It is recommended not to define variable names of more than 16 characters, to get a clear execution log (some advanced writing levels take into account only the first 16 characters).

Parameters

[in]	name	field name
[in]	label	field default label, or empty
[in]	dim	field dimension
[out]	iscal	variable number for defined field

add_model_field_indexes()

subroutine add_model_field_indexes	(	integer, intent(in)	f_id,
		integer, intent(out)	iscal
	)

add field indexes associated with a new non-user solved scalar variable, with default options

Parameters

[in]	f_id	field id
[out]	iscal	scalar id for defined field

add_model_scalar_field()

subroutine add_model_scalar_field	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	label,
		integer, intent(out)	iscal
	)

add field defining a non-user solved scalar variable, with default options

It is recommended not to define variable names of more than 16 characters, to get a clear execution log (some advanced writing levels take into account only the first 16 characters).

Parameters

[in]	name	field name
[in]	label	field default label, or empty
[out]	iscal	scalar number for defined field

add_user_scalar_fields()

subroutine add_user_scalar_fields

add fields defining user solved scalar variables, with default options

add_variable_field()

subroutine add_variable_field	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	label,
		integer, intent(in)	dim,
		integer, intent(out)	ivar
	)

add field defining a general solved variable, with default options

It is recommended not to define variable names of more than 16 characters, to get a clear execution log (some advanced writing levels take into account only the first 16 characters).

Parameters

[in]	name	field name
[in]	label	field default label, or empty
[in]	dim	field dimension
[out]	ivar	variable number for defined field

add_variable_field_indexes()

subroutine add_variable_field_indexes	(	integer, intent(in)	f_id,
		integer, intent(out)	ivar
	)

add field indexes associated with a new non-user solved scalar variable, with default options

Parameters

[in]	f_id	field id
[out]	ivar	variable number for defined field

cs_add_variable_field_indexes()

integer(c_int) function cs_add_variable_field_indexes

(

integer(c_int), value

f_id

)

add field indexes associated with a new non-user solved variable, with default options

Parameters

[in]

f_id

field id

Returns

variable number for defined field

cs_c_add_model_field_indexes()

integer(c_int) function cs_c_add_model_field_indexes

(

integer(c_int), value

f_id

)

add field indexes associated with a new non-user solved variable, with default options

Parameters

[in]

f_id

field id

Returns

scalar number for defined field

cs_c_add_model_thermal_field_indexes()

subroutine cs_c_add_model_thermal_field_indexes

(

integer(c_int), value

f_id

)

add field indexes associated with a new solved thermal variable, with default options

Parameters

[in]

f_id

field id

fldvar()

subroutine fldvar

(

integer(c_int), value

nmodpp

)

Parameters

[out]

nmodpp

number of activated particle physic models

fldvar_check_nscapp()

subroutine fldvar_check_nscapp

Check nscamx is sufficient for the required number of model scalars.

fldvar_check_nvar()

subroutine fldvar_check_nvar

Check nvarmx is sufficient for the required number of variables.

init_var_cal_opt()

subroutine init_var_cal_opt

(

integer

id

)

Initialize the given variable calculation option structure with legacy values (iniini) allowing to later test user modification.

map_variable_field_try()

subroutine map_variable_field_try	(	character(len=*), intent(in)	name,
		integer, intent(out)	ivar
	)

Map field defining a general solved variable to Fortran id.

If field is not available, value is at 0

Parameters

[in]	name	field name
[out]	ivar	variable id, or 0