programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Types | Public Member Functions | Data Fields
cs_c_bindings Module Reference
Collaboration diagram for cs_c_bindings:
Collaboration graph

Data Types

interface  log_iteration
 Log field and other array statistics for a given time step. More...
 
interface  parameters_read_restart_info
 Read restart metadata. More...
 
interface  time_moment_field_id
 Read temporal moments checkpoint information. 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...
 
type  var_cal_opt
 

Public Member Functions

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 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)
 Add array not saved as permanent field to logging of fields. More...
 
subroutine restart_read_int_t_compat (f_num, 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_read_real_t_compat (f_num, 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 (f_num, 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_read_bc_coeffs (f_num)
 Read boundary condition coefficients for all fields from checkpoint. More...
 
subroutine restart_write_bc_coeffs (f_num)
 Write boundary condition coefficients for all fields to checkpoint. More...
 
subroutine time_moment_define_by_field_ids (name, n_fields, field_id, component_id, type, nt_start, t_start, restart_id, moment_id)
 Define a moment of a product of existing fields components. More...
 

Data Fields

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
 

Member Function/Subroutine Documentation

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

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
subroutine restart_read_bc_coeffs ( integer, intent(in)  f_num)

Read boundary condition coefficients for all fields from checkpoint.

Parameters
[in]f_numrestart file number
subroutine restart_read_int_t_compat ( integer, intent(in)  f_num,
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(*)  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]f_numrestart file number
[in]sec_namename of section
[in]old_nameold name of section
[in]location_idid of associated mesh location
[in]n_loc_valsnumber of valeus per location
[out]valmin local value prior to clip
[out]ierror0: success, < 0: error code
subroutine restart_read_real_3_t_compat ( integer, intent(in)  f_num,
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]f_numrestart file number
[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]valmin local value prior to clip
[out]ierror0: success, < 0: error code
subroutine restart_read_real_t_compat ( integer, intent(in)  f_num,
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(*)  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]f_numrestart file number
[in]sec_namename of section
[in]old_nameold name of section
[in]location_idid of associated mesh location
[in]n_loc_valsnumber of valeus per location
[out]valmin local value prior to clip
[out]ierror0: success, < 0: error code
subroutine restart_write_bc_coeffs ( integer, intent(in)  f_num)

Write boundary condition coefficients for all fields to checkpoint.

Parameters
[in]f_numrestart file number
subroutine time_moment_define_by_field_ids ( character(len=*), intent(in)  name,
integer, intent(in)  n_fields,
integer(c_int), dimension(*), intent(in)  field_id,
integer(c_int), dimension(*), intent(in)  component_id,
integer, intent(in)  type,
integer, intent(in)  nt_start,
double precision, intent(in)  t_start,
integer, intent(in)  restart_id,
integer, intent(out)  moment_id 
)

Define a moment of a product of existing fields components.

Moments will involve the tensor products of their component fields, and only scalar, vector, or rank-2 tensors are handled (for post-processing output reasons), so a moment may not involve more than 2 vectors or 1 tensor, unless single components are specified.

Parameters
[in]namename of associated moment
[in]n_fieldsnumber of associated fields
[in]field_idids of associated fields
[in]component_idids of matching field components (-1 for all)
[in]typemoment type
[in]nt_startstarting time step (or -1 to use t_start)
[in]t_startstarting time
[in]restart_id-2: automatic, -1: reset, >= 0: id of matching moment in restart data
[out]moment_idid of new moment in case of success, -1 in case of error.

Field 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

The documentation for this module was generated from the following file: