OpenCMISSIron Internal API Documentation

This module contains all computational environment variables. More...
Go to the source code of this file.
Data Types  
type  comp_environment::computational_work_group_ptr_type 
!>pointer type to COMPUTATIONAL_WORK_GROUP_TYPE More...  
type  comp_environment::computational_work_group_type 
Contains information on logical working groups (added by Robert on 01/04/2010) More...  
type  comp_environment::cache_type 
Contains information on a cache heirarchy. More...  
type  comp_environment::computational_node_type 
Contains information on a computational node containing a number of processors. More...  
type  comp_environment::mpi_computational_node_type 
Contains information on the MPI type to transfer information about a computational node. More...  
type  comp_environment::computational_environment_type 
Contains information on the computational environment the program is running in. More...  
Modules  
module  comp_environment 
This module contains all computational environment variables.  
Functions/Subroutines  
subroutine, public  comp_environment::computational_work_group_subgroup_add (PARENT_WORK_GROUP, NUMBER_COMPUTATIONAL_NODES, ADDED_WORK_GROUP, ERR, ERROR,) 
Add the work subgroup to the parent group based on the computational requirements (called by user) More...  
subroutine, public  comp_environment::computational_work_group_create_start (WORLD_WORK_GROUP, NUMBER_COMPUTATIONAL_NODES, ERR, ERROR,) 
Create the highest level work group (Default: GROUP_WORLD) More...  
recursive subroutine  comp_environment::computational_workgroupgeneratecompenviron (WORK_GROUP, AVAILABLE_RANK_LIST, ERR, ERROR,) 
Generate computational environment for current level work group tree and all it's subgroups recursively. More...  
subroutine, public  comp_environment::computational_work_group_create_finish (WORLD_WORK_GROUP, ERR, ERROR,) 
Generate the hierarchy computational environment based on work group tree. More...  
subroutine  comp_environment::computational_node_finalise (COMPUTATIONAL_NODE, ERR, ERROR,) 
Finalises the computational node data structures and deallocates all memory. More...  
subroutine  comp_environment::computational_node_initialise (COMPUTATIONAL_NODE, RANK, ERR, ERROR,) 
Initialises the computational node data structures. More...  
subroutine  comp_environment::computational_node_mpi_type_finalise (ERR, ERROR,) 
Finalises the data structure containing the MPI type information for the COMPUTATIONAL_NODE_TYPE. More...  
subroutine  comp_environment::computational_node_mpi_type_initialise (COMPUTATIONAL_NODE, ERR, ERROR,) 
Initialises the data structure containing the MPI type information for the COMPUTATIONAL_NODE_TYPE. More...  
subroutine, public  comp_environment::computational_environment_finalise (ERR, ERROR,) 
Finalises the computational environment data structures and deallocates all memory. More...  
subroutine, public  comp_environment::computational_environment_initialise (ERR, ERROR,) 
Initialises the computational environment data structures. More...  
integer(intg) function, public  comp_environment::computational_node_number_get (ERR, ERROR) 
Returns the number/rank of the computational nodes. More...  
integer(intg) function, public  comp_environment::computational_nodes_number_get (ERR, ERROR) 
Returns the number of computational nodes. More...  
Variables  
type(computational_environment_type), target, public  comp_environment::computational_environment 
The computational environment the program is running in. More...  
type(mpi_computational_node_type)  comp_environment::mpi_computational_node_type_data 
The MPI data on the computational nodes. More...  
This module contains all computational environment variables.
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) 20072010 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 computational_environment.f90.