| Data Types | |
| interface | field_allocate_or_map_all | 
| Allocate arrays for all defined fields based on their location.  More... | |
| interface | field_set_key_int | 
| Assign a floating point value for a given key to a field.  More... | |
| interface | field_set_key_int_bits | 
| Set integer bits matching a mask to 1 for a given key for a field.  More... | |
| interface | field_clear_key_int_bits | 
| Set integer bits matching a mask to 0 for a given key for a field.  More... | |
| interface | field_set_key_double | 
| Assign a floating point value for a given key to a field.  More... | |
| Functions/Subroutines | |
| subroutine | field_create (name, type_flag, location_id, dim, has_previous, id) | 
| Define a field.  More... | |
| subroutine | field_find_or_create (name, type_flag, location_id, dim, id) | 
| Return the id of a field matching a given name and attributes, creating it if necessary.  More... | |
| subroutine | field_get_n_fields (nfld) | 
| Return the number of defined fields.  More... | |
| subroutine | field_get_id (name, id) | 
| Return an id associated with a given field name.  More... | |
| subroutine | field_get_location (f_id, f_loc) | 
| Return the location of a given field.  More... | |
| subroutine | field_get_id_try (name, id) | 
| Return an id associated with a given field name if present.  More... | |
| subroutine | field_get_name (f_id, name) | 
| Return a given field's name.  More... | |
| subroutine | field_get_dim (f_id, f_dim) | 
| Return a given field's dimension.  More... | |
| subroutine | field_get_type (f_id, f_type) | 
| Return a given field's type.  More... | |
| subroutine | field_have_previous (f_id, have_previous) | 
| Indicate if a field maintains values at the previous time step.  More... | |
| subroutine | field_lock_key (f_id, k_id) | 
| Interface to C function locking a key value.  More... | |
| subroutine | field_set_n_previous (f_id, n_previous) | 
| Modify a field's handling of values at the previous time step.  More... | |
| subroutine | field_get_n_previous (f_id, f_n) | 
| Return a given field's number of previous values.  More... | |
| subroutine | field_allocate_values (id) | 
| Allocate field's value arrays.  More... | |
| subroutine | field_allocate_bc_coeffs (id, have_flux_bc, have_mom_bc, have_conv_bc, have_exch_bc) | 
| Allocate boundary condition coefficient arrays if applicable.  More... | |
| subroutine | field_init_bc_coeffs (id) | 
| Initialize boundary condition coefficient arrays if applicable.  More... | |
| subroutine | field_current_to_previous (id) | 
| Copy current values to previous values.  More... | |
| subroutine | field_is_key_set (f_id, k_id, is_set) | 
| Query if a given key has been set for a field.  More... | |
| subroutine | field_get_key_id (name, id) | 
| Return an id associated with a given key name if present.  More... | |
| subroutine | field_get_key_int (f_id, k_id, k_value) | 
| Return an integer value for a given key associated with a field.  More... | |
| subroutine | field_get_key_int_by_name (f_id, k_name, k_value) | 
| Return an integer value for a given key associated with a field.  More... | |
| subroutine | field_get_key_double (f_id, k_id, k_value) | 
| Return a floating-point value for a given key associated with a field.  More... | |
| subroutine | field_set_key_str (f_id, k_id, str) | 
| Assign a character string for a given key to a field.  More... | |
| subroutine | field_get_key_str (f_id, k_id, str) | 
| Return a character string for a given key associated with a field.  More... | |
| subroutine | fldsnv (name1, name2, name3) | 
| subroutine | field_get_label (f_id, str) | 
| Return a label associated with a field.  More... | |
| subroutine | field_get_val_s (field_id, p) | 
| Return pointer to the values array of a given scalar field.  More... | |
| subroutine | field_get_val_s_by_name (name, p) | 
| Return pointer to the values array of a given scalar field.  More... | |
| subroutine | field_get_val_prev_s_by_name (name, p) | 
| Return pointer to the array's previous values of a given scalar field.  More... | |
| subroutine | field_get_val_v (field_id, p) | 
| Return pointer to the values array of a given vector field.  More... | |
| subroutine | field_get_val_t (field_id, p) | 
| Return pointer to the values array of a given 3*3 tensor field.  More... | |
| subroutine | field_get_val_v_by_name (name, p) | 
| Return pointer to the values array of a given vector field.  More... | |
| subroutine | field_get_val_prev_v_by_name (name, p) | 
| Return pointer to the array's previous values of a given vector field.  More... | |
| subroutine | field_get_val_prev_s (field_id, p) | 
| Return pointer to the previous values array of a given scalar field.  More... | |
| subroutine | field_get_val_prev2_s (field_id, p) | 
| Return pointer to the previous values array of a given scalar field.  More... | |
| subroutine | field_get_val_prev_s_try (field_id, p) | 
| Return pointer to the previous values array of a given scalar field if it exists, to the current value otherwise.  More... | |
| subroutine | field_get_val_prev_v (field_id, p) | 
| Return pointer to the previous values array of a given vector field.  More... | |
| subroutine | field_get_coefa_s (field_id, p) | 
| Return pointer to the coefa array of a given scalar field.  More... | |
| subroutine | field_get_coefa_v (field_id, p) | 
| Return pointer to the coefa array of a given vector field.  More... | |
| subroutine | field_get_coefac_v (field_id, p) | 
| Return pointer to the coefac array of a given vector field.  More... | |
| subroutine | field_get_coefb_s (field_id, p) | 
| Return pointer to the coefb array of a given scalar field.  More... | |
| subroutine | field_get_coefb_v (field_id, p) | 
| Return pointer to the coefb array of a given coupled vector field.  More... | |
| subroutine | field_get_coefaf_s (field_id, p) | 
| Return pointer to the coefaf array of a given scalar field.  More... | |
| subroutine | field_get_coefac_s (field_id, p) | 
| Return pointer to the coefac array of a given scalar field.  More... | |
| subroutine | field_get_coefaf_v (field_id, p) | 
| Return pointer to the coefaf array of a given vector field.  More... | |
| subroutine | field_get_coefbf_s (field_id, p) | 
| Return pointer to the coefbf array of a given scalar field.  More... | |
| subroutine | field_get_coefbf_v (field_id, p) | 
| Return pointer to the coefbf array of a given coupled vector field.  More... | |
| subroutine | field_build_bc_codes_all (icodcl, rcodcl) | 
| Map and return icodcl and rcodcl boundary condition arrays.  More... | |
| subroutine | field_free_bc_codes_all (icodcl, rcodcl) | 
| Map and return icodcl and rcodcl boundary condition arrays.  More... | |
| Variables | |
| integer | field_intensive | 
| integer | field_extensive | 
| integer | field_variable | 
| integer | field_property | 
| integer | field_postprocess | 
| integer | field_accumulator | 
| integer | field_user | 
| integer | field_cdo | 
| integer | field_ok | 
| integer | field_invalid_key_name | 
| integer | field_invalid_key_id | 
| integer | field_invalid_category | 
| integer | field_invalid_type | 
| subroutine field::field_allocate_bc_coeffs | ( | integer, intent(in) | id, | 
| logical, intent(in) | have_flux_bc, | ||
| logical, intent(in) | have_mom_bc, | ||
| logical, intent(in) | have_conv_bc, | ||
| logical, intent(in) | have_exch_bc | ||
| ) | 
Allocate boundary condition coefficient arrays if applicable.
| [in] | id | field id | 
| [in] | have_flux_bc | if .true., flux BC coefficients (coefaf and coefbf) are added | 
| [in] | have_mom_bc | if .true., BC coefficients used in divergence term (coefad and coefbd) are added | 
| [in] | have_conv_bc | if .true., BC coefficients used in convection term (coefac and coefbc) are added | 
| [in] | have_conv_bc | if .true., BC coefficients used in convection term (coefac and coefbc) are added | 
| [in] | have_exch_bc | if .true., exchange boundary coefficients (hint and hext) | 
| subroutine field::field_allocate_values | ( | integer, intent(in) | id | ) | 
Allocate field's value arrays.
| [in] | id | field id | 
| subroutine field::field_build_bc_codes_all | ( | integer, dimension(:,:), intent(inout), pointer | icodcl, | 
| double precision, dimension(:,:,:), intent(inout), pointer | rcodcl | ||
| ) | 
Map and return icodcl and rcodcl boundary condition arrays.
| [out] | icodcl | pointer to icodcl array | 
| [out] | icodcl | pointer to icodcl array | 
| subroutine field::field_create | ( | character(len=*), intent(in) | name, | 
| integer, intent(in) | type_flag, | ||
| integer, intent(in) | location_id, | ||
| integer, intent(in) | dim, | ||
| logical, intent(in) | has_previous, | ||
| integer, intent(out) | id | ||
| ) | 
Define a field.
| [in] | name | field name | 
| [in] | type_flag | field categories (may be added) | 
| [in] | location_id | field location type: 0: none 1: cells 2: interior faces 3: interior faces 4: vertices | 
| [in] | dim | field dimension | 
| [in] | has_previous | .true. if values at previous time step are maintained | 
| [out] | id | id of defined field | 
| subroutine field::field_current_to_previous | ( | integer, intent(in) | id | ) | 
Copy current values to previous values.
| [in] | id | field id | 
| subroutine field::field_find_or_create | ( | character(len=*), intent(in) | name, | 
| integer, intent(in) | type_flag, | ||
| integer, intent(in) | location_id, | ||
| integer, intent(in) | dim, | ||
| integer, intent(out) | id | ||
| ) | 
Return the id of a field matching a given name and attributes, creating it if necessary.
If a field with the same name but different attributes is present, this is considered an error. The default number of time values associated with a field created through this function is 1. To modify it, use cs_field_set_n_time_vals.
| [in] | name | field name | 
| [in] | type_flag | field categories (may be added) | 
| [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 | 
| subroutine field::field_free_bc_codes_all | ( | integer, dimension(:,:), intent(inout), pointer | icodcl, | 
| double precision, dimension(:,:,:), intent(inout), pointer | rcodcl | ||
| ) | 
Map and return icodcl and rcodcl boundary condition arrays.
| [out] | icodcl | pointer to icodcl array | 
| [out] | rcodcl | pointer to rcodcl array | 
| subroutine field::field_get_coefa_s | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefa array of a given scalar field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to scalar field BC coefa values | 
| subroutine field::field_get_coefa_v | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefa array of a given vector field.
| [in] | field_id | id of given field (which must be a vector) | 
| [out] | p | pointer to vector field BC coefa values | 
| subroutine field::field_get_coefac_s | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefac array of a given scalar field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to scalar field BC coefa values | 
| subroutine field::field_get_coefac_v | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:,:), intent(out), pointer | p | ||
| ) | 
Return pointer to the coefac array of a given vector field.
| [in] | field_id | id of given field (which must be a vector) | 
| [out] | p | pointer to vector field BC coefa values | 
| subroutine field::field_get_coefaf_s | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefaf array of a given scalar field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to scalar field BC coefa values | 
| subroutine field::field_get_coefaf_v | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefaf array of a given vector field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to vector field BC coefa values | 
| subroutine field::field_get_coefb_s | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefb array of a given scalar field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to scalar field BC coefa values | 
| subroutine field::field_get_coefb_v | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:,:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefb array of a given coupled vector field.
| [in] | field_id | id of given field (which must be a vector) | 
| [out] | p | pointer to vector field BC coefa values | 
| subroutine field::field_get_coefbf_s | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefbf array of a given scalar field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to scalar field BC coefb values | 
| subroutine field::field_get_coefbf_v | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:,:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the coefbf array of a given coupled vector field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to vector field BC coefb values | 
| subroutine field::field_get_dim | ( | integer, intent(in) | f_id, | 
| integer, intent(out) | f_dim | ||
| ) | 
Return a given field's dimension.
| [in] | f_id | field id | 
| [out] | f_dim | number of field components (dimension) | 
| subroutine field::field_get_id | ( | character(len=*), intent(in) | name, | 
| integer, intent(out) | id | ||
| ) | 
Return an id associated with a given field name.
| [in] | name | field name | 
| [out] | id | id of field | 
| subroutine field::field_get_id_try | ( | character(len=*), intent(in) | name, | 
| integer, intent(out) | id | ||
| ) | 
Return an id associated with a given field name if present.
If the field has not been defined previously, -1 is returned.
| [in] | name | field name | 
| [out] | id | id of field | 
| subroutine field::field_get_key_double | ( | integer, intent(in) | f_id, | 
| integer, intent(in) | k_id, | ||
| double precision, intent(out) | k_value | ||
| ) | 
Return a floating-point value for a given key associated with a field.
If the key id is not valid, or the value type or field category is not compatible, a fatal error is provoked.
| [in] | f_id | field id | 
| [in] | k_id | id of associated key | 
| [out] | k_value | integer value associated with key id for this field | 
| subroutine field::field_get_key_id | ( | character(len=*), intent(in) | name, | 
| integer, intent(out) | id | ||
| ) | 
Return an id associated with a given key name if present.
If the key has not been defined previously, -1 is returned.
| [in] | name | key name | 
| [out] | id | associated key id | 
| subroutine field::field_get_key_int | ( | integer, intent(in) | f_id, | 
| integer, intent(in) | k_id, | ||
| integer, intent(out) | k_value | ||
| ) | 
Return an integer value for a given key associated with a field.
If the key id is not valid, or the value type or field category is not compatible, a fatal error is provoked.
| [in] | f_id | field id | 
| [in] | k_id | id of associated key | 
| [out] | k_value | integer value associated with key id for this field | 
| subroutine field::field_get_key_int_by_name | ( | integer, intent(in) | f_id, | 
| character(len=*), intent(in) | k_name, | ||
| integer, intent(out) | k_value | ||
| ) | 
Return an integer value for a given key associated with a field.
If the key id is not valid, or the value type or field category is not compatible, a fatal error is provoked.
| [in] | f_id | field id | 
| [in] | k_name | key name | 
| [out] | k_value | integer value associated with key id for this field | 
| subroutine field::field_get_key_str | ( | integer, intent(in) | f_id, | 
| integer, intent(in) | k_id, | ||
| character(len=*), intent(out) | str | ||
| ) | 
Return a character string for a given key associated with a field.
If the key id is not valid, or the value type or field category is not compatible, a fatal error is provoked.
| [in] | f_id | field id | 
| [in] | k_id | id of associated key | 
| [out] | str | string associated with key | 
| subroutine field::field_get_label | ( | integer, intent(in) | f_id, | 
| character(len=*), intent(out) | str | ||
| ) | 
Return a label associated with a field.
If the "label" key has been set for this field, its associated string is returned. Otherwise, the field's name is returned.
| [in] | f_id | field id | 
| [out] | str | string associated with key | 
| subroutine field::field_get_location | ( | integer, intent(in) | f_id, | 
| integer, intent(out) | f_loc | ||
| ) | 
Return the location of a given field.
| [in] | f_id | field id | 
| [out] | f_loc | location of the field | 
| subroutine field::field_get_n_fields | ( | integer, intent(out) | nfld | ) | 
Return the number of defined fields.
| [out] | nfld | number of field | 
| subroutine field::field_get_n_previous | ( | integer, intent(in) | f_id, | 
| integer, intent(out) | f_n | ||
| ) | 
Return a given field's number of previous values.
| [in] | f_id | field id | 
| [out] | f_n | number of previous values | 
| subroutine field::field_get_name | ( | integer, intent(in) | f_id, | 
| character(len=*), intent(out) | name | ||
| ) | 
Return a given field's name.
| [in] | f_id | field id | 
| [out] | name | field's name | 
| subroutine field::field_get_type | ( | integer, intent(in) | f_id, | 
| integer, intent(out) | f_type | ||
| ) | 
Return a given field's type.
| [in] | f_id | field id | 
| [out] | f_type | field type flag | 
| subroutine field::field_get_val_prev2_s | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the previous values array of a given scalar field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to previous scalar field values | 
| subroutine field::field_get_val_prev_s | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the previous values array of a given scalar field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to previous scalar field values | 
| subroutine field::field_get_val_prev_s_by_name | ( | character(len=*), intent(in) | name, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the array's previous values of a given scalar field.
| [in] | name | name of given field (which must be scalar) | 
| [out] | p | pointer to scalar field values at the previous iteration | 
| subroutine field::field_get_val_prev_s_try | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the previous values array of a given scalar field if it exists, to the current value otherwise.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to previous scalar field values | 
| subroutine field::field_get_val_prev_v | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the previous values array of a given vector field.
| [in] | field_id | id of given field (which must be vectorial) | 
| [out] | p | pointer to previous vector field values | 
| subroutine field::field_get_val_prev_v_by_name | ( | character(len=*), intent(in) | name, | 
| double precision, dimension(:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the array's previous values of a given vector field.
| [in] | name | name of given field (which must be vectorial) | 
| [out] | p | pointer to vector field values at the previous iteration | 
| subroutine field::field_get_val_s | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the values array of a given scalar field.
| [in] | field_id | id of given field (which must be scalar) | 
| [out] | p | pointer to scalar field values | 
| subroutine field::field_get_val_s_by_name | ( | character(len=*), intent(in) | name, | 
| double precision, dimension(:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the values array of a given scalar field.
| [in] | name | name of given field (which must be scalar) | 
| [out] | p | pointer to scalar field values | 
| subroutine field::field_get_val_t | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:,:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the values array of a given 3*3 tensor field.
| [in] | field_id | id of given field (which must be vectorial) | 
| [out] | p | pointer to vector field values | 
| subroutine field::field_get_val_v | ( | integer, intent(in) | field_id, | 
| double precision, dimension(:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the values array of a given vector field.
| [in] | field_id | id of given field (which must be vectorial) | 
| [out] | p | pointer to vector field values | 
| subroutine field::field_get_val_v_by_name | ( | character(len=*), intent(in) | name, | 
| double precision, dimension(:,:), intent(inout), pointer | p | ||
| ) | 
Return pointer to the values array of a given vector field.
| [in] | name | name of given field (which must be vectorial) | 
| [out] | p | pointer to scalar field values | 
| subroutine field::field_have_previous | ( | integer, intent(in) | f_id, | 
| logical, intent(out) | have_previous | ||
| ) | 
Indicate if a field maintains values at the previous time step.
| [in] | f_id | field id | 
| [out] | have_previous | true if previous values are maintained | 
| subroutine field::field_init_bc_coeffs | ( | integer, intent(in) | id | ) | 
Initialize boundary condition coefficient arrays if applicable.
| [in] | id | field id | 
| subroutine field::field_is_key_set | ( | integer, intent(in) | f_id, | 
| integer, intent(in) | k_id, | ||
| logical, intent(out) | is_set | ||
| ) | 
Query if a given key has been set for a field.
If the key id is not valid, or the field category is not compatible, a fatal error is provoked.
| [in] | f_id | field id | 
| [in] | k_id | id of associated key | 
| [out] | is_set | is .true. if the field is set | 
| subroutine field::field_lock_key | ( | integer, intent(in) | f_id, | 
| integer, intent(in) | k_id | ||
| ) | 
Interface to C function locking a key value.
| [in] | f_id | field id | 
| [in] | k_id | key id | 
| subroutine field::field_set_key_str | ( | integer, intent(in) | f_id, | 
| integer, intent(in) | k_id, | ||
| character(len=*), intent(in) | str | ||
| ) | 
Assign a character string for a given key to a field.
If the key id is not valid, or the value type or field category is not compatible, a fatal error is provoked.
| [in] | f_id | field id | 
| [in] | k_id | id of associated key | 
| [in] | str | string associated with key | 
| subroutine field::field_set_n_previous | ( | integer, intent(in) | f_id, | 
| integer, intent(in) | n_previous | ||
| ) | 
Modify a field's handling of values at the previous time step.
| [in] | f_id | field id | 
| [out] | n_previous | number of previous values (0 or 1) | 
| subroutine field::fldsnv | ( | character(len=*), intent(inout) | name1, | 
| character(len=*), intent(in) | name2, | ||
| character(len=*), intent(in) | name3 | ||
| ) | 
| integer field_accumulator | 
| integer field_cdo | 
| integer field_extensive | 
| integer field_intensive | 
| integer field_invalid_category | 
| integer field_invalid_key_id | 
| integer field_invalid_key_name | 
| integer field_invalid_type | 
| integer field_ok | 
| integer field_postprocess | 
| integer field_property | 
| integer field_user | 
| integer field_variable |