programmer's documentation
Data Types | Functions/Subroutines | Variables
cs_c_bindings Module Reference

Data Types

interface  boundary_conditions_mapped_set
 Set mapped boundary conditions for a given field and mapping locator. More...
 
interface  cs_fan_n_fans
 Return the number of fans. More...
 
interface  cs_map_name_to_id_destroy
 Destroy name to id map structure. More...
 
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_user_parameters
 General user parameters. More...
 
type  gas_mix_species_prop
 
interface  les_filter
 Compute filters for dynamic models. More...
 
interface  log_iteration
 
interface  parameters_read_restart_info
 Read restart metadata. More...
 
interface  restart_check_base_location
 Check the locations associated with a restart file. More...
 
interface  restart_destroy
 Destroy structure associated with a restart file (and close the file). More...
 
interface  restart_read_bc_coeffs
 Read boundary condition coefficients for all fields from checkpoint. More...
 
interface  restart_read_field_info
 Read field metadata from checkpoint. More...
 
interface  restart_write_bc_coeffs
 Write boundary condition coefficients for all fields to checkpoint. More...
 
interface  restart_write_field_info
 Write field metadata to checkpoint. More...
 
type  solving_info
 
interface  time_moment_field_id
 Get field id associated with a given moment. More...
 
interface  time_moment_log_iteration
 Log temporal moments initialization. More...
 
interface  time_moment_restart_read
 Read temporal moments checkpoint information. More...
 
interface  time_moment_restart_write
 Checkpoint temporal moments. More...
 
interface  time_moment_update_all
 Update temporal moments. More...
 
interface  timer_stats_increment_time_step
 Increment time step for timer statistics. 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_stop
 Stop 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_inlet_hyd_diam
 Set inlet boundary condition values for turbulence variables based on a diameter $ D_H $ and the reference velocity $ U_{ref} $ for a circular duct flow with smooth wall. More...
 
interface  turbulence_bc_inlet_turb_intensity
 Set inlet boundary condition values for turbulence variables based on a diameter $ D_H $, a turbulent intensity $ I $ and the reference velocity $ U_{ref} $ for a circular duct flow with smooth wall. More...
 
interface  turbulence_bc_ke_hyd_diam
 Calculation of $ u^\star $, $ k $ and $\varepsilon $ from a diameter $ D_H $ and the reference velocity $ U_{ref} $ for a circular duct flow with smooth wall (use for inlet boundary conditions). More...
 
interface  turbulence_bc_ke_turb_intensity
 Calculation of $ k $ and $\varepsilon$ from a diameter $ D_H $, a turbulent intensity $ I $ and the reference velocity $ U_{ref} $ for a circular duct flow with smooth wall (for inlet boundary conditions). More...
 
type  var_cal_opt
 

Functions/Subroutines

subroutine balance_by_zone (itypfb, sel_crit, name)
 Compute balance on a given zone for a given scalar. 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_set_key_struct_solving_info (f_id, k_value)
 Assign a solving_info for a cs_solving_info_t key to a field. More...
 
subroutine field_set_key_struct_gas_mix_species_prop (f_id, k_value)
 Assign a gas_mix_species_prop for a cs_gas_mix_species_prop_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 field_get_key_struct_solving_info (f_id, k_value)
 Return a pointer to the solving_info structure for cs_solving_info_t key associated with a field. More...
 
subroutine field_get_key_struct_gas_mix_species_prop (f_id, k_value)
 Return a pointer to the gas_mix_species_prop structure for cs_gas_mix_species_prop_t key associated with a field. More...
 
subroutine gradient_s (f_id, imrgra, inc, recompute_cocg, nswrgp, imligp, iwarnp, epsrgp, climgp, extrap, pvar, coefap, coefbp, grad)
 Compute cell gradient. More...
 
subroutine gradient_potential_s (f_id, imrgra, inc, recompute_cocg, nswrgp, imligp, hyd_p_flag, iwarnp, epsrgp, climgp, extrap, f_ext, pvar, coefap, coefbp, grad)
 Compute cell gradient of potential-type values. More...
 
subroutine gradient_weighted_s (f_id, imrgra, inc, recompute_cocg, nswrgp, imligp, iwarnp, epsrgp, climgp, extrap, pvar, c_weight, coefap, coefbp, grad)
 Compute cell gradient of a scalar with weighting. More...
 
subroutine locator_destroy (this_locator)
 Destruction of a locator structure. More...
 
subroutine log_iteration_add_array (name, category, location, is_intensive, dim, val)
 Add array not saved as permanent field to logging of fields. More...
 
subroutine log_iteration_clipping (name, dim, n_clip_min, n_clip_max, min_pre_clip, max_pre_clip)
 Add array not saved as permanent field to logging of fields. More...
 
subroutine log_iteration_clipping_field (f_id, n_clip_min, n_clip_max, min_pre_clip, max_pre_clip, n_clip_min_comp, n_clip_max_comp)
 Add array not saved as permanent field to logging of fields. More...
 
subroutine restart_create (name, path, mode, r)
 Initialize a restart file. More...
 
subroutine restart_read_variables (r, old_field_map, t_id_flag)
 Read variables from checkpoint. More...
 
subroutine restart_write_variables (r, t_id_flag)
 Write variables to checkpoint. More...
 
subroutine restart_read_section_int_t (r, sec_name, location_id, n_loc_vals, val, ierror)
 Read a section of integers from a restart file. More...
 
subroutine restart_read_int_t_compat (r, sec_name, old_name, location_id, n_loc_vals, val, ierror)
 Read a section of integers from a restart file, when that section may have used a different name in a previous version. More...
 
subroutine restart_write_section_int_t (r, sec_name, location_id, n_loc_vals, val)
 Write a section of integers to a checkpoint file. More...
 
subroutine restart_read_section_real_t (r, sec_name, location_id, n_loc_vals, val, ierror)
 Read a section of doubles from a restart file. More...
 
subroutine restart_read_real_t_compat (r, sec_name, old_name, location_id, n_loc_vals, val, ierror)
 Read a section of double precision reals from a restart file, when that section may have used a different name in a previous version. More...
 
subroutine restart_read_real_3_t_compat (r, sec_name, old_name_x, old_name_y, old_name_z, location_id, val, ierror)
 Read a vector of double precision reals of dimension (3,*) from a restart file, when that section may have used a different name and been non-interleaved in a previous version. More...
 
subroutine restart_write_section_real_t (r, sec_name, location_id, n_loc_vals, val)
 write a section of doubles to a checkpoint file. More...
 
subroutine restart_read_field_vals (r, f_id, t_id, ierror)
 Read field values from checkpoint. More...
 
subroutine restart_write_field_vals (r, f_id, t_id)
 Write field values to checkpoint. More...
 
subroutine restart_read_linked_fields (r, old_field_map, key, n_w)
 Read fields depending on others from checkpoint. More...
 
subroutine restart_write_linked_fields (r, key, n_w)
 Write fields depending on others to checkpoint. More...
 
subroutine sles_solve_native (f_id, name, isym, ibsize, iesize, dam, xam, iinvpe, epsilp, rnorm, niter, residue, rhs, vx)
 Call sparse linear equation solver using native matrix arrays. More...
 
subroutine sles_free_native (f_id, name)
 Free sparse linear equation solver setup using native matrix arrays. More...
 
subroutine sles_push (f_id, name)
 Temporarily replace field id with name for matching calls to sles_solve_native. More...
 
subroutine sles_pop (f_id)
 Revert to normal behavior of field id for matching calls to sles_solve_native. More...
 
integer function timer_stats_create (parent_name, name, label)
 Create a timer statistics structure. More...
 
integer function timer_stats_id_by_name (name)
 Return the id of a defined statistic based on its name. 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 restart_val_type_int_t
 
integer restart_val_type_real_t
 

Function/Subroutine Documentation

subroutine cs_c_bindings::balance_by_zone ( integer(kind=c_int), dimension(*), intent(in)  itypfb,
character(len=*), intent(in)  sel_crit,
character(len=*), intent(in)  name 
)

Compute balance on a given zone for a given scalar.

param[in] itypfb array of boundary faces type param[in] sel_crit selection criterium of a volumic zone param[in] name scalar name

type(c_ptr) function cs_c_bindings::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

subroutine cs_c_bindings::field_get_key_struct_gas_mix_species_prop ( integer, intent(in)  f_id,
type(gas_mix_species_prop), intent(inout), target  k_value 
)

Return a pointer to the gas_mix_species_prop structure for cs_gas_mix_species_prop_t key associated with a field.

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

Parameters
[in]f_idfield id
[out]k_valueinteger value associated with key id for this field
subroutine cs_c_bindings::field_get_key_struct_solving_info ( integer, intent(in)  f_id,
type(solving_info), intent(inout), target  k_value 
)

Return a pointer to the solving_info structure for cs_solving_info_t key associated with a field.

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

Parameters
[in]f_idfield id
[out]k_valueinteger value associated with key id for this field
subroutine cs_c_bindings::field_get_key_struct_var_cal_opt ( integer, intent(in)  f_id,
type(var_cal_opt), intent(inout), 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_idfield id
[out]k_valueinteger value associated with key id for this field
subroutine cs_c_bindings::field_set_key_struct_gas_mix_species_prop ( integer, intent(in)  f_id,
type(gas_mix_species_prop), intent(in), target  k_value 
)

Assign a gas_mix_species_prop for a cs_gas_mix_species_prop_t key to a field.

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

Parameters
[in]f_idfield id
[in]k_valuestructure associated with key
subroutine cs_c_bindings::field_set_key_struct_solving_info ( integer, intent(in)  f_id,
type(solving_info), intent(in), target  k_value 
)

Assign a solving_info for a cs_solving_info_t key to a field.

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

Parameters
[in]f_idfield id
[in]k_valuestructure associated with key
subroutine cs_c_bindings::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_idfield id
[in]k_valuestructure associated with key
subroutine cs_c_bindings::gradient_potential_s ( integer, intent(in)  f_id,
integer, intent(in)  imrgra,
integer, intent(in)  inc,
integer, intent(in)  recompute_cocg,
integer, intent(in)  nswrgp,
integer, intent(in)  imligp,
integer, intent(in)  hyd_p_flag,
integer, intent(in)  iwarnp,
double precision, intent(in)  epsrgp,
double precision, intent(in)  climgp,
double precision, intent(in)  extrap,
real(kind=c_double), dimension(3, *), intent(in)  f_ext,
real(kind=c_double), dimension(ncelet), intent(inout)  pvar,
real(kind=c_double), dimension(nfabor), intent(in)  coefap,
real(kind=c_double), dimension(nfabor), intent(in)  coefbp,
real(kind=c_double), dimension(3, ncelet), intent(out)  grad 
)

Compute cell gradient of potential-type values.

Parameters
[in]f_idfield id, or -1
[in]imrgragradient computation mode
[in]inc0: increment; 1: do not increment
[in]recompute_cocg1 or 0: recompute COCG or not
[in]nswrgpnumber of sweeps for reconstruction
[in]imligpgradient limitation method: < 0 no limitation = 0 based on neighboring gradients = 1 based on mean gradient
[in]hyd_p_flagflag for hydrostatic pressure
[in]iwarnpverbosity
[in]epsrgprelative precision for reconstruction
[in]climgplimiter coefficient for imligp
[in]extrapgradient extrapolation coefficient
[in]f_extexterior force generating the hydrostatic pressure
[in,out]pvarcell values whose gradient is computed
[in]coefapboundary coefap coefficients
[in]coefbpboundary coefap coefficients
[out]gradresulting gradient
subroutine cs_c_bindings::gradient_s ( integer, intent(in)  f_id,
integer, intent(in)  imrgra,
integer, intent(in)  inc,
integer, intent(in)  recompute_cocg,
integer, intent(in)  nswrgp,
integer, intent(in)  imligp,
integer, intent(in)  iwarnp,
double precision, intent(in)  epsrgp,
double precision, intent(in)  climgp,
double precision, intent(in)  extrap,
real(kind=c_double), dimension(ncelet), intent(inout)  pvar,
real(kind=c_double), dimension(nfabor), intent(in)  coefap,
real(kind=c_double), dimension(nfabor), intent(in)  coefbp,
real(kind=c_double), dimension(3, ncelet), intent(out)  grad 
)

Compute cell gradient.

Parameters
[in]f_idfield id, or -1
[in]imrgragradient computation mode
[in]inc0: increment; 1: do not increment
[in]recompute_cocg1 or 0: recompute COCG or not
[in]nswrgpnumber of sweeps for reconstruction
[in]imligpgradient limitation method: < 0 no limitation = 0 based on neighboring gradients = 1 based on mean gradient
[in]iwarnpverbosity
[in]epsrgprelative precision for reconstruction
[in]climgplimiter coefficient for imligp
[in]extrapgradient extrapolation coefficient
[in,out]pvarcell values whose gradient is computed
[in]coefapboundary coefap coefficients
[in]coefbpboundary coefap coefficients
[out]gradresulting gradient
subroutine cs_c_bindings::gradient_weighted_s ( integer, intent(in)  f_id,
integer, intent(in)  imrgra,
integer, intent(in)  inc,
integer, intent(in)  recompute_cocg,
integer, intent(in)  nswrgp,
integer, intent(in)  imligp,
integer, intent(in)  iwarnp,
double precision, intent(in)  epsrgp,
double precision, intent(in)  climgp,
double precision, intent(in)  extrap,
real(kind=c_double), dimension(ncelet), intent(inout)  pvar,
real(kind=c_double), dimension(*), intent(in)  c_weight,
real(kind=c_double), dimension(nfabor), intent(in)  coefap,
real(kind=c_double), dimension(nfabor), intent(in)  coefbp,
real(kind=c_double), dimension(3, ncelet), intent(out)  grad 
)

Compute cell gradient of a scalar with weighting.

Parameters
[in]f_idfield id, or -1
[in]imrgragradient computation mode
[in]inc0: increment; 1: do not increment
[in]recompute_cocg1 or 0: recompute COCG or not
[in]nswrgpnumber of sweeps for reconstruction
[in]imligpgradient limitation method: < 0 no limitation = 0 based on neighboring gradients = 1 based on mean gradient
[in]iwarnpverbosity
[in]epsrgprelative precision for reconstruction
[in]climgplimiter coefficient for imligp
[in]extrapgradient extrapolation coefficient
[in,out]pvarcell values whose gradient is computed
[in,out]c_weightcell weighting coefficient
[in]coefapboundary coefap coefficients
[in]coefbpboundary coefap coefficients
[out]gradresulting gradient
subroutine cs_c_bindings::locator_destroy ( type(c_ptr)  this_locator)

Destruction of a locator structure.

Parameters
[in,out]this_locator
subroutine cs_c_bindings::log_iteration_add_array ( character(len=*), intent(in)  name,
character(len=*), intent(in)  category,
integer, intent(in)  location,
logical, intent(in)  is_intensive,
integer, intent(in)  dim,
real(kind=c_double), dimension(*)  val 
)

Add array not saved as permanent field to logging of fields.

Parameters
[in]namearray name
[in]categorycategory name
[in]locationassociated mesh location
[in]is_intensiveassociated mesh location
[in]dimassociated dimension (interleaved)
[in]valassociated values
subroutine cs_c_bindings::log_iteration_clipping ( character(len=*), intent(in)  name,
integer, intent(in)  dim,
integer, intent(in)  n_clip_min,
integer, intent(in)  n_clip_max,
real(kind=c_double), dimension(*)  min_pre_clip,
real(kind=c_double), dimension(*)  max_pre_clip 
)

Add array not saved as permanent field to logging of fields.

Parameters
[in]namearray name
[in]dimassociated dimension (interleaved)
[in]n_clip_minlocal number of clipped to min values
[in]n_clip_maxlocal number of clipped to max values
[in]min_pre_clipmin local value prior to clip
[in]max_pre_clipmax local value prior to clip
subroutine cs_c_bindings::log_iteration_clipping_field ( integer, intent(in)  f_id,
integer, intent(in)  n_clip_min,
integer, intent(in)  n_clip_max,
real(kind=c_double), dimension(*)  min_pre_clip,
real(kind=c_double), dimension(*)  max_pre_clip,
integer(c_int), dimension(*), intent(in)  n_clip_min_comp,
integer(c_int), dimension(*), intent(in)  n_clip_max_comp 
)

Add array not saved as permanent field to logging of fields.

Parameters
[in]f_idassociated dimension (interleaved)
[in]n_clip_minlocal number of clipped to min values
[in]n_clip_maxlocal number of clipped to max values
[in]min_pre_clipmin local value prior to clip
[in]max_pre_clipmax local value prior to clip
[in]n_clip_min_compnumber of clip min by component
[in]n_clip_max_compnumber of clip max by component
subroutine cs_c_bindings::restart_create ( character(len=*), intent(in)  name,
character(len=*), intent(in)  path,
integer, intent(in)  mode,
type(c_ptr), intent(out)  r 
)

Initialize a restart file.

Parameters
[in]namefile name
[in]pathoptional directory name for output (automatically created if necessary)
[in]moderead (0) or write (1)
[out]rpointer to restart structure
subroutine cs_c_bindings::restart_read_field_vals ( type(c_ptr), intent(in)  r,
integer, intent(in)  f_id,
integer, intent(in)  t_id,
integer, intent(out)  ierror 
)

Read field values from checkpoint.

If the values are not found using the default rules based on the field's name, its name itself, or a "restart_rename" keyed string value, an old name may be used for compatibility with older files. For cell-based fields, the old name base is appended automatically with "_ce_phase01", except for scalars, where the name uses a different scheme, based on "scalaire_ce_%04" % s_num;

Parameters
[in]rpointer to restart structure
[in]f_idfield id
[in]t_idtime id (0 for current, 1 for previous, ...)
[out]ierrorreturn code
subroutine cs_c_bindings::restart_read_int_t_compat ( type(c_ptr), intent(in)  r,
character(len=*), intent(in)  sec_name,
character(len=*), intent(in)  old_name,
integer, intent(in)  location_id,
integer, intent(in)  n_loc_vals,
integer, dimension(*), target  val,
integer, intent(out)  ierror 
)

Read a section of integers from a restart file, when that section may have used a different name in a previous version.

Parameters
[in]rpointer to restart structure
[in]sec_namename of section
[in]old_nameold name of section
[in]location_idid of associated mesh location
[in]n_loc_valsnumber of values per location
[out]valvalues array
[out]ierror0: success, < 0: error code
subroutine cs_c_bindings::restart_read_linked_fields ( type(c_ptr), intent(in)  r,
type(c_ptr), intent(in)  old_field_map,
character(len=*), intent(in)  key,
integer, intent(out)  n_w 
)

Read fields depending on others from checkpoint.

Parameters
[in]rpointer to restart structure
[in]old_field_mappointer to old field map
[in]keykey for field association
[out]n_wnumber of fields read
subroutine cs_c_bindings::restart_read_real_3_t_compat ( type(c_ptr), intent(in)  r,
character(len=*), intent(in)  sec_name,
character(len=*), intent(in)  old_name_x,
character(len=*), intent(in)  old_name_y,
character(len=*), intent(in)  old_name_z,
integer, intent(in)  location_id,
real(kind=c_double), dimension(*)  val,
integer, intent(out)  ierror 
)

Read a vector of double precision reals of dimension (3,*) from a restart file, when that section may have used a different name and been non-interleaved in a previous version.

Parameters
[in]rpointer to restart structure
[in]sec_namename of section
[in]old_name_xold name of component x of section
[in]old_name_yold name of component y of section
[in]old_name_zold name of component z of section
[in]location_idid of associated mesh location
[out]valvalues array
[out]ierror0: success, < 0: error code
subroutine cs_c_bindings::restart_read_real_t_compat ( type(c_ptr), intent(in)  r,
character(len=*), intent(in)  sec_name,
character(len=*), intent(in)  old_name,
integer, intent(in)  location_id,
integer, intent(in)  n_loc_vals,
real(kind=c_double), dimension(*), target  val,
integer, intent(out)  ierror 
)

Read a section of double precision reals from a restart file, when that section may have used a different name in a previous version.

Parameters
[in]rpointer to restart structure
[in]sec_namename of section
[in]old_nameold name of section
[in]location_idid of associated mesh location
[in]n_loc_valsnumber of values per location
[out]valvalues array
[out]ierror0: success, < 0: error code
subroutine cs_c_bindings::restart_read_section_int_t ( type(c_ptr), intent(in)  r,
character(len=*), intent(in)  sec_name,
integer, intent(in)  location_id,
integer, intent(in)  n_loc_vals,
integer, dimension(*), target  val,
integer, intent(out)  ierror 
)

Read a section of integers from a restart file.

Parameters
[in]rpointer to restart structure
[in]sec_namename of section
[in]location_idid of associated mesh location
[in]n_loc_valsnumber of values per location
[out]valvalues array
[out]ierror0: success, < 0: error code
subroutine cs_c_bindings::restart_read_section_real_t ( type(c_ptr), intent(in)  r,
character(len=*), intent(in)  sec_name,
integer, intent(in)  location_id,
integer, intent(in)  n_loc_vals,
real(kind=c_double), dimension(*), target  val,
integer, intent(out)  ierror 
)

Read a section of doubles from a restart file.

Parameters
[in]rpointer to restart structure
[in]sec_namename of section
[in]location_idid of associated mesh location
[in]n_loc_valsnumber of values per location
[out]valvalues array
[out]ierror0: success, < 0: error code
subroutine cs_c_bindings::restart_read_variables ( type(c_ptr), intent(in)  r,
type(c_ptr), intent(in)  old_field_map,
integer, intent(in)  t_id_flag 
)

Read variables from checkpoint.

Parameters
[in]rpointer to restart structure
[in]old_field_mapold field map pointer
[in]t_id_flag-1: all time values; 0: current values; > 0: previous values
subroutine cs_c_bindings::restart_write_field_vals ( type(c_ptr), intent(in)  r,
integer, intent(in)  f_id,
integer, intent(in)  t_id 
)

Write field values to checkpoint.

Parameters
[in]rpointer to restart structure
[in]f_idfield id
[in]t_idtime id (0 for current, 1 for previous, ...)
subroutine cs_c_bindings::restart_write_linked_fields ( type(c_ptr), intent(in)  r,
character(len=*), intent(in)  key,
integer, intent(out)  n_w 
)

Write fields depending on others to checkpoint.

Parameters
[in]rpointer to restart structure
[in]keykey for field association
[out]n_wnumber of fields written
subroutine cs_c_bindings::restart_write_section_int_t ( type(c_ptr), intent(in)  r,
character(len=*), intent(in)  sec_name,
integer, intent(in)  location_id,
integer, intent(in)  n_loc_vals,
integer, dimension(*), intent(in), target  val 
)

Write a section of integers to a checkpoint file.

Parameters
[in]rpointer to restart structure
[in]sec_namename of section
[in]location_idid of associated mesh location
[in]n_loc_valsnumber of values per location
[in]valvalues array
subroutine cs_c_bindings::restart_write_section_real_t ( type(c_ptr), intent(in)  r,
character(len=*), intent(in)  sec_name,
integer, intent(in)  location_id,
integer, intent(in)  n_loc_vals,
real(kind=c_double), dimension(*), intent(in), target  val 
)

write a section of doubles to a checkpoint file.

Parameters
[in]rpointer to restart structure
[in]sec_namename of section
[in]location_idid of associated mesh location
[in]n_loc_valsnumber of values per location
[in]valvalues array
subroutine cs_c_bindings::restart_write_variables ( type(c_ptr), intent(in)  r,
integer, intent(in)  t_id_flag 
)

Write variables to checkpoint.

Parameters
[in]rpointer to restart structure
[in]t_id_flag-1: all time values; 0: current values; > 0: previous values
subroutine cs_c_bindings::sles_free_native ( integer, intent(in)  f_id,
character(len=*), intent(in)  name 
)

Free sparse linear equation solver setup using native matrix arrays.

param[in] f_id associated field id, or < 0 param[in] name associated name if f_id < 0, or ignored

subroutine cs_c_bindings::sles_pop ( integer, intent(in)  f_id)

Revert to normal behavior of field id for matching calls to sles_solve_native.

param[in] f_id associated field id, or < 0

subroutine cs_c_bindings::sles_push ( integer, intent(in)  f_id,
character(len=*), intent(in)  name 
)

Temporarily replace field id with name for matching calls to sles_solve_native.

param[in] f_id associated field id, or < 0 param[in] name associated name if f_id < 0, or ignored

subroutine cs_c_bindings::sles_solve_native ( integer, intent(in)  f_id,
character(len=*), intent(in)  name,
integer, intent(in)  isym,
integer, intent(in)  ibsize,
integer, intent(in)  iesize,
real(kind=c_double), dimension(*), intent(in)  dam,
real(kind=c_double), dimension(*), intent(in)  xam,
integer, intent(in)  iinvpe,
double precision, intent(in)  epsilp,
double precision, intent(in)  rnorm,
integer, intent(out)  niter,
double precision, intent(out)  residue,
real(kind=c_double), dimension(*), intent(in)  rhs,
real(kind=c_double), dimension(*), intent(inout)  vx 
)

Call sparse linear equation solver using native matrix arrays.

param[in] f_id associated field id, or < 0 param[in] name associated name if f_id < 0, or ignored param[in] isym symmetry indicator: 1 symmetric, 2: not symmetric param[in] ibsize block sizes for diagonal param[in] iesize block sizes for extra diagonal param[in] dam matrix diagonal param[in] xam matrix extra-diagonal terms param[in] iinvpe Indicator to cancel increments in rotational periodicty (2) or to exchange them as scalars (1) param[in] epsilp precision for iterative resolution param[in] rnorm residue normalization param[out] niter number of "equivalent" iterations param[out] residue residue param[in] rhs right hand side param[in, out] vx system solution

integer function cs_c_bindings::timer_stats_create ( character(len=*), intent(in)  parent_name,
character(len=*), intent(in)  name,
character(len=*), intent(in)  label 
)

Create a timer statistics structure.

If no timer with the given name exists, -1 is returned.

Parameters
[in]parent_namename of parent statistic (may be empty)
[in]nameassociated canonical name
[in]labelassociated label (may be empty)
integer function cs_c_bindings::timer_stats_id_by_name ( character(len=*), intent(in)  name)

Return the id of a defined statistic based on its name.

If no timer with the given name exists, -1 is returned.

Parameters
[in]namestatistic name

Variable Documentation

integer mesh_location_boundary_faces
integer mesh_location_cells
integer mesh_location_interior_faces
integer mesh_location_none
integer mesh_location_other
integer mesh_location_particles
integer mesh_location_vertices
integer restart_val_type_int_t
integer restart_val_type_real_t