region_routines.f90 File Reference

This module contains all region routines. More...

Go to the source code of this file.

Data Types
interface	region_routines::region_label_get
interface	region_routines::region_label_set

Modules
module	region_routines
	This module contains all region routines.

Functions/Subroutines
subroutine, public	region_routines::region_coordinate_system_get (REGION, COORDINATE_SYSTEM, ERR, ERROR,)
	Returns the coordinate system of region. More...
subroutine, public	region_routines::region_coordinate_system_set (REGION, COORDINATE_SYSTEM, ERR, ERROR,)
	Sets the coordinate system of region. More...
subroutine, public	region_routines::region_create_finish (REGION, ERR, ERROR,)
	Finishes the creation of a region. More...
subroutine, public	region_routines::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_routines::region_data_points_get (REGION, DATA_POINTS, ERR, ERROR,)
	Returns a pointer to the data points for a region. More...
recursive subroutine	region_routines::region_destroy_number (USER_NUMBER, ERR, ERROR,)
	Destroys a region given by USER_NUMBER and all sub-regions under it. More...
subroutine, public	region_routines::region_destroy (REGION, ERR, ERROR,)
	Destroys a region identified by a pointer and all sub-regions under it. More...
subroutine, public	region_routines::region_finalise (REGION, ERR, ERROR,)
	Finalises a region and deallocates all memory. More...
subroutine, public	region_routines::region_initialise (REGION, ERR, ERROR,)
	Initialises a region. More...
subroutine	region_routines::region_label_get_c (REGION, LABEL, ERR, ERROR,)
	Returns the label of a region. More...
subroutine	region_routines::region_label_get_vs (REGION, LABEL, ERR, ERROR,)
	Returns the label of a region. More...
subroutine	region_routines::region_label_set_c (REGION, LABEL, ERR, ERROR,)
	Sets the label of a region. More...
subroutine	region_routines::region_label_set_vs (REGION, LABEL, ERR, ERROR,)
	Sets the label of a region. More...
subroutine, public	region_routines::region_nodes_get (REGION, NODES, ERR, ERROR,)
	Returns a pointer to the nodes for a region. More...
subroutine, public	region_routines::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_routines::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	region_routines::regions_finalise (ERR, ERROR,)
	Finalises the regions and destroys any current regions. More...
subroutine, public	region_routines::regions_initialise (WORLD_REGION, ERR, ERROR,)
	Initialises the regions and creates the global world region. More...
subroutine, public	region_routines::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)	region_routines::regions

Detailed Description

This module contains all region routines.

Author

Chris Bradley

LICENSE

Version: MPL 1.1/GPL 2.0/LGPL 2.1

The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

The Original Code is OpenCMISS

The Initial Developer of the Original Code is University of Auckland, Auckland, New Zealand, the University of Oxford, Oxford, United Kingdom and King's College, London, United Kingdom. Portions created by the University of Auckland, the University of Oxford and King's College, London are Copyright (C) 2007-2010 by the University of Auckland, the University of Oxford and King's College, London. All Rights Reserved.

Contributor(s):

Alternatively, the contents of this file may be used under the terms of either the GNU General Public License Version 2 or later (the "GPL"), or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which case the provisions of the GPL or the LGPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of either the GPL or the LGPL, and not to allow others to use your version of this file under the terms of the MPL, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL or the LGPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the MPL, the GPL or the LGPL.

Definition in file region_routines.f90.