My Project
programmer's documentation
Data Types | Modules | Functions/Subroutines | Variables
field.f90 File Reference

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...
 

Modules

module  field
 

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_ownership (f_id, f_is_owner)
 Return the field ownership flag. 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_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_coefad_s (field_id, p)
 Return pointer to the coefad array of a given scalar field (used in the divergence operator such as div(Rij)) More...
 
subroutine field_get_coefad_v (field_id, p)
 Return pointer to the coefa array of a given vector field (used in the divergence operator such as div(u'T')) 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_coefbc_s (field_id, p)
 Return pointer to the coefbc array of a given scalar field. More...
 
subroutine field_get_coefb_uv (field_id, p)
 Return pointer to the coefb array of a given uncoupled vector field. More...
 
subroutine field_get_coefbc_uv (field_id, p)
 Return pointer to the coefbc array of a given uncoupled vector 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_coefbc_v (field_id, p)
 Return pointer to the coefbc 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_uv (field_id, p)
 Return pointer to the coefbf array of a given uncoupled vector 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_get_coefbd_s (field_id, p)
 Return pointer to the coefbd array of a given scalar field (used in the divergence operator such as div(Rij)) More...
 
subroutine field_get_coefbd_v (field_id, p)
 Return pointer to the coefbd array of a given coupled vector field (used in the divergence operator such as div(u'T')) More...
 
subroutine field_get_hext (field_id, p)
 Return pointer to the hext array of a given variable field. More...
 
subroutine field_get_hint (field_id, p)
 Return pointer to the hint array of a given variable field. 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
 

Detailed Description

Module for field-related operations