This module contains all region routines. More...

Data Types
interface	region_label_get

interface	region_label_set

Functions/Subroutines
subroutine, public	region_coordinate_system_get (REGION, COORDINATE_SYSTEM, ERR, ERROR,)
	Returns the coordinate system of region. More...

subroutine, public	region_coordinate_system_set (REGION, COORDINATE_SYSTEM, ERR, ERROR,)
	Sets the coordinate system of region. More...

subroutine, public	region_create_finish (REGION, ERR, ERROR,)
	Finishes the creation of a region. More...

subroutine, public	region_create_start (USER_NUMBER, PARENT_REGION, REGION, ERR, ERROR,)
	Starts the creation a new region number USER_NUMBER as a sub region to the given PARENT_REGION, initialises all variables and inherits the PARENT_REGIONS coordinate system. More...

subroutine, public	region_data_points_get (REGION, DATA_POINTS, ERR, ERROR,)
	Returns a pointer to the data points for a region. More...

recursive subroutine	region_destroy_number (USER_NUMBER, ERR, ERROR,)
	Destroys a region given by USER_NUMBER and all sub-regions under it. More...

subroutine, public	region_destroy (REGION, ERR, ERROR,)
	Destroys a region identified by a pointer and all sub-regions under it. More...

subroutine, public	region_finalise (REGION, ERR, ERROR,)
	Finalises a region and deallocates all memory. More...

subroutine, public	region_initialise (REGION, ERR, ERROR,)
	Initialises a region. More...

subroutine	region_label_get_c (REGION, LABEL, ERR, ERROR,)
	Returns the label of a region. More...

subroutine	region_label_get_vs (REGION, LABEL, ERR, ERROR,)
	Returns the label of a region. More...

subroutine	region_label_set_c (REGION, LABEL, ERR, ERROR,)
	Sets the label of a region. More...

subroutine	region_label_set_vs (REGION, LABEL, ERR, ERROR,)
	Sets the label of a region. More...

subroutine, public	region_nodes_get (REGION, NODES, ERR, ERROR,)
	Returns a pointer to the nodes for a region. More...

subroutine, public	region_user_number_find (USER_NUMBER, REGION, ERR, ERROR,)
	Finds and returns in REGION a pointer to the region with the number given in USER_NUMBER. If no region with that number exits REGION is left nullified. More...

recursive subroutine	region_user_number_find_ptr (USER_NUMBER, START_REGION, REGION, ERR, ERROR,)
	Finds and returns in REGION a pointer to the region with the number given in USER_NUMBER starting from the START_REGION and searching all sub-regions under the START_REGION. If no region with that number exit REGION is left nullified. More...

subroutine, public	regions_finalise (ERR, ERROR,)
	Finalises the regions and destroys any current regions. More...

subroutine, public	regions_initialise (WORLD_REGION, ERR, ERROR,)
	Initialises the regions and creates the global world region. More...

subroutine, public	region_user_number_to_region (USER_NUMBER, REGION, ERR, ERROR,)
	Find the region with the given user number, or throw an error if it does not exist. More...

Variables
type(regions_type)	regions

Detailed Description

This module contains all region routines.

Function/Subroutine Documentation

subroutine, public region_routines::region_coordinate_system_get	(	type(region_type), pointer	REGION,
		type(coordinate_system_type), pointer	COORDINATE_SYSTEM,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Returns the coordinate system of region.

See also: OPENCMISS::CMISSRegionCoordinateSystemGet

Parameters

	region	A pointer to the region to get the coordinate system for
	coordinate_system	On exit, the coordinate system for the specified region. Must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 115 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by fieldml_output_routines::fieldml_output_get_value_type().

subroutine, public region_routines::region_coordinate_system_set	(	type(region_type), pointer	REGION,
		type(coordinate_system_type), pointer	COORDINATE_SYSTEM,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets the coordinate system of region.

See also: OPENCMISS::CMISSRegionCoordinateSystemSet

Parameters

	region	A pointer to the region to set the coordinate system for
	coordinate_system	The coordinate system to set
[out]	err	The error code
[out]	error	The error string

Definition at line 151 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine, public region_routines::region_create_finish	(	type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finishes the creation of a region.

See also: OPENCMISS::CMISSRegionCreateFinish

Parameters

	region	A pointer to the region to finish the creation of
[out]	err	The error code
[out]	error	The error string

Definition at line 191 of file region_routines.f90.

References base_routines::diagnostic_output_type, base_routines::diagnostics1, base_routines::enters(), and base_routines::exits().

subroutine, public region_routines::region_create_start	(	integer(intg), intent(in)	USER_NUMBER,
		type(region_type), pointer	PARENT_REGION,
		type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Starts the creation a new region number USER_NUMBER as a sub region to the given PARENT_REGION, initialises all variables and inherits the PARENT_REGIONS coordinate system.

See also

OPENCMISS::CMISSRegionCreateFinish Default values set for the REGION's attributes are:

COORDINATE_SYSTEM: parent coordinate system. See COORDINATE_SYSTEM_TYPE
DATA_POINTS: null
NODES: null
MESHES: 0 mesh
FIELDS: 0 field
EQUATIONS_SETS: 0 equation set
PARENT_REGION: global region
NUMBER_OF_SUB_REGIONS: 0
SUB_REGIONS: 0 region

Parameters

[in]	user_number	The user number of the region to create
	parent_region	A pointer to the parent region
	region	On exit, a pointer to the created region. Must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 244 of file region_routines.f90.

References base_routines::enters(), base_routines::exits(), region_finalise(), region_initialise(), and region_user_number_find().

subroutine, public region_routines::region_data_points_get	(	type(region_type), pointer	REGION,
		type(data_points_type), pointer	DATA_POINTS,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Returns a pointer to the data points for a region.

See also: OPENCMISS::CMISSRegionDataPointsGet

Parameters

	region	A pointer to the region to get the data points for
	data_points	On exit, a pointer to the data points for the region. Must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 323 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine, public region_routines::region_destroy	(	type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroys a region identified by a pointer and all sub-regions under it.

See also: OPENCMISS::CMISSRegionDestroy

Parameters

	region	A pointer to the region to destroy
[out]	err	The error code
[out]	error	The error string

Definition at line 432 of file region_routines.f90.

References base_routines::enters(), base_routines::exits(), and region_destroy_number().

recursive subroutine region_routines::region_destroy_number	(	integer(intg), intent(in)	USER_NUMBER,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Destroys a region given by USER_NUMBER and all sub-regions under it.

Todo:: create destroy by pointer method.

See also: OPENCMISS::CMISSRegionDestroy

Parameters

[in]	user_number	The user number of the region to destroy
[out]	err	The error code
[out]	error	The error string

Definition at line 363 of file region_routines.f90.

References base_routines::enters(), base_routines::exits(), region_finalise(), and region_user_number_find().

Referenced by region_destroy(), and regions_finalise().

subroutine, public region_routines::region_finalise	(	type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finalises a region and deallocates all memory.

Parameters

	region	A pointer to the region to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 461 of file region_routines.f90.

References cmiss_cellml::cellml_environments_finalise(), base_routines::enters(), equations_set_routines::equations_sets_finalise(), and base_routines::exits().

Referenced by region_create_start(), region_destroy_number(), region_initialise(), and regions_finalise().

subroutine, public region_routines::region_initialise	(	type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Initialises a region.

Parameters

	region	A pointer to the region to initialise. Must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 496 of file region_routines.f90.

References cmiss_cellml::cellml_environments_initialise(), base_routines::enters(), equations_set_routines::equations_sets_initialise(), base_routines::exits(), and region_finalise().

Referenced by region_create_start(), and regions_initialise().

subroutine region_routines::region_label_get_c	(	type(region_type), pointer	REGION,
		character(len=*), intent(out)	LABEL,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Returns the label of a region.

See also: OPENCMISS::CMISSRegionLabelGet

Parameters

	region	A pointer to the region to get the label for
[out]	label	On return the region label.
[out]	err	The error code
[out]	error	The error string

Definition at line 549 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine region_routines::region_label_get_vs	(	type(region_type), pointer	REGION,
		type(varying_string), intent(out)	LABEL,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Returns the label of a region.

See also: OPENCMISS::CMISSRegionLabelGet

Parameters

	region	A pointer to the region to get the label for
[out]	label	On return the region label.
[out]	err	The error code
[out]	error	The error string

Definition at line 585 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine region_routines::region_label_set_c	(	type(region_type), pointer	REGION,
		character(len=*), intent(in)	LABEL,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets the label of a region.

See also: OPENCMISS::CMISSRegionLabelSet

Parameters

	region	A pointer to the region to set the label for
[in]	label	The label to set
[out]	err	The error code
[out]	error	The error string

Definition at line 615 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine region_routines::region_label_set_vs	(	type(region_type), pointer	REGION,
		type(varying_string), intent(in)	LABEL,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets the label of a region.

See also: OPENCMISS::CMISSRegionLabelSet

Parameters

	region	A pointer to the region to set the label for
[in]	label	The label to set
[out]	err	The error code
[out]	error	The error string

Definition at line 647 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine, public region_routines::region_nodes_get	(	type(region_type), pointer	REGION,
		type(nodes_type), pointer	NODES,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Returns a pointer to the nodes for a region.

See also: OPENCMISS::CMISSRegionNodesGet

Parameters

	region	A pointer to the region to get the nodes for
	nodes	On exit, a pointer to the nodes for the region. Must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 679 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by fieldml_output_routines::fieldml_output_initialise_info(), and fieldml_input_routines::fieldmlinput_fieldnodalparametersupdate().

subroutine, public region_routines::region_user_number_find	(	integer(intg), intent(in)	USER_NUMBER,
		type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finds and returns in REGION a pointer to the region with the number given in USER_NUMBER. If no region with that number exits REGION is left nullified.

Parameters

[in]	user_number	The user number of the region to find
	region	On exit, a pointer to the region with the specified user number if it exists. If no region exists with the specified user number a NULL pointer is returned. Must not be associated on entry.
[out]	error	The error string

Definition at line 719 of file region_routines.f90.

References base_routines::enters(), base_routines::exits(), region_user_number_find_ptr(), and regions.

Referenced by region_create_start(), region_destroy_number(), and region_user_number_to_region().

recursive subroutine region_routines::region_user_number_find_ptr	(	integer(intg), intent(in)	USER_NUMBER,
		type(region_type), pointer	START_REGION,
		type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finds and returns in REGION a pointer to the region with the number given in USER_NUMBER starting from the START_REGION and searching all sub-regions under the START_REGION. If no region with that number exit REGION is left nullified.

Parameters

[in]	user_number	The user number to find
	start_region	A pointer to the region to start the search from
	region	On exit, a pointer to the region with the specified user number if it exists. If no region exists with the specified user number a NULL pointer is returned.
[out]	err	The error code
[out]	error	The error string

Definition at line 765 of file region_routines.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by region_user_number_find().

subroutine, public region_routines::region_user_number_to_region	(	integer(intg), intent(in)	USER_NUMBER,
		type(region_type), pointer	REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Find the region with the given user number, or throw an error if it does not exist.

Parameters

[in]	user_number	The user number of the region to find
	region	On return, a pointer to the region with the specified user number.
[out]	err	The error code.
[out]	error	The error string

Definition at line 875 of file region_routines.f90.

References base_routines::enters(), base_routines::exits(), and region_user_number_find().

subroutine, public region_routines::regions_finalise	(	integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finalises the regions and destroys any current regions.

Parameters

[out]	err	The error code
[out]	error	The error string

Definition at line 804 of file region_routines.f90.

References base_routines::enters(), base_routines::exits(), region_destroy_number(), region_finalise(), and regions.

Referenced by cmiss::cmfe_finalise_().

subroutine, public region_routines::regions_initialise	(	type(region_type), pointer	WORLD_REGION,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Initialises the regions and creates the global world region.

Parameters

	world_region	On exit, a pointer to the world region. Must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 834 of file region_routines.f90.

References coordinate_routines::coordinate_system_user_number_find(), base_routines::enters(), base_routines::exits(), region_initialise(), and regions.

Referenced by cmiss::cmfe_initialise_().

Variable Documentation

type(regions_type) region_routines::regions

private

Definition at line 75 of file region_routines.f90.

Referenced by region_user_number_find(), regions_finalise(), and regions_initialise().

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

Variable Documentation