My Project
programmer's documentation
Functions/Subroutines
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, location_id)
 add field defining a general solved variable, with default options More...
 
subroutine add_cdo_variable_field (name, label, dim, ivar, location_id, has_previous)
 Add a field defining a general solved variable, with default options This variable is solved with a CDO scheme. 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_model_field_indexes (f_id, iscal)
 add field indexes associated with a new non-user solved scalar variable, with default options 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_c_add_model_field_indexes (f_id)
 add field indexes associated with a new non-user solved variable, with default options More...
 

Detailed Description

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

Function/Subroutine Documentation

◆ add_cdo_variable_field()

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

Add a field defining a general solved variable, with default options This variable is solved with a CDO scheme.

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]namefield name
[in]labelfield default label, or empty
[out]ivarvariable number for defined field
[in]dimfield dimension
[in]location_idid of the mesh location where the field is defined
[in]has_previousif greater than 0 then stores previous state

◆ 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]namefield name
[in]labelfield default label, or empty
[in]dimfield dimension
[out]iscalvariable 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_idfield id
[out]iscalvariable number 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]namefield name
[in]labelfield default label, or empty
[out]iscalscalar 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,
integer, intent(in)  location_id 
)

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]namefield name
[in]labelfield default label, or empty
[in]dimfield dimension
[out]ivarvariable 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_idfield id
Returns
scalar number for defined field

◆ fldvar()

subroutine fldvar ( integer  nmodpp)
Parameters
[out]nmodppnumber 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.