xref: /petsc/src/dm/impls/da/daview.c (revision 84df9cb40eca90ea9b18a456fab7a4ecc7f6c1a4)
1 
2 /*
3   Code for manipulating distributed regular arrays in parallel.
4 */
5 
6 #include <private/daimpl.h>    /*I   "petscdmda.h"   I*/
7 
8 #if defined(PETSC_HAVE_MATLAB_ENGINE)
9 #include <mat.h>   /* MATLAB include file */
10 
11 #undef __FUNCT__
12 #define __FUNCT__ "DMView_DA_Matlab"
13 PetscErrorCode DMView_DA_Matlab(DM da,PetscViewer viewer)
14 {
15   PetscErrorCode   ierr;
16   PetscMPIInt      rank;
17   PetscInt         dim,m,n,p,dof,swidth;
18   DMDAStencilType  stencil;
19   DMDABoundaryType bx,by,bz;
20   mxArray          *mx;
21   const char       *fnames[] = {"dimension","m","n","p","dof","stencil_width","bx","by","bz","stencil_type"};
22 
23   PetscFunctionBegin;
24   ierr = MPI_Comm_rank(((PetscObject)da)->comm,&rank);CHKERRQ(ierr);
25   if (!rank) {
26     ierr = DMDAGetInfo(da,&dim,&m,&n,&p,0,0,0,&dof,&swidth,&bx,&by,&bz,&stencil);CHKERRQ(ierr);
27     mx = mxCreateStructMatrix(1,1,8,(const char **)fnames);
28     if (!mx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Unable to generate MATLAB struct array to hold DMDA informations");
29     mxSetFieldByNumber(mx,0,0,mxCreateDoubleScalar((double)dim));
30     mxSetFieldByNumber(mx,0,1,mxCreateDoubleScalar((double)m));
31     mxSetFieldByNumber(mx,0,2,mxCreateDoubleScalar((double)n));
32     mxSetFieldByNumber(mx,0,3,mxCreateDoubleScalar((double)p));
33     mxSetFieldByNumber(mx,0,4,mxCreateDoubleScalar((double)dof));
34     mxSetFieldByNumber(mx,0,5,mxCreateDoubleScalar((double)swidth));
35     mxSetFieldByNumber(mx,0,6,mxCreateDoubleScalar((double)bx));
36     mxSetFieldByNumber(mx,0,7,mxCreateDoubleScalar((double)by));
37     mxSetFieldByNumber(mx,0,8,mxCreateDoubleScalar((double)bz));
38     mxSetFieldByNumber(mx,0,9,mxCreateDoubleScalar((double)stencil));
39     ierr = PetscObjectName((PetscObject)da);CHKERRQ(ierr);
40     ierr = PetscViewerMatlabPutVariable(viewer,((PetscObject)da)->name,mx);CHKERRQ(ierr);
41   }
42   PetscFunctionReturn(0);
43 }
44 #endif
45 
46 #undef __FUNCT__
47 #define __FUNCT__ "DMView_DA_Binary"
48 PetscErrorCode DMView_DA_Binary(DM da,PetscViewer viewer)
49 {
50   PetscErrorCode   ierr;
51   PetscMPIInt      rank;
52   PetscInt         dim,m,n,p,dof,swidth,M,N,P;
53   DMDAStencilType  stencil;
54   DMDABoundaryType bx,by,bz;
55   MPI_Comm         comm;
56   DM_DA            *dd = (DM_DA*)da->data;
57   PetscInt         classid = DM_FILE_CLASSID,subclassid = DMDA_FILE_CLASSID ;
58   PetscBool        coors = PETSC_FALSE;
59 
60   PetscFunctionBegin;
61   ierr = PetscObjectGetComm((PetscObject)da,&comm);CHKERRQ(ierr);
62 
63   ierr = DMDAGetInfo(da,&dim,&m,&n,&p,&M,&N,&P,&dof,&swidth,&bx,&by,&bz,&stencil);CHKERRQ(ierr);
64   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
65   if (!rank) {
66 
67     ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
68     ierr = PetscViewerBinaryWrite(viewer,&subclassid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
69     ierr = PetscViewerBinaryWrite(viewer,&dim,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
70     ierr = PetscViewerBinaryWrite(viewer,&m,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
71     ierr = PetscViewerBinaryWrite(viewer,&n,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
72     ierr = PetscViewerBinaryWrite(viewer,&p,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
73     ierr = PetscViewerBinaryWrite(viewer,&dof,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
74     ierr = PetscViewerBinaryWrite(viewer,&swidth,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
75     ierr = PetscViewerBinaryWrite(viewer,&bx,1,PETSC_ENUM,PETSC_FALSE);CHKERRQ(ierr);
76     ierr = PetscViewerBinaryWrite(viewer,&by,1,PETSC_ENUM,PETSC_FALSE);CHKERRQ(ierr);
77     ierr = PetscViewerBinaryWrite(viewer,&bz,1,PETSC_ENUM,PETSC_FALSE);CHKERRQ(ierr);
78     ierr = PetscViewerBinaryWrite(viewer,&stencil,1,PETSC_ENUM,PETSC_FALSE);CHKERRQ(ierr);
79     if (dd->coordinates) coors = PETSC_TRUE;
80     ierr = PetscViewerBinaryWrite(viewer,&coors,1,PETSC_BOOL,PETSC_FALSE);CHKERRQ(ierr);
81   }
82 
83   /* save the coordinates if they exist to disk (in the natural ordering) */
84   if (dd->coordinates) {
85     ierr = VecView(dd->coordinates,viewer);CHKERRQ(ierr);
86   }
87   PetscFunctionReturn(0);
88 }
89 
90 #undef __FUNCT__
91 #define __FUNCT__ "DMView_DA_VTK"
92 PetscErrorCode DMView_DA_VTK(DM da, PetscViewer viewer)
93 {
94   PetscInt       dim, dof, M = 0, N = 0, P = 0;
95   PetscErrorCode ierr;
96   DM_DA          *dd = (DM_DA*)da->data;
97 
98   PetscFunctionBegin;
99   ierr = DMDAGetInfo(da, &dim, &M, &N, &P, PETSC_NULL, PETSC_NULL, PETSC_NULL, &dof, PETSC_NULL, PETSC_NULL, PETSC_NULL, PETSC_NULL, PETSC_NULL);CHKERRQ(ierr);
100   /* if (dim != 3) {SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "VTK output only works for three dimensional DMDAs.");} */
101   if (!dd->coordinates) SETERRQ(((PetscObject)da)->comm,PETSC_ERR_SUP, "VTK output requires DMDA coordinates.");
102   /* Write Header */
103   ierr = PetscViewerASCIIPrintf(viewer,"# vtk DataFile Version 2.0\n");CHKERRQ(ierr);
104   ierr = PetscViewerASCIIPrintf(viewer,"Structured Mesh Example\n");CHKERRQ(ierr);
105   ierr = PetscViewerASCIIPrintf(viewer,"ASCII\n");CHKERRQ(ierr);
106   ierr = PetscViewerASCIIPrintf(viewer,"DATASET STRUCTURED_GRID\n");CHKERRQ(ierr);
107   ierr = PetscViewerASCIIPrintf(viewer,"DIMENSIONS %d %d %d\n", M, N, P);CHKERRQ(ierr);
108   ierr = PetscViewerASCIIPrintf(viewer,"POINTS %d double\n", M*N*P);CHKERRQ(ierr);
109   if (dd->coordinates) {
110     DM  dac;
111     Vec natural;
112 
113     ierr = DMDAGetCoordinateDA(da, &dac);CHKERRQ(ierr);
114     ierr = DMDACreateNaturalVector(dac, &natural);CHKERRQ(ierr);
115     ierr = PetscObjectSetOptionsPrefix((PetscObject) natural, "coor_");CHKERRQ(ierr);
116     ierr = DMDAGlobalToNaturalBegin(dac, dd->coordinates, INSERT_VALUES, natural);CHKERRQ(ierr);
117     ierr = DMDAGlobalToNaturalEnd(dac, dd->coordinates, INSERT_VALUES, natural);CHKERRQ(ierr);
118     ierr = PetscViewerPushFormat(viewer, PETSC_VIEWER_ASCII_VTK_COORDS);CHKERRQ(ierr);
119     ierr = VecView(natural, viewer);CHKERRQ(ierr);
120     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
121     ierr = VecDestroy(&natural);CHKERRQ(ierr);
122   }
123   PetscFunctionReturn(0);
124 }
125 
126 #undef __FUNCT__
127 #define __FUNCT__ "DMDAGetInfo"
128 /*@C
129    DMDAGetInfo - Gets information about a given distributed array.
130 
131    Not Collective
132 
133    Input Parameter:
134 .  da - the distributed array
135 
136    Output Parameters:
137 +  dim      - dimension of the distributed array (1, 2, or 3)
138 .  M, N, P  - global dimension in each direction of the array
139 .  m, n, p  - corresponding number of procs in each dimension
140 .  dof      - number of degrees of freedom per node
141 .  s        - stencil width
142 .  bx,by,bz - type of ghost nodes at boundary, one of DMDA_BOUNDARY_NONE, DMDA_BOUNDARY_GHOSTED,
143               DMDA_BOUNDARY_MIRROR, DMDA_BOUNDARY_PERIODIC
144 -  st       - stencil type, either DMDA_STENCIL_STAR or DMDA_STENCIL_BOX
145 
146    Level: beginner
147 
148    Note:
149    Use PETSC_NULL (PETSC_NULL_INTEGER in Fortran) in place of any output parameter that is not of interest.
150 
151 .keywords: distributed array, get, information
152 
153 .seealso: DMView(), DMDAGetCorners(), DMDAGetLocalInfo()
154 @*/
155 PetscErrorCode  DMDAGetInfo(DM da,PetscInt *dim,PetscInt *M,PetscInt *N,PetscInt *P,PetscInt *m,PetscInt *n,PetscInt *p,PetscInt *dof,PetscInt *s,DMDABoundaryType *bx,DMDABoundaryType *by,DMDABoundaryType *bz,DMDAStencilType *st)
156 {
157   DM_DA *dd = (DM_DA*)da->data;
158 
159   PetscFunctionBegin;
160   PetscValidHeaderSpecific(da,DM_CLASSID,1);
161   if (dim)  *dim  = dd->dim;
162   if (M)    *M    = dd->M;
163   if (N)    *N    = dd->N;
164   if (P)    *P    = dd->P;
165   if (m)    *m    = dd->m;
166   if (n)    *n    = dd->n;
167   if (p)    *p    = dd->p;
168   if (dof)  *dof  = dd->w;
169   if (s)    *s    = dd->s;
170   if (bx) *bx = dd->bx;
171   if (by) *by = dd->by;
172   if (bz) *bz = dd->bz;
173   if (st)   *st   = dd->stencil_type;
174   PetscFunctionReturn(0);
175 }
176 
177 #undef __FUNCT__
178 #define __FUNCT__ "DMDAGetLocalInfo"
179 /*@C
180    DMDAGetLocalInfo - Gets information about a given distributed array and this processors location in it
181 
182    Not Collective
183 
184    Input Parameter:
185 .  da - the distributed array
186 
187    Output Parameters:
188 .  dainfo - structure containing the information
189 
190    Level: beginner
191 
192 .keywords: distributed array, get, information
193 
194 .seealso: DMDAGetInfo(), DMDAGetCorners()
195 @*/
196 PetscErrorCode  DMDAGetLocalInfo(DM da,DMDALocalInfo *info)
197 {
198   PetscInt w;
199   DM_DA    *dd = (DM_DA*)da->data;
200 
201   PetscFunctionBegin;
202   PetscValidHeaderSpecific(da,DM_CLASSID,1);
203   PetscValidPointer(info,2);
204   info->da   = da;
205   info->dim  = dd->dim;
206   info->mx   = dd->M;
207   info->my   = dd->N;
208   info->mz   = dd->P;
209   info->dof  = dd->w;
210   info->sw   = dd->s;
211   info->bx   = dd->bx;
212   info->by   = dd->by;
213   info->bz   = dd->bz;
214   info->st   = dd->stencil_type;
215 
216   /* since the xs, xe ... have all been multiplied by the number of degrees
217      of freedom per cell, w = dd->w, we divide that out before returning.*/
218   w = dd->w;
219   info->xs = dd->xs/w;
220   info->xm = (dd->xe - dd->xs)/w;
221   /* the y and z have NOT been multiplied by w */
222   info->ys = dd->ys;
223   info->ym = (dd->ye - dd->ys);
224   info->zs = dd->zs;
225   info->zm = (dd->ze - dd->zs);
226 
227   info->gxs = dd->Xs/w;
228   info->gxm = (dd->Xe - dd->Xs)/w;
229   /* the y and z have NOT been multiplied by w */
230   info->gys = dd->Ys;
231   info->gym = (dd->Ye - dd->Ys);
232   info->gzs = dd->Zs;
233   info->gzm = (dd->Ze - dd->Zs);
234   PetscFunctionReturn(0);
235 }
236 
237