field Module Reference

Data Types
interface	field_set_key_double
	Assign a floating point value for a given key to a field. More...
interface	field_set_key_int
	Assign a floating point value for a given key to a field. More...

Functions/Subroutines
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_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_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_s (field_id, p)
	Return pointer to the previous values array of a given scalar field. More...

Variables
integer	field_intensive
integer	field_extensive
integer	field_variable
integer	field_property

Function/Subroutine Documentation

field_get_dim()

subroutine field_get_dim	(	integer, intent(in)	f_id,
		integer, intent(out)	f_dim
	)

Return a given field's dimension.

Parameters

[in]	f_id	field id
[out]	f_dim	number of field components (dimension)

field_get_id()

subroutine field_get_id	(	character(len=*), intent(in)	name,
		integer, intent(out)	id
	)

Return an id associated with a given field name.

Parameters

[in]	name	field name
[out]	id	id of field

field_get_id_try()

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

Parameters

[in]	name	field name
[out]	id	id of field

field_get_key_double()

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

Parameters

[in]	f_id	field id
[in]	k_id	id of associated key
[out]	k_value	integer value associated with key id for this field

field_get_key_id()

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

Parameters

[in]	name	key name
[out]	id	associated key id

field_get_key_int()

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

Parameters

[in]	f_id	field id
[in]	k_id	id of associated key
[out]	k_value	integer value associated with key id for this field

field_get_key_int_by_name()

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

Parameters

[in]	f_id	field id
[in]	k_name	key name
[out]	k_value	integer value associated with key id for this field

field_get_label()

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

Parameters

[in]	f_id	field id
[out]	str	string associated with key

field_get_location()

subroutine field_get_location	(	integer, intent(in)	f_id,
		integer, intent(out)	f_loc
	)

Return the location of a given field.

Parameters

[in]	f_id	field id
[out]	f_loc	location of the field

field_get_n_fields()

subroutine field_get_n_fields

(

integer, intent(out)

nfld

)

Return the number of defined fields.

Parameters

[out]

nfld

number of field

field_get_name()

subroutine field_get_name	(	integer, intent(in)	f_id,
		character(len=*), intent(out)	name
	)

Return a given field's name.

Parameters

[in]	f_id	field id
[out]	name	field's name

field_get_type()

subroutine field_get_type	(	integer, intent(in)	f_id,
		integer, intent(out)	f_type
	)

Return a given field's type.

Parameters

[in]	f_id	field id
[out]	f_type	field type flag

field_get_val_prev_s()

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

Parameters

[in]	field_id	id of given field (which must be scalar)
[out]	p	pointer to previous scalar field values

field_get_val_prev_s_by_name()

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

Parameters

[in]	name	name of given field (which must be scalar)
[out]	p	pointer to scalar field values at the previous iteration

field_get_val_s()

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

Parameters

[in]	field_id	id of given field (which must be scalar)
[out]	p	pointer to scalar field values

field_get_val_s_by_name()

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

Parameters

[in]	name	name of given field (which must be scalar)
[out]	p	pointer to scalar field values

field_get_val_v()

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

Parameters

[in]	field_id	id of given field (which must be vectorial)
[out]	p	pointer to vector field values

field_get_val_v_by_name()

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

Parameters

[in]	name	name of given field (which must be vectorial)
[out]	p	pointer to scalar field values

Variable Documentation

field_extensive

integer field_extensive

field_intensive

integer field_intensive

field_property

integer field_property

field_variable

integer field_variable