OpenCMISS-Iron Internal API Documentation
types::field_type Type Reference

Contains information for a field defined on a region. More...

Collaboration diagram for types::field_type:

Public Attributes

integer(intg) global_number
 The global number of the field in the list of fields for a region. More...
 
integer(intg) user_number
 The user defined identifier for the field. The user number must be unique. More...
 
type(varying_string) label
 The label for the field. More...
 
logical field_finished
 Is .TRUE. if the field has finished being created, .FALSE. if not. More...
 
type(fields_type), pointer fields
 A pointer to the fields for this region. More...
 
type(region_type), pointer region
 A pointer to the region containing the field. If the field are in an interface rather than a region then this pointer will be NULL and the interface pointer should be used. More...
 
type(interface_type), pointer interface
 A pointer to the interface containing the field. If the field are in a region rather than an interface then this pointer will be NULL and the interface pointer should be used. More...
 
integer(intg) type
 The type of the field. NOTE: this should be a field variable attribute as you may have a, say, geometric field variable and a general field variable bundled together in the same field. More...
 
integer(intg) dependent_type
 The dependent type of the field. More...
 
type(decomposition_type), pointer decomposition
 A pointer to the decomposition of the mesh for which the field is defined on. More...
 
integer(intg) number_of_variables
 The number of variable types in the field. Old CMISS name NCT(nr,nx) More...
 
type(field_variable_ptr_type), dimension(:), allocatable variable_type_map
 VARIABLE_TYPE_MAP(variable_idx). The map from the available field variable types to the field variable types that are defined for the field. variable_idx varies from 1 to FIELD_ROUTINES::FIELD_NUMBER_OF_VARIABLE_TYPES. If the particular field variable type has not been defined on the field then the VARIABLE_TYPE_MAP will be NULL. More...
 
type(field_variable_type), dimension(:), allocatable variables
 VARIABLES(variable_idx). The array of field variables. More...
 
type(field_scalings_typescalings
 The scaling parameters for the field. More...
 
type(field_type), pointer geometric_field
 A pointer to the geometric field that this field uses. If the field itself is a geometric field then this will be a pointer back to itself. More...
 
type(field_geometric_parameters_type), pointer geometric_field_parameters
 If the field is a geometric field the pointer to the geometric parameters (lines, areas, volumes etc.). If the field is not a geometric field the pointer is NULL. More...
 
type(field_create_values_cache_type), pointer create_values_cache
 The create values cache for the field. More...
 
type(data_projection_type), pointer dataprojection
 A pointer to the data projection that this field uses. More...
 

Detailed Description

Contains information for a field defined on a region.

See also
OPENCMISS::CMISSFieldType

Definition at line 1346 of file types.f90.

Member Data Documentation

type(field_create_values_cache_type), pointer types::field_type::create_values_cache

The create values cache for the field.

Definition at line 1363 of file types.f90.

type(data_projection_type), pointer types::field_type::dataprojection

A pointer to the data projection that this field uses.

Definition at line 1364 of file types.f90.

type(decomposition_type), pointer types::field_type::decomposition

A pointer to the decomposition of the mesh for which the field is defined on.

Definition at line 1356 of file types.f90.

integer(intg) types::field_type::dependent_type

The dependent type of the field.

See also
FIELD_ROUTINES_DependentTypes

Definition at line 1355 of file types.f90.

logical types::field_type::field_finished

Is .TRUE. if the field has finished being created, .FALSE. if not.

Definition at line 1350 of file types.f90.

type(fields_type), pointer types::field_type::fields

A pointer to the fields for this region.

Definition at line 1351 of file types.f90.

type(field_type), pointer types::field_type::geometric_field

A pointer to the geometric field that this field uses. If the field itself is a geometric field then this will be a pointer back to itself.

Definition at line 1361 of file types.f90.

type(field_geometric_parameters_type), pointer types::field_type::geometric_field_parameters

If the field is a geometric field the pointer to the geometric parameters (lines, areas, volumes etc.). If the field is not a geometric field the pointer is NULL.

Definition at line 1362 of file types.f90.

integer(intg) types::field_type::global_number

The global number of the field in the list of fields for a region.

Definition at line 1347 of file types.f90.

type(interface_type), pointer types::field_type::interface

A pointer to the interface containing the field. If the field are in a region rather than an interface then this pointer will be NULL and the interface pointer should be used.

Definition at line 1353 of file types.f90.

type(varying_string) types::field_type::label

The label for the field.

Definition at line 1349 of file types.f90.

integer(intg) types::field_type::number_of_variables

The number of variable types in the field. Old CMISS name NCT(nr,nx)

Definition at line 1357 of file types.f90.

type(region_type), pointer types::field_type::region

A pointer to the region containing the field. If the field are in an interface rather than a region then this pointer will be NULL and the interface pointer should be used.

Definition at line 1352 of file types.f90.

type(field_scalings_type) types::field_type::scalings

The scaling parameters for the field.

Definition at line 1360 of file types.f90.

integer(intg) types::field_type::type

The type of the field. NOTE: this should be a field variable attribute as you may have a, say, geometric field variable and a general field variable bundled together in the same field.

See also
FIELD_ROUTINES_FieldTypes

Definition at line 1354 of file types.f90.

integer(intg) types::field_type::user_number

The user defined identifier for the field. The user number must be unique.

Definition at line 1348 of file types.f90.

type(field_variable_ptr_type), dimension(:), allocatable types::field_type::variable_type_map

VARIABLE_TYPE_MAP(variable_idx). The map from the available field variable types to the field variable types that are defined for the field. variable_idx varies from 1 to FIELD_ROUTINES::FIELD_NUMBER_OF_VARIABLE_TYPES. If the particular field variable type has not been defined on the field then the VARIABLE_TYPE_MAP will be NULL.

See also
FIELD_ROUTINES_VariableTypes

Definition at line 1358 of file types.f90.

type(field_variable_type), dimension(:), allocatable types::field_type::variables

VARIABLES(variable_idx). The array of field variables.

Definition at line 1359 of file types.f90.