xref: /petsc/src/dm/impls/da/dacreate.c (revision 7d0a6c19129e7069c8a40e210b34ed62989173db)
1*7d0a6c19SBarry Smith 
2e1589f56SBarry Smith #include "private/daimpl.h"    /*I   "petscdm.h"   I*/
347c6ae99SBarry Smith 
447c6ae99SBarry Smith #undef __FUNCT__
59a42bb27SBarry Smith #define __FUNCT__ "DMSetFromOptions_DA"
67087cfbeSBarry Smith PetscErrorCode  DMSetFromOptions_DA(DM da)
747c6ae99SBarry Smith {
847c6ae99SBarry Smith   PetscErrorCode ierr;
947c6ae99SBarry Smith   PetscBool      flg;
1047c6ae99SBarry Smith   char           typeName[256];
1147c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
1247c6ae99SBarry Smith 
1347c6ae99SBarry Smith   PetscFunctionBegin;
1447c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
1547c6ae99SBarry Smith 
16aa219208SBarry Smith   ierr = PetscOptionsBegin(((PetscObject)da)->comm,((PetscObject)da)->prefix,"DMDA Options","DMDA");CHKERRQ(ierr);
17aa219208SBarry Smith     /* Handle DMDA grid sizes */
1847c6ae99SBarry Smith     if (dd->M < 0) {
1947c6ae99SBarry Smith       PetscInt newM = -dd->M;
20aa219208SBarry Smith       ierr = PetscOptionsInt("-da_grid_x","Number of grid points in x direction","DMDASetSizes",newM,&newM,PETSC_NULL);CHKERRQ(ierr);
2147c6ae99SBarry Smith       dd->M = newM;
2247c6ae99SBarry Smith     }
2347c6ae99SBarry Smith     if (dd->dim > 1 && dd->N < 0) {
2447c6ae99SBarry Smith       PetscInt newN = -dd->N;
25aa219208SBarry Smith       ierr = PetscOptionsInt("-da_grid_y","Number of grid points in y direction","DMDASetSizes",newN,&newN,PETSC_NULL);CHKERRQ(ierr);
2647c6ae99SBarry Smith       dd->N = newN;
2747c6ae99SBarry Smith     }
2847c6ae99SBarry Smith     if (dd->dim > 2 && dd->P < 0) {
2947c6ae99SBarry Smith       PetscInt newP = -dd->P;
30aa219208SBarry Smith       ierr = PetscOptionsInt("-da_grid_z","Number of grid points in z direction","DMDASetSizes",newP,&newP,PETSC_NULL);CHKERRQ(ierr);
3147c6ae99SBarry Smith       dd->P = newP;
3247c6ae99SBarry Smith     }
33aa219208SBarry Smith     /* Handle DMDA parallel distibution */
34aa219208SBarry Smith     ierr = PetscOptionsInt("-da_processors_x","Number of processors in x direction","DMDASetNumProcs",dd->m,&dd->m,PETSC_NULL);CHKERRQ(ierr);
35aa219208SBarry Smith     if (dd->dim > 1) {ierr = PetscOptionsInt("-da_processors_y","Number of processors in y direction","DMDASetNumProcs",dd->n,&dd->n,PETSC_NULL);CHKERRQ(ierr);}
36aa219208SBarry Smith     if (dd->dim > 2) {ierr = PetscOptionsInt("-da_processors_z","Number of processors in z direction","DMDASetNumProcs",dd->p,&dd->p,PETSC_NULL);CHKERRQ(ierr);}
37aa219208SBarry Smith     /* Handle DMDA refinement */
38aa219208SBarry Smith     ierr = PetscOptionsInt("-da_refine_x","Refinement ratio in x direction","DMDASetRefinementFactor",dd->refine_x,&dd->refine_x,PETSC_NULL);CHKERRQ(ierr);
39aa219208SBarry Smith     if (dd->dim > 1) {ierr = PetscOptionsInt("-da_refine_y","Refinement ratio in y direction","DMDASetRefinementFactor",dd->refine_y,&dd->refine_y,PETSC_NULL);CHKERRQ(ierr);}
40aa219208SBarry Smith     if (dd->dim > 2) {ierr = PetscOptionsInt("-da_refine_z","Refinement ratio in z direction","DMDASetRefinementFactor",dd->refine_z,&dd->refine_z,PETSC_NULL);CHKERRQ(ierr);}
4147c6ae99SBarry Smith 
4247c6ae99SBarry Smith     if (!VecRegisterAllCalled) {ierr = VecRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
439a42bb27SBarry Smith     ierr = PetscOptionsList("-da_vec_type","Vector type used for created vectors","DMSetVecType",VecList,da->vectype,typeName,256,&flg);CHKERRQ(ierr);
4447c6ae99SBarry Smith     if (flg) {
459a42bb27SBarry Smith       ierr = DMSetVecType(da,typeName);CHKERRQ(ierr);
4647c6ae99SBarry Smith     }
4747c6ae99SBarry Smith 
4847c6ae99SBarry Smith     /* process any options handlers added with PetscObjectAddOptionsHandler() */
4947c6ae99SBarry Smith     ierr = PetscObjectProcessOptionsHandlers((PetscObject)da);CHKERRQ(ierr);
5047c6ae99SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
5147c6ae99SBarry Smith 
5247c6ae99SBarry Smith   PetscFunctionReturn(0);
5347c6ae99SBarry Smith }
5447c6ae99SBarry Smith 
557087cfbeSBarry Smith extern PetscErrorCode  DMCreateGlobalVector_DA(DM,Vec*);
567087cfbeSBarry Smith extern PetscErrorCode  DMCreateLocalVector_DA(DM,Vec*);
577087cfbeSBarry Smith extern PetscErrorCode  DMGlobalToLocalBegin_DA(DM,Vec,InsertMode,Vec);
587087cfbeSBarry Smith extern PetscErrorCode  DMGlobalToLocalEnd_DA(DM,Vec,InsertMode,Vec);
597087cfbeSBarry Smith extern PetscErrorCode  DMLocalToGlobalBegin_DA(DM,Vec,InsertMode,Vec);
607087cfbeSBarry Smith extern PetscErrorCode  DMLocalToGlobalEnd_DA(DM,Vec,InsertMode,Vec);
617087cfbeSBarry Smith extern PetscErrorCode  DMGetInterpolation_DA(DM,DM,Mat*,Vec*);
627087cfbeSBarry Smith extern PetscErrorCode  DMGetColoring_DA(DM,ISColoringType,const MatType,ISColoring*);
637087cfbeSBarry Smith extern PetscErrorCode  DMGetElements_DA(DM,PetscInt*,PetscInt*,const PetscInt *[]);
647087cfbeSBarry Smith extern PetscErrorCode  DMGetMatrix_DA(DM,const MatType,Mat*);
657087cfbeSBarry Smith extern PetscErrorCode  DMRefine_DA(DM,MPI_Comm,DM*);
667087cfbeSBarry Smith extern PetscErrorCode  DMCoarsen_DA(DM,MPI_Comm,DM*);
677087cfbeSBarry Smith extern PetscErrorCode  DMRefineHierarchy_DA(DM,PetscInt,DM[]);
687087cfbeSBarry Smith extern PetscErrorCode  DMCoarsenHierarchy_DA(DM,PetscInt,DM[]);
697087cfbeSBarry Smith extern PetscErrorCode  DMGetInjection_DA(DM,DM,VecScatter*);
707087cfbeSBarry Smith extern PetscErrorCode  DMGetAggregates_DA(DM,DM,Mat*);
717087cfbeSBarry Smith extern PetscErrorCode  DMView_DA(DM,PetscViewer);
727087cfbeSBarry Smith extern PetscErrorCode  DMSetUp_DA(DM);
737087cfbeSBarry Smith extern PetscErrorCode  DMDestroy_DA(DM);
749a42bb27SBarry Smith 
75a4121054SBarry Smith EXTERN_C_BEGIN
7647c6ae99SBarry Smith #undef __FUNCT__
77a4121054SBarry Smith #define __FUNCT__ "DMCreate_DA"
787087cfbeSBarry Smith PetscErrorCode  DMCreate_DA(DM da)
7947c6ae99SBarry Smith {
8047c6ae99SBarry Smith   PetscErrorCode ierr;
8147c6ae99SBarry Smith   DM_DA          *dd;
8247c6ae99SBarry Smith 
8347c6ae99SBarry Smith   PetscFunctionBegin;
84a4121054SBarry Smith   PetscValidPointer(da,1);
85a4121054SBarry Smith   ierr = PetscNewLog(da,DM_DA,&dd);CHKERRQ(ierr);
86a4121054SBarry Smith   da->data = dd;
8747c6ae99SBarry Smith 
8847c6ae99SBarry Smith   dd->dim        = -1;
89aa219208SBarry Smith   dd->interptype = DMDA_Q1;
9047c6ae99SBarry Smith   dd->refine_x   = 2;
9147c6ae99SBarry Smith   dd->refine_y   = 2;
9247c6ae99SBarry Smith   dd->refine_z   = 2;
9347c6ae99SBarry Smith   dd->fieldname  = PETSC_NULL;
9447c6ae99SBarry Smith   dd->nlocal     = -1;
9547c6ae99SBarry Smith   dd->Nlocal     = -1;
9647c6ae99SBarry Smith   dd->M          = -1;
9747c6ae99SBarry Smith   dd->N          = -1;
9847c6ae99SBarry Smith   dd->P          = -1;
9947c6ae99SBarry Smith   dd->m          = -1;
10047c6ae99SBarry Smith   dd->n          = -1;
10147c6ae99SBarry Smith   dd->p          = -1;
10247c6ae99SBarry Smith   dd->w          = -1;
10347c6ae99SBarry Smith   dd->s          = -1;
10447c6ae99SBarry Smith   dd->xs = -1; dd->xe = -1; dd->ys = -1; dd->ye = -1; dd->zs = -1; dd->ze = -1;
10547c6ae99SBarry Smith   dd->Xs = -1; dd->Xe = -1; dd->Ys = -1; dd->Ye = -1; dd->Zs = -1; dd->Ze = -1;
10647c6ae99SBarry Smith 
10747c6ae99SBarry Smith   dd->gtol         = PETSC_NULL;
10847c6ae99SBarry Smith   dd->ltog         = PETSC_NULL;
10947c6ae99SBarry Smith   dd->ltol         = PETSC_NULL;
11047c6ae99SBarry Smith   dd->ao           = PETSC_NULL;
11147c6ae99SBarry Smith   dd->base         = -1;
1121321219cSEthan Coon   dd->bx         = DMDA_BOUNDARY_NONE;
1131321219cSEthan Coon   dd->by         = DMDA_BOUNDARY_NONE;
1141321219cSEthan Coon   dd->bz         = DMDA_BOUNDARY_NONE;
115aa219208SBarry Smith   dd->stencil_type = DMDA_STENCIL_BOX;
116aa219208SBarry Smith   dd->interptype   = DMDA_Q1;
11747c6ae99SBarry Smith   dd->idx          = PETSC_NULL;
11847c6ae99SBarry Smith   dd->Nl           = -1;
11947c6ae99SBarry Smith   dd->lx           = PETSC_NULL;
12047c6ae99SBarry Smith   dd->ly           = PETSC_NULL;
12147c6ae99SBarry Smith   dd->lz           = PETSC_NULL;
12247c6ae99SBarry Smith 
123454e267fSLisandro Dalcin   dd->elementtype  = DMDA_ELEMENT_Q1;
124454e267fSLisandro Dalcin 
125a4121054SBarry Smith   ierr = PetscStrallocpy(VECSTANDARD,&da->vectype);CHKERRQ(ierr);
126a4121054SBarry Smith   da->ops->globaltolocalbegin = DMGlobalToLocalBegin_DA;
127a4121054SBarry Smith   da->ops->globaltolocalend   = DMGlobalToLocalEnd_DA;
128a4121054SBarry Smith   da->ops->localtoglobalbegin = DMLocalToGlobalBegin_DA;
129a4121054SBarry Smith   da->ops->localtoglobalend   = DMLocalToGlobalEnd_DA;
130a4121054SBarry Smith   da->ops->createglobalvector = DMCreateGlobalVector_DA;
131a4121054SBarry Smith   da->ops->createlocalvector  = DMCreateLocalVector_DA;
132a4121054SBarry Smith   da->ops->getinterpolation   = DMGetInterpolation_DA;
133a4121054SBarry Smith   da->ops->getcoloring        = DMGetColoring_DA;
134454e267fSLisandro Dalcin   da->ops->getelements        = DMGetElements_DA;
135a4121054SBarry Smith   da->ops->getmatrix          = DMGetMatrix_DA;
136a4121054SBarry Smith   da->ops->refine             = DMRefine_DA;
137a4121054SBarry Smith   da->ops->coarsen            = DMCoarsen_DA;
138a4121054SBarry Smith   da->ops->refinehierarchy    = DMRefineHierarchy_DA;
139a4121054SBarry Smith   da->ops->coarsenhierarchy   = DMCoarsenHierarchy_DA;
140a4121054SBarry Smith   da->ops->getinjection       = DMGetInjection_DA;
141a4121054SBarry Smith   da->ops->getaggregates      = DMGetAggregates_DA;
142a4121054SBarry Smith   da->ops->destroy            = DMDestroy_DA;
143a4121054SBarry Smith   da->ops->view               = 0;
144a4121054SBarry Smith   da->ops->setfromoptions     = DMSetFromOptions_DA;
145a4121054SBarry Smith   da->ops->setup              = DMSetUp_DA;
146a4121054SBarry Smith   PetscFunctionReturn(0);
147a4121054SBarry Smith }
148a4121054SBarry Smith EXTERN_C_END
14947c6ae99SBarry Smith 
150a4121054SBarry Smith #undef __FUNCT__
151a4121054SBarry Smith #define __FUNCT__ "DMDACreate"
152a4121054SBarry Smith /*@
153a4121054SBarry Smith   DMDACreate - Creates a DMDA object.
154a4121054SBarry Smith 
155a4121054SBarry Smith   Collective on MPI_Comm
156a4121054SBarry Smith 
157a4121054SBarry Smith   Input Parameter:
158a4121054SBarry Smith . comm - The communicator for the DMDA object
159a4121054SBarry Smith 
160a4121054SBarry Smith   Output Parameter:
161a4121054SBarry Smith . da  - The DMDA object
162a4121054SBarry Smith 
163a4121054SBarry Smith   Level: beginner
164a4121054SBarry Smith 
165a4121054SBarry Smith .keywords: DMDA, create
166a4121054SBarry Smith .seealso:  DMDASetSizes(), DMDADuplicate()
167a4121054SBarry Smith @*/
1687087cfbeSBarry Smith PetscErrorCode  DMDACreate(MPI_Comm comm, DM *da)
169a4121054SBarry Smith {
170a4121054SBarry Smith   PetscErrorCode ierr;
171a4121054SBarry Smith 
172a4121054SBarry Smith   PetscFunctionBegin;
173a4121054SBarry Smith   PetscValidPointer(da,2);
174a4121054SBarry Smith   ierr = DMCreate(comm,da);CHKERRQ(ierr);
175a4121054SBarry Smith   ierr = DMSetType(*da,DMDA);CHKERRQ(ierr);
17647c6ae99SBarry Smith   PetscFunctionReturn(0);
17747c6ae99SBarry Smith }
178