Actual source code: daindex.c
1: /*$Id: daindex.c,v 1.32 2001/03/23 23:25:00 balay Exp $*/
2:
3: /*
4: Code for manipulating distributed regular arrays in parallel.
5: */
7: #include "src/dm/da/daimpl.h" /*I "petscda.h" I*/
9: /*@C
10: DAGetGlobalIndices - Returns the global node number of all local nodes,
11: including ghost nodes.
13: Not Collective
15: Input Parameter:
16: . da - the distributed array
18: Output Parameters:
19: + n - the number of local elements, including ghost nodes (or PETSC_NULL)
20: - idx - the global indices
22: Level: intermediate
24: Note:
25: For DA_STENCIL_STAR stencils the inactive corner ghost nodes are also included
26: in the list of local indices (even though those nodes are not updated
27: during calls to DAXXXToXXX().
29: Essentially the same data is returned in the form of a local-to-global mapping
30: with the routine DAGetISLocalToGlobalMapping();
32: Fortran Note:
33: This routine is used differently from Fortran
34: .vb
35: DA da
36: integer da_array(1)
37: PetscOffset i_da
38: integer ierr
39: call DAGetGlobalIndices(da,da_array,i_da,ierr)
41: C Access first local entry in list
42: value = da_array(i_da + 1)
43: .ve
45: See the Fortran chapter of the users manual for details
47: .keywords: distributed array, get, global, indices, local-to-global
49: .seealso: DACreate2d(), DAGetGhostCorners(), DAGetCorners(), DALocalToGlobal()
50: DAGlobalToLocal(), DALocalToLocal(), DAGetAO(), DAGetGlobalIndicesF90()
51: DAGetISLocalToGlobalMapping(), DACreate3d(), DACreate1d()
52: @*/
53: int DAGetGlobalIndices(DA da,int *n,int **idx)
54: {
57: if (n) *n = da->Nl;
58: if (idx) *idx = da->idx;
59: return(0);
60: }
63: /*@C
64: DAGetAO - Gets the application ordering context for a distributed array.
66: Not Collective, but AO is parallel if DA is parallel
68: Input Parameter:
69: . da - the distributed array
71: Output Parameters:
72: . ao - the application ordering context for DAs
74: Level: intermediate
76: Notes:
77: In this case, the AO maps to the natural grid ordering that would be used
78: for the DA if only 1 processor were employed (ordering most rapidly in the
79: x-direction, then y, then z). Multiple degrees of freedom are numbered
80: for each node (rather than 1 component for the whole grid, then the next
81: component, etc.)
83: .keywords: distributed array, get, global, indices, local-to-global
85: .seealso: DACreate2d(), DAGetGhostCorners(), DAGetCorners(), DALocalToGlocal()
86: DAGlobalToLocal(), DALocalToLocal(), DAGetGlobalIndices()
87: @*/
88: int DAGetAO(DA da,AO *ao)
89: {
92: *ao = da->ao;
93: return(0);
94: }
96: /*MC
97: DAGetGlobalIndicesF90 - Returns a Fortran90 pointer to the list of
98: global indices (global node number of all local nodes, including
99: ghost nodes).
101: Synopsis:
102: DAGetGlobalIndicesF90(DA da,integer n,{integer, pointer :: idx(:)},integer ierr)
104: Input Parameter:
105: . da - the distributed array
107: Output Parameters:
108: + n - the number of local elements, including ghost nodes (or PETSC_NULL)
109: . idx - the Fortran90 pointer to the global indices
110: - ierr - error code
112: Level: intermediate
114: Notes:
115: Not yet supported for all F90 compilers
117: .keywords: distributed array, get, global, indices, local-to-global, f90
119: .seealso: DAGetGlobalIndices()
120: M*/