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