1af0996ceSBarry Smith #include <petsc/private/dmimpl.h> /*I "petscdm.h" I*/ 2c58f1c22SToby Isaac #include <petsc/private/dmlabelimpl.h> /*I "petscdmlabel.h" I*/ 3e6f8dbb6SToby Isaac #include <petsc/private/petscdsimpl.h> /*I "petscds.h" I*/ 43e922f36SToby Isaac #include <petscdmplex.h> 5f19dbd58SToby Isaac #include <petscdmfield.h> 60c312b8eSJed Brown #include <petscsf.h> 72764a2aaSMatthew G. Knepley #include <petscds.h> 847c6ae99SBarry Smith 9732e2eb9SMatthew G Knepley PetscClassId DM_CLASSID; 10d67d17b1SMatthew G. Knepley PetscClassId DMLABEL_CLASSID; 115a84ad33SLisandro Dalcin PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_Refine, DM_CreateInterpolation, DM_CreateRestriction, DM_CreateInjection, DM_CreateMatrix; 1267a56275SMatthew G Knepley 13e249ee26SToby Isaac const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DMBoundaryType","DM_BOUNDARY_",0}; 1440967b3bSMatthew G. Knepley const char *const DMBoundaryConditionTypes[] = {"INVALID","ESSENTIAL","NATURAL","INVALID","INVALID","ESSENTIAL_FIELD","NATURAL_FIELD","INVALID","INVALID","INVALID","NATURAL_RIEMANN","DMBoundaryConditionType","DM_BC_",0}; 15bff4a2f0SMatthew G. Knepley 16a4121054SBarry Smith /*@ 17de043629SMatthew G Knepley DMCreate - Creates an empty DM object. The type can then be set with DMSetType(). 18a4121054SBarry Smith 19a4121054SBarry Smith If you never call DMSetType() it will generate an 20a4121054SBarry Smith error when you try to use the vector. 21a4121054SBarry Smith 22d083f849SBarry Smith Collective 23a4121054SBarry Smith 24a4121054SBarry Smith Input Parameter: 25a4121054SBarry Smith . comm - The communicator for the DM object 26a4121054SBarry Smith 27a4121054SBarry Smith Output Parameter: 28a4121054SBarry Smith . dm - The DM object 29a4121054SBarry Smith 30a4121054SBarry Smith Level: beginner 31a4121054SBarry Smith 328472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK 33a4121054SBarry Smith @*/ 347087cfbeSBarry Smith PetscErrorCode DMCreate(MPI_Comm comm,DM *dm) 35a4121054SBarry Smith { 36a4121054SBarry Smith DM v; 37e5e52638SMatthew G. Knepley PetscDS ds; 38a4121054SBarry Smith PetscErrorCode ierr; 39a4121054SBarry Smith 40a4121054SBarry Smith PetscFunctionBegin; 411411c6eeSJed Brown PetscValidPointer(dm,2); 420298fd71SBarry Smith *dm = NULL; 43607a6623SBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 44a4121054SBarry Smith 4573107ff1SLisandro Dalcin ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr); 46e7c4fc90SDmitry Karpeev 4749be4549SMatthew G. Knepley v->setupcalled = PETSC_FALSE; 4849be4549SMatthew G. Knepley v->setfromoptionscalled = PETSC_FALSE; 490298fd71SBarry Smith v->ltogmap = NULL; 501411c6eeSJed Brown v->bs = 1; 51171400e9SBarry Smith v->coloringtype = IS_COLORING_GLOBAL; 5288ed4aceSMatthew G Knepley ierr = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr); 531bb6d2a8SBarry Smith ierr = PetscSFCreate(comm, &v->sectionSF);CHKERRQ(ierr); 54c58f1c22SToby Isaac v->labels = NULL; 5534aa8a36SMatthew G. Knepley v->adjacency[0] = PETSC_FALSE; 5634aa8a36SMatthew G. Knepley v->adjacency[1] = PETSC_TRUE; 57c58f1c22SToby Isaac v->depthLabel = NULL; 581bb6d2a8SBarry Smith v->localSection = NULL; 591bb6d2a8SBarry Smith v->globalSection = NULL; 60fba222abSToby Isaac v->defaultConstraintSection = NULL; 61fba222abSToby Isaac v->defaultConstraintMat = NULL; 62c6b900c6SMatthew G. Knepley v->L = NULL; 63c6b900c6SMatthew G. Knepley v->maxCell = NULL; 645dc8c3f7SMatthew G. Knepley v->bdtype = NULL; 659a9a41abSToby Isaac v->dimEmbed = PETSC_DEFAULT; 6696173672SStefano Zampini v->dim = PETSC_DETERMINE; 67435a35e8SMatthew G Knepley { 68435a35e8SMatthew G Knepley PetscInt i; 69435a35e8SMatthew G Knepley for (i = 0; i < 10; ++i) { 700298fd71SBarry Smith v->nullspaceConstructors[i] = NULL; 71f9d4088aSMatthew G. Knepley v->nearnullspaceConstructors[i] = NULL; 72435a35e8SMatthew G Knepley } 73435a35e8SMatthew G Knepley } 74e5e52638SMatthew G. Knepley ierr = PetscDSCreate(PetscObjectComm((PetscObject) v), &ds);CHKERRQ(ierr); 75b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr); 76e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 7714f150ffSMatthew G. Knepley v->dmBC = NULL; 78a8fb8f29SToby Isaac v->coarseMesh = NULL; 79f4d763aaSMatthew G. Knepley v->outputSequenceNum = -1; 80cdb7a50dSMatthew G. Knepley v->outputSequenceVal = 0.0; 81c0dedaeaSBarry Smith ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr); 82b412c318SBarry Smith ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr); 834a7a4c06SLawrence Mitchell 841411c6eeSJed Brown *dm = v; 85a4121054SBarry Smith PetscFunctionReturn(0); 86a4121054SBarry Smith } 87a4121054SBarry Smith 8838221697SMatthew G. Knepley /*@ 8938221697SMatthew G. Knepley DMClone - Creates a DM object with the same topology as the original. 9038221697SMatthew G. Knepley 91d083f849SBarry Smith Collective 9238221697SMatthew G. Knepley 9338221697SMatthew G. Knepley Input Parameter: 9438221697SMatthew G. Knepley . dm - The original DM object 9538221697SMatthew G. Knepley 9638221697SMatthew G. Knepley Output Parameter: 9738221697SMatthew G. Knepley . newdm - The new DM object 9838221697SMatthew G. Knepley 9938221697SMatthew G. Knepley Level: beginner 10038221697SMatthew G. Knepley 1011bb6d2a8SBarry Smith Notes: For some DM this is a shallow clone, the result of which may share (referent counted) information with its parent. For example, 1021bb6d2a8SBarry Smith DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does 1031bb6d2a8SBarry Smith share the PetscSection of the original DM 1041bb6d2a8SBarry Smith 1051bb6d2a8SBarry Smith .seealso: DMDestry(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection() 1061bb6d2a8SBarry Smith 10738221697SMatthew G. Knepley @*/ 10838221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm) 10938221697SMatthew G. Knepley { 11038221697SMatthew G. Knepley PetscSF sf; 11138221697SMatthew G. Knepley Vec coords; 11238221697SMatthew G. Knepley void *ctx; 113a3219837SMatthew G. Knepley PetscInt dim, cdim; 11438221697SMatthew G. Knepley PetscErrorCode ierr; 11538221697SMatthew G. Knepley 11638221697SMatthew G. Knepley PetscFunctionBegin; 11738221697SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 11838221697SMatthew G. Knepley PetscValidPointer(newdm,2); 11938221697SMatthew G. Knepley ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr); 1205d80c0bfSVaclav Hapla ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE);CHKERRQ(ierr); 121ddf8437dSMatthew G. Knepley (*newdm)->leveldown = dm->leveldown; 122ddf8437dSMatthew G. Knepley (*newdm)->levelup = dm->levelup; 1231de53e9aSMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 1241de53e9aSMatthew G. Knepley ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr); 12538221697SMatthew G. Knepley if (dm->ops->clone) { 12638221697SMatthew G. Knepley ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr); 12738221697SMatthew G. Knepley } 1283f22bcbcSToby Isaac (*newdm)->setupcalled = dm->setupcalled; 12938221697SMatthew G. Knepley ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr); 13038221697SMatthew G. Knepley ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr); 13138221697SMatthew G. Knepley ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr); 13238221697SMatthew G. Knepley ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr); 133be4c1c3eSMatthew G. Knepley if (dm->coordinateDM) { 134be4c1c3eSMatthew G. Knepley DM ncdm; 135be4c1c3eSMatthew G. Knepley PetscSection cs; 1365a0206caSToby Isaac PetscInt pEnd = -1, pEndMax = -1; 137be4c1c3eSMatthew G. Knepley 13892fd8e1eSJed Brown ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr); 139be4c1c3eSMatthew G. Knepley if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);} 1405a0206caSToby Isaac ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 1415a0206caSToby Isaac if (pEndMax >= 0) { 142be4c1c3eSMatthew G. Knepley ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr); 14383bfc06fSMatthew Knepley ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr); 14492fd8e1eSJed Brown ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr); 145a61e840bSMatthew G. Knepley ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr); 146be4c1c3eSMatthew G. Knepley ierr = DMDestroy(&ncdm);CHKERRQ(ierr); 147be4c1c3eSMatthew G. Knepley } 148be4c1c3eSMatthew G. Knepley } 149a3219837SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 150a3219837SMatthew G. Knepley ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr); 15138221697SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr); 15238221697SMatthew G. Knepley if (coords) { 15338221697SMatthew G. Knepley ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr); 15438221697SMatthew G. Knepley } else { 15538221697SMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 15638221697SMatthew G. Knepley if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);} 15738221697SMatthew G. Knepley } 15890b157c4SStefano Zampini { 15990b157c4SStefano Zampini PetscBool isper; 160c6b900c6SMatthew G. Knepley const PetscReal *maxCell, *L; 1615dc8c3f7SMatthew G. Knepley const DMBoundaryType *bd; 16290b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 16390b157c4SStefano Zampini ierr = DMSetPeriodicity(*newdm, isper, maxCell, L, bd);CHKERRQ(ierr); 164c6b900c6SMatthew G. Knepley } 16534aa8a36SMatthew G. Knepley { 16634aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 16734aa8a36SMatthew G. Knepley 16834aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr); 16934aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 17034aa8a36SMatthew G. Knepley } 17138221697SMatthew G. Knepley PetscFunctionReturn(0); 17238221697SMatthew G. Knepley } 17338221697SMatthew G. Knepley 1749a42bb27SBarry Smith /*@C 175564755cdSBarry Smith DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 1769a42bb27SBarry Smith 177d083f849SBarry Smith Logically Collective on da 1789a42bb27SBarry Smith 1799a42bb27SBarry Smith Input Parameter: 1809a42bb27SBarry Smith + da - initial distributed array 181e9e886b6SKarl Rupp . ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL 1829a42bb27SBarry Smith 1839a42bb27SBarry Smith Options Database: 184dd85299cSBarry Smith . -dm_vec_type ctype 1859a42bb27SBarry Smith 1869a42bb27SBarry Smith Level: intermediate 1879a42bb27SBarry Smith 188a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType() 1899a42bb27SBarry Smith @*/ 19019fd82e9SBarry Smith PetscErrorCode DMSetVecType(DM da,VecType ctype) 1919a42bb27SBarry Smith { 1929a42bb27SBarry Smith PetscErrorCode ierr; 1939a42bb27SBarry Smith 1949a42bb27SBarry Smith PetscFunctionBegin; 1959a42bb27SBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 1969a42bb27SBarry Smith ierr = PetscFree(da->vectype);CHKERRQ(ierr); 19719fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr); 1989a42bb27SBarry Smith PetscFunctionReturn(0); 1999a42bb27SBarry Smith } 2009a42bb27SBarry Smith 201c0dedaeaSBarry Smith /*@C 202c0dedaeaSBarry Smith DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 203c0dedaeaSBarry Smith 204d083f849SBarry Smith Logically Collective on da 205c0dedaeaSBarry Smith 206c0dedaeaSBarry Smith Input Parameter: 207c0dedaeaSBarry Smith . da - initial distributed array 208c0dedaeaSBarry Smith 209c0dedaeaSBarry Smith Output Parameter: 210c0dedaeaSBarry Smith . ctype - the vector type 211c0dedaeaSBarry Smith 212c0dedaeaSBarry Smith Level: intermediate 213c0dedaeaSBarry Smith 214a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType() 215c0dedaeaSBarry Smith @*/ 216c0dedaeaSBarry Smith PetscErrorCode DMGetVecType(DM da,VecType *ctype) 217c0dedaeaSBarry Smith { 218c0dedaeaSBarry Smith PetscFunctionBegin; 219c0dedaeaSBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 220c0dedaeaSBarry Smith *ctype = da->vectype; 221c0dedaeaSBarry Smith PetscFunctionReturn(0); 222c0dedaeaSBarry Smith } 223c0dedaeaSBarry Smith 2245f1ad066SMatthew G Knepley /*@ 22534f98d34SBarry Smith VecGetDM - Gets the DM defining the data layout of the vector 2265f1ad066SMatthew G Knepley 2275f1ad066SMatthew G Knepley Not collective 2285f1ad066SMatthew G Knepley 2295f1ad066SMatthew G Knepley Input Parameter: 2305f1ad066SMatthew G Knepley . v - The Vec 2315f1ad066SMatthew G Knepley 2325f1ad066SMatthew G Knepley Output Parameter: 2335f1ad066SMatthew G Knepley . dm - The DM 2345f1ad066SMatthew G Knepley 2355f1ad066SMatthew G Knepley Level: intermediate 2365f1ad066SMatthew G Knepley 2375f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2385f1ad066SMatthew G Knepley @*/ 2395f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm) 2405f1ad066SMatthew G Knepley { 2415f1ad066SMatthew G Knepley PetscErrorCode ierr; 2425f1ad066SMatthew G Knepley 2435f1ad066SMatthew G Knepley PetscFunctionBegin; 2445f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 2455f1ad066SMatthew G Knepley PetscValidPointer(dm,2); 2465f1ad066SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 2475f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2485f1ad066SMatthew G Knepley } 2495f1ad066SMatthew G Knepley 2505f1ad066SMatthew G Knepley /*@ 251d9805387SMatthew G. Knepley VecSetDM - Sets the DM defining the data layout of the vector. 2525f1ad066SMatthew G Knepley 2535f1ad066SMatthew G Knepley Not collective 2545f1ad066SMatthew G Knepley 2555f1ad066SMatthew G Knepley Input Parameters: 2565f1ad066SMatthew G Knepley + v - The Vec 2575f1ad066SMatthew G Knepley - dm - The DM 2585f1ad066SMatthew G Knepley 259d9805387SMatthew G. Knepley Note: This is NOT the same as DMCreateGlobalVector() since it does not change the view methods or perform other customization, but merely sets the DM member. 260d9805387SMatthew G. Knepley 2615f1ad066SMatthew G Knepley Level: intermediate 2625f1ad066SMatthew G Knepley 2635f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2645f1ad066SMatthew G Knepley @*/ 2655f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm) 2665f1ad066SMatthew G Knepley { 2675f1ad066SMatthew G Knepley PetscErrorCode ierr; 2685f1ad066SMatthew G Knepley 2695f1ad066SMatthew G Knepley PetscFunctionBegin; 2705f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 271d7f50e27SLisandro Dalcin if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 2725f1ad066SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 2735f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2745f1ad066SMatthew G Knepley } 2755f1ad066SMatthew G Knepley 276521d9a4cSLisandro Dalcin /*@C 2778f1509bcSBarry Smith DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM 2788f1509bcSBarry Smith 279d083f849SBarry Smith Logically Collective on dm 2808f1509bcSBarry Smith 2818f1509bcSBarry Smith Input Parameters: 2828f1509bcSBarry Smith + dm - the DM context 2838f1509bcSBarry Smith - ctype - the matrix type 2848f1509bcSBarry Smith 2858f1509bcSBarry Smith Options Database: 2868f1509bcSBarry Smith . -dm_is_coloring_type - global or local 2878f1509bcSBarry Smith 2888f1509bcSBarry Smith Level: intermediate 2898f1509bcSBarry Smith 2908f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), 2918f1509bcSBarry Smith DMGetISColoringType() 2928f1509bcSBarry Smith @*/ 2938f1509bcSBarry Smith PetscErrorCode DMSetISColoringType(DM dm,ISColoringType ctype) 2948f1509bcSBarry Smith { 2958f1509bcSBarry Smith PetscFunctionBegin; 2968f1509bcSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2978f1509bcSBarry Smith dm->coloringtype = ctype; 2988f1509bcSBarry Smith PetscFunctionReturn(0); 2998f1509bcSBarry Smith } 3008f1509bcSBarry Smith 3018f1509bcSBarry Smith /*@C 3028f1509bcSBarry Smith DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM 303521d9a4cSLisandro Dalcin 304d083f849SBarry Smith Logically Collective on dm 305521d9a4cSLisandro Dalcin 306521d9a4cSLisandro Dalcin Input Parameter: 3078f1509bcSBarry Smith . dm - the DM context 3088f1509bcSBarry Smith 3098f1509bcSBarry Smith Output Parameter: 3108f1509bcSBarry Smith . ctype - the matrix type 3118f1509bcSBarry Smith 3128f1509bcSBarry Smith Options Database: 3138f1509bcSBarry Smith . -dm_is_coloring_type - global or local 3148f1509bcSBarry Smith 3158f1509bcSBarry Smith Level: intermediate 3168f1509bcSBarry Smith 3178f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), 3188f1509bcSBarry Smith DMGetISColoringType() 3198f1509bcSBarry Smith @*/ 3208f1509bcSBarry Smith PetscErrorCode DMGetISColoringType(DM dm,ISColoringType *ctype) 3218f1509bcSBarry Smith { 3228f1509bcSBarry Smith PetscFunctionBegin; 3238f1509bcSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3248f1509bcSBarry Smith *ctype = dm->coloringtype; 3258f1509bcSBarry Smith PetscFunctionReturn(0); 3268f1509bcSBarry Smith } 3278f1509bcSBarry Smith 3288f1509bcSBarry Smith /*@C 3298f1509bcSBarry Smith DMSetMatType - Sets the type of matrix created with DMCreateMatrix() 3308f1509bcSBarry Smith 331d083f849SBarry Smith Logically Collective on dm 3328f1509bcSBarry Smith 3338f1509bcSBarry Smith Input Parameters: 334521d9a4cSLisandro Dalcin + dm - the DM context 335a2b5a043SBarry Smith - ctype - the matrix type 336521d9a4cSLisandro Dalcin 337521d9a4cSLisandro Dalcin Options Database: 338521d9a4cSLisandro Dalcin . -dm_mat_type ctype 339521d9a4cSLisandro Dalcin 340521d9a4cSLisandro Dalcin Level: intermediate 341521d9a4cSLisandro Dalcin 342a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType() 343521d9a4cSLisandro Dalcin @*/ 34419fd82e9SBarry Smith PetscErrorCode DMSetMatType(DM dm,MatType ctype) 345521d9a4cSLisandro Dalcin { 346521d9a4cSLisandro Dalcin PetscErrorCode ierr; 34788f0584fSBarry Smith 348521d9a4cSLisandro Dalcin PetscFunctionBegin; 349521d9a4cSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 350521d9a4cSLisandro Dalcin ierr = PetscFree(dm->mattype);CHKERRQ(ierr); 35119fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr); 352521d9a4cSLisandro Dalcin PetscFunctionReturn(0); 353521d9a4cSLisandro Dalcin } 354521d9a4cSLisandro Dalcin 355c0dedaeaSBarry Smith /*@C 356c0dedaeaSBarry Smith DMGetMatType - Gets the type of matrix created with DMCreateMatrix() 357c0dedaeaSBarry Smith 358d083f849SBarry Smith Logically Collective on dm 359c0dedaeaSBarry Smith 360c0dedaeaSBarry Smith Input Parameter: 361c0dedaeaSBarry Smith . dm - the DM context 362c0dedaeaSBarry Smith 363c0dedaeaSBarry Smith Output Parameter: 364c0dedaeaSBarry Smith . ctype - the matrix type 365c0dedaeaSBarry Smith 366c0dedaeaSBarry Smith Options Database: 367c0dedaeaSBarry Smith . -dm_mat_type ctype 368c0dedaeaSBarry Smith 369c0dedaeaSBarry Smith Level: intermediate 370c0dedaeaSBarry Smith 371a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType() 372c0dedaeaSBarry Smith @*/ 373c0dedaeaSBarry Smith PetscErrorCode DMGetMatType(DM dm,MatType *ctype) 374c0dedaeaSBarry Smith { 375c0dedaeaSBarry Smith PetscFunctionBegin; 376c0dedaeaSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 377c0dedaeaSBarry Smith *ctype = dm->mattype; 378c0dedaeaSBarry Smith PetscFunctionReturn(0); 379c0dedaeaSBarry Smith } 380c0dedaeaSBarry Smith 381c688c046SMatthew G Knepley /*@ 38234f98d34SBarry Smith MatGetDM - Gets the DM defining the data layout of the matrix 383c688c046SMatthew G Knepley 384c688c046SMatthew G Knepley Not collective 385c688c046SMatthew G Knepley 386c688c046SMatthew G Knepley Input Parameter: 387c688c046SMatthew G Knepley . A - The Mat 388c688c046SMatthew G Knepley 389c688c046SMatthew G Knepley Output Parameter: 390c688c046SMatthew G Knepley . dm - The DM 391c688c046SMatthew G Knepley 392c688c046SMatthew G Knepley Level: intermediate 393c688c046SMatthew G Knepley 3948f1509bcSBarry Smith Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with 3958f1509bcSBarry Smith the Mat through a PetscObjectCompose() operation 3968f1509bcSBarry Smith 397c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType() 398c688c046SMatthew G Knepley @*/ 399c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm) 400c688c046SMatthew G Knepley { 401c688c046SMatthew G Knepley PetscErrorCode ierr; 402c688c046SMatthew G Knepley 403c688c046SMatthew G Knepley PetscFunctionBegin; 404c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 405c688c046SMatthew G Knepley PetscValidPointer(dm,2); 406c688c046SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 407c688c046SMatthew G Knepley PetscFunctionReturn(0); 408c688c046SMatthew G Knepley } 409c688c046SMatthew G Knepley 410c688c046SMatthew G Knepley /*@ 411c688c046SMatthew G Knepley MatSetDM - Sets the DM defining the data layout of the matrix 412c688c046SMatthew G Knepley 413c688c046SMatthew G Knepley Not collective 414c688c046SMatthew G Knepley 415c688c046SMatthew G Knepley Input Parameters: 416c688c046SMatthew G Knepley + A - The Mat 417c688c046SMatthew G Knepley - dm - The DM 418c688c046SMatthew G Knepley 419c688c046SMatthew G Knepley Level: intermediate 420c688c046SMatthew G Knepley 4218f1509bcSBarry Smith Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with 4228f1509bcSBarry Smith the Mat through a PetscObjectCompose() operation 4238f1509bcSBarry Smith 4248f1509bcSBarry Smith 425c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType() 426c688c046SMatthew G Knepley @*/ 427c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm) 428c688c046SMatthew G Knepley { 429c688c046SMatthew G Knepley PetscErrorCode ierr; 430c688c046SMatthew G Knepley 431c688c046SMatthew G Knepley PetscFunctionBegin; 432c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 4338865f1eaSKarl Rupp if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 434c688c046SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 435c688c046SMatthew G Knepley PetscFunctionReturn(0); 436c688c046SMatthew G Knepley } 437c688c046SMatthew G Knepley 4389a42bb27SBarry Smith /*@C 4399a42bb27SBarry Smith DMSetOptionsPrefix - Sets the prefix used for searching for all 4406757b960SDave May DM options in the database. 4419a42bb27SBarry Smith 442d083f849SBarry Smith Logically Collective on dm 4439a42bb27SBarry Smith 4449a42bb27SBarry Smith Input Parameter: 4458353ddbbSDave May + da - the DM context 4469a42bb27SBarry Smith - prefix - the prefix to prepend to all option names 4479a42bb27SBarry Smith 4489a42bb27SBarry Smith Notes: 4499a42bb27SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4509a42bb27SBarry Smith The first character of all runtime options is AUTOMATICALLY the hyphen. 4519a42bb27SBarry Smith 4529a42bb27SBarry Smith Level: advanced 4539a42bb27SBarry Smith 4549a42bb27SBarry Smith .seealso: DMSetFromOptions() 4559a42bb27SBarry Smith @*/ 4567087cfbeSBarry Smith PetscErrorCode DMSetOptionsPrefix(DM dm,const char prefix[]) 4579a42bb27SBarry Smith { 4589a42bb27SBarry Smith PetscErrorCode ierr; 4599a42bb27SBarry Smith 4609a42bb27SBarry Smith PetscFunctionBegin; 4619a42bb27SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4629a42bb27SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 463691be533SLawrence Mitchell if (dm->sf) { 464691be533SLawrence Mitchell ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr); 465691be533SLawrence Mitchell } 4661bb6d2a8SBarry Smith if (dm->sectionSF) { 4671bb6d2a8SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr); 468691be533SLawrence Mitchell } 4699a42bb27SBarry Smith PetscFunctionReturn(0); 4709a42bb27SBarry Smith } 4719a42bb27SBarry Smith 47231697293SDave May /*@C 47331697293SDave May DMAppendOptionsPrefix - Appends to the prefix used for searching for all 47431697293SDave May DM options in the database. 47531697293SDave May 476d083f849SBarry Smith Logically Collective on dm 47731697293SDave May 47831697293SDave May Input Parameters: 47931697293SDave May + dm - the DM context 48031697293SDave May - prefix - the prefix string to prepend to all DM option requests 48131697293SDave May 48231697293SDave May Notes: 48331697293SDave May A hyphen (-) must NOT be given at the beginning of the prefix name. 48431697293SDave May The first character of all runtime options is AUTOMATICALLY the hyphen. 48531697293SDave May 48631697293SDave May Level: advanced 48731697293SDave May 48831697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix() 48931697293SDave May @*/ 49031697293SDave May PetscErrorCode DMAppendOptionsPrefix(DM dm,const char prefix[]) 49131697293SDave May { 49231697293SDave May PetscErrorCode ierr; 49331697293SDave May 49431697293SDave May PetscFunctionBegin; 49531697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 49631697293SDave May ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 49731697293SDave May PetscFunctionReturn(0); 49831697293SDave May } 49931697293SDave May 50031697293SDave May /*@C 50131697293SDave May DMGetOptionsPrefix - Gets the prefix used for searching for all 50231697293SDave May DM options in the database. 50331697293SDave May 50431697293SDave May Not Collective 50531697293SDave May 50631697293SDave May Input Parameters: 50731697293SDave May . dm - the DM context 50831697293SDave May 50931697293SDave May Output Parameters: 51031697293SDave May . prefix - pointer to the prefix string used is returned 51131697293SDave May 51295452b02SPatrick Sanan Notes: 51395452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prefix' of 51431697293SDave May sufficient length to hold the prefix. 51531697293SDave May 51631697293SDave May Level: advanced 51731697293SDave May 51831697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix() 51931697293SDave May @*/ 52031697293SDave May PetscErrorCode DMGetOptionsPrefix(DM dm,const char *prefix[]) 52131697293SDave May { 52231697293SDave May PetscErrorCode ierr; 52331697293SDave May 52431697293SDave May PetscFunctionBegin; 52531697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 52631697293SDave May ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 52731697293SDave May PetscFunctionReturn(0); 52831697293SDave May } 52931697293SDave May 53088bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct) 53188bdff64SToby Isaac { 53288bdff64SToby Isaac PetscInt i, refct = ((PetscObject) dm)->refct; 53388bdff64SToby Isaac DMNamedVecLink nlink; 53488bdff64SToby Isaac PetscErrorCode ierr; 53588bdff64SToby Isaac 53688bdff64SToby Isaac PetscFunctionBegin; 537aab5bcd8SJed Brown *ncrefct = 0; 53888bdff64SToby Isaac /* count all the circular references of DM and its contained Vecs */ 53988bdff64SToby Isaac for (i=0; i<DM_MAX_WORK_VECTORS; i++) { 54088bdff64SToby Isaac if (dm->localin[i]) refct--; 54188bdff64SToby Isaac if (dm->globalin[i]) refct--; 54288bdff64SToby Isaac } 54388bdff64SToby Isaac for (nlink=dm->namedglobal; nlink; nlink=nlink->next) refct--; 54488bdff64SToby Isaac for (nlink=dm->namedlocal; nlink; nlink=nlink->next) refct--; 54588bdff64SToby Isaac if (dm->x) { 54688bdff64SToby Isaac DM obj; 54788bdff64SToby Isaac ierr = VecGetDM(dm->x, &obj);CHKERRQ(ierr); 54888bdff64SToby Isaac if (obj == dm) refct--; 54988bdff64SToby Isaac } 55088bdff64SToby Isaac if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) { 55188bdff64SToby Isaac refct--; 55288bdff64SToby Isaac if (recurseCoarse) { 55388bdff64SToby Isaac PetscInt coarseCount; 55488bdff64SToby Isaac 55588bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr); 55688bdff64SToby Isaac refct += coarseCount; 55788bdff64SToby Isaac } 55888bdff64SToby Isaac } 55988bdff64SToby Isaac if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) { 56088bdff64SToby Isaac refct--; 56188bdff64SToby Isaac if (recurseFine) { 56288bdff64SToby Isaac PetscInt fineCount; 56388bdff64SToby Isaac 56488bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr); 56588bdff64SToby Isaac refct += fineCount; 56688bdff64SToby Isaac } 56788bdff64SToby Isaac } 56888bdff64SToby Isaac *ncrefct = refct; 56988bdff64SToby Isaac PetscFunctionReturn(0); 57088bdff64SToby Isaac } 57188bdff64SToby Isaac 572f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm) 573354557abSToby Isaac { 5745d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 575354557abSToby Isaac PetscErrorCode ierr; 576354557abSToby Isaac 577354557abSToby Isaac PetscFunctionBegin; 578354557abSToby Isaac /* destroy the labels */ 579354557abSToby Isaac while (next) { 580354557abSToby Isaac DMLabelLink tmp = next->next; 581354557abSToby Isaac 5825d80c0bfSVaclav Hapla if (next->label == dm->depthLabel) dm->depthLabel = NULL; 583354557abSToby Isaac ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 584354557abSToby Isaac ierr = PetscFree(next);CHKERRQ(ierr); 585354557abSToby Isaac next = tmp; 586354557abSToby Isaac } 5875d80c0bfSVaclav Hapla dm->labels = NULL; 588354557abSToby Isaac PetscFunctionReturn(0); 589354557abSToby Isaac } 590354557abSToby Isaac 59147c6ae99SBarry Smith /*@ 5928472ad0fSDave May DMDestroy - Destroys a vector packer or DM. 59347c6ae99SBarry Smith 594d083f849SBarry Smith Collective on dm 59547c6ae99SBarry Smith 59647c6ae99SBarry Smith Input Parameter: 59747c6ae99SBarry Smith . dm - the DM object to destroy 59847c6ae99SBarry Smith 59947c6ae99SBarry Smith Level: developer 60047c6ae99SBarry Smith 601e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 60247c6ae99SBarry Smith 60347c6ae99SBarry Smith @*/ 604fcfd50ebSBarry Smith PetscErrorCode DMDestroy(DM *dm) 60547c6ae99SBarry Smith { 60688bdff64SToby Isaac PetscInt i, cnt; 607dfe15315SJed Brown DMNamedVecLink nlink,nnext; 60847c6ae99SBarry Smith PetscErrorCode ierr; 60947c6ae99SBarry Smith 61047c6ae99SBarry Smith PetscFunctionBegin; 6116bf464f9SBarry Smith if (!*dm) PetscFunctionReturn(0); 6126bf464f9SBarry Smith PetscValidHeaderSpecific((*dm),DM_CLASSID,1); 61387e657c6SBarry Smith 61488bdff64SToby Isaac /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */ 61588bdff64SToby Isaac ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr); 61688bdff64SToby Isaac --((PetscObject)(*dm))->refct; 61788bdff64SToby Isaac if (--cnt > 0) {*dm = 0; PetscFunctionReturn(0);} 618732e2eb9SMatthew G Knepley /* 619732e2eb9SMatthew G Knepley Need this test because the dm references the vectors that 620732e2eb9SMatthew G Knepley reference the dm, so destroying the dm calls destroy on the 621732e2eb9SMatthew G Knepley vectors that cause another destroy on the dm 622732e2eb9SMatthew G Knepley */ 6236bf464f9SBarry Smith if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0); 6246bf464f9SBarry Smith ((PetscObject) (*dm))->refct = 0; 625732e2eb9SMatthew G Knepley for (i=0; i<DM_MAX_WORK_VECTORS; i++) { 6266bf464f9SBarry Smith if ((*dm)->localout[i]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Destroying a DM that has a local vector obtained with DMGetLocalVector()"); 6276bf464f9SBarry Smith ierr = VecDestroy(&(*dm)->localin[i]);CHKERRQ(ierr); 628732e2eb9SMatthew G Knepley } 629f490541aSPeter Brune nnext=(*dm)->namedglobal; 6300298fd71SBarry Smith (*dm)->namedglobal = NULL; 631f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */ 6322348bcf4SPeter Brune nnext = nlink->next; 6332348bcf4SPeter Brune if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name); 6342348bcf4SPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 6352348bcf4SPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 6362348bcf4SPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 6372348bcf4SPeter Brune } 638f490541aSPeter Brune nnext=(*dm)->namedlocal; 6390298fd71SBarry Smith (*dm)->namedlocal = NULL; 640f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */ 641f490541aSPeter Brune nnext = nlink->next; 642f490541aSPeter Brune if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name); 643f490541aSPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 644f490541aSPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 645f490541aSPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 646f490541aSPeter Brune } 6472348bcf4SPeter Brune 648b17ce1afSJed Brown /* Destroy the list of hooks */ 649c833c3b5SJed Brown { 650c833c3b5SJed Brown DMCoarsenHookLink link,next; 651b17ce1afSJed Brown for (link=(*dm)->coarsenhook; link; link=next) { 652b17ce1afSJed Brown next = link->next; 653b17ce1afSJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 654b17ce1afSJed Brown } 6550298fd71SBarry Smith (*dm)->coarsenhook = NULL; 656c833c3b5SJed Brown } 657c833c3b5SJed Brown { 658c833c3b5SJed Brown DMRefineHookLink link,next; 659c833c3b5SJed Brown for (link=(*dm)->refinehook; link; link=next) { 660c833c3b5SJed Brown next = link->next; 661c833c3b5SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 662c833c3b5SJed Brown } 6630298fd71SBarry Smith (*dm)->refinehook = NULL; 664c833c3b5SJed Brown } 665be081cd6SPeter Brune { 666be081cd6SPeter Brune DMSubDomainHookLink link,next; 667be081cd6SPeter Brune for (link=(*dm)->subdomainhook; link; link=next) { 668be081cd6SPeter Brune next = link->next; 669be081cd6SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 670be081cd6SPeter Brune } 6710298fd71SBarry Smith (*dm)->subdomainhook = NULL; 672be081cd6SPeter Brune } 673baf369e7SPeter Brune { 674baf369e7SPeter Brune DMGlobalToLocalHookLink link,next; 675baf369e7SPeter Brune for (link=(*dm)->gtolhook; link; link=next) { 676baf369e7SPeter Brune next = link->next; 677baf369e7SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 678baf369e7SPeter Brune } 6790298fd71SBarry Smith (*dm)->gtolhook = NULL; 680baf369e7SPeter Brune } 681d4d07f1eSToby Isaac { 682d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,next; 683d4d07f1eSToby Isaac for (link=(*dm)->ltoghook; link; link=next) { 684d4d07f1eSToby Isaac next = link->next; 685d4d07f1eSToby Isaac ierr = PetscFree(link);CHKERRQ(ierr); 686d4d07f1eSToby Isaac } 687d4d07f1eSToby Isaac (*dm)->ltoghook = NULL; 688d4d07f1eSToby Isaac } 689aa1993deSMatthew G Knepley /* Destroy the work arrays */ 690aa1993deSMatthew G Knepley { 691aa1993deSMatthew G Knepley DMWorkLink link,next; 692aa1993deSMatthew G Knepley if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out"); 693aa1993deSMatthew G Knepley for (link=(*dm)->workin; link; link=next) { 694aa1993deSMatthew G Knepley next = link->next; 695aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 696aa1993deSMatthew G Knepley ierr = PetscFree(link);CHKERRQ(ierr); 697aa1993deSMatthew G Knepley } 6980298fd71SBarry Smith (*dm)->workin = NULL; 699aa1993deSMatthew G Knepley } 700c58f1c22SToby Isaac /* destroy the labels */ 701f4cdcedcSVaclav Hapla ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr); 702f4cdcedcSVaclav Hapla /* destroy the fields */ 703e5e52638SMatthew G. Knepley ierr = DMClearFields(*dm);CHKERRQ(ierr); 704f4cdcedcSVaclav Hapla /* destroy the boundaries */ 705e6f8dbb6SToby Isaac { 706e6f8dbb6SToby Isaac DMBoundary next = (*dm)->boundary; 707e6f8dbb6SToby Isaac while (next) { 708e6f8dbb6SToby Isaac DMBoundary b = next; 709e6f8dbb6SToby Isaac 710e6f8dbb6SToby Isaac next = b->next; 711e6f8dbb6SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 712e6f8dbb6SToby Isaac } 713e6f8dbb6SToby Isaac } 714b17ce1afSJed Brown 71552536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr); 71652536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr); 71752536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr); 71852536dc3SBarry Smith 7191a266240SBarry Smith if ((*dm)->ctx && (*dm)->ctxdestroy) { 7201a266240SBarry Smith ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr); 7211a266240SBarry Smith } 72287e657c6SBarry Smith ierr = VecDestroy(&(*dm)->x);CHKERRQ(ierr); 72371cd77b2SBarry Smith ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr); 7244dcab191SBarry Smith ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr); 7256bf464f9SBarry Smith ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr); 7266bf464f9SBarry Smith ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr); 727073dac72SJed Brown ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr); 72888ed4aceSMatthew G Knepley 7291bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr); 7301bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr); 7318b1ab98fSJed Brown ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr); 732fba222abSToby Isaac ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr); 733fba222abSToby Isaac ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr); 73488ed4aceSMatthew G Knepley ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr); 7351bb6d2a8SBarry Smith ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr); 736736995cdSBlaise Bourdin if ((*dm)->useNatural) { 737736995cdSBlaise Bourdin if ((*dm)->sfNatural) { 7388e4ac7eaSMatthew G. Knepley ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr); 739736995cdSBlaise Bourdin } 740736995cdSBlaise Bourdin ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr); 741736995cdSBlaise Bourdin } 74288bdff64SToby Isaac if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) { 74388bdff64SToby Isaac ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr); 74488bdff64SToby Isaac } 745a8fb8f29SToby Isaac ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr); 74688bdff64SToby Isaac if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) { 74788bdff64SToby Isaac ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr); 74888bdff64SToby Isaac } 74988bdff64SToby Isaac ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr); 750f19dbd58SToby Isaac ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr); 7516636e97aSMatthew G Knepley ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr); 7526636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr); 7536636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr); 7545dc8c3f7SMatthew G. Knepley ierr = PetscFree3((*dm)->L,(*dm)->maxCell,(*dm)->bdtype);CHKERRQ(ierr); 755ca3d3a14SMatthew G. Knepley if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);} 756ca3d3a14SMatthew G. Knepley ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr); 757ca3d3a14SMatthew G. Knepley ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr); 7586636e97aSMatthew G Knepley 759e5e52638SMatthew G. Knepley ierr = DMClearDS(*dm);CHKERRQ(ierr); 76014f150ffSMatthew G. Knepley ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr); 761e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 762e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr); 763732e2eb9SMatthew G Knepley 764ed3c66a1SDave May if ((*dm)->ops->destroy) { 7656bf464f9SBarry Smith ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr); 766ed3c66a1SDave May } 767435a35e8SMatthew G Knepley /* We do not destroy (*dm)->data here so that we can reference count backend objects */ 768732e2eb9SMatthew G Knepley ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr); 76947c6ae99SBarry Smith PetscFunctionReturn(0); 77047c6ae99SBarry Smith } 77147c6ae99SBarry Smith 772d7bf68aeSBarry Smith /*@ 773d7bf68aeSBarry Smith DMSetUp - sets up the data structures inside a DM object 774d7bf68aeSBarry Smith 775d083f849SBarry Smith Collective on dm 776d7bf68aeSBarry Smith 777d7bf68aeSBarry Smith Input Parameter: 778d7bf68aeSBarry Smith . dm - the DM object to setup 779d7bf68aeSBarry Smith 780d7bf68aeSBarry Smith Level: developer 781d7bf68aeSBarry Smith 782e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 783d7bf68aeSBarry Smith 784d7bf68aeSBarry Smith @*/ 7857087cfbeSBarry Smith PetscErrorCode DMSetUp(DM dm) 786d7bf68aeSBarry Smith { 787d7bf68aeSBarry Smith PetscErrorCode ierr; 788d7bf68aeSBarry Smith 789d7bf68aeSBarry Smith PetscFunctionBegin; 790171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7918387afaaSJed Brown if (dm->setupcalled) PetscFunctionReturn(0); 792d7bf68aeSBarry Smith if (dm->ops->setup) { 793d7bf68aeSBarry Smith ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr); 794d7bf68aeSBarry Smith } 7958387afaaSJed Brown dm->setupcalled = PETSC_TRUE; 796d7bf68aeSBarry Smith PetscFunctionReturn(0); 797d7bf68aeSBarry Smith } 798d7bf68aeSBarry Smith 799d7bf68aeSBarry Smith /*@ 800d7bf68aeSBarry Smith DMSetFromOptions - sets parameters in a DM from the options database 801d7bf68aeSBarry Smith 802d083f849SBarry Smith Collective on dm 803d7bf68aeSBarry Smith 804d7bf68aeSBarry Smith Input Parameter: 805d7bf68aeSBarry Smith . dm - the DM object to set options for 806d7bf68aeSBarry Smith 807732e2eb9SMatthew G Knepley Options Database: 8084164ae61SDominic Meiser + -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 8094164ae61SDominic Meiser . -dm_vec_type <type> - type of vector to create inside DM 8104164ae61SDominic Meiser . -dm_mat_type <type> - type of matrix to create inside DM 8118f1509bcSBarry Smith - -dm_is_coloring_type - <global or local> 812732e2eb9SMatthew G Knepley 81395eb5ee5SVaclav Hapla DMPLEX Specific Checks: 81495eb5ee5SVaclav Hapla -dm_plex_check_symmetry - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry() 81595eb5ee5SVaclav Hapla -dm_plex_check_skeleton - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton() 81695eb5ee5SVaclav Hapla -dm_plex_check_faces - Check that the faces of each cell give a vertex order this is consistent with what we expect from the cell type - DMPlexCheckFaces() 81795eb5ee5SVaclav Hapla -dm_plex_check_geometry - Check that cells have positive volume - DMPlexCheckGeometry() 81895eb5ee5SVaclav Hapla -dm_plex_check_pointsf - Check some necessary conditions for PointSF - DMPlexCheckPointSF() 81995eb5ee5SVaclav Hapla -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones() 820e902f1eaSVaclav Hapla -dm_plex_check_all - Perform all the checks above 821d7bf68aeSBarry Smith 82295eb5ee5SVaclav Hapla Level: intermediate 82395eb5ee5SVaclav Hapla 82495eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), 82595eb5ee5SVaclav Hapla DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones() 826d7bf68aeSBarry Smith 827d7bf68aeSBarry Smith @*/ 8287087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm) 829d7bf68aeSBarry Smith { 8307781c08eSBarry Smith char typeName[256]; 831ca266f36SBarry Smith PetscBool flg; 832d7bf68aeSBarry Smith PetscErrorCode ierr; 833d7bf68aeSBarry Smith 834d7bf68aeSBarry Smith PetscFunctionBegin; 835171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 83649be4549SMatthew G. Knepley dm->setfromoptionscalled = PETSC_TRUE; 83749be4549SMatthew G. Knepley if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);} 8381bb6d2a8SBarry Smith if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);} 8393194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr); 8400298fd71SBarry Smith ierr = PetscOptionsBool("-dm_preallocate_only","only preallocate matrix, but do not set column indices","DMSetMatrixPreallocateOnly",dm->prealloc_only,&dm->prealloc_only,NULL);CHKERRQ(ierr); 841a264d7a6SBarry Smith ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr); 842f9ba7244SBarry Smith if (flg) { 843f9ba7244SBarry Smith ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr); 844f9ba7244SBarry Smith } 845a264d7a6SBarry Smith ierr = PetscOptionsFList("-dm_mat_type","Matrix type used for created matrices","DMSetMatType",MatList,dm->mattype ? dm->mattype : typeName,typeName,sizeof(typeName),&flg);CHKERRQ(ierr); 846073dac72SJed Brown if (flg) { 847521d9a4cSLisandro Dalcin ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr); 848073dac72SJed Brown } 8498f1509bcSBarry Smith ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr); 850f9ba7244SBarry Smith if (dm->ops->setfromoptions) { 851e55864a3SBarry Smith ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr); 852f9ba7244SBarry Smith } 853f9ba7244SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 8540633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr); 85582fcb398SMatthew G Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 856d7bf68aeSBarry Smith PetscFunctionReturn(0); 857d7bf68aeSBarry Smith } 858d7bf68aeSBarry Smith 859fc9bc008SSatish Balay /*@C 860fe2efc57SMark DMViewFromOptions - View from Options 861fe2efc57SMark 862fe2efc57SMark Collective on DM 863fe2efc57SMark 864fe2efc57SMark Input Parameters: 865fe2efc57SMark + dm - the DM object 866736c3998SJose E. Roman . obj - Optional object 867736c3998SJose E. Roman - name - command line option 868fe2efc57SMark 869fe2efc57SMark Level: intermediate 870fe2efc57SMark .seealso: DM, DMView, PetscObjectViewFromOptions(), DMCreate() 871fe2efc57SMark @*/ 872fe2efc57SMark PetscErrorCode DMViewFromOptions(DM dm,PetscObject obj,const char name[]) 873fe2efc57SMark { 874fe2efc57SMark PetscErrorCode ierr; 875fe2efc57SMark 876fe2efc57SMark PetscFunctionBegin; 877fe2efc57SMark PetscValidHeaderSpecific(dm,DM_CLASSID,1); 878fe2efc57SMark ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr); 879fe2efc57SMark PetscFunctionReturn(0); 880fe2efc57SMark } 881fe2efc57SMark 882fe2efc57SMark /*@C 883224748a4SBarry Smith DMView - Views a DM 88447c6ae99SBarry Smith 885d083f849SBarry Smith Collective on dm 88647c6ae99SBarry Smith 88747c6ae99SBarry Smith Input Parameter: 88847c6ae99SBarry Smith + dm - the DM object to view 88947c6ae99SBarry Smith - v - the viewer 89047c6ae99SBarry Smith 891224748a4SBarry Smith Level: beginner 89247c6ae99SBarry Smith 893e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 89447c6ae99SBarry Smith 89547c6ae99SBarry Smith @*/ 8967087cfbeSBarry Smith PetscErrorCode DMView(DM dm,PetscViewer v) 89747c6ae99SBarry Smith { 89847c6ae99SBarry Smith PetscErrorCode ierr; 89932c0f0efSBarry Smith PetscBool isbinary; 90076a8abe0SBarry Smith PetscMPIInt size; 90176a8abe0SBarry Smith PetscViewerFormat format; 90247c6ae99SBarry Smith 90347c6ae99SBarry Smith PetscFunctionBegin; 904171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9053014e516SBarry Smith if (!v) { 906ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr); 9073014e516SBarry Smith } 908b1b135c8SBarry Smith PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2); 90974903a4fSStefano Zampini /* Ideally, we would like to have this test on. 91074903a4fSStefano Zampini However, it currently breaks socket viz via GLVis. 91174903a4fSStefano Zampini During DMView(parallel_mesh,glvis_viewer), each 91274903a4fSStefano Zampini process opens a sequential ASCII socket to visualize 91374903a4fSStefano Zampini the local mesh, and PetscObjectView(dm,local_socket) 91474903a4fSStefano Zampini is internally called inside VecView_GLVis, incurring 91574903a4fSStefano Zampini in an error here */ 91674903a4fSStefano Zampini /* PetscCheckSameComm(dm,1,v,2); */ 9178bfd1ab9SVaclav Hapla ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr); 918b1b135c8SBarry Smith 91976a8abe0SBarry Smith ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr); 92076a8abe0SBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRQ(ierr); 92176a8abe0SBarry Smith if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0); 92298c3331eSBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr); 92332c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 92432c0f0efSBarry Smith if (isbinary) { 92555849f57SBarry Smith PetscInt classid = DM_FILE_CLASSID; 92632c0f0efSBarry Smith char type[256]; 92732c0f0efSBarry Smith 92832c0f0efSBarry Smith ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 92932c0f0efSBarry Smith ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr); 93032c0f0efSBarry Smith ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 93132c0f0efSBarry Smith } 9320c010503SBarry Smith if (dm->ops->view) { 9330c010503SBarry Smith ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr); 93447c6ae99SBarry Smith } 93547c6ae99SBarry Smith PetscFunctionReturn(0); 93647c6ae99SBarry Smith } 93747c6ae99SBarry Smith 93847c6ae99SBarry Smith /*@ 9398472ad0fSDave May DMCreateGlobalVector - Creates a global vector from a DM object 94047c6ae99SBarry Smith 941d083f849SBarry Smith Collective on dm 94247c6ae99SBarry Smith 94347c6ae99SBarry Smith Input Parameter: 94447c6ae99SBarry Smith . dm - the DM object 94547c6ae99SBarry Smith 94647c6ae99SBarry Smith Output Parameter: 94747c6ae99SBarry Smith . vec - the global vector 94847c6ae99SBarry Smith 949073dac72SJed Brown Level: beginner 95047c6ae99SBarry Smith 951e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 95247c6ae99SBarry Smith 95347c6ae99SBarry Smith @*/ 9547087cfbeSBarry Smith PetscErrorCode DMCreateGlobalVector(DM dm,Vec *vec) 95547c6ae99SBarry Smith { 95647c6ae99SBarry Smith PetscErrorCode ierr; 95747c6ae99SBarry Smith 95847c6ae99SBarry Smith PetscFunctionBegin; 959171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 960b9d85ea2SLisandro Dalcin PetscValidPointer(vec,2); 961b9d85ea2SLisandro Dalcin if (!dm->ops->createglobalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name); 96247c6ae99SBarry Smith ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr); 96347c6ae99SBarry Smith PetscFunctionReturn(0); 96447c6ae99SBarry Smith } 96547c6ae99SBarry Smith 96647c6ae99SBarry Smith /*@ 9678472ad0fSDave May DMCreateLocalVector - Creates a local vector from a DM object 96847c6ae99SBarry Smith 96947c6ae99SBarry Smith Not Collective 97047c6ae99SBarry Smith 97147c6ae99SBarry Smith Input Parameter: 97247c6ae99SBarry Smith . dm - the DM object 97347c6ae99SBarry Smith 97447c6ae99SBarry Smith Output Parameter: 97547c6ae99SBarry Smith . vec - the local vector 97647c6ae99SBarry Smith 977073dac72SJed Brown Level: beginner 97847c6ae99SBarry Smith 979e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 98047c6ae99SBarry Smith 98147c6ae99SBarry Smith @*/ 9827087cfbeSBarry Smith PetscErrorCode DMCreateLocalVector(DM dm,Vec *vec) 98347c6ae99SBarry Smith { 98447c6ae99SBarry Smith PetscErrorCode ierr; 98547c6ae99SBarry Smith 98647c6ae99SBarry Smith PetscFunctionBegin; 987171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 988b9d85ea2SLisandro Dalcin PetscValidPointer(vec,2); 989b9d85ea2SLisandro Dalcin if (!dm->ops->createlocalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name); 99047c6ae99SBarry Smith ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr); 99147c6ae99SBarry Smith PetscFunctionReturn(0); 99247c6ae99SBarry Smith } 99347c6ae99SBarry Smith 9941411c6eeSJed Brown /*@ 9951411c6eeSJed Brown DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM. 9961411c6eeSJed Brown 997d083f849SBarry Smith Collective on dm 9981411c6eeSJed Brown 9991411c6eeSJed Brown Input Parameter: 10001411c6eeSJed Brown . dm - the DM that provides the mapping 10011411c6eeSJed Brown 10021411c6eeSJed Brown Output Parameter: 10031411c6eeSJed Brown . ltog - the mapping 10041411c6eeSJed Brown 10051411c6eeSJed Brown Level: intermediate 10061411c6eeSJed Brown 10071411c6eeSJed Brown Notes: 10081411c6eeSJed Brown This mapping can then be used by VecSetLocalToGlobalMapping() or 10091411c6eeSJed Brown MatSetLocalToGlobalMapping(). 10101411c6eeSJed Brown 1011fc31e74dSBarry Smith .seealso: DMCreateLocalVector() 10121411c6eeSJed Brown @*/ 10137087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog) 10141411c6eeSJed Brown { 10150be3e97aSMatthew G. Knepley PetscInt bs = -1, bsLocal[2], bsMinMax[2]; 10161411c6eeSJed Brown PetscErrorCode ierr; 10171411c6eeSJed Brown 10181411c6eeSJed Brown PetscFunctionBegin; 10191411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 10201411c6eeSJed Brown PetscValidPointer(ltog,2); 10211411c6eeSJed Brown if (!dm->ltogmap) { 102237d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 102337d0c07bSMatthew G Knepley 102492fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 102537d0c07bSMatthew G Knepley if (section) { 1026a974ec88SMatthew G. Knepley const PetscInt *cdofs; 102737d0c07bSMatthew G Knepley PetscInt *ltog; 1028ccf3bd66SMatthew G. Knepley PetscInt pStart, pEnd, n, p, k, l; 102937d0c07bSMatthew G Knepley 1030e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 103137d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 1032ccf3bd66SMatthew G. Knepley ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr); 1033ccf3bd66SMatthew G. Knepley ierr = PetscMalloc1(n, <og);CHKERRQ(ierr); /* We want the local+overlap size */ 103437d0c07bSMatthew G Knepley for (p = pStart, l = 0; p < pEnd; ++p) { 1035a974ec88SMatthew G. Knepley PetscInt bdof, cdof, dof, off, c, cind = 0; 103637d0c07bSMatthew G Knepley 103737d0c07bSMatthew G Knepley /* Should probably use constrained dofs */ 103837d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr); 1039a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr); 1040a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr); 104137d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr); 10421a7dc684SMatthew G. Knepley /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */ 10431a7dc684SMatthew G. Knepley bdof = cdof && (dof-cdof) ? 1 : dof; 10441a7dc684SMatthew G. Knepley if (dof) { 1045b190aa46SMatthew G. Knepley if (bs < 0) {bs = bdof;} 1046b190aa46SMatthew G. Knepley else if (bs != bdof) {bs = 1;} 10471a7dc684SMatthew G. Knepley } 104837d0c07bSMatthew G Knepley for (c = 0; c < dof; ++c, ++l) { 1049a974ec88SMatthew G. Knepley if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c; 1050a974ec88SMatthew G. Knepley else ltog[l] = (off < 0 ? -(off+1) : off) + c; 105137d0c07bSMatthew G Knepley } 105237d0c07bSMatthew G Knepley } 1053bff27382SMatthew G. Knepley /* Must have same blocksize on all procs (some might have no points) */ 10540be3e97aSMatthew G. Knepley bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs; 10550be3e97aSMatthew G. Knepley ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr); 10560be3e97aSMatthew G. Knepley if (bsMinMax[0] != bsMinMax[1]) {bs = 1;} 10570be3e97aSMatthew G. Knepley else {bs = bsMinMax[0];} 10587591dbb2SMatthew G. Knepley bs = bs < 0 ? 1 : bs; 10597591dbb2SMatthew G. Knepley /* Must reduce indices by blocksize */ 1060ccf3bd66SMatthew G. Knepley if (bs > 1) { 1061ccf3bd66SMatthew G. Knepley for (l = 0, k = 0; l < n; l += bs, ++k) ltog[k] = ltog[l]/bs; 1062ccf3bd66SMatthew G. Knepley n /= bs; 1063ccf3bd66SMatthew G. Knepley } 1064ccf3bd66SMatthew G. Knepley ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr); 10653bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr); 106637d0c07bSMatthew G Knepley } else { 1067b9d85ea2SLisandro Dalcin if (!dm->ops->getlocaltoglobalmapping) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name); 1068184d77edSJed Brown ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr); 10691411c6eeSJed Brown } 107037d0c07bSMatthew G Knepley } 10711411c6eeSJed Brown *ltog = dm->ltogmap; 10721411c6eeSJed Brown PetscFunctionReturn(0); 10731411c6eeSJed Brown } 10741411c6eeSJed Brown 10751411c6eeSJed Brown /*@ 10761411c6eeSJed Brown DMGetBlockSize - Gets the inherent block size associated with a DM 10771411c6eeSJed Brown 10781411c6eeSJed Brown Not Collective 10791411c6eeSJed Brown 10801411c6eeSJed Brown Input Parameter: 10811411c6eeSJed Brown . dm - the DM with block structure 10821411c6eeSJed Brown 10831411c6eeSJed Brown Output Parameter: 10841411c6eeSJed Brown . bs - the block size, 1 implies no exploitable block structure 10851411c6eeSJed Brown 10861411c6eeSJed Brown Level: intermediate 10871411c6eeSJed Brown 1088fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping() 10891411c6eeSJed Brown @*/ 10907087cfbeSBarry Smith PetscErrorCode DMGetBlockSize(DM dm,PetscInt *bs) 10911411c6eeSJed Brown { 10921411c6eeSJed Brown PetscFunctionBegin; 10931411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1094534a8f05SLisandro Dalcin PetscValidIntPointer(bs,2); 10951411c6eeSJed Brown if (dm->bs < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet"); 10961411c6eeSJed Brown *bs = dm->bs; 10971411c6eeSJed Brown PetscFunctionReturn(0); 10981411c6eeSJed Brown } 10991411c6eeSJed Brown 110047c6ae99SBarry Smith /*@ 11018472ad0fSDave May DMCreateInterpolation - Gets interpolation matrix between two DM objects 110247c6ae99SBarry Smith 1103d083f849SBarry Smith Collective on dm1 110447c6ae99SBarry Smith 110547c6ae99SBarry Smith Input Parameter: 110647c6ae99SBarry Smith + dm1 - the DM object 110747c6ae99SBarry Smith - dm2 - the second, finer DM object 110847c6ae99SBarry Smith 110947c6ae99SBarry Smith Output Parameter: 111047c6ae99SBarry Smith + mat - the interpolation 111147c6ae99SBarry Smith - vec - the scaling (optional) 111247c6ae99SBarry Smith 111347c6ae99SBarry Smith Level: developer 111447c6ae99SBarry Smith 111595452b02SPatrick Sanan Notes: 111695452b02SPatrick Sanan For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 111785afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 1118d52bd9f3SBarry Smith 11191f588964SMatthew G Knepley For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors 1120d52bd9f3SBarry Smith EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic. 112185afcc9aSBarry Smith 112285afcc9aSBarry Smith 11233ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction() 112447c6ae99SBarry Smith 112547c6ae99SBarry Smith @*/ 1126e727c939SJed Brown PetscErrorCode DMCreateInterpolation(DM dm1,DM dm2,Mat *mat,Vec *vec) 112747c6ae99SBarry Smith { 112847c6ae99SBarry Smith PetscErrorCode ierr; 112947c6ae99SBarry Smith 113047c6ae99SBarry Smith PetscFunctionBegin; 1131171400e9SBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 1132171400e9SBarry Smith PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 1133c7d20fa0SStefano Zampini PetscValidPointer(mat,3); 1134b9d85ea2SLisandro Dalcin if (!dm1->ops->createinterpolation) SETERRQ1(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dm1)->type_name); 1135cea54e9dSPatrick Farrell ierr = PetscLogEventBegin(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr); 113625296bd5SBarry Smith ierr = (*dm1->ops->createinterpolation)(dm1,dm2,mat,vec);CHKERRQ(ierr); 1137cea54e9dSPatrick Farrell ierr = PetscLogEventEnd(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr); 113847c6ae99SBarry Smith PetscFunctionReturn(0); 113947c6ae99SBarry Smith } 114047c6ae99SBarry Smith 11413ad4599aSBarry Smith /*@ 11423ad4599aSBarry Smith DMCreateRestriction - Gets restriction matrix between two DM objects 11433ad4599aSBarry Smith 1144d083f849SBarry Smith Collective on dm1 11453ad4599aSBarry Smith 11463ad4599aSBarry Smith Input Parameter: 11473ad4599aSBarry Smith + dm1 - the DM object 11483ad4599aSBarry Smith - dm2 - the second, finer DM object 11493ad4599aSBarry Smith 11503ad4599aSBarry Smith Output Parameter: 11513ad4599aSBarry Smith . mat - the restriction 11523ad4599aSBarry Smith 11533ad4599aSBarry Smith 11543ad4599aSBarry Smith Level: developer 11553ad4599aSBarry Smith 115695452b02SPatrick Sanan Notes: 115795452b02SPatrick Sanan For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 11583ad4599aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 11593ad4599aSBarry Smith 11603ad4599aSBarry Smith 11613ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation() 11623ad4599aSBarry Smith 11633ad4599aSBarry Smith @*/ 11643ad4599aSBarry Smith PetscErrorCode DMCreateRestriction(DM dm1,DM dm2,Mat *mat) 11653ad4599aSBarry Smith { 11663ad4599aSBarry Smith PetscErrorCode ierr; 11673ad4599aSBarry Smith 11683ad4599aSBarry Smith PetscFunctionBegin; 11693ad4599aSBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 11703ad4599aSBarry Smith PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 11715a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1172b9d85ea2SLisandro Dalcin if (!dm1->ops->createrestriction) SETERRQ1(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dm1)->type_name); 11733ad4599aSBarry Smith ierr = PetscLogEventBegin(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr); 11743ad4599aSBarry Smith ierr = (*dm1->ops->createrestriction)(dm1,dm2,mat);CHKERRQ(ierr); 11753ad4599aSBarry Smith ierr = PetscLogEventEnd(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr); 11763ad4599aSBarry Smith PetscFunctionReturn(0); 11773ad4599aSBarry Smith } 11783ad4599aSBarry Smith 117947c6ae99SBarry Smith /*@ 11808472ad0fSDave May DMCreateInjection - Gets injection matrix between two DM objects 118147c6ae99SBarry Smith 1182d083f849SBarry Smith Collective on dm1 118347c6ae99SBarry Smith 118447c6ae99SBarry Smith Input Parameter: 118547c6ae99SBarry Smith + dm1 - the DM object 118647c6ae99SBarry Smith - dm2 - the second, finer DM object 118747c6ae99SBarry Smith 118847c6ae99SBarry Smith Output Parameter: 11896dbf9973SLawrence Mitchell . mat - the injection 119047c6ae99SBarry Smith 119147c6ae99SBarry Smith Level: developer 119247c6ae99SBarry Smith 119395452b02SPatrick Sanan Notes: 119495452b02SPatrick Sanan For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 119585afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection. 119685afcc9aSBarry Smith 1197e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation() 119847c6ae99SBarry Smith 119947c6ae99SBarry Smith @*/ 12006dbf9973SLawrence Mitchell PetscErrorCode DMCreateInjection(DM dm1,DM dm2,Mat *mat) 120147c6ae99SBarry Smith { 120247c6ae99SBarry Smith PetscErrorCode ierr; 120347c6ae99SBarry Smith 120447c6ae99SBarry Smith PetscFunctionBegin; 1205171400e9SBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 1206171400e9SBarry Smith PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 12075a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1208b9d85ea2SLisandro Dalcin if (!dm1->ops->createinjection) SETERRQ1(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dm1)->type_name); 12095a84ad33SLisandro Dalcin ierr = PetscLogEventBegin(DM_CreateInjection,dm1,dm2,0,0);CHKERRQ(ierr); 12105a84ad33SLisandro Dalcin ierr = (*dm1->ops->createinjection)(dm1,dm2,mat);CHKERRQ(ierr); 12115a84ad33SLisandro Dalcin ierr = PetscLogEventEnd(DM_CreateInjection,dm1,dm2,0,0);CHKERRQ(ierr); 121247c6ae99SBarry Smith PetscFunctionReturn(0); 121347c6ae99SBarry Smith } 121447c6ae99SBarry Smith 1215b412c318SBarry Smith /*@ 1216bd041c0cSMatthew G. Knepley DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j 1217bd041c0cSMatthew G. Knepley 1218d083f849SBarry Smith Collective on dm1 1219bd041c0cSMatthew G. Knepley 1220bd041c0cSMatthew G. Knepley Input Parameter: 1221bd041c0cSMatthew G. Knepley + dm1 - the DM object 1222bd041c0cSMatthew G. Knepley - dm2 - the second, finer DM object 1223bd041c0cSMatthew G. Knepley 1224bd041c0cSMatthew G. Knepley Output Parameter: 1225bd041c0cSMatthew G. Knepley . mat - the interpolation 1226bd041c0cSMatthew G. Knepley 1227bd041c0cSMatthew G. Knepley Level: developer 1228bd041c0cSMatthew G. Knepley 1229bd041c0cSMatthew G. Knepley .seealso DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection() 1230bd041c0cSMatthew G. Knepley @*/ 1231bd041c0cSMatthew G. Knepley PetscErrorCode DMCreateMassMatrix(DM dm1, DM dm2, Mat *mat) 1232bd041c0cSMatthew G. Knepley { 1233bd041c0cSMatthew G. Knepley PetscErrorCode ierr; 1234bd041c0cSMatthew G. Knepley 1235bd041c0cSMatthew G. Knepley PetscFunctionBegin; 1236bd041c0cSMatthew G. Knepley PetscValidHeaderSpecific(dm1, DM_CLASSID, 1); 1237bd041c0cSMatthew G. Knepley PetscValidHeaderSpecific(dm2, DM_CLASSID, 2); 12385a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1239b9d85ea2SLisandro Dalcin if (!dm1->ops->createmassmatrix) SETERRQ1(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dm1)->type_name); 1240bd041c0cSMatthew G. Knepley ierr = (*dm1->ops->createmassmatrix)(dm1, dm2, mat);CHKERRQ(ierr); 1241bd041c0cSMatthew G. Knepley PetscFunctionReturn(0); 1242bd041c0cSMatthew G. Knepley } 1243bd041c0cSMatthew G. Knepley 1244bd041c0cSMatthew G. Knepley /*@ 1245b412c318SBarry Smith DMCreateColoring - Gets coloring for a DM 124647c6ae99SBarry Smith 1247d083f849SBarry Smith Collective on dm 124847c6ae99SBarry Smith 124947c6ae99SBarry Smith Input Parameter: 125047c6ae99SBarry Smith + dm - the DM object 12515bdb020cSBarry Smith - ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL 125247c6ae99SBarry Smith 125347c6ae99SBarry Smith Output Parameter: 125447c6ae99SBarry Smith . coloring - the coloring 125547c6ae99SBarry Smith 1256*ec5066bdSBarry Smith Notes: 1257*ec5066bdSBarry Smith Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the MatColoring object or from the mesh from which the 1258*ec5066bdSBarry Smith matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors). 1259*ec5066bdSBarry Smith 1260*ec5066bdSBarry Smith This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate() 1261*ec5066bdSBarry Smith 126247c6ae99SBarry Smith Level: developer 126347c6ae99SBarry Smith 1264*ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate() 126547c6ae99SBarry Smith 1266aab9d709SJed Brown @*/ 1267b412c318SBarry Smith PetscErrorCode DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring) 126847c6ae99SBarry Smith { 126947c6ae99SBarry Smith PetscErrorCode ierr; 127047c6ae99SBarry Smith 127147c6ae99SBarry Smith PetscFunctionBegin; 1272171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 12735a84ad33SLisandro Dalcin PetscValidPointer(coloring,3); 1274b9d85ea2SLisandro Dalcin if (!dm->ops->getcoloring) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name); 1275b412c318SBarry Smith ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr); 127647c6ae99SBarry Smith PetscFunctionReturn(0); 127747c6ae99SBarry Smith } 127847c6ae99SBarry Smith 1279b412c318SBarry Smith /*@ 12808472ad0fSDave May DMCreateMatrix - Gets empty Jacobian for a DM 128147c6ae99SBarry Smith 1282d083f849SBarry Smith Collective on dm 128347c6ae99SBarry Smith 128447c6ae99SBarry Smith Input Parameter: 1285b412c318SBarry Smith . dm - the DM object 128647c6ae99SBarry Smith 128747c6ae99SBarry Smith Output Parameter: 128847c6ae99SBarry Smith . mat - the empty Jacobian 128947c6ae99SBarry Smith 1290073dac72SJed Brown Level: beginner 129147c6ae99SBarry Smith 129295452b02SPatrick Sanan Notes: 129395452b02SPatrick Sanan This properly preallocates the number of nonzeros in the sparse matrix so you 129494013140SBarry Smith do not need to do it yourself. 129594013140SBarry Smith 129694013140SBarry Smith By default it also sets the nonzero structure and puts in the zero entries. To prevent setting 12977889ec69SBarry Smith the nonzero pattern call DMSetMatrixPreallocateOnly() 129894013140SBarry Smith 129994013140SBarry Smith For structured grid problems, when you call MatView() on this matrix it is displayed using the global natural ordering, NOT in the ordering used 130094013140SBarry Smith internally by PETSc. 130194013140SBarry Smith 130294013140SBarry Smith For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires 1303aa219208SBarry Smith the indices for the global numbering for DMDAs which is complicated. 130494013140SBarry Smith 1305b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType() 130647c6ae99SBarry Smith 1307aab9d709SJed Brown @*/ 1308b412c318SBarry Smith PetscErrorCode DMCreateMatrix(DM dm,Mat *mat) 130947c6ae99SBarry Smith { 131047c6ae99SBarry Smith PetscErrorCode ierr; 131147c6ae99SBarry Smith 131247c6ae99SBarry Smith PetscFunctionBegin; 1313171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1314c7b7c8a4SJed Brown PetscValidPointer(mat,3); 1315b9d85ea2SLisandro Dalcin if (!dm->ops->creatematrix) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name); 13165a84ad33SLisandro Dalcin ierr = MatInitializePackage();CHKERRQ(ierr); 1317fdc842d1SBarry Smith ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 1318b412c318SBarry Smith ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr); 1319e571a35bSMatthew G. Knepley /* Handle nullspace and near nullspace */ 1320e5e52638SMatthew G. Knepley if (dm->Nf) { 1321e571a35bSMatthew G. Knepley MatNullSpace nullSpace; 1322e571a35bSMatthew G. Knepley PetscInt Nf; 1323e571a35bSMatthew G. Knepley 1324e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 1325e571a35bSMatthew G. Knepley if (Nf == 1) { 1326e571a35bSMatthew G. Knepley if (dm->nullspaceConstructors[0]) { 1327e571a35bSMatthew G. Knepley ierr = (*dm->nullspaceConstructors[0])(dm, 0, &nullSpace);CHKERRQ(ierr); 1328e571a35bSMatthew G. Knepley ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1329e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1330e571a35bSMatthew G. Knepley } 1331e571a35bSMatthew G. Knepley if (dm->nearnullspaceConstructors[0]) { 1332e571a35bSMatthew G. Knepley ierr = (*dm->nearnullspaceConstructors[0])(dm, 0, &nullSpace);CHKERRQ(ierr); 1333e571a35bSMatthew G. Knepley ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1334e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1335e571a35bSMatthew G. Knepley } 1336e571a35bSMatthew G. Knepley } 1337e571a35bSMatthew G. Knepley } 1338fdc842d1SBarry Smith ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 133947c6ae99SBarry Smith PetscFunctionReturn(0); 134047c6ae99SBarry Smith } 134147c6ae99SBarry Smith 1342732e2eb9SMatthew G Knepley /*@ 1343950540a4SJed Brown DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly 1344732e2eb9SMatthew G Knepley preallocated but the nonzero structure and zero values will not be set. 1345732e2eb9SMatthew G Knepley 1346d083f849SBarry Smith Logically Collective on dm 1347732e2eb9SMatthew G Knepley 1348732e2eb9SMatthew G Knepley Input Parameter: 1349732e2eb9SMatthew G Knepley + dm - the DM 1350732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation 1351732e2eb9SMatthew G Knepley 1352732e2eb9SMatthew G Knepley Level: developer 1353b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly() 1354732e2eb9SMatthew G Knepley @*/ 1355732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only) 1356732e2eb9SMatthew G Knepley { 1357732e2eb9SMatthew G Knepley PetscFunctionBegin; 1358732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1359732e2eb9SMatthew G Knepley dm->prealloc_only = only; 1360732e2eb9SMatthew G Knepley PetscFunctionReturn(0); 1361732e2eb9SMatthew G Knepley } 1362732e2eb9SMatthew G Knepley 1363b06ff27eSHong Zhang /*@ 1364b06ff27eSHong Zhang DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created 1365b06ff27eSHong Zhang but the array for values will not be allocated. 1366b06ff27eSHong Zhang 1367d083f849SBarry Smith Logically Collective on dm 1368b06ff27eSHong Zhang 1369b06ff27eSHong Zhang Input Parameter: 1370b06ff27eSHong Zhang + dm - the DM 1371b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture 1372b06ff27eSHong Zhang 1373b06ff27eSHong Zhang Level: developer 1374b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly() 1375b06ff27eSHong Zhang @*/ 1376b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only) 1377b06ff27eSHong Zhang { 1378b06ff27eSHong Zhang PetscFunctionBegin; 1379b06ff27eSHong Zhang PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1380b06ff27eSHong Zhang dm->structure_only = only; 1381b06ff27eSHong Zhang PetscFunctionReturn(0); 1382b06ff27eSHong Zhang } 1383b06ff27eSHong Zhang 1384a89ea682SMatthew G Knepley /*@C 1385aa1993deSMatthew G Knepley DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1386a89ea682SMatthew G Knepley 1387a89ea682SMatthew G Knepley Not Collective 1388a89ea682SMatthew G Knepley 1389a89ea682SMatthew G Knepley Input Parameters: 1390a89ea682SMatthew G Knepley + dm - the DM object 1391aa1993deSMatthew G Knepley . count - The minium size 139269291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT) 1393a89ea682SMatthew G Knepley 1394a89ea682SMatthew G Knepley Output Parameter: 1395a89ea682SMatthew G Knepley . array - the work array 1396a89ea682SMatthew G Knepley 1397a89ea682SMatthew G Knepley Level: developer 1398a89ea682SMatthew G Knepley 1399a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate() 1400a89ea682SMatthew G Knepley @*/ 140169291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1402a89ea682SMatthew G Knepley { 1403a89ea682SMatthew G Knepley PetscErrorCode ierr; 1404aa1993deSMatthew G Knepley DMWorkLink link; 140569291d52SBarry Smith PetscMPIInt dsize; 1406a89ea682SMatthew G Knepley 1407a89ea682SMatthew G Knepley PetscFunctionBegin; 1408a89ea682SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1409aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1410aa1993deSMatthew G Knepley if (dm->workin) { 1411aa1993deSMatthew G Knepley link = dm->workin; 1412aa1993deSMatthew G Knepley dm->workin = dm->workin->next; 1413aa1993deSMatthew G Knepley } else { 1414b00a9115SJed Brown ierr = PetscNewLog(dm,&link);CHKERRQ(ierr); 1415a89ea682SMatthew G Knepley } 141669291d52SBarry Smith ierr = MPI_Type_size(dtype,&dsize);CHKERRQ(ierr); 14175056fcd2SBarry Smith if (((size_t)dsize*count) > link->bytes) { 1418aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 1419854ce69bSBarry Smith ierr = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr); 1420854ce69bSBarry Smith link->bytes = dsize*count; 1421aa1993deSMatthew G Knepley } 1422aa1993deSMatthew G Knepley link->next = dm->workout; 1423aa1993deSMatthew G Knepley dm->workout = link; 1424aa1993deSMatthew G Knepley *(void**)mem = link->mem; 1425a89ea682SMatthew G Knepley PetscFunctionReturn(0); 1426a89ea682SMatthew G Knepley } 1427a89ea682SMatthew G Knepley 1428aa1993deSMatthew G Knepley /*@C 1429aa1993deSMatthew G Knepley DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1430aa1993deSMatthew G Knepley 1431aa1993deSMatthew G Knepley Not Collective 1432aa1993deSMatthew G Knepley 1433aa1993deSMatthew G Knepley Input Parameters: 1434aa1993deSMatthew G Knepley + dm - the DM object 1435aa1993deSMatthew G Knepley . count - The minium size 143669291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT 1437aa1993deSMatthew G Knepley 1438aa1993deSMatthew G Knepley Output Parameter: 1439aa1993deSMatthew G Knepley . array - the work array 1440aa1993deSMatthew G Knepley 1441aa1993deSMatthew G Knepley Level: developer 1442aa1993deSMatthew G Knepley 144395452b02SPatrick Sanan Developer Notes: 144495452b02SPatrick Sanan count and dtype are ignored, they are only needed for DMGetWorkArray() 1445aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate() 1446aa1993deSMatthew G Knepley @*/ 144769291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1448aa1993deSMatthew G Knepley { 1449aa1993deSMatthew G Knepley DMWorkLink *p,link; 1450aa1993deSMatthew G Knepley 1451aa1993deSMatthew G Knepley PetscFunctionBegin; 1452aa1993deSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1453aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1454aa1993deSMatthew G Knepley for (p=&dm->workout; (link=*p); p=&link->next) { 1455aa1993deSMatthew G Knepley if (link->mem == *(void**)mem) { 1456aa1993deSMatthew G Knepley *p = link->next; 1457aa1993deSMatthew G Knepley link->next = dm->workin; 1458aa1993deSMatthew G Knepley dm->workin = link; 14590298fd71SBarry Smith *(void**)mem = NULL; 1460aa1993deSMatthew G Knepley PetscFunctionReturn(0); 1461aa1993deSMatthew G Knepley } 1462aa1993deSMatthew G Knepley } 1463aa1993deSMatthew G Knepley SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out"); 1464aa1993deSMatthew G Knepley } 1465e7c4fc90SDmitry Karpeev 1466435a35e8SMatthew G Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace)) 1467435a35e8SMatthew G Knepley { 1468435a35e8SMatthew G Knepley PetscFunctionBegin; 1469435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 147082f516ccSBarry Smith if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1471435a35e8SMatthew G Knepley dm->nullspaceConstructors[field] = nullsp; 1472435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1473435a35e8SMatthew G Knepley } 1474435a35e8SMatthew G Knepley 14750a50eb56SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace)) 14760a50eb56SMatthew G. Knepley { 14770a50eb56SMatthew G. Knepley PetscFunctionBegin; 14780a50eb56SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1479f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 14800a50eb56SMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 14810a50eb56SMatthew G. Knepley *nullsp = dm->nullspaceConstructors[field]; 14820a50eb56SMatthew G. Knepley PetscFunctionReturn(0); 14830a50eb56SMatthew G. Knepley } 14840a50eb56SMatthew G. Knepley 1485f9d4088aSMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace)) 1486f9d4088aSMatthew G. Knepley { 1487f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1488f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1489f9d4088aSMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1490f9d4088aSMatthew G. Knepley dm->nearnullspaceConstructors[field] = nullsp; 1491f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1492f9d4088aSMatthew G. Knepley } 1493f9d4088aSMatthew G. Knepley 1494f9d4088aSMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace)) 1495f9d4088aSMatthew G. Knepley { 1496f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1497f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1498f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 1499f9d4088aSMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1500f9d4088aSMatthew G. Knepley *nullsp = dm->nearnullspaceConstructors[field]; 1501f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1502f9d4088aSMatthew G. Knepley } 1503f9d4088aSMatthew G. Knepley 15044f3b5142SJed Brown /*@C 15054d343eeaSMatthew G Knepley DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field 15064d343eeaSMatthew G Knepley 15074d343eeaSMatthew G Knepley Not collective 15084d343eeaSMatthew G Knepley 15094d343eeaSMatthew G Knepley Input Parameter: 15104d343eeaSMatthew G Knepley . dm - the DM object 15114d343eeaSMatthew G Knepley 15124d343eeaSMatthew G Knepley Output Parameters: 15130298fd71SBarry Smith + numFields - The number of fields (or NULL if not requested) 15140298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested) 15150298fd71SBarry Smith - fields - The global indices for each field (or NULL if not requested) 15164d343eeaSMatthew G Knepley 15174d343eeaSMatthew G Knepley Level: intermediate 15184d343eeaSMatthew G Knepley 151921c9b008SJed Brown Notes: 152021c9b008SJed Brown The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 152121c9b008SJed Brown PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with 152221c9b008SJed Brown PetscFree(). 152321c9b008SJed Brown 15244d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 15254d343eeaSMatthew G Knepley @*/ 152637d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields) 15274d343eeaSMatthew G Knepley { 152837d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 15294d343eeaSMatthew G Knepley PetscErrorCode ierr; 15304d343eeaSMatthew G Knepley 15314d343eeaSMatthew G Knepley PetscFunctionBegin; 15324d343eeaSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 153369ca1f37SDmitry Karpeev if (numFields) { 1534534a8f05SLisandro Dalcin PetscValidIntPointer(numFields,2); 153569ca1f37SDmitry Karpeev *numFields = 0; 153669ca1f37SDmitry Karpeev } 153737d0c07bSMatthew G Knepley if (fieldNames) { 153837d0c07bSMatthew G Knepley PetscValidPointer(fieldNames,3); 15390298fd71SBarry Smith *fieldNames = NULL; 154069ca1f37SDmitry Karpeev } 154169ca1f37SDmitry Karpeev if (fields) { 154269ca1f37SDmitry Karpeev PetscValidPointer(fields,4); 15430298fd71SBarry Smith *fields = NULL; 154469ca1f37SDmitry Karpeev } 154592fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 154637d0c07bSMatthew G Knepley if (section) { 15473a544194SStefano Zampini PetscInt *fieldSizes, *fieldNc, **fieldIndices; 154837d0c07bSMatthew G Knepley PetscInt nF, f, pStart, pEnd, p; 154937d0c07bSMatthew G Knepley 1550e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 155137d0c07bSMatthew G Knepley ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr); 15523a544194SStefano Zampini ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr); 155337d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr); 155437d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 155537d0c07bSMatthew G Knepley fieldSizes[f] = 0; 15563a544194SStefano Zampini ierr = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr); 155737d0c07bSMatthew G Knepley } 155837d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 155937d0c07bSMatthew G Knepley PetscInt gdof; 156037d0c07bSMatthew G Knepley 156137d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 156237d0c07bSMatthew G Knepley if (gdof > 0) { 156337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 15643a544194SStefano Zampini PetscInt fdof, fcdof, fpdof; 156537d0c07bSMatthew G Knepley 156637d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 156737d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 15683a544194SStefano Zampini fpdof = fdof-fcdof; 15693a544194SStefano Zampini if (fpdof && fpdof != fieldNc[f]) { 15703a544194SStefano Zampini /* Layout does not admit a pointwise block size */ 15713a544194SStefano Zampini fieldNc[f] = 1; 15723a544194SStefano Zampini } 15733a544194SStefano Zampini fieldSizes[f] += fpdof; 157437d0c07bSMatthew G Knepley } 157537d0c07bSMatthew G Knepley } 157637d0c07bSMatthew G Knepley } 157737d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 1578785e854fSJed Brown ierr = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr); 157937d0c07bSMatthew G Knepley fieldSizes[f] = 0; 158037d0c07bSMatthew G Knepley } 158137d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 158237d0c07bSMatthew G Knepley PetscInt gdof, goff; 158337d0c07bSMatthew G Knepley 158437d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 158537d0c07bSMatthew G Knepley if (gdof > 0) { 158637d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr); 158737d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 158837d0c07bSMatthew G Knepley PetscInt fdof, fcdof, fc; 158937d0c07bSMatthew G Knepley 159037d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 159137d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 159237d0c07bSMatthew G Knepley for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) { 159337d0c07bSMatthew G Knepley fieldIndices[f][fieldSizes[f]] = goff++; 159437d0c07bSMatthew G Knepley } 159537d0c07bSMatthew G Knepley } 159637d0c07bSMatthew G Knepley } 159737d0c07bSMatthew G Knepley } 15988865f1eaSKarl Rupp if (numFields) *numFields = nF; 159937d0c07bSMatthew G Knepley if (fieldNames) { 1600785e854fSJed Brown ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr); 160137d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 160237d0c07bSMatthew G Knepley const char *fieldName; 160337d0c07bSMatthew G Knepley 160437d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 160537d0c07bSMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr); 160637d0c07bSMatthew G Knepley } 160737d0c07bSMatthew G Knepley } 160837d0c07bSMatthew G Knepley if (fields) { 1609785e854fSJed Brown ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr); 161037d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 16113a544194SStefano Zampini PetscInt bs, in[2], out[2]; 16123a544194SStefano Zampini 161382f516ccSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr); 16143a544194SStefano Zampini in[0] = -fieldNc[f]; 16153a544194SStefano Zampini in[1] = fieldNc[f]; 16163a544194SStefano Zampini ierr = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 16173a544194SStefano Zampini bs = (-out[0] == out[1]) ? out[1] : 1; 16183a544194SStefano Zampini ierr = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr); 161937d0c07bSMatthew G Knepley } 162037d0c07bSMatthew G Knepley } 16213a544194SStefano Zampini ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr); 16228865f1eaSKarl Rupp } else if (dm->ops->createfieldis) { 16238865f1eaSKarl Rupp ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr); 162469ca1f37SDmitry Karpeev } 16254d343eeaSMatthew G Knepley PetscFunctionReturn(0); 16264d343eeaSMatthew G Knepley } 16274d343eeaSMatthew G Knepley 162816621825SDmitry Karpeev 162916621825SDmitry Karpeev /*@C 163016621825SDmitry Karpeev DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems 163116621825SDmitry Karpeev corresponding to different fields: each IS contains the global indices of the dofs of the 163216621825SDmitry Karpeev corresponding field. The optional list of DMs define the DM for each subproblem. 1633e7c4fc90SDmitry Karpeev Generalizes DMCreateFieldIS(). 1634e7c4fc90SDmitry Karpeev 1635e7c4fc90SDmitry Karpeev Not collective 1636e7c4fc90SDmitry Karpeev 1637e7c4fc90SDmitry Karpeev Input Parameter: 1638e7c4fc90SDmitry Karpeev . dm - the DM object 1639e7c4fc90SDmitry Karpeev 1640e7c4fc90SDmitry Karpeev Output Parameters: 16410298fd71SBarry Smith + len - The number of subproblems in the field decomposition (or NULL if not requested) 16420298fd71SBarry Smith . namelist - The name for each field (or NULL if not requested) 16430298fd71SBarry Smith . islist - The global indices for each field (or NULL if not requested) 16440298fd71SBarry Smith - dmlist - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 1645e7c4fc90SDmitry Karpeev 1646e7c4fc90SDmitry Karpeev Level: intermediate 1647e7c4fc90SDmitry Karpeev 1648e7c4fc90SDmitry Karpeev Notes: 1649e7c4fc90SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 1650e7c4fc90SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 1651e7c4fc90SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 1652e7c4fc90SDmitry Karpeev 1653e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1654e7c4fc90SDmitry Karpeev @*/ 165516621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist) 1656e7c4fc90SDmitry Karpeev { 1657e7c4fc90SDmitry Karpeev PetscErrorCode ierr; 1658e7c4fc90SDmitry Karpeev 1659e7c4fc90SDmitry Karpeev PetscFunctionBegin; 1660e7c4fc90SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 16618865f1eaSKarl Rupp if (len) { 1662534a8f05SLisandro Dalcin PetscValidIntPointer(len,2); 16638865f1eaSKarl Rupp *len = 0; 16648865f1eaSKarl Rupp } 16658865f1eaSKarl Rupp if (namelist) { 16668865f1eaSKarl Rupp PetscValidPointer(namelist,3); 16678865f1eaSKarl Rupp *namelist = 0; 16688865f1eaSKarl Rupp } 16698865f1eaSKarl Rupp if (islist) { 16708865f1eaSKarl Rupp PetscValidPointer(islist,4); 16718865f1eaSKarl Rupp *islist = 0; 16728865f1eaSKarl Rupp } 16738865f1eaSKarl Rupp if (dmlist) { 16748865f1eaSKarl Rupp PetscValidPointer(dmlist,5); 16758865f1eaSKarl Rupp *dmlist = 0; 16768865f1eaSKarl Rupp } 1677f3f0edfdSDmitry Karpeev /* 1678f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 1679f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 1680f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 1681f3f0edfdSDmitry Karpeev */ 1682ce94432eSBarry Smith if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 168316621825SDmitry Karpeev if (!dm->ops->createfielddecomposition) { 1684435a35e8SMatthew G Knepley PetscSection section; 1685435a35e8SMatthew G Knepley PetscInt numFields, f; 1686435a35e8SMatthew G Knepley 168792fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 1688435a35e8SMatthew G Knepley if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);} 1689435a35e8SMatthew G Knepley if (section && numFields && dm->ops->createsubdm) { 1690f25d98f1SMatthew G. Knepley if (len) *len = numFields; 169103dc3394SMatthew G. Knepley if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);} 169203dc3394SMatthew G. Knepley if (islist) {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);} 169303dc3394SMatthew G. Knepley if (dmlist) {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);} 1694435a35e8SMatthew G Knepley for (f = 0; f < numFields; ++f) { 1695435a35e8SMatthew G Knepley const char *fieldName; 1696435a35e8SMatthew G Knepley 169703dc3394SMatthew G. Knepley ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr); 169803dc3394SMatthew G. Knepley if (namelist) { 1699435a35e8SMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 1700435a35e8SMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr); 1701435a35e8SMatthew G Knepley } 170203dc3394SMatthew G. Knepley } 1703435a35e8SMatthew G Knepley } else { 170469ca1f37SDmitry Karpeev ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr); 1705e7c4fc90SDmitry Karpeev /* By default there are no DMs associated with subproblems. */ 17060298fd71SBarry Smith if (dmlist) *dmlist = NULL; 1707e7c4fc90SDmitry Karpeev } 17088865f1eaSKarl Rupp } else { 170916621825SDmitry Karpeev ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr); 171016621825SDmitry Karpeev } 171116621825SDmitry Karpeev PetscFunctionReturn(0); 171216621825SDmitry Karpeev } 171316621825SDmitry Karpeev 1714564cec59SMatthew G. Knepley /*@ 1715435a35e8SMatthew G Knepley DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in. 1716435a35e8SMatthew G Knepley The fields are defined by DMCreateFieldIS(). 1717435a35e8SMatthew G Knepley 1718435a35e8SMatthew G Knepley Not collective 1719435a35e8SMatthew G Knepley 1720435a35e8SMatthew G Knepley Input Parameters: 17212adcc780SMatthew G. Knepley + dm - The DM object 17222adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem 17232adcc780SMatthew G. Knepley - fields - The field numbers of the selected fields 1724435a35e8SMatthew G Knepley 1725435a35e8SMatthew G Knepley Output Parameters: 17262adcc780SMatthew G. Knepley + is - The global indices for the subproblem 17272adcc780SMatthew G. Knepley - subdm - The DM for the subproblem 1728435a35e8SMatthew G Knepley 17295d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 17305d3b26e6SMatthew G. Knepley 1731435a35e8SMatthew G Knepley Level: intermediate 1732435a35e8SMatthew G Knepley 17335d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1734435a35e8SMatthew G Knepley @*/ 173537bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm) 1736435a35e8SMatthew G Knepley { 1737435a35e8SMatthew G Knepley PetscErrorCode ierr; 1738435a35e8SMatthew G Knepley 1739435a35e8SMatthew G Knepley PetscFunctionBegin; 1740435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1741435a35e8SMatthew G Knepley PetscValidPointer(fields,3); 17428865f1eaSKarl Rupp if (is) PetscValidPointer(is,4); 17438865f1eaSKarl Rupp if (subdm) PetscValidPointer(subdm,5); 1744b9d85ea2SLisandro Dalcin if (!dm->ops->createsubdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name); 1745435a35e8SMatthew G Knepley ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr); 1746435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1747435a35e8SMatthew G Knepley } 1748435a35e8SMatthew G Knepley 17492adcc780SMatthew G. Knepley /*@C 17502adcc780SMatthew G. Knepley DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in. 17512adcc780SMatthew G. Knepley 17522adcc780SMatthew G. Knepley Not collective 17532adcc780SMatthew G. Knepley 17542adcc780SMatthew G. Knepley Input Parameter: 17552adcc780SMatthew G. Knepley + dms - The DM objects 17562adcc780SMatthew G. Knepley - len - The number of DMs 17572adcc780SMatthew G. Knepley 17582adcc780SMatthew G. Knepley Output Parameters: 1759a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL 17602adcc780SMatthew G. Knepley - superdm - The DM for the superproblem 17612adcc780SMatthew G. Knepley 17625d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 17635d3b26e6SMatthew G. Knepley 17642adcc780SMatthew G. Knepley Level: intermediate 17652adcc780SMatthew G. Knepley 17665d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 17672adcc780SMatthew G. Knepley @*/ 17682adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm) 17692adcc780SMatthew G. Knepley { 17702adcc780SMatthew G. Knepley PetscInt i; 17712adcc780SMatthew G. Knepley PetscErrorCode ierr; 17722adcc780SMatthew G. Knepley 17732adcc780SMatthew G. Knepley PetscFunctionBegin; 17742adcc780SMatthew G. Knepley PetscValidPointer(dms,1); 17752adcc780SMatthew G. Knepley for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);} 17762adcc780SMatthew G. Knepley if (is) PetscValidPointer(is,3); 1777a42bd24dSMatthew G. Knepley PetscValidPointer(superdm,4); 17782adcc780SMatthew G. Knepley if (len < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len); 17792adcc780SMatthew G. Knepley if (len) { 1780b9d85ea2SLisandro Dalcin DM dm = dms[0]; 1781b9d85ea2SLisandro Dalcin if (!dm->ops->createsuperdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name); 1782b9d85ea2SLisandro Dalcin ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr); 17832adcc780SMatthew G. Knepley } 17842adcc780SMatthew G. Knepley PetscFunctionReturn(0); 17852adcc780SMatthew G. Knepley } 17862adcc780SMatthew G. Knepley 178716621825SDmitry Karpeev 178816621825SDmitry Karpeev /*@C 17898d4ac253SDmitry Karpeev DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems 17908d4ac253SDmitry Karpeev corresponding to restrictions to pairs nested subdomains: each IS contains the global 17918d4ac253SDmitry Karpeev indices of the dofs of the corresponding subdomains. The inner subdomains conceptually 17928d4ac253SDmitry Karpeev define a nonoverlapping covering, while outer subdomains can overlap. 17938d4ac253SDmitry Karpeev The optional list of DMs define the DM for each subproblem. 179416621825SDmitry Karpeev 179516621825SDmitry Karpeev Not collective 179616621825SDmitry Karpeev 179716621825SDmitry Karpeev Input Parameter: 179816621825SDmitry Karpeev . dm - the DM object 179916621825SDmitry Karpeev 180016621825SDmitry Karpeev Output Parameters: 18010298fd71SBarry Smith + len - The number of subproblems in the domain decomposition (or NULL if not requested) 18020298fd71SBarry Smith . namelist - The name for each subdomain (or NULL if not requested) 18030298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested) 18040298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested) 18050298fd71SBarry Smith - dmlist - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 180616621825SDmitry Karpeev 180716621825SDmitry Karpeev Level: intermediate 180816621825SDmitry Karpeev 180916621825SDmitry Karpeev Notes: 181016621825SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 181116621825SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 181216621825SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 181316621825SDmitry Karpeev 18148d4ac253SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateDomainDecompositionDM(), DMCreateFieldDecomposition() 181516621825SDmitry Karpeev @*/ 18168d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist) 181716621825SDmitry Karpeev { 181816621825SDmitry Karpeev PetscErrorCode ierr; 1819be081cd6SPeter Brune DMSubDomainHookLink link; 1820be081cd6SPeter Brune PetscInt i,l; 182116621825SDmitry Karpeev 182216621825SDmitry Karpeev PetscFunctionBegin; 182316621825SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 182414a18fd3SPeter Brune if (len) {PetscValidPointer(len,2); *len = 0;} 18250298fd71SBarry Smith if (namelist) {PetscValidPointer(namelist,3); *namelist = NULL;} 18260298fd71SBarry Smith if (innerislist) {PetscValidPointer(innerislist,4); *innerislist = NULL;} 18270298fd71SBarry Smith if (outerislist) {PetscValidPointer(outerislist,5); *outerislist = NULL;} 18280298fd71SBarry Smith if (dmlist) {PetscValidPointer(dmlist,6); *dmlist = NULL;} 1829f3f0edfdSDmitry Karpeev /* 1830f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 1831f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 1832f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 1833f3f0edfdSDmitry Karpeev */ 1834ce94432eSBarry Smith if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 183516621825SDmitry Karpeev if (dm->ops->createdomaindecomposition) { 1836be081cd6SPeter Brune ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr); 183714a18fd3SPeter Brune /* copy subdomain hooks and context over to the subdomain DMs */ 1838f891f5b9SPatrick Sanan if (dmlist && *dmlist) { 1839be081cd6SPeter Brune for (i = 0; i < l; i++) { 1840be081cd6SPeter Brune for (link=dm->subdomainhook; link; link=link->next) { 1841be081cd6SPeter Brune if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);} 1842be081cd6SPeter Brune } 1843648262bbSPatrick Sanan if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx; 1844e7c4fc90SDmitry Karpeev } 184514a18fd3SPeter Brune } 184614a18fd3SPeter Brune if (len) *len = l; 184714a18fd3SPeter Brune } 1848e30e807fSPeter Brune PetscFunctionReturn(0); 1849e30e807fSPeter Brune } 1850e30e807fSPeter Brune 1851e30e807fSPeter Brune 1852e30e807fSPeter Brune /*@C 1853e30e807fSPeter Brune DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector 1854e30e807fSPeter Brune 1855e30e807fSPeter Brune Not collective 1856e30e807fSPeter Brune 1857e30e807fSPeter Brune Input Parameters: 1858e30e807fSPeter Brune + dm - the DM object 1859e30e807fSPeter Brune . n - the number of subdomain scatters 1860e30e807fSPeter Brune - subdms - the local subdomains 1861e30e807fSPeter Brune 1862e30e807fSPeter Brune Output Parameters: 1863e30e807fSPeter Brune + n - the number of scatters returned 1864e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain 1865e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain 1866e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts) 1867e30e807fSPeter Brune 186895452b02SPatrick Sanan Notes: 186995452b02SPatrick Sanan This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution 1870e30e807fSPeter Brune of general nonlinear problems with overlapping subdomain methods. While merely having index sets that enable subsets 1871e30e807fSPeter Brune of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of 1872e30e807fSPeter Brune solution and residual data. 1873e30e807fSPeter Brune 1874e30e807fSPeter Brune Level: developer 1875e30e807fSPeter Brune 1876e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1877e30e807fSPeter Brune @*/ 1878e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat) 1879e30e807fSPeter Brune { 1880e30e807fSPeter Brune PetscErrorCode ierr; 1881e30e807fSPeter Brune 1882e30e807fSPeter Brune PetscFunctionBegin; 1883e30e807fSPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1884e30e807fSPeter Brune PetscValidPointer(subdms,3); 1885b9d85ea2SLisandro Dalcin if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name); 1886e30e807fSPeter Brune ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr); 1887e7c4fc90SDmitry Karpeev PetscFunctionReturn(0); 1888e7c4fc90SDmitry Karpeev } 1889e7c4fc90SDmitry Karpeev 189047c6ae99SBarry Smith /*@ 189147c6ae99SBarry Smith DMRefine - Refines a DM object 189247c6ae99SBarry Smith 1893d083f849SBarry Smith Collective on dm 189447c6ae99SBarry Smith 189547c6ae99SBarry Smith Input Parameter: 189647c6ae99SBarry Smith + dm - the DM object 189791d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 189847c6ae99SBarry Smith 189947c6ae99SBarry Smith Output Parameter: 19000298fd71SBarry Smith . dmf - the refined DM, or NULL 1901ae0a1c52SMatthew G Knepley 19020298fd71SBarry Smith Note: If no refinement was done, the return value is NULL 190347c6ae99SBarry Smith 190447c6ae99SBarry Smith Level: developer 190547c6ae99SBarry Smith 1906e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 190747c6ae99SBarry Smith @*/ 19087087cfbeSBarry Smith PetscErrorCode DMRefine(DM dm,MPI_Comm comm,DM *dmf) 190947c6ae99SBarry Smith { 191047c6ae99SBarry Smith PetscErrorCode ierr; 1911c833c3b5SJed Brown DMRefineHookLink link; 191247c6ae99SBarry Smith 191347c6ae99SBarry Smith PetscFunctionBegin; 1914732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1915b9d85ea2SLisandro Dalcin if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name); 19161ac00216SMatthew G. Knepley ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 191747c6ae99SBarry Smith ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr); 19184057135bSMatthew G Knepley if (*dmf) { 191943842a1eSJed Brown (*dmf)->ops->creatematrix = dm->ops->creatematrix; 19208865f1eaSKarl Rupp 19218cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr); 19228865f1eaSKarl Rupp 1923644e2e5bSBarry Smith (*dmf)->ctx = dm->ctx; 19240598a293SJed Brown (*dmf)->leveldown = dm->leveldown; 1925656b349aSBarry Smith (*dmf)->levelup = dm->levelup + 1; 19268865f1eaSKarl Rupp 1927e4b4b23bSJed Brown ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr); 1928c833c3b5SJed Brown for (link=dm->refinehook; link; link=link->next) { 19298865f1eaSKarl Rupp if (link->refinehook) { 19308865f1eaSKarl Rupp ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr); 19318865f1eaSKarl Rupp } 1932c833c3b5SJed Brown } 1933c833c3b5SJed Brown } 19341ac00216SMatthew G. Knepley ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 1935c833c3b5SJed Brown PetscFunctionReturn(0); 1936c833c3b5SJed Brown } 1937c833c3b5SJed Brown 1938bb9467b5SJed Brown /*@C 1939c833c3b5SJed Brown DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid 1940c833c3b5SJed Brown 1941c833c3b5SJed Brown Logically Collective 1942c833c3b5SJed Brown 1943c833c3b5SJed Brown Input Arguments: 1944c833c3b5SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 1945c833c3b5SJed Brown . refinehook - function to run when setting up a coarser level 1946c833c3b5SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 19470298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 1948c833c3b5SJed Brown 1949c833c3b5SJed Brown Calling sequence of refinehook: 1950c833c3b5SJed Brown $ refinehook(DM coarse,DM fine,void *ctx); 1951c833c3b5SJed Brown 1952c833c3b5SJed Brown + coarse - coarse level DM 1953c833c3b5SJed Brown . fine - fine level DM to interpolate problem to 1954c833c3b5SJed Brown - ctx - optional user-defined function context 1955c833c3b5SJed Brown 1956c833c3b5SJed Brown Calling sequence for interphook: 1957c833c3b5SJed Brown $ interphook(DM coarse,Mat interp,DM fine,void *ctx) 1958c833c3b5SJed Brown 1959c833c3b5SJed Brown + coarse - coarse level DM 1960c833c3b5SJed Brown . interp - matrix interpolating a coarse-level solution to the finer grid 1961c833c3b5SJed Brown . fine - fine level DM to update 1962c833c3b5SJed Brown - ctx - optional user-defined function context 1963c833c3b5SJed Brown 1964c833c3b5SJed Brown Level: advanced 1965c833c3b5SJed Brown 1966c833c3b5SJed Brown Notes: 1967c833c3b5SJed Brown This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing 1968c833c3b5SJed Brown 1969c833c3b5SJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 1970c833c3b5SJed Brown 1971bb9467b5SJed Brown This function is currently not available from Fortran. 1972bb9467b5SJed Brown 1973c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 1974c833c3b5SJed Brown @*/ 1975c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 1976c833c3b5SJed Brown { 1977c833c3b5SJed Brown PetscErrorCode ierr; 1978c833c3b5SJed Brown DMRefineHookLink link,*p; 1979c833c3b5SJed Brown 1980c833c3b5SJed Brown PetscFunctionBegin; 1981c833c3b5SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 19823d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 19833d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0); 19843d8e3701SJed Brown } 198595dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 1986c833c3b5SJed Brown link->refinehook = refinehook; 1987c833c3b5SJed Brown link->interphook = interphook; 1988c833c3b5SJed Brown link->ctx = ctx; 19890298fd71SBarry Smith link->next = NULL; 1990c833c3b5SJed Brown *p = link; 1991c833c3b5SJed Brown PetscFunctionReturn(0); 1992c833c3b5SJed Brown } 1993c833c3b5SJed Brown 19943d8e3701SJed Brown /*@C 19953d8e3701SJed Brown DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid 19963d8e3701SJed Brown 19973d8e3701SJed Brown Logically Collective 19983d8e3701SJed Brown 19993d8e3701SJed Brown Input Arguments: 20003d8e3701SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 20013d8e3701SJed Brown . refinehook - function to run when setting up a coarser level 20023d8e3701SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 20033d8e3701SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 20043d8e3701SJed Brown 20053d8e3701SJed Brown Level: advanced 20063d8e3701SJed Brown 20073d8e3701SJed Brown Notes: 20083d8e3701SJed Brown This function does nothing if the hook is not in the list. 20093d8e3701SJed Brown 20103d8e3701SJed Brown This function is currently not available from Fortran. 20113d8e3701SJed Brown 20123d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 20133d8e3701SJed Brown @*/ 20143d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 20153d8e3701SJed Brown { 20163d8e3701SJed Brown PetscErrorCode ierr; 20173d8e3701SJed Brown DMRefineHookLink link,*p; 20183d8e3701SJed Brown 20193d8e3701SJed Brown PetscFunctionBegin; 20203d8e3701SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 20213d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 20223d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) { 20233d8e3701SJed Brown link = *p; 20243d8e3701SJed Brown *p = link->next; 20253d8e3701SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 20263d8e3701SJed Brown break; 20273d8e3701SJed Brown } 20283d8e3701SJed Brown } 20293d8e3701SJed Brown PetscFunctionReturn(0); 20303d8e3701SJed Brown } 20313d8e3701SJed Brown 2032c833c3b5SJed Brown /*@ 2033c833c3b5SJed Brown DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd() 2034c833c3b5SJed Brown 2035c833c3b5SJed Brown Collective if any hooks are 2036c833c3b5SJed Brown 2037c833c3b5SJed Brown Input Arguments: 2038c833c3b5SJed Brown + coarse - coarser DM to use as a base 2039e91eccc2SStefano Zampini . interp - interpolation matrix, apply using MatInterpolate() 2040c833c3b5SJed Brown - fine - finer DM to update 2041c833c3b5SJed Brown 2042c833c3b5SJed Brown Level: developer 2043c833c3b5SJed Brown 2044c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate() 2045c833c3b5SJed Brown @*/ 2046c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine) 2047c833c3b5SJed Brown { 2048c833c3b5SJed Brown PetscErrorCode ierr; 2049c833c3b5SJed Brown DMRefineHookLink link; 2050c833c3b5SJed Brown 2051c833c3b5SJed Brown PetscFunctionBegin; 2052c833c3b5SJed Brown for (link=fine->refinehook; link; link=link->next) { 20538865f1eaSKarl Rupp if (link->interphook) { 20548865f1eaSKarl Rupp ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr); 20558865f1eaSKarl Rupp } 20564057135bSMatthew G Knepley } 205747c6ae99SBarry Smith PetscFunctionReturn(0); 205847c6ae99SBarry Smith } 205947c6ae99SBarry Smith 2060eb3f98d2SBarry Smith /*@ 2061eb3f98d2SBarry Smith DMGetRefineLevel - Get's the number of refinements that have generated this DM. 2062eb3f98d2SBarry Smith 2063eb3f98d2SBarry Smith Not Collective 2064eb3f98d2SBarry Smith 2065eb3f98d2SBarry Smith Input Parameter: 2066eb3f98d2SBarry Smith . dm - the DM object 2067eb3f98d2SBarry Smith 2068eb3f98d2SBarry Smith Output Parameter: 2069eb3f98d2SBarry Smith . level - number of refinements 2070eb3f98d2SBarry Smith 2071eb3f98d2SBarry Smith Level: developer 2072eb3f98d2SBarry Smith 20736a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2074eb3f98d2SBarry Smith 2075eb3f98d2SBarry Smith @*/ 2076eb3f98d2SBarry Smith PetscErrorCode DMGetRefineLevel(DM dm,PetscInt *level) 2077eb3f98d2SBarry Smith { 2078eb3f98d2SBarry Smith PetscFunctionBegin; 2079eb3f98d2SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2080eb3f98d2SBarry Smith *level = dm->levelup; 2081eb3f98d2SBarry Smith PetscFunctionReturn(0); 2082eb3f98d2SBarry Smith } 2083eb3f98d2SBarry Smith 2084fef3a512SBarry Smith /*@ 2085fef3a512SBarry Smith DMSetRefineLevel - Set's the number of refinements that have generated this DM. 2086fef3a512SBarry Smith 2087fef3a512SBarry Smith Not Collective 2088fef3a512SBarry Smith 2089fef3a512SBarry Smith Input Parameter: 2090fef3a512SBarry Smith + dm - the DM object 2091fef3a512SBarry Smith - level - number of refinements 2092fef3a512SBarry Smith 2093fef3a512SBarry Smith Level: advanced 2094fef3a512SBarry Smith 209595452b02SPatrick Sanan Notes: 209695452b02SPatrick Sanan This value is used by PCMG to determine how many multigrid levels to use 2097fef3a512SBarry Smith 2098fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2099fef3a512SBarry Smith 2100fef3a512SBarry Smith @*/ 2101fef3a512SBarry Smith PetscErrorCode DMSetRefineLevel(DM dm,PetscInt level) 2102fef3a512SBarry Smith { 2103fef3a512SBarry Smith PetscFunctionBegin; 2104fef3a512SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2105fef3a512SBarry Smith dm->levelup = level; 2106fef3a512SBarry Smith PetscFunctionReturn(0); 2107fef3a512SBarry Smith } 2108fef3a512SBarry Smith 2109ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm) 2110ca3d3a14SMatthew G. Knepley { 2111ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2112ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2113ca3d3a14SMatthew G. Knepley PetscValidPointer(tdm, 2); 2114ca3d3a14SMatthew G. Knepley *tdm = dm->transformDM; 2115ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2116ca3d3a14SMatthew G. Knepley } 2117ca3d3a14SMatthew G. Knepley 2118ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv) 2119ca3d3a14SMatthew G. Knepley { 2120ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2121ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2122ca3d3a14SMatthew G. Knepley PetscValidPointer(tv, 2); 2123ca3d3a14SMatthew G. Knepley *tv = dm->transform; 2124ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2125ca3d3a14SMatthew G. Knepley } 2126ca3d3a14SMatthew G. Knepley 2127ca3d3a14SMatthew G. Knepley /*@ 2128c0f8e1fdSMatthew G. Knepley DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors 2129ca3d3a14SMatthew G. Knepley 2130ca3d3a14SMatthew G. Knepley Input Parameter: 2131ca3d3a14SMatthew G. Knepley . dm - The DM 2132ca3d3a14SMatthew G. Knepley 2133ca3d3a14SMatthew G. Knepley Output Parameter: 2134ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done 2135ca3d3a14SMatthew G. Knepley 2136ca3d3a14SMatthew G. Knepley Level: developer 2137ca3d3a14SMatthew G. Knepley 2138ca3d3a14SMatthew G. Knepley .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis()() 2139ca3d3a14SMatthew G. Knepley @*/ 2140ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg) 2141ca3d3a14SMatthew G. Knepley { 2142ca3d3a14SMatthew G. Knepley Vec tv; 2143ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2144ca3d3a14SMatthew G. Knepley 2145ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2146ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2147534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 2148ca3d3a14SMatthew G. Knepley ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr); 2149ca3d3a14SMatthew G. Knepley *flg = tv ? PETSC_TRUE : PETSC_FALSE; 2150ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2151ca3d3a14SMatthew G. Knepley } 2152ca3d3a14SMatthew G. Knepley 2153ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm) 2154ca3d3a14SMatthew G. Knepley { 2155ca3d3a14SMatthew G. Knepley PetscSection s, ts; 2156ca3d3a14SMatthew G. Knepley PetscScalar *ta; 2157ca3d3a14SMatthew G. Knepley PetscInt cdim, pStart, pEnd, p, Nf, f, Nc, dof; 2158ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2159ca3d3a14SMatthew G. Knepley 2160ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2161ca3d3a14SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 216292fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 2163ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 2164ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr); 2165ca3d3a14SMatthew G. Knepley ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr); 216692fd8e1eSJed Brown ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr); 2167ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr); 2168ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr); 2169ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2170ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr); 2171ca3d3a14SMatthew G. Knepley /* We could start to label fields by their transformation properties */ 2172ca3d3a14SMatthew G. Knepley if (Nc != cdim) continue; 2173ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2174ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr); 2175ca3d3a14SMatthew G. Knepley if (!dof) continue; 2176ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr); 2177ca3d3a14SMatthew G. Knepley ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr); 2178ca3d3a14SMatthew G. Knepley } 2179ca3d3a14SMatthew G. Knepley } 2180ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetUp(ts);CHKERRQ(ierr); 2181ca3d3a14SMatthew G. Knepley ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr); 2182ca3d3a14SMatthew G. Knepley ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr); 2183ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2184ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2185ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr); 2186ca3d3a14SMatthew G. Knepley if (dof) { 2187ca3d3a14SMatthew G. Knepley PetscReal x[3] = {0.0, 0.0, 0.0}; 2188ca3d3a14SMatthew G. Knepley PetscScalar *tva; 2189ca3d3a14SMatthew G. Knepley const PetscScalar *A; 2190ca3d3a14SMatthew G. Knepley 2191ca3d3a14SMatthew G. Knepley /* TODO Get quadrature point for this dual basis vector for coordinate */ 2192ca3d3a14SMatthew G. Knepley ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr); 2193ca3d3a14SMatthew G. Knepley ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr); 2194580bdb30SBarry Smith ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr); 2195ca3d3a14SMatthew G. Knepley } 2196ca3d3a14SMatthew G. Knepley } 2197ca3d3a14SMatthew G. Knepley } 2198ca3d3a14SMatthew G. Knepley ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr); 2199ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2200ca3d3a14SMatthew G. Knepley } 2201ca3d3a14SMatthew G. Knepley 2202ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm) 2203ca3d3a14SMatthew G. Knepley { 2204ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2205ca3d3a14SMatthew G. Knepley 2206ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2207ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2208ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(newdm, DM_CLASSID, 2); 2209ca3d3a14SMatthew G. Knepley newdm->transformCtx = dm->transformCtx; 2210ca3d3a14SMatthew G. Knepley newdm->transformSetUp = dm->transformSetUp; 2211ca3d3a14SMatthew G. Knepley newdm->transformDestroy = NULL; 2212ca3d3a14SMatthew G. Knepley newdm->transformGetMatrix = dm->transformGetMatrix; 2213ca3d3a14SMatthew G. Knepley if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);} 2214ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2215ca3d3a14SMatthew G. Knepley } 2216ca3d3a14SMatthew G. Knepley 2217bb9467b5SJed Brown /*@C 2218baf369e7SPeter Brune DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called 2219baf369e7SPeter Brune 2220baf369e7SPeter Brune Logically Collective 2221baf369e7SPeter Brune 2222baf369e7SPeter Brune Input Arguments: 2223baf369e7SPeter Brune + dm - the DM 2224baf369e7SPeter Brune . beginhook - function to run at the beginning of DMGlobalToLocalBegin() 2225baf369e7SPeter Brune . endhook - function to run after DMGlobalToLocalEnd() has completed 22260298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2227baf369e7SPeter Brune 2228baf369e7SPeter Brune Calling sequence for beginhook: 2229baf369e7SPeter Brune $ beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2230baf369e7SPeter Brune 2231baf369e7SPeter Brune + dm - global DM 2232baf369e7SPeter Brune . g - global vector 2233baf369e7SPeter Brune . mode - mode 2234baf369e7SPeter Brune . l - local vector 2235baf369e7SPeter Brune - ctx - optional user-defined function context 2236baf369e7SPeter Brune 2237baf369e7SPeter Brune 2238baf369e7SPeter Brune Calling sequence for endhook: 2239ec4806b8SPeter Brune $ endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2240baf369e7SPeter Brune 2241baf369e7SPeter Brune + global - global DM 2242baf369e7SPeter Brune - ctx - optional user-defined function context 2243baf369e7SPeter Brune 2244baf369e7SPeter Brune Level: advanced 2245baf369e7SPeter Brune 2246baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2247baf369e7SPeter Brune @*/ 2248baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2249baf369e7SPeter Brune { 2250baf369e7SPeter Brune PetscErrorCode ierr; 2251baf369e7SPeter Brune DMGlobalToLocalHookLink link,*p; 2252baf369e7SPeter Brune 2253baf369e7SPeter Brune PetscFunctionBegin; 2254baf369e7SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2255baf369e7SPeter Brune for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 225695dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2257baf369e7SPeter Brune link->beginhook = beginhook; 2258baf369e7SPeter Brune link->endhook = endhook; 2259baf369e7SPeter Brune link->ctx = ctx; 22600298fd71SBarry Smith link->next = NULL; 2261baf369e7SPeter Brune *p = link; 2262baf369e7SPeter Brune PetscFunctionReturn(0); 2263baf369e7SPeter Brune } 2264baf369e7SPeter Brune 22654c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx) 22664c274da1SToby Isaac { 22674c274da1SToby Isaac Mat cMat; 22684c274da1SToby Isaac Vec cVec; 22694c274da1SToby Isaac PetscSection section, cSec; 22704c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 22714c274da1SToby Isaac PetscErrorCode ierr; 22724c274da1SToby Isaac 22734c274da1SToby Isaac PetscFunctionBegin; 22744c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 22754c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 22764c274da1SToby Isaac if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) { 22775db9a05bSToby Isaac PetscInt nRows; 22785db9a05bSToby Isaac 22795db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 22805db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 228192fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 22827711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 22834c274da1SToby Isaac ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr); 22844c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 22854c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 22864c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 22874c274da1SToby Isaac if (dof) { 22884c274da1SToby Isaac PetscScalar *vals; 22894c274da1SToby Isaac ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr); 22904c274da1SToby Isaac ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr); 22914c274da1SToby Isaac } 22924c274da1SToby Isaac } 22934c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 22944c274da1SToby Isaac } 22954c274da1SToby Isaac PetscFunctionReturn(0); 22964c274da1SToby Isaac } 22974c274da1SToby Isaac 229847c6ae99SBarry Smith /*@ 229901729b5cSPatrick Sanan DMGlobalToLocal - update local vectors from global vector 230001729b5cSPatrick Sanan 2301d083f849SBarry Smith Neighbor-wise Collective on dm 230201729b5cSPatrick Sanan 230301729b5cSPatrick Sanan Input Parameters: 230401729b5cSPatrick Sanan + dm - the DM object 230501729b5cSPatrick Sanan . g - the global vector 230601729b5cSPatrick Sanan . mode - INSERT_VALUES or ADD_VALUES 230701729b5cSPatrick Sanan - l - the local vector 230801729b5cSPatrick Sanan 230901729b5cSPatrick Sanan Notes: 231001729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 231101729b5cSPatrick Sanan DMGlobalToLocalBegin() and DMGlobalToLocalEnd(). 231201729b5cSPatrick Sanan 231301729b5cSPatrick Sanan Level: beginner 231401729b5cSPatrick Sanan 231501729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 231601729b5cSPatrick Sanan 231701729b5cSPatrick Sanan @*/ 231801729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l) 231901729b5cSPatrick Sanan { 232001729b5cSPatrick Sanan PetscErrorCode ierr; 232101729b5cSPatrick Sanan 232201729b5cSPatrick Sanan PetscFunctionBegin; 232301729b5cSPatrick Sanan ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr); 232401729b5cSPatrick Sanan ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr); 232501729b5cSPatrick Sanan PetscFunctionReturn(0); 232601729b5cSPatrick Sanan } 232701729b5cSPatrick Sanan 232801729b5cSPatrick Sanan /*@ 232947c6ae99SBarry Smith DMGlobalToLocalBegin - Begins updating local vectors from global vector 233047c6ae99SBarry Smith 2331d083f849SBarry Smith Neighbor-wise Collective on dm 233247c6ae99SBarry Smith 233347c6ae99SBarry Smith Input Parameters: 233447c6ae99SBarry Smith + dm - the DM object 233547c6ae99SBarry Smith . g - the global vector 233647c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 233747c6ae99SBarry Smith - l - the local vector 233847c6ae99SBarry Smith 233901729b5cSPatrick Sanan Level: intermediate 234047c6ae99SBarry Smith 234101729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 234247c6ae99SBarry Smith 234347c6ae99SBarry Smith @*/ 23447087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 234547c6ae99SBarry Smith { 23467128ae9fSMatthew G Knepley PetscSF sf; 234747c6ae99SBarry Smith PetscErrorCode ierr; 2348baf369e7SPeter Brune DMGlobalToLocalHookLink link; 234947c6ae99SBarry Smith 235047c6ae99SBarry Smith PetscFunctionBegin; 2351171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2352baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 23538865f1eaSKarl Rupp if (link->beginhook) { 23548865f1eaSKarl Rupp ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr); 23558865f1eaSKarl Rupp } 2356baf369e7SPeter Brune } 23571bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 23587128ae9fSMatthew G Knepley if (sf) { 2359ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2360ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 23617128ae9fSMatthew G Knepley 236282f516ccSBarry Smith if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 23637128ae9fSMatthew G Knepley ierr = VecGetArray(l, &lArray);CHKERRQ(ierr); 2364ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr); 23657128ae9fSMatthew G Knepley ierr = PetscSFBcastBegin(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr); 23667128ae9fSMatthew G Knepley ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr); 2367ae5cfb4aSMatthew G. Knepley ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr); 23687128ae9fSMatthew G Knepley } else { 236933907cc2SStefano Zampini if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name); 2370843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 23717128ae9fSMatthew G Knepley } 237247c6ae99SBarry Smith PetscFunctionReturn(0); 237347c6ae99SBarry Smith } 237447c6ae99SBarry Smith 237547c6ae99SBarry Smith /*@ 237647c6ae99SBarry Smith DMGlobalToLocalEnd - Ends updating local vectors from global vector 237747c6ae99SBarry Smith 2378d083f849SBarry Smith Neighbor-wise Collective on dm 237947c6ae99SBarry Smith 238047c6ae99SBarry Smith Input Parameters: 238147c6ae99SBarry Smith + dm - the DM object 238247c6ae99SBarry Smith . g - the global vector 238347c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 238447c6ae99SBarry Smith - l - the local vector 238547c6ae99SBarry Smith 238601729b5cSPatrick Sanan Level: intermediate 238747c6ae99SBarry Smith 238801729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 238947c6ae99SBarry Smith 239047c6ae99SBarry Smith @*/ 23917087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 239247c6ae99SBarry Smith { 23937128ae9fSMatthew G Knepley PetscSF sf; 239447c6ae99SBarry Smith PetscErrorCode ierr; 2395ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2396ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2397ca3d3a14SMatthew G. Knepley PetscBool transform; 2398baf369e7SPeter Brune DMGlobalToLocalHookLink link; 239947c6ae99SBarry Smith 240047c6ae99SBarry Smith PetscFunctionBegin; 2401171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 24021bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 2403ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 24047128ae9fSMatthew G Knepley if (sf) { 240582f516ccSBarry Smith if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 24067128ae9fSMatthew G Knepley 24077128ae9fSMatthew G Knepley ierr = VecGetArray(l, &lArray);CHKERRQ(ierr); 2408ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr); 24097128ae9fSMatthew G Knepley ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr); 24107128ae9fSMatthew G Knepley ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr); 2411ae5cfb4aSMatthew G. Knepley ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr); 2412ca3d3a14SMatthew G. Knepley if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);} 24137128ae9fSMatthew G Knepley } else { 241433907cc2SStefano Zampini if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name); 2415843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 24167128ae9fSMatthew G Knepley } 24174c274da1SToby Isaac ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr); 2418baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 2419baf369e7SPeter Brune if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 2420baf369e7SPeter Brune } 242147c6ae99SBarry Smith PetscFunctionReturn(0); 242247c6ae99SBarry Smith } 242347c6ae99SBarry Smith 2424d4d07f1eSToby Isaac /*@C 2425d4d07f1eSToby Isaac DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called 2426d4d07f1eSToby Isaac 2427d4d07f1eSToby Isaac Logically Collective 2428d4d07f1eSToby Isaac 2429d4d07f1eSToby Isaac Input Arguments: 2430d4d07f1eSToby Isaac + dm - the DM 2431d4d07f1eSToby Isaac . beginhook - function to run at the beginning of DMLocalToGlobalBegin() 2432d4d07f1eSToby Isaac . endhook - function to run after DMLocalToGlobalEnd() has completed 2433d4d07f1eSToby Isaac - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2434d4d07f1eSToby Isaac 2435d4d07f1eSToby Isaac Calling sequence for beginhook: 2436d4d07f1eSToby Isaac $ beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2437d4d07f1eSToby Isaac 2438d4d07f1eSToby Isaac + dm - global DM 2439d4d07f1eSToby Isaac . l - local vector 2440d4d07f1eSToby Isaac . mode - mode 2441d4d07f1eSToby Isaac . g - global vector 2442d4d07f1eSToby Isaac - ctx - optional user-defined function context 2443d4d07f1eSToby Isaac 2444d4d07f1eSToby Isaac 2445d4d07f1eSToby Isaac Calling sequence for endhook: 2446d4d07f1eSToby Isaac $ endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2447d4d07f1eSToby Isaac 2448d4d07f1eSToby Isaac + global - global DM 2449d4d07f1eSToby Isaac . l - local vector 2450d4d07f1eSToby Isaac . mode - mode 2451d4d07f1eSToby Isaac . g - global vector 2452d4d07f1eSToby Isaac - ctx - optional user-defined function context 2453d4d07f1eSToby Isaac 2454d4d07f1eSToby Isaac Level: advanced 2455d4d07f1eSToby Isaac 2456d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2457d4d07f1eSToby Isaac @*/ 2458d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2459d4d07f1eSToby Isaac { 2460d4d07f1eSToby Isaac PetscErrorCode ierr; 2461d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,*p; 2462d4d07f1eSToby Isaac 2463d4d07f1eSToby Isaac PetscFunctionBegin; 2464d4d07f1eSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2465d4d07f1eSToby Isaac for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 246695dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2467d4d07f1eSToby Isaac link->beginhook = beginhook; 2468d4d07f1eSToby Isaac link->endhook = endhook; 2469d4d07f1eSToby Isaac link->ctx = ctx; 2470d4d07f1eSToby Isaac link->next = NULL; 2471d4d07f1eSToby Isaac *p = link; 2472d4d07f1eSToby Isaac PetscFunctionReturn(0); 2473d4d07f1eSToby Isaac } 2474d4d07f1eSToby Isaac 24754c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx) 24764c274da1SToby Isaac { 24774c274da1SToby Isaac Mat cMat; 24784c274da1SToby Isaac Vec cVec; 24794c274da1SToby Isaac PetscSection section, cSec; 24804c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 24814c274da1SToby Isaac PetscErrorCode ierr; 24824c274da1SToby Isaac 24834c274da1SToby Isaac PetscFunctionBegin; 24844c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 24854c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 24864c274da1SToby Isaac if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) { 24875db9a05bSToby Isaac PetscInt nRows; 24885db9a05bSToby Isaac 24895db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 24905db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 249192fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 24927711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 24934c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 24944c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 24954c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 24964c274da1SToby Isaac if (dof) { 24974c274da1SToby Isaac PetscInt d; 24984c274da1SToby Isaac PetscScalar *vals; 24994c274da1SToby Isaac ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr); 25004c274da1SToby Isaac ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr); 25014c274da1SToby Isaac /* for this to be the true transpose, we have to zero the values that 25024c274da1SToby Isaac * we just extracted */ 25034c274da1SToby Isaac for (d = 0; d < dof; d++) { 25044c274da1SToby Isaac vals[d] = 0.; 25054c274da1SToby Isaac } 25064c274da1SToby Isaac } 25074c274da1SToby Isaac } 25084c274da1SToby Isaac ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr); 25094c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 25104c274da1SToby Isaac } 25114c274da1SToby Isaac PetscFunctionReturn(0); 25124c274da1SToby Isaac } 251301729b5cSPatrick Sanan /*@ 251401729b5cSPatrick Sanan DMLocalToGlobal - updates global vectors from local vectors 251501729b5cSPatrick Sanan 2516d083f849SBarry Smith Neighbor-wise Collective on dm 251701729b5cSPatrick Sanan 251801729b5cSPatrick Sanan Input Parameters: 251901729b5cSPatrick Sanan + dm - the DM object 252001729b5cSPatrick Sanan . l - the local vector 252101729b5cSPatrick Sanan . mode - if INSERT_VALUES then no parallel communication is used, if ADD_VALUES then all ghost points from the same base point accumulate into that base point. 252201729b5cSPatrick Sanan - g - the global vector 252301729b5cSPatrick Sanan 252401729b5cSPatrick Sanan Notes: 252501729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 252601729b5cSPatrick Sanan DMLocalToGlobalBegin() and DMLocalToGlobalEnd(). 252701729b5cSPatrick Sanan 252801729b5cSPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 252901729b5cSPatrick Sanan INSERT_VALUES is not supported for DMDA; in that case simply compute the values directly into a global vector instead of a local one. 253001729b5cSPatrick Sanan 253101729b5cSPatrick Sanan Level: beginner 253201729b5cSPatrick Sanan 253301729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 253401729b5cSPatrick Sanan 253501729b5cSPatrick Sanan @*/ 253601729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g) 253701729b5cSPatrick Sanan { 253801729b5cSPatrick Sanan PetscErrorCode ierr; 253901729b5cSPatrick Sanan 254001729b5cSPatrick Sanan PetscFunctionBegin; 254101729b5cSPatrick Sanan ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr); 254201729b5cSPatrick Sanan ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr); 254301729b5cSPatrick Sanan PetscFunctionReturn(0); 254401729b5cSPatrick Sanan } 25454c274da1SToby Isaac 254647c6ae99SBarry Smith /*@ 254701729b5cSPatrick Sanan DMLocalToGlobalBegin - begins updating global vectors from local vectors 25489a42bb27SBarry Smith 2549d083f849SBarry Smith Neighbor-wise Collective on dm 25509a42bb27SBarry Smith 25519a42bb27SBarry Smith Input Parameters: 25529a42bb27SBarry Smith + dm - the DM object 2553f6813fd5SJed Brown . l - the local vector 25541eb28f2eSBarry Smith . mode - if INSERT_VALUES then no parallel communication is used, if ADD_VALUES then all ghost points from the same base point accumulate into that base point. 25551eb28f2eSBarry Smith - g - the global vector 25569a42bb27SBarry Smith 255795452b02SPatrick Sanan Notes: 255895452b02SPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 255984330215SMatthew G. Knepley INSERT_VALUES is not supported for DMDA, in that case simply compute the values directly into a global vector instead of a local one. 25609a42bb27SBarry Smith 256101729b5cSPatrick Sanan Level: intermediate 25629a42bb27SBarry Smith 256301729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 25649a42bb27SBarry Smith 25659a42bb27SBarry Smith @*/ 25667087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g) 25679a42bb27SBarry Smith { 25687128ae9fSMatthew G Knepley PetscSF sf; 256984330215SMatthew G. Knepley PetscSection s, gs; 2570d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 2571ca3d3a14SMatthew G. Knepley Vec tmpl; 2572ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2573ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 2574ca3d3a14SMatthew G. Knepley PetscBool isInsert, transform; 257584330215SMatthew G. Knepley PetscErrorCode ierr; 25769a42bb27SBarry Smith 25779a42bb27SBarry Smith PetscFunctionBegin; 2578171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2579d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2580d4d07f1eSToby Isaac if (link->beginhook) { 2581d4d07f1eSToby Isaac ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr); 2582d4d07f1eSToby Isaac } 2583d4d07f1eSToby Isaac } 25844c274da1SToby Isaac ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr); 25851bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 258692fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 25877128ae9fSMatthew G Knepley switch (mode) { 25887128ae9fSMatthew G Knepley case INSERT_VALUES: 25897128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 2590304ab55fSMatthew G. Knepley case INSERT_BC_VALUES: 259184330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 25927128ae9fSMatthew G Knepley case ADD_VALUES: 25937128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 2594304ab55fSMatthew G. Knepley case ADD_BC_VALUES: 259584330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 25967128ae9fSMatthew G Knepley default: 259782f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 25987128ae9fSMatthew G Knepley } 2599ca3d3a14SMatthew G. Knepley if ((sf && !isInsert) || (s && isInsert)) { 2600ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 2601ca3d3a14SMatthew G. Knepley if (transform) { 2602ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2603ca3d3a14SMatthew G. Knepley ierr = VecCopy(l, tmpl);CHKERRQ(ierr); 2604ca3d3a14SMatthew G. Knepley ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr); 2605ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2606ca3d3a14SMatthew G. Knepley } else { 2607ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 2608ca3d3a14SMatthew G. Knepley } 26097128ae9fSMatthew G Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 2610ca3d3a14SMatthew G. Knepley if (sf && !isInsert) { 2611a9b180a6SBarry Smith ierr = PetscSFReduceBegin(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr); 261284330215SMatthew G. Knepley } else if (s && isInsert) { 261384330215SMatthew G. Knepley PetscInt gStart, pStart, pEnd, p; 261484330215SMatthew G. Knepley 2615e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr); 261684330215SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 261784330215SMatthew G. Knepley ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr); 261884330215SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2619b3b16f48SMatthew G. Knepley PetscInt dof, gdof, cdof, gcdof, off, goff, d, e; 262084330215SMatthew G. Knepley 262184330215SMatthew G. Knepley ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr); 262203442857SMatthew G. Knepley ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr); 262384330215SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr); 2624b3b16f48SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr); 262584330215SMatthew G. Knepley ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr); 262684330215SMatthew G. Knepley ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr); 2627b3b16f48SMatthew G. Knepley /* Ignore off-process data and points with no global data */ 262803442857SMatthew G. Knepley if (!gdof || goff < 0) continue; 2629b3b16f48SMatthew G. Knepley if (dof != gdof) SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof); 2630b3b16f48SMatthew G. Knepley /* If no constraints are enforced in the global vector */ 2631b3b16f48SMatthew G. Knepley if (!gcdof) { 263284330215SMatthew G. Knepley for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d]; 2633b3b16f48SMatthew G. Knepley /* If constraints are enforced in the global vector */ 2634b3b16f48SMatthew G. Knepley } else if (cdof == gcdof) { 263584330215SMatthew G. Knepley const PetscInt *cdofs; 263684330215SMatthew G. Knepley PetscInt cind = 0; 263784330215SMatthew G. Knepley 263884330215SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr); 2639b3b16f48SMatthew G. Knepley for (d = 0, e = 0; d < dof; ++d) { 264084330215SMatthew G. Knepley if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;} 2641b3b16f48SMatthew G. Knepley gArray[goff-gStart+e++] = lArray[off+d]; 264284330215SMatthew G. Knepley } 2643b3b16f48SMatthew G. Knepley } else SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof); 264484330215SMatthew G. Knepley } 2645ca3d3a14SMatthew G. Knepley } 26467128ae9fSMatthew G Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 2647ca3d3a14SMatthew G. Knepley if (transform) { 2648ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2649ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2650ca3d3a14SMatthew G. Knepley } else { 2651ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 2652ca3d3a14SMatthew G. Knepley } 26537128ae9fSMatthew G Knepley } else { 2654b9d85ea2SLisandro Dalcin if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name); 2655843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 26567128ae9fSMatthew G Knepley } 26579a42bb27SBarry Smith PetscFunctionReturn(0); 26589a42bb27SBarry Smith } 26599a42bb27SBarry Smith 26609a42bb27SBarry Smith /*@ 26619a42bb27SBarry Smith DMLocalToGlobalEnd - updates global vectors from local vectors 266247c6ae99SBarry Smith 2663d083f849SBarry Smith Neighbor-wise Collective on dm 266447c6ae99SBarry Smith 266547c6ae99SBarry Smith Input Parameters: 266647c6ae99SBarry Smith + dm - the DM object 2667f6813fd5SJed Brown . l - the local vector 266847c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 2669f6813fd5SJed Brown - g - the global vector 267047c6ae99SBarry Smith 267101729b5cSPatrick Sanan Level: intermediate 267247c6ae99SBarry Smith 2673e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd() 267447c6ae99SBarry Smith 267547c6ae99SBarry Smith @*/ 26767087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g) 267747c6ae99SBarry Smith { 26787128ae9fSMatthew G Knepley PetscSF sf; 267984330215SMatthew G. Knepley PetscSection s; 2680d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 2681ca3d3a14SMatthew G. Knepley PetscBool isInsert, transform; 268284330215SMatthew G. Knepley PetscErrorCode ierr; 268347c6ae99SBarry Smith 268447c6ae99SBarry Smith PetscFunctionBegin; 2685171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 26861bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 268792fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 26887128ae9fSMatthew G Knepley switch (mode) { 26897128ae9fSMatthew G Knepley case INSERT_VALUES: 26907128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 269184330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 26927128ae9fSMatthew G Knepley case ADD_VALUES: 26937128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 269484330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 26957128ae9fSMatthew G Knepley default: 269682f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 26977128ae9fSMatthew G Knepley } 269884330215SMatthew G. Knepley if (sf && !isInsert) { 2699ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2700ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 2701ca3d3a14SMatthew G. Knepley Vec tmpl; 270284330215SMatthew G. Knepley 2703ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 2704ca3d3a14SMatthew G. Knepley if (transform) { 2705ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2706ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2707ca3d3a14SMatthew G. Knepley } else { 2708ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 2709ca3d3a14SMatthew G. Knepley } 27107128ae9fSMatthew G Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 2711a9b180a6SBarry Smith ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr); 2712ca3d3a14SMatthew G. Knepley if (transform) { 2713ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2714ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2715ca3d3a14SMatthew G. Knepley } else { 2716ae5cfb4aSMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 2717ca3d3a14SMatthew G. Knepley } 27187128ae9fSMatthew G Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 271984330215SMatthew G. Knepley } else if (s && isInsert) { 27207128ae9fSMatthew G Knepley } else { 2721b9d85ea2SLisandro Dalcin if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name); 2722843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 27237128ae9fSMatthew G Knepley } 2724d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2725d4d07f1eSToby Isaac if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 2726d4d07f1eSToby Isaac } 272747c6ae99SBarry Smith PetscFunctionReturn(0); 272847c6ae99SBarry Smith } 272947c6ae99SBarry Smith 2730f089877aSRichard Tran Mills /*@ 2731bc0a1609SRichard Tran Mills DMLocalToLocalBegin - Maps from a local vector (including ghost points 2732bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 2733d78e899eSRichard Tran Mills points in the second are set correctly. Must be followed by DMLocalToLocalEnd(). 2734f089877aSRichard Tran Mills 2735d083f849SBarry Smith Neighbor-wise Collective on dm 2736f089877aSRichard Tran Mills 2737f089877aSRichard Tran Mills Input Parameters: 2738f089877aSRichard Tran Mills + dm - the DM object 2739bc0a1609SRichard Tran Mills . g - the original local vector 2740bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 2741f089877aSRichard Tran Mills 2742bc0a1609SRichard Tran Mills Output Parameter: 2743bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 2744f089877aSRichard Tran Mills 2745f089877aSRichard Tran Mills Level: intermediate 2746f089877aSRichard Tran Mills 2747bc0a1609SRichard Tran Mills Notes: 2748bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 2749bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 2750bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 2751bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 2752bc0a1609SRichard Tran Mills 2753bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 2754f089877aSRichard Tran Mills 2755f089877aSRichard Tran Mills @*/ 2756f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 2757f089877aSRichard Tran Mills { 2758f089877aSRichard Tran Mills PetscErrorCode ierr; 2759f089877aSRichard Tran Mills 2760f089877aSRichard Tran Mills PetscFunctionBegin; 2761f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2762bb358533SPatrick Sanan if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 2763f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 2764f089877aSRichard Tran Mills PetscFunctionReturn(0); 2765f089877aSRichard Tran Mills } 2766f089877aSRichard Tran Mills 2767f089877aSRichard Tran Mills /*@ 2768bc0a1609SRichard Tran Mills DMLocalToLocalEnd - Maps from a local vector (including ghost points 2769bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 2770d78e899eSRichard Tran Mills points in the second are set correctly. Must be preceded by DMLocalToLocalBegin(). 2771f089877aSRichard Tran Mills 2772d083f849SBarry Smith Neighbor-wise Collective on dm 2773f089877aSRichard Tran Mills 2774f089877aSRichard Tran Mills Input Parameters: 2775bc0a1609SRichard Tran Mills + da - the DM object 2776bc0a1609SRichard Tran Mills . g - the original local vector 2777bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 2778f089877aSRichard Tran Mills 2779bc0a1609SRichard Tran Mills Output Parameter: 2780bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 2781f089877aSRichard Tran Mills 2782f089877aSRichard Tran Mills Level: intermediate 2783f089877aSRichard Tran Mills 2784bc0a1609SRichard Tran Mills Notes: 2785bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 2786bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 2787bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 2788bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 2789bc0a1609SRichard Tran Mills 2790bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 2791f089877aSRichard Tran Mills 2792f089877aSRichard Tran Mills @*/ 2793f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 2794f089877aSRichard Tran Mills { 2795f089877aSRichard Tran Mills PetscErrorCode ierr; 2796f089877aSRichard Tran Mills 2797f089877aSRichard Tran Mills PetscFunctionBegin; 2798f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2799bb358533SPatrick Sanan if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 2800f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 2801f089877aSRichard Tran Mills PetscFunctionReturn(0); 2802f089877aSRichard Tran Mills } 2803f089877aSRichard Tran Mills 2804f089877aSRichard Tran Mills 280547c6ae99SBarry Smith /*@ 280647c6ae99SBarry Smith DMCoarsen - Coarsens a DM object 280747c6ae99SBarry Smith 2808d083f849SBarry Smith Collective on dm 280947c6ae99SBarry Smith 281047c6ae99SBarry Smith Input Parameter: 281147c6ae99SBarry Smith + dm - the DM object 281291d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 281347c6ae99SBarry Smith 281447c6ae99SBarry Smith Output Parameter: 281547c6ae99SBarry Smith . dmc - the coarsened DM 281647c6ae99SBarry Smith 281747c6ae99SBarry Smith Level: developer 281847c6ae99SBarry Smith 2819e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 282047c6ae99SBarry Smith 282147c6ae99SBarry Smith @*/ 28227087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc) 282347c6ae99SBarry Smith { 282447c6ae99SBarry Smith PetscErrorCode ierr; 2825b17ce1afSJed Brown DMCoarsenHookLink link; 282647c6ae99SBarry Smith 282747c6ae99SBarry Smith PetscFunctionBegin; 2828171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2829b9d85ea2SLisandro Dalcin if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name); 283047a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 283147c6ae99SBarry Smith ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr); 2832b9d85ea2SLisandro Dalcin if (*dmc) { 2833a8fb8f29SToby Isaac ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr); 283443842a1eSJed Brown (*dmc)->ops->creatematrix = dm->ops->creatematrix; 28358cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr); 2836644e2e5bSBarry Smith (*dmc)->ctx = dm->ctx; 28370598a293SJed Brown (*dmc)->levelup = dm->levelup; 2838656b349aSBarry Smith (*dmc)->leveldown = dm->leveldown + 1; 2839e4b4b23bSJed Brown ierr = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr); 2840b17ce1afSJed Brown for (link=dm->coarsenhook; link; link=link->next) { 2841b17ce1afSJed Brown if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);} 2842b17ce1afSJed Brown } 2843b9d85ea2SLisandro Dalcin } 284447a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 2845b9d85ea2SLisandro Dalcin if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced"); 2846b17ce1afSJed Brown PetscFunctionReturn(0); 2847b17ce1afSJed Brown } 2848b17ce1afSJed Brown 2849bb9467b5SJed Brown /*@C 2850b17ce1afSJed Brown DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid 2851b17ce1afSJed Brown 2852b17ce1afSJed Brown Logically Collective 2853b17ce1afSJed Brown 2854b17ce1afSJed Brown Input Arguments: 2855b17ce1afSJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 2856b17ce1afSJed Brown . coarsenhook - function to run when setting up a coarser level 2857b17ce1afSJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 28580298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2859b17ce1afSJed Brown 2860b17ce1afSJed Brown Calling sequence of coarsenhook: 2861b17ce1afSJed Brown $ coarsenhook(DM fine,DM coarse,void *ctx); 2862b17ce1afSJed Brown 2863b17ce1afSJed Brown + fine - fine level DM 2864b17ce1afSJed Brown . coarse - coarse level DM to restrict problem to 2865b17ce1afSJed Brown - ctx - optional user-defined function context 2866b17ce1afSJed Brown 2867b17ce1afSJed Brown Calling sequence for restricthook: 2868c833c3b5SJed Brown $ restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx) 2869b17ce1afSJed Brown 2870b17ce1afSJed Brown + fine - fine level DM 2871b17ce1afSJed Brown . mrestrict - matrix restricting a fine-level solution to the coarse grid 2872c833c3b5SJed Brown . rscale - scaling vector for restriction 2873c833c3b5SJed Brown . inject - matrix restricting by injection 2874b17ce1afSJed Brown . coarse - coarse level DM to update 2875b17ce1afSJed Brown - ctx - optional user-defined function context 2876b17ce1afSJed Brown 2877b17ce1afSJed Brown Level: advanced 2878b17ce1afSJed Brown 2879b17ce1afSJed Brown Notes: 2880b17ce1afSJed Brown This function is only needed if auxiliary data needs to be set up on coarse grids. 2881b17ce1afSJed Brown 2882b17ce1afSJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 2883b17ce1afSJed Brown 2884b17ce1afSJed Brown In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 2885b17ce1afSJed Brown extract the finest level information from its context (instead of from the SNES). 2886b17ce1afSJed Brown 2887bb9467b5SJed Brown This function is currently not available from Fortran. 2888bb9467b5SJed Brown 2889dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2890b17ce1afSJed Brown @*/ 2891b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 2892b17ce1afSJed Brown { 2893b17ce1afSJed Brown PetscErrorCode ierr; 2894b17ce1afSJed Brown DMCoarsenHookLink link,*p; 2895b17ce1afSJed Brown 2896b17ce1afSJed Brown PetscFunctionBegin; 2897b17ce1afSJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 28981e3d8eccSJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 28991e3d8eccSJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 29001e3d8eccSJed Brown } 290195dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2902b17ce1afSJed Brown link->coarsenhook = coarsenhook; 2903b17ce1afSJed Brown link->restricthook = restricthook; 2904b17ce1afSJed Brown link->ctx = ctx; 29050298fd71SBarry Smith link->next = NULL; 2906b17ce1afSJed Brown *p = link; 2907b17ce1afSJed Brown PetscFunctionReturn(0); 2908b17ce1afSJed Brown } 2909b17ce1afSJed Brown 2910dc822a44SJed Brown /*@C 2911dc822a44SJed Brown DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid 2912dc822a44SJed Brown 2913dc822a44SJed Brown Logically Collective 2914dc822a44SJed Brown 2915dc822a44SJed Brown Input Arguments: 2916dc822a44SJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 2917dc822a44SJed Brown . coarsenhook - function to run when setting up a coarser level 2918dc822a44SJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 2919dc822a44SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2920dc822a44SJed Brown 2921dc822a44SJed Brown Level: advanced 2922dc822a44SJed Brown 2923dc822a44SJed Brown Notes: 2924dc822a44SJed Brown This function does nothing if the hook is not in the list. 2925dc822a44SJed Brown 2926dc822a44SJed Brown This function is currently not available from Fortran. 2927dc822a44SJed Brown 2928dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2929dc822a44SJed Brown @*/ 2930dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 2931dc822a44SJed Brown { 2932dc822a44SJed Brown PetscErrorCode ierr; 2933dc822a44SJed Brown DMCoarsenHookLink link,*p; 2934dc822a44SJed Brown 2935dc822a44SJed Brown PetscFunctionBegin; 2936dc822a44SJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 2937dc822a44SJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 2938dc822a44SJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 2939dc822a44SJed Brown link = *p; 2940dc822a44SJed Brown *p = link->next; 2941dc822a44SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 2942dc822a44SJed Brown break; 2943dc822a44SJed Brown } 2944dc822a44SJed Brown } 2945dc822a44SJed Brown PetscFunctionReturn(0); 2946dc822a44SJed Brown } 2947dc822a44SJed Brown 2948dc822a44SJed Brown 2949b17ce1afSJed Brown /*@ 2950b17ce1afSJed Brown DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd() 2951b17ce1afSJed Brown 2952b17ce1afSJed Brown Collective if any hooks are 2953b17ce1afSJed Brown 2954b17ce1afSJed Brown Input Arguments: 2955b17ce1afSJed Brown + fine - finer DM to use as a base 2956b17ce1afSJed Brown . restrct - restriction matrix, apply using MatRestrict() 2957e91eccc2SStefano Zampini . rscale - scaling vector for restriction 2958b17ce1afSJed Brown . inject - injection matrix, also use MatRestrict() 2959e91eccc2SStefano Zampini - coarse - coarser DM to update 2960b17ce1afSJed Brown 2961b17ce1afSJed Brown Level: developer 2962b17ce1afSJed Brown 2963b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict() 2964b17ce1afSJed Brown @*/ 2965b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse) 2966b17ce1afSJed Brown { 2967b17ce1afSJed Brown PetscErrorCode ierr; 2968b17ce1afSJed Brown DMCoarsenHookLink link; 2969b17ce1afSJed Brown 2970b17ce1afSJed Brown PetscFunctionBegin; 2971b17ce1afSJed Brown for (link=fine->coarsenhook; link; link=link->next) { 29728865f1eaSKarl Rupp if (link->restricthook) { 29738865f1eaSKarl Rupp ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr); 29748865f1eaSKarl Rupp } 2975b17ce1afSJed Brown } 297647c6ae99SBarry Smith PetscFunctionReturn(0); 297747c6ae99SBarry Smith } 297847c6ae99SBarry Smith 2979bb9467b5SJed Brown /*@C 2980be081cd6SPeter Brune DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid 29815dbd56e3SPeter Brune 2982d083f849SBarry Smith Logically Collective on global 29835dbd56e3SPeter Brune 29845dbd56e3SPeter Brune Input Arguments: 29855dbd56e3SPeter Brune + global - global DM 2986ec4806b8SPeter Brune . ddhook - function to run to pass data to the decomposition DM upon its creation 29875dbd56e3SPeter Brune . restricthook - function to run to update data on block solve (at the beginning of the block solve) 29880298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 29895dbd56e3SPeter Brune 2990ec4806b8SPeter Brune 2991ec4806b8SPeter Brune Calling sequence for ddhook: 2992ec4806b8SPeter Brune $ ddhook(DM global,DM block,void *ctx) 2993ec4806b8SPeter Brune 2994ec4806b8SPeter Brune + global - global DM 2995ec4806b8SPeter Brune . block - block DM 2996ec4806b8SPeter Brune - ctx - optional user-defined function context 2997ec4806b8SPeter Brune 29985dbd56e3SPeter Brune Calling sequence for restricthook: 2999ec4806b8SPeter Brune $ restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx) 30005dbd56e3SPeter Brune 30015dbd56e3SPeter Brune + global - global DM 30025dbd56e3SPeter Brune . out - scatter to the outer (with ghost and overlap points) block vector 30035dbd56e3SPeter Brune . in - scatter to block vector values only owned locally 3004ec4806b8SPeter Brune . block - block DM 30055dbd56e3SPeter Brune - ctx - optional user-defined function context 30065dbd56e3SPeter Brune 30075dbd56e3SPeter Brune Level: advanced 30085dbd56e3SPeter Brune 30095dbd56e3SPeter Brune Notes: 3010ec4806b8SPeter Brune This function is only needed if auxiliary data needs to be set up on subdomain DMs. 30115dbd56e3SPeter Brune 30125dbd56e3SPeter Brune If this function is called multiple times, the hooks will be run in the order they are added. 30135dbd56e3SPeter Brune 30145dbd56e3SPeter Brune In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3015ec4806b8SPeter Brune extract the global information from its context (instead of from the SNES). 30165dbd56e3SPeter Brune 3017bb9467b5SJed Brown This function is currently not available from Fortran. 3018bb9467b5SJed Brown 30195dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 30205dbd56e3SPeter Brune @*/ 3021be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 30225dbd56e3SPeter Brune { 30235dbd56e3SPeter Brune PetscErrorCode ierr; 3024be081cd6SPeter Brune DMSubDomainHookLink link,*p; 30255dbd56e3SPeter Brune 30265dbd56e3SPeter Brune PetscFunctionBegin; 30275dbd56e3SPeter Brune PetscValidHeaderSpecific(global,DM_CLASSID,1); 3028b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 3029b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 3030b3a6b972SJed Brown } 303195dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 30325dbd56e3SPeter Brune link->restricthook = restricthook; 3033be081cd6SPeter Brune link->ddhook = ddhook; 30345dbd56e3SPeter Brune link->ctx = ctx; 30350298fd71SBarry Smith link->next = NULL; 30365dbd56e3SPeter Brune *p = link; 30375dbd56e3SPeter Brune PetscFunctionReturn(0); 30385dbd56e3SPeter Brune } 30395dbd56e3SPeter Brune 3040b3a6b972SJed Brown /*@C 3041b3a6b972SJed Brown DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid 3042b3a6b972SJed Brown 3043b3a6b972SJed Brown Logically Collective 3044b3a6b972SJed Brown 3045b3a6b972SJed Brown Input Arguments: 3046b3a6b972SJed Brown + global - global DM 3047b3a6b972SJed Brown . ddhook - function to run to pass data to the decomposition DM upon its creation 3048b3a6b972SJed Brown . restricthook - function to run to update data on block solve (at the beginning of the block solve) 3049b3a6b972SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3050b3a6b972SJed Brown 3051b3a6b972SJed Brown Level: advanced 3052b3a6b972SJed Brown 3053b3a6b972SJed Brown Notes: 3054b3a6b972SJed Brown 3055b3a6b972SJed Brown This function is currently not available from Fortran. 3056b3a6b972SJed Brown 3057b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3058b3a6b972SJed Brown @*/ 3059b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 3060b3a6b972SJed Brown { 3061b3a6b972SJed Brown PetscErrorCode ierr; 3062b3a6b972SJed Brown DMSubDomainHookLink link,*p; 3063b3a6b972SJed Brown 3064b3a6b972SJed Brown PetscFunctionBegin; 3065b3a6b972SJed Brown PetscValidHeaderSpecific(global,DM_CLASSID,1); 3066b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3067b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3068b3a6b972SJed Brown link = *p; 3069b3a6b972SJed Brown *p = link->next; 3070b3a6b972SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3071b3a6b972SJed Brown break; 3072b3a6b972SJed Brown } 3073b3a6b972SJed Brown } 3074b3a6b972SJed Brown PetscFunctionReturn(0); 3075b3a6b972SJed Brown } 3076b3a6b972SJed Brown 30775dbd56e3SPeter Brune /*@ 3078be081cd6SPeter Brune DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd() 30795dbd56e3SPeter Brune 30805dbd56e3SPeter Brune Collective if any hooks are 30815dbd56e3SPeter Brune 30825dbd56e3SPeter Brune Input Arguments: 30835dbd56e3SPeter Brune + fine - finer DM to use as a base 3084be081cd6SPeter Brune . oscatter - scatter from domain global vector filling subdomain global vector with overlap 3085be081cd6SPeter Brune . gscatter - scatter from domain global vector filling subdomain local vector with ghosts 30865dbd56e3SPeter Brune - coarse - coarer DM to update 30875dbd56e3SPeter Brune 30885dbd56e3SPeter Brune Level: developer 30895dbd56e3SPeter Brune 30905dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict() 30915dbd56e3SPeter Brune @*/ 3092be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm) 30935dbd56e3SPeter Brune { 30945dbd56e3SPeter Brune PetscErrorCode ierr; 3095be081cd6SPeter Brune DMSubDomainHookLink link; 30965dbd56e3SPeter Brune 30975dbd56e3SPeter Brune PetscFunctionBegin; 3098be081cd6SPeter Brune for (link=global->subdomainhook; link; link=link->next) { 30998865f1eaSKarl Rupp if (link->restricthook) { 31008865f1eaSKarl Rupp ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr); 31018865f1eaSKarl Rupp } 31025dbd56e3SPeter Brune } 31035dbd56e3SPeter Brune PetscFunctionReturn(0); 31045dbd56e3SPeter Brune } 31055dbd56e3SPeter Brune 31065fe1f584SPeter Brune /*@ 31076a7d9d85SPeter Brune DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM. 31085fe1f584SPeter Brune 31095fe1f584SPeter Brune Not Collective 31105fe1f584SPeter Brune 31115fe1f584SPeter Brune Input Parameter: 31125fe1f584SPeter Brune . dm - the DM object 31135fe1f584SPeter Brune 31145fe1f584SPeter Brune Output Parameter: 31156a7d9d85SPeter Brune . level - number of coarsenings 31165fe1f584SPeter Brune 31175fe1f584SPeter Brune Level: developer 31185fe1f584SPeter Brune 31196a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 31205fe1f584SPeter Brune 31215fe1f584SPeter Brune @*/ 31225fe1f584SPeter Brune PetscErrorCode DMGetCoarsenLevel(DM dm,PetscInt *level) 31235fe1f584SPeter Brune { 31245fe1f584SPeter Brune PetscFunctionBegin; 31255fe1f584SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3126b9d85ea2SLisandro Dalcin PetscValidIntPointer(level,2); 31275fe1f584SPeter Brune *level = dm->leveldown; 31285fe1f584SPeter Brune PetscFunctionReturn(0); 31295fe1f584SPeter Brune } 31305fe1f584SPeter Brune 31319a64c4a8SMatthew G. Knepley /*@ 31329a64c4a8SMatthew G. Knepley DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM. 31339a64c4a8SMatthew G. Knepley 31349a64c4a8SMatthew G. Knepley Not Collective 31359a64c4a8SMatthew G. Knepley 31369a64c4a8SMatthew G. Knepley Input Parameters: 31379a64c4a8SMatthew G. Knepley + dm - the DM object 31389a64c4a8SMatthew G. Knepley - level - number of coarsenings 31399a64c4a8SMatthew G. Knepley 31409a64c4a8SMatthew G. Knepley Level: developer 31419a64c4a8SMatthew G. Knepley 31429a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 31439a64c4a8SMatthew G. Knepley @*/ 31449a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level) 31459a64c4a8SMatthew G. Knepley { 31469a64c4a8SMatthew G. Knepley PetscFunctionBegin; 31479a64c4a8SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 31489a64c4a8SMatthew G. Knepley dm->leveldown = level; 31499a64c4a8SMatthew G. Knepley PetscFunctionReturn(0); 31509a64c4a8SMatthew G. Knepley } 31519a64c4a8SMatthew G. Knepley 31525fe1f584SPeter Brune 31535fe1f584SPeter Brune 315447c6ae99SBarry Smith /*@C 315547c6ae99SBarry Smith DMRefineHierarchy - Refines a DM object, all levels at once 315647c6ae99SBarry Smith 3157d083f849SBarry Smith Collective on dm 315847c6ae99SBarry Smith 315947c6ae99SBarry Smith Input Parameter: 316047c6ae99SBarry Smith + dm - the DM object 316147c6ae99SBarry Smith - nlevels - the number of levels of refinement 316247c6ae99SBarry Smith 316347c6ae99SBarry Smith Output Parameter: 316447c6ae99SBarry Smith . dmf - the refined DM hierarchy 316547c6ae99SBarry Smith 316647c6ae99SBarry Smith Level: developer 316747c6ae99SBarry Smith 3168e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 316947c6ae99SBarry Smith 317047c6ae99SBarry Smith @*/ 31717087cfbeSBarry Smith PetscErrorCode DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[]) 317247c6ae99SBarry Smith { 317347c6ae99SBarry Smith PetscErrorCode ierr; 317447c6ae99SBarry Smith 317547c6ae99SBarry Smith PetscFunctionBegin; 3176171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3177ce94432eSBarry Smith if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 317847c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 3179b9d85ea2SLisandro Dalcin PetscValidPointer(dmf,3); 318047c6ae99SBarry Smith if (dm->ops->refinehierarchy) { 318147c6ae99SBarry Smith ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr); 318247c6ae99SBarry Smith } else if (dm->ops->refine) { 318347c6ae99SBarry Smith PetscInt i; 318447c6ae99SBarry Smith 3185ce94432eSBarry Smith ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr); 318647c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3187ce94432eSBarry Smith ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr); 318847c6ae99SBarry Smith } 3189ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet"); 319047c6ae99SBarry Smith PetscFunctionReturn(0); 319147c6ae99SBarry Smith } 319247c6ae99SBarry Smith 319347c6ae99SBarry Smith /*@C 319447c6ae99SBarry Smith DMCoarsenHierarchy - Coarsens a DM object, all levels at once 319547c6ae99SBarry Smith 3196d083f849SBarry Smith Collective on dm 319747c6ae99SBarry Smith 319847c6ae99SBarry Smith Input Parameter: 319947c6ae99SBarry Smith + dm - the DM object 320047c6ae99SBarry Smith - nlevels - the number of levels of coarsening 320147c6ae99SBarry Smith 320247c6ae99SBarry Smith Output Parameter: 320347c6ae99SBarry Smith . dmc - the coarsened DM hierarchy 320447c6ae99SBarry Smith 320547c6ae99SBarry Smith Level: developer 320647c6ae99SBarry Smith 3207e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 320847c6ae99SBarry Smith 320947c6ae99SBarry Smith @*/ 32107087cfbeSBarry Smith PetscErrorCode DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[]) 321147c6ae99SBarry Smith { 321247c6ae99SBarry Smith PetscErrorCode ierr; 321347c6ae99SBarry Smith 321447c6ae99SBarry Smith PetscFunctionBegin; 3215171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3216ce94432eSBarry Smith if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 321747c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 321847c6ae99SBarry Smith PetscValidPointer(dmc,3); 321947c6ae99SBarry Smith if (dm->ops->coarsenhierarchy) { 322047c6ae99SBarry Smith ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr); 322147c6ae99SBarry Smith } else if (dm->ops->coarsen) { 322247c6ae99SBarry Smith PetscInt i; 322347c6ae99SBarry Smith 3224ce94432eSBarry Smith ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr); 322547c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3226ce94432eSBarry Smith ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr); 322747c6ae99SBarry Smith } 3228ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet"); 322947c6ae99SBarry Smith PetscFunctionReturn(0); 323047c6ae99SBarry Smith } 323147c6ae99SBarry Smith 32321a266240SBarry Smith /*@C 32331a266240SBarry Smith DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed 32341a266240SBarry Smith 32351a266240SBarry Smith Not Collective 32361a266240SBarry Smith 32371a266240SBarry Smith Input Parameters: 32381a266240SBarry Smith + dm - the DM object 32391a266240SBarry Smith - destroy - the destroy function 32401a266240SBarry Smith 32411a266240SBarry Smith Level: intermediate 32421a266240SBarry Smith 3243e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 32441a266240SBarry Smith 3245f07f9ceaSJed Brown @*/ 32461a266240SBarry Smith PetscErrorCode DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**)) 32471a266240SBarry Smith { 32481a266240SBarry Smith PetscFunctionBegin; 3249171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 32501a266240SBarry Smith dm->ctxdestroy = destroy; 32511a266240SBarry Smith PetscFunctionReturn(0); 32521a266240SBarry Smith } 32531a266240SBarry Smith 3254b07ff414SBarry Smith /*@ 32551b2093e4SBarry Smith DMSetApplicationContext - Set a user context into a DM object 325647c6ae99SBarry Smith 325747c6ae99SBarry Smith Not Collective 325847c6ae99SBarry Smith 325947c6ae99SBarry Smith Input Parameters: 326047c6ae99SBarry Smith + dm - the DM object 326147c6ae99SBarry Smith - ctx - the user context 326247c6ae99SBarry Smith 326347c6ae99SBarry Smith Level: intermediate 326447c6ae99SBarry Smith 3265e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 326647c6ae99SBarry Smith 326747c6ae99SBarry Smith @*/ 32681b2093e4SBarry Smith PetscErrorCode DMSetApplicationContext(DM dm,void *ctx) 326947c6ae99SBarry Smith { 327047c6ae99SBarry Smith PetscFunctionBegin; 3271171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 327247c6ae99SBarry Smith dm->ctx = ctx; 327347c6ae99SBarry Smith PetscFunctionReturn(0); 327447c6ae99SBarry Smith } 327547c6ae99SBarry Smith 327647c6ae99SBarry Smith /*@ 32771b2093e4SBarry Smith DMGetApplicationContext - Gets a user context from a DM object 327847c6ae99SBarry Smith 327947c6ae99SBarry Smith Not Collective 328047c6ae99SBarry Smith 328147c6ae99SBarry Smith Input Parameter: 328247c6ae99SBarry Smith . dm - the DM object 328347c6ae99SBarry Smith 328447c6ae99SBarry Smith Output Parameter: 328547c6ae99SBarry Smith . ctx - the user context 328647c6ae99SBarry Smith 328747c6ae99SBarry Smith Level: intermediate 328847c6ae99SBarry Smith 3289e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 329047c6ae99SBarry Smith 329147c6ae99SBarry Smith @*/ 32921b2093e4SBarry Smith PetscErrorCode DMGetApplicationContext(DM dm,void *ctx) 329347c6ae99SBarry Smith { 329447c6ae99SBarry Smith PetscFunctionBegin; 3295171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 32961b2093e4SBarry Smith *(void**)ctx = dm->ctx; 329747c6ae99SBarry Smith PetscFunctionReturn(0); 329847c6ae99SBarry Smith } 329947c6ae99SBarry Smith 330008da532bSDmitry Karpeev /*@C 3301df3898eeSBarry Smith DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI. 330208da532bSDmitry Karpeev 3303d083f849SBarry Smith Logically Collective on dm 330408da532bSDmitry Karpeev 330508da532bSDmitry Karpeev Input Parameter: 330608da532bSDmitry Karpeev + dm - the DM object 33070298fd71SBarry Smith - f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set) 330808da532bSDmitry Karpeev 330908da532bSDmitry Karpeev Level: intermediate 331008da532bSDmitry Karpeev 3311835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(), 331208da532bSDmitry Karpeev DMSetJacobian() 331308da532bSDmitry Karpeev 331408da532bSDmitry Karpeev @*/ 331508da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec)) 331608da532bSDmitry Karpeev { 331708da532bSDmitry Karpeev PetscFunctionBegin; 33185a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 331908da532bSDmitry Karpeev dm->ops->computevariablebounds = f; 332008da532bSDmitry Karpeev PetscFunctionReturn(0); 332108da532bSDmitry Karpeev } 332208da532bSDmitry Karpeev 332308da532bSDmitry Karpeev /*@ 332408da532bSDmitry Karpeev DMHasVariableBounds - does the DM object have a variable bounds function? 332508da532bSDmitry Karpeev 332608da532bSDmitry Karpeev Not Collective 332708da532bSDmitry Karpeev 332808da532bSDmitry Karpeev Input Parameter: 332908da532bSDmitry Karpeev . dm - the DM object to destroy 333008da532bSDmitry Karpeev 333108da532bSDmitry Karpeev Output Parameter: 333208da532bSDmitry Karpeev . flg - PETSC_TRUE if the variable bounds function exists 333308da532bSDmitry Karpeev 333408da532bSDmitry Karpeev Level: developer 333508da532bSDmitry Karpeev 333674e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 333708da532bSDmitry Karpeev 333808da532bSDmitry Karpeev @*/ 333908da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg) 334008da532bSDmitry Karpeev { 334108da532bSDmitry Karpeev PetscFunctionBegin; 33425a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3343534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 334408da532bSDmitry Karpeev *flg = (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE; 334508da532bSDmitry Karpeev PetscFunctionReturn(0); 334608da532bSDmitry Karpeev } 334708da532bSDmitry Karpeev 334808da532bSDmitry Karpeev /*@C 334908da532bSDmitry Karpeev DMComputeVariableBounds - compute variable bounds used by SNESVI. 335008da532bSDmitry Karpeev 3351d083f849SBarry Smith Logically Collective on dm 335208da532bSDmitry Karpeev 335308da532bSDmitry Karpeev Input Parameters: 3354907376e6SBarry Smith . dm - the DM object 335508da532bSDmitry Karpeev 335608da532bSDmitry Karpeev Output parameters: 335708da532bSDmitry Karpeev + xl - lower bound 335808da532bSDmitry Karpeev - xu - upper bound 335908da532bSDmitry Karpeev 3360907376e6SBarry Smith Level: advanced 3361907376e6SBarry Smith 336295452b02SPatrick Sanan Notes: 336395452b02SPatrick Sanan This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds() 336408da532bSDmitry Karpeev 336574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 336608da532bSDmitry Karpeev 336708da532bSDmitry Karpeev @*/ 336808da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu) 336908da532bSDmitry Karpeev { 337008da532bSDmitry Karpeev PetscErrorCode ierr; 33715fd66863SKarl Rupp 337208da532bSDmitry Karpeev PetscFunctionBegin; 33735a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 337408da532bSDmitry Karpeev PetscValidHeaderSpecific(xl,VEC_CLASSID,2); 33755a84ad33SLisandro Dalcin PetscValidHeaderSpecific(xu,VEC_CLASSID,3); 3376b9d85ea2SLisandro Dalcin if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name); 337708da532bSDmitry Karpeev ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr); 337808da532bSDmitry Karpeev PetscFunctionReturn(0); 337908da532bSDmitry Karpeev } 338008da532bSDmitry Karpeev 3381b0ae01b7SPeter Brune /*@ 3382b0ae01b7SPeter Brune DMHasColoring - does the DM object have a method of providing a coloring? 3383b0ae01b7SPeter Brune 3384b0ae01b7SPeter Brune Not Collective 3385b0ae01b7SPeter Brune 3386b0ae01b7SPeter Brune Input Parameter: 3387b0ae01b7SPeter Brune . dm - the DM object 3388b0ae01b7SPeter Brune 3389b0ae01b7SPeter Brune Output Parameter: 3390b0ae01b7SPeter Brune . flg - PETSC_TRUE if the DM has facilities for DMCreateColoring(). 3391b0ae01b7SPeter Brune 3392b0ae01b7SPeter Brune Level: developer 3393b0ae01b7SPeter Brune 33941565f0a7SPatrick Sanan .seealso DMCreateColoring() 3395b0ae01b7SPeter Brune 3396b0ae01b7SPeter Brune @*/ 3397b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg) 3398b0ae01b7SPeter Brune { 3399b0ae01b7SPeter Brune PetscFunctionBegin; 34005a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3401534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 3402b0ae01b7SPeter Brune *flg = (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE; 3403b0ae01b7SPeter Brune PetscFunctionReturn(0); 3404b0ae01b7SPeter Brune } 3405b0ae01b7SPeter Brune 34063ad4599aSBarry Smith /*@ 34073ad4599aSBarry Smith DMHasCreateRestriction - does the DM object have a method of providing a restriction? 34083ad4599aSBarry Smith 34093ad4599aSBarry Smith Not Collective 34103ad4599aSBarry Smith 34113ad4599aSBarry Smith Input Parameter: 34123ad4599aSBarry Smith . dm - the DM object 34133ad4599aSBarry Smith 34143ad4599aSBarry Smith Output Parameter: 34153ad4599aSBarry Smith . flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction(). 34163ad4599aSBarry Smith 34173ad4599aSBarry Smith Level: developer 34183ad4599aSBarry Smith 34191565f0a7SPatrick Sanan .seealso DMCreateRestriction() 34203ad4599aSBarry Smith 34213ad4599aSBarry Smith @*/ 34223ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg) 34233ad4599aSBarry Smith { 34243ad4599aSBarry Smith PetscFunctionBegin; 34255a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3426534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 34273ad4599aSBarry Smith *flg = (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE; 34283ad4599aSBarry Smith PetscFunctionReturn(0); 34293ad4599aSBarry Smith } 34303ad4599aSBarry Smith 3431a7058e45SLawrence Mitchell 3432a7058e45SLawrence Mitchell /*@ 3433a7058e45SLawrence Mitchell DMHasCreateInjection - does the DM object have a method of providing an injection? 3434a7058e45SLawrence Mitchell 3435a7058e45SLawrence Mitchell Not Collective 3436a7058e45SLawrence Mitchell 3437a7058e45SLawrence Mitchell Input Parameter: 3438a7058e45SLawrence Mitchell . dm - the DM object 3439a7058e45SLawrence Mitchell 3440a7058e45SLawrence Mitchell Output Parameter: 3441a7058e45SLawrence Mitchell . flg - PETSC_TRUE if the DM has facilities for DMCreateInjection(). 3442a7058e45SLawrence Mitchell 3443a7058e45SLawrence Mitchell Level: developer 3444a7058e45SLawrence Mitchell 34451565f0a7SPatrick Sanan .seealso DMCreateInjection() 3446a7058e45SLawrence Mitchell 3447a7058e45SLawrence Mitchell @*/ 3448a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg) 3449a7058e45SLawrence Mitchell { 34504a7a4c06SLawrence Mitchell PetscErrorCode ierr; 34515a84ad33SLisandro Dalcin 3452a7058e45SLawrence Mitchell PetscFunctionBegin; 34535a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3454534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 34555a84ad33SLisandro Dalcin if (dm->ops->hascreateinjection) { 34564a7a4c06SLawrence Mitchell ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr); 34575a84ad33SLisandro Dalcin } else { 34585a84ad33SLisandro Dalcin *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE; 34595a84ad33SLisandro Dalcin } 3460a7058e45SLawrence Mitchell PetscFunctionReturn(0); 3461a7058e45SLawrence Mitchell } 3462a7058e45SLawrence Mitchell 34635a84ad33SLisandro Dalcin 3464748fac09SDmitry Karpeev /*@C 346508da532bSDmitry Karpeev DMSetVec - set the vector at which to compute residual, Jacobian and VI bounds, if the problem is nonlinear. 346608da532bSDmitry Karpeev 3467d083f849SBarry Smith Collective on dm 346808da532bSDmitry Karpeev 346908da532bSDmitry Karpeev Input Parameter: 347008da532bSDmitry Karpeev + dm - the DM object 34710298fd71SBarry Smith - x - location to compute residual and Jacobian, if NULL is passed to those routines; will be NULL for linear problems. 347208da532bSDmitry Karpeev 347308da532bSDmitry Karpeev Level: developer 347408da532bSDmitry Karpeev 347574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 347608da532bSDmitry Karpeev 347708da532bSDmitry Karpeev @*/ 347808da532bSDmitry Karpeev PetscErrorCode DMSetVec(DM dm,Vec x) 347908da532bSDmitry Karpeev { 348008da532bSDmitry Karpeev PetscErrorCode ierr; 34815fd66863SKarl Rupp 348208da532bSDmitry Karpeev PetscFunctionBegin; 3483b9d85ea2SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 348408da532bSDmitry Karpeev if (x) { 348508da532bSDmitry Karpeev if (!dm->x) { 348608da532bSDmitry Karpeev ierr = DMCreateGlobalVector(dm,&dm->x);CHKERRQ(ierr); 348708da532bSDmitry Karpeev } 348808da532bSDmitry Karpeev ierr = VecCopy(x,dm->x);CHKERRQ(ierr); 34898865f1eaSKarl Rupp } else if (dm->x) { 349008da532bSDmitry Karpeev ierr = VecDestroy(&dm->x);CHKERRQ(ierr); 349108da532bSDmitry Karpeev } 349208da532bSDmitry Karpeev PetscFunctionReturn(0); 349308da532bSDmitry Karpeev } 349408da532bSDmitry Karpeev 34950298fd71SBarry Smith PetscFunctionList DMList = NULL; 3496264ace61SBarry Smith PetscBool DMRegisterAllCalled = PETSC_FALSE; 3497264ace61SBarry Smith 3498264ace61SBarry Smith /*@C 3499264ace61SBarry Smith DMSetType - Builds a DM, for a particular DM implementation. 3500264ace61SBarry Smith 3501d083f849SBarry Smith Collective on dm 3502264ace61SBarry Smith 3503264ace61SBarry Smith Input Parameters: 3504264ace61SBarry Smith + dm - The DM object 3505264ace61SBarry Smith - method - The name of the DM type 3506264ace61SBarry Smith 3507264ace61SBarry Smith Options Database Key: 3508264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types 3509264ace61SBarry Smith 3510264ace61SBarry Smith Notes: 3511e1589f56SBarry Smith See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D). 3512264ace61SBarry Smith 3513264ace61SBarry Smith Level: intermediate 3514264ace61SBarry Smith 3515264ace61SBarry Smith .seealso: DMGetType(), DMCreate() 3516264ace61SBarry Smith @*/ 351719fd82e9SBarry Smith PetscErrorCode DMSetType(DM dm, DMType method) 3518264ace61SBarry Smith { 3519264ace61SBarry Smith PetscErrorCode (*r)(DM); 3520264ace61SBarry Smith PetscBool match; 3521264ace61SBarry Smith PetscErrorCode ierr; 3522264ace61SBarry Smith 3523264ace61SBarry Smith PetscFunctionBegin; 3524264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3525251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr); 3526264ace61SBarry Smith if (match) PetscFunctionReturn(0); 3527264ace61SBarry Smith 35280f51fdf8SToby Isaac ierr = DMRegisterAll();CHKERRQ(ierr); 35291c9cd337SJed Brown ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr); 3530ce94432eSBarry Smith if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method); 3531264ace61SBarry Smith 3532264ace61SBarry Smith if (dm->ops->destroy) { 3533264ace61SBarry Smith ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr); 3534264ace61SBarry Smith } 3535d57f96a3SLisandro Dalcin ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr); 3536264ace61SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr); 3537d57f96a3SLisandro Dalcin ierr = (*r)(dm);CHKERRQ(ierr); 3538264ace61SBarry Smith PetscFunctionReturn(0); 3539264ace61SBarry Smith } 3540264ace61SBarry Smith 3541264ace61SBarry Smith /*@C 3542264ace61SBarry Smith DMGetType - Gets the DM type name (as a string) from the DM. 3543264ace61SBarry Smith 3544264ace61SBarry Smith Not Collective 3545264ace61SBarry Smith 3546264ace61SBarry Smith Input Parameter: 3547264ace61SBarry Smith . dm - The DM 3548264ace61SBarry Smith 3549264ace61SBarry Smith Output Parameter: 3550264ace61SBarry Smith . type - The DM type name 3551264ace61SBarry Smith 3552264ace61SBarry Smith Level: intermediate 3553264ace61SBarry Smith 3554264ace61SBarry Smith .seealso: DMSetType(), DMCreate() 3555264ace61SBarry Smith @*/ 355619fd82e9SBarry Smith PetscErrorCode DMGetType(DM dm, DMType *type) 3557264ace61SBarry Smith { 3558264ace61SBarry Smith PetscErrorCode ierr; 3559264ace61SBarry Smith 3560264ace61SBarry Smith PetscFunctionBegin; 3561264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3562c959eef4SJed Brown PetscValidPointer(type,2); 3563607a6623SBarry Smith ierr = DMRegisterAll();CHKERRQ(ierr); 3564264ace61SBarry Smith *type = ((PetscObject)dm)->type_name; 3565264ace61SBarry Smith PetscFunctionReturn(0); 3566264ace61SBarry Smith } 3567264ace61SBarry Smith 356867a56275SMatthew G Knepley /*@C 356967a56275SMatthew G Knepley DMConvert - Converts a DM to another DM, either of the same or different type. 357067a56275SMatthew G Knepley 3571d083f849SBarry Smith Collective on dm 357267a56275SMatthew G Knepley 357367a56275SMatthew G Knepley Input Parameters: 357467a56275SMatthew G Knepley + dm - the DM 357567a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type) 357667a56275SMatthew G Knepley 357767a56275SMatthew G Knepley Output Parameter: 357867a56275SMatthew G Knepley . M - pointer to new DM 357967a56275SMatthew G Knepley 358067a56275SMatthew G Knepley Notes: 358167a56275SMatthew G Knepley Cannot be used to convert a sequential DM to parallel or parallel to sequential, 358267a56275SMatthew G Knepley the MPI communicator of the generated DM is always the same as the communicator 358367a56275SMatthew G Knepley of the input DM. 358467a56275SMatthew G Knepley 358567a56275SMatthew G Knepley Level: intermediate 358667a56275SMatthew G Knepley 358767a56275SMatthew G Knepley .seealso: DMCreate() 358867a56275SMatthew G Knepley @*/ 358919fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M) 359067a56275SMatthew G Knepley { 359167a56275SMatthew G Knepley DM B; 359267a56275SMatthew G Knepley char convname[256]; 3593c067b6caSMatthew G. Knepley PetscBool sametype/*, issame */; 359467a56275SMatthew G Knepley PetscErrorCode ierr; 359567a56275SMatthew G Knepley 359667a56275SMatthew G Knepley PetscFunctionBegin; 359767a56275SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 359867a56275SMatthew G Knepley PetscValidType(dm,1); 359967a56275SMatthew G Knepley PetscValidPointer(M,3); 3600251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr); 3601c067b6caSMatthew G. Knepley /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */ 3602c067b6caSMatthew G. Knepley if (sametype) { 3603c067b6caSMatthew G. Knepley *M = dm; 3604c067b6caSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr); 3605c067b6caSMatthew G. Knepley PetscFunctionReturn(0); 3606c067b6caSMatthew G. Knepley } else { 36070298fd71SBarry Smith PetscErrorCode (*conv)(DM, DMType, DM*) = NULL; 360867a56275SMatthew G Knepley 360967a56275SMatthew G Knepley /* 361067a56275SMatthew G Knepley Order of precedence: 361167a56275SMatthew G Knepley 1) See if a specialized converter is known to the current DM. 361267a56275SMatthew G Knepley 2) See if a specialized converter is known to the desired DM class. 361367a56275SMatthew G Knepley 3) See if a good general converter is registered for the desired class 361467a56275SMatthew G Knepley 4) See if a good general converter is known for the current matrix. 361567a56275SMatthew G Knepley 5) Use a really basic converter. 361667a56275SMatthew G Knepley */ 361767a56275SMatthew G Knepley 361867a56275SMatthew G Knepley /* 1) See if a specialized converter is known to the current DM and the desired class */ 3619a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3620a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3621a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3622a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3623a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 36240005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr); 362567a56275SMatthew G Knepley if (conv) goto foundconv; 362667a56275SMatthew G Knepley 362767a56275SMatthew G Knepley /* 2) See if a specialized converter is known to the desired DM class. */ 362882f516ccSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr); 362967a56275SMatthew G Knepley ierr = DMSetType(B, newtype);CHKERRQ(ierr); 3630a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3631a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3632a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3633a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3634a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 36350005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr); 363667a56275SMatthew G Knepley if (conv) { 3637fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 363867a56275SMatthew G Knepley goto foundconv; 363967a56275SMatthew G Knepley } 364067a56275SMatthew G Knepley 364167a56275SMatthew G Knepley #if 0 364267a56275SMatthew G Knepley /* 3) See if a good general converter is registered for the desired class */ 364367a56275SMatthew G Knepley conv = B->ops->convertfrom; 3644fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 364567a56275SMatthew G Knepley if (conv) goto foundconv; 364667a56275SMatthew G Knepley 364767a56275SMatthew G Knepley /* 4) See if a good general converter is known for the current matrix */ 364867a56275SMatthew G Knepley if (dm->ops->convert) { 364967a56275SMatthew G Knepley conv = dm->ops->convert; 365067a56275SMatthew G Knepley } 365167a56275SMatthew G Knepley if (conv) goto foundconv; 365267a56275SMatthew G Knepley #endif 365367a56275SMatthew G Knepley 365467a56275SMatthew G Knepley /* 5) Use a really basic converter. */ 365582f516ccSBarry Smith SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype); 365667a56275SMatthew G Knepley 365767a56275SMatthew G Knepley foundconv: 365867a56275SMatthew G Knepley ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 365967a56275SMatthew G Knepley ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr); 366012fa691eSMatthew G. Knepley /* Things that are independent of DM type: We should consult DMClone() here */ 366190b157c4SStefano Zampini { 366290b157c4SStefano Zampini PetscBool isper; 366312fa691eSMatthew G. Knepley const PetscReal *maxCell, *L; 366412fa691eSMatthew G. Knepley const DMBoundaryType *bd; 366590b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 366690b157c4SStefano Zampini ierr = DMSetPeriodicity(*M, isper, maxCell, L, bd);CHKERRQ(ierr); 366712fa691eSMatthew G. Knepley } 366867a56275SMatthew G Knepley ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 366967a56275SMatthew G Knepley } 367067a56275SMatthew G Knepley ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr); 367167a56275SMatthew G Knepley PetscFunctionReturn(0); 367267a56275SMatthew G Knepley } 3673264ace61SBarry Smith 3674264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/ 3675264ace61SBarry Smith 3676264ace61SBarry Smith /*@C 36771c84c290SBarry Smith DMRegister - Adds a new DM component implementation 36781c84c290SBarry Smith 36791c84c290SBarry Smith Not Collective 36801c84c290SBarry Smith 36811c84c290SBarry Smith Input Parameters: 36821c84c290SBarry Smith + name - The name of a new user-defined creation routine 36831c84c290SBarry Smith - create_func - The creation routine itself 36841c84c290SBarry Smith 36851c84c290SBarry Smith Notes: 36861c84c290SBarry Smith DMRegister() may be called multiple times to add several user-defined DMs 36871c84c290SBarry Smith 36881c84c290SBarry Smith 36891c84c290SBarry Smith Sample usage: 36901c84c290SBarry Smith .vb 3691bdf89e91SBarry Smith DMRegister("my_da", MyDMCreate); 36921c84c290SBarry Smith .ve 36931c84c290SBarry Smith 36941c84c290SBarry Smith Then, your DM type can be chosen with the procedural interface via 36951c84c290SBarry Smith .vb 36961c84c290SBarry Smith DMCreate(MPI_Comm, DM *); 36971c84c290SBarry Smith DMSetType(DM,"my_da"); 36981c84c290SBarry Smith .ve 36991c84c290SBarry Smith or at runtime via the option 37001c84c290SBarry Smith .vb 37011c84c290SBarry Smith -da_type my_da 37021c84c290SBarry Smith .ve 3703264ace61SBarry Smith 3704264ace61SBarry Smith Level: advanced 37051c84c290SBarry Smith 3706bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy() 37071c84c290SBarry Smith 3708264ace61SBarry Smith @*/ 3709bdf89e91SBarry Smith PetscErrorCode DMRegister(const char sname[],PetscErrorCode (*function)(DM)) 3710264ace61SBarry Smith { 3711264ace61SBarry Smith PetscErrorCode ierr; 3712264ace61SBarry Smith 3713264ace61SBarry Smith PetscFunctionBegin; 37141d36bdfdSBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 3715a240a19fSJed Brown ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr); 3716264ace61SBarry Smith PetscFunctionReturn(0); 3717264ace61SBarry Smith } 3718264ace61SBarry Smith 3719b859378eSBarry Smith /*@C 372055849f57SBarry Smith DMLoad - Loads a DM that has been stored in binary with DMView(). 3721b859378eSBarry Smith 3722d083f849SBarry Smith Collective on viewer 3723b859378eSBarry Smith 3724b859378eSBarry Smith Input Parameters: 3725b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or 3726b859378eSBarry Smith some related function before a call to DMLoad(). 3727b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or 3728b859378eSBarry Smith HDF5 file viewer, obtained from PetscViewerHDF5Open() 3729b859378eSBarry Smith 3730b859378eSBarry Smith Level: intermediate 3731b859378eSBarry Smith 3732b859378eSBarry Smith Notes: 373355849f57SBarry Smith The type is determined by the data in the file, any type set into the DM before this call is ignored. 3734b859378eSBarry Smith 3735b859378eSBarry Smith Notes for advanced users: 3736b859378eSBarry Smith Most users should not need to know the details of the binary storage 3737b859378eSBarry Smith format, since DMLoad() and DMView() completely hide these details. 3738b859378eSBarry Smith But for anyone who's interested, the standard binary matrix storage 3739b859378eSBarry Smith format is 3740b859378eSBarry Smith .vb 3741b859378eSBarry Smith has not yet been determined 3742b859378eSBarry Smith .ve 3743b859378eSBarry Smith 3744b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad() 3745b859378eSBarry Smith @*/ 3746b859378eSBarry Smith PetscErrorCode DMLoad(DM newdm, PetscViewer viewer) 3747b859378eSBarry Smith { 37489331c7a4SMatthew G. Knepley PetscBool isbinary, ishdf5; 3749b859378eSBarry Smith PetscErrorCode ierr; 3750b859378eSBarry Smith 3751b859378eSBarry Smith PetscFunctionBegin; 3752b859378eSBarry Smith PetscValidHeaderSpecific(newdm,DM_CLASSID,1); 3753b859378eSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 3754fb694a9eSVaclav Hapla ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr); 375532c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 37569331c7a4SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr); 37579331c7a4SMatthew G. Knepley if (isbinary) { 37589331c7a4SMatthew G. Knepley PetscInt classid; 37599331c7a4SMatthew G. Knepley char type[256]; 3760b859378eSBarry Smith 3761060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 37629200755eSBarry Smith if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid); 3763060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 376432c0f0efSBarry Smith ierr = DMSetType(newdm, type);CHKERRQ(ierr); 37659331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 37669331c7a4SMatthew G. Knepley } else if (ishdf5) { 37679331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 37689331c7a4SMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()"); 3769b859378eSBarry Smith PetscFunctionReturn(0); 3770b859378eSBarry Smith } 3771b859378eSBarry Smith 3772b2e4378dSMatthew G. Knepley /*@ 3773b2e4378dSMatthew G. Knepley DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process. 3774b2e4378dSMatthew G. Knepley 3775b2e4378dSMatthew G. Knepley Not collective 3776b2e4378dSMatthew G. Knepley 3777b2e4378dSMatthew G. Knepley Input Parameter: 3778b2e4378dSMatthew G. Knepley . dm - the DM 3779b2e4378dSMatthew G. Knepley 3780b2e4378dSMatthew G. Knepley Output Parameters: 3781b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional) 3782b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional) 3783b2e4378dSMatthew G. Knepley 3784b2e4378dSMatthew G. Knepley Level: beginner 3785b2e4378dSMatthew G. Knepley 3786b2e4378dSMatthew G. Knepley Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead. 3787b2e4378dSMatthew G. Knepley 3788b2e4378dSMatthew G. Knepley 3789b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox() 3790b2e4378dSMatthew G. Knepley @*/ 3791b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[]) 3792b2e4378dSMatthew G. Knepley { 3793b2e4378dSMatthew G. Knepley Vec coords = NULL; 3794b2e4378dSMatthew G. Knepley PetscReal min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL}; 3795b2e4378dSMatthew G. Knepley PetscReal max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL}; 3796b2e4378dSMatthew G. Knepley const PetscScalar *local_coords; 3797b2e4378dSMatthew G. Knepley PetscInt N, Ni; 3798b2e4378dSMatthew G. Knepley PetscInt cdim, i, j; 3799b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 3800b2e4378dSMatthew G. Knepley 3801b2e4378dSMatthew G. Knepley PetscFunctionBegin; 3802b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3803b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 3804b2e4378dSMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 3805b2e4378dSMatthew G. Knepley if (coords) { 3806b2e4378dSMatthew G. Knepley ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr); 3807b2e4378dSMatthew G. Knepley ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr); 3808b2e4378dSMatthew G. Knepley Ni = N/cdim; 3809b2e4378dSMatthew G. Knepley for (i = 0; i < Ni; ++i) { 3810b2e4378dSMatthew G. Knepley for (j = 0; j < 3; ++j) { 3811b2e4378dSMatthew G. Knepley min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 3812b2e4378dSMatthew G. Knepley max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 3813b2e4378dSMatthew G. Knepley } 3814b2e4378dSMatthew G. Knepley } 3815b2e4378dSMatthew G. Knepley ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr); 3816b2e4378dSMatthew G. Knepley } else { 3817b2e4378dSMatthew G. Knepley PetscBool isda; 3818b2e4378dSMatthew G. Knepley 3819b2e4378dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr); 3820b2e4378dSMatthew G. Knepley if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);} 3821b2e4378dSMatthew G. Knepley } 3822b2e4378dSMatthew G. Knepley if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);} 3823b2e4378dSMatthew G. Knepley if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);} 3824b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 3825b2e4378dSMatthew G. Knepley } 3826b2e4378dSMatthew G. Knepley 3827b2e4378dSMatthew G. Knepley /*@ 3828b2e4378dSMatthew G. Knepley DMGetBoundingBox - Returns the global bounding box for the DM. 3829b2e4378dSMatthew G. Knepley 3830b2e4378dSMatthew G. Knepley Collective 3831b2e4378dSMatthew G. Knepley 3832b2e4378dSMatthew G. Knepley Input Parameter: 3833b2e4378dSMatthew G. Knepley . dm - the DM 3834b2e4378dSMatthew G. Knepley 3835b2e4378dSMatthew G. Knepley Output Parameters: 3836b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional) 3837b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional) 3838b2e4378dSMatthew G. Knepley 3839b2e4378dSMatthew G. Knepley Level: beginner 3840b2e4378dSMatthew G. Knepley 3841b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal() 3842b2e4378dSMatthew G. Knepley @*/ 3843b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[]) 3844b2e4378dSMatthew G. Knepley { 3845b2e4378dSMatthew G. Knepley PetscReal lmin[3], lmax[3]; 38466ce308c4SMatthew G. Knepley PetscInt cdim; 38476ce308c4SMatthew G. Knepley PetscMPIInt count; 3848b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 3849b2e4378dSMatthew G. Knepley 3850b2e4378dSMatthew G. Knepley PetscFunctionBegin; 3851b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3852b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 3853b2e4378dSMatthew G. Knepley ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr); 3854b2e4378dSMatthew G. Knepley ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr); 3855b2e4378dSMatthew G. Knepley if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);} 3856b2e4378dSMatthew G. Knepley if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);} 3857b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 3858b2e4378dSMatthew G. Knepley } 3859b2e4378dSMatthew G. Knepley 38607da65231SMatthew G Knepley /******************************** FEM Support **********************************/ 38617da65231SMatthew G Knepley 3862a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[]) 3863a6dfd86eSKarl Rupp { 38641d47ebbbSSatish Balay PetscInt f; 38651b30c384SMatthew G Knepley PetscErrorCode ierr; 38661b30c384SMatthew G Knepley 38677da65231SMatthew G Knepley PetscFunctionBegin; 386874778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 38691d47ebbbSSatish Balay for (f = 0; f < len; ++f) { 387057622a8eSBarry Smith ierr = PetscPrintf(PETSC_COMM_SELF, " | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr); 38717da65231SMatthew G Knepley } 38727da65231SMatthew G Knepley PetscFunctionReturn(0); 38737da65231SMatthew G Knepley } 38747da65231SMatthew G Knepley 3875a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[]) 3876a6dfd86eSKarl Rupp { 38771b30c384SMatthew G Knepley PetscInt f, g; 38787da65231SMatthew G Knepley PetscErrorCode ierr; 38797da65231SMatthew G Knepley 38807da65231SMatthew G Knepley PetscFunctionBegin; 388174778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 38821d47ebbbSSatish Balay for (f = 0; f < rows; ++f) { 388374778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |");CHKERRQ(ierr); 38841d47ebbbSSatish Balay for (g = 0; g < cols; ++g) { 3885e3556bceSMatthew G. Knepley ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr); 38867da65231SMatthew G Knepley } 388774778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr); 38887da65231SMatthew G Knepley } 38897da65231SMatthew G Knepley PetscFunctionReturn(0); 38907da65231SMatthew G Knepley } 3891e7c4fc90SDmitry Karpeev 38926113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X) 3893e759306cSMatthew G. Knepley { 38940c5b8624SToby Isaac PetscInt localSize, bs; 38950c5b8624SToby Isaac PetscMPIInt size; 38960c5b8624SToby Isaac Vec x, xglob; 38970c5b8624SToby Isaac const PetscScalar *xarray; 3898e759306cSMatthew G. Knepley PetscErrorCode ierr; 3899e759306cSMatthew G. Knepley 3900e759306cSMatthew G. Knepley PetscFunctionBegin; 39019852e123SBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRQ(ierr); 3902e759306cSMatthew G. Knepley ierr = VecDuplicate(X, &x);CHKERRQ(ierr); 3903e759306cSMatthew G. Knepley ierr = VecCopy(X, x);CHKERRQ(ierr); 39046113b454SMatthew G. Knepley ierr = VecChop(x, tol);CHKERRQ(ierr); 39050c5b8624SToby Isaac ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr); 39060c5b8624SToby Isaac if (size > 1) { 39070c5b8624SToby Isaac ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr); 39080c5b8624SToby Isaac ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr); 39090c5b8624SToby Isaac ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 39100c5b8624SToby Isaac ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr); 39110c5b8624SToby Isaac } else { 39120c5b8624SToby Isaac xglob = x; 39130c5b8624SToby Isaac } 39140c5b8624SToby Isaac ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr); 39150c5b8624SToby Isaac if (size > 1) { 39160c5b8624SToby Isaac ierr = VecDestroy(&xglob);CHKERRQ(ierr); 39170c5b8624SToby Isaac ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr); 39180c5b8624SToby Isaac } 3919e759306cSMatthew G. Knepley ierr = VecDestroy(&x);CHKERRQ(ierr); 3920e759306cSMatthew G. Knepley PetscFunctionReturn(0); 3921e759306cSMatthew G. Knepley } 3922e759306cSMatthew G. Knepley 392388ed4aceSMatthew G Knepley /*@ 39241bb6d2a8SBarry Smith DMGetSection - Get the PetscSection encoding the local data layout for the DM. This is equivalent to DMGetLocalSection(). Deprecated in v3.12 3925061576a5SJed Brown 3926061576a5SJed Brown Input Parameter: 3927061576a5SJed Brown . dm - The DM 3928061576a5SJed Brown 3929061576a5SJed Brown Output Parameter: 3930061576a5SJed Brown . section - The PetscSection 3931061576a5SJed Brown 3932061576a5SJed Brown Options Database Keys: 3933061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM 3934061576a5SJed Brown 3935061576a5SJed Brown Level: advanced 3936061576a5SJed Brown 3937061576a5SJed Brown Notes: 3938061576a5SJed Brown Use DMGetLocalSection() in new code. 3939061576a5SJed Brown 3940061576a5SJed Brown This gets a borrowed reference, so the user should not destroy this PetscSection. 3941061576a5SJed Brown 3942061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection() 3943061576a5SJed Brown @*/ 3944061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section) 3945061576a5SJed Brown { 3946061576a5SJed Brown PetscErrorCode ierr; 3947061576a5SJed Brown 3948061576a5SJed Brown PetscFunctionBegin; 3949061576a5SJed Brown ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr); 3950061576a5SJed Brown PetscFunctionReturn(0); 3951061576a5SJed Brown } 3952061576a5SJed Brown 3953061576a5SJed Brown /*@ 3954061576a5SJed Brown DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM. 395588ed4aceSMatthew G Knepley 395688ed4aceSMatthew G Knepley Input Parameter: 395788ed4aceSMatthew G Knepley . dm - The DM 395888ed4aceSMatthew G Knepley 395988ed4aceSMatthew G Knepley Output Parameter: 396088ed4aceSMatthew G Knepley . section - The PetscSection 396188ed4aceSMatthew G Knepley 3962e5893cccSMatthew G. Knepley Options Database Keys: 3963e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM 3964e5893cccSMatthew G. Knepley 396588ed4aceSMatthew G Knepley Level: intermediate 396688ed4aceSMatthew G Knepley 396788ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 396888ed4aceSMatthew G Knepley 3969061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection() 397088ed4aceSMatthew G Knepley @*/ 3971061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section) 39720adebc6cSBarry Smith { 3973fd59a867SMatthew G. Knepley PetscErrorCode ierr; 3974fd59a867SMatthew G. Knepley 397588ed4aceSMatthew G Knepley PetscFunctionBegin; 397688ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 397788ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 39781bb6d2a8SBarry Smith if (!dm->localSection && dm->ops->createlocalsection) { 3979e5e52638SMatthew G. Knepley PetscInt d; 3980e5e52638SMatthew G. Knepley 3981e5e52638SMatthew G. Knepley if (dm->setfromoptionscalled) for (d = 0; d < dm->Nds; ++d) {ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);} 39821bb6d2a8SBarry Smith ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr); 39831bb6d2a8SBarry Smith if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);} 39842f0f8703SMatthew G. Knepley } 39851bb6d2a8SBarry Smith *section = dm->localSection; 398688ed4aceSMatthew G Knepley PetscFunctionReturn(0); 398788ed4aceSMatthew G Knepley } 398888ed4aceSMatthew G Knepley 398988ed4aceSMatthew G Knepley /*@ 39901bb6d2a8SBarry Smith DMSetSection - Set the PetscSection encoding the local data layout for the DM. This is equivalent to DMSetLocalSection(). Deprecated in v3.12 3991061576a5SJed Brown 3992061576a5SJed Brown Input Parameters: 3993061576a5SJed Brown + dm - The DM 3994061576a5SJed Brown - section - The PetscSection 3995061576a5SJed Brown 3996061576a5SJed Brown Level: advanced 3997061576a5SJed Brown 3998061576a5SJed Brown Notes: 3999061576a5SJed Brown Use DMSetLocalSection() in new code. 4000061576a5SJed Brown 4001061576a5SJed Brown Any existing Section will be destroyed 4002061576a5SJed Brown 4003061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection() 4004061576a5SJed Brown @*/ 4005061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section) 4006061576a5SJed Brown { 4007061576a5SJed Brown PetscErrorCode ierr; 4008061576a5SJed Brown 4009061576a5SJed Brown PetscFunctionBegin; 4010061576a5SJed Brown ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr); 4011061576a5SJed Brown PetscFunctionReturn(0); 4012061576a5SJed Brown } 4013061576a5SJed Brown 4014061576a5SJed Brown /*@ 4015061576a5SJed Brown DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM. 401688ed4aceSMatthew G Knepley 401788ed4aceSMatthew G Knepley Input Parameters: 401888ed4aceSMatthew G Knepley + dm - The DM 401988ed4aceSMatthew G Knepley - section - The PetscSection 402088ed4aceSMatthew G Knepley 402188ed4aceSMatthew G Knepley Level: intermediate 402288ed4aceSMatthew G Knepley 402388ed4aceSMatthew G Knepley Note: Any existing Section will be destroyed 402488ed4aceSMatthew G Knepley 4025061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection() 402688ed4aceSMatthew G Knepley @*/ 4027061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section) 40280adebc6cSBarry Smith { 4029c473ab19SMatthew G. Knepley PetscInt numFields = 0; 4030af122d2aSMatthew G Knepley PetscInt f; 403188ed4aceSMatthew G Knepley PetscErrorCode ierr; 403288ed4aceSMatthew G Knepley 403388ed4aceSMatthew G Knepley PetscFunctionBegin; 403488ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4035b9d85ea2SLisandro Dalcin if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 40361d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 40371bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr); 40381bb6d2a8SBarry Smith dm->localSection = section; 40391bb6d2a8SBarry Smith if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);} 4040af122d2aSMatthew G Knepley if (numFields) { 4041af122d2aSMatthew G Knepley ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr); 4042af122d2aSMatthew G Knepley for (f = 0; f < numFields; ++f) { 40430f21e855SMatthew G. Knepley PetscObject disc; 4044af122d2aSMatthew G Knepley const char *name; 4045af122d2aSMatthew G Knepley 40461bb6d2a8SBarry Smith ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr); 404744a7f3ddSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr); 40480f21e855SMatthew G. Knepley ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr); 4049af122d2aSMatthew G Knepley } 4050af122d2aSMatthew G Knepley } 4051e87a4003SBarry Smith /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */ 40521bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 405388ed4aceSMatthew G Knepley PetscFunctionReturn(0); 405488ed4aceSMatthew G Knepley } 405588ed4aceSMatthew G Knepley 40569435951eSToby Isaac /*@ 4057b7385021SStefano Zampini DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation. 40589435951eSToby Isaac 4059e228b242SToby Isaac not collective 4060e228b242SToby Isaac 40619435951eSToby Isaac Input Parameter: 40629435951eSToby Isaac . dm - The DM 40639435951eSToby Isaac 40649435951eSToby Isaac Output Parameter: 40659435951eSToby Isaac + section - The PetscSection describing the range of the constraint matrix: relates rows of the constraint matrix to dofs of the default section. Returns NULL if there are no local constraints. 40669435951eSToby Isaac - mat - The Mat that interpolates local constraints: its width should be the layout size of the default section. Returns NULL if there are no local constraints. 40679435951eSToby Isaac 40689435951eSToby Isaac Level: advanced 40699435951eSToby Isaac 40709435951eSToby Isaac Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat. 40719435951eSToby Isaac 40729435951eSToby Isaac .seealso: DMSetDefaultConstraints() 40739435951eSToby Isaac @*/ 40749435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat) 40759435951eSToby Isaac { 40769435951eSToby Isaac PetscErrorCode ierr; 40779435951eSToby Isaac 40789435951eSToby Isaac PetscFunctionBegin; 40799435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 40809435951eSToby Isaac if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);} 408145a75d81SToby Isaac if (section) {*section = dm->defaultConstraintSection;} 408245a75d81SToby Isaac if (mat) {*mat = dm->defaultConstraintMat;} 40839435951eSToby Isaac PetscFunctionReturn(0); 40849435951eSToby Isaac } 40859435951eSToby Isaac 40869435951eSToby Isaac /*@ 4087b7385021SStefano Zampini DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation. 40889435951eSToby Isaac 40899435951eSToby Isaac If a constraint matrix is specified, then it is applied during DMGlobalToLocalEnd() when mode is INSERT_VALUES, INSERT_BC_VALUES, or INSERT_ALL_VALUES. Without a constraint matrix, the local vector l returned by DMGlobalToLocalEnd() contains values that have been scattered from a global vector without modification; with a constraint matrix A, l is modified by computing c = A * l, l[s[i]] = c[i], where the scatter s is defined by the PetscSection returned by DMGetDefaultConstraintMatrix(). 40909435951eSToby Isaac 40919435951eSToby Isaac If a constraint matrix is specified, then its adjoint is applied during DMLocalToGlobalBegin() when mode is ADD_VALUES, ADD_BC_VALUES, or ADD_ALL_VALUES. Without a constraint matrix, the local vector l is accumulated into a global vector without modification; with a constraint matrix A, l is first modified by computing c[i] = l[s[i]], l[s[i]] = 0, l = l + A'*c, which is the adjoint of the operation described above. 40929435951eSToby Isaac 4093e228b242SToby Isaac collective on dm 4094e228b242SToby Isaac 40959435951eSToby Isaac Input Parameters: 40969435951eSToby Isaac + dm - The DM 4097e228b242SToby Isaac + section - The PetscSection describing the range of the constraint matrix: relates rows of the constraint matrix to dofs of the default section. Must have a local communicator (PETSC_COMM_SELF or derivative). 4098e228b242SToby Isaac - mat - The Mat that interpolates local constraints: its width should be the layout size of the default section: NULL indicates no constraints. Must have a local communicator (PETSC_COMM_SELF or derivative). 40999435951eSToby Isaac 41009435951eSToby Isaac Level: advanced 41019435951eSToby Isaac 41029435951eSToby Isaac Note: This increments the references of the PetscSection and the Mat, so they user can destroy them 41039435951eSToby Isaac 41049435951eSToby Isaac .seealso: DMGetDefaultConstraints() 41059435951eSToby Isaac @*/ 41069435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat) 41079435951eSToby Isaac { 4108e228b242SToby Isaac PetscMPIInt result; 41099435951eSToby Isaac PetscErrorCode ierr; 41109435951eSToby Isaac 41119435951eSToby Isaac PetscFunctionBegin; 41129435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4113e228b242SToby Isaac if (section) { 4114e228b242SToby Isaac PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 4115e228b242SToby Isaac ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRQ(ierr); 4116f60917d2SBarry Smith if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator"); 4117e228b242SToby Isaac } 4118e228b242SToby Isaac if (mat) { 4119e228b242SToby Isaac PetscValidHeaderSpecific(mat,MAT_CLASSID,3); 4120e228b242SToby Isaac ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRQ(ierr); 4121f60917d2SBarry Smith if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator"); 4122e228b242SToby Isaac } 41239435951eSToby Isaac ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 41249435951eSToby Isaac ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr); 41259435951eSToby Isaac dm->defaultConstraintSection = section; 41269435951eSToby Isaac ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr); 41279435951eSToby Isaac ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr); 41289435951eSToby Isaac dm->defaultConstraintMat = mat; 41299435951eSToby Isaac PetscFunctionReturn(0); 41309435951eSToby Isaac } 41319435951eSToby Isaac 4132497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 4133507e4973SMatthew G. Knepley /* 4134507e4973SMatthew G. Knepley DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections. 4135507e4973SMatthew G. Knepley 4136507e4973SMatthew G. Knepley Input Parameters: 4137507e4973SMatthew G. Knepley + dm - The DM 4138507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout 4139507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout 4140507e4973SMatthew G. Knepley 4141507e4973SMatthew G. Knepley Level: intermediate 4142507e4973SMatthew G. Knepley 41431bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF() 4144507e4973SMatthew G. Knepley */ 4145f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection) 4146507e4973SMatthew G. Knepley { 4147507e4973SMatthew G. Knepley MPI_Comm comm; 4148507e4973SMatthew G. Knepley PetscLayout layout; 4149507e4973SMatthew G. Knepley const PetscInt *ranges; 4150507e4973SMatthew G. Knepley PetscInt pStart, pEnd, p, nroots; 4151507e4973SMatthew G. Knepley PetscMPIInt size, rank; 4152507e4973SMatthew G. Knepley PetscBool valid = PETSC_TRUE, gvalid; 4153507e4973SMatthew G. Knepley PetscErrorCode ierr; 4154507e4973SMatthew G. Knepley 4155507e4973SMatthew G. Knepley PetscFunctionBegin; 4156507e4973SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr); 4157507e4973SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4158507e4973SMatthew G. Knepley ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 4159507e4973SMatthew G. Knepley ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 4160507e4973SMatthew G. Knepley ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr); 4161507e4973SMatthew G. Knepley ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr); 4162507e4973SMatthew G. Knepley ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr); 4163507e4973SMatthew G. Knepley ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr); 4164507e4973SMatthew G. Knepley ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr); 4165507e4973SMatthew G. Knepley ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr); 4166507e4973SMatthew G. Knepley ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr); 4167507e4973SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 4168f741bcd2SMatthew G. Knepley PetscInt dof, cdof, off, gdof, gcdof, goff, gsize, d; 4169507e4973SMatthew G. Knepley 4170507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr); 4171507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr); 4172507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr); 4173507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 4174507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 4175507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr); 4176507e4973SMatthew G. Knepley if (!gdof) continue; /* Censored point */ 4177507e4973SMatthew G. Knepley if ((gdof < 0 ? -(gdof+1) : gdof) != dof) {ierr = PetscSynchronizedPrintf(comm, "[%d]Global dof %d for point %d not equal to local dof %d\n", rank, gdof, p, dof);CHKERRQ(ierr); valid = PETSC_FALSE;} 4178507e4973SMatthew G. Knepley if (gcdof && (gcdof != cdof)) {ierr = PetscSynchronizedPrintf(comm, "[%d]Global constraints %d for point %d not equal to local constraints %d\n", rank, gcdof, p, cdof);CHKERRQ(ierr); valid = PETSC_FALSE;} 4179507e4973SMatthew G. Knepley if (gdof < 0) { 4180507e4973SMatthew G. Knepley gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 4181507e4973SMatthew G. Knepley for (d = 0; d < gsize; ++d) { 4182507e4973SMatthew G. Knepley PetscInt offset = -(goff+1) + d, r; 4183507e4973SMatthew G. Knepley 4184507e4973SMatthew G. Knepley ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr); 4185507e4973SMatthew G. Knepley if (r < 0) r = -(r+2); 4186507e4973SMatthew G. Knepley if ((r < 0) || (r >= size)) {ierr = PetscSynchronizedPrintf(comm, "[%d]Point %d mapped to invalid process %d (%d, %d)\n", rank, p, r, gdof, goff);CHKERRQ(ierr); valid = PETSC_FALSE;break;} 4187507e4973SMatthew G. Knepley } 4188507e4973SMatthew G. Knepley } 4189507e4973SMatthew G. Knepley } 4190507e4973SMatthew G. Knepley ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr); 4191507e4973SMatthew G. Knepley ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr); 4192b2566f29SBarry Smith ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr); 4193507e4973SMatthew G. Knepley if (!gvalid) { 4194507e4973SMatthew G. Knepley ierr = DMView(dm, NULL);CHKERRQ(ierr); 4195507e4973SMatthew G. Knepley SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections"); 4196507e4973SMatthew G. Knepley } 4197507e4973SMatthew G. Knepley PetscFunctionReturn(0); 4198507e4973SMatthew G. Knepley } 4199f741bcd2SMatthew G. Knepley #endif 4200507e4973SMatthew G. Knepley 420188ed4aceSMatthew G Knepley /*@ 4202e87a4003SBarry Smith DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM. 420388ed4aceSMatthew G Knepley 4204d083f849SBarry Smith Collective on dm 42058b1ab98fSJed Brown 420688ed4aceSMatthew G Knepley Input Parameter: 420788ed4aceSMatthew G Knepley . dm - The DM 420888ed4aceSMatthew G Knepley 420988ed4aceSMatthew G Knepley Output Parameter: 421088ed4aceSMatthew G Knepley . section - The PetscSection 421188ed4aceSMatthew G Knepley 421288ed4aceSMatthew G Knepley Level: intermediate 421388ed4aceSMatthew G Knepley 421488ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 421588ed4aceSMatthew G Knepley 421692fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection() 421788ed4aceSMatthew G Knepley @*/ 4218e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section) 42190adebc6cSBarry Smith { 422088ed4aceSMatthew G Knepley PetscErrorCode ierr; 422188ed4aceSMatthew G Knepley 422288ed4aceSMatthew G Knepley PetscFunctionBegin; 422388ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 422488ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 42251bb6d2a8SBarry Smith if (!dm->globalSection) { 4226fd59a867SMatthew G. Knepley PetscSection s; 4227fd59a867SMatthew G. Knepley 422892fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 4229fd59a867SMatthew G. Knepley if (!s) SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection"); 423033907cc2SStefano Zampini if (!dm->sf) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection"); 42311bb6d2a8SBarry Smith ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr); 4232cf06b437SMatthew G. Knepley ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr); 42331bb6d2a8SBarry Smith ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr); 42341bb6d2a8SBarry Smith ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr); 423588ed4aceSMatthew G Knepley } 42361bb6d2a8SBarry Smith *section = dm->globalSection; 423788ed4aceSMatthew G Knepley PetscFunctionReturn(0); 423888ed4aceSMatthew G Knepley } 423988ed4aceSMatthew G Knepley 4240b21d0597SMatthew G Knepley /*@ 4241e87a4003SBarry Smith DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM. 4242b21d0597SMatthew G Knepley 4243b21d0597SMatthew G Knepley Input Parameters: 4244b21d0597SMatthew G Knepley + dm - The DM 42455080bbdbSMatthew G Knepley - section - The PetscSection, or NULL 4246b21d0597SMatthew G Knepley 4247b21d0597SMatthew G Knepley Level: intermediate 4248b21d0597SMatthew G Knepley 4249b21d0597SMatthew G Knepley Note: Any existing Section will be destroyed 4250b21d0597SMatthew G Knepley 425192fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection() 4252b21d0597SMatthew G Knepley @*/ 4253e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section) 42540adebc6cSBarry Smith { 4255b21d0597SMatthew G Knepley PetscErrorCode ierr; 4256b21d0597SMatthew G Knepley 4257b21d0597SMatthew G Knepley PetscFunctionBegin; 4258b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 42595080bbdbSMatthew G Knepley if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 42601d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 42611bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 42621bb6d2a8SBarry Smith dm->globalSection = section; 4263497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 42641bb6d2a8SBarry Smith if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);} 4265507e4973SMatthew G. Knepley #endif 4266b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4267b21d0597SMatthew G Knepley } 4268b21d0597SMatthew G Knepley 426988ed4aceSMatthew G Knepley /*@ 42701bb6d2a8SBarry Smith DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set, 427188ed4aceSMatthew G Knepley it is created from the default PetscSection layouts in the DM. 427288ed4aceSMatthew G Knepley 427388ed4aceSMatthew G Knepley Input Parameter: 427488ed4aceSMatthew G Knepley . dm - The DM 427588ed4aceSMatthew G Knepley 427688ed4aceSMatthew G Knepley Output Parameter: 427788ed4aceSMatthew G Knepley . sf - The PetscSF 427888ed4aceSMatthew G Knepley 427988ed4aceSMatthew G Knepley Level: intermediate 428088ed4aceSMatthew G Knepley 428188ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 428288ed4aceSMatthew G Knepley 42831bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF() 428488ed4aceSMatthew G Knepley @*/ 42851bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf) 42860adebc6cSBarry Smith { 428788ed4aceSMatthew G Knepley PetscInt nroots; 428888ed4aceSMatthew G Knepley PetscErrorCode ierr; 428988ed4aceSMatthew G Knepley 429088ed4aceSMatthew G Knepley PetscFunctionBegin; 429188ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 429288ed4aceSMatthew G Knepley PetscValidPointer(sf, 2); 42931bb6d2a8SBarry Smith if (!dm->sectionSF) { 42941bb6d2a8SBarry Smith ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr); 429533907cc2SStefano Zampini } 42961bb6d2a8SBarry Smith ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr); 429788ed4aceSMatthew G Knepley if (nroots < 0) { 429888ed4aceSMatthew G Knepley PetscSection section, gSection; 429988ed4aceSMatthew G Knepley 430092fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 430131ea6d37SMatthew G Knepley if (section) { 4302e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr); 43031bb6d2a8SBarry Smith ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr); 430431ea6d37SMatthew G Knepley } else { 43050298fd71SBarry Smith *sf = NULL; 430631ea6d37SMatthew G Knepley PetscFunctionReturn(0); 430731ea6d37SMatthew G Knepley } 430888ed4aceSMatthew G Knepley } 43091bb6d2a8SBarry Smith *sf = dm->sectionSF; 431088ed4aceSMatthew G Knepley PetscFunctionReturn(0); 431188ed4aceSMatthew G Knepley } 431288ed4aceSMatthew G Knepley 431388ed4aceSMatthew G Knepley /*@ 43141bb6d2a8SBarry Smith DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM 431588ed4aceSMatthew G Knepley 431688ed4aceSMatthew G Knepley Input Parameters: 431788ed4aceSMatthew G Knepley + dm - The DM 431888ed4aceSMatthew G Knepley - sf - The PetscSF 431988ed4aceSMatthew G Knepley 432088ed4aceSMatthew G Knepley Level: intermediate 432188ed4aceSMatthew G Knepley 432288ed4aceSMatthew G Knepley Note: Any previous SF is destroyed 432388ed4aceSMatthew G Knepley 43241bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF() 432588ed4aceSMatthew G Knepley @*/ 43261bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf) 43270adebc6cSBarry Smith { 432888ed4aceSMatthew G Knepley PetscErrorCode ierr; 432988ed4aceSMatthew G Knepley 433088ed4aceSMatthew G Knepley PetscFunctionBegin; 433188ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4332b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 433333907cc2SStefano Zampini ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 43341bb6d2a8SBarry Smith ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr); 43351bb6d2a8SBarry Smith dm->sectionSF = sf; 433688ed4aceSMatthew G Knepley PetscFunctionReturn(0); 433788ed4aceSMatthew G Knepley } 433888ed4aceSMatthew G Knepley 433988ed4aceSMatthew G Knepley /*@C 43401bb6d2a8SBarry Smith DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections 434188ed4aceSMatthew G Knepley describing the data layout. 434288ed4aceSMatthew G Knepley 434388ed4aceSMatthew G Knepley Input Parameters: 434488ed4aceSMatthew G Knepley + dm - The DM 434588ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout 434688ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout 434788ed4aceSMatthew G Knepley 43481bb6d2a8SBarry Smith Notes: One usually uses DMGetSectionSF() to obtain the PetscSF 434988ed4aceSMatthew G Knepley 43501bb6d2a8SBarry Smith Level: developer 43511bb6d2a8SBarry Smith 43521bb6d2a8SBarry Smith Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF 43531bb6d2a8SBarry Smith directly into the DM, perhaps this function should not take the local and global sections as 43541bb6d2a8SBarry Smith input and should just obtain them from the DM? 43551bb6d2a8SBarry Smith 43561bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection() 435788ed4aceSMatthew G Knepley @*/ 43581bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection) 435988ed4aceSMatthew G Knepley { 436082f516ccSBarry Smith MPI_Comm comm; 436188ed4aceSMatthew G Knepley PetscLayout layout; 436288ed4aceSMatthew G Knepley const PetscInt *ranges; 436388ed4aceSMatthew G Knepley PetscInt *local; 436488ed4aceSMatthew G Knepley PetscSFNode *remote; 4365ecd73843SMatthew G. Knepley PetscInt pStart, pEnd, p, nroots, nleaves = 0, l; 436688ed4aceSMatthew G Knepley PetscMPIInt size, rank; 436788ed4aceSMatthew G Knepley PetscErrorCode ierr; 436888ed4aceSMatthew G Knepley 436988ed4aceSMatthew G Knepley PetscFunctionBegin; 437088ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4371367003a6SStefano Zampini ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr); 437288ed4aceSMatthew G Knepley ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 437388ed4aceSMatthew G Knepley ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 437488ed4aceSMatthew G Knepley ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr); 437588ed4aceSMatthew G Knepley ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr); 437688ed4aceSMatthew G Knepley ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr); 437788ed4aceSMatthew G Knepley ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr); 437888ed4aceSMatthew G Knepley ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr); 437988ed4aceSMatthew G Knepley ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr); 438088ed4aceSMatthew G Knepley ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr); 4381ecd73843SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 43826636e97aSMatthew G Knepley PetscInt gdof, gcdof; 438388ed4aceSMatthew G Knepley 43846636e97aSMatthew G Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 43856636e97aSMatthew G Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 4386235fbf56SMatthew G. Knepley if (gcdof > (gdof < 0 ? -(gdof+1) : gdof)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Point %d has %d constraints > %d dof", p, gcdof, (gdof < 0 ? -(gdof+1) : gdof)); 43876636e97aSMatthew G Knepley nleaves += gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 438888ed4aceSMatthew G Knepley } 4389785e854fSJed Brown ierr = PetscMalloc1(nleaves, &local);CHKERRQ(ierr); 4390785e854fSJed Brown ierr = PetscMalloc1(nleaves, &remote);CHKERRQ(ierr); 439188ed4aceSMatthew G Knepley for (p = pStart, l = 0; p < pEnd; ++p) { 43921f588964SMatthew G Knepley const PetscInt *cind; 43936636e97aSMatthew G Knepley PetscInt dof, cdof, off, gdof, gcdof, goff, gsize, d, c; 439488ed4aceSMatthew G Knepley 439588ed4aceSMatthew G Knepley ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr); 439688ed4aceSMatthew G Knepley ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr); 439788ed4aceSMatthew G Knepley ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr); 439888ed4aceSMatthew G Knepley ierr = PetscSectionGetConstraintIndices(localSection, p, &cind);CHKERRQ(ierr); 439988ed4aceSMatthew G Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 44006636e97aSMatthew G Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 440188ed4aceSMatthew G Knepley ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr); 44026636e97aSMatthew G Knepley if (!gdof) continue; /* Censored point */ 44036636e97aSMatthew G Knepley gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 44046636e97aSMatthew G Knepley if (gsize != dof-cdof) { 4405057b4bcdSMatthew G Knepley if (gsize != dof) SETERRQ4(comm, PETSC_ERR_ARG_WRONG, "Global dof %d for point %d is neither the constrained size %d, nor the unconstrained %d", gsize, p, dof-cdof, dof); 44066636e97aSMatthew G Knepley cdof = 0; /* Ignore constraints */ 44076636e97aSMatthew G Knepley } 440888ed4aceSMatthew G Knepley for (d = 0, c = 0; d < dof; ++d) { 440988ed4aceSMatthew G Knepley if ((c < cdof) && (cind[c] == d)) {++c; continue;} 441088ed4aceSMatthew G Knepley local[l+d-c] = off+d; 441188ed4aceSMatthew G Knepley } 441288ed4aceSMatthew G Knepley if (gdof < 0) { 44136636e97aSMatthew G Knepley for (d = 0; d < gsize; ++d, ++l) { 441488ed4aceSMatthew G Knepley PetscInt offset = -(goff+1) + d, r; 441588ed4aceSMatthew G Knepley 441605376888SMatthew G. Knepley ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr); 441731d3f06eSJed Brown if (r < 0) r = -(r+2); 441805376888SMatthew G. Knepley if ((r < 0) || (r >= size)) SETERRQ4(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Point %d mapped to invalid process %d (%d, %d)", p, r, gdof, goff); 441988ed4aceSMatthew G Knepley remote[l].rank = r; 442088ed4aceSMatthew G Knepley remote[l].index = offset - ranges[r]; 442188ed4aceSMatthew G Knepley } 442288ed4aceSMatthew G Knepley } else { 44236636e97aSMatthew G Knepley for (d = 0; d < gsize; ++d, ++l) { 442488ed4aceSMatthew G Knepley remote[l].rank = rank; 442588ed4aceSMatthew G Knepley remote[l].index = goff+d - ranges[rank]; 442688ed4aceSMatthew G Knepley } 442788ed4aceSMatthew G Knepley } 442888ed4aceSMatthew G Knepley } 44296636e97aSMatthew G Knepley if (l != nleaves) SETERRQ2(comm, PETSC_ERR_PLIB, "Iteration error, l %d != nleaves %d", l, nleaves); 443088ed4aceSMatthew G Knepley ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr); 44311bb6d2a8SBarry Smith ierr = PetscSFSetGraph(dm->sectionSF, nroots, nleaves, local, PETSC_OWN_POINTER, remote, PETSC_OWN_POINTER);CHKERRQ(ierr); 443288ed4aceSMatthew G Knepley PetscFunctionReturn(0); 443388ed4aceSMatthew G Knepley } 4434af122d2aSMatthew G Knepley 4435b21d0597SMatthew G Knepley /*@ 4436b21d0597SMatthew G Knepley DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM. 4437b21d0597SMatthew G Knepley 4438b21d0597SMatthew G Knepley Input Parameter: 4439b21d0597SMatthew G Knepley . dm - The DM 4440b21d0597SMatthew G Knepley 4441b21d0597SMatthew G Knepley Output Parameter: 4442b21d0597SMatthew G Knepley . sf - The PetscSF 4443b21d0597SMatthew G Knepley 4444b21d0597SMatthew G Knepley Level: intermediate 4445b21d0597SMatthew G Knepley 4446b21d0597SMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 4447b21d0597SMatthew G Knepley 44481bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4449b21d0597SMatthew G Knepley @*/ 44500adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf) 44510adebc6cSBarry Smith { 4452b21d0597SMatthew G Knepley PetscFunctionBegin; 4453b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4454b21d0597SMatthew G Knepley PetscValidPointer(sf, 2); 4455b21d0597SMatthew G Knepley *sf = dm->sf; 4456b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4457b21d0597SMatthew G Knepley } 4458b21d0597SMatthew G Knepley 4459057b4bcdSMatthew G Knepley /*@ 4460057b4bcdSMatthew G Knepley DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM. 4461057b4bcdSMatthew G Knepley 4462057b4bcdSMatthew G Knepley Input Parameters: 4463057b4bcdSMatthew G Knepley + dm - The DM 4464057b4bcdSMatthew G Knepley - sf - The PetscSF 4465057b4bcdSMatthew G Knepley 4466057b4bcdSMatthew G Knepley Level: intermediate 4467057b4bcdSMatthew G Knepley 44681bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4469057b4bcdSMatthew G Knepley @*/ 44700adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf) 44710adebc6cSBarry Smith { 4472057b4bcdSMatthew G Knepley PetscErrorCode ierr; 4473057b4bcdSMatthew G Knepley 4474057b4bcdSMatthew G Knepley PetscFunctionBegin; 4475057b4bcdSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4476b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 4477057b4bcdSMatthew G Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 447833907cc2SStefano Zampini ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr); 4479057b4bcdSMatthew G Knepley dm->sf = sf; 4480057b4bcdSMatthew G Knepley PetscFunctionReturn(0); 4481057b4bcdSMatthew G Knepley } 4482057b4bcdSMatthew G Knepley 448334aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc) 448434aa8a36SMatthew G. Knepley { 448534aa8a36SMatthew G. Knepley PetscClassId id; 448634aa8a36SMatthew G. Knepley PetscErrorCode ierr; 448734aa8a36SMatthew G. Knepley 448834aa8a36SMatthew G. Knepley PetscFunctionBegin; 448934aa8a36SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 449034aa8a36SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 449134aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 449234aa8a36SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 449334aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr); 449417c1d62eSMatthew G. Knepley } else { 449517c1d62eSMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 449634aa8a36SMatthew G. Knepley } 449734aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 449834aa8a36SMatthew G. Knepley } 449934aa8a36SMatthew G. Knepley 450044a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew) 450144a7f3ddSMatthew G. Knepley { 450244a7f3ddSMatthew G. Knepley RegionField *tmpr; 450344a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf, f; 450444a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 450544a7f3ddSMatthew G. Knepley 450644a7f3ddSMatthew G. Knepley PetscFunctionBegin; 450744a7f3ddSMatthew G. Knepley if (Nf >= NfNew) PetscFunctionReturn(0); 450844a7f3ddSMatthew G. Knepley ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr); 450944a7f3ddSMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f]; 451044a7f3ddSMatthew G. Knepley for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL;} 451144a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 451244a7f3ddSMatthew G. Knepley dm->Nf = NfNew; 451344a7f3ddSMatthew G. Knepley dm->fields = tmpr; 451444a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 451544a7f3ddSMatthew G. Knepley } 451644a7f3ddSMatthew G. Knepley 451744a7f3ddSMatthew G. Knepley /*@ 451844a7f3ddSMatthew G. Knepley DMClearFields - Remove all fields from the DM 451944a7f3ddSMatthew G. Knepley 4520d083f849SBarry Smith Logically collective on dm 452144a7f3ddSMatthew G. Knepley 452244a7f3ddSMatthew G. Knepley Input Parameter: 452344a7f3ddSMatthew G. Knepley . dm - The DM 452444a7f3ddSMatthew G. Knepley 452544a7f3ddSMatthew G. Knepley Level: intermediate 452644a7f3ddSMatthew G. Knepley 452744a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField() 452844a7f3ddSMatthew G. Knepley @*/ 452944a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm) 453044a7f3ddSMatthew G. Knepley { 453144a7f3ddSMatthew G. Knepley PetscInt f; 453244a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 453344a7f3ddSMatthew G. Knepley 453444a7f3ddSMatthew G. Knepley PetscFunctionBegin; 453544a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 453644a7f3ddSMatthew G. Knepley for (f = 0; f < dm->Nf; ++f) { 453744a7f3ddSMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 453844a7f3ddSMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 453944a7f3ddSMatthew G. Knepley } 454044a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 454144a7f3ddSMatthew G. Knepley dm->fields = NULL; 454244a7f3ddSMatthew G. Knepley dm->Nf = 0; 454344a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 454444a7f3ddSMatthew G. Knepley } 454544a7f3ddSMatthew G. Knepley 4546689b5837SMatthew G. Knepley /*@ 4547689b5837SMatthew G. Knepley DMGetNumFields - Get the number of fields in the DM 4548689b5837SMatthew G. Knepley 4549689b5837SMatthew G. Knepley Not collective 4550689b5837SMatthew G. Knepley 4551689b5837SMatthew G. Knepley Input Parameter: 4552689b5837SMatthew G. Knepley . dm - The DM 4553689b5837SMatthew G. Knepley 4554689b5837SMatthew G. Knepley Output Parameter: 4555689b5837SMatthew G. Knepley . Nf - The number of fields 4556689b5837SMatthew G. Knepley 4557689b5837SMatthew G. Knepley Level: intermediate 4558689b5837SMatthew G. Knepley 4559689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField() 4560689b5837SMatthew G. Knepley @*/ 45610f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields) 45620f21e855SMatthew G. Knepley { 45630f21e855SMatthew G. Knepley PetscFunctionBegin; 45640f21e855SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4565534a8f05SLisandro Dalcin PetscValidIntPointer(numFields, 2); 456644a7f3ddSMatthew G. Knepley *numFields = dm->Nf; 4567af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4568af122d2aSMatthew G Knepley } 4569af122d2aSMatthew G Knepley 4570689b5837SMatthew G. Knepley /*@ 4571689b5837SMatthew G. Knepley DMSetNumFields - Set the number of fields in the DM 4572689b5837SMatthew G. Knepley 4573d083f849SBarry Smith Logically collective on dm 4574689b5837SMatthew G. Knepley 4575689b5837SMatthew G. Knepley Input Parameters: 4576689b5837SMatthew G. Knepley + dm - The DM 4577689b5837SMatthew G. Knepley - Nf - The number of fields 4578689b5837SMatthew G. Knepley 4579689b5837SMatthew G. Knepley Level: intermediate 4580689b5837SMatthew G. Knepley 4581689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField() 4582689b5837SMatthew G. Knepley @*/ 4583af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields) 4584af122d2aSMatthew G Knepley { 45850f21e855SMatthew G. Knepley PetscInt Nf, f; 4586af122d2aSMatthew G Knepley PetscErrorCode ierr; 4587af122d2aSMatthew G Knepley 4588af122d2aSMatthew G Knepley PetscFunctionBegin; 4589af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 459044a7f3ddSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 45910f21e855SMatthew G. Knepley for (f = Nf; f < numFields; ++f) { 45920f21e855SMatthew G. Knepley PetscContainer obj; 45930f21e855SMatthew G. Knepley 45940f21e855SMatthew G. Knepley ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr); 459544a7f3ddSMatthew G. Knepley ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr); 45960f21e855SMatthew G. Knepley ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr); 4597af122d2aSMatthew G Knepley } 4598af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4599af122d2aSMatthew G Knepley } 4600af122d2aSMatthew G Knepley 4601c1929be8SMatthew G. Knepley /*@ 4602c1929be8SMatthew G. Knepley DMGetField - Return the discretization object for a given DM field 4603c1929be8SMatthew G. Knepley 4604c1929be8SMatthew G. Knepley Not collective 4605c1929be8SMatthew G. Knepley 4606c1929be8SMatthew G. Knepley Input Parameters: 4607c1929be8SMatthew G. Knepley + dm - The DM 4608c1929be8SMatthew G. Knepley - f - The field number 4609c1929be8SMatthew G. Knepley 461044a7f3ddSMatthew G. Knepley Output Parameters: 461144a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh 461244a7f3ddSMatthew G. Knepley - field - The discretization object 4613c1929be8SMatthew G. Knepley 461444a7f3ddSMatthew G. Knepley Level: intermediate 4615c1929be8SMatthew G. Knepley 461644a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField() 4617c1929be8SMatthew G. Knepley @*/ 461844a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field) 4619af122d2aSMatthew G Knepley { 4620af122d2aSMatthew G Knepley PetscFunctionBegin; 4621af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 462244a7f3ddSMatthew G. Knepley PetscValidPointer(field, 3); 462344a7f3ddSMatthew G. Knepley if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf); 462444a7f3ddSMatthew G. Knepley if (label) *label = dm->fields[f].label; 462544a7f3ddSMatthew G. Knepley if (field) *field = dm->fields[f].disc; 4626decb47aaSMatthew G. Knepley PetscFunctionReturn(0); 4627decb47aaSMatthew G. Knepley } 4628decb47aaSMatthew G. Knepley 4629c1929be8SMatthew G. Knepley /*@ 4630c1929be8SMatthew G. Knepley DMSetField - Set the discretization object for a given DM field 4631c1929be8SMatthew G. Knepley 4632d083f849SBarry Smith Logically collective on dm 4633c1929be8SMatthew G. Knepley 4634c1929be8SMatthew G. Knepley Input Parameters: 4635c1929be8SMatthew G. Knepley + dm - The DM 4636c1929be8SMatthew G. Knepley . f - The field number 463744a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 4638c1929be8SMatthew G. Knepley - field - The discretization object 4639c1929be8SMatthew G. Knepley 464044a7f3ddSMatthew G. Knepley Level: intermediate 4641c1929be8SMatthew G. Knepley 464244a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField() 4643c1929be8SMatthew G. Knepley @*/ 464444a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field) 4645decb47aaSMatthew G. Knepley { 4646decb47aaSMatthew G. Knepley PetscErrorCode ierr; 4647decb47aaSMatthew G. Knepley 4648decb47aaSMatthew G. Knepley PetscFunctionBegin; 4649decb47aaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4650e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3); 465144a7f3ddSMatthew G. Knepley PetscValidHeader(field, 4); 4652e5e52638SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 465344a7f3ddSMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr); 465444a7f3ddSMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 465544a7f3ddSMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 465644a7f3ddSMatthew G. Knepley dm->fields[f].label = label; 465744a7f3ddSMatthew G. Knepley dm->fields[f].disc = field; 465844a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 465944a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 466034aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr); 46612df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 466244a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 466344a7f3ddSMatthew G. Knepley } 466444a7f3ddSMatthew G. Knepley 466544a7f3ddSMatthew G. Knepley /*@ 466644a7f3ddSMatthew G. Knepley DMAddField - Add the discretization object for the given DM field 466744a7f3ddSMatthew G. Knepley 4668d083f849SBarry Smith Logically collective on dm 466944a7f3ddSMatthew G. Knepley 467044a7f3ddSMatthew G. Knepley Input Parameters: 467144a7f3ddSMatthew G. Knepley + dm - The DM 467244a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 467344a7f3ddSMatthew G. Knepley - field - The discretization object 467444a7f3ddSMatthew G. Knepley 467544a7f3ddSMatthew G. Knepley Level: intermediate 467644a7f3ddSMatthew G. Knepley 467744a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField() 467844a7f3ddSMatthew G. Knepley @*/ 467944a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field) 468044a7f3ddSMatthew G. Knepley { 468144a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf; 468244a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 468344a7f3ddSMatthew G. Knepley 468444a7f3ddSMatthew G. Knepley PetscFunctionBegin; 468544a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 468644a7f3ddSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3); 468744a7f3ddSMatthew G. Knepley PetscValidHeader(field, 3); 468844a7f3ddSMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr); 468944a7f3ddSMatthew G. Knepley dm->fields[Nf].label = label; 469044a7f3ddSMatthew G. Knepley dm->fields[Nf].disc = field; 469144a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 469244a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 469334aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr); 46942df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 4695af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4696af122d2aSMatthew G Knepley } 46976636e97aSMatthew G Knepley 4698e5e52638SMatthew G. Knepley /*@ 4699e5e52638SMatthew G. Knepley DMCopyFields - Copy the discretizations for the DM into another DM 4700e5e52638SMatthew G. Knepley 4701d083f849SBarry Smith Collective on dm 4702e5e52638SMatthew G. Knepley 4703e5e52638SMatthew G. Knepley Input Parameter: 4704e5e52638SMatthew G. Knepley . dm - The DM 4705e5e52638SMatthew G. Knepley 4706e5e52638SMatthew G. Knepley Output Parameter: 4707e5e52638SMatthew G. Knepley . newdm - The DM 4708e5e52638SMatthew G. Knepley 4709e5e52638SMatthew G. Knepley Level: advanced 4710e5e52638SMatthew G. Knepley 4711e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS() 4712e5e52638SMatthew G. Knepley @*/ 4713e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm) 4714e5e52638SMatthew G. Knepley { 4715e5e52638SMatthew G. Knepley PetscInt Nf, f; 4716e5e52638SMatthew G. Knepley PetscErrorCode ierr; 4717e5e52638SMatthew G. Knepley 4718e5e52638SMatthew G. Knepley PetscFunctionBegin; 4719e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 4720e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 4721e5e52638SMatthew G. Knepley ierr = DMClearFields(newdm);CHKERRQ(ierr); 4722e5e52638SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 4723e5e52638SMatthew G. Knepley DMLabel label; 4724e5e52638SMatthew G. Knepley PetscObject field; 472534aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 4726e5e52638SMatthew G. Knepley 4727e5e52638SMatthew G. Knepley ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr); 4728e5e52638SMatthew G. Knepley ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr); 472934aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr); 473034aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr); 473134aa8a36SMatthew G. Knepley } 473234aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 473334aa8a36SMatthew G. Knepley } 473434aa8a36SMatthew G. Knepley 473534aa8a36SMatthew G. Knepley /*@ 473634aa8a36SMatthew G. Knepley DMGetAdjacency - Returns the flags for determining variable influence 473734aa8a36SMatthew G. Knepley 473834aa8a36SMatthew G. Knepley Not collective 473934aa8a36SMatthew G. Knepley 474034aa8a36SMatthew G. Knepley Input Parameters: 474134aa8a36SMatthew G. Knepley + dm - The DM object 474234aa8a36SMatthew G. Knepley - f - The field number, or PETSC_DEFAULT for the default adjacency 474334aa8a36SMatthew G. Knepley 474434aa8a36SMatthew G. Knepley Output Parameter: 474534aa8a36SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 474634aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 474734aa8a36SMatthew G. Knepley 474834aa8a36SMatthew G. Knepley Notes: 474934aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 475034aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 475134aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 4752979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 475334aa8a36SMatthew G. Knepley 475434aa8a36SMatthew G. Knepley Level: developer 475534aa8a36SMatthew G. Knepley 475634aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField() 475734aa8a36SMatthew G. Knepley @*/ 475834aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure) 475934aa8a36SMatthew G. Knepley { 476034aa8a36SMatthew G. Knepley PetscFunctionBegin; 476134aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4762534a8f05SLisandro Dalcin if (useCone) PetscValidBoolPointer(useCone, 3); 4763534a8f05SLisandro Dalcin if (useClosure) PetscValidBoolPointer(useClosure, 4); 476434aa8a36SMatthew G. Knepley if (f < 0) { 476534aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->adjacency[0]; 476634aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->adjacency[1]; 476734aa8a36SMatthew G. Knepley } else { 476834aa8a36SMatthew G. Knepley PetscInt Nf; 476934aa8a36SMatthew G. Knepley PetscErrorCode ierr; 477034aa8a36SMatthew G. Knepley 477134aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 477234aa8a36SMatthew G. Knepley if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 477334aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->fields[f].adjacency[0]; 477434aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->fields[f].adjacency[1]; 477534aa8a36SMatthew G. Knepley } 477634aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 477734aa8a36SMatthew G. Knepley } 477834aa8a36SMatthew G. Knepley 477934aa8a36SMatthew G. Knepley /*@ 478034aa8a36SMatthew G. Knepley DMSetAdjacency - Set the flags for determining variable influence 478134aa8a36SMatthew G. Knepley 478234aa8a36SMatthew G. Knepley Not collective 478334aa8a36SMatthew G. Knepley 478434aa8a36SMatthew G. Knepley Input Parameters: 478534aa8a36SMatthew G. Knepley + dm - The DM object 478634aa8a36SMatthew G. Knepley . f - The field number 478734aa8a36SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 478834aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 478934aa8a36SMatthew G. Knepley 479034aa8a36SMatthew G. Knepley Notes: 479134aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 479234aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 479334aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 4794979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 479534aa8a36SMatthew G. Knepley 479634aa8a36SMatthew G. Knepley Level: developer 479734aa8a36SMatthew G. Knepley 479834aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField() 479934aa8a36SMatthew G. Knepley @*/ 480034aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure) 480134aa8a36SMatthew G. Knepley { 480234aa8a36SMatthew G. Knepley PetscFunctionBegin; 480334aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 480434aa8a36SMatthew G. Knepley if (f < 0) { 480534aa8a36SMatthew G. Knepley dm->adjacency[0] = useCone; 480634aa8a36SMatthew G. Knepley dm->adjacency[1] = useClosure; 480734aa8a36SMatthew G. Knepley } else { 480834aa8a36SMatthew G. Knepley PetscInt Nf; 480934aa8a36SMatthew G. Knepley PetscErrorCode ierr; 481034aa8a36SMatthew G. Knepley 481134aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 481234aa8a36SMatthew G. Knepley if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 481334aa8a36SMatthew G. Knepley dm->fields[f].adjacency[0] = useCone; 481434aa8a36SMatthew G. Knepley dm->fields[f].adjacency[1] = useClosure; 4815e5e52638SMatthew G. Knepley } 4816e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 4817e5e52638SMatthew G. Knepley } 4818e5e52638SMatthew G. Knepley 4819b0441da4SMatthew G. Knepley /*@ 4820b0441da4SMatthew G. Knepley DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined 4821b0441da4SMatthew G. Knepley 4822b0441da4SMatthew G. Knepley Not collective 4823b0441da4SMatthew G. Knepley 4824b0441da4SMatthew G. Knepley Input Parameters: 4825b0441da4SMatthew G. Knepley . dm - The DM object 4826b0441da4SMatthew G. Knepley 4827b0441da4SMatthew G. Knepley Output Parameter: 4828b0441da4SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 4829b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 4830b0441da4SMatthew G. Knepley 4831b0441da4SMatthew G. Knepley Notes: 4832b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 4833b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 4834b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 4835b0441da4SMatthew G. Knepley 4836b0441da4SMatthew G. Knepley Level: developer 4837b0441da4SMatthew G. Knepley 4838b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField() 4839b0441da4SMatthew G. Knepley @*/ 4840b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure) 4841b0441da4SMatthew G. Knepley { 4842b0441da4SMatthew G. Knepley PetscInt Nf; 4843b0441da4SMatthew G. Knepley PetscErrorCode ierr; 4844b0441da4SMatthew G. Knepley 4845b0441da4SMatthew G. Knepley PetscFunctionBegin; 4846b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4847534a8f05SLisandro Dalcin if (useCone) PetscValidBoolPointer(useCone, 3); 4848534a8f05SLisandro Dalcin if (useClosure) PetscValidBoolPointer(useClosure, 4); 4849b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 4850b0441da4SMatthew G. Knepley if (!Nf) { 4851b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 4852b0441da4SMatthew G. Knepley } else { 4853b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 4854b0441da4SMatthew G. Knepley } 4855b0441da4SMatthew G. Knepley PetscFunctionReturn(0); 4856b0441da4SMatthew G. Knepley } 4857b0441da4SMatthew G. Knepley 4858b0441da4SMatthew G. Knepley /*@ 4859b0441da4SMatthew G. Knepley DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined 4860b0441da4SMatthew G. Knepley 4861b0441da4SMatthew G. Knepley Not collective 4862b0441da4SMatthew G. Knepley 4863b0441da4SMatthew G. Knepley Input Parameters: 4864b0441da4SMatthew G. Knepley + dm - The DM object 4865b0441da4SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 4866b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 4867b0441da4SMatthew G. Knepley 4868b0441da4SMatthew G. Knepley Notes: 4869b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 4870b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 4871b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 4872b0441da4SMatthew G. Knepley 4873b0441da4SMatthew G. Knepley Level: developer 4874b0441da4SMatthew G. Knepley 4875b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField() 4876b0441da4SMatthew G. Knepley @*/ 4877b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure) 4878b0441da4SMatthew G. Knepley { 4879b0441da4SMatthew G. Knepley PetscInt Nf; 4880b0441da4SMatthew G. Knepley PetscErrorCode ierr; 4881b0441da4SMatthew G. Knepley 4882b0441da4SMatthew G. Knepley PetscFunctionBegin; 4883b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4884b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 4885b0441da4SMatthew G. Knepley if (!Nf) { 4886b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 4887b0441da4SMatthew G. Knepley } else { 4888b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 4889e5e52638SMatthew G. Knepley } 4890e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 4891e5e52638SMatthew G. Knepley } 4892e5e52638SMatthew G. Knepley 4893e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew) 4894e5e52638SMatthew G. Knepley { 4895e5e52638SMatthew G. Knepley DMSpace *tmpd; 4896e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 4897e5e52638SMatthew G. Knepley PetscErrorCode ierr; 4898e5e52638SMatthew G. Knepley 4899e5e52638SMatthew G. Knepley PetscFunctionBegin; 4900e5e52638SMatthew G. Knepley if (Nds >= NdsNew) PetscFunctionReturn(0); 4901e5e52638SMatthew G. Knepley ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr); 4902e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s]; 4903b3cf3223SMatthew G. Knepley for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;} 4904e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 4905e5e52638SMatthew G. Knepley dm->Nds = NdsNew; 4906e5e52638SMatthew G. Knepley dm->probs = tmpd; 4907e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 4908e5e52638SMatthew G. Knepley } 4909e5e52638SMatthew G. Knepley 4910e5e52638SMatthew G. Knepley /*@ 4911e5e52638SMatthew G. Knepley DMGetNumDS - Get the number of discrete systems in the DM 4912e5e52638SMatthew G. Knepley 4913e5e52638SMatthew G. Knepley Not collective 4914e5e52638SMatthew G. Knepley 4915e5e52638SMatthew G. Knepley Input Parameter: 4916e5e52638SMatthew G. Knepley . dm - The DM 4917e5e52638SMatthew G. Knepley 4918e5e52638SMatthew G. Knepley Output Parameter: 4919e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects 4920e5e52638SMatthew G. Knepley 4921e5e52638SMatthew G. Knepley Level: intermediate 4922e5e52638SMatthew G. Knepley 4923e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS() 4924e5e52638SMatthew G. Knepley @*/ 4925e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds) 4926e5e52638SMatthew G. Knepley { 4927e5e52638SMatthew G. Knepley PetscFunctionBegin; 4928e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4929534a8f05SLisandro Dalcin PetscValidIntPointer(Nds, 2); 4930e5e52638SMatthew G. Knepley *Nds = dm->Nds; 4931e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 4932e5e52638SMatthew G. Knepley } 4933e5e52638SMatthew G. Knepley 4934e5e52638SMatthew G. Knepley /*@ 4935e5e52638SMatthew G. Knepley DMClearDS - Remove all discrete systems from the DM 4936e5e52638SMatthew G. Knepley 4937d083f849SBarry Smith Logically collective on dm 4938e5e52638SMatthew G. Knepley 4939e5e52638SMatthew G. Knepley Input Parameter: 4940e5e52638SMatthew G. Knepley . dm - The DM 4941e5e52638SMatthew G. Knepley 4942e5e52638SMatthew G. Knepley Level: intermediate 4943e5e52638SMatthew G. Knepley 4944e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField() 4945e5e52638SMatthew G. Knepley @*/ 4946e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm) 4947e5e52638SMatthew G. Knepley { 4948e5e52638SMatthew G. Knepley PetscInt s; 4949e5e52638SMatthew G. Knepley PetscErrorCode ierr; 4950e5e52638SMatthew G. Knepley 4951e5e52638SMatthew G. Knepley PetscFunctionBegin; 4952e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4953e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 4954e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 4955e5e52638SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr); 4956b3cf3223SMatthew G. Knepley ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr); 4957e5e52638SMatthew G. Knepley } 4958e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 4959e5e52638SMatthew G. Knepley dm->probs = NULL; 4960e5e52638SMatthew G. Knepley dm->Nds = 0; 4961e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 4962e5e52638SMatthew G. Knepley } 4963e5e52638SMatthew G. Knepley 4964e5e52638SMatthew G. Knepley /*@ 4965e5e52638SMatthew G. Knepley DMGetDS - Get the default PetscDS 4966e5e52638SMatthew G. Knepley 4967e5e52638SMatthew G. Knepley Not collective 4968e5e52638SMatthew G. Knepley 4969e5e52638SMatthew G. Knepley Input Parameter: 4970e5e52638SMatthew G. Knepley . dm - The DM 4971e5e52638SMatthew G. Knepley 4972e5e52638SMatthew G. Knepley Output Parameter: 4973e5e52638SMatthew G. Knepley . prob - The default PetscDS 4974e5e52638SMatthew G. Knepley 4975e5e52638SMatthew G. Knepley Level: intermediate 4976e5e52638SMatthew G. Knepley 4977e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS() 4978e5e52638SMatthew G. Knepley @*/ 4979e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob) 4980e5e52638SMatthew G. Knepley { 4981b0143b4dSMatthew G. Knepley PetscErrorCode ierr; 4982b0143b4dSMatthew G. Knepley 4983e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 4984e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4985e5e52638SMatthew G. Knepley PetscValidPointer(prob, 2); 4986b0143b4dSMatthew G. Knepley if (dm->Nds <= 0) { 4987b0143b4dSMatthew G. Knepley PetscDS ds; 4988b0143b4dSMatthew G. Knepley 4989b0143b4dSMatthew G. Knepley ierr = PetscDSCreate(PetscObjectComm((PetscObject) dm), &ds);CHKERRQ(ierr); 4990b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr); 4991b0143b4dSMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 4992b0143b4dSMatthew G. Knepley } 4993b0143b4dSMatthew G. Knepley *prob = dm->probs[0].ds; 4994e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 4995e5e52638SMatthew G. Knepley } 4996e5e52638SMatthew G. Knepley 4997e5e52638SMatthew G. Knepley /*@ 4998e5e52638SMatthew G. Knepley DMGetCellDS - Get the PetscDS defined on a given cell 4999e5e52638SMatthew G. Knepley 5000e5e52638SMatthew G. Knepley Not collective 5001e5e52638SMatthew G. Knepley 5002e5e52638SMatthew G. Knepley Input Parameters: 5003e5e52638SMatthew G. Knepley + dm - The DM 5004e5e52638SMatthew G. Knepley - point - Cell for the DS 5005e5e52638SMatthew G. Knepley 5006e5e52638SMatthew G. Knepley Output Parameter: 5007e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell 5008e5e52638SMatthew G. Knepley 5009e5e52638SMatthew G. Knepley Level: developer 5010e5e52638SMatthew G. Knepley 5011b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS() 5012e5e52638SMatthew G. Knepley @*/ 5013e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob) 5014e5e52638SMatthew G. Knepley { 5015e5e52638SMatthew G. Knepley PetscDS probDef = NULL; 5016e5e52638SMatthew G. Knepley PetscInt s; 5017e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5018e5e52638SMatthew G. Knepley 5019e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5020e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5021e5e52638SMatthew G. Knepley PetscValidPointer(prob, 3); 5022e5e52638SMatthew G. Knepley *prob = NULL; 5023e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5024e5e52638SMatthew G. Knepley PetscInt val; 5025e5e52638SMatthew G. Knepley 5026e5e52638SMatthew G. Knepley if (!dm->probs[s].label) {probDef = dm->probs[s].ds;} 5027e5e52638SMatthew G. Knepley else { 5028e5e52638SMatthew G. Knepley ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr); 5029e5e52638SMatthew G. Knepley if (val >= 0) {*prob = dm->probs[s].ds; break;} 5030e5e52638SMatthew G. Knepley } 5031e5e52638SMatthew G. Knepley } 5032e5e52638SMatthew G. Knepley if (!*prob) *prob = probDef; 5033e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5034e5e52638SMatthew G. Knepley } 5035e5e52638SMatthew G. Knepley 5036e5e52638SMatthew G. Knepley /*@ 5037e5e52638SMatthew G. Knepley DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel 5038e5e52638SMatthew G. Knepley 5039e5e52638SMatthew G. Knepley Not collective 5040e5e52638SMatthew G. Knepley 5041e5e52638SMatthew G. Knepley Input Parameters: 5042e5e52638SMatthew G. Knepley + dm - The DM 5043e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh 5044e5e52638SMatthew G. Knepley 5045b3cf3223SMatthew G. Knepley Output Parameters: 5046b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5047b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL 5048e5e52638SMatthew G. Knepley 5049e5e52638SMatthew G. Knepley Note: If the label is missing, this function returns an error 5050e5e52638SMatthew G. Knepley 5051e5e52638SMatthew G. Knepley Level: advanced 5052e5e52638SMatthew G. Knepley 5053e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5054e5e52638SMatthew G. Knepley @*/ 5055b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds) 5056e5e52638SMatthew G. Knepley { 5057e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5058e5e52638SMatthew G. Knepley 5059e5e52638SMatthew G. Knepley PetscFunctionBegin; 5060e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5061e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5062b3cf3223SMatthew G. Knepley if (fields) {PetscValidPointer(fields, 3); *fields = NULL;} 5063b3cf3223SMatthew G. Knepley if (ds) {PetscValidPointer(ds, 4); *ds = NULL;} 5064e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5065b3cf3223SMatthew G. Knepley if (dm->probs[s].label == label) { 5066b3cf3223SMatthew G. Knepley if (fields) *fields = dm->probs[s].fields; 5067b3cf3223SMatthew G. Knepley if (ds) *ds = dm->probs[s].ds; 5068b3cf3223SMatthew G. Knepley PetscFunctionReturn(0); 5069b3cf3223SMatthew G. Knepley } 5070e5e52638SMatthew G. Knepley } 50712df9ee95SMatthew G. Knepley PetscFunctionReturn(0); 5072e5e52638SMatthew G. Knepley } 5073e5e52638SMatthew G. Knepley 5074e5e52638SMatthew G. Knepley /*@ 5075e5e52638SMatthew G. Knepley DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number 5076e5e52638SMatthew G. Knepley 5077e5e52638SMatthew G. Knepley Not collective 5078e5e52638SMatthew G. Knepley 5079e5e52638SMatthew G. Knepley Input Parameters: 5080e5e52638SMatthew G. Knepley + dm - The DM 5081e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds) 5082e5e52638SMatthew G. Knepley 5083e5e52638SMatthew G. Knepley Output Parameters: 5084b3cf3223SMatthew G. Knepley + label - The region label, or NULL 5085b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5086b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL 5087e5e52638SMatthew G. Knepley 5088e5e52638SMatthew G. Knepley Level: advanced 5089e5e52638SMatthew G. Knepley 5090e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5091e5e52638SMatthew G. Knepley @*/ 5092b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds) 5093e5e52638SMatthew G. Knepley { 5094e5e52638SMatthew G. Knepley PetscInt Nds; 5095e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5096e5e52638SMatthew G. Knepley 5097e5e52638SMatthew G. Knepley PetscFunctionBegin; 5098e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5099e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 5100e5e52638SMatthew G. Knepley if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5101e5e52638SMatthew G. Knepley if (label) { 5102e5e52638SMatthew G. Knepley PetscValidPointer(label, 3); 5103e5e52638SMatthew G. Knepley *label = dm->probs[num].label; 5104e5e52638SMatthew G. Knepley } 5105b3cf3223SMatthew G. Knepley if (fields) { 5106b3cf3223SMatthew G. Knepley PetscValidPointer(fields, 4); 5107b3cf3223SMatthew G. Knepley *fields = dm->probs[num].fields; 5108b3cf3223SMatthew G. Knepley } 5109e5e52638SMatthew G. Knepley if (ds) { 5110b3cf3223SMatthew G. Knepley PetscValidPointer(ds, 5); 5111e5e52638SMatthew G. Knepley *ds = dm->probs[num].ds; 5112e5e52638SMatthew G. Knepley } 5113e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5114e5e52638SMatthew G. Knepley } 5115e5e52638SMatthew G. Knepley 5116e5e52638SMatthew G. Knepley /*@ 5117e5e52638SMatthew G. Knepley DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel 5118e5e52638SMatthew G. Knepley 5119d083f849SBarry Smith Collective on dm 5120e5e52638SMatthew G. Knepley 5121e5e52638SMatthew G. Knepley Input Parameters: 5122e5e52638SMatthew G. Knepley + dm - The DM 5123e5e52638SMatthew G. Knepley . label - The DMLabel defining the mesh region, or NULL for the entire mesh 5124b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields 5125e5e52638SMatthew G. Knepley - prob - The PetscDS defined on the given cell 5126e5e52638SMatthew G. Knepley 5127b3cf3223SMatthew G. Knepley Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. If DS is replaced, 5128b3cf3223SMatthew G. Knepley the fields argument is ignored. 5129e5e52638SMatthew G. Knepley 5130e5e52638SMatthew G. Knepley Level: advanced 5131e5e52638SMatthew G. Knepley 5132e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMGetDS(), DMGetCellDS() 5133e5e52638SMatthew G. Knepley @*/ 5134b3cf3223SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds) 5135e5e52638SMatthew G. Knepley { 5136e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5137e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5138e5e52638SMatthew G. Knepley 5139e5e52638SMatthew G. Knepley PetscFunctionBegin; 5140e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5141e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5142e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 3); 5143e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5144e5e52638SMatthew G. Knepley if (dm->probs[s].label == label) { 5145b3cf3223SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5146e5e52638SMatthew G. Knepley dm->probs[s].ds = ds; 5147e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5148e5e52638SMatthew G. Knepley } 5149e5e52638SMatthew G. Knepley } 51501b5e6740SSatish Balay ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr); 5151e5e52638SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5152b3cf3223SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5153e5e52638SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5154e5e52638SMatthew G. Knepley if (!label) { 5155e5e52638SMatthew G. Knepley /* Put the NULL label at the front, so it is returned as the default */ 5156e5e52638SMatthew G. Knepley for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s]; 5157e5e52638SMatthew G. Knepley Nds = 0; 5158e5e52638SMatthew G. Knepley } 5159e5e52638SMatthew G. Knepley dm->probs[Nds].label = label; 5160b3cf3223SMatthew G. Knepley dm->probs[Nds].fields = fields; 5161e5e52638SMatthew G. Knepley dm->probs[Nds].ds = ds; 5162e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5163e5e52638SMatthew G. Knepley } 5164e5e52638SMatthew G. Knepley 5165e5e52638SMatthew G. Knepley /*@ 5166e5e52638SMatthew G. Knepley DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM 5167e5e52638SMatthew G. Knepley 5168d083f849SBarry Smith Collective on dm 5169e5e52638SMatthew G. Knepley 5170e5e52638SMatthew G. Knepley Input Parameter: 5171e5e52638SMatthew G. Knepley . dm - The DM 5172e5e52638SMatthew G. Knepley 5173e5e52638SMatthew G. Knepley Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. 5174e5e52638SMatthew G. Knepley 5175e5e52638SMatthew G. Knepley Level: intermediate 5176e5e52638SMatthew G. Knepley 5177e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 5178e5e52638SMatthew G. Knepley @*/ 5179e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm) 5180e5e52638SMatthew G. Knepley { 5181e5e52638SMatthew G. Knepley MPI_Comm comm; 5182e5e52638SMatthew G. Knepley PetscDS prob, probh = NULL; 5183b3cf3223SMatthew G. Knepley PetscInt dimEmbed, Nf = dm->Nf, f, s, field = 0, fieldh = 0; 5184e5e52638SMatthew G. Knepley PetscBool doSetup = PETSC_TRUE; 5185e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5186e5e52638SMatthew G. Knepley 5187e5e52638SMatthew G. Knepley PetscFunctionBegin; 5188e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5189e5e52638SMatthew G. Knepley if (!dm->fields) PetscFunctionReturn(0); 5190e5e52638SMatthew G. Knepley /* Can only handle two label cases right now: 5191e5e52638SMatthew G. Knepley 1) NULL 5192e5e52638SMatthew G. Knepley 2) Hybrid cells 5193e5e52638SMatthew G. Knepley */ 5194e5e52638SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr); 5195e5e52638SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dimEmbed);CHKERRQ(ierr); 5196e5e52638SMatthew G. Knepley /* Create default DS */ 5197b3cf3223SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &prob);CHKERRQ(ierr); 51982df9ee95SMatthew G. Knepley if (!prob) { 5199b3cf3223SMatthew G. Knepley IS fields; 5200b3cf3223SMatthew G. Knepley PetscInt *fld, nf; 5201b3cf3223SMatthew G. Knepley 5202b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf; 5203b3cf3223SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5204b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f; 520588f0c812SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 520688f0c812SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 520788f0c812SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 520888f0c812SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 520988f0c812SMatthew G. Knepley 52102df9ee95SMatthew G. Knepley ierr = PetscDSCreate(comm, &prob);CHKERRQ(ierr); 5211b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, fields, prob);CHKERRQ(ierr); 52122df9ee95SMatthew G. Knepley ierr = PetscDSDestroy(&prob);CHKERRQ(ierr); 5213b3cf3223SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 5214b3cf3223SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &prob);CHKERRQ(ierr); 52152df9ee95SMatthew G. Knepley } 5216e5e52638SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(prob, dimEmbed);CHKERRQ(ierr); 5217e5e52638SMatthew G. Knepley /* Optionally create hybrid DS */ 5218b3cf3223SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5219e5e52638SMatthew G. Knepley DMLabel label = dm->fields[f].label; 5220e5e52638SMatthew G. Knepley PetscInt lStart, lEnd; 5221e5e52638SMatthew G. Knepley 5222e5e52638SMatthew G. Knepley if (label) { 52230122748bSMatthew G. Knepley DM plex; 5224a2d47024SMatthew G. Knepley IS fields; 5225a2d47024SMatthew G. Knepley PetscInt *fld; 52260122748bSMatthew G. Knepley PetscInt depth, pMax[4]; 52270122748bSMatthew G. Knepley 52280122748bSMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 52290122748bSMatthew G. Knepley ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr); 52300122748bSMatthew G. Knepley ierr = DMPlexGetHybridBounds(plex, depth >= 0 ? &pMax[depth] : NULL, depth>1 ? &pMax[depth-1] : NULL, depth>2 ? &pMax[1] : NULL, &pMax[0]);CHKERRQ(ierr); 52310122748bSMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 52320122748bSMatthew G. Knepley 5233e5e52638SMatthew G. Knepley ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr); 5234e5e52638SMatthew G. Knepley if (lStart < pMax[depth]) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Only support labels over hybrid cells right now"); 5235e5e52638SMatthew G. Knepley ierr = PetscDSCreate(comm, &probh);CHKERRQ(ierr); 5236a2d47024SMatthew G. Knepley ierr = PetscMalloc1(1, &fld);CHKERRQ(ierr); 5237a2d47024SMatthew G. Knepley fld[0] = f; 5238a2d47024SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 5239a2d47024SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 5240a2d47024SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 5241a2d47024SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, 1, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 5242a2d47024SMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, probh);CHKERRQ(ierr); 5243a2d47024SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 5244e5e52638SMatthew G. Knepley ierr = PetscDSSetHybrid(probh, PETSC_TRUE);CHKERRQ(ierr); 5245e5e52638SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(probh, dimEmbed);CHKERRQ(ierr); 5246e5e52638SMatthew G. Knepley break; 5247e5e52638SMatthew G. Knepley } 5248e5e52638SMatthew G. Knepley } 5249e5e52638SMatthew G. Knepley /* Set fields in DSes */ 5250b3cf3223SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5251e5e52638SMatthew G. Knepley DMLabel label = dm->fields[f].label; 5252e5e52638SMatthew G. Knepley PetscObject disc = dm->fields[f].disc; 5253e5e52638SMatthew G. Knepley 5254e5e52638SMatthew G. Knepley if (!label) { 5255e5e52638SMatthew G. Knepley ierr = PetscDSSetDiscretization(prob, field++, disc);CHKERRQ(ierr); 5256e5e52638SMatthew G. Knepley if (probh) { 5257e5e52638SMatthew G. Knepley PetscFE subfe; 5258e5e52638SMatthew G. Knepley 5259e5e52638SMatthew G. Knepley ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, &subfe);CHKERRQ(ierr); 5260e5e52638SMatthew G. Knepley ierr = PetscDSSetDiscretization(probh, fieldh++, (PetscObject) subfe);CHKERRQ(ierr); 5261e5e52638SMatthew G. Knepley } 5262e5e52638SMatthew G. Knepley } else { 5263e5e52638SMatthew G. Knepley ierr = PetscDSSetDiscretization(probh, fieldh++, disc);CHKERRQ(ierr); 5264e5e52638SMatthew G. Knepley } 5265e5e52638SMatthew G. Knepley /* We allow people to have placeholder fields and construct the Section by hand */ 5266e5e52638SMatthew G. Knepley { 5267e5e52638SMatthew G. Knepley PetscClassId id; 5268e5e52638SMatthew G. Knepley 5269e5e52638SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 5270e5e52638SMatthew G. Knepley if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE; 5271e5e52638SMatthew G. Knepley } 5272e5e52638SMatthew G. Knepley } 5273e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&probh);CHKERRQ(ierr); 5274e5e52638SMatthew G. Knepley /* Setup DSes */ 5275e5e52638SMatthew G. Knepley if (doSetup) { 5276e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);} 5277e5e52638SMatthew G. Knepley } 5278e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5279e5e52638SMatthew G. Knepley } 5280e5e52638SMatthew G. Knepley 5281e5e52638SMatthew G. Knepley /*@ 5282e5e52638SMatthew G. Knepley DMCopyDS - Copy the discrete systems for the DM into another DM 5283e5e52638SMatthew G. Knepley 5284d083f849SBarry Smith Collective on dm 5285e5e52638SMatthew G. Knepley 5286e5e52638SMatthew G. Knepley Input Parameter: 5287e5e52638SMatthew G. Knepley . dm - The DM 5288e5e52638SMatthew G. Knepley 5289e5e52638SMatthew G. Knepley Output Parameter: 5290e5e52638SMatthew G. Knepley . newdm - The DM 5291e5e52638SMatthew G. Knepley 5292e5e52638SMatthew G. Knepley Level: advanced 5293e5e52638SMatthew G. Knepley 5294e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 5295e5e52638SMatthew G. Knepley @*/ 5296e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm) 5297e5e52638SMatthew G. Knepley { 5298e5e52638SMatthew G. Knepley PetscInt Nds, s; 5299e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5300e5e52638SMatthew G. Knepley 5301e5e52638SMatthew G. Knepley PetscFunctionBegin; 5302e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 5303e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 5304e5e52638SMatthew G. Knepley ierr = DMClearDS(newdm);CHKERRQ(ierr); 5305e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5306e5e52638SMatthew G. Knepley DMLabel label; 5307b3cf3223SMatthew G. Knepley IS fields; 5308e5e52638SMatthew G. Knepley PetscDS ds; 5309e5e52638SMatthew G. Knepley 5310b3cf3223SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr); 5311b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(newdm, label, fields, ds);CHKERRQ(ierr); 5312e5e52638SMatthew G. Knepley } 5313e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5314e5e52638SMatthew G. Knepley } 5315e5e52638SMatthew G. Knepley 5316e5e52638SMatthew G. Knepley /*@ 5317e5e52638SMatthew G. Knepley DMCopyDisc - Copy the fields and discrete systems for the DM into another DM 5318e5e52638SMatthew G. Knepley 5319d083f849SBarry Smith Collective on dm 5320e5e52638SMatthew G. Knepley 5321e5e52638SMatthew G. Knepley Input Parameter: 5322e5e52638SMatthew G. Knepley . dm - The DM 5323e5e52638SMatthew G. Knepley 5324e5e52638SMatthew G. Knepley Output Parameter: 5325e5e52638SMatthew G. Knepley . newdm - The DM 5326e5e52638SMatthew G. Knepley 5327e5e52638SMatthew G. Knepley Level: advanced 5328e5e52638SMatthew G. Knepley 5329e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS() 5330e5e52638SMatthew G. Knepley @*/ 5331e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm) 5332e5e52638SMatthew G. Knepley { 5333e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5334e5e52638SMatthew G. Knepley 5335e5e52638SMatthew G. Knepley PetscFunctionBegin; 5336e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 5337e5e52638SMatthew G. Knepley ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr); 5338e5e52638SMatthew G. Knepley ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr); 5339e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5340e5e52638SMatthew G. Knepley } 5341e5e52638SMatthew G. Knepley 5342b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx) 5343b64e0483SPeter Brune { 5344b64e0483SPeter Brune DM dm_coord,dmc_coord; 5345b64e0483SPeter Brune PetscErrorCode ierr; 5346b64e0483SPeter Brune Vec coords,ccoords; 53476dbf9973SLawrence Mitchell Mat inject; 5348b64e0483SPeter Brune PetscFunctionBegin; 5349b64e0483SPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 5350b64e0483SPeter Brune ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr); 5351b64e0483SPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 5352b64e0483SPeter Brune ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr); 5353b64e0483SPeter Brune if (coords && !ccoords) { 5354b64e0483SPeter Brune ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr); 53556668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 53566dbf9973SLawrence Mitchell ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr); 53572adcf181SLawrence Mitchell ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr); 53586dbf9973SLawrence Mitchell ierr = MatDestroy(&inject);CHKERRQ(ierr); 5359b64e0483SPeter Brune ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr); 5360b64e0483SPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 5361b64e0483SPeter Brune } 5362b64e0483SPeter Brune PetscFunctionReturn(0); 5363b64e0483SPeter Brune } 5364b64e0483SPeter Brune 536503dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx) 536603dadc2fSPeter Brune { 536703dadc2fSPeter Brune DM dm_coord,subdm_coord; 536803dadc2fSPeter Brune PetscErrorCode ierr; 536903dadc2fSPeter Brune Vec coords,ccoords,clcoords; 537003dadc2fSPeter Brune VecScatter *scat_i,*scat_g; 537103dadc2fSPeter Brune PetscFunctionBegin; 537203dadc2fSPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 537303dadc2fSPeter Brune ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr); 537403dadc2fSPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 537503dadc2fSPeter Brune ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr); 537603dadc2fSPeter Brune if (coords && !ccoords) { 537703dadc2fSPeter Brune ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr); 53786668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 537903dadc2fSPeter Brune ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr); 538024640c55SToby Isaac ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr); 538103dadc2fSPeter Brune ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr); 538203dadc2fSPeter Brune ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 538303dadc2fSPeter Brune ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 53841ed9ada7SJunchao Zhang ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 538503dadc2fSPeter Brune ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 538603dadc2fSPeter Brune ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr); 538703dadc2fSPeter Brune ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr); 538803dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr); 538903dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr); 539003dadc2fSPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 539103dadc2fSPeter Brune ierr = VecDestroy(&clcoords);CHKERRQ(ierr); 539203dadc2fSPeter Brune ierr = PetscFree(scat_i);CHKERRQ(ierr); 539303dadc2fSPeter Brune ierr = PetscFree(scat_g);CHKERRQ(ierr); 539403dadc2fSPeter Brune } 539503dadc2fSPeter Brune PetscFunctionReturn(0); 539603dadc2fSPeter Brune } 539703dadc2fSPeter Brune 5398c73cfb54SMatthew G. Knepley /*@ 5399c73cfb54SMatthew G. Knepley DMGetDimension - Return the topological dimension of the DM 5400c73cfb54SMatthew G. Knepley 5401c73cfb54SMatthew G. Knepley Not collective 5402c73cfb54SMatthew G. Knepley 5403c73cfb54SMatthew G. Knepley Input Parameter: 5404c73cfb54SMatthew G. Knepley . dm - The DM 5405c73cfb54SMatthew G. Knepley 5406c73cfb54SMatthew G. Knepley Output Parameter: 5407c73cfb54SMatthew G. Knepley . dim - The topological dimension 5408c73cfb54SMatthew G. Knepley 5409c73cfb54SMatthew G. Knepley Level: beginner 5410c73cfb54SMatthew G. Knepley 5411c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate() 5412c73cfb54SMatthew G. Knepley @*/ 5413c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim) 5414c73cfb54SMatthew G. Knepley { 5415c73cfb54SMatthew G. Knepley PetscFunctionBegin; 5416c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5417534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 5418c73cfb54SMatthew G. Knepley *dim = dm->dim; 5419c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 5420c73cfb54SMatthew G. Knepley } 5421c73cfb54SMatthew G. Knepley 5422c73cfb54SMatthew G. Knepley /*@ 5423c73cfb54SMatthew G. Knepley DMSetDimension - Set the topological dimension of the DM 5424c73cfb54SMatthew G. Knepley 5425c73cfb54SMatthew G. Knepley Collective on dm 5426c73cfb54SMatthew G. Knepley 5427c73cfb54SMatthew G. Knepley Input Parameters: 5428c73cfb54SMatthew G. Knepley + dm - The DM 5429c73cfb54SMatthew G. Knepley - dim - The topological dimension 5430c73cfb54SMatthew G. Knepley 5431c73cfb54SMatthew G. Knepley Level: beginner 5432c73cfb54SMatthew G. Knepley 5433c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate() 5434c73cfb54SMatthew G. Knepley @*/ 5435c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim) 5436c73cfb54SMatthew G. Knepley { 5437e5e52638SMatthew G. Knepley PetscDS ds; 5438f17e8794SMatthew G. Knepley PetscErrorCode ierr; 5439f17e8794SMatthew G. Knepley 5440c73cfb54SMatthew G. Knepley PetscFunctionBegin; 5441c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5442c73cfb54SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, dim, 2); 5443c73cfb54SMatthew G. Knepley dm->dim = dim; 5444e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 5445e5e52638SMatthew G. Knepley if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dm->dim);CHKERRQ(ierr);} 5446c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 5447c73cfb54SMatthew G. Knepley } 5448c73cfb54SMatthew G. Knepley 5449793f3fe5SMatthew G. Knepley /*@ 5450793f3fe5SMatthew G. Knepley DMGetDimPoints - Get the half-open interval for all points of a given dimension 5451793f3fe5SMatthew G. Knepley 5452d083f849SBarry Smith Collective on dm 5453793f3fe5SMatthew G. Knepley 5454793f3fe5SMatthew G. Knepley Input Parameters: 5455793f3fe5SMatthew G. Knepley + dm - the DM 5456793f3fe5SMatthew G. Knepley - dim - the dimension 5457793f3fe5SMatthew G. Knepley 5458793f3fe5SMatthew G. Knepley Output Parameters: 5459793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension 5460aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension 5461793f3fe5SMatthew G. Knepley 5462793f3fe5SMatthew G. Knepley Note: 5463793f3fe5SMatthew G. Knepley The points are vertices in the Hasse diagram encoding the topology. This is explained in 5464a8d69d7bSBarry Smith https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme, 5465793f3fe5SMatthew G. Knepley then the interval is empty. 5466793f3fe5SMatthew G. Knepley 5467793f3fe5SMatthew G. Knepley Level: intermediate 5468793f3fe5SMatthew G. Knepley 5469793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum() 5470793f3fe5SMatthew G. Knepley @*/ 5471793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd) 5472793f3fe5SMatthew G. Knepley { 5473793f3fe5SMatthew G. Knepley PetscInt d; 5474793f3fe5SMatthew G. Knepley PetscErrorCode ierr; 5475793f3fe5SMatthew G. Knepley 5476793f3fe5SMatthew G. Knepley PetscFunctionBegin; 5477793f3fe5SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 5478793f3fe5SMatthew G. Knepley ierr = DMGetDimension(dm, &d);CHKERRQ(ierr); 5479793f3fe5SMatthew G. Knepley if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d); 5480b9d85ea2SLisandro Dalcin if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name); 5481793f3fe5SMatthew G. Knepley ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr); 5482793f3fe5SMatthew G. Knepley PetscFunctionReturn(0); 5483793f3fe5SMatthew G. Knepley } 5484793f3fe5SMatthew G. Knepley 54856636e97aSMatthew G Knepley /*@ 54866636e97aSMatthew G Knepley DMSetCoordinates - Sets into the DM a global vector that holds the coordinates 54876636e97aSMatthew G Knepley 5488d083f849SBarry Smith Collective on dm 54896636e97aSMatthew G Knepley 54906636e97aSMatthew G Knepley Input Parameters: 54916636e97aSMatthew G Knepley + dm - the DM 54926636e97aSMatthew G Knepley - c - coordinate vector 54936636e97aSMatthew G Knepley 54942dd40e9bSPatrick Sanan Notes: 54952dd40e9bSPatrick Sanan The coordinates do include those for ghost points, which are in the local vector. 54962dd40e9bSPatrick Sanan 54972dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 54986636e97aSMatthew G Knepley 54996636e97aSMatthew G Knepley Level: intermediate 55006636e97aSMatthew G Knepley 55012dd40e9bSPatrick Sanan .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM() 55026636e97aSMatthew G Knepley @*/ 55036636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c) 55046636e97aSMatthew G Knepley { 55056636e97aSMatthew G Knepley PetscErrorCode ierr; 55066636e97aSMatthew G Knepley 55076636e97aSMatthew G Knepley PetscFunctionBegin; 55086636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 55096636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 55106636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 55116636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 55126636e97aSMatthew G Knepley dm->coordinates = c; 55136636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 5514b64e0483SPeter Brune ierr = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 551503dadc2fSPeter Brune ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 55166636e97aSMatthew G Knepley PetscFunctionReturn(0); 55176636e97aSMatthew G Knepley } 55186636e97aSMatthew G Knepley 55196636e97aSMatthew G Knepley /*@ 55206636e97aSMatthew G Knepley DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates 55216636e97aSMatthew G Knepley 55227058e716SVaclav Hapla Not collective 55236636e97aSMatthew G Knepley 55246636e97aSMatthew G Knepley Input Parameters: 55256636e97aSMatthew G Knepley + dm - the DM 55266636e97aSMatthew G Knepley - c - coordinate vector 55276636e97aSMatthew G Knepley 55282dd40e9bSPatrick Sanan Notes: 55296636e97aSMatthew G Knepley The coordinates of ghost points can be set using DMSetCoordinates() 55306636e97aSMatthew G Knepley followed by DMGetCoordinatesLocal(). This is intended to enable the 55316636e97aSMatthew G Knepley setting of ghost coordinates outside of the domain. 55326636e97aSMatthew G Knepley 55332dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 55342dd40e9bSPatrick Sanan 55356636e97aSMatthew G Knepley Level: intermediate 55366636e97aSMatthew G Knepley 55376636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM() 55386636e97aSMatthew G Knepley @*/ 55396636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c) 55406636e97aSMatthew G Knepley { 55416636e97aSMatthew G Knepley PetscErrorCode ierr; 55426636e97aSMatthew G Knepley 55436636e97aSMatthew G Knepley PetscFunctionBegin; 55446636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 55456636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 55466636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 55476636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 55488865f1eaSKarl Rupp 55496636e97aSMatthew G Knepley dm->coordinatesLocal = c; 55508865f1eaSKarl Rupp 55516636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 55526636e97aSMatthew G Knepley PetscFunctionReturn(0); 55536636e97aSMatthew G Knepley } 55546636e97aSMatthew G Knepley 55556636e97aSMatthew G Knepley /*@ 55566636e97aSMatthew G Knepley DMGetCoordinates - Gets a global vector with the coordinates associated with the DM. 55576636e97aSMatthew G Knepley 5558d083f849SBarry Smith Collective on dm 55596636e97aSMatthew G Knepley 55606636e97aSMatthew G Knepley Input Parameter: 55616636e97aSMatthew G Knepley . dm - the DM 55626636e97aSMatthew G Knepley 55636636e97aSMatthew G Knepley Output Parameter: 55646636e97aSMatthew G Knepley . c - global coordinate vector 55656636e97aSMatthew G Knepley 55666636e97aSMatthew G Knepley Note: 55676636e97aSMatthew G Knepley This is a borrowed reference, so the user should NOT destroy this vector 55686636e97aSMatthew G Knepley 55696636e97aSMatthew G Knepley Each process has only the local coordinates (does NOT have the ghost coordinates). 55706636e97aSMatthew G Knepley 55716636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 55726636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 55736636e97aSMatthew G Knepley 55746636e97aSMatthew G Knepley Level: intermediate 55756636e97aSMatthew G Knepley 55766636e97aSMatthew G Knepley .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM() 55776636e97aSMatthew G Knepley @*/ 55786636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c) 55796636e97aSMatthew G Knepley { 55806636e97aSMatthew G Knepley PetscErrorCode ierr; 55816636e97aSMatthew G Knepley 55826636e97aSMatthew G Knepley PetscFunctionBegin; 55836636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 55846636e97aSMatthew G Knepley PetscValidPointer(c,2); 55851f588964SMatthew G Knepley if (!dm->coordinates && dm->coordinatesLocal) { 55860298fd71SBarry Smith DM cdm = NULL; 55871970a576SMatthew G. Knepley PetscBool localized; 55886636e97aSMatthew G Knepley 55896636e97aSMatthew G Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 55906636e97aSMatthew G Knepley ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr); 55911970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 55921970a576SMatthew G. Knepley /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */ 55931970a576SMatthew G. Knepley if (localized) { 55941970a576SMatthew G. Knepley PetscInt cdim; 55951970a576SMatthew G. Knepley 55961970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 55971970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 55981970a576SMatthew G. Knepley } 55996636e97aSMatthew G Knepley ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr); 56006636e97aSMatthew G Knepley ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 56016636e97aSMatthew G Knepley ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 56026636e97aSMatthew G Knepley } 56036636e97aSMatthew G Knepley *c = dm->coordinates; 56046636e97aSMatthew G Knepley PetscFunctionReturn(0); 56056636e97aSMatthew G Knepley } 56066636e97aSMatthew G Knepley 56076636e97aSMatthew G Knepley /*@ 560881e9a530SVaclav Hapla DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards. 560981e9a530SVaclav Hapla 5610d083f849SBarry Smith Collective on dm 561181e9a530SVaclav Hapla 561281e9a530SVaclav Hapla Input Parameter: 561381e9a530SVaclav Hapla . dm - the DM 561481e9a530SVaclav Hapla 561581e9a530SVaclav Hapla Level: advanced 561681e9a530SVaclav Hapla 561781e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective() 561881e9a530SVaclav Hapla @*/ 561981e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm) 562081e9a530SVaclav Hapla { 562181e9a530SVaclav Hapla PetscErrorCode ierr; 562281e9a530SVaclav Hapla 562381e9a530SVaclav Hapla PetscFunctionBegin; 562481e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 562581e9a530SVaclav Hapla if (!dm->coordinatesLocal && dm->coordinates) { 56261970a576SMatthew G. Knepley DM cdm = NULL; 56271970a576SMatthew G. Knepley PetscBool localized; 56281970a576SMatthew G. Knepley 562981e9a530SVaclav Hapla ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 563081e9a530SVaclav Hapla ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr); 56311970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 56321970a576SMatthew G. Knepley /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */ 56331970a576SMatthew G. Knepley if (localized) { 56341970a576SMatthew G. Knepley PetscInt cdim; 56351970a576SMatthew G. Knepley 56361970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 56371970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 56381970a576SMatthew G. Knepley } 563981e9a530SVaclav Hapla ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr); 564081e9a530SVaclav Hapla ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 564181e9a530SVaclav Hapla ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 564281e9a530SVaclav Hapla } 564381e9a530SVaclav Hapla PetscFunctionReturn(0); 564481e9a530SVaclav Hapla } 564581e9a530SVaclav Hapla 564681e9a530SVaclav Hapla /*@ 56476636e97aSMatthew G Knepley DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM. 56486636e97aSMatthew G Knepley 5649d083f849SBarry Smith Collective on dm 56506636e97aSMatthew G Knepley 56516636e97aSMatthew G Knepley Input Parameter: 56526636e97aSMatthew G Knepley . dm - the DM 56536636e97aSMatthew G Knepley 56546636e97aSMatthew G Knepley Output Parameter: 56556636e97aSMatthew G Knepley . c - coordinate vector 56566636e97aSMatthew G Knepley 56576636e97aSMatthew G Knepley Note: 56586636e97aSMatthew G Knepley This is a borrowed reference, so the user should NOT destroy this vector 56596636e97aSMatthew G Knepley 56606636e97aSMatthew G Knepley Each process has the local and ghost coordinates 56616636e97aSMatthew G Knepley 56626636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 56636636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 56646636e97aSMatthew G Knepley 56656636e97aSMatthew G Knepley Level: intermediate 56666636e97aSMatthew G Knepley 566781e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective() 56686636e97aSMatthew G Knepley @*/ 56696636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c) 56706636e97aSMatthew G Knepley { 56716636e97aSMatthew G Knepley PetscErrorCode ierr; 56726636e97aSMatthew G Knepley 56736636e97aSMatthew G Knepley PetscFunctionBegin; 56746636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 56756636e97aSMatthew G Knepley PetscValidPointer(c,2); 567681e9a530SVaclav Hapla ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr); 56776636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 56786636e97aSMatthew G Knepley PetscFunctionReturn(0); 56796636e97aSMatthew G Knepley } 56806636e97aSMatthew G Knepley 568181e9a530SVaclav Hapla /*@ 568281e9a530SVaclav Hapla DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called. 568381e9a530SVaclav Hapla 568481e9a530SVaclav Hapla Not collective 568581e9a530SVaclav Hapla 568681e9a530SVaclav Hapla Input Parameter: 568781e9a530SVaclav Hapla . dm - the DM 568881e9a530SVaclav Hapla 568981e9a530SVaclav Hapla Output Parameter: 569081e9a530SVaclav Hapla . c - coordinate vector 569181e9a530SVaclav Hapla 569281e9a530SVaclav Hapla Level: advanced 569381e9a530SVaclav Hapla 569481e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 569581e9a530SVaclav Hapla @*/ 569681e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c) 569781e9a530SVaclav Hapla { 569881e9a530SVaclav Hapla PetscFunctionBegin; 569981e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 570081e9a530SVaclav Hapla PetscValidPointer(c,2); 570181e9a530SVaclav Hapla if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called"); 57026636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 57036636e97aSMatthew G Knepley PetscFunctionReturn(0); 57046636e97aSMatthew G Knepley } 57056636e97aSMatthew G Knepley 57062db98f8dSVaclav Hapla /*@ 57072db98f8dSVaclav Hapla DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout. 57082db98f8dSVaclav Hapla 57092db98f8dSVaclav Hapla Not collective 57102db98f8dSVaclav Hapla 57112db98f8dSVaclav Hapla Input Parameter: 57122db98f8dSVaclav Hapla + dm - the DM 57132db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned 57142db98f8dSVaclav Hapla 57152db98f8dSVaclav Hapla Output Parameter: 57162db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates 57172db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p 57182db98f8dSVaclav Hapla 57192db98f8dSVaclav Hapla Note: 57202db98f8dSVaclav Hapla DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective. 57212db98f8dSVaclav Hapla 57222db98f8dSVaclav Hapla This creates a new vector, so the user SHOULD destroy this vector 57232db98f8dSVaclav Hapla 57242db98f8dSVaclav Hapla Each process has the local and ghost coordinates 57252db98f8dSVaclav Hapla 57262db98f8dSVaclav Hapla For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 57272db98f8dSVaclav Hapla and (x_0,y_0,z_0,x_1,y_1,z_1...) 57282db98f8dSVaclav Hapla 57292db98f8dSVaclav Hapla Level: advanced 57302db98f8dSVaclav Hapla 57312db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 57322db98f8dSVaclav Hapla @*/ 57332db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord) 57342db98f8dSVaclav Hapla { 57352db98f8dSVaclav Hapla PetscSection cs, newcs; 57362db98f8dSVaclav Hapla Vec coords; 57372db98f8dSVaclav Hapla const PetscScalar *arr; 57382db98f8dSVaclav Hapla PetscScalar *newarr=NULL; 57392db98f8dSVaclav Hapla PetscInt n; 57402db98f8dSVaclav Hapla PetscErrorCode ierr; 57412db98f8dSVaclav Hapla 57422db98f8dSVaclav Hapla PetscFunctionBegin; 57432db98f8dSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 57442db98f8dSVaclav Hapla PetscValidHeaderSpecific(p, IS_CLASSID, 2); 57452db98f8dSVaclav Hapla if (pCoordSection) PetscValidPointer(pCoordSection, 3); 57462db98f8dSVaclav Hapla if (pCoord) PetscValidPointer(pCoord, 4); 57472db98f8dSVaclav Hapla if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set"); 57481bb6d2a8SBarry Smith if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported"); 57491bb6d2a8SBarry Smith cs = dm->coordinateDM->localSection; 57502db98f8dSVaclav Hapla coords = dm->coordinatesLocal; 57512db98f8dSVaclav Hapla ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr); 57522db98f8dSVaclav Hapla ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr); 57532db98f8dSVaclav Hapla ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr); 57542db98f8dSVaclav Hapla if (pCoord) { 57552db98f8dSVaclav Hapla ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr); 57562db98f8dSVaclav Hapla /* set array in two steps to mimic PETSC_OWN_POINTER */ 57572db98f8dSVaclav Hapla ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr); 57582db98f8dSVaclav Hapla ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr); 5759ad9ac99dSVaclav Hapla } else { 5760ad9ac99dSVaclav Hapla ierr = PetscFree(newarr);CHKERRQ(ierr); 57612db98f8dSVaclav Hapla } 5762ad9ac99dSVaclav Hapla if (pCoordSection) {*pCoordSection = newcs;} 5763ad9ac99dSVaclav Hapla else {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);} 57642db98f8dSVaclav Hapla PetscFunctionReturn(0); 57652db98f8dSVaclav Hapla } 57662db98f8dSVaclav Hapla 5767f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field) 5768f19dbd58SToby Isaac { 5769f19dbd58SToby Isaac PetscErrorCode ierr; 5770f19dbd58SToby Isaac 5771f19dbd58SToby Isaac PetscFunctionBegin; 5772f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 5773f19dbd58SToby Isaac PetscValidPointer(field,2); 5774f19dbd58SToby Isaac if (!dm->coordinateField) { 5775f19dbd58SToby Isaac if (dm->ops->createcoordinatefield) { 5776f19dbd58SToby Isaac ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr); 5777f19dbd58SToby Isaac } 5778f19dbd58SToby Isaac } 5779f19dbd58SToby Isaac *field = dm->coordinateField; 5780f19dbd58SToby Isaac PetscFunctionReturn(0); 5781f19dbd58SToby Isaac } 5782f19dbd58SToby Isaac 5783f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field) 5784f19dbd58SToby Isaac { 5785f19dbd58SToby Isaac PetscErrorCode ierr; 5786f19dbd58SToby Isaac 5787f19dbd58SToby Isaac PetscFunctionBegin; 5788f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 5789f19dbd58SToby Isaac if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2); 5790c4e6da2cSBarry Smith ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr); 5791f19dbd58SToby Isaac ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr); 5792f19dbd58SToby Isaac dm->coordinateField = field; 5793f19dbd58SToby Isaac PetscFunctionReturn(0); 5794f19dbd58SToby Isaac } 5795f19dbd58SToby Isaac 57966636e97aSMatthew G Knepley /*@ 57971cfe2091SMatthew G. Knepley DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates 57986636e97aSMatthew G Knepley 5799d083f849SBarry Smith Collective on dm 58006636e97aSMatthew G Knepley 58016636e97aSMatthew G Knepley Input Parameter: 58026636e97aSMatthew G Knepley . dm - the DM 58036636e97aSMatthew G Knepley 58046636e97aSMatthew G Knepley Output Parameter: 58056636e97aSMatthew G Knepley . cdm - coordinate DM 58066636e97aSMatthew G Knepley 58076636e97aSMatthew G Knepley Level: intermediate 58086636e97aSMatthew G Knepley 58091cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 58106636e97aSMatthew G Knepley @*/ 58116636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm) 58126636e97aSMatthew G Knepley { 58136636e97aSMatthew G Knepley PetscErrorCode ierr; 58146636e97aSMatthew G Knepley 58156636e97aSMatthew G Knepley PetscFunctionBegin; 58166636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 58176636e97aSMatthew G Knepley PetscValidPointer(cdm,2); 58186636e97aSMatthew G Knepley if (!dm->coordinateDM) { 5819308f8a94SToby Isaac DM cdm; 5820308f8a94SToby Isaac 582182f516ccSBarry Smith if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM"); 5822308f8a94SToby Isaac ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr); 5823308f8a94SToby Isaac /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup 5824308f8a94SToby Isaac * until the call to CreateCoordinateDM) */ 5825308f8a94SToby Isaac ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 5826308f8a94SToby Isaac dm->coordinateDM = cdm; 58276636e97aSMatthew G Knepley } 58286636e97aSMatthew G Knepley *cdm = dm->coordinateDM; 58296636e97aSMatthew G Knepley PetscFunctionReturn(0); 58306636e97aSMatthew G Knepley } 5831e87bb0d3SMatthew G Knepley 58321cfe2091SMatthew G. Knepley /*@ 58331cfe2091SMatthew G. Knepley DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates 58341cfe2091SMatthew G. Knepley 5835d083f849SBarry Smith Logically Collective on dm 58361cfe2091SMatthew G. Knepley 58371cfe2091SMatthew G. Knepley Input Parameters: 58381cfe2091SMatthew G. Knepley + dm - the DM 58391cfe2091SMatthew G. Knepley - cdm - coordinate DM 58401cfe2091SMatthew G. Knepley 58411cfe2091SMatthew G. Knepley Level: intermediate 58421cfe2091SMatthew G. Knepley 58431cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 58441cfe2091SMatthew G. Knepley @*/ 58451cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm) 58461cfe2091SMatthew G. Knepley { 58471cfe2091SMatthew G. Knepley PetscErrorCode ierr; 58481cfe2091SMatthew G. Knepley 58491cfe2091SMatthew G. Knepley PetscFunctionBegin; 58501cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 58511cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(cdm,DM_CLASSID,2); 5852f26b38b9SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 58531cfe2091SMatthew G. Knepley ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 58541cfe2091SMatthew G. Knepley dm->coordinateDM = cdm; 58551cfe2091SMatthew G. Knepley PetscFunctionReturn(0); 58561cfe2091SMatthew G. Knepley } 58571cfe2091SMatthew G. Knepley 585846e270d4SMatthew G. Knepley /*@ 585946e270d4SMatthew G. Knepley DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values. 586046e270d4SMatthew G. Knepley 586146e270d4SMatthew G. Knepley Not Collective 586246e270d4SMatthew G. Knepley 586346e270d4SMatthew G. Knepley Input Parameter: 586446e270d4SMatthew G. Knepley . dm - The DM object 586546e270d4SMatthew G. Knepley 586646e270d4SMatthew G. Knepley Output Parameter: 586746e270d4SMatthew G. Knepley . dim - The embedding dimension 586846e270d4SMatthew G. Knepley 586946e270d4SMatthew G. Knepley Level: intermediate 587046e270d4SMatthew G. Knepley 587192fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 587246e270d4SMatthew G. Knepley @*/ 587346e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim) 587446e270d4SMatthew G. Knepley { 587546e270d4SMatthew G. Knepley PetscFunctionBegin; 587646e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5877534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 58789a9a41abSToby Isaac if (dm->dimEmbed == PETSC_DEFAULT) { 58799a9a41abSToby Isaac dm->dimEmbed = dm->dim; 58809a9a41abSToby Isaac } 588146e270d4SMatthew G. Knepley *dim = dm->dimEmbed; 588246e270d4SMatthew G. Knepley PetscFunctionReturn(0); 588346e270d4SMatthew G. Knepley } 588446e270d4SMatthew G. Knepley 588546e270d4SMatthew G. Knepley /*@ 588646e270d4SMatthew G. Knepley DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values. 588746e270d4SMatthew G. Knepley 588846e270d4SMatthew G. Knepley Not Collective 588946e270d4SMatthew G. Knepley 589046e270d4SMatthew G. Knepley Input Parameters: 589146e270d4SMatthew G. Knepley + dm - The DM object 589246e270d4SMatthew G. Knepley - dim - The embedding dimension 589346e270d4SMatthew G. Knepley 589446e270d4SMatthew G. Knepley Level: intermediate 589546e270d4SMatthew G. Knepley 589692fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 589746e270d4SMatthew G. Knepley @*/ 589846e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim) 589946e270d4SMatthew G. Knepley { 5900e5e52638SMatthew G. Knepley PetscDS ds; 5901f17e8794SMatthew G. Knepley PetscErrorCode ierr; 5902f17e8794SMatthew G. Knepley 590346e270d4SMatthew G. Knepley PetscFunctionBegin; 590446e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 590546e270d4SMatthew G. Knepley dm->dimEmbed = dim; 5906e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 5907e5e52638SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr); 590846e270d4SMatthew G. Knepley PetscFunctionReturn(0); 590946e270d4SMatthew G. Knepley } 591046e270d4SMatthew G. Knepley 5911e8abe2deSMatthew G. Knepley /*@ 5912e8abe2deSMatthew G. Knepley DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh. 5913e8abe2deSMatthew G. Knepley 5914d083f849SBarry Smith Collective on dm 5915e8abe2deSMatthew G. Knepley 5916e8abe2deSMatthew G. Knepley Input Parameter: 5917e8abe2deSMatthew G. Knepley . dm - The DM object 5918e8abe2deSMatthew G. Knepley 5919e8abe2deSMatthew G. Knepley Output Parameter: 5920e8abe2deSMatthew G. Knepley . section - The PetscSection object 5921e8abe2deSMatthew G. Knepley 5922e8abe2deSMatthew G. Knepley Level: intermediate 5923e8abe2deSMatthew G. Knepley 592492fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 5925e8abe2deSMatthew G. Knepley @*/ 5926e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section) 5927e8abe2deSMatthew G. Knepley { 5928e8abe2deSMatthew G. Knepley DM cdm; 5929e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 5930e8abe2deSMatthew G. Knepley 5931e8abe2deSMatthew G. Knepley PetscFunctionBegin; 5932e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5933e8abe2deSMatthew G. Knepley PetscValidPointer(section, 2); 5934e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 593592fd8e1eSJed Brown ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr); 5936e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 5937e8abe2deSMatthew G. Knepley } 5938e8abe2deSMatthew G. Knepley 5939e8abe2deSMatthew G. Knepley /*@ 5940e8abe2deSMatthew G. Knepley DMSetCoordinateSection - Set the layout of coordinate values over the mesh. 5941e8abe2deSMatthew G. Knepley 5942e8abe2deSMatthew G. Knepley Not Collective 5943e8abe2deSMatthew G. Knepley 5944e8abe2deSMatthew G. Knepley Input Parameters: 5945e8abe2deSMatthew G. Knepley + dm - The DM object 594646e270d4SMatthew G. Knepley . dim - The embedding dimension, or PETSC_DETERMINE 5947e8abe2deSMatthew G. Knepley - section - The PetscSection object 5948e8abe2deSMatthew G. Knepley 5949e8abe2deSMatthew G. Knepley Level: intermediate 5950e8abe2deSMatthew G. Knepley 595192fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 5952e8abe2deSMatthew G. Knepley @*/ 595346e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section) 5954e8abe2deSMatthew G. Knepley { 5955e8abe2deSMatthew G. Knepley DM cdm; 5956e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 5957e8abe2deSMatthew G. Knepley 5958e8abe2deSMatthew G. Knepley PetscFunctionBegin; 5959e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 596046e270d4SMatthew G. Knepley PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3); 5961e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 596292fd8e1eSJed Brown ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr); 596346e270d4SMatthew G. Knepley if (dim == PETSC_DETERMINE) { 59644c1069a6SMatthew G. Knepley PetscInt d = PETSC_DEFAULT; 596546e270d4SMatthew G. Knepley PetscInt pStart, pEnd, vStart, vEnd, v, dd; 596646e270d4SMatthew G. Knepley 596746e270d4SMatthew G. Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 596846e270d4SMatthew G. Knepley ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr); 596946e270d4SMatthew G. Knepley pStart = PetscMax(vStart, pStart); 597046e270d4SMatthew G. Knepley pEnd = PetscMin(vEnd, pEnd); 597146e270d4SMatthew G. Knepley for (v = pStart; v < pEnd; ++v) { 597246e270d4SMatthew G. Knepley ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr); 597346e270d4SMatthew G. Knepley if (dd) {d = dd; break;} 597446e270d4SMatthew G. Knepley } 5975ebfe4b0dSMatthew G. Knepley if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);} 597646e270d4SMatthew G. Knepley } 5977e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 5978e8abe2deSMatthew G. Knepley } 5979e8abe2deSMatthew G. Knepley 59805dc8c3f7SMatthew G. Knepley /*@C 598190b157c4SStefano Zampini DMGetPeriodicity - Get the description of mesh periodicity 59825dc8c3f7SMatthew G. Knepley 59835dc8c3f7SMatthew G. Knepley Input Parameters: 598490b157c4SStefano Zampini . dm - The DM object 598590b157c4SStefano Zampini 598690b157c4SStefano Zampini Output Parameters: 598790b157c4SStefano Zampini + per - Whether the DM is periodic or not 59885dc8c3f7SMatthew G. Knepley . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates 59895dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 59905dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 59915dc8c3f7SMatthew G. Knepley 59925dc8c3f7SMatthew G. Knepley Level: developer 59935dc8c3f7SMatthew G. Knepley 59945dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 59955dc8c3f7SMatthew G. Knepley @*/ 599690b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd) 5997c6b900c6SMatthew G. Knepley { 5998c6b900c6SMatthew G. Knepley PetscFunctionBegin; 5999c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 600090b157c4SStefano Zampini if (per) *per = dm->periodic; 6001c6b900c6SMatthew G. Knepley if (L) *L = dm->L; 6002c6b900c6SMatthew G. Knepley if (maxCell) *maxCell = dm->maxCell; 60035dc8c3f7SMatthew G. Knepley if (bd) *bd = dm->bdtype; 6004c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6005c6b900c6SMatthew G. Knepley } 6006c6b900c6SMatthew G. Knepley 60075dc8c3f7SMatthew G. Knepley /*@C 60085dc8c3f7SMatthew G. Knepley DMSetPeriodicity - Set the description of mesh periodicity 60095dc8c3f7SMatthew G. Knepley 60105dc8c3f7SMatthew G. Knepley Input Parameters: 60115dc8c3f7SMatthew G. Knepley + dm - The DM object 601290b157c4SStefano Zampini . per - Whether the DM is periodic or not. If maxCell is not provided, coordinates need to be localized 60135dc8c3f7SMatthew G. Knepley . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates 60145dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 60155dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 60165dc8c3f7SMatthew G. Knepley 60175dc8c3f7SMatthew G. Knepley Level: developer 60185dc8c3f7SMatthew G. Knepley 60195dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 60205dc8c3f7SMatthew G. Knepley @*/ 602190b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[]) 6022c6b900c6SMatthew G. Knepley { 6023c6b900c6SMatthew G. Knepley PetscInt dim, d; 6024c6b900c6SMatthew G. Knepley PetscErrorCode ierr; 6025c6b900c6SMatthew G. Knepley 6026c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6027c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 602890b157c4SStefano Zampini PetscValidLogicalCollectiveBool(dm,per,2); 602990b157c4SStefano Zampini if (maxCell) { 6030534a8f05SLisandro Dalcin PetscValidRealPointer(maxCell,3); 6031534a8f05SLisandro Dalcin PetscValidRealPointer(L,4); 603290b157c4SStefano Zampini PetscValidPointer(bd,5); 603390b157c4SStefano Zampini } 60345dc8c3f7SMatthew G. Knepley ierr = PetscFree3(dm->L,dm->maxCell,dm->bdtype);CHKERRQ(ierr); 60355dc8c3f7SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 603690b157c4SStefano Zampini if (maxCell) { 60375dc8c3f7SMatthew G. Knepley ierr = PetscMalloc3(dim,&dm->L,dim,&dm->maxCell,dim,&dm->bdtype);CHKERRQ(ierr); 60385dc8c3f7SMatthew G. Knepley for (d = 0; d < dim; ++d) {dm->L[d] = L[d]; dm->maxCell[d] = maxCell[d]; dm->bdtype[d] = bd[d];} 603990b157c4SStefano Zampini } 6040072d7d67SStefano Zampini dm->periodic = per; 6041c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6042c6b900c6SMatthew G. Knepley } 6043c6b900c6SMatthew G. Knepley 60442e17dfb7SMatthew G. Knepley /*@ 60452e17dfb7SMatthew G. Knepley DMLocalizeCoordinate - If a mesh is periodic (a torus with lengths L_i, some of which can be infinite), project the coordinate onto [0, L_i) in each dimension. 60462e17dfb7SMatthew G. Knepley 60472e17dfb7SMatthew G. Knepley Input Parameters: 60482e17dfb7SMatthew G. Knepley + dm - The DM 604965da65dcSMatthew G. Knepley . in - The input coordinate point (dim numbers) 605065da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i 60512e17dfb7SMatthew G. Knepley 60522e17dfb7SMatthew G. Knepley Output Parameter: 60532e17dfb7SMatthew G. Knepley . out - The localized coordinate point 60542e17dfb7SMatthew G. Knepley 60552e17dfb7SMatthew G. Knepley Level: developer 60562e17dfb7SMatthew G. Knepley 60572e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 60582e17dfb7SMatthew G. Knepley @*/ 605965da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[]) 60602e17dfb7SMatthew G. Knepley { 60612e17dfb7SMatthew G. Knepley PetscInt dim, d; 60622e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 60632e17dfb7SMatthew G. Knepley 60642e17dfb7SMatthew G. Knepley PetscFunctionBegin; 60652e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr); 60662e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 60672e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 60682e17dfb7SMatthew G. Knepley } else { 606965da65dcSMatthew G. Knepley if (endpoint) { 607065da65dcSMatthew G. Knepley for (d = 0; d < dim; ++d) { 6071da3333bfSMatthew G. Knepley if ((PetscAbsReal(PetscRealPart(in[d])/dm->L[d] - PetscFloorReal(PetscRealPart(in[d])/dm->L[d])) < PETSC_SMALL) && (PetscRealPart(in[d])/dm->L[d] > PETSC_SMALL)) { 6072da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1); 607365da65dcSMatthew G. Knepley } else { 6074da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 607565da65dcSMatthew G. Knepley } 607665da65dcSMatthew G. Knepley } 607765da65dcSMatthew G. Knepley } else { 60782e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 60791118d4bcSLisandro Dalcin out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 60802e17dfb7SMatthew G. Knepley } 60812e17dfb7SMatthew G. Knepley } 608265da65dcSMatthew G. Knepley } 60832e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 60842e17dfb7SMatthew G. Knepley } 60852e17dfb7SMatthew G. Knepley 60862e17dfb7SMatthew G. Knepley /* 60872e17dfb7SMatthew G. Knepley DMLocalizeCoordinate_Internal - If a mesh is periodic, and the input point is far from the anchor, pick the coordinate sheet of the torus which moves it closer. 60882e17dfb7SMatthew G. Knepley 60892e17dfb7SMatthew G. Knepley Input Parameters: 60902e17dfb7SMatthew G. Knepley + dm - The DM 60912e17dfb7SMatthew G. Knepley . dim - The spatial dimension 60922e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 60932e17dfb7SMatthew G. Knepley - in - The input coordinate point (dim numbers) 60942e17dfb7SMatthew G. Knepley 60952e17dfb7SMatthew G. Knepley Output Parameter: 60962e17dfb7SMatthew G. Knepley . out - The localized coordinate point 60972e17dfb7SMatthew G. Knepley 60982e17dfb7SMatthew G. Knepley Level: developer 60992e17dfb7SMatthew G. Knepley 61002e17dfb7SMatthew G. Knepley Note: This is meant to get a set of coordinates close to each other, as in a cell. The anchor is usually the one of the vertices on a containing cell 61012e17dfb7SMatthew G. Knepley 61022e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 61032e17dfb7SMatthew G. Knepley */ 61042e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 61052e17dfb7SMatthew G. Knepley { 61062e17dfb7SMatthew G. Knepley PetscInt d; 61072e17dfb7SMatthew G. Knepley 61082e17dfb7SMatthew G. Knepley PetscFunctionBegin; 61092e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 61102e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 61112e17dfb7SMatthew G. Knepley } else { 61122e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6113908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) { 61142e17dfb7SMatthew G. Knepley out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 61152e17dfb7SMatthew G. Knepley } else { 61162e17dfb7SMatthew G. Knepley out[d] = in[d]; 61172e17dfb7SMatthew G. Knepley } 61182e17dfb7SMatthew G. Knepley } 61192e17dfb7SMatthew G. Knepley } 61202e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 61212e17dfb7SMatthew G. Knepley } 61222e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[]) 61232e17dfb7SMatthew G. Knepley { 61242e17dfb7SMatthew G. Knepley PetscInt d; 61252e17dfb7SMatthew G. Knepley 61262e17dfb7SMatthew G. Knepley PetscFunctionBegin; 61272e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 61282e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 61292e17dfb7SMatthew G. Knepley } else { 61302e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6131908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) { 61322e17dfb7SMatthew G. Knepley out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d]; 61332e17dfb7SMatthew G. Knepley } else { 61342e17dfb7SMatthew G. Knepley out[d] = in[d]; 61352e17dfb7SMatthew G. Knepley } 61362e17dfb7SMatthew G. Knepley } 61372e17dfb7SMatthew G. Knepley } 61382e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 61392e17dfb7SMatthew G. Knepley } 61402e17dfb7SMatthew G. Knepley 61412e17dfb7SMatthew G. Knepley /* 61422e17dfb7SMatthew G. Knepley DMLocalizeAddCoordinate_Internal - If a mesh is periodic, and the input point is far from the anchor, pick the coordinate sheet of the torus which moves it closer. 61432e17dfb7SMatthew G. Knepley 61442e17dfb7SMatthew G. Knepley Input Parameters: 61452e17dfb7SMatthew G. Knepley + dm - The DM 61462e17dfb7SMatthew G. Knepley . dim - The spatial dimension 61472e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 61482e17dfb7SMatthew G. Knepley . in - The input coordinate delta (dim numbers) 61492e17dfb7SMatthew G. Knepley - out - The input coordinate point (dim numbers) 61502e17dfb7SMatthew G. Knepley 61512e17dfb7SMatthew G. Knepley Output Parameter: 61522e17dfb7SMatthew G. Knepley . out - The localized coordinate in + out 61532e17dfb7SMatthew G. Knepley 61542e17dfb7SMatthew G. Knepley Level: developer 61552e17dfb7SMatthew G. Knepley 61562e17dfb7SMatthew G. Knepley Note: This is meant to get a set of coordinates close to each other, as in a cell. The anchor is usually the one of the vertices on a containing cell 61572e17dfb7SMatthew G. Knepley 61582e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate() 61592e17dfb7SMatthew G. Knepley */ 61602e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 61612e17dfb7SMatthew G. Knepley { 61622e17dfb7SMatthew G. Knepley PetscInt d; 61632e17dfb7SMatthew G. Knepley 61642e17dfb7SMatthew G. Knepley PetscFunctionBegin; 61652e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 61662e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] += in[d]; 61672e17dfb7SMatthew G. Knepley } else { 61682e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6169908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) { 61702e17dfb7SMatthew G. Knepley out[d] += PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 61712e17dfb7SMatthew G. Knepley } else { 61722e17dfb7SMatthew G. Knepley out[d] += in[d]; 61732e17dfb7SMatthew G. Knepley } 61742e17dfb7SMatthew G. Knepley } 61752e17dfb7SMatthew G. Knepley } 61762e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 61772e17dfb7SMatthew G. Knepley } 61782e17dfb7SMatthew G. Knepley 617936447a5eSToby Isaac /*@ 61808f700142SStefano Zampini DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process 61818f700142SStefano Zampini 61828f700142SStefano Zampini Not collective 618336447a5eSToby Isaac 618436447a5eSToby Isaac Input Parameter: 618536447a5eSToby Isaac . dm - The DM 618636447a5eSToby Isaac 618736447a5eSToby Isaac Output Parameter: 618836447a5eSToby Isaac areLocalized - True if localized 618936447a5eSToby Isaac 619036447a5eSToby Isaac Level: developer 619136447a5eSToby Isaac 61928f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity() 619336447a5eSToby Isaac @*/ 61948f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized) 619536447a5eSToby Isaac { 619636447a5eSToby Isaac DM cdm; 619736447a5eSToby Isaac PetscSection coordSection; 619846a3a80fSLisandro Dalcin PetscInt cStart, cEnd, sStart, sEnd, c, dof; 619946a3a80fSLisandro Dalcin PetscBool isPlex, alreadyLocalized; 620036447a5eSToby Isaac PetscErrorCode ierr; 620136447a5eSToby Isaac 620236447a5eSToby Isaac PetscFunctionBegin; 620336447a5eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6204534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 62058b09590cSToby Isaac *areLocalized = PETSC_FALSE; 620646a3a80fSLisandro Dalcin 620736447a5eSToby Isaac /* We need some generic way of refering to cells/vertices */ 620836447a5eSToby Isaac ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 620946a3a80fSLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr); 62109f7230bfSMatthew G. Knepley if (!isPlex) PetscFunctionReturn(0); 621146a3a80fSLisandro Dalcin 62129f7230bfSMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 621346a3a80fSLisandro Dalcin ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr); 621436447a5eSToby Isaac ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr); 621536447a5eSToby Isaac alreadyLocalized = PETSC_FALSE; 621646a3a80fSLisandro Dalcin for (c = cStart; c < cEnd; ++c) { 621746a3a80fSLisandro Dalcin if (c < sStart || c >= sEnd) continue; 621836447a5eSToby Isaac ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr); 621946a3a80fSLisandro Dalcin if (dof) { alreadyLocalized = PETSC_TRUE; break; } 622036447a5eSToby Isaac } 62218f700142SStefano Zampini *areLocalized = alreadyLocalized; 622236447a5eSToby Isaac PetscFunctionReturn(0); 622336447a5eSToby Isaac } 622436447a5eSToby Isaac 62258f700142SStefano Zampini /*@ 62268f700142SStefano Zampini DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells 62278f700142SStefano Zampini 62288f700142SStefano Zampini Collective on dm 62298f700142SStefano Zampini 62308f700142SStefano Zampini Input Parameter: 62318f700142SStefano Zampini . dm - The DM 62328f700142SStefano Zampini 62338f700142SStefano Zampini Output Parameter: 62348f700142SStefano Zampini areLocalized - True if localized 62358f700142SStefano Zampini 62368f700142SStefano Zampini Level: developer 62378f700142SStefano Zampini 62388f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal() 62398f700142SStefano Zampini @*/ 62408f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized) 62418f700142SStefano Zampini { 62428f700142SStefano Zampini PetscBool localized; 62438f700142SStefano Zampini PetscErrorCode ierr; 62448f700142SStefano Zampini 62458f700142SStefano Zampini PetscFunctionBegin; 62468f700142SStefano Zampini PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6247534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 62488f700142SStefano Zampini ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr); 62498f700142SStefano Zampini ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 62508f700142SStefano Zampini PetscFunctionReturn(0); 62518f700142SStefano Zampini } 625236447a5eSToby Isaac 62532e17dfb7SMatthew G. Knepley /*@ 6254492b8470SStefano Zampini DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces 62552e17dfb7SMatthew G. Knepley 62568f700142SStefano Zampini Collective on dm 62578f700142SStefano Zampini 62582e17dfb7SMatthew G. Knepley Input Parameter: 62592e17dfb7SMatthew G. Knepley . dm - The DM 62602e17dfb7SMatthew G. Knepley 62612e17dfb7SMatthew G. Knepley Level: developer 62622e17dfb7SMatthew G. Knepley 62638f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate() 62642e17dfb7SMatthew G. Knepley @*/ 62652e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm) 62662e17dfb7SMatthew G. Knepley { 62672e17dfb7SMatthew G. Knepley DM cdm; 62682e17dfb7SMatthew G. Knepley PetscSection coordSection, cSection; 62692e17dfb7SMatthew G. Knepley Vec coordinates, cVec; 62703e922f36SToby Isaac PetscScalar *coords, *coords2, *anchor, *localized; 62713e922f36SToby Isaac PetscInt Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize; 6272e0ae35bbSToby Isaac PetscBool alreadyLocalized, alreadyLocalizedGlobal; 62733e922f36SToby Isaac PetscInt maxHeight = 0, h; 62743e922f36SToby Isaac PetscInt *pStart = NULL, *pEnd = NULL; 62752e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 62762e17dfb7SMatthew G. Knepley 62772e17dfb7SMatthew G. Knepley PetscFunctionBegin; 62782e17dfb7SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 627992c9c85fSStefano Zampini if (!dm->periodic) PetscFunctionReturn(0); 6280f7cbd40bSStefano Zampini ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr); 6281f7cbd40bSStefano Zampini if (alreadyLocalized) PetscFunctionReturn(0); 6282f7cbd40bSStefano Zampini 62832e17dfb7SMatthew G. Knepley /* We need some generic way of refering to cells/vertices */ 62842e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 62852e17dfb7SMatthew G. Knepley { 62862e17dfb7SMatthew G. Knepley PetscBool isplex; 62872e17dfb7SMatthew G. Knepley 62882e17dfb7SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr); 62892e17dfb7SMatthew G. Knepley if (isplex) { 62902e17dfb7SMatthew G. Knepley ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr); 62913e922f36SToby Isaac ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr); 629269291d52SBarry Smith ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 62933e922f36SToby Isaac pEnd = &pStart[maxHeight + 1]; 62943e922f36SToby Isaac newStart = vStart; 62953e922f36SToby Isaac newEnd = vEnd; 62963e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 62973e922f36SToby Isaac ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr); 62983e922f36SToby Isaac newStart = PetscMin(newStart,pStart[h]); 62993e922f36SToby Isaac newEnd = PetscMax(newEnd,pEnd[h]); 63003e922f36SToby Isaac } 63012e17dfb7SMatthew G. Knepley } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM"); 63022e17dfb7SMatthew G. Knepley } 63032e17dfb7SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr); 630443eeeb2dSStefano Zampini if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector"); 63052e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 63063e922f36SToby Isaac ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr); 6307e0ae35bbSToby Isaac ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr); 63083e922f36SToby Isaac 63092e17dfb7SMatthew G. Knepley ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr); 63102e17dfb7SMatthew G. Knepley ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr); 63112e17dfb7SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr); 63122e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr); 63133e922f36SToby Isaac ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr); 63143e922f36SToby Isaac 631569291d52SBarry Smith ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 63163e922f36SToby Isaac localized = &anchor[bs]; 63173e922f36SToby Isaac alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE; 63183e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 63193e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 63203e922f36SToby Isaac 63213e922f36SToby Isaac for (c = cStart; c < cEnd; ++c) { 63223e922f36SToby Isaac PetscScalar *cellCoords = NULL; 63233e922f36SToby Isaac PetscInt b; 63243e922f36SToby Isaac 63253e922f36SToby Isaac if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE; 63263e922f36SToby Isaac ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 63273e922f36SToby Isaac for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 63283e922f36SToby Isaac for (d = 0; d < dof/bs; ++d) { 63293e922f36SToby Isaac ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr); 63303e922f36SToby Isaac for (b = 0; b < bs; b++) { 63313e922f36SToby Isaac if (cellCoords[d*bs + b] != localized[b]) break; 63323e922f36SToby Isaac } 63333e922f36SToby Isaac if (b < bs) break; 63343e922f36SToby Isaac } 63353e922f36SToby Isaac if (d < dof/bs) { 63363e922f36SToby Isaac if (c >= sStart && c < sEnd) { 63373e922f36SToby Isaac PetscInt cdof; 63383e922f36SToby Isaac 63393e922f36SToby Isaac ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr); 63403e922f36SToby Isaac if (cdof != dof) alreadyLocalized = PETSC_FALSE; 63413e922f36SToby Isaac } 63423e922f36SToby Isaac ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr); 63433e922f36SToby Isaac ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr); 63443e922f36SToby Isaac } 63453e922f36SToby Isaac ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 63463e922f36SToby Isaac } 63473e922f36SToby Isaac } 63483e922f36SToby Isaac ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 63493e922f36SToby Isaac if (alreadyLocalizedGlobal) { 635069291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 63513e922f36SToby Isaac ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 635269291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 63533e922f36SToby Isaac PetscFunctionReturn(0); 63543e922f36SToby Isaac } 63552e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 63562e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 63572e17dfb7SMatthew G. Knepley ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr); 63582e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr); 63592e17dfb7SMatthew G. Knepley } 63602e17dfb7SMatthew G. Knepley ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr); 63612e17dfb7SMatthew G. Knepley ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr); 6362c2be7e5eSLisandro Dalcin ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr); 63632e17dfb7SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr); 63642e17dfb7SMatthew G. Knepley ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr); 63652e17dfb7SMatthew G. Knepley ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr); 63662e17dfb7SMatthew G. Knepley ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr); 6367c2be7e5eSLisandro Dalcin ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 63682e17dfb7SMatthew G. Knepley ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr); 63692e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 63702e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 63712e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr); 63722e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, v, &off2);CHKERRQ(ierr); 63732e17dfb7SMatthew G. Knepley for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d]; 63742e17dfb7SMatthew G. Knepley } 63753e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 63763e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 63773e922f36SToby Isaac 63782e17dfb7SMatthew G. Knepley for (c = cStart; c < cEnd; ++c) { 63792e17dfb7SMatthew G. Knepley PetscScalar *cellCoords = NULL; 63803e922f36SToby Isaac PetscInt b, cdof; 63812e17dfb7SMatthew G. Knepley 63823e922f36SToby Isaac ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr); 63833e922f36SToby Isaac if (!cdof) continue; 63842e17dfb7SMatthew G. Knepley ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 63852e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr); 63862e17dfb7SMatthew G. Knepley for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 63872e17dfb7SMatthew G. Knepley for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);} 63882e17dfb7SMatthew G. Knepley ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 63892e17dfb7SMatthew G. Knepley } 63903e922f36SToby Isaac } 639169291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 639269291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 6393c2be7e5eSLisandro Dalcin ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 63942e17dfb7SMatthew G. Knepley ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr); 63952e17dfb7SMatthew G. Knepley ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr); 63962e17dfb7SMatthew G. Knepley ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr); 63972e17dfb7SMatthew G. Knepley ierr = VecDestroy(&cVec);CHKERRQ(ierr); 63982e17dfb7SMatthew G. Knepley ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 63992e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 64002e17dfb7SMatthew G. Knepley } 64012e17dfb7SMatthew G. Knepley 6402e87bb0d3SMatthew G Knepley /*@ 64033a93e3b7SToby Isaac DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells 6404e87bb0d3SMatthew G Knepley 6405d083f849SBarry Smith Collective on v (see explanation below) 6406e87bb0d3SMatthew G Knepley 6407e87bb0d3SMatthew G Knepley Input Parameters: 6408e87bb0d3SMatthew G Knepley + dm - The DM 64093a93e3b7SToby Isaac . v - The Vec of points 641062a38674SMatthew G. Knepley . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST 64113a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point. 6412e87bb0d3SMatthew G Knepley 641361e3bb9bSMatthew G Knepley Output Parameter: 641462a38674SMatthew G. Knepley + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used 641562a38674SMatthew G. Knepley - cells - The PetscSF containing the ranks and local indices of the containing points. 64163a93e3b7SToby Isaac 6417e87bb0d3SMatthew G Knepley 6418e87bb0d3SMatthew G Knepley Level: developer 641961e3bb9bSMatthew G Knepley 642062a38674SMatthew G. Knepley Notes: 64213a93e3b7SToby Isaac To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator. 642262a38674SMatthew G. Knepley To do a search of all the cells in the distributed mesh, v should have the same communicator as dm. 64233a93e3b7SToby Isaac 64243a93e3b7SToby Isaac If *cellSF is NULL on input, a PetscSF will be created. 642562a38674SMatthew G. Knepley If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses. 64263a93e3b7SToby Isaac 64273a93e3b7SToby Isaac An array that maps each point to its containing cell can be obtained with 64283a93e3b7SToby Isaac 642962a38674SMatthew G. Knepley $ const PetscSFNode *cells; 643062a38674SMatthew G. Knepley $ PetscInt nFound; 6431a6216909SToby Isaac $ const PetscInt *found; 643262a38674SMatthew G. Knepley $ 6433a6216909SToby Isaac $ PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells); 64343a93e3b7SToby Isaac 64353a93e3b7SToby Isaac Where cells[i].rank is the rank of the cell containing point found[i] (or i if found == NULL), and cells[i].index is 64363a93e3b7SToby Isaac the index of the cell in its rank's local numbering. 64373a93e3b7SToby Isaac 643862a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType 643961e3bb9bSMatthew G Knepley @*/ 644062a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF) 6441e87bb0d3SMatthew G Knepley { 6442735aa83eSMatthew G Knepley PetscErrorCode ierr; 6443735aa83eSMatthew G Knepley 6444e87bb0d3SMatthew G Knepley PetscFunctionBegin; 6445e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6446e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,2); 6447e0fc9d1bSMatthew G. Knepley PetscValidPointer(cellSF,4); 64483a93e3b7SToby Isaac if (*cellSF) { 64493a93e3b7SToby Isaac PetscMPIInt result; 64503a93e3b7SToby Isaac 6451e0fc9d1bSMatthew G. Knepley PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4); 6452a4f09dd6SDave May ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRQ(ierr); 64533a93e3b7SToby Isaac if (result != MPI_IDENT && result != MPI_CONGRUENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's"); 6454e0fc9d1bSMatthew G. Knepley } else { 64553a93e3b7SToby Isaac ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr); 64563a93e3b7SToby Isaac } 6457b9d85ea2SLisandro Dalcin if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM"); 645847a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 645962a38674SMatthew G. Knepley ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr); 646047a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 6461e87bb0d3SMatthew G Knepley PetscFunctionReturn(0); 6462e87bb0d3SMatthew G Knepley } 646314f150ffSMatthew G. Knepley 6464f4d763aaSMatthew G. Knepley /*@ 6465f4d763aaSMatthew G. Knepley DMGetOutputDM - Retrieve the DM associated with the layout for output 6466f4d763aaSMatthew G. Knepley 64678f700142SStefano Zampini Collective on dm 64688f700142SStefano Zampini 6469f4d763aaSMatthew G. Knepley Input Parameter: 6470f4d763aaSMatthew G. Knepley . dm - The original DM 6471f4d763aaSMatthew G. Knepley 6472f4d763aaSMatthew G. Knepley Output Parameter: 6473f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output 6474f4d763aaSMatthew G. Knepley 6475f4d763aaSMatthew G. Knepley Level: intermediate 6476f4d763aaSMatthew G. Knepley 6477e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection() 6478f4d763aaSMatthew G. Knepley @*/ 647914f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm) 648014f150ffSMatthew G. Knepley { 6481c26acbdeSMatthew G. Knepley PetscSection section; 64822d4e4a49SMatthew G. Knepley PetscBool hasConstraints, ghasConstraints; 648314f150ffSMatthew G. Knepley PetscErrorCode ierr; 648414f150ffSMatthew G. Knepley 648514f150ffSMatthew G. Knepley PetscFunctionBegin; 648614f150ffSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 648714f150ffSMatthew G. Knepley PetscValidPointer(odm,2); 648892fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 6489c26acbdeSMatthew G. Knepley ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr); 6490127fe6b9SMatthew G. Knepley ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr); 64912d4e4a49SMatthew G. Knepley if (!ghasConstraints) { 6492c26acbdeSMatthew G. Knepley *odm = dm; 6493c26acbdeSMatthew G. Knepley PetscFunctionReturn(0); 6494c26acbdeSMatthew G. Knepley } 649514f150ffSMatthew G. Knepley if (!dm->dmBC) { 6496c26acbdeSMatthew G. Knepley PetscSection newSection, gsection; 649714f150ffSMatthew G. Knepley PetscSF sf; 649814f150ffSMatthew G. Knepley 649914f150ffSMatthew G. Knepley ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr); 6500e5e52638SMatthew G. Knepley ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr); 650114f150ffSMatthew G. Knepley ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr); 650292fd8e1eSJed Brown ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr); 650314f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr); 650414f150ffSMatthew G. Knepley ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr); 650515b58121SMatthew G. Knepley ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr); 6506e87a4003SBarry Smith ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr); 650714f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr); 650814f150ffSMatthew G. Knepley } 650914f150ffSMatthew G. Knepley *odm = dm->dmBC; 651014f150ffSMatthew G. Knepley PetscFunctionReturn(0); 651114f150ffSMatthew G. Knepley } 6512f4d763aaSMatthew G. Knepley 6513f4d763aaSMatthew G. Knepley /*@ 6514cdb7a50dSMatthew G. Knepley DMGetOutputSequenceNumber - Retrieve the sequence number/value for output 6515f4d763aaSMatthew G. Knepley 6516f4d763aaSMatthew G. Knepley Input Parameter: 6517f4d763aaSMatthew G. Knepley . dm - The original DM 6518f4d763aaSMatthew G. Knepley 6519cdb7a50dSMatthew G. Knepley Output Parameters: 6520cdb7a50dSMatthew G. Knepley + num - The output sequence number 6521cdb7a50dSMatthew G. Knepley - val - The output sequence value 6522f4d763aaSMatthew G. Knepley 6523f4d763aaSMatthew G. Knepley Level: intermediate 6524f4d763aaSMatthew G. Knepley 6525f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 6526f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 6527f4d763aaSMatthew G. Knepley 6528f4d763aaSMatthew G. Knepley .seealso: VecView() 6529f4d763aaSMatthew G. Knepley @*/ 6530cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val) 6531f4d763aaSMatthew G. Knepley { 6532f4d763aaSMatthew G. Knepley PetscFunctionBegin; 6533f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6534534a8f05SLisandro Dalcin if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;} 6535534a8f05SLisandro Dalcin if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;} 6536f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 6537f4d763aaSMatthew G. Knepley } 6538f4d763aaSMatthew G. Knepley 6539f4d763aaSMatthew G. Knepley /*@ 6540cdb7a50dSMatthew G. Knepley DMSetOutputSequenceNumber - Set the sequence number/value for output 6541f4d763aaSMatthew G. Knepley 6542f4d763aaSMatthew G. Knepley Input Parameters: 6543f4d763aaSMatthew G. Knepley + dm - The original DM 6544cdb7a50dSMatthew G. Knepley . num - The output sequence number 6545cdb7a50dSMatthew G. Knepley - val - The output sequence value 6546f4d763aaSMatthew G. Knepley 6547f4d763aaSMatthew G. Knepley Level: intermediate 6548f4d763aaSMatthew G. Knepley 6549f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 6550f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 6551f4d763aaSMatthew G. Knepley 6552f4d763aaSMatthew G. Knepley .seealso: VecView() 6553f4d763aaSMatthew G. Knepley @*/ 6554cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val) 6555f4d763aaSMatthew G. Knepley { 6556f4d763aaSMatthew G. Knepley PetscFunctionBegin; 6557f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6558f4d763aaSMatthew G. Knepley dm->outputSequenceNum = num; 6559cdb7a50dSMatthew G. Knepley dm->outputSequenceVal = val; 6560cdb7a50dSMatthew G. Knepley PetscFunctionReturn(0); 6561cdb7a50dSMatthew G. Knepley } 6562cdb7a50dSMatthew G. Knepley 6563cdb7a50dSMatthew G. Knepley /*@C 6564cdb7a50dSMatthew G. Knepley DMOutputSequenceLoad - Retrieve the sequence value from a Viewer 6565cdb7a50dSMatthew G. Knepley 6566cdb7a50dSMatthew G. Knepley Input Parameters: 6567cdb7a50dSMatthew G. Knepley + dm - The original DM 6568cdb7a50dSMatthew G. Knepley . name - The sequence name 6569cdb7a50dSMatthew G. Knepley - num - The output sequence number 6570cdb7a50dSMatthew G. Knepley 6571cdb7a50dSMatthew G. Knepley Output Parameter: 6572cdb7a50dSMatthew G. Knepley . val - The output sequence value 6573cdb7a50dSMatthew G. Knepley 6574cdb7a50dSMatthew G. Knepley Level: intermediate 6575cdb7a50dSMatthew G. Knepley 6576cdb7a50dSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 6577cdb7a50dSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 6578cdb7a50dSMatthew G. Knepley 6579cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView() 6580cdb7a50dSMatthew G. Knepley @*/ 6581cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val) 6582cdb7a50dSMatthew G. Knepley { 6583cdb7a50dSMatthew G. Knepley PetscBool ishdf5; 6584cdb7a50dSMatthew G. Knepley PetscErrorCode ierr; 6585cdb7a50dSMatthew G. Knepley 6586cdb7a50dSMatthew G. Knepley PetscFunctionBegin; 6587cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6588cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 6589534a8f05SLisandro Dalcin PetscValidRealPointer(val,4); 6590cdb7a50dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr); 6591cdb7a50dSMatthew G. Knepley if (ishdf5) { 6592cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5) 6593cdb7a50dSMatthew G. Knepley PetscScalar value; 6594cdb7a50dSMatthew G. Knepley 659539d25373SMatthew G. Knepley ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr); 65964aeb217fSMatthew G. Knepley *val = PetscRealPart(value); 6597cdb7a50dSMatthew G. Knepley #endif 6598cdb7a50dSMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()"); 6599f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 6600f4d763aaSMatthew G. Knepley } 66018e4ac7eaSMatthew G. Knepley 66028e4ac7eaSMatthew G. Knepley /*@ 66038e4ac7eaSMatthew G. Knepley DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution 66048e4ac7eaSMatthew G. Knepley 66058e4ac7eaSMatthew G. Knepley Not collective 66068e4ac7eaSMatthew G. Knepley 66078e4ac7eaSMatthew G. Knepley Input Parameter: 66088e4ac7eaSMatthew G. Knepley . dm - The DM 66098e4ac7eaSMatthew G. Knepley 66108e4ac7eaSMatthew G. Knepley Output Parameter: 66118e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution 66128e4ac7eaSMatthew G. Knepley 66138e4ac7eaSMatthew G. Knepley Level: beginner 66148e4ac7eaSMatthew G. Knepley 66158e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate() 66168e4ac7eaSMatthew G. Knepley @*/ 66178e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural) 66188e4ac7eaSMatthew G. Knepley { 66198e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 66208e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6621534a8f05SLisandro Dalcin PetscValidBoolPointer(useNatural, 2); 66228e4ac7eaSMatthew G. Knepley *useNatural = dm->useNatural; 66238e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 66248e4ac7eaSMatthew G. Knepley } 66258e4ac7eaSMatthew G. Knepley 66268e4ac7eaSMatthew G. Knepley /*@ 66275d3b26e6SMatthew G. Knepley DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution 66288e4ac7eaSMatthew G. Knepley 66298e4ac7eaSMatthew G. Knepley Collective on dm 66308e4ac7eaSMatthew G. Knepley 66318e4ac7eaSMatthew G. Knepley Input Parameters: 66328e4ac7eaSMatthew G. Knepley + dm - The DM 66338e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution 66348e4ac7eaSMatthew G. Knepley 66355d3b26e6SMatthew G. Knepley Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM() 66365d3b26e6SMatthew G. Knepley 66378e4ac7eaSMatthew G. Knepley Level: beginner 66388e4ac7eaSMatthew G. Knepley 66395d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM() 66408e4ac7eaSMatthew G. Knepley @*/ 66418e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural) 66428e4ac7eaSMatthew G. Knepley { 66438e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 66448e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 66458833efb5SBlaise Bourdin PetscValidLogicalCollectiveBool(dm, useNatural, 2); 66468e4ac7eaSMatthew G. Knepley dm->useNatural = useNatural; 66478e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 66488e4ac7eaSMatthew G. Knepley } 6649c58f1c22SToby Isaac 6650c58f1c22SToby Isaac 6651c58f1c22SToby Isaac /*@C 6652c58f1c22SToby Isaac DMCreateLabel - Create a label of the given name if it does not already exist 6653c58f1c22SToby Isaac 6654c58f1c22SToby Isaac Not Collective 6655c58f1c22SToby Isaac 6656c58f1c22SToby Isaac Input Parameters: 6657c58f1c22SToby Isaac + dm - The DM object 6658c58f1c22SToby Isaac - name - The label name 6659c58f1c22SToby Isaac 6660c58f1c22SToby Isaac Level: intermediate 6661c58f1c22SToby Isaac 6662c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 6663c58f1c22SToby Isaac @*/ 6664c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[]) 6665c58f1c22SToby Isaac { 66665d80c0bfSVaclav Hapla PetscBool flg; 66675d80c0bfSVaclav Hapla DMLabel label; 6668c58f1c22SToby Isaac PetscErrorCode ierr; 6669c58f1c22SToby Isaac 6670c58f1c22SToby Isaac PetscFunctionBegin; 6671c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6672c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 66735d80c0bfSVaclav Hapla ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 6674c58f1c22SToby Isaac if (!flg) { 66755d80c0bfSVaclav Hapla ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 66765d80c0bfSVaclav Hapla ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 66775d80c0bfSVaclav Hapla ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 6678c58f1c22SToby Isaac } 6679c58f1c22SToby Isaac PetscFunctionReturn(0); 6680c58f1c22SToby Isaac } 6681c58f1c22SToby Isaac 6682c58f1c22SToby Isaac /*@C 6683c58f1c22SToby Isaac DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default 6684c58f1c22SToby Isaac 6685c58f1c22SToby Isaac Not Collective 6686c58f1c22SToby Isaac 6687c58f1c22SToby Isaac Input Parameters: 6688c58f1c22SToby Isaac + dm - The DM object 6689c58f1c22SToby Isaac . name - The label name 6690c58f1c22SToby Isaac - point - The mesh point 6691c58f1c22SToby Isaac 6692c58f1c22SToby Isaac Output Parameter: 6693c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label 6694c58f1c22SToby Isaac 6695c58f1c22SToby Isaac Level: beginner 6696c58f1c22SToby Isaac 6697c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS() 6698c58f1c22SToby Isaac @*/ 6699c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value) 6700c58f1c22SToby Isaac { 6701c58f1c22SToby Isaac DMLabel label; 6702c58f1c22SToby Isaac PetscErrorCode ierr; 6703c58f1c22SToby Isaac 6704c58f1c22SToby Isaac PetscFunctionBegin; 6705c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6706c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 6707c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 670813903a91SSatish Balay if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name); 6709c58f1c22SToby Isaac ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr); 6710c58f1c22SToby Isaac PetscFunctionReturn(0); 6711c58f1c22SToby Isaac } 6712c58f1c22SToby Isaac 6713c58f1c22SToby Isaac /*@C 6714c58f1c22SToby Isaac DMSetLabelValue - Add a point to a Sieve Label with given value 6715c58f1c22SToby Isaac 6716c58f1c22SToby Isaac Not Collective 6717c58f1c22SToby Isaac 6718c58f1c22SToby Isaac Input Parameters: 6719c58f1c22SToby Isaac + dm - The DM object 6720c58f1c22SToby Isaac . name - The label name 6721c58f1c22SToby Isaac . point - The mesh point 6722c58f1c22SToby Isaac - value - The label value for this point 6723c58f1c22SToby Isaac 6724c58f1c22SToby Isaac Output Parameter: 6725c58f1c22SToby Isaac 6726c58f1c22SToby Isaac Level: beginner 6727c58f1c22SToby Isaac 6728c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue() 6729c58f1c22SToby Isaac @*/ 6730c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 6731c58f1c22SToby Isaac { 6732c58f1c22SToby Isaac DMLabel label; 6733c58f1c22SToby Isaac PetscErrorCode ierr; 6734c58f1c22SToby Isaac 6735c58f1c22SToby Isaac PetscFunctionBegin; 6736c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6737c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 6738c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 6739c58f1c22SToby Isaac if (!label) { 6740c58f1c22SToby Isaac ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 6741c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 6742c58f1c22SToby Isaac } 6743c58f1c22SToby Isaac ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr); 6744c58f1c22SToby Isaac PetscFunctionReturn(0); 6745c58f1c22SToby Isaac } 6746c58f1c22SToby Isaac 6747c58f1c22SToby Isaac /*@C 6748c58f1c22SToby Isaac DMClearLabelValue - Remove a point from a Sieve Label with given value 6749c58f1c22SToby Isaac 6750c58f1c22SToby Isaac Not Collective 6751c58f1c22SToby Isaac 6752c58f1c22SToby Isaac Input Parameters: 6753c58f1c22SToby Isaac + dm - The DM object 6754c58f1c22SToby Isaac . name - The label name 6755c58f1c22SToby Isaac . point - The mesh point 6756c58f1c22SToby Isaac - value - The label value for this point 6757c58f1c22SToby Isaac 6758c58f1c22SToby Isaac Output Parameter: 6759c58f1c22SToby Isaac 6760c58f1c22SToby Isaac Level: beginner 6761c58f1c22SToby Isaac 6762c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS() 6763c58f1c22SToby Isaac @*/ 6764c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 6765c58f1c22SToby Isaac { 6766c58f1c22SToby Isaac DMLabel label; 6767c58f1c22SToby Isaac PetscErrorCode ierr; 6768c58f1c22SToby Isaac 6769c58f1c22SToby Isaac PetscFunctionBegin; 6770c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6771c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 6772c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 6773c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 6774c58f1c22SToby Isaac ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr); 6775c58f1c22SToby Isaac PetscFunctionReturn(0); 6776c58f1c22SToby Isaac } 6777c58f1c22SToby Isaac 6778c58f1c22SToby Isaac /*@C 6779c58f1c22SToby Isaac DMGetLabelSize - Get the number of different integer ids in a Label 6780c58f1c22SToby Isaac 6781c58f1c22SToby Isaac Not Collective 6782c58f1c22SToby Isaac 6783c58f1c22SToby Isaac Input Parameters: 6784c58f1c22SToby Isaac + dm - The DM object 6785c58f1c22SToby Isaac - name - The label name 6786c58f1c22SToby Isaac 6787c58f1c22SToby Isaac Output Parameter: 6788c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist 6789c58f1c22SToby Isaac 6790c58f1c22SToby Isaac Level: beginner 6791c58f1c22SToby Isaac 6792df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue() 6793c58f1c22SToby Isaac @*/ 6794c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size) 6795c58f1c22SToby Isaac { 6796c58f1c22SToby Isaac DMLabel label; 6797c58f1c22SToby Isaac PetscErrorCode ierr; 6798c58f1c22SToby Isaac 6799c58f1c22SToby Isaac PetscFunctionBegin; 6800c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6801c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 6802534a8f05SLisandro Dalcin PetscValidIntPointer(size, 3); 6803c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 6804c58f1c22SToby Isaac *size = 0; 6805c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 6806c58f1c22SToby Isaac ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr); 6807c58f1c22SToby Isaac PetscFunctionReturn(0); 6808c58f1c22SToby Isaac } 6809c58f1c22SToby Isaac 6810c58f1c22SToby Isaac /*@C 6811c58f1c22SToby Isaac DMGetLabelIdIS - Get the integer ids in a label 6812c58f1c22SToby Isaac 6813c58f1c22SToby Isaac Not Collective 6814c58f1c22SToby Isaac 6815c58f1c22SToby Isaac Input Parameters: 6816c58f1c22SToby Isaac + mesh - The DM object 6817c58f1c22SToby Isaac - name - The label name 6818c58f1c22SToby Isaac 6819c58f1c22SToby Isaac Output Parameter: 6820c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist 6821c58f1c22SToby Isaac 6822c58f1c22SToby Isaac Level: beginner 6823c58f1c22SToby Isaac 6824c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize() 6825c58f1c22SToby Isaac @*/ 6826c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids) 6827c58f1c22SToby Isaac { 6828c58f1c22SToby Isaac DMLabel label; 6829c58f1c22SToby Isaac PetscErrorCode ierr; 6830c58f1c22SToby Isaac 6831c58f1c22SToby Isaac PetscFunctionBegin; 6832c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6833c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 6834c58f1c22SToby Isaac PetscValidPointer(ids, 3); 6835c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 6836c58f1c22SToby Isaac *ids = NULL; 6837dab2e251SBlaise Bourdin if (label) { 6838c58f1c22SToby Isaac ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr); 6839dab2e251SBlaise Bourdin } else { 6840dab2e251SBlaise Bourdin /* returning an empty IS */ 6841dab2e251SBlaise Bourdin ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr); 6842dab2e251SBlaise Bourdin } 6843c58f1c22SToby Isaac PetscFunctionReturn(0); 6844c58f1c22SToby Isaac } 6845c58f1c22SToby Isaac 6846c58f1c22SToby Isaac /*@C 6847c58f1c22SToby Isaac DMGetStratumSize - Get the number of points in a label stratum 6848c58f1c22SToby Isaac 6849c58f1c22SToby Isaac Not Collective 6850c58f1c22SToby Isaac 6851c58f1c22SToby Isaac Input Parameters: 6852c58f1c22SToby Isaac + dm - The DM object 6853c58f1c22SToby Isaac . name - The label name 6854c58f1c22SToby Isaac - value - The stratum value 6855c58f1c22SToby Isaac 6856c58f1c22SToby Isaac Output Parameter: 6857c58f1c22SToby Isaac . size - The stratum size 6858c58f1c22SToby Isaac 6859c58f1c22SToby Isaac Level: beginner 6860c58f1c22SToby Isaac 6861c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds() 6862c58f1c22SToby Isaac @*/ 6863c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size) 6864c58f1c22SToby Isaac { 6865c58f1c22SToby Isaac DMLabel label; 6866c58f1c22SToby Isaac PetscErrorCode ierr; 6867c58f1c22SToby Isaac 6868c58f1c22SToby Isaac PetscFunctionBegin; 6869c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6870c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 6871534a8f05SLisandro Dalcin PetscValidIntPointer(size, 4); 6872c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 6873c58f1c22SToby Isaac *size = 0; 6874c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 6875c58f1c22SToby Isaac ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr); 6876c58f1c22SToby Isaac PetscFunctionReturn(0); 6877c58f1c22SToby Isaac } 6878c58f1c22SToby Isaac 6879c58f1c22SToby Isaac /*@C 6880c58f1c22SToby Isaac DMGetStratumIS - Get the points in a label stratum 6881c58f1c22SToby Isaac 6882c58f1c22SToby Isaac Not Collective 6883c58f1c22SToby Isaac 6884c58f1c22SToby Isaac Input Parameters: 6885c58f1c22SToby Isaac + dm - The DM object 6886c58f1c22SToby Isaac . name - The label name 6887c58f1c22SToby Isaac - value - The stratum value 6888c58f1c22SToby Isaac 6889c58f1c22SToby Isaac Output Parameter: 6890c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value 6891c58f1c22SToby Isaac 6892c58f1c22SToby Isaac Level: beginner 6893c58f1c22SToby Isaac 6894c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize() 6895c58f1c22SToby Isaac @*/ 6896c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points) 6897c58f1c22SToby Isaac { 6898c58f1c22SToby Isaac DMLabel label; 6899c58f1c22SToby Isaac PetscErrorCode ierr; 6900c58f1c22SToby Isaac 6901c58f1c22SToby Isaac PetscFunctionBegin; 6902c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6903c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 6904c58f1c22SToby Isaac PetscValidPointer(points, 4); 6905c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 6906c58f1c22SToby Isaac *points = NULL; 6907c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 6908c58f1c22SToby Isaac ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr); 6909c58f1c22SToby Isaac PetscFunctionReturn(0); 6910c58f1c22SToby Isaac } 6911c58f1c22SToby Isaac 69124de306b1SToby Isaac /*@C 69139044fa66SMatthew G. Knepley DMSetStratumIS - Set the points in a label stratum 69144de306b1SToby Isaac 69154de306b1SToby Isaac Not Collective 69164de306b1SToby Isaac 69174de306b1SToby Isaac Input Parameters: 69184de306b1SToby Isaac + dm - The DM object 69194de306b1SToby Isaac . name - The label name 69204de306b1SToby Isaac . value - The stratum value 69214de306b1SToby Isaac - points - The stratum points 69224de306b1SToby Isaac 69234de306b1SToby Isaac Level: beginner 69244de306b1SToby Isaac 69254de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize() 69264de306b1SToby Isaac @*/ 69274de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points) 69284de306b1SToby Isaac { 69294de306b1SToby Isaac DMLabel label; 69304de306b1SToby Isaac PetscErrorCode ierr; 69314de306b1SToby Isaac 69324de306b1SToby Isaac PetscFunctionBegin; 69334de306b1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 69344de306b1SToby Isaac PetscValidCharPointer(name, 2); 69354de306b1SToby Isaac PetscValidPointer(points, 4); 69364de306b1SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 69374de306b1SToby Isaac if (!label) PetscFunctionReturn(0); 69384de306b1SToby Isaac ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr); 69394de306b1SToby Isaac PetscFunctionReturn(0); 69404de306b1SToby Isaac } 69414de306b1SToby Isaac 6942c58f1c22SToby Isaac /*@C 6943c58f1c22SToby Isaac DMClearLabelStratum - Remove all points from a stratum from a Sieve Label 6944c58f1c22SToby Isaac 6945c58f1c22SToby Isaac Not Collective 6946c58f1c22SToby Isaac 6947c58f1c22SToby Isaac Input Parameters: 6948c58f1c22SToby Isaac + dm - The DM object 6949c58f1c22SToby Isaac . name - The label name 6950c58f1c22SToby Isaac - value - The label value for this point 6951c58f1c22SToby Isaac 6952c58f1c22SToby Isaac Output Parameter: 6953c58f1c22SToby Isaac 6954c58f1c22SToby Isaac Level: beginner 6955c58f1c22SToby Isaac 6956c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue() 6957c58f1c22SToby Isaac @*/ 6958c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value) 6959c58f1c22SToby Isaac { 6960c58f1c22SToby Isaac DMLabel label; 6961c58f1c22SToby Isaac PetscErrorCode ierr; 6962c58f1c22SToby Isaac 6963c58f1c22SToby Isaac PetscFunctionBegin; 6964c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6965c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 6966c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 6967c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 6968c58f1c22SToby Isaac ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr); 6969c58f1c22SToby Isaac PetscFunctionReturn(0); 6970c58f1c22SToby Isaac } 6971c58f1c22SToby Isaac 6972c58f1c22SToby Isaac /*@ 6973c58f1c22SToby Isaac DMGetNumLabels - Return the number of labels defined by the mesh 6974c58f1c22SToby Isaac 6975c58f1c22SToby Isaac Not Collective 6976c58f1c22SToby Isaac 6977c58f1c22SToby Isaac Input Parameter: 6978c58f1c22SToby Isaac . dm - The DM object 6979c58f1c22SToby Isaac 6980c58f1c22SToby Isaac Output Parameter: 6981c58f1c22SToby Isaac . numLabels - the number of Labels 6982c58f1c22SToby Isaac 6983c58f1c22SToby Isaac Level: intermediate 6984c58f1c22SToby Isaac 6985c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 6986c58f1c22SToby Isaac @*/ 6987c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels) 6988c58f1c22SToby Isaac { 69895d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 6990c58f1c22SToby Isaac PetscInt n = 0; 6991c58f1c22SToby Isaac 6992c58f1c22SToby Isaac PetscFunctionBegin; 6993c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6994534a8f05SLisandro Dalcin PetscValidIntPointer(numLabels, 2); 6995c58f1c22SToby Isaac while (next) {++n; next = next->next;} 6996c58f1c22SToby Isaac *numLabels = n; 6997c58f1c22SToby Isaac PetscFunctionReturn(0); 6998c58f1c22SToby Isaac } 6999c58f1c22SToby Isaac 7000c58f1c22SToby Isaac /*@C 7001c58f1c22SToby Isaac DMGetLabelName - Return the name of nth label 7002c58f1c22SToby Isaac 7003c58f1c22SToby Isaac Not Collective 7004c58f1c22SToby Isaac 7005c58f1c22SToby Isaac Input Parameters: 7006c58f1c22SToby Isaac + dm - The DM object 7007c58f1c22SToby Isaac - n - the label number 7008c58f1c22SToby Isaac 7009c58f1c22SToby Isaac Output Parameter: 7010c58f1c22SToby Isaac . name - the label name 7011c58f1c22SToby Isaac 7012c58f1c22SToby Isaac Level: intermediate 7013c58f1c22SToby Isaac 7014c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7015c58f1c22SToby Isaac @*/ 7016c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name) 7017c58f1c22SToby Isaac { 70185d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7019c58f1c22SToby Isaac PetscInt l = 0; 7020d67d17b1SMatthew G. Knepley PetscErrorCode ierr; 7021c58f1c22SToby Isaac 7022c58f1c22SToby Isaac PetscFunctionBegin; 7023c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7024c58f1c22SToby Isaac PetscValidPointer(name, 3); 7025c58f1c22SToby Isaac while (next) { 7026c58f1c22SToby Isaac if (l == n) { 7027d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr); 7028c58f1c22SToby Isaac PetscFunctionReturn(0); 7029c58f1c22SToby Isaac } 7030c58f1c22SToby Isaac ++l; 7031c58f1c22SToby Isaac next = next->next; 7032c58f1c22SToby Isaac } 7033c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 7034c58f1c22SToby Isaac } 7035c58f1c22SToby Isaac 7036c58f1c22SToby Isaac /*@C 7037c58f1c22SToby Isaac DMHasLabel - Determine whether the mesh has a label of a given name 7038c58f1c22SToby Isaac 7039c58f1c22SToby Isaac Not Collective 7040c58f1c22SToby Isaac 7041c58f1c22SToby Isaac Input Parameters: 7042c58f1c22SToby Isaac + dm - The DM object 7043c58f1c22SToby Isaac - name - The label name 7044c58f1c22SToby Isaac 7045c58f1c22SToby Isaac Output Parameter: 7046c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present 7047c58f1c22SToby Isaac 7048c58f1c22SToby Isaac Level: intermediate 7049c58f1c22SToby Isaac 7050c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7051c58f1c22SToby Isaac @*/ 7052c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel) 7053c58f1c22SToby Isaac { 70545d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7055d67d17b1SMatthew G. Knepley const char *lname; 7056c58f1c22SToby Isaac PetscErrorCode ierr; 7057c58f1c22SToby Isaac 7058c58f1c22SToby Isaac PetscFunctionBegin; 7059c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7060c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7061534a8f05SLisandro Dalcin PetscValidBoolPointer(hasLabel, 3); 7062c58f1c22SToby Isaac *hasLabel = PETSC_FALSE; 7063c58f1c22SToby Isaac while (next) { 7064d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 7065d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr); 7066c58f1c22SToby Isaac if (*hasLabel) break; 7067c58f1c22SToby Isaac next = next->next; 7068c58f1c22SToby Isaac } 7069c58f1c22SToby Isaac PetscFunctionReturn(0); 7070c58f1c22SToby Isaac } 7071c58f1c22SToby Isaac 7072c58f1c22SToby Isaac /*@C 7073c58f1c22SToby Isaac DMGetLabel - Return the label of a given name, or NULL 7074c58f1c22SToby Isaac 7075c58f1c22SToby Isaac Not Collective 7076c58f1c22SToby Isaac 7077c58f1c22SToby Isaac Input Parameters: 7078c58f1c22SToby Isaac + dm - The DM object 7079c58f1c22SToby Isaac - name - The label name 7080c58f1c22SToby Isaac 7081c58f1c22SToby Isaac Output Parameter: 7082c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 7083c58f1c22SToby Isaac 7084c58f1c22SToby Isaac Level: intermediate 7085c58f1c22SToby Isaac 7086c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7087c58f1c22SToby Isaac @*/ 7088c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label) 7089c58f1c22SToby Isaac { 70905d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7091c58f1c22SToby Isaac PetscBool hasLabel; 7092d67d17b1SMatthew G. Knepley const char *lname; 7093c58f1c22SToby Isaac PetscErrorCode ierr; 7094c58f1c22SToby Isaac 7095c58f1c22SToby Isaac PetscFunctionBegin; 7096c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7097c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7098c58f1c22SToby Isaac PetscValidPointer(label, 3); 7099c58f1c22SToby Isaac *label = NULL; 7100c58f1c22SToby Isaac while (next) { 7101d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 7102d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 7103c58f1c22SToby Isaac if (hasLabel) { 7104c58f1c22SToby Isaac *label = next->label; 7105c58f1c22SToby Isaac break; 7106c58f1c22SToby Isaac } 7107c58f1c22SToby Isaac next = next->next; 7108c58f1c22SToby Isaac } 7109c58f1c22SToby Isaac PetscFunctionReturn(0); 7110c58f1c22SToby Isaac } 7111c58f1c22SToby Isaac 7112c58f1c22SToby Isaac /*@C 7113c58f1c22SToby Isaac DMGetLabelByNum - Return the nth label 7114c58f1c22SToby Isaac 7115c58f1c22SToby Isaac Not Collective 7116c58f1c22SToby Isaac 7117c58f1c22SToby Isaac Input Parameters: 7118c58f1c22SToby Isaac + dm - The DM object 7119c58f1c22SToby Isaac - n - the label number 7120c58f1c22SToby Isaac 7121c58f1c22SToby Isaac Output Parameter: 7122c58f1c22SToby Isaac . label - the label 7123c58f1c22SToby Isaac 7124c58f1c22SToby Isaac Level: intermediate 7125c58f1c22SToby Isaac 7126c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7127c58f1c22SToby Isaac @*/ 7128c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label) 7129c58f1c22SToby Isaac { 71305d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7131c58f1c22SToby Isaac PetscInt l = 0; 7132c58f1c22SToby Isaac 7133c58f1c22SToby Isaac PetscFunctionBegin; 7134c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7135c58f1c22SToby Isaac PetscValidPointer(label, 3); 7136c58f1c22SToby Isaac while (next) { 7137c58f1c22SToby Isaac if (l == n) { 7138c58f1c22SToby Isaac *label = next->label; 7139c58f1c22SToby Isaac PetscFunctionReturn(0); 7140c58f1c22SToby Isaac } 7141c58f1c22SToby Isaac ++l; 7142c58f1c22SToby Isaac next = next->next; 7143c58f1c22SToby Isaac } 7144c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 7145c58f1c22SToby Isaac } 7146c58f1c22SToby Isaac 7147c58f1c22SToby Isaac /*@C 7148c58f1c22SToby Isaac DMAddLabel - Add the label to this mesh 7149c58f1c22SToby Isaac 7150c58f1c22SToby Isaac Not Collective 7151c58f1c22SToby Isaac 7152c58f1c22SToby Isaac Input Parameters: 7153c58f1c22SToby Isaac + dm - The DM object 7154c58f1c22SToby Isaac - label - The DMLabel 7155c58f1c22SToby Isaac 7156c58f1c22SToby Isaac Level: developer 7157c58f1c22SToby Isaac 7158c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7159c58f1c22SToby Isaac @*/ 7160c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label) 7161c58f1c22SToby Isaac { 71625d80c0bfSVaclav Hapla DMLabelLink l, *p, tmpLabel; 7163c58f1c22SToby Isaac PetscBool hasLabel; 7164d67d17b1SMatthew G. Knepley const char *lname; 71655d80c0bfSVaclav Hapla PetscBool flg; 7166c58f1c22SToby Isaac PetscErrorCode ierr; 7167c58f1c22SToby Isaac 7168c58f1c22SToby Isaac PetscFunctionBegin; 7169c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7170d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr); 7171d67d17b1SMatthew G. Knepley ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr); 7172d67d17b1SMatthew G. Knepley if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname); 7173c58f1c22SToby Isaac ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr); 7174c58f1c22SToby Isaac tmpLabel->label = label; 7175c58f1c22SToby Isaac tmpLabel->output = PETSC_TRUE; 71765d80c0bfSVaclav Hapla for (p=&dm->labels; (l=*p); p=&l->next) {} 71775d80c0bfSVaclav Hapla *p = tmpLabel; 717808f633c4SVaclav Hapla ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr); 71795d80c0bfSVaclav Hapla ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 71805d80c0bfSVaclav Hapla if (flg) dm->depthLabel = label; 7181c58f1c22SToby Isaac PetscFunctionReturn(0); 7182c58f1c22SToby Isaac } 7183c58f1c22SToby Isaac 7184c58f1c22SToby Isaac /*@C 7185e5472504SVaclav Hapla DMRemoveLabel - Remove the label given by name from this mesh 7186c58f1c22SToby Isaac 7187c58f1c22SToby Isaac Not Collective 7188c58f1c22SToby Isaac 7189c58f1c22SToby Isaac Input Parameters: 7190c58f1c22SToby Isaac + dm - The DM object 7191c58f1c22SToby Isaac - name - The label name 7192c58f1c22SToby Isaac 7193c58f1c22SToby Isaac Output Parameter: 7194c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 7195c58f1c22SToby Isaac 7196c58f1c22SToby Isaac Level: developer 7197c58f1c22SToby Isaac 7198e5472504SVaclav Hapla Notes: 7199e5472504SVaclav Hapla DMRemoveLabel(dm,name,NULL) removes the label from dm and calls 7200e5472504SVaclav Hapla DMLabelDestroy() on the label. 7201e5472504SVaclav Hapla 7202e5472504SVaclav Hapla DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT 7203e5472504SVaclav Hapla call DMLabelDestroy(). Instead, the label is returned and the user is 7204e5472504SVaclav Hapla responsible of calling DMLabelDestroy() at some point. 7205e5472504SVaclav Hapla 7206e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf() 7207c58f1c22SToby Isaac @*/ 7208c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label) 7209c58f1c22SToby Isaac { 721095d578d6SVaclav Hapla DMLabelLink link, *pnext; 7211c58f1c22SToby Isaac PetscBool hasLabel; 7212d67d17b1SMatthew G. Knepley const char *lname; 7213c58f1c22SToby Isaac PetscErrorCode ierr; 7214c58f1c22SToby Isaac 7215c58f1c22SToby Isaac PetscFunctionBegin; 7216c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7217e5472504SVaclav Hapla PetscValidCharPointer(name, 2); 7218e5472504SVaclav Hapla if (label) { 7219e5472504SVaclav Hapla PetscValidPointer(label, 3); 7220c58f1c22SToby Isaac *label = NULL; 7221e5472504SVaclav Hapla } 72225d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 722395d578d6SVaclav Hapla ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr); 7224d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 7225c58f1c22SToby Isaac if (hasLabel) { 722695d578d6SVaclav Hapla *pnext = link->next; /* Remove from list */ 7227c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr); 722895d578d6SVaclav Hapla if (hasLabel) dm->depthLabel = NULL; 722995d578d6SVaclav Hapla if (label) *label = link->label; 723095d578d6SVaclav Hapla else {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);} 723195d578d6SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 7232c58f1c22SToby Isaac break; 7233c58f1c22SToby Isaac } 7234c58f1c22SToby Isaac } 7235c58f1c22SToby Isaac PetscFunctionReturn(0); 7236c58f1c22SToby Isaac } 7237c58f1c22SToby Isaac 7238306894acSVaclav Hapla /*@ 7239306894acSVaclav Hapla DMRemoveLabelBySelf - Remove the label from this mesh 7240306894acSVaclav Hapla 7241306894acSVaclav Hapla Not Collective 7242306894acSVaclav Hapla 7243306894acSVaclav Hapla Input Parameters: 7244306894acSVaclav Hapla + dm - The DM object 7245306894acSVaclav Hapla . label - (Optional) The DMLabel to be removed from the DM 7246306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM? 7247306894acSVaclav Hapla 7248306894acSVaclav Hapla Level: developer 7249306894acSVaclav Hapla 7250306894acSVaclav Hapla Notes: 7251306894acSVaclav Hapla Only exactly the same instance is removed if found, name match is ignored. 7252306894acSVaclav Hapla If the DM has an exclusive reference to the label, it gets destroyed and 7253306894acSVaclav Hapla *label nullified. 7254306894acSVaclav Hapla 7255306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel() 7256306894acSVaclav Hapla @*/ 7257306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound) 7258306894acSVaclav Hapla { 725943e45a93SVaclav Hapla DMLabelLink link, *pnext; 7260306894acSVaclav Hapla PetscBool hasLabel = PETSC_FALSE; 7261306894acSVaclav Hapla PetscErrorCode ierr; 7262306894acSVaclav Hapla 7263306894acSVaclav Hapla PetscFunctionBegin; 7264306894acSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7265306894acSVaclav Hapla PetscValidPointer(label, 2); 7266f39a9ae0SVaclav Hapla if (!*label && !failNotFound) PetscFunctionReturn(0); 7267306894acSVaclav Hapla PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2); 7268306894acSVaclav Hapla PetscValidLogicalCollectiveBool(dm,failNotFound,3); 72695d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 727043e45a93SVaclav Hapla if (*label == link->label) { 7271306894acSVaclav Hapla hasLabel = PETSC_TRUE; 727243e45a93SVaclav Hapla *pnext = link->next; /* Remove from list */ 7273306894acSVaclav Hapla if (*label == dm->depthLabel) dm->depthLabel = NULL; 727443e45a93SVaclav Hapla if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */ 727543e45a93SVaclav Hapla ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr); 727643e45a93SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 7277306894acSVaclav Hapla break; 7278306894acSVaclav Hapla } 7279306894acSVaclav Hapla } 7280306894acSVaclav Hapla if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM"); 7281306894acSVaclav Hapla PetscFunctionReturn(0); 7282306894acSVaclav Hapla } 7283306894acSVaclav Hapla 7284c58f1c22SToby Isaac /*@C 7285c58f1c22SToby Isaac DMGetLabelOutput - Get the output flag for a given label 7286c58f1c22SToby Isaac 7287c58f1c22SToby Isaac Not Collective 7288c58f1c22SToby Isaac 7289c58f1c22SToby Isaac Input Parameters: 7290c58f1c22SToby Isaac + dm - The DM object 7291c58f1c22SToby Isaac - name - The label name 7292c58f1c22SToby Isaac 7293c58f1c22SToby Isaac Output Parameter: 7294c58f1c22SToby Isaac . output - The flag for output 7295c58f1c22SToby Isaac 7296c58f1c22SToby Isaac Level: developer 7297c58f1c22SToby Isaac 7298c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7299c58f1c22SToby Isaac @*/ 7300c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output) 7301c58f1c22SToby Isaac { 73025d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7303d67d17b1SMatthew G. Knepley const char *lname; 7304c58f1c22SToby Isaac PetscErrorCode ierr; 7305c58f1c22SToby Isaac 7306c58f1c22SToby Isaac PetscFunctionBegin; 7307c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7308c58f1c22SToby Isaac PetscValidPointer(name, 2); 7309c58f1c22SToby Isaac PetscValidPointer(output, 3); 7310c58f1c22SToby Isaac while (next) { 7311c58f1c22SToby Isaac PetscBool flg; 7312c58f1c22SToby Isaac 7313d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 7314d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 7315c58f1c22SToby Isaac if (flg) {*output = next->output; PetscFunctionReturn(0);} 7316c58f1c22SToby Isaac next = next->next; 7317c58f1c22SToby Isaac } 7318c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 7319c58f1c22SToby Isaac } 7320c58f1c22SToby Isaac 7321c58f1c22SToby Isaac /*@C 7322c58f1c22SToby Isaac DMSetLabelOutput - Set the output flag for a given label 7323c58f1c22SToby Isaac 7324c58f1c22SToby Isaac Not Collective 7325c58f1c22SToby Isaac 7326c58f1c22SToby Isaac Input Parameters: 7327c58f1c22SToby Isaac + dm - The DM object 7328c58f1c22SToby Isaac . name - The label name 7329c58f1c22SToby Isaac - output - The flag for output 7330c58f1c22SToby Isaac 7331c58f1c22SToby Isaac Level: developer 7332c58f1c22SToby Isaac 7333c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7334c58f1c22SToby Isaac @*/ 7335c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output) 7336c58f1c22SToby Isaac { 73375d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7338d67d17b1SMatthew G. Knepley const char *lname; 7339c58f1c22SToby Isaac PetscErrorCode ierr; 7340c58f1c22SToby Isaac 7341c58f1c22SToby Isaac PetscFunctionBegin; 7342c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7343534a8f05SLisandro Dalcin PetscValidCharPointer(name, 2); 7344c58f1c22SToby Isaac while (next) { 7345c58f1c22SToby Isaac PetscBool flg; 7346c58f1c22SToby Isaac 7347d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 7348d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 7349c58f1c22SToby Isaac if (flg) {next->output = output; PetscFunctionReturn(0);} 7350c58f1c22SToby Isaac next = next->next; 7351c58f1c22SToby Isaac } 7352c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 7353c58f1c22SToby Isaac } 7354c58f1c22SToby Isaac 7355c58f1c22SToby Isaac /*@ 7356c58f1c22SToby Isaac DMCopyLabels - Copy labels from one mesh to another with a superset of the points 7357c58f1c22SToby Isaac 7358d083f849SBarry Smith Collective on dmA 7359c58f1c22SToby Isaac 7360c58f1c22SToby Isaac Input Parameter: 73615d80c0bfSVaclav Hapla + dmA - The DM object with initial labels 73622e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels 73635d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES) 73645d80c0bfSVaclav Hapla - all - Copy all labels including "depth" and "dim" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE) 7365c58f1c22SToby Isaac 7366c58f1c22SToby Isaac Level: intermediate 7367c58f1c22SToby Isaac 7368c58f1c22SToby Isaac Note: This is typically used when interpolating or otherwise adding to a mesh 7369c58f1c22SToby Isaac 73705d80c0bfSVaclav Hapla .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection(), DMShareLabels() 7371c58f1c22SToby Isaac @*/ 73725d80c0bfSVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all) 7373c58f1c22SToby Isaac { 7374c58f1c22SToby Isaac DMLabel label, labelNew; 7375c58f1c22SToby Isaac const char *name; 7376c58f1c22SToby Isaac PetscBool flg; 73775d80c0bfSVaclav Hapla DMLabelLink link; 73785d80c0bfSVaclav Hapla PetscErrorCode ierr; 7379c58f1c22SToby Isaac 73805d80c0bfSVaclav Hapla PetscFunctionBegin; 73815d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmA, DM_CLASSID, 1); 73825d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmB, DM_CLASSID, 2); 73835d80c0bfSVaclav Hapla PetscValidLogicalCollectiveEnum(dmA, mode,3); 73845d80c0bfSVaclav Hapla PetscValidLogicalCollectiveBool(dmA, all, 4); 73855d80c0bfSVaclav Hapla if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects"); 73865d80c0bfSVaclav Hapla if (dmA == dmB) PetscFunctionReturn(0); 73875d80c0bfSVaclav Hapla for (link=dmA->labels; link; link=link->next) { 73885d80c0bfSVaclav Hapla label=link->label; 73895d80c0bfSVaclav Hapla ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr); 73905d80c0bfSVaclav Hapla if (!all) { 7391c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr); 7392c58f1c22SToby Isaac if (flg) continue; 73937d5acc75SStefano Zampini ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr); 73947d5acc75SStefano Zampini if (flg) continue; 73955d80c0bfSVaclav Hapla } else { 73965d80c0bfSVaclav Hapla dmB->depthLabel = dmA->depthLabel; 73975d80c0bfSVaclav Hapla } 73985d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) { 7399c58f1c22SToby Isaac ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr); 74005d80c0bfSVaclav Hapla } else { 74015d80c0bfSVaclav Hapla labelNew = label; 74025d80c0bfSVaclav Hapla } 7403c58f1c22SToby Isaac ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr); 74045d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);} 7405c58f1c22SToby Isaac } 7406c58f1c22SToby Isaac PetscFunctionReturn(0); 7407c58f1c22SToby Isaac } 7408a8fb8f29SToby Isaac 7409a8fb8f29SToby Isaac /*@ 7410a8fb8f29SToby Isaac DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement 7411a8fb8f29SToby Isaac 7412a8fb8f29SToby Isaac Input Parameter: 7413a8fb8f29SToby Isaac . dm - The DM object 7414a8fb8f29SToby Isaac 7415a8fb8f29SToby Isaac Output Parameter: 7416a8fb8f29SToby Isaac . cdm - The coarse DM 7417a8fb8f29SToby Isaac 7418a8fb8f29SToby Isaac Level: intermediate 7419a8fb8f29SToby Isaac 7420a8fb8f29SToby Isaac .seealso: DMSetCoarseDM() 7421a8fb8f29SToby Isaac @*/ 7422a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm) 7423a8fb8f29SToby Isaac { 7424a8fb8f29SToby Isaac PetscFunctionBegin; 7425a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7426a8fb8f29SToby Isaac PetscValidPointer(cdm, 2); 7427a8fb8f29SToby Isaac *cdm = dm->coarseMesh; 7428a8fb8f29SToby Isaac PetscFunctionReturn(0); 7429a8fb8f29SToby Isaac } 7430a8fb8f29SToby Isaac 7431a8fb8f29SToby Isaac /*@ 7432a8fb8f29SToby Isaac DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement 7433a8fb8f29SToby Isaac 7434a8fb8f29SToby Isaac Input Parameters: 7435a8fb8f29SToby Isaac + dm - The DM object 7436a8fb8f29SToby Isaac - cdm - The coarse DM 7437a8fb8f29SToby Isaac 7438a8fb8f29SToby Isaac Level: intermediate 7439a8fb8f29SToby Isaac 7440a8fb8f29SToby Isaac .seealso: DMGetCoarseDM() 7441a8fb8f29SToby Isaac @*/ 7442a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm) 7443a8fb8f29SToby Isaac { 7444a8fb8f29SToby Isaac PetscErrorCode ierr; 7445a8fb8f29SToby Isaac 7446a8fb8f29SToby Isaac PetscFunctionBegin; 7447a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7448a8fb8f29SToby Isaac if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2); 7449a8fb8f29SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 7450a8fb8f29SToby Isaac ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr); 7451a8fb8f29SToby Isaac dm->coarseMesh = cdm; 7452a8fb8f29SToby Isaac PetscFunctionReturn(0); 7453a8fb8f29SToby Isaac } 7454a8fb8f29SToby Isaac 745588bdff64SToby Isaac /*@ 745688bdff64SToby Isaac DMGetFineDM - Get the fine mesh from which this was obtained by refinement 745788bdff64SToby Isaac 745888bdff64SToby Isaac Input Parameter: 745988bdff64SToby Isaac . dm - The DM object 746088bdff64SToby Isaac 746188bdff64SToby Isaac Output Parameter: 746288bdff64SToby Isaac . fdm - The fine DM 746388bdff64SToby Isaac 746488bdff64SToby Isaac Level: intermediate 746588bdff64SToby Isaac 746688bdff64SToby Isaac .seealso: DMSetFineDM() 746788bdff64SToby Isaac @*/ 746888bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm) 746988bdff64SToby Isaac { 747088bdff64SToby Isaac PetscFunctionBegin; 747188bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 747288bdff64SToby Isaac PetscValidPointer(fdm, 2); 747388bdff64SToby Isaac *fdm = dm->fineMesh; 747488bdff64SToby Isaac PetscFunctionReturn(0); 747588bdff64SToby Isaac } 747688bdff64SToby Isaac 747788bdff64SToby Isaac /*@ 747888bdff64SToby Isaac DMSetFineDM - Set the fine mesh from which this was obtained by refinement 747988bdff64SToby Isaac 748088bdff64SToby Isaac Input Parameters: 748188bdff64SToby Isaac + dm - The DM object 748288bdff64SToby Isaac - fdm - The fine DM 748388bdff64SToby Isaac 748488bdff64SToby Isaac Level: intermediate 748588bdff64SToby Isaac 748688bdff64SToby Isaac .seealso: DMGetFineDM() 748788bdff64SToby Isaac @*/ 748888bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm) 748988bdff64SToby Isaac { 749088bdff64SToby Isaac PetscErrorCode ierr; 749188bdff64SToby Isaac 749288bdff64SToby Isaac PetscFunctionBegin; 749388bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 749488bdff64SToby Isaac if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2); 749588bdff64SToby Isaac ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr); 749688bdff64SToby Isaac ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr); 749788bdff64SToby Isaac dm->fineMesh = fdm; 749888bdff64SToby Isaac PetscFunctionReturn(0); 749988bdff64SToby Isaac } 750088bdff64SToby Isaac 7501a6ba4734SToby Isaac /*=== DMBoundary code ===*/ 7502a6ba4734SToby Isaac 7503a6ba4734SToby Isaac PetscErrorCode DMCopyBoundary(DM dm, DM dmNew) 7504a6ba4734SToby Isaac { 7505e5e52638SMatthew G. Knepley PetscInt d; 7506a6ba4734SToby Isaac PetscErrorCode ierr; 7507a6ba4734SToby Isaac 7508a6ba4734SToby Isaac PetscFunctionBegin; 7509e5e52638SMatthew G. Knepley for (d = 0; d < dm->Nds; ++d) { 7510e5e52638SMatthew G. Knepley ierr = PetscDSCopyBoundary(dm->probs[d].ds, dmNew->probs[d].ds);CHKERRQ(ierr); 7511e5e52638SMatthew G. Knepley } 7512a6ba4734SToby Isaac PetscFunctionReturn(0); 7513a6ba4734SToby Isaac } 7514a6ba4734SToby Isaac 7515a6ba4734SToby Isaac /*@C 7516a6ba4734SToby Isaac DMAddBoundary - Add a boundary condition to the model 7517a6ba4734SToby Isaac 7518a6ba4734SToby Isaac Input Parameters: 75194c258f51SMatthew G. Knepley + dm - The DM, with a PetscDS that matches the problem being constrained 7520f971fd6bSMatthew G. Knepley . type - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 7521a6ba4734SToby Isaac . name - The BC name 7522a6ba4734SToby Isaac . labelname - The label defining constrained points 7523a6ba4734SToby Isaac . field - The field to constrain 7524e8ecbf3fSStefano Zampini . numcomps - The number of constrained field components (0 will constrain all fields) 7525a6ba4734SToby Isaac . comps - An array of constrained component numbers 7526a6ba4734SToby Isaac . bcFunc - A pointwise function giving boundary values 7527a6ba4734SToby Isaac . numids - The number of DMLabel ids for constrained points 7528a6ba4734SToby Isaac . ids - An array of ids for constrained points 7529a6ba4734SToby Isaac - ctx - An optional user context for bcFunc 7530a6ba4734SToby Isaac 7531a6ba4734SToby Isaac Options Database Keys: 7532a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 7533a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 7534a6ba4734SToby Isaac 7535a6ba4734SToby Isaac Level: developer 7536a6ba4734SToby Isaac 7537a6ba4734SToby Isaac .seealso: DMGetBoundary() 7538a6ba4734SToby Isaac @*/ 7539a30ec4eaSSatish Balay PetscErrorCode DMAddBoundary(DM dm, DMBoundaryConditionType type, const char name[], const char labelname[], PetscInt field, PetscInt numcomps, const PetscInt *comps, void (*bcFunc)(void), PetscInt numids, const PetscInt *ids, void *ctx) 7540a6ba4734SToby Isaac { 7541e5e52638SMatthew G. Knepley PetscDS ds; 7542a6ba4734SToby Isaac PetscErrorCode ierr; 7543a6ba4734SToby Isaac 7544a6ba4734SToby Isaac PetscFunctionBegin; 7545a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7546e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 7547e5e52638SMatthew G. Knepley ierr = PetscDSAddBoundary(ds, type,name, labelname, field, numcomps, comps, bcFunc, numids, ids, ctx);CHKERRQ(ierr); 7548a6ba4734SToby Isaac PetscFunctionReturn(0); 7549a6ba4734SToby Isaac } 7550a6ba4734SToby Isaac 7551a6ba4734SToby Isaac /*@ 7552a6ba4734SToby Isaac DMGetNumBoundary - Get the number of registered BC 7553a6ba4734SToby Isaac 7554a6ba4734SToby Isaac Input Parameters: 7555a6ba4734SToby Isaac . dm - The mesh object 7556a6ba4734SToby Isaac 7557a6ba4734SToby Isaac Output Parameters: 7558a6ba4734SToby Isaac . numBd - The number of BC 7559a6ba4734SToby Isaac 7560a6ba4734SToby Isaac Level: intermediate 7561a6ba4734SToby Isaac 7562a6ba4734SToby Isaac .seealso: DMAddBoundary(), DMGetBoundary() 7563a6ba4734SToby Isaac @*/ 7564a6ba4734SToby Isaac PetscErrorCode DMGetNumBoundary(DM dm, PetscInt *numBd) 7565a6ba4734SToby Isaac { 7566e5e52638SMatthew G. Knepley PetscDS ds; 756758ebd649SToby Isaac PetscErrorCode ierr; 7568a6ba4734SToby Isaac 7569a6ba4734SToby Isaac PetscFunctionBegin; 7570a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7571e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 7572e5e52638SMatthew G. Knepley ierr = PetscDSGetNumBoundary(ds, numBd);CHKERRQ(ierr); 7573a6ba4734SToby Isaac PetscFunctionReturn(0); 7574a6ba4734SToby Isaac } 7575a6ba4734SToby Isaac 7576a6ba4734SToby Isaac /*@C 75771c531cf8SMatthew G. Knepley DMGetBoundary - Get a model boundary condition 7578a6ba4734SToby Isaac 7579a6ba4734SToby Isaac Input Parameters: 7580a6ba4734SToby Isaac + dm - The mesh object 7581a6ba4734SToby Isaac - bd - The BC number 7582a6ba4734SToby Isaac 7583a6ba4734SToby Isaac Output Parameters: 7584f971fd6bSMatthew G. Knepley + type - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 7585a6ba4734SToby Isaac . name - The BC name 7586a6ba4734SToby Isaac . labelname - The label defining constrained points 7587a6ba4734SToby Isaac . field - The field to constrain 7588a6ba4734SToby Isaac . numcomps - The number of constrained field components 7589a6ba4734SToby Isaac . comps - An array of constrained component numbers 7590a6ba4734SToby Isaac . bcFunc - A pointwise function giving boundary values 7591a6ba4734SToby Isaac . numids - The number of DMLabel ids for constrained points 7592a6ba4734SToby Isaac . ids - An array of ids for constrained points 7593a6ba4734SToby Isaac - ctx - An optional user context for bcFunc 7594a6ba4734SToby Isaac 7595a6ba4734SToby Isaac Options Database Keys: 7596a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 7597a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 7598a6ba4734SToby Isaac 7599a6ba4734SToby Isaac Level: developer 7600a6ba4734SToby Isaac 7601a6ba4734SToby Isaac .seealso: DMAddBoundary() 7602a6ba4734SToby Isaac @*/ 7603a30ec4eaSSatish Balay PetscErrorCode DMGetBoundary(DM dm, PetscInt bd, DMBoundaryConditionType *type, const char **name, const char **labelname, PetscInt *field, PetscInt *numcomps, const PetscInt **comps, void (**func)(void), PetscInt *numids, const PetscInt **ids, void **ctx) 7604a6ba4734SToby Isaac { 7605e5e52638SMatthew G. Knepley PetscDS ds; 760658ebd649SToby Isaac PetscErrorCode ierr; 7607a6ba4734SToby Isaac 7608a6ba4734SToby Isaac PetscFunctionBegin; 7609a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7610e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 7611e5e52638SMatthew G. Knepley ierr = PetscDSGetBoundary(ds, bd, type, name, labelname, field, numcomps, comps, func, numids, ids, ctx);CHKERRQ(ierr); 7612a6ba4734SToby Isaac PetscFunctionReturn(0); 7613a6ba4734SToby Isaac } 7614a6ba4734SToby Isaac 7615e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm) 7616e6f8dbb6SToby Isaac { 7617e5e52638SMatthew G. Knepley PetscDS ds; 7618dff059c6SToby Isaac DMBoundary *lastnext; 7619e6f8dbb6SToby Isaac DSBoundary dsbound; 7620e6f8dbb6SToby Isaac PetscErrorCode ierr; 7621e6f8dbb6SToby Isaac 7622e6f8dbb6SToby Isaac PetscFunctionBegin; 7623e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 7624e5e52638SMatthew G. Knepley dsbound = ds->boundary; 762547a1f5adSToby Isaac if (dm->boundary) { 762647a1f5adSToby Isaac DMBoundary next = dm->boundary; 762747a1f5adSToby Isaac 762847a1f5adSToby Isaac /* quick check to see if the PetscDS has changed */ 762947a1f5adSToby Isaac if (next->dsboundary == dsbound) PetscFunctionReturn(0); 763047a1f5adSToby Isaac /* the PetscDS has changed: tear down and rebuild */ 763147a1f5adSToby Isaac while (next) { 763247a1f5adSToby Isaac DMBoundary b = next; 763347a1f5adSToby Isaac 763447a1f5adSToby Isaac next = b->next; 763547a1f5adSToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 7636a6ba4734SToby Isaac } 763747a1f5adSToby Isaac dm->boundary = NULL; 7638a6ba4734SToby Isaac } 763947a1f5adSToby Isaac 7640dff059c6SToby Isaac lastnext = &(dm->boundary); 7641e6f8dbb6SToby Isaac while (dsbound) { 7642e6f8dbb6SToby Isaac DMBoundary dmbound; 7643e6f8dbb6SToby Isaac 7644e6f8dbb6SToby Isaac ierr = PetscNew(&dmbound);CHKERRQ(ierr); 7645e6f8dbb6SToby Isaac dmbound->dsboundary = dsbound; 7646e6f8dbb6SToby Isaac ierr = DMGetLabel(dm, dsbound->labelname, &(dmbound->label));CHKERRQ(ierr); 7647994fe344SLisandro Dalcin if (!dmbound->label) {ierr = PetscInfo2(dm, "DSBoundary %s wants label %s, which is not in this dm.\n",dsbound->name,dsbound->labelname);CHKERRQ(ierr);} 764847a1f5adSToby Isaac /* push on the back instead of the front so that it is in the same order as in the PetscDS */ 7649dff059c6SToby Isaac *lastnext = dmbound; 7650dff059c6SToby Isaac lastnext = &(dmbound->next); 7651dff059c6SToby Isaac dsbound = dsbound->next; 7652a6ba4734SToby Isaac } 7653a6ba4734SToby Isaac PetscFunctionReturn(0); 7654a6ba4734SToby Isaac } 7655a6ba4734SToby Isaac 7656a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd) 7657a6ba4734SToby Isaac { 7658b95f2879SToby Isaac DMBoundary b; 7659a6ba4734SToby Isaac PetscErrorCode ierr; 7660a6ba4734SToby Isaac 7661a6ba4734SToby Isaac PetscFunctionBegin; 7662a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7663534a8f05SLisandro Dalcin PetscValidBoolPointer(isBd, 3); 7664a6ba4734SToby Isaac *isBd = PETSC_FALSE; 7665e6f8dbb6SToby Isaac ierr = DMPopulateBoundary(dm);CHKERRQ(ierr); 7666b95f2879SToby Isaac b = dm->boundary; 7667a6ba4734SToby Isaac while (b && !(*isBd)) { 7668e6f8dbb6SToby Isaac DMLabel label = b->label; 7669e6f8dbb6SToby Isaac DSBoundary dsb = b->dsboundary; 76703424c85cSToby Isaac 76713424c85cSToby Isaac if (label) { 7672a6ba4734SToby Isaac PetscInt i; 7673a6ba4734SToby Isaac 7674e6f8dbb6SToby Isaac for (i = 0; i < dsb->numids && !(*isBd); ++i) { 7675e6f8dbb6SToby Isaac ierr = DMLabelStratumHasPoint(label, dsb->ids[i], point, isBd);CHKERRQ(ierr); 7676a6ba4734SToby Isaac } 7677a6ba4734SToby Isaac } 7678a6ba4734SToby Isaac b = b->next; 7679a6ba4734SToby Isaac } 7680a6ba4734SToby Isaac PetscFunctionReturn(0); 7681a6ba4734SToby Isaac } 76824d6f44ffSToby Isaac 76834d6f44ffSToby Isaac /*@C 76844d6f44ffSToby Isaac DMProjectFunction - This projects the given function into the function space provided. 76854d6f44ffSToby Isaac 76864d6f44ffSToby Isaac Input Parameters: 76874d6f44ffSToby Isaac + dm - The DM 76880709b2feSToby Isaac . time - The time 76894d6f44ffSToby Isaac . funcs - The coordinate functions to evaluate, one per field 76904d6f44ffSToby Isaac . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 76914d6f44ffSToby Isaac - mode - The insertion mode for values 76924d6f44ffSToby Isaac 76934d6f44ffSToby Isaac Output Parameter: 76944d6f44ffSToby Isaac . X - vector 76954d6f44ffSToby Isaac 76964d6f44ffSToby Isaac Calling sequence of func: 76970709b2feSToby Isaac $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx); 76984d6f44ffSToby Isaac 76994d6f44ffSToby Isaac + dim - The spatial dimension 77004d6f44ffSToby Isaac . x - The coordinates 77014d6f44ffSToby Isaac . Nf - The number of fields 77024d6f44ffSToby Isaac . u - The output field values 77034d6f44ffSToby Isaac - ctx - optional user-defined function context 77044d6f44ffSToby Isaac 77054d6f44ffSToby Isaac Level: developer 77064d6f44ffSToby Isaac 77072716604bSToby Isaac .seealso: DMComputeL2Diff() 77084d6f44ffSToby Isaac @*/ 77090709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X) 77104d6f44ffSToby Isaac { 77114d6f44ffSToby Isaac Vec localX; 77124d6f44ffSToby Isaac PetscErrorCode ierr; 77134d6f44ffSToby Isaac 77144d6f44ffSToby Isaac PetscFunctionBegin; 77154d6f44ffSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 77164d6f44ffSToby Isaac ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 77170709b2feSToby Isaac ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 77184d6f44ffSToby Isaac ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 77194d6f44ffSToby Isaac ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 77204d6f44ffSToby Isaac ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 77214d6f44ffSToby Isaac PetscFunctionReturn(0); 77224d6f44ffSToby Isaac } 77234d6f44ffSToby Isaac 77240709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 77254d6f44ffSToby Isaac { 77264d6f44ffSToby Isaac PetscErrorCode ierr; 77274d6f44ffSToby Isaac 77284d6f44ffSToby Isaac PetscFunctionBegin; 77294d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 77304d6f44ffSToby Isaac PetscValidHeaderSpecific(localX,VEC_CLASSID,5); 77310918c465SMatthew G. Knepley if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name); 77320709b2feSToby Isaac ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 77334d6f44ffSToby Isaac PetscFunctionReturn(0); 77344d6f44ffSToby Isaac } 77354d6f44ffSToby Isaac 77362c53366bSMatthew G. Knepley PetscErrorCode DMProjectFunctionLabel(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X) 77372c53366bSMatthew G. Knepley { 77382c53366bSMatthew G. Knepley Vec localX; 77392c53366bSMatthew G. Knepley PetscErrorCode ierr; 77402c53366bSMatthew G. Knepley 77412c53366bSMatthew G. Knepley PetscFunctionBegin; 77422c53366bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 77432c53366bSMatthew G. Knepley ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 77442c53366bSMatthew G. Knepley ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 77452c53366bSMatthew G. Knepley ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 77462c53366bSMatthew G. Knepley ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 77472c53366bSMatthew G. Knepley ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 77482c53366bSMatthew G. Knepley PetscFunctionReturn(0); 77492c53366bSMatthew G. Knepley } 77502c53366bSMatthew G. Knepley 77511c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFunctionLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 77524d6f44ffSToby Isaac { 77534d6f44ffSToby Isaac PetscErrorCode ierr; 77544d6f44ffSToby Isaac 77554d6f44ffSToby Isaac PetscFunctionBegin; 77564d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 77574d6f44ffSToby Isaac PetscValidHeaderSpecific(localX,VEC_CLASSID,5); 77580918c465SMatthew G. Knepley if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name); 77591c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 77604d6f44ffSToby Isaac PetscFunctionReturn(0); 77614d6f44ffSToby Isaac } 77622716604bSToby Isaac 77638c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU, 77648c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 77658c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 77668c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 7767191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 77688c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 77698c6c5593SMatthew G. Knepley { 77708c6c5593SMatthew G. Knepley PetscErrorCode ierr; 77718c6c5593SMatthew G. Knepley 77728c6c5593SMatthew G. Knepley PetscFunctionBegin; 77738c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 77748c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localU,VEC_CLASSID,3); 77758c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 77760918c465SMatthew G. Knepley if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name); 77778c6c5593SMatthew G. Knepley ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr); 77788c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 77798c6c5593SMatthew G. Knepley } 77808c6c5593SMatthew G. Knepley 77811c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 77828c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 77838c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 77848c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 7785191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 77868c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 77878c6c5593SMatthew G. Knepley { 77888c6c5593SMatthew G. Knepley PetscErrorCode ierr; 77898c6c5593SMatthew G. Knepley 77908c6c5593SMatthew G. Knepley PetscFunctionBegin; 77918c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 77928c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localU,VEC_CLASSID,6); 77938c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localX,VEC_CLASSID,9); 77940918c465SMatthew G. Knepley if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name); 77951c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 77968c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 77978c6c5593SMatthew G. Knepley } 77988c6c5593SMatthew G. Knepley 77992716604bSToby Isaac /*@C 78002716604bSToby Isaac DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h. 78012716604bSToby Isaac 78022716604bSToby Isaac Input Parameters: 78032716604bSToby Isaac + dm - The DM 78040709b2feSToby Isaac . time - The time 78052716604bSToby Isaac . funcs - The functions to evaluate for each field component 78062716604bSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 7807574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 78082716604bSToby Isaac 78092716604bSToby Isaac Output Parameter: 78102716604bSToby Isaac . diff - The diff ||u - u_h||_2 78112716604bSToby Isaac 78122716604bSToby Isaac Level: developer 78132716604bSToby Isaac 78141189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 78152716604bSToby Isaac @*/ 78160709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff) 78172716604bSToby Isaac { 78182716604bSToby Isaac PetscErrorCode ierr; 78192716604bSToby Isaac 78202716604bSToby Isaac PetscFunctionBegin; 78212716604bSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7822b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 78230918c465SMatthew G. Knepley if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name); 78240709b2feSToby Isaac ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 78252716604bSToby Isaac PetscFunctionReturn(0); 78262716604bSToby Isaac } 7827b698f381SToby Isaac 7828b698f381SToby Isaac /*@C 7829b698f381SToby Isaac DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h. 7830b698f381SToby Isaac 7831d083f849SBarry Smith Collective on dm 7832d083f849SBarry Smith 7833b698f381SToby Isaac Input Parameters: 7834b698f381SToby Isaac + dm - The DM 7835b698f381SToby Isaac , time - The time 7836b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component 7837b698f381SToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 7838574a98acSMatthew G. Knepley . X - The coefficient vector u_h, a global vector 7839b698f381SToby Isaac - n - The vector to project along 7840b698f381SToby Isaac 7841b698f381SToby Isaac Output Parameter: 7842b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2 7843b698f381SToby Isaac 7844b698f381SToby Isaac Level: developer 7845b698f381SToby Isaac 7846b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff() 7847b698f381SToby Isaac @*/ 7848b698f381SToby Isaac PetscErrorCode DMComputeL2GradientDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], const PetscReal[], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, const PetscReal n[], PetscReal *diff) 7849b698f381SToby Isaac { 7850b698f381SToby Isaac PetscErrorCode ierr; 7851b698f381SToby Isaac 7852b698f381SToby Isaac PetscFunctionBegin; 7853b698f381SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7854b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 7855b698f381SToby Isaac if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name); 7856b698f381SToby Isaac ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr); 7857b698f381SToby Isaac PetscFunctionReturn(0); 7858b698f381SToby Isaac } 7859b698f381SToby Isaac 78602a16baeaSToby Isaac /*@C 78612a16baeaSToby Isaac DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components. 78622a16baeaSToby Isaac 7863d083f849SBarry Smith Collective on dm 7864d083f849SBarry Smith 78652a16baeaSToby Isaac Input Parameters: 78662a16baeaSToby Isaac + dm - The DM 78672a16baeaSToby Isaac . time - The time 78682a16baeaSToby Isaac . funcs - The functions to evaluate for each field component 78692a16baeaSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 7870574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 78712a16baeaSToby Isaac 78722a16baeaSToby Isaac Output Parameter: 78732a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2 78742a16baeaSToby Isaac 78752a16baeaSToby Isaac Level: developer 78762a16baeaSToby Isaac 78771189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 78782a16baeaSToby Isaac @*/ 78791189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[]) 78802a16baeaSToby Isaac { 78812a16baeaSToby Isaac PetscErrorCode ierr; 78822a16baeaSToby Isaac 78832a16baeaSToby Isaac PetscFunctionBegin; 78842a16baeaSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 78852a16baeaSToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 78860918c465SMatthew G. Knepley if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name); 78872a16baeaSToby Isaac ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 78882a16baeaSToby Isaac PetscFunctionReturn(0); 78892a16baeaSToby Isaac } 78902a16baeaSToby Isaac 7891df0b854cSToby Isaac /*@C 7892df0b854cSToby Isaac DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags. Specific implementations of DM maybe have 7893cd3c525cSToby Isaac specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN. 7894df0b854cSToby Isaac 7895df0b854cSToby Isaac Collective on dm 7896df0b854cSToby Isaac 7897df0b854cSToby Isaac Input parameters: 7898df0b854cSToby Isaac + dm - the pre-adaptation DM object 7899a1b0c543SToby Isaac - label - label with the flags 7900df0b854cSToby Isaac 7901df0b854cSToby Isaac Output parameters: 79020d1cd5e0SMatthew G. Knepley . dmAdapt - the adapted DM object: may be NULL if an adapted DM could not be produced. 7903df0b854cSToby Isaac 7904df0b854cSToby Isaac Level: intermediate 79050d1cd5e0SMatthew G. Knepley 79060d1cd5e0SMatthew G. Knepley .seealso: DMAdaptMetric(), DMCoarsen(), DMRefine() 7907df0b854cSToby Isaac @*/ 79080d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt) 7909df0b854cSToby Isaac { 7910df0b854cSToby Isaac PetscErrorCode ierr; 7911df0b854cSToby Isaac 7912df0b854cSToby Isaac PetscFunctionBegin; 7913df0b854cSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7914a1b0c543SToby Isaac PetscValidPointer(label,2); 79150d1cd5e0SMatthew G. Knepley PetscValidPointer(dmAdapt,3); 79160d1cd5e0SMatthew G. Knepley *dmAdapt = NULL; 79176f25b0d8SLisandro Dalcin if (!dm->ops->adaptlabel) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptLabel",((PetscObject)dm)->type_name); 79180d1cd5e0SMatthew G. Knepley ierr = (dm->ops->adaptlabel)(dm, label, dmAdapt);CHKERRQ(ierr); 79190d1cd5e0SMatthew G. Knepley PetscFunctionReturn(0); 79200d1cd5e0SMatthew G. Knepley } 79210d1cd5e0SMatthew G. Knepley 79220d1cd5e0SMatthew G. Knepley /*@C 79230d1cd5e0SMatthew G. Knepley DMAdaptMetric - Generates a mesh adapted to the specified metric field using the pragmatic library. 79240d1cd5e0SMatthew G. Knepley 79250d1cd5e0SMatthew G. Knepley Input Parameters: 79260d1cd5e0SMatthew G. Knepley + dm - The DM object 79270d1cd5e0SMatthew G. Knepley . metric - The metric to which the mesh is adapted, defined vertex-wise. 79286f25b0d8SLisandro Dalcin - bdLabel - Label for boundary tags, which will be preserved in the output mesh. bdLabel should be NULL if there is no such label, and should be different from "_boundary_". 79290d1cd5e0SMatthew G. Knepley 79300d1cd5e0SMatthew G. Knepley Output Parameter: 79310d1cd5e0SMatthew G. Knepley . dmAdapt - Pointer to the DM object containing the adapted mesh 79320d1cd5e0SMatthew G. Knepley 79330d1cd5e0SMatthew G. Knepley Note: The label in the adapted mesh will be registered under the name of the input DMLabel object 79340d1cd5e0SMatthew G. Knepley 79350d1cd5e0SMatthew G. Knepley Level: advanced 79360d1cd5e0SMatthew G. Knepley 79370d1cd5e0SMatthew G. Knepley .seealso: DMAdaptLabel(), DMCoarsen(), DMRefine() 79380d1cd5e0SMatthew G. Knepley @*/ 79390d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DM *dmAdapt) 79400d1cd5e0SMatthew G. Knepley { 79410d1cd5e0SMatthew G. Knepley PetscErrorCode ierr; 79420d1cd5e0SMatthew G. Knepley 79430d1cd5e0SMatthew G. Knepley PetscFunctionBegin; 79440d1cd5e0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 79450d1cd5e0SMatthew G. Knepley PetscValidHeaderSpecific(metric, VEC_CLASSID, 2); 79460d1cd5e0SMatthew G. Knepley if (bdLabel) PetscValidPointer(bdLabel, 3); 79470d1cd5e0SMatthew G. Knepley PetscValidPointer(dmAdapt, 4); 79486f25b0d8SLisandro Dalcin *dmAdapt = NULL; 79496f25b0d8SLisandro Dalcin if (!dm->ops->adaptmetric) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptMetric",((PetscObject)dm)->type_name); 79500d1cd5e0SMatthew G. Knepley ierr = (dm->ops->adaptmetric)(dm, metric, bdLabel, dmAdapt);CHKERRQ(ierr); 7951df0b854cSToby Isaac PetscFunctionReturn(0); 7952df0b854cSToby Isaac } 7953c4088d22SMatthew G. Knepley 7954502a2867SDave May /*@C 7955502a2867SDave May DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors 7956502a2867SDave May 7957502a2867SDave May Not Collective 7958502a2867SDave May 7959502a2867SDave May Input Parameter: 7960502a2867SDave May . dm - The DM 7961502a2867SDave May 7962502a2867SDave May Output Parameter: 7963502a2867SDave May . nranks - the number of neighbours 7964502a2867SDave May . ranks - the neighbors ranks 7965502a2867SDave May 7966502a2867SDave May Notes: 7967502a2867SDave May Do not free the array, it is freed when the DM is destroyed. 7968502a2867SDave May 7969502a2867SDave May Level: beginner 7970502a2867SDave May 7971dec1416fSJunchao Zhang .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks() 7972502a2867SDave May @*/ 7973502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[]) 7974502a2867SDave May { 7975502a2867SDave May PetscErrorCode ierr; 7976502a2867SDave May 7977502a2867SDave May PetscFunctionBegin; 7978502a2867SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 79790918c465SMatthew G. Knepley if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name); 7980502a2867SDave May ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr); 7981502a2867SDave May PetscFunctionReturn(0); 7982502a2867SDave May } 7983502a2867SDave May 7984531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */ 7985531c7667SBarry Smith 7986531c7667SBarry Smith /* 7987531c7667SBarry Smith Converts the input vector to a ghosted vector and then calls the standard coloring code. 7988531c7667SBarry Smith This has be a different function because it requires DM which is not defined in the Mat library 7989531c7667SBarry Smith */ 7990531c7667SBarry Smith PetscErrorCode MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx) 7991531c7667SBarry Smith { 7992531c7667SBarry Smith PetscErrorCode ierr; 7993531c7667SBarry Smith 7994531c7667SBarry Smith PetscFunctionBegin; 7995531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 7996531c7667SBarry Smith Vec x1local; 7997531c7667SBarry Smith DM dm; 7998531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 7999531c7667SBarry Smith if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM"); 8000531c7667SBarry Smith ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr); 8001531c7667SBarry Smith ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 8002531c7667SBarry Smith ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 8003531c7667SBarry Smith x1 = x1local; 8004531c7667SBarry Smith } 8005531c7667SBarry Smith ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr); 8006531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 8007531c7667SBarry Smith DM dm; 8008531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 8009531c7667SBarry Smith ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr); 8010531c7667SBarry Smith } 8011531c7667SBarry Smith PetscFunctionReturn(0); 8012531c7667SBarry Smith } 8013531c7667SBarry Smith 8014531c7667SBarry Smith /*@ 8015531c7667SBarry Smith MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring 8016531c7667SBarry Smith 8017531c7667SBarry Smith Input Parameter: 8018531c7667SBarry Smith . coloring - the MatFDColoring object 8019531c7667SBarry Smith 802095452b02SPatrick Sanan Developer Notes: 802195452b02SPatrick Sanan this routine exists because the PETSc Mat library does not know about the DM objects 8022531c7667SBarry Smith 80231b266c99SBarry Smith Level: advanced 80241b266c99SBarry Smith 8025531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType 8026531c7667SBarry Smith @*/ 8027531c7667SBarry Smith PetscErrorCode MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring) 8028531c7667SBarry Smith { 8029531c7667SBarry Smith PetscFunctionBegin; 8030531c7667SBarry Smith coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM; 8031531c7667SBarry Smith PetscFunctionReturn(0); 8032531c7667SBarry Smith } 80338320bc6fSPatrick Sanan 80348320bc6fSPatrick Sanan /*@ 80358320bc6fSPatrick Sanan DMGetCompatibility - determine if two DMs are compatible 80368320bc6fSPatrick Sanan 80378320bc6fSPatrick Sanan Collective 80388320bc6fSPatrick Sanan 80398320bc6fSPatrick Sanan Input Parameters: 80408320bc6fSPatrick Sanan + dm - the first DM 80418320bc6fSPatrick Sanan - dm2 - the second DM 80428320bc6fSPatrick Sanan 80438320bc6fSPatrick Sanan Output Parameters: 80448320bc6fSPatrick Sanan + compatible - whether or not the two DMs are compatible 80458320bc6fSPatrick Sanan - set - whether or not the compatible value was set 80468320bc6fSPatrick Sanan 80478320bc6fSPatrick Sanan Notes: 80488320bc6fSPatrick Sanan Two DMs are deemed compatible if they represent the same parallel decomposition 80493d862458SPatrick Sanan of the same topology. This implies that the section (field data) on one 80508320bc6fSPatrick Sanan "makes sense" with respect to the topology and parallel decomposition of the other. 80513d862458SPatrick Sanan Loosely speaking, compatible DMs represent the same domain and parallel 80523d862458SPatrick Sanan decomposition, but hold different data. 80538320bc6fSPatrick Sanan 80548320bc6fSPatrick Sanan Typically, one would confirm compatibility if intending to simultaneously iterate 80558320bc6fSPatrick Sanan over a pair of vectors obtained from different DMs. 80568320bc6fSPatrick Sanan 80578320bc6fSPatrick Sanan For example, two DMDA objects are compatible if they have the same local 80588320bc6fSPatrick Sanan and global sizes and the same stencil width. They can have different numbers 80598320bc6fSPatrick Sanan of degrees of freedom per node. Thus, one could use the node numbering from 80608320bc6fSPatrick Sanan either DM in bounds for a loop over vectors derived from either DM. 80618320bc6fSPatrick Sanan 80628320bc6fSPatrick Sanan Consider the operation of summing data living on a 2-dof DMDA to data living 80638320bc6fSPatrick Sanan on a 1-dof DMDA, which should be compatible, as in the following snippet. 80648320bc6fSPatrick Sanan .vb 80658320bc6fSPatrick Sanan ... 80668320bc6fSPatrick Sanan ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr); 80678320bc6fSPatrick Sanan if (set && compatible) { 80688320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 80698320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 80703d862458SPatrick Sanan ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr); 80718320bc6fSPatrick Sanan for (j=y; j<y+n; ++j) { 80728320bc6fSPatrick Sanan for (i=x; i<x+m, ++i) { 80738320bc6fSPatrick Sanan arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1]; 80748320bc6fSPatrick Sanan } 80758320bc6fSPatrick Sanan } 80768320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 80778320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 80788320bc6fSPatrick Sanan } else { 80798320bc6fSPatrick Sanan SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible"); 80808320bc6fSPatrick Sanan } 80818320bc6fSPatrick Sanan ... 80828320bc6fSPatrick Sanan .ve 80838320bc6fSPatrick Sanan 80848320bc6fSPatrick Sanan Checking compatibility might be expensive for a given implementation of DM, 80858320bc6fSPatrick Sanan or might be impossible to unambiguously confirm or deny. For this reason, 80868320bc6fSPatrick Sanan this function may decline to determine compatibility, and hence users should 80878320bc6fSPatrick Sanan always check the "set" output parameter. 80888320bc6fSPatrick Sanan 80898320bc6fSPatrick Sanan A DM is always compatible with itself. 80908320bc6fSPatrick Sanan 80918320bc6fSPatrick Sanan In the current implementation, DMs which live on "unequal" communicators 80928320bc6fSPatrick Sanan (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed 80938320bc6fSPatrick Sanan incompatible. 80948320bc6fSPatrick Sanan 80958320bc6fSPatrick Sanan This function is labeled "Collective," as information about all subdomains 80968320bc6fSPatrick Sanan is required on each rank. However, in DM implementations which store all this 80978320bc6fSPatrick Sanan information locally, this function may be merely "Logically Collective". 80988320bc6fSPatrick Sanan 80998320bc6fSPatrick Sanan Developer Notes: 81003d862458SPatrick Sanan Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B 81013d862458SPatrick Sanan iff B is compatible with A. Thus, this function checks the implementations 81028320bc6fSPatrick Sanan of both dm and dm2 (if they are of different types), attempting to determine 81038320bc6fSPatrick Sanan compatibility. It is left to DM implementers to ensure that symmetry is 81048320bc6fSPatrick Sanan preserved. The simplest way to do this is, when implementing type-specific 81053d862458SPatrick Sanan logic for this function, is to check for existing logic in the implementation 81063d862458SPatrick Sanan of other DM types and let *set = PETSC_FALSE if found. 81078320bc6fSPatrick Sanan 81088320bc6fSPatrick Sanan Level: advanced 81098320bc6fSPatrick Sanan 81103d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag() 81118320bc6fSPatrick Sanan @*/ 81128320bc6fSPatrick Sanan 81138320bc6fSPatrick Sanan PetscErrorCode DMGetCompatibility(DM dm,DM dm2,PetscBool *compatible,PetscBool *set) 81148320bc6fSPatrick Sanan { 81158320bc6fSPatrick Sanan PetscErrorCode ierr; 81168320bc6fSPatrick Sanan PetscMPIInt compareResult; 81178320bc6fSPatrick Sanan DMType type,type2; 81188320bc6fSPatrick Sanan PetscBool sameType; 81198320bc6fSPatrick Sanan 81208320bc6fSPatrick Sanan PetscFunctionBegin; 81218320bc6fSPatrick Sanan PetscValidHeaderSpecific(dm,DM_CLASSID,1); 81228320bc6fSPatrick Sanan PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 81238320bc6fSPatrick Sanan 81248320bc6fSPatrick Sanan /* Declare a DM compatible with itself */ 81258320bc6fSPatrick Sanan if (dm == dm2) { 81268320bc6fSPatrick Sanan *set = PETSC_TRUE; 81278320bc6fSPatrick Sanan *compatible = PETSC_TRUE; 81288320bc6fSPatrick Sanan PetscFunctionReturn(0); 81298320bc6fSPatrick Sanan } 81308320bc6fSPatrick Sanan 81318320bc6fSPatrick Sanan /* Declare a DM incompatible with a DM that lives on an "unequal" 81328320bc6fSPatrick Sanan communicator. Note that this does not preclude compatibility with 81338320bc6fSPatrick Sanan DMs living on "congruent" or "similar" communicators, but this must be 81348320bc6fSPatrick Sanan determined by the implementation-specific logic */ 81358320bc6fSPatrick Sanan ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRQ(ierr); 81368320bc6fSPatrick Sanan if (compareResult == MPI_UNEQUAL) { 81378320bc6fSPatrick Sanan *set = PETSC_TRUE; 81388320bc6fSPatrick Sanan *compatible = PETSC_FALSE; 81398320bc6fSPatrick Sanan PetscFunctionReturn(0); 81408320bc6fSPatrick Sanan } 81418320bc6fSPatrick Sanan 81428320bc6fSPatrick Sanan /* Pass to the implementation-specific routine, if one exists. */ 81438320bc6fSPatrick Sanan if (dm->ops->getcompatibility) { 81448320bc6fSPatrick Sanan ierr = (*dm->ops->getcompatibility)(dm,dm2,compatible,set);CHKERRQ(ierr); 8145b9d85ea2SLisandro Dalcin if (*set) PetscFunctionReturn(0); 81468320bc6fSPatrick Sanan } 81478320bc6fSPatrick Sanan 81488320bc6fSPatrick Sanan /* If dm and dm2 are of different types, then attempt to check compatibility 81498320bc6fSPatrick Sanan with an implementation of this function from dm2 */ 81508320bc6fSPatrick Sanan ierr = DMGetType(dm,&type);CHKERRQ(ierr); 81518320bc6fSPatrick Sanan ierr = DMGetType(dm2,&type2);CHKERRQ(ierr); 81528320bc6fSPatrick Sanan ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr); 81538320bc6fSPatrick Sanan if (!sameType && dm2->ops->getcompatibility) { 81548320bc6fSPatrick Sanan ierr = (*dm2->ops->getcompatibility)(dm2,dm,compatible,set);CHKERRQ(ierr); /* Note argument order */ 81558320bc6fSPatrick Sanan } else { 81568320bc6fSPatrick Sanan *set = PETSC_FALSE; 81578320bc6fSPatrick Sanan } 81588320bc6fSPatrick Sanan PetscFunctionReturn(0); 81598320bc6fSPatrick Sanan } 8160