ITM Grid Service Library: Fortran 90

itm_grid_objectlist Module Reference

Functions/Subroutines

subroutine allocateIndexList (iList)
 Basic setup of structure (required because all arrays in the ITM CPO data structures are pointers, we cannot have fixed size arrays.
type(type_complexgrid_indexlist) createIndexListForSingle (index)
 Create an index set: single object.
type(type_complexgrid_indexlist) createIndexListForAll (grid, cls, ispace)
 Create an index set: all objects of given class.
type(type_complexgrid_indexlist) createIndexListForRange (ifrom, ito)
 Create an index list: index range.
type(type_complexgrid_indexlist) createIndexListForList (grid, nind, ind)
 Create an index list: explicit list of indices.
integer indexListSize (ilist)
 Get size of the index list.
integer indexListGetIndex (ilist, localind)
 Get the index specified in the index list for the local index localind.
integer indexListGetLocalIndex (ilist, ind)
 Get the local index of the index ind in this index list. The the index is not contained in the index list, returns GRID_UNDEFINED.
subroutine createExplicitObjectList (grid, olist, cls, ind)
 Create an explicit object list for a given class and given objects (optional: directly set the objects)
subroutine createImplicitObjectList (grid, olist, cls)
 Create an implicit object list for a given class. This routine does not fill in any object indices, this has to be done in a separate step.
subroutine createImplicitObjectListForAll (grid, olist, cls)
 Create an implicit object list for a given class, all objects.
logical objectListIsExplicit (olist)
 Check whether an object list is an explicit list of objects.
integer objectListSize (olist)
 Get size of the index set.
integer, dimension(size(olist%cls)) objectListGetIndex (olist, localind)
 Get index tuple for the object with local index lind in this list.
type(GridObjectobjectListGetObject (olist, localind)
 Get ith object specified in the object list.
integer objectListGetIndexForObject (olist, obj)
 Return the local index of the given object obj in the object list olist, according to the object ordering in the object list. If the object is not contained in the object list, GRID_UNDEFINED is returned.

Function/Subroutine Documentation

subroutine itm_grid_objectlist::allocateIndexList ( type(type_complexgrid_indexlist),intent(inout)  iList)

Basic setup of structure (required because all arrays in the ITM CPO data structures are pointers, we cannot have fixed size arrays.

Definition at line 20 of file itm_grid_objectlist.f90.

subroutine itm_grid_objectlist::createExplicitObjectList ( type(type_complexgrid),intent(in)  grid,
type(type_complexgrid_objectlist),intent(out)  olist,
integer,dimension(gridnspace(grid)),intent(in)  cls,
integer,dimension(:,:),intent(in),optional  ind 
)

Create an explicit object list for a given class and given objects (optional: directly set the objects)

Definition at line 131 of file itm_grid_objectlist.f90.

subroutine itm_grid_objectlist::createImplicitObjectList ( type(type_complexgrid),intent(in)  grid,
type(type_complexgrid_objectlist),intent(out)  olist,
integer,dimension(gridnspace(grid)),intent(in)  cls 
)

Create an implicit object list for a given class. This routine does not fill in any object indices, this has to be done in a separate step.

Definition at line 153 of file itm_grid_objectlist.f90.

subroutine itm_grid_objectlist::createImplicitObjectListForAll ( type(type_complexgrid),intent(in)  grid,
type(type_complexgrid_objectlist),intent(out)  olist,
integer,dimension(gridnspace(grid)),intent(in)  cls 
)

Create an implicit object list for a given class, all objects.

Definition at line 169 of file itm_grid_objectlist.f90.

type(type_complexgrid_indexlist) itm_grid_objectlist::createIndexListForAll ( type(type_complexgrid),intent(in)  grid,
integer,dimension(gridnspace(grid)),intent(in)  cls,
integer,intent(in)  ispace 
)

Create an index set: all objects of given class.

Definition at line 37 of file itm_grid_objectlist.f90.

type(type_complexgrid_indexlist) itm_grid_objectlist::createIndexListForList ( type(type_complexgrid),intent(in)  grid,
integer,intent(in)  nind,
integer,dimension(nind),intent(in),optional  ind 
)

Create an index list: explicit list of indices.

Definition at line 57 of file itm_grid_objectlist.f90.

type(type_complexgrid_indexlist) itm_grid_objectlist::createIndexListForRange ( integer,intent(in)  ifrom,
integer,intent(in)  ito 
)

Create an index list: index range.

Definition at line 48 of file itm_grid_objectlist.f90.

type(type_complexgrid_indexlist) itm_grid_objectlist::createIndexListForSingle ( integer,intent(in)  index)

Create an index set: single object.

Definition at line 27 of file itm_grid_objectlist.f90.

integer itm_grid_objectlist::indexListGetIndex ( type(type_complexgrid_indexlist),intent(in)  ilist,
integer,intent(in)  localind 
)

Get the index specified in the index list for the local index localind.

Definition at line 85 of file itm_grid_objectlist.f90.

integer itm_grid_objectlist::indexListGetLocalIndex ( type(type_complexgrid_indexlist),intent(in)  ilist,
integer,intent(in)  ind 
)

Get the local index of the index ind in this index list. The the index is not contained in the index list, returns GRID_UNDEFINED.

Definition at line 102 of file itm_grid_objectlist.f90.

integer itm_grid_objectlist::indexListSize ( type(type_complexgrid_indexlist),intent(in)  ilist)

Get size of the index list.

Definition at line 73 of file itm_grid_objectlist.f90.

integer,dimension(size(olist%cls)) itm_grid_objectlist::objectListGetIndex ( type(type_complexgrid_objectlist),intent(in)  olist,
integer,intent(in)  localind 
)

Get index tuple for the object with local index lind in this list.

Definition at line 214 of file itm_grid_objectlist.f90.

integer itm_grid_objectlist::objectListGetIndexForObject ( type(type_complexgrid_objectlist),intent(in)  olist,
type(GridObject),intent(in)  obj 
)

Return the local index of the given object obj in the object list olist, according to the object ordering in the object list. If the object is not contained in the object list, GRID_UNDEFINED is returned.

Definition at line 263 of file itm_grid_objectlist.f90.

type(GridObject) itm_grid_objectlist::objectListGetObject ( type(type_complexgrid_objectlist),intent(in)  olist,
integer,intent(in)  localind 
)

Get ith object specified in the object list.

Definition at line 252 of file itm_grid_objectlist.f90.

logical itm_grid_objectlist::objectListIsExplicit ( type(type_complexgrid_objectlist),intent(in)  olist)

Check whether an object list is an explicit list of objects.

Definition at line 185 of file itm_grid_objectlist.f90.

integer itm_grid_objectlist::objectListSize ( type(type_complexgrid_objectlist),intent(in)  olist)

Get size of the index set.

Definition at line 197 of file itm_grid_objectlist.f90.

 All Classes Namespaces Files Functions Variables