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> 50c312b8eSJed Brown #include <petscsf.h> 62764a2aaSMatthew G. Knepley #include <petscds.h> 747c6ae99SBarry Smith 8732e2eb9SMatthew G Knepley PetscClassId DM_CLASSID; 91ac00216SMatthew G. Knepley PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_Refine, DM_CreateInterpolation, DM_CreateRestriction; 1067a56275SMatthew G Knepley 11bff4a2f0SMatthew G. Knepley const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DM_BOUNDARY_",0}; 12bff4a2f0SMatthew G. Knepley 13a4121054SBarry Smith /*@ 14de043629SMatthew G Knepley DMCreate - Creates an empty DM object. The type can then be set with DMSetType(). 15a4121054SBarry Smith 16a4121054SBarry Smith If you never call DMSetType() it will generate an 17a4121054SBarry Smith error when you try to use the vector. 18a4121054SBarry Smith 19a4121054SBarry Smith Collective on MPI_Comm 20a4121054SBarry Smith 21a4121054SBarry Smith Input Parameter: 22a4121054SBarry Smith . comm - The communicator for the DM object 23a4121054SBarry Smith 24a4121054SBarry Smith Output Parameter: 25a4121054SBarry Smith . dm - The DM object 26a4121054SBarry Smith 27a4121054SBarry Smith Level: beginner 28a4121054SBarry Smith 298472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK 30a4121054SBarry Smith @*/ 317087cfbeSBarry Smith PetscErrorCode DMCreate(MPI_Comm comm,DM *dm) 32a4121054SBarry Smith { 33a4121054SBarry Smith DM v; 34a4121054SBarry Smith PetscErrorCode ierr; 35a4121054SBarry Smith 36a4121054SBarry Smith PetscFunctionBegin; 371411c6eeSJed Brown PetscValidPointer(dm,2); 380298fd71SBarry Smith *dm = NULL; 398b984314SMatthew G. Knepley ierr = PetscSysInitializePackage();CHKERRQ(ierr); 40607a6623SBarry Smith ierr = VecInitializePackage();CHKERRQ(ierr); 41607a6623SBarry Smith ierr = MatInitializePackage();CHKERRQ(ierr); 42607a6623SBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 43a4121054SBarry Smith 4473107ff1SLisandro Dalcin ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr); 45e7c4fc90SDmitry Karpeev 460298fd71SBarry Smith v->ltogmap = NULL; 471411c6eeSJed Brown v->bs = 1; 48171400e9SBarry Smith v->coloringtype = IS_COLORING_GLOBAL; 4988ed4aceSMatthew G Knepley ierr = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr); 5088ed4aceSMatthew G Knepley ierr = PetscSFCreate(comm, &v->defaultSF);CHKERRQ(ierr); 51c58f1c22SToby Isaac v->labels = NULL; 52c58f1c22SToby Isaac v->depthLabel = NULL; 530298fd71SBarry Smith v->defaultSection = NULL; 540298fd71SBarry Smith v->defaultGlobalSection = NULL; 55fba222abSToby Isaac v->defaultConstraintSection = NULL; 56fba222abSToby Isaac v->defaultConstraintMat = NULL; 57c6b900c6SMatthew G. Knepley v->L = NULL; 58c6b900c6SMatthew G. Knepley v->maxCell = NULL; 595dc8c3f7SMatthew G. Knepley v->bdtype = NULL; 609a9a41abSToby Isaac v->dimEmbed = PETSC_DEFAULT; 61435a35e8SMatthew G Knepley { 62435a35e8SMatthew G Knepley PetscInt i; 63435a35e8SMatthew G Knepley for (i = 0; i < 10; ++i) { 640298fd71SBarry Smith v->nullspaceConstructors[i] = NULL; 65435a35e8SMatthew G Knepley } 66435a35e8SMatthew G Knepley } 672764a2aaSMatthew G. Knepley ierr = PetscDSCreate(comm, &v->prob);CHKERRQ(ierr); 6814f150ffSMatthew G. Knepley v->dmBC = NULL; 69a8fb8f29SToby Isaac v->coarseMesh = NULL; 70f4d763aaSMatthew G. Knepley v->outputSequenceNum = -1; 71cdb7a50dSMatthew G. Knepley v->outputSequenceVal = 0.0; 72c0dedaeaSBarry Smith ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr); 73b412c318SBarry Smith ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr); 74bcc5ffd9SToby Isaac ierr = PetscNew(&(v->labels));CHKERRQ(ierr); 75c58f1c22SToby Isaac v->labels->refct = 1; 761411c6eeSJed Brown *dm = v; 77a4121054SBarry Smith PetscFunctionReturn(0); 78a4121054SBarry Smith } 79a4121054SBarry Smith 8038221697SMatthew G. Knepley /*@ 8138221697SMatthew G. Knepley DMClone - Creates a DM object with the same topology as the original. 8238221697SMatthew G. Knepley 8338221697SMatthew G. Knepley Collective on MPI_Comm 8438221697SMatthew G. Knepley 8538221697SMatthew G. Knepley Input Parameter: 8638221697SMatthew G. Knepley . dm - The original DM object 8738221697SMatthew G. Knepley 8838221697SMatthew G. Knepley Output Parameter: 8938221697SMatthew G. Knepley . newdm - The new DM object 9038221697SMatthew G. Knepley 9138221697SMatthew G. Knepley Level: beginner 9238221697SMatthew G. Knepley 9338221697SMatthew G. Knepley .keywords: DM, topology, create 9438221697SMatthew G. Knepley @*/ 9538221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm) 9638221697SMatthew G. Knepley { 9738221697SMatthew G. Knepley PetscSF sf; 9838221697SMatthew G. Knepley Vec coords; 9938221697SMatthew G. Knepley void *ctx; 100a3219837SMatthew G. Knepley PetscInt dim, cdim; 10138221697SMatthew G. Knepley PetscErrorCode ierr; 10238221697SMatthew G. Knepley 10338221697SMatthew G. Knepley PetscFunctionBegin; 10438221697SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 10538221697SMatthew G. Knepley PetscValidPointer(newdm,2); 10638221697SMatthew G. Knepley ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr); 107c58f1c22SToby Isaac ierr = PetscFree((*newdm)->labels);CHKERRQ(ierr); 108c58f1c22SToby Isaac dm->labels->refct++; 109c58f1c22SToby Isaac (*newdm)->labels = dm->labels; 110c58f1c22SToby Isaac (*newdm)->depthLabel = dm->depthLabel; 1111de53e9aSMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 1121de53e9aSMatthew G. Knepley ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr); 11338221697SMatthew G. Knepley if (dm->ops->clone) { 11438221697SMatthew G. Knepley ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr); 11538221697SMatthew G. Knepley } 1163f22bcbcSToby Isaac (*newdm)->setupcalled = dm->setupcalled; 11738221697SMatthew G. Knepley ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr); 11838221697SMatthew G. Knepley ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr); 11938221697SMatthew G. Knepley ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr); 12038221697SMatthew G. Knepley ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr); 121be4c1c3eSMatthew G. Knepley if (dm->coordinateDM) { 122be4c1c3eSMatthew G. Knepley DM ncdm; 123be4c1c3eSMatthew G. Knepley PetscSection cs; 1245a0206caSToby Isaac PetscInt pEnd = -1, pEndMax = -1; 125be4c1c3eSMatthew G. Knepley 126be4c1c3eSMatthew G. Knepley ierr = DMGetDefaultSection(dm->coordinateDM, &cs);CHKERRQ(ierr); 127be4c1c3eSMatthew G. Knepley if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);} 1285a0206caSToby Isaac ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 1295a0206caSToby Isaac if (pEndMax >= 0) { 130be4c1c3eSMatthew G. Knepley ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr); 13113bffc4cSMatthew G. Knepley ierr = DMSetDefaultSection(ncdm, cs);CHKERRQ(ierr); 132a61e840bSMatthew G. Knepley ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr); 133be4c1c3eSMatthew G. Knepley ierr = DMDestroy(&ncdm);CHKERRQ(ierr); 134be4c1c3eSMatthew G. Knepley } 135be4c1c3eSMatthew G. Knepley } 136a3219837SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 137a3219837SMatthew G. Knepley ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr); 13838221697SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr); 13938221697SMatthew G. Knepley if (coords) { 14038221697SMatthew G. Knepley ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr); 14138221697SMatthew G. Knepley } else { 14238221697SMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 14338221697SMatthew G. Knepley if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);} 14438221697SMatthew G. Knepley } 145c6b900c6SMatthew G. Knepley if (dm->maxCell) { 146c6b900c6SMatthew G. Knepley const PetscReal *maxCell, *L; 1475dc8c3f7SMatthew G. Knepley const DMBoundaryType *bd; 1485dc8c3f7SMatthew G. Knepley ierr = DMGetPeriodicity(dm, &maxCell, &L, &bd);CHKERRQ(ierr); 1495dc8c3f7SMatthew G. Knepley ierr = DMSetPeriodicity(*newdm, maxCell, L, bd);CHKERRQ(ierr); 150c6b900c6SMatthew G. Knepley } 15138221697SMatthew G. Knepley PetscFunctionReturn(0); 15238221697SMatthew G. Knepley } 15338221697SMatthew G. Knepley 1549a42bb27SBarry Smith /*@C 155564755cdSBarry Smith DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 1569a42bb27SBarry Smith 1578472ad0fSDave May Logically Collective on DM 1589a42bb27SBarry Smith 1599a42bb27SBarry Smith Input Parameter: 1609a42bb27SBarry Smith + da - initial distributed array 1618154be41SBarry Smith . ctype - the vector type, currently either VECSTANDARD or VECCUSP 1629a42bb27SBarry Smith 1639a42bb27SBarry Smith Options Database: 164dd85299cSBarry Smith . -dm_vec_type ctype 1659a42bb27SBarry Smith 1669a42bb27SBarry Smith Level: intermediate 1679a42bb27SBarry Smith 1688472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType() 1699a42bb27SBarry Smith @*/ 17019fd82e9SBarry Smith PetscErrorCode DMSetVecType(DM da,VecType ctype) 1719a42bb27SBarry Smith { 1729a42bb27SBarry Smith PetscErrorCode ierr; 1739a42bb27SBarry Smith 1749a42bb27SBarry Smith PetscFunctionBegin; 1759a42bb27SBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 1769a42bb27SBarry Smith ierr = PetscFree(da->vectype);CHKERRQ(ierr); 17719fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr); 1789a42bb27SBarry Smith PetscFunctionReturn(0); 1799a42bb27SBarry Smith } 1809a42bb27SBarry Smith 181c0dedaeaSBarry Smith /*@C 182c0dedaeaSBarry Smith DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 183c0dedaeaSBarry Smith 1848472ad0fSDave May Logically Collective on DM 185c0dedaeaSBarry Smith 186c0dedaeaSBarry Smith Input Parameter: 187c0dedaeaSBarry Smith . da - initial distributed array 188c0dedaeaSBarry Smith 189c0dedaeaSBarry Smith Output Parameter: 190c0dedaeaSBarry Smith . ctype - the vector type 191c0dedaeaSBarry Smith 192c0dedaeaSBarry Smith Level: intermediate 193c0dedaeaSBarry Smith 1948472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType 195c0dedaeaSBarry Smith @*/ 196c0dedaeaSBarry Smith PetscErrorCode DMGetVecType(DM da,VecType *ctype) 197c0dedaeaSBarry Smith { 198c0dedaeaSBarry Smith PetscFunctionBegin; 199c0dedaeaSBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 200c0dedaeaSBarry Smith *ctype = da->vectype; 201c0dedaeaSBarry Smith PetscFunctionReturn(0); 202c0dedaeaSBarry Smith } 203c0dedaeaSBarry Smith 2045f1ad066SMatthew G Knepley /*@ 20534f98d34SBarry Smith VecGetDM - Gets the DM defining the data layout of the vector 2065f1ad066SMatthew G Knepley 2075f1ad066SMatthew G Knepley Not collective 2085f1ad066SMatthew G Knepley 2095f1ad066SMatthew G Knepley Input Parameter: 2105f1ad066SMatthew G Knepley . v - The Vec 2115f1ad066SMatthew G Knepley 2125f1ad066SMatthew G Knepley Output Parameter: 2135f1ad066SMatthew G Knepley . dm - The DM 2145f1ad066SMatthew G Knepley 2155f1ad066SMatthew G Knepley Level: intermediate 2165f1ad066SMatthew G Knepley 2175f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2185f1ad066SMatthew G Knepley @*/ 2195f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm) 2205f1ad066SMatthew G Knepley { 2215f1ad066SMatthew G Knepley PetscErrorCode ierr; 2225f1ad066SMatthew G Knepley 2235f1ad066SMatthew G Knepley PetscFunctionBegin; 2245f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 2255f1ad066SMatthew G Knepley PetscValidPointer(dm,2); 2265f1ad066SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 2275f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2285f1ad066SMatthew G Knepley } 2295f1ad066SMatthew G Knepley 2305f1ad066SMatthew G Knepley /*@ 231d9805387SMatthew G. Knepley VecSetDM - Sets the DM defining the data layout of the vector. 2325f1ad066SMatthew G Knepley 2335f1ad066SMatthew G Knepley Not collective 2345f1ad066SMatthew G Knepley 2355f1ad066SMatthew G Knepley Input Parameters: 2365f1ad066SMatthew G Knepley + v - The Vec 2375f1ad066SMatthew G Knepley - dm - The DM 2385f1ad066SMatthew G Knepley 239d9805387SMatthew 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. 240d9805387SMatthew G. Knepley 2415f1ad066SMatthew G Knepley Level: intermediate 2425f1ad066SMatthew G Knepley 2435f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2445f1ad066SMatthew G Knepley @*/ 2455f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm) 2465f1ad066SMatthew G Knepley { 2475f1ad066SMatthew G Knepley PetscErrorCode ierr; 2485f1ad066SMatthew G Knepley 2495f1ad066SMatthew G Knepley PetscFunctionBegin; 2505f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 251d7f50e27SLisandro Dalcin if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 2525f1ad066SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 2535f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2545f1ad066SMatthew G Knepley } 2555f1ad066SMatthew G Knepley 256521d9a4cSLisandro Dalcin /*@C 257521d9a4cSLisandro Dalcin DMSetMatType - Sets the type of matrix created with DMCreateMatrix() 258521d9a4cSLisandro Dalcin 259521d9a4cSLisandro Dalcin Logically Collective on DM 260521d9a4cSLisandro Dalcin 261521d9a4cSLisandro Dalcin Input Parameter: 262521d9a4cSLisandro Dalcin + dm - the DM context 263a2b5a043SBarry Smith - ctype - the matrix type 264521d9a4cSLisandro Dalcin 265521d9a4cSLisandro Dalcin Options Database: 266521d9a4cSLisandro Dalcin . -dm_mat_type ctype 267521d9a4cSLisandro Dalcin 268521d9a4cSLisandro Dalcin Level: intermediate 269521d9a4cSLisandro Dalcin 270c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType() 271521d9a4cSLisandro Dalcin @*/ 27219fd82e9SBarry Smith PetscErrorCode DMSetMatType(DM dm,MatType ctype) 273521d9a4cSLisandro Dalcin { 274521d9a4cSLisandro Dalcin PetscErrorCode ierr; 27588f0584fSBarry Smith 276521d9a4cSLisandro Dalcin PetscFunctionBegin; 277521d9a4cSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 278521d9a4cSLisandro Dalcin ierr = PetscFree(dm->mattype);CHKERRQ(ierr); 27919fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr); 280521d9a4cSLisandro Dalcin PetscFunctionReturn(0); 281521d9a4cSLisandro Dalcin } 282521d9a4cSLisandro Dalcin 283c0dedaeaSBarry Smith /*@C 284c0dedaeaSBarry Smith DMGetMatType - Gets the type of matrix created with DMCreateMatrix() 285c0dedaeaSBarry Smith 286c0dedaeaSBarry Smith Logically Collective on DM 287c0dedaeaSBarry Smith 288c0dedaeaSBarry Smith Input Parameter: 289c0dedaeaSBarry Smith . dm - the DM context 290c0dedaeaSBarry Smith 291c0dedaeaSBarry Smith Output Parameter: 292c0dedaeaSBarry Smith . ctype - the matrix type 293c0dedaeaSBarry Smith 294c0dedaeaSBarry Smith Options Database: 295c0dedaeaSBarry Smith . -dm_mat_type ctype 296c0dedaeaSBarry Smith 297c0dedaeaSBarry Smith Level: intermediate 298c0dedaeaSBarry Smith 299c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType() 300c0dedaeaSBarry Smith @*/ 301c0dedaeaSBarry Smith PetscErrorCode DMGetMatType(DM dm,MatType *ctype) 302c0dedaeaSBarry Smith { 303c0dedaeaSBarry Smith PetscFunctionBegin; 304c0dedaeaSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 305c0dedaeaSBarry Smith *ctype = dm->mattype; 306c0dedaeaSBarry Smith PetscFunctionReturn(0); 307c0dedaeaSBarry Smith } 308c0dedaeaSBarry Smith 309c688c046SMatthew G Knepley /*@ 31034f98d34SBarry Smith MatGetDM - Gets the DM defining the data layout of the matrix 311c688c046SMatthew G Knepley 312c688c046SMatthew G Knepley Not collective 313c688c046SMatthew G Knepley 314c688c046SMatthew G Knepley Input Parameter: 315c688c046SMatthew G Knepley . A - The Mat 316c688c046SMatthew G Knepley 317c688c046SMatthew G Knepley Output Parameter: 318c688c046SMatthew G Knepley . dm - The DM 319c688c046SMatthew G Knepley 320c688c046SMatthew G Knepley Level: intermediate 321c688c046SMatthew G Knepley 322c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType() 323c688c046SMatthew G Knepley @*/ 324c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm) 325c688c046SMatthew G Knepley { 326c688c046SMatthew G Knepley PetscErrorCode ierr; 327c688c046SMatthew G Knepley 328c688c046SMatthew G Knepley PetscFunctionBegin; 329c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 330c688c046SMatthew G Knepley PetscValidPointer(dm,2); 331c688c046SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 332c688c046SMatthew G Knepley PetscFunctionReturn(0); 333c688c046SMatthew G Knepley } 334c688c046SMatthew G Knepley 335c688c046SMatthew G Knepley /*@ 336c688c046SMatthew G Knepley MatSetDM - Sets the DM defining the data layout of the matrix 337c688c046SMatthew G Knepley 338c688c046SMatthew G Knepley Not collective 339c688c046SMatthew G Knepley 340c688c046SMatthew G Knepley Input Parameters: 341c688c046SMatthew G Knepley + A - The Mat 342c688c046SMatthew G Knepley - dm - The DM 343c688c046SMatthew G Knepley 344c688c046SMatthew G Knepley Level: intermediate 345c688c046SMatthew G Knepley 346c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType() 347c688c046SMatthew G Knepley @*/ 348c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm) 349c688c046SMatthew G Knepley { 350c688c046SMatthew G Knepley PetscErrorCode ierr; 351c688c046SMatthew G Knepley 352c688c046SMatthew G Knepley PetscFunctionBegin; 353c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 3548865f1eaSKarl Rupp if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 355c688c046SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 356c688c046SMatthew G Knepley PetscFunctionReturn(0); 357c688c046SMatthew G Knepley } 358c688c046SMatthew G Knepley 3599a42bb27SBarry Smith /*@C 3609a42bb27SBarry Smith DMSetOptionsPrefix - Sets the prefix used for searching for all 3616757b960SDave May DM options in the database. 3629a42bb27SBarry Smith 3638353ddbbSDave May Logically Collective on DM 3649a42bb27SBarry Smith 3659a42bb27SBarry Smith Input Parameter: 3668353ddbbSDave May + da - the DM context 3679a42bb27SBarry Smith - prefix - the prefix to prepend to all option names 3689a42bb27SBarry Smith 3699a42bb27SBarry Smith Notes: 3709a42bb27SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 3719a42bb27SBarry Smith The first character of all runtime options is AUTOMATICALLY the hyphen. 3729a42bb27SBarry Smith 3739a42bb27SBarry Smith Level: advanced 3749a42bb27SBarry Smith 3758353ddbbSDave May .keywords: DM, set, options, prefix, database 3769a42bb27SBarry Smith 3779a42bb27SBarry Smith .seealso: DMSetFromOptions() 3789a42bb27SBarry Smith @*/ 3797087cfbeSBarry Smith PetscErrorCode DMSetOptionsPrefix(DM dm,const char prefix[]) 3809a42bb27SBarry Smith { 3819a42bb27SBarry Smith PetscErrorCode ierr; 3829a42bb27SBarry Smith 3839a42bb27SBarry Smith PetscFunctionBegin; 3849a42bb27SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3859a42bb27SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 386691be533SLawrence Mitchell if (dm->sf) { 387691be533SLawrence Mitchell ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr); 388691be533SLawrence Mitchell } 389691be533SLawrence Mitchell if (dm->defaultSF) { 390691be533SLawrence Mitchell ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->defaultSF,prefix);CHKERRQ(ierr); 391691be533SLawrence Mitchell } 3929a42bb27SBarry Smith PetscFunctionReturn(0); 3939a42bb27SBarry Smith } 3949a42bb27SBarry Smith 39531697293SDave May /*@C 39631697293SDave May DMAppendOptionsPrefix - Appends to the prefix used for searching for all 39731697293SDave May DM options in the database. 39831697293SDave May 39931697293SDave May Logically Collective on DM 40031697293SDave May 40131697293SDave May Input Parameters: 40231697293SDave May + dm - the DM context 40331697293SDave May - prefix - the prefix string to prepend to all DM option requests 40431697293SDave May 40531697293SDave May Notes: 40631697293SDave May A hyphen (-) must NOT be given at the beginning of the prefix name. 40731697293SDave May The first character of all runtime options is AUTOMATICALLY the hyphen. 40831697293SDave May 40931697293SDave May Level: advanced 41031697293SDave May 41131697293SDave May .keywords: DM, append, options, prefix, database 41231697293SDave May 41331697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix() 41431697293SDave May @*/ 41531697293SDave May PetscErrorCode DMAppendOptionsPrefix(DM dm,const char prefix[]) 41631697293SDave May { 41731697293SDave May PetscErrorCode ierr; 41831697293SDave May 41931697293SDave May PetscFunctionBegin; 42031697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 42131697293SDave May ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 42231697293SDave May PetscFunctionReturn(0); 42331697293SDave May } 42431697293SDave May 42531697293SDave May /*@C 42631697293SDave May DMGetOptionsPrefix - Gets the prefix used for searching for all 42731697293SDave May DM options in the database. 42831697293SDave May 42931697293SDave May Not Collective 43031697293SDave May 43131697293SDave May Input Parameters: 43231697293SDave May . dm - the DM context 43331697293SDave May 43431697293SDave May Output Parameters: 43531697293SDave May . prefix - pointer to the prefix string used is returned 43631697293SDave May 43731697293SDave May Notes: On the fortran side, the user should pass in a string 'prefix' of 43831697293SDave May sufficient length to hold the prefix. 43931697293SDave May 44031697293SDave May Level: advanced 44131697293SDave May 44231697293SDave May .keywords: DM, set, options, prefix, database 44331697293SDave May 44431697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix() 44531697293SDave May @*/ 44631697293SDave May PetscErrorCode DMGetOptionsPrefix(DM dm,const char *prefix[]) 44731697293SDave May { 44831697293SDave May PetscErrorCode ierr; 44931697293SDave May 45031697293SDave May PetscFunctionBegin; 45131697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 45231697293SDave May ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 45331697293SDave May PetscFunctionReturn(0); 45431697293SDave May } 45531697293SDave May 45688bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct) 45788bdff64SToby Isaac { 45888bdff64SToby Isaac PetscInt i, refct = ((PetscObject) dm)->refct; 45988bdff64SToby Isaac DMNamedVecLink nlink; 46088bdff64SToby Isaac PetscErrorCode ierr; 46188bdff64SToby Isaac 46288bdff64SToby Isaac PetscFunctionBegin; 46388bdff64SToby Isaac /* count all the circular references of DM and its contained Vecs */ 46488bdff64SToby Isaac for (i=0; i<DM_MAX_WORK_VECTORS; i++) { 46588bdff64SToby Isaac if (dm->localin[i]) refct--; 46688bdff64SToby Isaac if (dm->globalin[i]) refct--; 46788bdff64SToby Isaac } 46888bdff64SToby Isaac for (nlink=dm->namedglobal; nlink; nlink=nlink->next) refct--; 46988bdff64SToby Isaac for (nlink=dm->namedlocal; nlink; nlink=nlink->next) refct--; 47088bdff64SToby Isaac if (dm->x) { 47188bdff64SToby Isaac DM obj; 47288bdff64SToby Isaac ierr = VecGetDM(dm->x, &obj);CHKERRQ(ierr); 47388bdff64SToby Isaac if (obj == dm) refct--; 47488bdff64SToby Isaac } 47588bdff64SToby Isaac if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) { 47688bdff64SToby Isaac refct--; 47788bdff64SToby Isaac if (recurseCoarse) { 47888bdff64SToby Isaac PetscInt coarseCount; 47988bdff64SToby Isaac 48088bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr); 48188bdff64SToby Isaac refct += coarseCount; 48288bdff64SToby Isaac } 48388bdff64SToby Isaac } 48488bdff64SToby Isaac if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) { 48588bdff64SToby Isaac refct--; 48688bdff64SToby Isaac if (recurseFine) { 48788bdff64SToby Isaac PetscInt fineCount; 48888bdff64SToby Isaac 48988bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr); 49088bdff64SToby Isaac refct += fineCount; 49188bdff64SToby Isaac } 49288bdff64SToby Isaac } 49388bdff64SToby Isaac *ncrefct = refct; 49488bdff64SToby Isaac PetscFunctionReturn(0); 49588bdff64SToby Isaac } 49688bdff64SToby Isaac 497354557abSToby Isaac PetscErrorCode DMDestroyLabelLinkList(DM dm) 498354557abSToby Isaac { 499354557abSToby Isaac PetscErrorCode ierr; 500354557abSToby Isaac 501354557abSToby Isaac PetscFunctionBegin; 502354557abSToby Isaac if (!--(dm->labels->refct)) { 503354557abSToby Isaac DMLabelLink next = dm->labels->next; 504354557abSToby Isaac 505354557abSToby Isaac /* destroy the labels */ 506354557abSToby Isaac while (next) { 507354557abSToby Isaac DMLabelLink tmp = next->next; 508354557abSToby Isaac 509354557abSToby Isaac ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 510354557abSToby Isaac ierr = PetscFree(next);CHKERRQ(ierr); 511354557abSToby Isaac next = tmp; 512354557abSToby Isaac } 513354557abSToby Isaac ierr = PetscFree(dm->labels);CHKERRQ(ierr); 514354557abSToby Isaac } 515354557abSToby Isaac PetscFunctionReturn(0); 516354557abSToby Isaac } 517354557abSToby Isaac 51847c6ae99SBarry Smith /*@ 5198472ad0fSDave May DMDestroy - Destroys a vector packer or DM. 52047c6ae99SBarry Smith 52147c6ae99SBarry Smith Collective on DM 52247c6ae99SBarry Smith 52347c6ae99SBarry Smith Input Parameter: 52447c6ae99SBarry Smith . dm - the DM object to destroy 52547c6ae99SBarry Smith 52647c6ae99SBarry Smith Level: developer 52747c6ae99SBarry Smith 528e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 52947c6ae99SBarry Smith 53047c6ae99SBarry Smith @*/ 531fcfd50ebSBarry Smith PetscErrorCode DMDestroy(DM *dm) 53247c6ae99SBarry Smith { 53388bdff64SToby Isaac PetscInt i, cnt; 534dfe15315SJed Brown DMNamedVecLink nlink,nnext; 53547c6ae99SBarry Smith PetscErrorCode ierr; 53647c6ae99SBarry Smith 53747c6ae99SBarry Smith PetscFunctionBegin; 5386bf464f9SBarry Smith if (!*dm) PetscFunctionReturn(0); 5396bf464f9SBarry Smith PetscValidHeaderSpecific((*dm),DM_CLASSID,1); 54087e657c6SBarry Smith 54188bdff64SToby Isaac /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */ 54288bdff64SToby Isaac ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr); 54388bdff64SToby Isaac --((PetscObject)(*dm))->refct; 54488bdff64SToby Isaac if (--cnt > 0) {*dm = 0; PetscFunctionReturn(0);} 545732e2eb9SMatthew G Knepley /* 546732e2eb9SMatthew G Knepley Need this test because the dm references the vectors that 547732e2eb9SMatthew G Knepley reference the dm, so destroying the dm calls destroy on the 548732e2eb9SMatthew G Knepley vectors that cause another destroy on the dm 549732e2eb9SMatthew G Knepley */ 5506bf464f9SBarry Smith if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0); 5516bf464f9SBarry Smith ((PetscObject) (*dm))->refct = 0; 552732e2eb9SMatthew G Knepley for (i=0; i<DM_MAX_WORK_VECTORS; i++) { 5536bf464f9SBarry Smith if ((*dm)->localout[i]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Destroying a DM that has a local vector obtained with DMGetLocalVector()"); 5546bf464f9SBarry Smith ierr = VecDestroy(&(*dm)->localin[i]);CHKERRQ(ierr); 555732e2eb9SMatthew G Knepley } 556f490541aSPeter Brune nnext=(*dm)->namedglobal; 5570298fd71SBarry Smith (*dm)->namedglobal = NULL; 558f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */ 5592348bcf4SPeter Brune nnext = nlink->next; 5602348bcf4SPeter 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); 5612348bcf4SPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 5622348bcf4SPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 5632348bcf4SPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 5642348bcf4SPeter Brune } 565f490541aSPeter Brune nnext=(*dm)->namedlocal; 5660298fd71SBarry Smith (*dm)->namedlocal = NULL; 567f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */ 568f490541aSPeter Brune nnext = nlink->next; 569f490541aSPeter 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); 570f490541aSPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 571f490541aSPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 572f490541aSPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 573f490541aSPeter Brune } 5742348bcf4SPeter Brune 575b17ce1afSJed Brown /* Destroy the list of hooks */ 576c833c3b5SJed Brown { 577c833c3b5SJed Brown DMCoarsenHookLink link,next; 578b17ce1afSJed Brown for (link=(*dm)->coarsenhook; link; link=next) { 579b17ce1afSJed Brown next = link->next; 580b17ce1afSJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 581b17ce1afSJed Brown } 5820298fd71SBarry Smith (*dm)->coarsenhook = NULL; 583c833c3b5SJed Brown } 584c833c3b5SJed Brown { 585c833c3b5SJed Brown DMRefineHookLink link,next; 586c833c3b5SJed Brown for (link=(*dm)->refinehook; link; link=next) { 587c833c3b5SJed Brown next = link->next; 588c833c3b5SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 589c833c3b5SJed Brown } 5900298fd71SBarry Smith (*dm)->refinehook = NULL; 591c833c3b5SJed Brown } 592be081cd6SPeter Brune { 593be081cd6SPeter Brune DMSubDomainHookLink link,next; 594be081cd6SPeter Brune for (link=(*dm)->subdomainhook; link; link=next) { 595be081cd6SPeter Brune next = link->next; 596be081cd6SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 597be081cd6SPeter Brune } 5980298fd71SBarry Smith (*dm)->subdomainhook = NULL; 599be081cd6SPeter Brune } 600baf369e7SPeter Brune { 601baf369e7SPeter Brune DMGlobalToLocalHookLink link,next; 602baf369e7SPeter Brune for (link=(*dm)->gtolhook; link; link=next) { 603baf369e7SPeter Brune next = link->next; 604baf369e7SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 605baf369e7SPeter Brune } 6060298fd71SBarry Smith (*dm)->gtolhook = NULL; 607baf369e7SPeter Brune } 608d4d07f1eSToby Isaac { 609d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,next; 610d4d07f1eSToby Isaac for (link=(*dm)->ltoghook; link; link=next) { 611d4d07f1eSToby Isaac next = link->next; 612d4d07f1eSToby Isaac ierr = PetscFree(link);CHKERRQ(ierr); 613d4d07f1eSToby Isaac } 614d4d07f1eSToby Isaac (*dm)->ltoghook = NULL; 615d4d07f1eSToby Isaac } 616aa1993deSMatthew G Knepley /* Destroy the work arrays */ 617aa1993deSMatthew G Knepley { 618aa1993deSMatthew G Knepley DMWorkLink link,next; 619aa1993deSMatthew G Knepley if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out"); 620aa1993deSMatthew G Knepley for (link=(*dm)->workin; link; link=next) { 621aa1993deSMatthew G Knepley next = link->next; 622aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 623aa1993deSMatthew G Knepley ierr = PetscFree(link);CHKERRQ(ierr); 624aa1993deSMatthew G Knepley } 6250298fd71SBarry Smith (*dm)->workin = NULL; 626aa1993deSMatthew G Knepley } 627c58f1c22SToby Isaac if (!--((*dm)->labels->refct)) { 628c58f1c22SToby Isaac DMLabelLink next = (*dm)->labels->next; 629c58f1c22SToby Isaac 630c58f1c22SToby Isaac /* destroy the labels */ 631c58f1c22SToby Isaac while (next) { 632c58f1c22SToby Isaac DMLabelLink tmp = next->next; 633c58f1c22SToby Isaac 634c58f1c22SToby Isaac ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 635c58f1c22SToby Isaac ierr = PetscFree(next);CHKERRQ(ierr); 636c58f1c22SToby Isaac next = tmp; 637c58f1c22SToby Isaac } 638c58f1c22SToby Isaac ierr = PetscFree((*dm)->labels);CHKERRQ(ierr); 639c58f1c22SToby Isaac } 640e6f8dbb6SToby Isaac { 641e6f8dbb6SToby Isaac DMBoundary next = (*dm)->boundary; 642e6f8dbb6SToby Isaac while (next) { 643e6f8dbb6SToby Isaac DMBoundary b = next; 644e6f8dbb6SToby Isaac 645e6f8dbb6SToby Isaac next = b->next; 646e6f8dbb6SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 647e6f8dbb6SToby Isaac } 648e6f8dbb6SToby Isaac } 649b17ce1afSJed Brown 65052536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr); 65152536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr); 65252536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr); 65352536dc3SBarry Smith 6541a266240SBarry Smith if ((*dm)->ctx && (*dm)->ctxdestroy) { 6551a266240SBarry Smith ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr); 6561a266240SBarry Smith } 65787e657c6SBarry Smith ierr = VecDestroy(&(*dm)->x);CHKERRQ(ierr); 65871cd77b2SBarry Smith ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr); 6594dcab191SBarry Smith ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr); 6606bf464f9SBarry Smith ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr); 6616bf464f9SBarry Smith ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr); 662073dac72SJed Brown ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr); 66388ed4aceSMatthew G Knepley 66488ed4aceSMatthew G Knepley ierr = PetscSectionDestroy(&(*dm)->defaultSection);CHKERRQ(ierr); 66588ed4aceSMatthew G Knepley ierr = PetscSectionDestroy(&(*dm)->defaultGlobalSection);CHKERRQ(ierr); 6668b1ab98fSJed Brown ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr); 667fba222abSToby Isaac ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr); 668fba222abSToby Isaac ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr); 66988ed4aceSMatthew G Knepley ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr); 67088ed4aceSMatthew G Knepley ierr = PetscSFDestroy(&(*dm)->defaultSF);CHKERRQ(ierr); 6718e4ac7eaSMatthew G. Knepley ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr); 672af122d2aSMatthew G Knepley 67388bdff64SToby Isaac if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) { 67488bdff64SToby Isaac ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr); 67588bdff64SToby Isaac } 676a8fb8f29SToby Isaac ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr); 67788bdff64SToby Isaac if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) { 67888bdff64SToby Isaac ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr); 67988bdff64SToby Isaac } 68088bdff64SToby Isaac ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr); 6816636e97aSMatthew G Knepley ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr); 6826636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr); 6836636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr); 6845dc8c3f7SMatthew G. Knepley ierr = PetscFree3((*dm)->L,(*dm)->maxCell,(*dm)->bdtype);CHKERRQ(ierr); 6856636e97aSMatthew G Knepley 6862764a2aaSMatthew G. Knepley ierr = PetscDSDestroy(&(*dm)->prob);CHKERRQ(ierr); 68714f150ffSMatthew G. Knepley ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr); 688e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 689e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr); 690732e2eb9SMatthew G Knepley 6916bf464f9SBarry Smith ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr); 692435a35e8SMatthew G Knepley /* We do not destroy (*dm)->data here so that we can reference count backend objects */ 693732e2eb9SMatthew G Knepley ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr); 69447c6ae99SBarry Smith PetscFunctionReturn(0); 69547c6ae99SBarry Smith } 69647c6ae99SBarry Smith 697d7bf68aeSBarry Smith /*@ 698d7bf68aeSBarry Smith DMSetUp - sets up the data structures inside a DM object 699d7bf68aeSBarry Smith 700d7bf68aeSBarry Smith Collective on DM 701d7bf68aeSBarry Smith 702d7bf68aeSBarry Smith Input Parameter: 703d7bf68aeSBarry Smith . dm - the DM object to setup 704d7bf68aeSBarry Smith 705d7bf68aeSBarry Smith Level: developer 706d7bf68aeSBarry Smith 707e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 708d7bf68aeSBarry Smith 709d7bf68aeSBarry Smith @*/ 7107087cfbeSBarry Smith PetscErrorCode DMSetUp(DM dm) 711d7bf68aeSBarry Smith { 712d7bf68aeSBarry Smith PetscErrorCode ierr; 713d7bf68aeSBarry Smith 714d7bf68aeSBarry Smith PetscFunctionBegin; 715171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7168387afaaSJed Brown if (dm->setupcalled) PetscFunctionReturn(0); 717d7bf68aeSBarry Smith if (dm->ops->setup) { 718d7bf68aeSBarry Smith ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr); 719d7bf68aeSBarry Smith } 7208387afaaSJed Brown dm->setupcalled = PETSC_TRUE; 721d7bf68aeSBarry Smith PetscFunctionReturn(0); 722d7bf68aeSBarry Smith } 723d7bf68aeSBarry Smith 724d7bf68aeSBarry Smith /*@ 725d7bf68aeSBarry Smith DMSetFromOptions - sets parameters in a DM from the options database 726d7bf68aeSBarry Smith 727d7bf68aeSBarry Smith Collective on DM 728d7bf68aeSBarry Smith 729d7bf68aeSBarry Smith Input Parameter: 730d7bf68aeSBarry Smith . dm - the DM object to set options for 731d7bf68aeSBarry Smith 732732e2eb9SMatthew G Knepley Options Database: 7334164ae61SDominic Meiser + -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 7344164ae61SDominic Meiser . -dm_vec_type <type> - type of vector to create inside DM 7354164ae61SDominic Meiser . -dm_mat_type <type> - type of matrix to create inside DM 7364164ae61SDominic Meiser - -dm_coloring_type - <global or ghosted> 737732e2eb9SMatthew G Knepley 738d7bf68aeSBarry Smith Level: developer 739d7bf68aeSBarry Smith 740e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 741d7bf68aeSBarry Smith 742d7bf68aeSBarry Smith @*/ 7437087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm) 744d7bf68aeSBarry Smith { 7457781c08eSBarry Smith char typeName[256]; 746ca266f36SBarry Smith PetscBool flg; 747d7bf68aeSBarry Smith PetscErrorCode ierr; 748d7bf68aeSBarry Smith 749d7bf68aeSBarry Smith PetscFunctionBegin; 750171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 751f1fd5e65SToby Isaac if (dm->prob) { 752f1fd5e65SToby Isaac ierr = PetscDSSetFromOptions(dm->prob);CHKERRQ(ierr); 753f1fd5e65SToby Isaac } 754691be533SLawrence Mitchell if (dm->sf) { 755691be533SLawrence Mitchell ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr); 756691be533SLawrence Mitchell } 757691be533SLawrence Mitchell if (dm->defaultSF) { 758691be533SLawrence Mitchell ierr = PetscSFSetFromOptions(dm->defaultSF);CHKERRQ(ierr); 759691be533SLawrence Mitchell } 7603194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr); 7610298fd71SBarry 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); 762a264d7a6SBarry Smith ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr); 763f9ba7244SBarry Smith if (flg) { 764f9ba7244SBarry Smith ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr); 765f9ba7244SBarry Smith } 766a264d7a6SBarry 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); 767073dac72SJed Brown if (flg) { 768521d9a4cSLisandro Dalcin ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr); 769073dac72SJed Brown } 7700298fd71SBarry Smith ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","ISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr); 771f9ba7244SBarry Smith if (dm->ops->setfromoptions) { 772e55864a3SBarry Smith ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr); 773f9ba7244SBarry Smith } 774f9ba7244SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 7750633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr); 77682fcb398SMatthew G Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 777d7bf68aeSBarry Smith PetscFunctionReturn(0); 778d7bf68aeSBarry Smith } 779d7bf68aeSBarry Smith 780fc9bc008SSatish Balay /*@C 781224748a4SBarry Smith DMView - Views a DM 78247c6ae99SBarry Smith 78347c6ae99SBarry Smith Collective on DM 78447c6ae99SBarry Smith 78547c6ae99SBarry Smith Input Parameter: 78647c6ae99SBarry Smith + dm - the DM object to view 78747c6ae99SBarry Smith - v - the viewer 78847c6ae99SBarry Smith 789224748a4SBarry Smith Level: beginner 79047c6ae99SBarry Smith 791e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 79247c6ae99SBarry Smith 79347c6ae99SBarry Smith @*/ 7947087cfbeSBarry Smith PetscErrorCode DMView(DM dm,PetscViewer v) 79547c6ae99SBarry Smith { 79647c6ae99SBarry Smith PetscErrorCode ierr; 79732c0f0efSBarry Smith PetscBool isbinary; 79847c6ae99SBarry Smith 79947c6ae99SBarry Smith PetscFunctionBegin; 800171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8013014e516SBarry Smith if (!v) { 802ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr); 8033014e516SBarry Smith } 80498c3331eSBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr); 80532c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 80632c0f0efSBarry Smith if (isbinary) { 80755849f57SBarry Smith PetscInt classid = DM_FILE_CLASSID; 80832c0f0efSBarry Smith char type[256]; 80932c0f0efSBarry Smith 81032c0f0efSBarry Smith ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 81132c0f0efSBarry Smith ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr); 81232c0f0efSBarry Smith ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 81332c0f0efSBarry Smith } 8140c010503SBarry Smith if (dm->ops->view) { 8150c010503SBarry Smith ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr); 81647c6ae99SBarry Smith } 81747c6ae99SBarry Smith PetscFunctionReturn(0); 81847c6ae99SBarry Smith } 81947c6ae99SBarry Smith 82047c6ae99SBarry Smith /*@ 8218472ad0fSDave May DMCreateGlobalVector - Creates a global vector from a DM object 82247c6ae99SBarry Smith 82347c6ae99SBarry Smith Collective on DM 82447c6ae99SBarry Smith 82547c6ae99SBarry Smith Input Parameter: 82647c6ae99SBarry Smith . dm - the DM object 82747c6ae99SBarry Smith 82847c6ae99SBarry Smith Output Parameter: 82947c6ae99SBarry Smith . vec - the global vector 83047c6ae99SBarry Smith 831073dac72SJed Brown Level: beginner 83247c6ae99SBarry Smith 833e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 83447c6ae99SBarry Smith 83547c6ae99SBarry Smith @*/ 8367087cfbeSBarry Smith PetscErrorCode DMCreateGlobalVector(DM dm,Vec *vec) 83747c6ae99SBarry Smith { 83847c6ae99SBarry Smith PetscErrorCode ierr; 83947c6ae99SBarry Smith 84047c6ae99SBarry Smith PetscFunctionBegin; 841171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 84247c6ae99SBarry Smith ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr); 84347c6ae99SBarry Smith PetscFunctionReturn(0); 84447c6ae99SBarry Smith } 84547c6ae99SBarry Smith 84647c6ae99SBarry Smith /*@ 8478472ad0fSDave May DMCreateLocalVector - Creates a local vector from a DM object 84847c6ae99SBarry Smith 84947c6ae99SBarry Smith Not Collective 85047c6ae99SBarry Smith 85147c6ae99SBarry Smith Input Parameter: 85247c6ae99SBarry Smith . dm - the DM object 85347c6ae99SBarry Smith 85447c6ae99SBarry Smith Output Parameter: 85547c6ae99SBarry Smith . vec - the local vector 85647c6ae99SBarry Smith 857073dac72SJed Brown Level: beginner 85847c6ae99SBarry Smith 859e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 86047c6ae99SBarry Smith 86147c6ae99SBarry Smith @*/ 8627087cfbeSBarry Smith PetscErrorCode DMCreateLocalVector(DM dm,Vec *vec) 86347c6ae99SBarry Smith { 86447c6ae99SBarry Smith PetscErrorCode ierr; 86547c6ae99SBarry Smith 86647c6ae99SBarry Smith PetscFunctionBegin; 867171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 86847c6ae99SBarry Smith ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr); 86947c6ae99SBarry Smith PetscFunctionReturn(0); 87047c6ae99SBarry Smith } 87147c6ae99SBarry Smith 8721411c6eeSJed Brown /*@ 8731411c6eeSJed Brown DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM. 8741411c6eeSJed Brown 8751411c6eeSJed Brown Collective on DM 8761411c6eeSJed Brown 8771411c6eeSJed Brown Input Parameter: 8781411c6eeSJed Brown . dm - the DM that provides the mapping 8791411c6eeSJed Brown 8801411c6eeSJed Brown Output Parameter: 8811411c6eeSJed Brown . ltog - the mapping 8821411c6eeSJed Brown 8831411c6eeSJed Brown Level: intermediate 8841411c6eeSJed Brown 8851411c6eeSJed Brown Notes: 8861411c6eeSJed Brown This mapping can then be used by VecSetLocalToGlobalMapping() or 8871411c6eeSJed Brown MatSetLocalToGlobalMapping(). 8881411c6eeSJed Brown 889fc31e74dSBarry Smith .seealso: DMCreateLocalVector() 8901411c6eeSJed Brown @*/ 8917087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog) 8921411c6eeSJed Brown { 893bff27382SMatthew G. Knepley PetscInt bs = -1, bsLocal, bsMin, bsMax; 8941411c6eeSJed Brown PetscErrorCode ierr; 8951411c6eeSJed Brown 8961411c6eeSJed Brown PetscFunctionBegin; 8971411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8981411c6eeSJed Brown PetscValidPointer(ltog,2); 8991411c6eeSJed Brown if (!dm->ltogmap) { 90037d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 90137d0c07bSMatthew G Knepley 90237d0c07bSMatthew G Knepley ierr = DMGetDefaultSection(dm, §ion);CHKERRQ(ierr); 90337d0c07bSMatthew G Knepley if (section) { 904a974ec88SMatthew G. Knepley const PetscInt *cdofs; 90537d0c07bSMatthew G Knepley PetscInt *ltog; 906*ccf3bd66SMatthew G. Knepley PetscInt pStart, pEnd, n, p, k, l; 90737d0c07bSMatthew G Knepley 90837d0c07bSMatthew G Knepley ierr = DMGetDefaultGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 90937d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 910*ccf3bd66SMatthew G. Knepley ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr); 911*ccf3bd66SMatthew G. Knepley ierr = PetscMalloc1(n, <og);CHKERRQ(ierr); /* We want the local+overlap size */ 91237d0c07bSMatthew G Knepley for (p = pStart, l = 0; p < pEnd; ++p) { 913a974ec88SMatthew G. Knepley PetscInt bdof, cdof, dof, off, c, cind = 0; 91437d0c07bSMatthew G Knepley 91537d0c07bSMatthew G Knepley /* Should probably use constrained dofs */ 91637d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr); 917a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr); 918a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr); 91937d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr); 9201a7dc684SMatthew G. Knepley /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */ 9211a7dc684SMatthew G. Knepley bdof = cdof && (dof-cdof) ? 1 : dof; 9221a7dc684SMatthew G. Knepley if (dof) { 923b190aa46SMatthew G. Knepley if (bs < 0) {bs = bdof;} 924b190aa46SMatthew G. Knepley else if (bs != bdof) {bs = 1;} 9251a7dc684SMatthew G. Knepley } 92637d0c07bSMatthew G Knepley for (c = 0; c < dof; ++c, ++l) { 927a974ec88SMatthew G. Knepley if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c; 928a974ec88SMatthew G. Knepley else ltog[l] = (off < 0 ? -(off+1) : off) + c; 92937d0c07bSMatthew G Knepley } 93037d0c07bSMatthew G Knepley } 931bff27382SMatthew G. Knepley /* Must have same blocksize on all procs (some might have no points) */ 932bff27382SMatthew G. Knepley bsLocal = bs; 933bff27382SMatthew G. Knepley ierr = MPIU_Allreduce(&bsLocal, &bsMax, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 934bff27382SMatthew G. Knepley bsLocal = bs < 0 ? bsMax : bs; 935bff27382SMatthew G. Knepley ierr = MPIU_Allreduce(&bsLocal, &bsMin, 1, MPIU_INT, MPI_MIN, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 936bff27382SMatthew G. Knepley if (bsMin != bsMax) {bs = 1;} 937bff27382SMatthew G. Knepley else {bs = bsMax;} 9387591dbb2SMatthew G. Knepley bs = bs < 0 ? 1 : bs; 9397591dbb2SMatthew G. Knepley /* Must reduce indices by blocksize */ 940*ccf3bd66SMatthew G. Knepley if (bs > 1) { 941*ccf3bd66SMatthew G. Knepley for (l = 0, k = 0; l < n; l += bs, ++k) ltog[k] = ltog[l]/bs; 942*ccf3bd66SMatthew G. Knepley n /= bs; 943*ccf3bd66SMatthew G. Knepley } 944*ccf3bd66SMatthew G. Knepley ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr); 9453bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr); 94637d0c07bSMatthew G Knepley } else { 947184d77edSJed Brown if (!dm->ops->getlocaltoglobalmapping) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM can not create LocalToGlobalMapping"); 948184d77edSJed Brown ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr); 9491411c6eeSJed Brown } 95037d0c07bSMatthew G Knepley } 9511411c6eeSJed Brown *ltog = dm->ltogmap; 9521411c6eeSJed Brown PetscFunctionReturn(0); 9531411c6eeSJed Brown } 9541411c6eeSJed Brown 9551411c6eeSJed Brown /*@ 9561411c6eeSJed Brown DMGetBlockSize - Gets the inherent block size associated with a DM 9571411c6eeSJed Brown 9581411c6eeSJed Brown Not Collective 9591411c6eeSJed Brown 9601411c6eeSJed Brown Input Parameter: 9611411c6eeSJed Brown . dm - the DM with block structure 9621411c6eeSJed Brown 9631411c6eeSJed Brown Output Parameter: 9641411c6eeSJed Brown . bs - the block size, 1 implies no exploitable block structure 9651411c6eeSJed Brown 9661411c6eeSJed Brown Level: intermediate 9671411c6eeSJed Brown 968fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping() 9691411c6eeSJed Brown @*/ 9707087cfbeSBarry Smith PetscErrorCode DMGetBlockSize(DM dm,PetscInt *bs) 9711411c6eeSJed Brown { 9721411c6eeSJed Brown PetscFunctionBegin; 9731411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9741411c6eeSJed Brown PetscValidPointer(bs,2); 9751411c6eeSJed 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"); 9761411c6eeSJed Brown *bs = dm->bs; 9771411c6eeSJed Brown PetscFunctionReturn(0); 9781411c6eeSJed Brown } 9791411c6eeSJed Brown 98047c6ae99SBarry Smith /*@ 9818472ad0fSDave May DMCreateInterpolation - Gets interpolation matrix between two DM objects 98247c6ae99SBarry Smith 98347c6ae99SBarry Smith Collective on DM 98447c6ae99SBarry Smith 98547c6ae99SBarry Smith Input Parameter: 98647c6ae99SBarry Smith + dm1 - the DM object 98747c6ae99SBarry Smith - dm2 - the second, finer DM object 98847c6ae99SBarry Smith 98947c6ae99SBarry Smith Output Parameter: 99047c6ae99SBarry Smith + mat - the interpolation 99147c6ae99SBarry Smith - vec - the scaling (optional) 99247c6ae99SBarry Smith 99347c6ae99SBarry Smith Level: developer 99447c6ae99SBarry Smith 99585afcc9aSBarry Smith Notes: For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 99685afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 997d52bd9f3SBarry Smith 9981f588964SMatthew G Knepley For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors 999d52bd9f3SBarry Smith EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic. 100085afcc9aSBarry Smith 100185afcc9aSBarry Smith 10023ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction() 100347c6ae99SBarry Smith 100447c6ae99SBarry Smith @*/ 1005e727c939SJed Brown PetscErrorCode DMCreateInterpolation(DM dm1,DM dm2,Mat *mat,Vec *vec) 100647c6ae99SBarry Smith { 100747c6ae99SBarry Smith PetscErrorCode ierr; 100847c6ae99SBarry Smith 100947c6ae99SBarry Smith PetscFunctionBegin; 1010171400e9SBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 1011171400e9SBarry Smith PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 1012cea54e9dSPatrick Farrell ierr = PetscLogEventBegin(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr); 101325296bd5SBarry Smith ierr = (*dm1->ops->createinterpolation)(dm1,dm2,mat,vec);CHKERRQ(ierr); 1014cea54e9dSPatrick Farrell ierr = PetscLogEventEnd(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr); 101547c6ae99SBarry Smith PetscFunctionReturn(0); 101647c6ae99SBarry Smith } 101747c6ae99SBarry Smith 10183ad4599aSBarry Smith /*@ 10193ad4599aSBarry Smith DMCreateRestriction - Gets restriction matrix between two DM objects 10203ad4599aSBarry Smith 10213ad4599aSBarry Smith Collective on DM 10223ad4599aSBarry Smith 10233ad4599aSBarry Smith Input Parameter: 10243ad4599aSBarry Smith + dm1 - the DM object 10253ad4599aSBarry Smith - dm2 - the second, finer DM object 10263ad4599aSBarry Smith 10273ad4599aSBarry Smith Output Parameter: 10283ad4599aSBarry Smith . mat - the restriction 10293ad4599aSBarry Smith 10303ad4599aSBarry Smith 10313ad4599aSBarry Smith Level: developer 10323ad4599aSBarry Smith 10333ad4599aSBarry Smith Notes: For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 10343ad4599aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 10353ad4599aSBarry Smith 10363ad4599aSBarry Smith 10373ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation() 10383ad4599aSBarry Smith 10393ad4599aSBarry Smith @*/ 10403ad4599aSBarry Smith PetscErrorCode DMCreateRestriction(DM dm1,DM dm2,Mat *mat) 10413ad4599aSBarry Smith { 10423ad4599aSBarry Smith PetscErrorCode ierr; 10433ad4599aSBarry Smith 10443ad4599aSBarry Smith PetscFunctionBegin; 10453ad4599aSBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 10463ad4599aSBarry Smith PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 10473ad4599aSBarry Smith ierr = PetscLogEventBegin(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr); 10487294143fSBarry Smith if (!dm1->ops->createrestriction) SETERRQ(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DMCreateRestriction not implemented for this type"); 10493ad4599aSBarry Smith ierr = (*dm1->ops->createrestriction)(dm1,dm2,mat);CHKERRQ(ierr); 10503ad4599aSBarry Smith ierr = PetscLogEventEnd(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr); 10513ad4599aSBarry Smith PetscFunctionReturn(0); 10523ad4599aSBarry Smith } 10533ad4599aSBarry Smith 105447c6ae99SBarry Smith /*@ 10558472ad0fSDave May DMCreateInjection - Gets injection matrix between two DM objects 105647c6ae99SBarry Smith 105747c6ae99SBarry Smith Collective on DM 105847c6ae99SBarry Smith 105947c6ae99SBarry Smith Input Parameter: 106047c6ae99SBarry Smith + dm1 - the DM object 106147c6ae99SBarry Smith - dm2 - the second, finer DM object 106247c6ae99SBarry Smith 106347c6ae99SBarry Smith Output Parameter: 10646dbf9973SLawrence Mitchell . mat - the injection 106547c6ae99SBarry Smith 106647c6ae99SBarry Smith Level: developer 106747c6ae99SBarry Smith 106885afcc9aSBarry Smith Notes: For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 106985afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection. 107085afcc9aSBarry Smith 1071e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation() 107247c6ae99SBarry Smith 107347c6ae99SBarry Smith @*/ 10746dbf9973SLawrence Mitchell PetscErrorCode DMCreateInjection(DM dm1,DM dm2,Mat *mat) 107547c6ae99SBarry Smith { 107647c6ae99SBarry Smith PetscErrorCode ierr; 107747c6ae99SBarry Smith 107847c6ae99SBarry Smith PetscFunctionBegin; 1079171400e9SBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 1080171400e9SBarry Smith PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 10810c4c9125SBarry Smith if (!dm1->ops->getinjection) SETERRQ(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DMCreateInjection not implemented for this type"); 10826dbf9973SLawrence Mitchell ierr = (*dm1->ops->getinjection)(dm1,dm2,mat);CHKERRQ(ierr); 108347c6ae99SBarry Smith PetscFunctionReturn(0); 108447c6ae99SBarry Smith } 108547c6ae99SBarry Smith 1086b412c318SBarry Smith /*@ 1087b412c318SBarry Smith DMCreateColoring - Gets coloring for a DM 108847c6ae99SBarry Smith 108947c6ae99SBarry Smith Collective on DM 109047c6ae99SBarry Smith 109147c6ae99SBarry Smith Input Parameter: 109247c6ae99SBarry Smith + dm - the DM object 10935bdb020cSBarry Smith - ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL 109447c6ae99SBarry Smith 109547c6ae99SBarry Smith Output Parameter: 109647c6ae99SBarry Smith . coloring - the coloring 109747c6ae99SBarry Smith 109847c6ae99SBarry Smith Level: developer 109947c6ae99SBarry Smith 1100b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType() 110147c6ae99SBarry Smith 1102aab9d709SJed Brown @*/ 1103b412c318SBarry Smith PetscErrorCode DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring) 110447c6ae99SBarry Smith { 110547c6ae99SBarry Smith PetscErrorCode ierr; 110647c6ae99SBarry Smith 110747c6ae99SBarry Smith PetscFunctionBegin; 1108171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1109ce94432eSBarry Smith if (!dm->ops->getcoloring) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No coloring for this type of DM yet"); 1110b412c318SBarry Smith ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr); 111147c6ae99SBarry Smith PetscFunctionReturn(0); 111247c6ae99SBarry Smith } 111347c6ae99SBarry Smith 1114b412c318SBarry Smith /*@ 11158472ad0fSDave May DMCreateMatrix - Gets empty Jacobian for a DM 111647c6ae99SBarry Smith 111747c6ae99SBarry Smith Collective on DM 111847c6ae99SBarry Smith 111947c6ae99SBarry Smith Input Parameter: 1120b412c318SBarry Smith . dm - the DM object 112147c6ae99SBarry Smith 112247c6ae99SBarry Smith Output Parameter: 112347c6ae99SBarry Smith . mat - the empty Jacobian 112447c6ae99SBarry Smith 1125073dac72SJed Brown Level: beginner 112647c6ae99SBarry Smith 112794013140SBarry Smith Notes: This properly preallocates the number of nonzeros in the sparse matrix so you 112894013140SBarry Smith do not need to do it yourself. 112994013140SBarry Smith 113094013140SBarry Smith By default it also sets the nonzero structure and puts in the zero entries. To prevent setting 11317889ec69SBarry Smith the nonzero pattern call DMSetMatrixPreallocateOnly() 113294013140SBarry Smith 113394013140SBarry 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 113494013140SBarry Smith internally by PETSc. 113594013140SBarry Smith 113694013140SBarry Smith For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires 1137aa219208SBarry Smith the indices for the global numbering for DMDAs which is complicated. 113894013140SBarry Smith 1139b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType() 114047c6ae99SBarry Smith 1141aab9d709SJed Brown @*/ 1142b412c318SBarry Smith PetscErrorCode DMCreateMatrix(DM dm,Mat *mat) 114347c6ae99SBarry Smith { 114447c6ae99SBarry Smith PetscErrorCode ierr; 114547c6ae99SBarry Smith 114647c6ae99SBarry Smith PetscFunctionBegin; 1147171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1148607a6623SBarry Smith ierr = MatInitializePackage();CHKERRQ(ierr); 1149c7b7c8a4SJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1150c7b7c8a4SJed Brown PetscValidPointer(mat,3); 1151b412c318SBarry Smith ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr); 115247c6ae99SBarry Smith PetscFunctionReturn(0); 115347c6ae99SBarry Smith } 115447c6ae99SBarry Smith 1155732e2eb9SMatthew G Knepley /*@ 1156950540a4SJed Brown DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly 1157732e2eb9SMatthew G Knepley preallocated but the nonzero structure and zero values will not be set. 1158732e2eb9SMatthew G Knepley 11598472ad0fSDave May Logically Collective on DM 1160732e2eb9SMatthew G Knepley 1161732e2eb9SMatthew G Knepley Input Parameter: 1162732e2eb9SMatthew G Knepley + dm - the DM 1163732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation 1164732e2eb9SMatthew G Knepley 1165732e2eb9SMatthew G Knepley Level: developer 1166b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly() 1167732e2eb9SMatthew G Knepley @*/ 1168732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only) 1169732e2eb9SMatthew G Knepley { 1170732e2eb9SMatthew G Knepley PetscFunctionBegin; 1171732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1172732e2eb9SMatthew G Knepley dm->prealloc_only = only; 1173732e2eb9SMatthew G Knepley PetscFunctionReturn(0); 1174732e2eb9SMatthew G Knepley } 1175732e2eb9SMatthew G Knepley 1176b06ff27eSHong Zhang /*@ 1177b06ff27eSHong Zhang DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created 1178b06ff27eSHong Zhang but the array for values will not be allocated. 1179b06ff27eSHong Zhang 1180b06ff27eSHong Zhang Logically Collective on DM 1181b06ff27eSHong Zhang 1182b06ff27eSHong Zhang Input Parameter: 1183b06ff27eSHong Zhang + dm - the DM 1184b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture 1185b06ff27eSHong Zhang 1186b06ff27eSHong Zhang Level: developer 1187b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly() 1188b06ff27eSHong Zhang @*/ 1189b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only) 1190b06ff27eSHong Zhang { 1191b06ff27eSHong Zhang PetscFunctionBegin; 1192b06ff27eSHong Zhang PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1193b06ff27eSHong Zhang dm->structure_only = only; 1194b06ff27eSHong Zhang PetscFunctionReturn(0); 1195b06ff27eSHong Zhang } 1196b06ff27eSHong Zhang 1197a89ea682SMatthew G Knepley /*@C 1198aa1993deSMatthew G Knepley DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1199a89ea682SMatthew G Knepley 1200a89ea682SMatthew G Knepley Not Collective 1201a89ea682SMatthew G Knepley 1202a89ea682SMatthew G Knepley Input Parameters: 1203a89ea682SMatthew G Knepley + dm - the DM object 1204aa1993deSMatthew G Knepley . count - The minium size 1205aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT) 1206a89ea682SMatthew G Knepley 1207a89ea682SMatthew G Knepley Output Parameter: 1208a89ea682SMatthew G Knepley . array - the work array 1209a89ea682SMatthew G Knepley 1210a89ea682SMatthew G Knepley Level: developer 1211a89ea682SMatthew G Knepley 1212a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate() 1213a89ea682SMatthew G Knepley @*/ 1214aa1993deSMatthew G Knepley PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem) 1215a89ea682SMatthew G Knepley { 1216a89ea682SMatthew G Knepley PetscErrorCode ierr; 1217aa1993deSMatthew G Knepley DMWorkLink link; 1218854ce69bSBarry Smith size_t dsize; 1219a89ea682SMatthew G Knepley 1220a89ea682SMatthew G Knepley PetscFunctionBegin; 1221a89ea682SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1222aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1223aa1993deSMatthew G Knepley if (dm->workin) { 1224aa1993deSMatthew G Knepley link = dm->workin; 1225aa1993deSMatthew G Knepley dm->workin = dm->workin->next; 1226aa1993deSMatthew G Knepley } else { 1227b00a9115SJed Brown ierr = PetscNewLog(dm,&link);CHKERRQ(ierr); 1228a89ea682SMatthew G Knepley } 1229854ce69bSBarry Smith ierr = PetscDataTypeGetSize(dtype,&dsize);CHKERRQ(ierr); 1230854ce69bSBarry Smith if (dsize*count > link->bytes) { 1231aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 1232854ce69bSBarry Smith ierr = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr); 1233854ce69bSBarry Smith link->bytes = dsize*count; 1234aa1993deSMatthew G Knepley } 1235aa1993deSMatthew G Knepley link->next = dm->workout; 1236aa1993deSMatthew G Knepley dm->workout = link; 1237aa1993deSMatthew G Knepley *(void**)mem = link->mem; 1238a89ea682SMatthew G Knepley PetscFunctionReturn(0); 1239a89ea682SMatthew G Knepley } 1240a89ea682SMatthew G Knepley 1241aa1993deSMatthew G Knepley /*@C 1242aa1993deSMatthew G Knepley DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1243aa1993deSMatthew G Knepley 1244aa1993deSMatthew G Knepley Not Collective 1245aa1993deSMatthew G Knepley 1246aa1993deSMatthew G Knepley Input Parameters: 1247aa1993deSMatthew G Knepley + dm - the DM object 1248aa1993deSMatthew G Knepley . count - The minium size 1249aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT) 1250aa1993deSMatthew G Knepley 1251aa1993deSMatthew G Knepley Output Parameter: 1252aa1993deSMatthew G Knepley . array - the work array 1253aa1993deSMatthew G Knepley 1254aa1993deSMatthew G Knepley Level: developer 1255aa1993deSMatthew G Knepley 1256aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate() 1257aa1993deSMatthew G Knepley @*/ 1258aa1993deSMatthew G Knepley PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem) 1259aa1993deSMatthew G Knepley { 1260aa1993deSMatthew G Knepley DMWorkLink *p,link; 1261aa1993deSMatthew G Knepley 1262aa1993deSMatthew G Knepley PetscFunctionBegin; 1263aa1993deSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1264aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1265aa1993deSMatthew G Knepley for (p=&dm->workout; (link=*p); p=&link->next) { 1266aa1993deSMatthew G Knepley if (link->mem == *(void**)mem) { 1267aa1993deSMatthew G Knepley *p = link->next; 1268aa1993deSMatthew G Knepley link->next = dm->workin; 1269aa1993deSMatthew G Knepley dm->workin = link; 12700298fd71SBarry Smith *(void**)mem = NULL; 1271aa1993deSMatthew G Knepley PetscFunctionReturn(0); 1272aa1993deSMatthew G Knepley } 1273aa1993deSMatthew G Knepley } 1274aa1993deSMatthew G Knepley SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out"); 1275aa1993deSMatthew G Knepley } 1276e7c4fc90SDmitry Karpeev 1277435a35e8SMatthew G Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace)) 1278435a35e8SMatthew G Knepley { 1279435a35e8SMatthew G Knepley PetscFunctionBegin; 1280435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 128182f516ccSBarry Smith if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1282435a35e8SMatthew G Knepley dm->nullspaceConstructors[field] = nullsp; 1283435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1284435a35e8SMatthew G Knepley } 1285435a35e8SMatthew G Knepley 12864f3b5142SJed Brown /*@C 12874d343eeaSMatthew G Knepley DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field 12884d343eeaSMatthew G Knepley 12894d343eeaSMatthew G Knepley Not collective 12904d343eeaSMatthew G Knepley 12914d343eeaSMatthew G Knepley Input Parameter: 12924d343eeaSMatthew G Knepley . dm - the DM object 12934d343eeaSMatthew G Knepley 12944d343eeaSMatthew G Knepley Output Parameters: 12950298fd71SBarry Smith + numFields - The number of fields (or NULL if not requested) 12960298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested) 12970298fd71SBarry Smith - fields - The global indices for each field (or NULL if not requested) 12984d343eeaSMatthew G Knepley 12994d343eeaSMatthew G Knepley Level: intermediate 13004d343eeaSMatthew G Knepley 130121c9b008SJed Brown Notes: 130221c9b008SJed Brown The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 130321c9b008SJed Brown PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with 130421c9b008SJed Brown PetscFree(). 130521c9b008SJed Brown 13064d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 13074d343eeaSMatthew G Knepley @*/ 130837d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields) 13094d343eeaSMatthew G Knepley { 131037d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 13114d343eeaSMatthew G Knepley PetscErrorCode ierr; 13124d343eeaSMatthew G Knepley 13134d343eeaSMatthew G Knepley PetscFunctionBegin; 13144d343eeaSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 131569ca1f37SDmitry Karpeev if (numFields) { 131669ca1f37SDmitry Karpeev PetscValidPointer(numFields,2); 131769ca1f37SDmitry Karpeev *numFields = 0; 131869ca1f37SDmitry Karpeev } 131937d0c07bSMatthew G Knepley if (fieldNames) { 132037d0c07bSMatthew G Knepley PetscValidPointer(fieldNames,3); 13210298fd71SBarry Smith *fieldNames = NULL; 132269ca1f37SDmitry Karpeev } 132369ca1f37SDmitry Karpeev if (fields) { 132469ca1f37SDmitry Karpeev PetscValidPointer(fields,4); 13250298fd71SBarry Smith *fields = NULL; 132669ca1f37SDmitry Karpeev } 132737d0c07bSMatthew G Knepley ierr = DMGetDefaultSection(dm, §ion);CHKERRQ(ierr); 132837d0c07bSMatthew G Knepley if (section) { 132937d0c07bSMatthew G Knepley PetscInt *fieldSizes, **fieldIndices; 133037d0c07bSMatthew G Knepley PetscInt nF, f, pStart, pEnd, p; 133137d0c07bSMatthew G Knepley 133237d0c07bSMatthew G Knepley ierr = DMGetDefaultGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 133337d0c07bSMatthew G Knepley ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr); 1334dcca6d9dSJed Brown ierr = PetscMalloc2(nF,&fieldSizes,nF,&fieldIndices);CHKERRQ(ierr); 133537d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr); 133637d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 133737d0c07bSMatthew G Knepley fieldSizes[f] = 0; 133837d0c07bSMatthew G Knepley } 133937d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 134037d0c07bSMatthew G Knepley PetscInt gdof; 134137d0c07bSMatthew G Knepley 134237d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 134337d0c07bSMatthew G Knepley if (gdof > 0) { 134437d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 134537d0c07bSMatthew G Knepley PetscInt fdof, fcdof; 134637d0c07bSMatthew G Knepley 134737d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 134837d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 134937d0c07bSMatthew G Knepley fieldSizes[f] += fdof-fcdof; 135037d0c07bSMatthew G Knepley } 135137d0c07bSMatthew G Knepley } 135237d0c07bSMatthew G Knepley } 135337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 1354785e854fSJed Brown ierr = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr); 135537d0c07bSMatthew G Knepley fieldSizes[f] = 0; 135637d0c07bSMatthew G Knepley } 135737d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 135837d0c07bSMatthew G Knepley PetscInt gdof, goff; 135937d0c07bSMatthew G Knepley 136037d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 136137d0c07bSMatthew G Knepley if (gdof > 0) { 136237d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr); 136337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 136437d0c07bSMatthew G Knepley PetscInt fdof, fcdof, fc; 136537d0c07bSMatthew G Knepley 136637d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 136737d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 136837d0c07bSMatthew G Knepley for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) { 136937d0c07bSMatthew G Knepley fieldIndices[f][fieldSizes[f]] = goff++; 137037d0c07bSMatthew G Knepley } 137137d0c07bSMatthew G Knepley } 137237d0c07bSMatthew G Knepley } 137337d0c07bSMatthew G Knepley } 13748865f1eaSKarl Rupp if (numFields) *numFields = nF; 137537d0c07bSMatthew G Knepley if (fieldNames) { 1376785e854fSJed Brown ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr); 137737d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 137837d0c07bSMatthew G Knepley const char *fieldName; 137937d0c07bSMatthew G Knepley 138037d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 138137d0c07bSMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr); 138237d0c07bSMatthew G Knepley } 138337d0c07bSMatthew G Knepley } 138437d0c07bSMatthew G Knepley if (fields) { 1385785e854fSJed Brown ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr); 138637d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 138782f516ccSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr); 138837d0c07bSMatthew G Knepley } 138937d0c07bSMatthew G Knepley } 139037d0c07bSMatthew G Knepley ierr = PetscFree2(fieldSizes,fieldIndices);CHKERRQ(ierr); 13918865f1eaSKarl Rupp } else if (dm->ops->createfieldis) { 13928865f1eaSKarl Rupp ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr); 139369ca1f37SDmitry Karpeev } 13944d343eeaSMatthew G Knepley PetscFunctionReturn(0); 13954d343eeaSMatthew G Knepley } 13964d343eeaSMatthew G Knepley 139716621825SDmitry Karpeev 139816621825SDmitry Karpeev /*@C 139916621825SDmitry Karpeev DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems 140016621825SDmitry Karpeev corresponding to different fields: each IS contains the global indices of the dofs of the 140116621825SDmitry Karpeev corresponding field. The optional list of DMs define the DM for each subproblem. 1402e7c4fc90SDmitry Karpeev Generalizes DMCreateFieldIS(). 1403e7c4fc90SDmitry Karpeev 1404e7c4fc90SDmitry Karpeev Not collective 1405e7c4fc90SDmitry Karpeev 1406e7c4fc90SDmitry Karpeev Input Parameter: 1407e7c4fc90SDmitry Karpeev . dm - the DM object 1408e7c4fc90SDmitry Karpeev 1409e7c4fc90SDmitry Karpeev Output Parameters: 14100298fd71SBarry Smith + len - The number of subproblems in the field decomposition (or NULL if not requested) 14110298fd71SBarry Smith . namelist - The name for each field (or NULL if not requested) 14120298fd71SBarry Smith . islist - The global indices for each field (or NULL if not requested) 14130298fd71SBarry Smith - dmlist - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 1414e7c4fc90SDmitry Karpeev 1415e7c4fc90SDmitry Karpeev Level: intermediate 1416e7c4fc90SDmitry Karpeev 1417e7c4fc90SDmitry Karpeev Notes: 1418e7c4fc90SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 1419e7c4fc90SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 1420e7c4fc90SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 1421e7c4fc90SDmitry Karpeev 1422e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1423e7c4fc90SDmitry Karpeev @*/ 142416621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist) 1425e7c4fc90SDmitry Karpeev { 1426e7c4fc90SDmitry Karpeev PetscErrorCode ierr; 1427e7c4fc90SDmitry Karpeev 1428e7c4fc90SDmitry Karpeev PetscFunctionBegin; 1429e7c4fc90SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 14308865f1eaSKarl Rupp if (len) { 14318865f1eaSKarl Rupp PetscValidPointer(len,2); 14328865f1eaSKarl Rupp *len = 0; 14338865f1eaSKarl Rupp } 14348865f1eaSKarl Rupp if (namelist) { 14358865f1eaSKarl Rupp PetscValidPointer(namelist,3); 14368865f1eaSKarl Rupp *namelist = 0; 14378865f1eaSKarl Rupp } 14388865f1eaSKarl Rupp if (islist) { 14398865f1eaSKarl Rupp PetscValidPointer(islist,4); 14408865f1eaSKarl Rupp *islist = 0; 14418865f1eaSKarl Rupp } 14428865f1eaSKarl Rupp if (dmlist) { 14438865f1eaSKarl Rupp PetscValidPointer(dmlist,5); 14448865f1eaSKarl Rupp *dmlist = 0; 14458865f1eaSKarl Rupp } 1446f3f0edfdSDmitry Karpeev /* 1447f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 1448f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 1449f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 1450f3f0edfdSDmitry Karpeev */ 1451ce94432eSBarry Smith if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 145216621825SDmitry Karpeev if (!dm->ops->createfielddecomposition) { 1453435a35e8SMatthew G Knepley PetscSection section; 1454435a35e8SMatthew G Knepley PetscInt numFields, f; 1455435a35e8SMatthew G Knepley 1456435a35e8SMatthew G Knepley ierr = DMGetDefaultSection(dm, §ion);CHKERRQ(ierr); 1457435a35e8SMatthew G Knepley if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);} 1458435a35e8SMatthew G Knepley if (section && numFields && dm->ops->createsubdm) { 1459f25d98f1SMatthew G. Knepley if (len) *len = numFields; 146003dc3394SMatthew G. Knepley if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);} 146103dc3394SMatthew G. Knepley if (islist) {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);} 146203dc3394SMatthew G. Knepley if (dmlist) {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);} 1463435a35e8SMatthew G Knepley for (f = 0; f < numFields; ++f) { 1464435a35e8SMatthew G Knepley const char *fieldName; 1465435a35e8SMatthew G Knepley 146603dc3394SMatthew G. Knepley ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr); 146703dc3394SMatthew G. Knepley if (namelist) { 1468435a35e8SMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 1469435a35e8SMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr); 1470435a35e8SMatthew G Knepley } 147103dc3394SMatthew G. Knepley } 1472435a35e8SMatthew G Knepley } else { 147369ca1f37SDmitry Karpeev ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr); 1474e7c4fc90SDmitry Karpeev /* By default there are no DMs associated with subproblems. */ 14750298fd71SBarry Smith if (dmlist) *dmlist = NULL; 1476e7c4fc90SDmitry Karpeev } 14778865f1eaSKarl Rupp } else { 147816621825SDmitry Karpeev ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr); 147916621825SDmitry Karpeev } 148016621825SDmitry Karpeev PetscFunctionReturn(0); 148116621825SDmitry Karpeev } 148216621825SDmitry Karpeev 1483564cec59SMatthew G. Knepley /*@ 1484435a35e8SMatthew G Knepley DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in. 1485435a35e8SMatthew G Knepley The fields are defined by DMCreateFieldIS(). 1486435a35e8SMatthew G Knepley 1487435a35e8SMatthew G Knepley Not collective 1488435a35e8SMatthew G Knepley 1489435a35e8SMatthew G Knepley Input Parameters: 1490435a35e8SMatthew G Knepley + dm - the DM object 1491435a35e8SMatthew G Knepley . numFields - number of fields in this subproblem 14920298fd71SBarry Smith - len - The number of subproblems in the decomposition (or NULL if not requested) 1493435a35e8SMatthew G Knepley 1494435a35e8SMatthew G Knepley Output Parameters: 1495435a35e8SMatthew G Knepley . is - The global indices for the subproblem 1496435a35e8SMatthew G Knepley - dm - The DM for the subproblem 1497435a35e8SMatthew G Knepley 1498435a35e8SMatthew G Knepley Level: intermediate 1499435a35e8SMatthew G Knepley 1500435a35e8SMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1501435a35e8SMatthew G Knepley @*/ 1502435a35e8SMatthew G Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, PetscInt fields[], IS *is, DM *subdm) 1503435a35e8SMatthew G Knepley { 1504435a35e8SMatthew G Knepley PetscErrorCode ierr; 1505435a35e8SMatthew G Knepley 1506435a35e8SMatthew G Knepley PetscFunctionBegin; 1507435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1508435a35e8SMatthew G Knepley PetscValidPointer(fields,3); 15098865f1eaSKarl Rupp if (is) PetscValidPointer(is,4); 15108865f1eaSKarl Rupp if (subdm) PetscValidPointer(subdm,5); 1511435a35e8SMatthew G Knepley if (dm->ops->createsubdm) { 1512435a35e8SMatthew G Knepley ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr); 151382f516ccSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateSubDM implementation defined"); 1514435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1515435a35e8SMatthew G Knepley } 1516435a35e8SMatthew G Knepley 151716621825SDmitry Karpeev 151816621825SDmitry Karpeev /*@C 15198d4ac253SDmitry Karpeev DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems 15208d4ac253SDmitry Karpeev corresponding to restrictions to pairs nested subdomains: each IS contains the global 15218d4ac253SDmitry Karpeev indices of the dofs of the corresponding subdomains. The inner subdomains conceptually 15228d4ac253SDmitry Karpeev define a nonoverlapping covering, while outer subdomains can overlap. 15238d4ac253SDmitry Karpeev The optional list of DMs define the DM for each subproblem. 152416621825SDmitry Karpeev 152516621825SDmitry Karpeev Not collective 152616621825SDmitry Karpeev 152716621825SDmitry Karpeev Input Parameter: 152816621825SDmitry Karpeev . dm - the DM object 152916621825SDmitry Karpeev 153016621825SDmitry Karpeev Output Parameters: 15310298fd71SBarry Smith + len - The number of subproblems in the domain decomposition (or NULL if not requested) 15320298fd71SBarry Smith . namelist - The name for each subdomain (or NULL if not requested) 15330298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested) 15340298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested) 15350298fd71SBarry Smith - dmlist - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 153616621825SDmitry Karpeev 153716621825SDmitry Karpeev Level: intermediate 153816621825SDmitry Karpeev 153916621825SDmitry Karpeev Notes: 154016621825SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 154116621825SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 154216621825SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 154316621825SDmitry Karpeev 15448d4ac253SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateDomainDecompositionDM(), DMCreateFieldDecomposition() 154516621825SDmitry Karpeev @*/ 15468d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist) 154716621825SDmitry Karpeev { 154816621825SDmitry Karpeev PetscErrorCode ierr; 1549be081cd6SPeter Brune DMSubDomainHookLink link; 1550be081cd6SPeter Brune PetscInt i,l; 155116621825SDmitry Karpeev 155216621825SDmitry Karpeev PetscFunctionBegin; 155316621825SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 155414a18fd3SPeter Brune if (len) {PetscValidPointer(len,2); *len = 0;} 15550298fd71SBarry Smith if (namelist) {PetscValidPointer(namelist,3); *namelist = NULL;} 15560298fd71SBarry Smith if (innerislist) {PetscValidPointer(innerislist,4); *innerislist = NULL;} 15570298fd71SBarry Smith if (outerislist) {PetscValidPointer(outerislist,5); *outerislist = NULL;} 15580298fd71SBarry Smith if (dmlist) {PetscValidPointer(dmlist,6); *dmlist = NULL;} 1559f3f0edfdSDmitry Karpeev /* 1560f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 1561f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 1562f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 1563f3f0edfdSDmitry Karpeev */ 1564ce94432eSBarry Smith if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 156516621825SDmitry Karpeev if (dm->ops->createdomaindecomposition) { 1566be081cd6SPeter Brune ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr); 156714a18fd3SPeter Brune /* copy subdomain hooks and context over to the subdomain DMs */ 1568f891f5b9SPatrick Sanan if (dmlist && *dmlist) { 1569be081cd6SPeter Brune for (i = 0; i < l; i++) { 1570be081cd6SPeter Brune for (link=dm->subdomainhook; link; link=link->next) { 1571be081cd6SPeter Brune if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);} 1572be081cd6SPeter Brune } 1573648262bbSPatrick Sanan if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx; 1574e7c4fc90SDmitry Karpeev } 157514a18fd3SPeter Brune } 157614a18fd3SPeter Brune if (len) *len = l; 157714a18fd3SPeter Brune } 1578e30e807fSPeter Brune PetscFunctionReturn(0); 1579e30e807fSPeter Brune } 1580e30e807fSPeter Brune 1581e30e807fSPeter Brune 1582e30e807fSPeter Brune /*@C 1583e30e807fSPeter Brune DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector 1584e30e807fSPeter Brune 1585e30e807fSPeter Brune Not collective 1586e30e807fSPeter Brune 1587e30e807fSPeter Brune Input Parameters: 1588e30e807fSPeter Brune + dm - the DM object 1589e30e807fSPeter Brune . n - the number of subdomain scatters 1590e30e807fSPeter Brune - subdms - the local subdomains 1591e30e807fSPeter Brune 1592e30e807fSPeter Brune Output Parameters: 1593e30e807fSPeter Brune + n - the number of scatters returned 1594e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain 1595e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain 1596e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts) 1597e30e807fSPeter Brune 1598e30e807fSPeter Brune Notes: This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution 1599e30e807fSPeter Brune of general nonlinear problems with overlapping subdomain methods. While merely having index sets that enable subsets 1600e30e807fSPeter Brune of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of 1601e30e807fSPeter Brune solution and residual data. 1602e30e807fSPeter Brune 1603e30e807fSPeter Brune Level: developer 1604e30e807fSPeter Brune 1605e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1606e30e807fSPeter Brune @*/ 1607e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat) 1608e30e807fSPeter Brune { 1609e30e807fSPeter Brune PetscErrorCode ierr; 1610e30e807fSPeter Brune 1611e30e807fSPeter Brune PetscFunctionBegin; 1612e30e807fSPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1613e30e807fSPeter Brune PetscValidPointer(subdms,3); 1614e30e807fSPeter Brune if (dm->ops->createddscatters) { 1615e30e807fSPeter Brune ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr); 16166668ed41SLisandro Dalcin } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateDomainDecompositionScatter implementation defined"); 1617e7c4fc90SDmitry Karpeev PetscFunctionReturn(0); 1618e7c4fc90SDmitry Karpeev } 1619e7c4fc90SDmitry Karpeev 162047c6ae99SBarry Smith /*@ 162147c6ae99SBarry Smith DMRefine - Refines a DM object 162247c6ae99SBarry Smith 162347c6ae99SBarry Smith Collective on DM 162447c6ae99SBarry Smith 162547c6ae99SBarry Smith Input Parameter: 162647c6ae99SBarry Smith + dm - the DM object 162791d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 162847c6ae99SBarry Smith 162947c6ae99SBarry Smith Output Parameter: 16300298fd71SBarry Smith . dmf - the refined DM, or NULL 1631ae0a1c52SMatthew G Knepley 16320298fd71SBarry Smith Note: If no refinement was done, the return value is NULL 163347c6ae99SBarry Smith 163447c6ae99SBarry Smith Level: developer 163547c6ae99SBarry Smith 1636e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 163747c6ae99SBarry Smith @*/ 16387087cfbeSBarry Smith PetscErrorCode DMRefine(DM dm,MPI_Comm comm,DM *dmf) 163947c6ae99SBarry Smith { 164047c6ae99SBarry Smith PetscErrorCode ierr; 1641c833c3b5SJed Brown DMRefineHookLink link; 164247c6ae99SBarry Smith 164347c6ae99SBarry Smith PetscFunctionBegin; 1644732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 16451ac00216SMatthew G. Knepley ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 1646fef3a512SBarry Smith if (!dm->ops->refine) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM cannot refine"); 164747c6ae99SBarry Smith ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr); 16484057135bSMatthew G Knepley if (*dmf) { 164943842a1eSJed Brown (*dmf)->ops->creatematrix = dm->ops->creatematrix; 16508865f1eaSKarl Rupp 16518cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr); 16528865f1eaSKarl Rupp 1653644e2e5bSBarry Smith (*dmf)->ctx = dm->ctx; 16540598a293SJed Brown (*dmf)->leveldown = dm->leveldown; 1655656b349aSBarry Smith (*dmf)->levelup = dm->levelup + 1; 16568865f1eaSKarl Rupp 1657e4b4b23bSJed Brown ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr); 1658c833c3b5SJed Brown for (link=dm->refinehook; link; link=link->next) { 16598865f1eaSKarl Rupp if (link->refinehook) { 16608865f1eaSKarl Rupp ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr); 16618865f1eaSKarl Rupp } 1662c833c3b5SJed Brown } 1663c833c3b5SJed Brown } 16641ac00216SMatthew G. Knepley ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 1665c833c3b5SJed Brown PetscFunctionReturn(0); 1666c833c3b5SJed Brown } 1667c833c3b5SJed Brown 1668bb9467b5SJed Brown /*@C 1669c833c3b5SJed Brown DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid 1670c833c3b5SJed Brown 1671c833c3b5SJed Brown Logically Collective 1672c833c3b5SJed Brown 1673c833c3b5SJed Brown Input Arguments: 1674c833c3b5SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 1675c833c3b5SJed Brown . refinehook - function to run when setting up a coarser level 1676c833c3b5SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 16770298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 1678c833c3b5SJed Brown 1679c833c3b5SJed Brown Calling sequence of refinehook: 1680c833c3b5SJed Brown $ refinehook(DM coarse,DM fine,void *ctx); 1681c833c3b5SJed Brown 1682c833c3b5SJed Brown + coarse - coarse level DM 1683c833c3b5SJed Brown . fine - fine level DM to interpolate problem to 1684c833c3b5SJed Brown - ctx - optional user-defined function context 1685c833c3b5SJed Brown 1686c833c3b5SJed Brown Calling sequence for interphook: 1687c833c3b5SJed Brown $ interphook(DM coarse,Mat interp,DM fine,void *ctx) 1688c833c3b5SJed Brown 1689c833c3b5SJed Brown + coarse - coarse level DM 1690c833c3b5SJed Brown . interp - matrix interpolating a coarse-level solution to the finer grid 1691c833c3b5SJed Brown . fine - fine level DM to update 1692c833c3b5SJed Brown - ctx - optional user-defined function context 1693c833c3b5SJed Brown 1694c833c3b5SJed Brown Level: advanced 1695c833c3b5SJed Brown 1696c833c3b5SJed Brown Notes: 1697c833c3b5SJed Brown This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing 1698c833c3b5SJed Brown 1699c833c3b5SJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 1700c833c3b5SJed Brown 1701bb9467b5SJed Brown This function is currently not available from Fortran. 1702bb9467b5SJed Brown 1703c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 1704c833c3b5SJed Brown @*/ 1705c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 1706c833c3b5SJed Brown { 1707c833c3b5SJed Brown PetscErrorCode ierr; 1708c833c3b5SJed Brown DMRefineHookLink link,*p; 1709c833c3b5SJed Brown 1710c833c3b5SJed Brown PetscFunctionBegin; 1711c833c3b5SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 1712c833c3b5SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 171395dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 1714c833c3b5SJed Brown link->refinehook = refinehook; 1715c833c3b5SJed Brown link->interphook = interphook; 1716c833c3b5SJed Brown link->ctx = ctx; 17170298fd71SBarry Smith link->next = NULL; 1718c833c3b5SJed Brown *p = link; 1719c833c3b5SJed Brown PetscFunctionReturn(0); 1720c833c3b5SJed Brown } 1721c833c3b5SJed Brown 1722c833c3b5SJed Brown /*@ 1723c833c3b5SJed Brown DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd() 1724c833c3b5SJed Brown 1725c833c3b5SJed Brown Collective if any hooks are 1726c833c3b5SJed Brown 1727c833c3b5SJed Brown Input Arguments: 1728c833c3b5SJed Brown + coarse - coarser DM to use as a base 1729c833c3b5SJed Brown . restrct - interpolation matrix, apply using MatInterpolate() 1730c833c3b5SJed Brown - fine - finer DM to update 1731c833c3b5SJed Brown 1732c833c3b5SJed Brown Level: developer 1733c833c3b5SJed Brown 1734c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate() 1735c833c3b5SJed Brown @*/ 1736c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine) 1737c833c3b5SJed Brown { 1738c833c3b5SJed Brown PetscErrorCode ierr; 1739c833c3b5SJed Brown DMRefineHookLink link; 1740c833c3b5SJed Brown 1741c833c3b5SJed Brown PetscFunctionBegin; 1742c833c3b5SJed Brown for (link=fine->refinehook; link; link=link->next) { 17438865f1eaSKarl Rupp if (link->interphook) { 17448865f1eaSKarl Rupp ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr); 17458865f1eaSKarl Rupp } 17464057135bSMatthew G Knepley } 174747c6ae99SBarry Smith PetscFunctionReturn(0); 174847c6ae99SBarry Smith } 174947c6ae99SBarry Smith 1750eb3f98d2SBarry Smith /*@ 1751eb3f98d2SBarry Smith DMGetRefineLevel - Get's the number of refinements that have generated this DM. 1752eb3f98d2SBarry Smith 1753eb3f98d2SBarry Smith Not Collective 1754eb3f98d2SBarry Smith 1755eb3f98d2SBarry Smith Input Parameter: 1756eb3f98d2SBarry Smith . dm - the DM object 1757eb3f98d2SBarry Smith 1758eb3f98d2SBarry Smith Output Parameter: 1759eb3f98d2SBarry Smith . level - number of refinements 1760eb3f98d2SBarry Smith 1761eb3f98d2SBarry Smith Level: developer 1762eb3f98d2SBarry Smith 17636a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 1764eb3f98d2SBarry Smith 1765eb3f98d2SBarry Smith @*/ 1766eb3f98d2SBarry Smith PetscErrorCode DMGetRefineLevel(DM dm,PetscInt *level) 1767eb3f98d2SBarry Smith { 1768eb3f98d2SBarry Smith PetscFunctionBegin; 1769eb3f98d2SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1770eb3f98d2SBarry Smith *level = dm->levelup; 1771eb3f98d2SBarry Smith PetscFunctionReturn(0); 1772eb3f98d2SBarry Smith } 1773eb3f98d2SBarry Smith 1774fef3a512SBarry Smith /*@ 1775fef3a512SBarry Smith DMSetRefineLevel - Set's the number of refinements that have generated this DM. 1776fef3a512SBarry Smith 1777fef3a512SBarry Smith Not Collective 1778fef3a512SBarry Smith 1779fef3a512SBarry Smith Input Parameter: 1780fef3a512SBarry Smith + dm - the DM object 1781fef3a512SBarry Smith - level - number of refinements 1782fef3a512SBarry Smith 1783fef3a512SBarry Smith Level: advanced 1784fef3a512SBarry Smith 1785fef3a512SBarry Smith Notes: This value is used by PCMG to determine how many multigrid levels to use 1786fef3a512SBarry Smith 1787fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 1788fef3a512SBarry Smith 1789fef3a512SBarry Smith @*/ 1790fef3a512SBarry Smith PetscErrorCode DMSetRefineLevel(DM dm,PetscInt level) 1791fef3a512SBarry Smith { 1792fef3a512SBarry Smith PetscFunctionBegin; 1793fef3a512SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1794fef3a512SBarry Smith dm->levelup = level; 1795fef3a512SBarry Smith PetscFunctionReturn(0); 1796fef3a512SBarry Smith } 1797fef3a512SBarry Smith 1798bb9467b5SJed Brown /*@C 1799baf369e7SPeter Brune DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called 1800baf369e7SPeter Brune 1801baf369e7SPeter Brune Logically Collective 1802baf369e7SPeter Brune 1803baf369e7SPeter Brune Input Arguments: 1804baf369e7SPeter Brune + dm - the DM 1805baf369e7SPeter Brune . beginhook - function to run at the beginning of DMGlobalToLocalBegin() 1806baf369e7SPeter Brune . endhook - function to run after DMGlobalToLocalEnd() has completed 18070298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 1808baf369e7SPeter Brune 1809baf369e7SPeter Brune Calling sequence for beginhook: 1810baf369e7SPeter Brune $ beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 1811baf369e7SPeter Brune 1812baf369e7SPeter Brune + dm - global DM 1813baf369e7SPeter Brune . g - global vector 1814baf369e7SPeter Brune . mode - mode 1815baf369e7SPeter Brune . l - local vector 1816baf369e7SPeter Brune - ctx - optional user-defined function context 1817baf369e7SPeter Brune 1818baf369e7SPeter Brune 1819baf369e7SPeter Brune Calling sequence for endhook: 1820ec4806b8SPeter Brune $ endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 1821baf369e7SPeter Brune 1822baf369e7SPeter Brune + global - global DM 1823baf369e7SPeter Brune - ctx - optional user-defined function context 1824baf369e7SPeter Brune 1825baf369e7SPeter Brune Level: advanced 1826baf369e7SPeter Brune 1827baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 1828baf369e7SPeter Brune @*/ 1829baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 1830baf369e7SPeter Brune { 1831baf369e7SPeter Brune PetscErrorCode ierr; 1832baf369e7SPeter Brune DMGlobalToLocalHookLink link,*p; 1833baf369e7SPeter Brune 1834baf369e7SPeter Brune PetscFunctionBegin; 1835baf369e7SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1836baf369e7SPeter Brune for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 183795dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 1838baf369e7SPeter Brune link->beginhook = beginhook; 1839baf369e7SPeter Brune link->endhook = endhook; 1840baf369e7SPeter Brune link->ctx = ctx; 18410298fd71SBarry Smith link->next = NULL; 1842baf369e7SPeter Brune *p = link; 1843baf369e7SPeter Brune PetscFunctionReturn(0); 1844baf369e7SPeter Brune } 1845baf369e7SPeter Brune 18464c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx) 18474c274da1SToby Isaac { 18484c274da1SToby Isaac Mat cMat; 18494c274da1SToby Isaac Vec cVec; 18504c274da1SToby Isaac PetscSection section, cSec; 18514c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 18524c274da1SToby Isaac PetscErrorCode ierr; 18534c274da1SToby Isaac 18544c274da1SToby Isaac PetscFunctionBegin; 18554c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 18564c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 18574c274da1SToby Isaac if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) { 18585db9a05bSToby Isaac PetscInt nRows; 18595db9a05bSToby Isaac 18605db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 18615db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 18624c274da1SToby Isaac ierr = DMGetDefaultSection(dm,§ion);CHKERRQ(ierr); 18637711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 18644c274da1SToby Isaac ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr); 18654c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 18664c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 18674c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 18684c274da1SToby Isaac if (dof) { 18694c274da1SToby Isaac PetscScalar *vals; 18704c274da1SToby Isaac ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr); 18714c274da1SToby Isaac ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr); 18724c274da1SToby Isaac } 18734c274da1SToby Isaac } 18744c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 18754c274da1SToby Isaac } 18764c274da1SToby Isaac PetscFunctionReturn(0); 18774c274da1SToby Isaac } 18784c274da1SToby Isaac 187947c6ae99SBarry Smith /*@ 188047c6ae99SBarry Smith DMGlobalToLocalBegin - Begins updating local vectors from global vector 188147c6ae99SBarry Smith 188247c6ae99SBarry Smith Neighbor-wise Collective on DM 188347c6ae99SBarry Smith 188447c6ae99SBarry Smith Input Parameters: 188547c6ae99SBarry Smith + dm - the DM object 188647c6ae99SBarry Smith . g - the global vector 188747c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 188847c6ae99SBarry Smith - l - the local vector 188947c6ae99SBarry Smith 189047c6ae99SBarry Smith 189147c6ae99SBarry Smith Level: beginner 189247c6ae99SBarry Smith 1893e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 189447c6ae99SBarry Smith 189547c6ae99SBarry Smith @*/ 18967087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 189747c6ae99SBarry Smith { 18987128ae9fSMatthew G Knepley PetscSF sf; 189947c6ae99SBarry Smith PetscErrorCode ierr; 1900baf369e7SPeter Brune DMGlobalToLocalHookLink link; 190147c6ae99SBarry Smith 190247c6ae99SBarry Smith PetscFunctionBegin; 1903171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1904baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 19058865f1eaSKarl Rupp if (link->beginhook) { 19068865f1eaSKarl Rupp ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr); 19078865f1eaSKarl Rupp } 1908baf369e7SPeter Brune } 19097128ae9fSMatthew G Knepley ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr); 19107128ae9fSMatthew G Knepley if (sf) { 1911ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 1912ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 19137128ae9fSMatthew G Knepley 191482f516ccSBarry Smith if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 19157128ae9fSMatthew G Knepley ierr = VecGetArray(l, &lArray);CHKERRQ(ierr); 1916ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr); 19177128ae9fSMatthew G Knepley ierr = PetscSFBcastBegin(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr); 19187128ae9fSMatthew G Knepley ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr); 1919ae5cfb4aSMatthew G. Knepley ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr); 19207128ae9fSMatthew G Knepley } else { 1921843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 19227128ae9fSMatthew G Knepley } 192347c6ae99SBarry Smith PetscFunctionReturn(0); 192447c6ae99SBarry Smith } 192547c6ae99SBarry Smith 192647c6ae99SBarry Smith /*@ 192747c6ae99SBarry Smith DMGlobalToLocalEnd - Ends updating local vectors from global vector 192847c6ae99SBarry Smith 192947c6ae99SBarry Smith Neighbor-wise Collective on DM 193047c6ae99SBarry Smith 193147c6ae99SBarry Smith Input Parameters: 193247c6ae99SBarry Smith + dm - the DM object 193347c6ae99SBarry Smith . g - the global vector 193447c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 193547c6ae99SBarry Smith - l - the local vector 193647c6ae99SBarry Smith 193747c6ae99SBarry Smith 193847c6ae99SBarry Smith Level: beginner 193947c6ae99SBarry Smith 1940e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 194147c6ae99SBarry Smith 194247c6ae99SBarry Smith @*/ 19437087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 194447c6ae99SBarry Smith { 19457128ae9fSMatthew G Knepley PetscSF sf; 194647c6ae99SBarry Smith PetscErrorCode ierr; 1947ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 1948ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 1949baf369e7SPeter Brune DMGlobalToLocalHookLink link; 195047c6ae99SBarry Smith 195147c6ae99SBarry Smith PetscFunctionBegin; 1952171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 19537128ae9fSMatthew G Knepley ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr); 19547128ae9fSMatthew G Knepley if (sf) { 195582f516ccSBarry Smith if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 19567128ae9fSMatthew G Knepley 19577128ae9fSMatthew G Knepley ierr = VecGetArray(l, &lArray);CHKERRQ(ierr); 1958ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr); 19597128ae9fSMatthew G Knepley ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr); 19607128ae9fSMatthew G Knepley ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr); 1961ae5cfb4aSMatthew G. Knepley ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr); 19627128ae9fSMatthew G Knepley } else { 1963843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 19647128ae9fSMatthew G Knepley } 19654c274da1SToby Isaac ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr); 1966baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 1967baf369e7SPeter Brune if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 1968baf369e7SPeter Brune } 196947c6ae99SBarry Smith PetscFunctionReturn(0); 197047c6ae99SBarry Smith } 197147c6ae99SBarry Smith 1972d4d07f1eSToby Isaac /*@C 1973d4d07f1eSToby Isaac DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called 1974d4d07f1eSToby Isaac 1975d4d07f1eSToby Isaac Logically Collective 1976d4d07f1eSToby Isaac 1977d4d07f1eSToby Isaac Input Arguments: 1978d4d07f1eSToby Isaac + dm - the DM 1979d4d07f1eSToby Isaac . beginhook - function to run at the beginning of DMLocalToGlobalBegin() 1980d4d07f1eSToby Isaac . endhook - function to run after DMLocalToGlobalEnd() has completed 1981d4d07f1eSToby Isaac - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 1982d4d07f1eSToby Isaac 1983d4d07f1eSToby Isaac Calling sequence for beginhook: 1984d4d07f1eSToby Isaac $ beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 1985d4d07f1eSToby Isaac 1986d4d07f1eSToby Isaac + dm - global DM 1987d4d07f1eSToby Isaac . l - local vector 1988d4d07f1eSToby Isaac . mode - mode 1989d4d07f1eSToby Isaac . g - global vector 1990d4d07f1eSToby Isaac - ctx - optional user-defined function context 1991d4d07f1eSToby Isaac 1992d4d07f1eSToby Isaac 1993d4d07f1eSToby Isaac Calling sequence for endhook: 1994d4d07f1eSToby Isaac $ endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 1995d4d07f1eSToby Isaac 1996d4d07f1eSToby Isaac + global - global DM 1997d4d07f1eSToby Isaac . l - local vector 1998d4d07f1eSToby Isaac . mode - mode 1999d4d07f1eSToby Isaac . g - global vector 2000d4d07f1eSToby Isaac - ctx - optional user-defined function context 2001d4d07f1eSToby Isaac 2002d4d07f1eSToby Isaac Level: advanced 2003d4d07f1eSToby Isaac 2004d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2005d4d07f1eSToby Isaac @*/ 2006d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2007d4d07f1eSToby Isaac { 2008d4d07f1eSToby Isaac PetscErrorCode ierr; 2009d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,*p; 2010d4d07f1eSToby Isaac 2011d4d07f1eSToby Isaac PetscFunctionBegin; 2012d4d07f1eSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2013d4d07f1eSToby Isaac for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 201495dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2015d4d07f1eSToby Isaac link->beginhook = beginhook; 2016d4d07f1eSToby Isaac link->endhook = endhook; 2017d4d07f1eSToby Isaac link->ctx = ctx; 2018d4d07f1eSToby Isaac link->next = NULL; 2019d4d07f1eSToby Isaac *p = link; 2020d4d07f1eSToby Isaac PetscFunctionReturn(0); 2021d4d07f1eSToby Isaac } 2022d4d07f1eSToby Isaac 20234c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx) 20244c274da1SToby Isaac { 20254c274da1SToby Isaac Mat cMat; 20264c274da1SToby Isaac Vec cVec; 20274c274da1SToby Isaac PetscSection section, cSec; 20284c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 20294c274da1SToby Isaac PetscErrorCode ierr; 20304c274da1SToby Isaac 20314c274da1SToby Isaac PetscFunctionBegin; 20324c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 20334c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 20344c274da1SToby Isaac if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) { 20355db9a05bSToby Isaac PetscInt nRows; 20365db9a05bSToby Isaac 20375db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 20385db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 20394c274da1SToby Isaac ierr = DMGetDefaultSection(dm,§ion);CHKERRQ(ierr); 20407711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 20414c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 20424c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 20434c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 20444c274da1SToby Isaac if (dof) { 20454c274da1SToby Isaac PetscInt d; 20464c274da1SToby Isaac PetscScalar *vals; 20474c274da1SToby Isaac ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr); 20484c274da1SToby Isaac ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr); 20494c274da1SToby Isaac /* for this to be the true transpose, we have to zero the values that 20504c274da1SToby Isaac * we just extracted */ 20514c274da1SToby Isaac for (d = 0; d < dof; d++) { 20524c274da1SToby Isaac vals[d] = 0.; 20534c274da1SToby Isaac } 20544c274da1SToby Isaac } 20554c274da1SToby Isaac } 20564c274da1SToby Isaac ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr); 20574c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 20584c274da1SToby Isaac } 20594c274da1SToby Isaac PetscFunctionReturn(0); 20604c274da1SToby Isaac } 20614c274da1SToby Isaac 206247c6ae99SBarry Smith /*@ 20639a42bb27SBarry Smith DMLocalToGlobalBegin - updates global vectors from local vectors 20649a42bb27SBarry Smith 20659a42bb27SBarry Smith Neighbor-wise Collective on DM 20669a42bb27SBarry Smith 20679a42bb27SBarry Smith Input Parameters: 20689a42bb27SBarry Smith + dm - the DM object 2069f6813fd5SJed Brown . l - the local vector 20701eb28f2eSBarry 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. 20711eb28f2eSBarry Smith - g - the global vector 20729a42bb27SBarry Smith 2073d96308ebSBarry Smith Notes: In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 207484330215SMatthew 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. 20759a42bb27SBarry Smith 20769a42bb27SBarry Smith Level: beginner 20779a42bb27SBarry Smith 2078e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 20799a42bb27SBarry Smith 20809a42bb27SBarry Smith @*/ 20817087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g) 20829a42bb27SBarry Smith { 20837128ae9fSMatthew G Knepley PetscSF sf; 208484330215SMatthew G. Knepley PetscSection s, gs; 2085d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 2086ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2087ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 208884330215SMatthew G. Knepley PetscBool isInsert; 208984330215SMatthew G. Knepley PetscErrorCode ierr; 20909a42bb27SBarry Smith 20919a42bb27SBarry Smith PetscFunctionBegin; 2092171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2093d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2094d4d07f1eSToby Isaac if (link->beginhook) { 2095d4d07f1eSToby Isaac ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr); 2096d4d07f1eSToby Isaac } 2097d4d07f1eSToby Isaac } 20984c274da1SToby Isaac ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr); 20997128ae9fSMatthew G Knepley ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr); 210084330215SMatthew G. Knepley ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr); 21017128ae9fSMatthew G Knepley switch (mode) { 21027128ae9fSMatthew G Knepley case INSERT_VALUES: 21037128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 2104304ab55fSMatthew G. Knepley case INSERT_BC_VALUES: 210584330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 21067128ae9fSMatthew G Knepley case ADD_VALUES: 21077128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 2108304ab55fSMatthew G. Knepley case ADD_BC_VALUES: 210984330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 21107128ae9fSMatthew G Knepley default: 211182f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 21127128ae9fSMatthew G Knepley } 211384330215SMatthew G. Knepley if (sf && !isInsert) { 2114ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 21157128ae9fSMatthew G Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 2116a9b180a6SBarry Smith ierr = PetscSFReduceBegin(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr); 2117ae5cfb4aSMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 211884330215SMatthew G. Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 211984330215SMatthew G. Knepley } else if (s && isInsert) { 212084330215SMatthew G. Knepley PetscInt gStart, pStart, pEnd, p; 212184330215SMatthew G. Knepley 212284330215SMatthew G. Knepley ierr = DMGetDefaultGlobalSection(dm, &gs);CHKERRQ(ierr); 212384330215SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 212484330215SMatthew G. Knepley ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr); 2125ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 212684330215SMatthew G. Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 212784330215SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2128b3b16f48SMatthew G. Knepley PetscInt dof, gdof, cdof, gcdof, off, goff, d, e; 212984330215SMatthew G. Knepley 213084330215SMatthew G. Knepley ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr); 213103442857SMatthew G. Knepley ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr); 213284330215SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr); 2133b3b16f48SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr); 213484330215SMatthew G. Knepley ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr); 213584330215SMatthew G. Knepley ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr); 2136b3b16f48SMatthew G. Knepley /* Ignore off-process data and points with no global data */ 213703442857SMatthew G. Knepley if (!gdof || goff < 0) continue; 2138b3b16f48SMatthew 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); 2139b3b16f48SMatthew G. Knepley /* If no constraints are enforced in the global vector */ 2140b3b16f48SMatthew G. Knepley if (!gcdof) { 214184330215SMatthew G. Knepley for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d]; 2142b3b16f48SMatthew G. Knepley /* If constraints are enforced in the global vector */ 2143b3b16f48SMatthew G. Knepley } else if (cdof == gcdof) { 214484330215SMatthew G. Knepley const PetscInt *cdofs; 214584330215SMatthew G. Knepley PetscInt cind = 0; 214684330215SMatthew G. Knepley 214784330215SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr); 2148b3b16f48SMatthew G. Knepley for (d = 0, e = 0; d < dof; ++d) { 214984330215SMatthew G. Knepley if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;} 2150b3b16f48SMatthew G. Knepley gArray[goff-gStart+e++] = lArray[off+d]; 215184330215SMatthew G. Knepley } 2152b3b16f48SMatthew 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); 215384330215SMatthew G. Knepley } 2154ae5cfb4aSMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 21557128ae9fSMatthew G Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 21567128ae9fSMatthew G Knepley } else { 2157843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 21587128ae9fSMatthew G Knepley } 21599a42bb27SBarry Smith PetscFunctionReturn(0); 21609a42bb27SBarry Smith } 21619a42bb27SBarry Smith 21629a42bb27SBarry Smith /*@ 21639a42bb27SBarry Smith DMLocalToGlobalEnd - updates global vectors from local vectors 216447c6ae99SBarry Smith 216547c6ae99SBarry Smith Neighbor-wise Collective on DM 216647c6ae99SBarry Smith 216747c6ae99SBarry Smith Input Parameters: 216847c6ae99SBarry Smith + dm - the DM object 2169f6813fd5SJed Brown . l - the local vector 217047c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 2171f6813fd5SJed Brown - g - the global vector 217247c6ae99SBarry Smith 217347c6ae99SBarry Smith 217447c6ae99SBarry Smith Level: beginner 217547c6ae99SBarry Smith 2176e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd() 217747c6ae99SBarry Smith 217847c6ae99SBarry Smith @*/ 21797087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g) 218047c6ae99SBarry Smith { 21817128ae9fSMatthew G Knepley PetscSF sf; 218284330215SMatthew G. Knepley PetscSection s; 2183d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 218484330215SMatthew G. Knepley PetscBool isInsert; 218584330215SMatthew G. Knepley PetscErrorCode ierr; 218647c6ae99SBarry Smith 218747c6ae99SBarry Smith PetscFunctionBegin; 2188171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 21897128ae9fSMatthew G Knepley ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr); 219084330215SMatthew G. Knepley ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr); 21917128ae9fSMatthew G Knepley switch (mode) { 21927128ae9fSMatthew G Knepley case INSERT_VALUES: 21937128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 219484330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 21957128ae9fSMatthew G Knepley case ADD_VALUES: 21967128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 219784330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 21987128ae9fSMatthew G Knepley default: 219982f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 22007128ae9fSMatthew G Knepley } 220184330215SMatthew G. Knepley if (sf && !isInsert) { 2202ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2203ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 220484330215SMatthew G. Knepley 2205ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 22067128ae9fSMatthew G Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 2207a9b180a6SBarry Smith ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr); 2208ae5cfb4aSMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 22097128ae9fSMatthew G Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 221084330215SMatthew G. Knepley } else if (s && isInsert) { 22117128ae9fSMatthew G Knepley } else { 2212843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 22137128ae9fSMatthew G Knepley } 2214d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2215d4d07f1eSToby Isaac if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 2216d4d07f1eSToby Isaac } 221747c6ae99SBarry Smith PetscFunctionReturn(0); 221847c6ae99SBarry Smith } 221947c6ae99SBarry Smith 2220f089877aSRichard Tran Mills /*@ 2221bc0a1609SRichard Tran Mills DMLocalToLocalBegin - Maps from a local vector (including ghost points 2222bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 2223d78e899eSRichard Tran Mills points in the second are set correctly. Must be followed by DMLocalToLocalEnd(). 2224f089877aSRichard Tran Mills 2225bc0a1609SRichard Tran Mills Neighbor-wise Collective on DM and Vec 2226f089877aSRichard Tran Mills 2227f089877aSRichard Tran Mills Input Parameters: 2228f089877aSRichard Tran Mills + dm - the DM object 2229bc0a1609SRichard Tran Mills . g - the original local vector 2230bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 2231f089877aSRichard Tran Mills 2232bc0a1609SRichard Tran Mills Output Parameter: 2233bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 2234f089877aSRichard Tran Mills 2235f089877aSRichard Tran Mills Level: intermediate 2236f089877aSRichard Tran Mills 2237bc0a1609SRichard Tran Mills Notes: 2238bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 2239bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 2240bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 2241bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 2242bc0a1609SRichard Tran Mills 2243bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, begin 2244bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 2245f089877aSRichard Tran Mills 2246f089877aSRichard Tran Mills @*/ 2247f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 2248f089877aSRichard Tran Mills { 2249f089877aSRichard Tran Mills PetscErrorCode ierr; 2250f089877aSRichard Tran Mills 2251f089877aSRichard Tran Mills PetscFunctionBegin; 2252f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2253f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 2254f089877aSRichard Tran Mills PetscFunctionReturn(0); 2255f089877aSRichard Tran Mills } 2256f089877aSRichard Tran Mills 2257f089877aSRichard Tran Mills /*@ 2258bc0a1609SRichard Tran Mills DMLocalToLocalEnd - Maps from a local vector (including ghost points 2259bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 2260d78e899eSRichard Tran Mills points in the second are set correctly. Must be preceded by DMLocalToLocalBegin(). 2261f089877aSRichard Tran Mills 2262bc0a1609SRichard Tran Mills Neighbor-wise Collective on DM and Vec 2263f089877aSRichard Tran Mills 2264f089877aSRichard Tran Mills Input Parameters: 2265bc0a1609SRichard Tran Mills + da - the DM object 2266bc0a1609SRichard Tran Mills . g - the original local vector 2267bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 2268f089877aSRichard Tran Mills 2269bc0a1609SRichard Tran Mills Output Parameter: 2270bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 2271f089877aSRichard Tran Mills 2272f089877aSRichard Tran Mills Level: intermediate 2273f089877aSRichard Tran Mills 2274bc0a1609SRichard Tran Mills Notes: 2275bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 2276bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 2277bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 2278bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 2279bc0a1609SRichard Tran Mills 2280bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, end 2281bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 2282f089877aSRichard Tran Mills 2283f089877aSRichard Tran Mills @*/ 2284f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 2285f089877aSRichard Tran Mills { 2286f089877aSRichard Tran Mills PetscErrorCode ierr; 2287f089877aSRichard Tran Mills 2288f089877aSRichard Tran Mills PetscFunctionBegin; 2289f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2290f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 2291f089877aSRichard Tran Mills PetscFunctionReturn(0); 2292f089877aSRichard Tran Mills } 2293f089877aSRichard Tran Mills 2294f089877aSRichard Tran Mills 229547c6ae99SBarry Smith /*@ 229647c6ae99SBarry Smith DMCoarsen - Coarsens a DM object 229747c6ae99SBarry Smith 229847c6ae99SBarry Smith Collective on DM 229947c6ae99SBarry Smith 230047c6ae99SBarry Smith Input Parameter: 230147c6ae99SBarry Smith + dm - the DM object 230291d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 230347c6ae99SBarry Smith 230447c6ae99SBarry Smith Output Parameter: 230547c6ae99SBarry Smith . dmc - the coarsened DM 230647c6ae99SBarry Smith 230747c6ae99SBarry Smith Level: developer 230847c6ae99SBarry Smith 2309e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 231047c6ae99SBarry Smith 231147c6ae99SBarry Smith @*/ 23127087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc) 231347c6ae99SBarry Smith { 231447c6ae99SBarry Smith PetscErrorCode ierr; 2315b17ce1afSJed Brown DMCoarsenHookLink link; 231647c6ae99SBarry Smith 231747c6ae99SBarry Smith PetscFunctionBegin; 2318171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2319fef3a512SBarry Smith if (!dm->ops->coarsen) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM cannot coarsen"); 232047a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 232147c6ae99SBarry Smith ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr); 23228892b4c3SMatthew G. Knepley if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced"); 2323a8fb8f29SToby Isaac ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr); 232443842a1eSJed Brown (*dmc)->ops->creatematrix = dm->ops->creatematrix; 23258cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr); 2326644e2e5bSBarry Smith (*dmc)->ctx = dm->ctx; 23270598a293SJed Brown (*dmc)->levelup = dm->levelup; 2328656b349aSBarry Smith (*dmc)->leveldown = dm->leveldown + 1; 2329e4b4b23bSJed Brown ierr = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr); 2330b17ce1afSJed Brown for (link=dm->coarsenhook; link; link=link->next) { 2331b17ce1afSJed Brown if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);} 2332b17ce1afSJed Brown } 233347a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 2334b17ce1afSJed Brown PetscFunctionReturn(0); 2335b17ce1afSJed Brown } 2336b17ce1afSJed Brown 2337bb9467b5SJed Brown /*@C 2338b17ce1afSJed Brown DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid 2339b17ce1afSJed Brown 2340b17ce1afSJed Brown Logically Collective 2341b17ce1afSJed Brown 2342b17ce1afSJed Brown Input Arguments: 2343b17ce1afSJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 2344b17ce1afSJed Brown . coarsenhook - function to run when setting up a coarser level 2345b17ce1afSJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 23460298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2347b17ce1afSJed Brown 2348b17ce1afSJed Brown Calling sequence of coarsenhook: 2349b17ce1afSJed Brown $ coarsenhook(DM fine,DM coarse,void *ctx); 2350b17ce1afSJed Brown 2351b17ce1afSJed Brown + fine - fine level DM 2352b17ce1afSJed Brown . coarse - coarse level DM to restrict problem to 2353b17ce1afSJed Brown - ctx - optional user-defined function context 2354b17ce1afSJed Brown 2355b17ce1afSJed Brown Calling sequence for restricthook: 2356c833c3b5SJed Brown $ restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx) 2357b17ce1afSJed Brown 2358b17ce1afSJed Brown + fine - fine level DM 2359b17ce1afSJed Brown . mrestrict - matrix restricting a fine-level solution to the coarse grid 2360c833c3b5SJed Brown . rscale - scaling vector for restriction 2361c833c3b5SJed Brown . inject - matrix restricting by injection 2362b17ce1afSJed Brown . coarse - coarse level DM to update 2363b17ce1afSJed Brown - ctx - optional user-defined function context 2364b17ce1afSJed Brown 2365b17ce1afSJed Brown Level: advanced 2366b17ce1afSJed Brown 2367b17ce1afSJed Brown Notes: 2368b17ce1afSJed Brown This function is only needed if auxiliary data needs to be set up on coarse grids. 2369b17ce1afSJed Brown 2370b17ce1afSJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 2371b17ce1afSJed Brown 2372b17ce1afSJed Brown In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 2373b17ce1afSJed Brown extract the finest level information from its context (instead of from the SNES). 2374b17ce1afSJed Brown 2375bb9467b5SJed Brown This function is currently not available from Fortran. 2376bb9467b5SJed Brown 2377c833c3b5SJed Brown .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2378b17ce1afSJed Brown @*/ 2379b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 2380b17ce1afSJed Brown { 2381b17ce1afSJed Brown PetscErrorCode ierr; 2382b17ce1afSJed Brown DMCoarsenHookLink link,*p; 2383b17ce1afSJed Brown 2384b17ce1afSJed Brown PetscFunctionBegin; 2385b17ce1afSJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 23866bfea28cSJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 238795dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2388b17ce1afSJed Brown link->coarsenhook = coarsenhook; 2389b17ce1afSJed Brown link->restricthook = restricthook; 2390b17ce1afSJed Brown link->ctx = ctx; 23910298fd71SBarry Smith link->next = NULL; 2392b17ce1afSJed Brown *p = link; 2393b17ce1afSJed Brown PetscFunctionReturn(0); 2394b17ce1afSJed Brown } 2395b17ce1afSJed Brown 2396b17ce1afSJed Brown /*@ 2397b17ce1afSJed Brown DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd() 2398b17ce1afSJed Brown 2399b17ce1afSJed Brown Collective if any hooks are 2400b17ce1afSJed Brown 2401b17ce1afSJed Brown Input Arguments: 2402b17ce1afSJed Brown + fine - finer DM to use as a base 2403b17ce1afSJed Brown . restrct - restriction matrix, apply using MatRestrict() 2404b17ce1afSJed Brown . inject - injection matrix, also use MatRestrict() 2405b17ce1afSJed Brown - coarse - coarer DM to update 2406b17ce1afSJed Brown 2407b17ce1afSJed Brown Level: developer 2408b17ce1afSJed Brown 2409b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict() 2410b17ce1afSJed Brown @*/ 2411b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse) 2412b17ce1afSJed Brown { 2413b17ce1afSJed Brown PetscErrorCode ierr; 2414b17ce1afSJed Brown DMCoarsenHookLink link; 2415b17ce1afSJed Brown 2416b17ce1afSJed Brown PetscFunctionBegin; 2417b17ce1afSJed Brown for (link=fine->coarsenhook; link; link=link->next) { 24188865f1eaSKarl Rupp if (link->restricthook) { 24198865f1eaSKarl Rupp ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr); 24208865f1eaSKarl Rupp } 2421b17ce1afSJed Brown } 242247c6ae99SBarry Smith PetscFunctionReturn(0); 242347c6ae99SBarry Smith } 242447c6ae99SBarry Smith 2425bb9467b5SJed Brown /*@C 2426be081cd6SPeter Brune DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid 24275dbd56e3SPeter Brune 24285dbd56e3SPeter Brune Logically Collective 24295dbd56e3SPeter Brune 24305dbd56e3SPeter Brune Input Arguments: 24315dbd56e3SPeter Brune + global - global DM 2432ec4806b8SPeter Brune . ddhook - function to run to pass data to the decomposition DM upon its creation 24335dbd56e3SPeter Brune . restricthook - function to run to update data on block solve (at the beginning of the block solve) 24340298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 24355dbd56e3SPeter Brune 2436ec4806b8SPeter Brune 2437ec4806b8SPeter Brune Calling sequence for ddhook: 2438ec4806b8SPeter Brune $ ddhook(DM global,DM block,void *ctx) 2439ec4806b8SPeter Brune 2440ec4806b8SPeter Brune + global - global DM 2441ec4806b8SPeter Brune . block - block DM 2442ec4806b8SPeter Brune - ctx - optional user-defined function context 2443ec4806b8SPeter Brune 24445dbd56e3SPeter Brune Calling sequence for restricthook: 2445ec4806b8SPeter Brune $ restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx) 24465dbd56e3SPeter Brune 24475dbd56e3SPeter Brune + global - global DM 24485dbd56e3SPeter Brune . out - scatter to the outer (with ghost and overlap points) block vector 24495dbd56e3SPeter Brune . in - scatter to block vector values only owned locally 2450ec4806b8SPeter Brune . block - block DM 24515dbd56e3SPeter Brune - ctx - optional user-defined function context 24525dbd56e3SPeter Brune 24535dbd56e3SPeter Brune Level: advanced 24545dbd56e3SPeter Brune 24555dbd56e3SPeter Brune Notes: 2456ec4806b8SPeter Brune This function is only needed if auxiliary data needs to be set up on subdomain DMs. 24575dbd56e3SPeter Brune 24585dbd56e3SPeter Brune If this function is called multiple times, the hooks will be run in the order they are added. 24595dbd56e3SPeter Brune 24605dbd56e3SPeter Brune In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 2461ec4806b8SPeter Brune extract the global information from its context (instead of from the SNES). 24625dbd56e3SPeter Brune 2463bb9467b5SJed Brown This function is currently not available from Fortran. 2464bb9467b5SJed Brown 24655dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 24665dbd56e3SPeter Brune @*/ 2467be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 24685dbd56e3SPeter Brune { 24695dbd56e3SPeter Brune PetscErrorCode ierr; 2470be081cd6SPeter Brune DMSubDomainHookLink link,*p; 24715dbd56e3SPeter Brune 24725dbd56e3SPeter Brune PetscFunctionBegin; 24735dbd56e3SPeter Brune PetscValidHeaderSpecific(global,DM_CLASSID,1); 2474be081cd6SPeter Brune for (p=&global->subdomainhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 247595dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 24765dbd56e3SPeter Brune link->restricthook = restricthook; 2477be081cd6SPeter Brune link->ddhook = ddhook; 24785dbd56e3SPeter Brune link->ctx = ctx; 24790298fd71SBarry Smith link->next = NULL; 24805dbd56e3SPeter Brune *p = link; 24815dbd56e3SPeter Brune PetscFunctionReturn(0); 24825dbd56e3SPeter Brune } 24835dbd56e3SPeter Brune 24845dbd56e3SPeter Brune /*@ 2485be081cd6SPeter Brune DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd() 24865dbd56e3SPeter Brune 24875dbd56e3SPeter Brune Collective if any hooks are 24885dbd56e3SPeter Brune 24895dbd56e3SPeter Brune Input Arguments: 24905dbd56e3SPeter Brune + fine - finer DM to use as a base 2491be081cd6SPeter Brune . oscatter - scatter from domain global vector filling subdomain global vector with overlap 2492be081cd6SPeter Brune . gscatter - scatter from domain global vector filling subdomain local vector with ghosts 24935dbd56e3SPeter Brune - coarse - coarer DM to update 24945dbd56e3SPeter Brune 24955dbd56e3SPeter Brune Level: developer 24965dbd56e3SPeter Brune 24975dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict() 24985dbd56e3SPeter Brune @*/ 2499be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm) 25005dbd56e3SPeter Brune { 25015dbd56e3SPeter Brune PetscErrorCode ierr; 2502be081cd6SPeter Brune DMSubDomainHookLink link; 25035dbd56e3SPeter Brune 25045dbd56e3SPeter Brune PetscFunctionBegin; 2505be081cd6SPeter Brune for (link=global->subdomainhook; link; link=link->next) { 25068865f1eaSKarl Rupp if (link->restricthook) { 25078865f1eaSKarl Rupp ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr); 25088865f1eaSKarl Rupp } 25095dbd56e3SPeter Brune } 25105dbd56e3SPeter Brune PetscFunctionReturn(0); 25115dbd56e3SPeter Brune } 25125dbd56e3SPeter Brune 25135fe1f584SPeter Brune /*@ 25146a7d9d85SPeter Brune DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM. 25155fe1f584SPeter Brune 25165fe1f584SPeter Brune Not Collective 25175fe1f584SPeter Brune 25185fe1f584SPeter Brune Input Parameter: 25195fe1f584SPeter Brune . dm - the DM object 25205fe1f584SPeter Brune 25215fe1f584SPeter Brune Output Parameter: 25226a7d9d85SPeter Brune . level - number of coarsenings 25235fe1f584SPeter Brune 25245fe1f584SPeter Brune Level: developer 25255fe1f584SPeter Brune 25266a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 25275fe1f584SPeter Brune 25285fe1f584SPeter Brune @*/ 25295fe1f584SPeter Brune PetscErrorCode DMGetCoarsenLevel(DM dm,PetscInt *level) 25305fe1f584SPeter Brune { 25315fe1f584SPeter Brune PetscFunctionBegin; 25325fe1f584SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 25335fe1f584SPeter Brune *level = dm->leveldown; 25345fe1f584SPeter Brune PetscFunctionReturn(0); 25355fe1f584SPeter Brune } 25365fe1f584SPeter Brune 25375fe1f584SPeter Brune 25385fe1f584SPeter Brune 253947c6ae99SBarry Smith /*@C 254047c6ae99SBarry Smith DMRefineHierarchy - Refines a DM object, all levels at once 254147c6ae99SBarry Smith 254247c6ae99SBarry Smith Collective on DM 254347c6ae99SBarry Smith 254447c6ae99SBarry Smith Input Parameter: 254547c6ae99SBarry Smith + dm - the DM object 254647c6ae99SBarry Smith - nlevels - the number of levels of refinement 254747c6ae99SBarry Smith 254847c6ae99SBarry Smith Output Parameter: 254947c6ae99SBarry Smith . dmf - the refined DM hierarchy 255047c6ae99SBarry Smith 255147c6ae99SBarry Smith Level: developer 255247c6ae99SBarry Smith 2553e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 255447c6ae99SBarry Smith 255547c6ae99SBarry Smith @*/ 25567087cfbeSBarry Smith PetscErrorCode DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[]) 255747c6ae99SBarry Smith { 255847c6ae99SBarry Smith PetscErrorCode ierr; 255947c6ae99SBarry Smith 256047c6ae99SBarry Smith PetscFunctionBegin; 2561171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2562ce94432eSBarry Smith if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 256347c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 256447c6ae99SBarry Smith if (dm->ops->refinehierarchy) { 256547c6ae99SBarry Smith ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr); 256647c6ae99SBarry Smith } else if (dm->ops->refine) { 256747c6ae99SBarry Smith PetscInt i; 256847c6ae99SBarry Smith 2569ce94432eSBarry Smith ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr); 257047c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 2571ce94432eSBarry Smith ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr); 257247c6ae99SBarry Smith } 2573ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet"); 257447c6ae99SBarry Smith PetscFunctionReturn(0); 257547c6ae99SBarry Smith } 257647c6ae99SBarry Smith 257747c6ae99SBarry Smith /*@C 257847c6ae99SBarry Smith DMCoarsenHierarchy - Coarsens a DM object, all levels at once 257947c6ae99SBarry Smith 258047c6ae99SBarry Smith Collective on DM 258147c6ae99SBarry Smith 258247c6ae99SBarry Smith Input Parameter: 258347c6ae99SBarry Smith + dm - the DM object 258447c6ae99SBarry Smith - nlevels - the number of levels of coarsening 258547c6ae99SBarry Smith 258647c6ae99SBarry Smith Output Parameter: 258747c6ae99SBarry Smith . dmc - the coarsened DM hierarchy 258847c6ae99SBarry Smith 258947c6ae99SBarry Smith Level: developer 259047c6ae99SBarry Smith 2591e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 259247c6ae99SBarry Smith 259347c6ae99SBarry Smith @*/ 25947087cfbeSBarry Smith PetscErrorCode DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[]) 259547c6ae99SBarry Smith { 259647c6ae99SBarry Smith PetscErrorCode ierr; 259747c6ae99SBarry Smith 259847c6ae99SBarry Smith PetscFunctionBegin; 2599171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2600ce94432eSBarry Smith if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 260147c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 260247c6ae99SBarry Smith PetscValidPointer(dmc,3); 260347c6ae99SBarry Smith if (dm->ops->coarsenhierarchy) { 260447c6ae99SBarry Smith ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr); 260547c6ae99SBarry Smith } else if (dm->ops->coarsen) { 260647c6ae99SBarry Smith PetscInt i; 260747c6ae99SBarry Smith 2608ce94432eSBarry Smith ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr); 260947c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 2610ce94432eSBarry Smith ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr); 261147c6ae99SBarry Smith } 2612ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet"); 261347c6ae99SBarry Smith PetscFunctionReturn(0); 261447c6ae99SBarry Smith } 261547c6ae99SBarry Smith 261647c6ae99SBarry Smith /*@ 2617e727c939SJed Brown DMCreateAggregates - Gets the aggregates that map between 261847c6ae99SBarry Smith grids associated with two DMs. 261947c6ae99SBarry Smith 262047c6ae99SBarry Smith Collective on DM 262147c6ae99SBarry Smith 262247c6ae99SBarry Smith Input Parameters: 262347c6ae99SBarry Smith + dmc - the coarse grid DM 262447c6ae99SBarry Smith - dmf - the fine grid DM 262547c6ae99SBarry Smith 262647c6ae99SBarry Smith Output Parameters: 262747c6ae99SBarry Smith . rest - the restriction matrix (transpose of the projection matrix) 262847c6ae99SBarry Smith 262947c6ae99SBarry Smith Level: intermediate 263047c6ae99SBarry Smith 263147c6ae99SBarry Smith .keywords: interpolation, restriction, multigrid 263247c6ae99SBarry Smith 2633e727c939SJed Brown .seealso: DMRefine(), DMCreateInjection(), DMCreateInterpolation() 263447c6ae99SBarry Smith @*/ 2635e727c939SJed Brown PetscErrorCode DMCreateAggregates(DM dmc, DM dmf, Mat *rest) 263647c6ae99SBarry Smith { 263747c6ae99SBarry Smith PetscErrorCode ierr; 263847c6ae99SBarry Smith 263947c6ae99SBarry Smith PetscFunctionBegin; 2640171400e9SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 2641171400e9SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 264247c6ae99SBarry Smith ierr = (*dmc->ops->getaggregates)(dmc, dmf, rest);CHKERRQ(ierr); 264347c6ae99SBarry Smith PetscFunctionReturn(0); 264447c6ae99SBarry Smith } 264547c6ae99SBarry Smith 26461a266240SBarry Smith /*@C 26471a266240SBarry Smith DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed 26481a266240SBarry Smith 26491a266240SBarry Smith Not Collective 26501a266240SBarry Smith 26511a266240SBarry Smith Input Parameters: 26521a266240SBarry Smith + dm - the DM object 26531a266240SBarry Smith - destroy - the destroy function 26541a266240SBarry Smith 26551a266240SBarry Smith Level: intermediate 26561a266240SBarry Smith 2657e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 26581a266240SBarry Smith 2659f07f9ceaSJed Brown @*/ 26601a266240SBarry Smith PetscErrorCode DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**)) 26611a266240SBarry Smith { 26621a266240SBarry Smith PetscFunctionBegin; 2663171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 26641a266240SBarry Smith dm->ctxdestroy = destroy; 26651a266240SBarry Smith PetscFunctionReturn(0); 26661a266240SBarry Smith } 26671a266240SBarry Smith 2668b07ff414SBarry Smith /*@ 26691b2093e4SBarry Smith DMSetApplicationContext - Set a user context into a DM object 267047c6ae99SBarry Smith 267147c6ae99SBarry Smith Not Collective 267247c6ae99SBarry Smith 267347c6ae99SBarry Smith Input Parameters: 267447c6ae99SBarry Smith + dm - the DM object 267547c6ae99SBarry Smith - ctx - the user context 267647c6ae99SBarry Smith 267747c6ae99SBarry Smith Level: intermediate 267847c6ae99SBarry Smith 2679e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 268047c6ae99SBarry Smith 268147c6ae99SBarry Smith @*/ 26821b2093e4SBarry Smith PetscErrorCode DMSetApplicationContext(DM dm,void *ctx) 268347c6ae99SBarry Smith { 268447c6ae99SBarry Smith PetscFunctionBegin; 2685171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 268647c6ae99SBarry Smith dm->ctx = ctx; 268747c6ae99SBarry Smith PetscFunctionReturn(0); 268847c6ae99SBarry Smith } 268947c6ae99SBarry Smith 269047c6ae99SBarry Smith /*@ 26911b2093e4SBarry Smith DMGetApplicationContext - Gets a user context from a DM object 269247c6ae99SBarry Smith 269347c6ae99SBarry Smith Not Collective 269447c6ae99SBarry Smith 269547c6ae99SBarry Smith Input Parameter: 269647c6ae99SBarry Smith . dm - the DM object 269747c6ae99SBarry Smith 269847c6ae99SBarry Smith Output Parameter: 269947c6ae99SBarry Smith . ctx - the user context 270047c6ae99SBarry Smith 270147c6ae99SBarry Smith Level: intermediate 270247c6ae99SBarry Smith 2703e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 270447c6ae99SBarry Smith 270547c6ae99SBarry Smith @*/ 27061b2093e4SBarry Smith PetscErrorCode DMGetApplicationContext(DM dm,void *ctx) 270747c6ae99SBarry Smith { 270847c6ae99SBarry Smith PetscFunctionBegin; 2709171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 27101b2093e4SBarry Smith *(void**)ctx = dm->ctx; 271147c6ae99SBarry Smith PetscFunctionReturn(0); 271247c6ae99SBarry Smith } 271347c6ae99SBarry Smith 271408da532bSDmitry Karpeev /*@C 2715df3898eeSBarry Smith DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI. 271608da532bSDmitry Karpeev 271708da532bSDmitry Karpeev Logically Collective on DM 271808da532bSDmitry Karpeev 271908da532bSDmitry Karpeev Input Parameter: 272008da532bSDmitry Karpeev + dm - the DM object 27210298fd71SBarry Smith - f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set) 272208da532bSDmitry Karpeev 272308da532bSDmitry Karpeev Level: intermediate 272408da532bSDmitry Karpeev 2725835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(), 272608da532bSDmitry Karpeev DMSetJacobian() 272708da532bSDmitry Karpeev 272808da532bSDmitry Karpeev @*/ 272908da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec)) 273008da532bSDmitry Karpeev { 273108da532bSDmitry Karpeev PetscFunctionBegin; 273208da532bSDmitry Karpeev dm->ops->computevariablebounds = f; 273308da532bSDmitry Karpeev PetscFunctionReturn(0); 273408da532bSDmitry Karpeev } 273508da532bSDmitry Karpeev 273608da532bSDmitry Karpeev /*@ 273708da532bSDmitry Karpeev DMHasVariableBounds - does the DM object have a variable bounds function? 273808da532bSDmitry Karpeev 273908da532bSDmitry Karpeev Not Collective 274008da532bSDmitry Karpeev 274108da532bSDmitry Karpeev Input Parameter: 274208da532bSDmitry Karpeev . dm - the DM object to destroy 274308da532bSDmitry Karpeev 274408da532bSDmitry Karpeev Output Parameter: 274508da532bSDmitry Karpeev . flg - PETSC_TRUE if the variable bounds function exists 274608da532bSDmitry Karpeev 274708da532bSDmitry Karpeev Level: developer 274808da532bSDmitry Karpeev 274974e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 275008da532bSDmitry Karpeev 275108da532bSDmitry Karpeev @*/ 275208da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg) 275308da532bSDmitry Karpeev { 275408da532bSDmitry Karpeev PetscFunctionBegin; 275508da532bSDmitry Karpeev *flg = (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE; 275608da532bSDmitry Karpeev PetscFunctionReturn(0); 275708da532bSDmitry Karpeev } 275808da532bSDmitry Karpeev 275908da532bSDmitry Karpeev /*@C 276008da532bSDmitry Karpeev DMComputeVariableBounds - compute variable bounds used by SNESVI. 276108da532bSDmitry Karpeev 276208da532bSDmitry Karpeev Logically Collective on DM 276308da532bSDmitry Karpeev 276408da532bSDmitry Karpeev Input Parameters: 2765907376e6SBarry Smith . dm - the DM object 276608da532bSDmitry Karpeev 276708da532bSDmitry Karpeev Output parameters: 276808da532bSDmitry Karpeev + xl - lower bound 276908da532bSDmitry Karpeev - xu - upper bound 277008da532bSDmitry Karpeev 2771907376e6SBarry Smith Level: advanced 2772907376e6SBarry Smith 2773907376e6SBarry Smith Notes: This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds() 277408da532bSDmitry Karpeev 277574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 277608da532bSDmitry Karpeev 277708da532bSDmitry Karpeev @*/ 277808da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu) 277908da532bSDmitry Karpeev { 278008da532bSDmitry Karpeev PetscErrorCode ierr; 27815fd66863SKarl Rupp 278208da532bSDmitry Karpeev PetscFunctionBegin; 278308da532bSDmitry Karpeev PetscValidHeaderSpecific(xl,VEC_CLASSID,2); 278408da532bSDmitry Karpeev PetscValidHeaderSpecific(xu,VEC_CLASSID,2); 278508da532bSDmitry Karpeev if (dm->ops->computevariablebounds) { 278608da532bSDmitry Karpeev ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr); 27878865f1eaSKarl Rupp } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "This DM is incapable of computing variable bounds."); 278808da532bSDmitry Karpeev PetscFunctionReturn(0); 278908da532bSDmitry Karpeev } 279008da532bSDmitry Karpeev 2791b0ae01b7SPeter Brune /*@ 2792b0ae01b7SPeter Brune DMHasColoring - does the DM object have a method of providing a coloring? 2793b0ae01b7SPeter Brune 2794b0ae01b7SPeter Brune Not Collective 2795b0ae01b7SPeter Brune 2796b0ae01b7SPeter Brune Input Parameter: 2797b0ae01b7SPeter Brune . dm - the DM object 2798b0ae01b7SPeter Brune 2799b0ae01b7SPeter Brune Output Parameter: 2800b0ae01b7SPeter Brune . flg - PETSC_TRUE if the DM has facilities for DMCreateColoring(). 2801b0ae01b7SPeter Brune 2802b0ae01b7SPeter Brune Level: developer 2803b0ae01b7SPeter Brune 2804b0ae01b7SPeter Brune .seealso DMHasFunction(), DMCreateColoring() 2805b0ae01b7SPeter Brune 2806b0ae01b7SPeter Brune @*/ 2807b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg) 2808b0ae01b7SPeter Brune { 2809b0ae01b7SPeter Brune PetscFunctionBegin; 2810b0ae01b7SPeter Brune *flg = (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE; 2811b0ae01b7SPeter Brune PetscFunctionReturn(0); 2812b0ae01b7SPeter Brune } 2813b0ae01b7SPeter Brune 28143ad4599aSBarry Smith /*@ 28153ad4599aSBarry Smith DMHasCreateRestriction - does the DM object have a method of providing a restriction? 28163ad4599aSBarry Smith 28173ad4599aSBarry Smith Not Collective 28183ad4599aSBarry Smith 28193ad4599aSBarry Smith Input Parameter: 28203ad4599aSBarry Smith . dm - the DM object 28213ad4599aSBarry Smith 28223ad4599aSBarry Smith Output Parameter: 28233ad4599aSBarry Smith . flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction(). 28243ad4599aSBarry Smith 28253ad4599aSBarry Smith Level: developer 28263ad4599aSBarry Smith 28273ad4599aSBarry Smith .seealso DMHasFunction(), DMCreateRestriction() 28283ad4599aSBarry Smith 28293ad4599aSBarry Smith @*/ 28303ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg) 28313ad4599aSBarry Smith { 28323ad4599aSBarry Smith PetscFunctionBegin; 28333ad4599aSBarry Smith *flg = (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE; 28343ad4599aSBarry Smith PetscFunctionReturn(0); 28353ad4599aSBarry Smith } 28363ad4599aSBarry Smith 2837748fac09SDmitry Karpeev /*@C 283808da532bSDmitry Karpeev DMSetVec - set the vector at which to compute residual, Jacobian and VI bounds, if the problem is nonlinear. 283908da532bSDmitry Karpeev 284008da532bSDmitry Karpeev Collective on DM 284108da532bSDmitry Karpeev 284208da532bSDmitry Karpeev Input Parameter: 284308da532bSDmitry Karpeev + dm - the DM object 28440298fd71SBarry Smith - x - location to compute residual and Jacobian, if NULL is passed to those routines; will be NULL for linear problems. 284508da532bSDmitry Karpeev 284608da532bSDmitry Karpeev Level: developer 284708da532bSDmitry Karpeev 284874e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 284908da532bSDmitry Karpeev 285008da532bSDmitry Karpeev @*/ 285108da532bSDmitry Karpeev PetscErrorCode DMSetVec(DM dm,Vec x) 285208da532bSDmitry Karpeev { 285308da532bSDmitry Karpeev PetscErrorCode ierr; 28545fd66863SKarl Rupp 285508da532bSDmitry Karpeev PetscFunctionBegin; 285608da532bSDmitry Karpeev if (x) { 285708da532bSDmitry Karpeev if (!dm->x) { 285808da532bSDmitry Karpeev ierr = DMCreateGlobalVector(dm,&dm->x);CHKERRQ(ierr); 285908da532bSDmitry Karpeev } 286008da532bSDmitry Karpeev ierr = VecCopy(x,dm->x);CHKERRQ(ierr); 28618865f1eaSKarl Rupp } else if (dm->x) { 286208da532bSDmitry Karpeev ierr = VecDestroy(&dm->x);CHKERRQ(ierr); 286308da532bSDmitry Karpeev } 286408da532bSDmitry Karpeev PetscFunctionReturn(0); 286508da532bSDmitry Karpeev } 286608da532bSDmitry Karpeev 28670298fd71SBarry Smith PetscFunctionList DMList = NULL; 2868264ace61SBarry Smith PetscBool DMRegisterAllCalled = PETSC_FALSE; 2869264ace61SBarry Smith 2870264ace61SBarry Smith /*@C 2871264ace61SBarry Smith DMSetType - Builds a DM, for a particular DM implementation. 2872264ace61SBarry Smith 2873264ace61SBarry Smith Collective on DM 2874264ace61SBarry Smith 2875264ace61SBarry Smith Input Parameters: 2876264ace61SBarry Smith + dm - The DM object 2877264ace61SBarry Smith - method - The name of the DM type 2878264ace61SBarry Smith 2879264ace61SBarry Smith Options Database Key: 2880264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types 2881264ace61SBarry Smith 2882264ace61SBarry Smith Notes: 2883e1589f56SBarry Smith See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D). 2884264ace61SBarry Smith 2885264ace61SBarry Smith Level: intermediate 2886264ace61SBarry Smith 2887264ace61SBarry Smith .keywords: DM, set, type 2888264ace61SBarry Smith .seealso: DMGetType(), DMCreate() 2889264ace61SBarry Smith @*/ 289019fd82e9SBarry Smith PetscErrorCode DMSetType(DM dm, DMType method) 2891264ace61SBarry Smith { 2892264ace61SBarry Smith PetscErrorCode (*r)(DM); 2893264ace61SBarry Smith PetscBool match; 2894264ace61SBarry Smith PetscErrorCode ierr; 2895264ace61SBarry Smith 2896264ace61SBarry Smith PetscFunctionBegin; 2897264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 2898251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr); 2899264ace61SBarry Smith if (match) PetscFunctionReturn(0); 2900264ace61SBarry Smith 29010f51fdf8SToby Isaac ierr = DMRegisterAll();CHKERRQ(ierr); 29021c9cd337SJed Brown ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr); 2903ce94432eSBarry Smith if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method); 2904264ace61SBarry Smith 2905264ace61SBarry Smith if (dm->ops->destroy) { 2906264ace61SBarry Smith ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr); 29070298fd71SBarry Smith dm->ops->destroy = NULL; 2908264ace61SBarry Smith } 2909264ace61SBarry Smith ierr = (*r)(dm);CHKERRQ(ierr); 2910264ace61SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr); 2911264ace61SBarry Smith PetscFunctionReturn(0); 2912264ace61SBarry Smith } 2913264ace61SBarry Smith 2914264ace61SBarry Smith /*@C 2915264ace61SBarry Smith DMGetType - Gets the DM type name (as a string) from the DM. 2916264ace61SBarry Smith 2917264ace61SBarry Smith Not Collective 2918264ace61SBarry Smith 2919264ace61SBarry Smith Input Parameter: 2920264ace61SBarry Smith . dm - The DM 2921264ace61SBarry Smith 2922264ace61SBarry Smith Output Parameter: 2923264ace61SBarry Smith . type - The DM type name 2924264ace61SBarry Smith 2925264ace61SBarry Smith Level: intermediate 2926264ace61SBarry Smith 2927264ace61SBarry Smith .keywords: DM, get, type, name 2928264ace61SBarry Smith .seealso: DMSetType(), DMCreate() 2929264ace61SBarry Smith @*/ 293019fd82e9SBarry Smith PetscErrorCode DMGetType(DM dm, DMType *type) 2931264ace61SBarry Smith { 2932264ace61SBarry Smith PetscErrorCode ierr; 2933264ace61SBarry Smith 2934264ace61SBarry Smith PetscFunctionBegin; 2935264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 2936c959eef4SJed Brown PetscValidPointer(type,2); 2937607a6623SBarry Smith ierr = DMRegisterAll();CHKERRQ(ierr); 2938264ace61SBarry Smith *type = ((PetscObject)dm)->type_name; 2939264ace61SBarry Smith PetscFunctionReturn(0); 2940264ace61SBarry Smith } 2941264ace61SBarry Smith 294267a56275SMatthew G Knepley /*@C 294367a56275SMatthew G Knepley DMConvert - Converts a DM to another DM, either of the same or different type. 294467a56275SMatthew G Knepley 294567a56275SMatthew G Knepley Collective on DM 294667a56275SMatthew G Knepley 294767a56275SMatthew G Knepley Input Parameters: 294867a56275SMatthew G Knepley + dm - the DM 294967a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type) 295067a56275SMatthew G Knepley 295167a56275SMatthew G Knepley Output Parameter: 295267a56275SMatthew G Knepley . M - pointer to new DM 295367a56275SMatthew G Knepley 295467a56275SMatthew G Knepley Notes: 295567a56275SMatthew G Knepley Cannot be used to convert a sequential DM to parallel or parallel to sequential, 295667a56275SMatthew G Knepley the MPI communicator of the generated DM is always the same as the communicator 295767a56275SMatthew G Knepley of the input DM. 295867a56275SMatthew G Knepley 295967a56275SMatthew G Knepley Level: intermediate 296067a56275SMatthew G Knepley 296167a56275SMatthew G Knepley .seealso: DMCreate() 296267a56275SMatthew G Knepley @*/ 296319fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M) 296467a56275SMatthew G Knepley { 296567a56275SMatthew G Knepley DM B; 296667a56275SMatthew G Knepley char convname[256]; 2967c067b6caSMatthew G. Knepley PetscBool sametype/*, issame */; 296867a56275SMatthew G Knepley PetscErrorCode ierr; 296967a56275SMatthew G Knepley 297067a56275SMatthew G Knepley PetscFunctionBegin; 297167a56275SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 297267a56275SMatthew G Knepley PetscValidType(dm,1); 297367a56275SMatthew G Knepley PetscValidPointer(M,3); 2974251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr); 2975c067b6caSMatthew G. Knepley /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */ 2976c067b6caSMatthew G. Knepley if (sametype) { 2977c067b6caSMatthew G. Knepley *M = dm; 2978c067b6caSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr); 2979c067b6caSMatthew G. Knepley PetscFunctionReturn(0); 2980c067b6caSMatthew G. Knepley } else { 29810298fd71SBarry Smith PetscErrorCode (*conv)(DM, DMType, DM*) = NULL; 298267a56275SMatthew G Knepley 298367a56275SMatthew G Knepley /* 298467a56275SMatthew G Knepley Order of precedence: 298567a56275SMatthew G Knepley 1) See if a specialized converter is known to the current DM. 298667a56275SMatthew G Knepley 2) See if a specialized converter is known to the desired DM class. 298767a56275SMatthew G Knepley 3) See if a good general converter is registered for the desired class 298867a56275SMatthew G Knepley 4) See if a good general converter is known for the current matrix. 298967a56275SMatthew G Knepley 5) Use a really basic converter. 299067a56275SMatthew G Knepley */ 299167a56275SMatthew G Knepley 299267a56275SMatthew G Knepley /* 1) See if a specialized converter is known to the current DM and the desired class */ 299367a56275SMatthew G Knepley ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr); 299467a56275SMatthew G Knepley ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr); 299567a56275SMatthew G Knepley ierr = PetscStrcat(convname,"_");CHKERRQ(ierr); 299667a56275SMatthew G Knepley ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr); 299767a56275SMatthew G Knepley ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr); 29980005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr); 299967a56275SMatthew G Knepley if (conv) goto foundconv; 300067a56275SMatthew G Knepley 300167a56275SMatthew G Knepley /* 2) See if a specialized converter is known to the desired DM class. */ 300282f516ccSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr); 300367a56275SMatthew G Knepley ierr = DMSetType(B, newtype);CHKERRQ(ierr); 300467a56275SMatthew G Knepley ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr); 300567a56275SMatthew G Knepley ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr); 300667a56275SMatthew G Knepley ierr = PetscStrcat(convname,"_");CHKERRQ(ierr); 300767a56275SMatthew G Knepley ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr); 300867a56275SMatthew G Knepley ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr); 30090005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr); 301067a56275SMatthew G Knepley if (conv) { 3011fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 301267a56275SMatthew G Knepley goto foundconv; 301367a56275SMatthew G Knepley } 301467a56275SMatthew G Knepley 301567a56275SMatthew G Knepley #if 0 301667a56275SMatthew G Knepley /* 3) See if a good general converter is registered for the desired class */ 301767a56275SMatthew G Knepley conv = B->ops->convertfrom; 3018fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 301967a56275SMatthew G Knepley if (conv) goto foundconv; 302067a56275SMatthew G Knepley 302167a56275SMatthew G Knepley /* 4) See if a good general converter is known for the current matrix */ 302267a56275SMatthew G Knepley if (dm->ops->convert) { 302367a56275SMatthew G Knepley conv = dm->ops->convert; 302467a56275SMatthew G Knepley } 302567a56275SMatthew G Knepley if (conv) goto foundconv; 302667a56275SMatthew G Knepley #endif 302767a56275SMatthew G Knepley 302867a56275SMatthew G Knepley /* 5) Use a really basic converter. */ 302982f516ccSBarry Smith SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype); 303067a56275SMatthew G Knepley 303167a56275SMatthew G Knepley foundconv: 303267a56275SMatthew G Knepley ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 303367a56275SMatthew G Knepley ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr); 303412fa691eSMatthew G. Knepley /* Things that are independent of DM type: We should consult DMClone() here */ 303512fa691eSMatthew G. Knepley if (dm->maxCell) { 303612fa691eSMatthew G. Knepley const PetscReal *maxCell, *L; 303712fa691eSMatthew G. Knepley const DMBoundaryType *bd; 303812fa691eSMatthew G. Knepley ierr = DMGetPeriodicity(dm, &maxCell, &L, &bd);CHKERRQ(ierr); 303912fa691eSMatthew G. Knepley ierr = DMSetPeriodicity(*M, maxCell, L, bd);CHKERRQ(ierr); 304012fa691eSMatthew G. Knepley } 304167a56275SMatthew G Knepley ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 304267a56275SMatthew G Knepley } 304367a56275SMatthew G Knepley ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr); 304467a56275SMatthew G Knepley PetscFunctionReturn(0); 304567a56275SMatthew G Knepley } 3046264ace61SBarry Smith 3047264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/ 3048264ace61SBarry Smith 3049264ace61SBarry Smith /*@C 30501c84c290SBarry Smith DMRegister - Adds a new DM component implementation 30511c84c290SBarry Smith 30521c84c290SBarry Smith Not Collective 30531c84c290SBarry Smith 30541c84c290SBarry Smith Input Parameters: 30551c84c290SBarry Smith + name - The name of a new user-defined creation routine 30561c84c290SBarry Smith - create_func - The creation routine itself 30571c84c290SBarry Smith 30581c84c290SBarry Smith Notes: 30591c84c290SBarry Smith DMRegister() may be called multiple times to add several user-defined DMs 30601c84c290SBarry Smith 30611c84c290SBarry Smith 30621c84c290SBarry Smith Sample usage: 30631c84c290SBarry Smith .vb 3064bdf89e91SBarry Smith DMRegister("my_da", MyDMCreate); 30651c84c290SBarry Smith .ve 30661c84c290SBarry Smith 30671c84c290SBarry Smith Then, your DM type can be chosen with the procedural interface via 30681c84c290SBarry Smith .vb 30691c84c290SBarry Smith DMCreate(MPI_Comm, DM *); 30701c84c290SBarry Smith DMSetType(DM,"my_da"); 30711c84c290SBarry Smith .ve 30721c84c290SBarry Smith or at runtime via the option 30731c84c290SBarry Smith .vb 30741c84c290SBarry Smith -da_type my_da 30751c84c290SBarry Smith .ve 3076264ace61SBarry Smith 3077264ace61SBarry Smith Level: advanced 30781c84c290SBarry Smith 30791c84c290SBarry Smith .keywords: DM, register 3080bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy() 30811c84c290SBarry Smith 3082264ace61SBarry Smith @*/ 3083bdf89e91SBarry Smith PetscErrorCode DMRegister(const char sname[],PetscErrorCode (*function)(DM)) 3084264ace61SBarry Smith { 3085264ace61SBarry Smith PetscErrorCode ierr; 3086264ace61SBarry Smith 3087264ace61SBarry Smith PetscFunctionBegin; 3088a240a19fSJed Brown ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr); 3089264ace61SBarry Smith PetscFunctionReturn(0); 3090264ace61SBarry Smith } 3091264ace61SBarry Smith 3092b859378eSBarry Smith /*@C 309355849f57SBarry Smith DMLoad - Loads a DM that has been stored in binary with DMView(). 3094b859378eSBarry Smith 3095b859378eSBarry Smith Collective on PetscViewer 3096b859378eSBarry Smith 3097b859378eSBarry Smith Input Parameters: 3098b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or 3099b859378eSBarry Smith some related function before a call to DMLoad(). 3100b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or 3101b859378eSBarry Smith HDF5 file viewer, obtained from PetscViewerHDF5Open() 3102b859378eSBarry Smith 3103b859378eSBarry Smith Level: intermediate 3104b859378eSBarry Smith 3105b859378eSBarry Smith Notes: 310655849f57SBarry Smith The type is determined by the data in the file, any type set into the DM before this call is ignored. 3107b859378eSBarry Smith 3108b859378eSBarry Smith Notes for advanced users: 3109b859378eSBarry Smith Most users should not need to know the details of the binary storage 3110b859378eSBarry Smith format, since DMLoad() and DMView() completely hide these details. 3111b859378eSBarry Smith But for anyone who's interested, the standard binary matrix storage 3112b859378eSBarry Smith format is 3113b859378eSBarry Smith .vb 3114b859378eSBarry Smith has not yet been determined 3115b859378eSBarry Smith .ve 3116b859378eSBarry Smith 3117b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad() 3118b859378eSBarry Smith @*/ 3119b859378eSBarry Smith PetscErrorCode DMLoad(DM newdm, PetscViewer viewer) 3120b859378eSBarry Smith { 31219331c7a4SMatthew G. Knepley PetscBool isbinary, ishdf5; 3122b859378eSBarry Smith PetscErrorCode ierr; 3123b859378eSBarry Smith 3124b859378eSBarry Smith PetscFunctionBegin; 3125b859378eSBarry Smith PetscValidHeaderSpecific(newdm,DM_CLASSID,1); 3126b859378eSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 312732c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 31289331c7a4SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr); 31299331c7a4SMatthew G. Knepley if (isbinary) { 31309331c7a4SMatthew G. Knepley PetscInt classid; 31319331c7a4SMatthew G. Knepley char type[256]; 3132b859378eSBarry Smith 3133060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 31349200755eSBarry Smith if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid); 3135060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 313632c0f0efSBarry Smith ierr = DMSetType(newdm, type);CHKERRQ(ierr); 31379331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 31389331c7a4SMatthew G. Knepley } else if (ishdf5) { 31399331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 31409331c7a4SMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()"); 3141b859378eSBarry Smith PetscFunctionReturn(0); 3142b859378eSBarry Smith } 3143b859378eSBarry Smith 31447da65231SMatthew G Knepley /******************************** FEM Support **********************************/ 31457da65231SMatthew G Knepley 3146a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[]) 3147a6dfd86eSKarl Rupp { 31481d47ebbbSSatish Balay PetscInt f; 31491b30c384SMatthew G Knepley PetscErrorCode ierr; 31501b30c384SMatthew G Knepley 31517da65231SMatthew G Knepley PetscFunctionBegin; 315274778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 31531d47ebbbSSatish Balay for (f = 0; f < len; ++f) { 315457622a8eSBarry Smith ierr = PetscPrintf(PETSC_COMM_SELF, " | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr); 31557da65231SMatthew G Knepley } 31567da65231SMatthew G Knepley PetscFunctionReturn(0); 31577da65231SMatthew G Knepley } 31587da65231SMatthew G Knepley 3159a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[]) 3160a6dfd86eSKarl Rupp { 31611b30c384SMatthew G Knepley PetscInt f, g; 31627da65231SMatthew G Knepley PetscErrorCode ierr; 31637da65231SMatthew G Knepley 31647da65231SMatthew G Knepley PetscFunctionBegin; 316574778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 31661d47ebbbSSatish Balay for (f = 0; f < rows; ++f) { 316774778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |");CHKERRQ(ierr); 31681d47ebbbSSatish Balay for (g = 0; g < cols; ++g) { 3169e3556bceSMatthew G. Knepley ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr); 31707da65231SMatthew G Knepley } 317174778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr); 31727da65231SMatthew G Knepley } 31737da65231SMatthew G Knepley PetscFunctionReturn(0); 31747da65231SMatthew G Knepley } 3175e7c4fc90SDmitry Karpeev 31766113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X) 3177e759306cSMatthew G. Knepley { 31780c5b8624SToby Isaac PetscInt localSize, bs; 31790c5b8624SToby Isaac PetscMPIInt size; 31800c5b8624SToby Isaac Vec x, xglob; 31810c5b8624SToby Isaac const PetscScalar *xarray; 3182e759306cSMatthew G. Knepley PetscErrorCode ierr; 3183e759306cSMatthew G. Knepley 3184e759306cSMatthew G. Knepley PetscFunctionBegin; 31859852e123SBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRQ(ierr); 3186e759306cSMatthew G. Knepley ierr = VecDuplicate(X, &x);CHKERRQ(ierr); 3187e759306cSMatthew G. Knepley ierr = VecCopy(X, x);CHKERRQ(ierr); 31886113b454SMatthew G. Knepley ierr = VecChop(x, tol);CHKERRQ(ierr); 31890c5b8624SToby Isaac ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr); 31900c5b8624SToby Isaac if (size > 1) { 31910c5b8624SToby Isaac ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr); 31920c5b8624SToby Isaac ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr); 31930c5b8624SToby Isaac ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 31940c5b8624SToby Isaac ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr); 31950c5b8624SToby Isaac } else { 31960c5b8624SToby Isaac xglob = x; 31970c5b8624SToby Isaac } 31980c5b8624SToby Isaac ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr); 31990c5b8624SToby Isaac if (size > 1) { 32000c5b8624SToby Isaac ierr = VecDestroy(&xglob);CHKERRQ(ierr); 32010c5b8624SToby Isaac ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr); 32020c5b8624SToby Isaac } 3203e759306cSMatthew G. Knepley ierr = VecDestroy(&x);CHKERRQ(ierr); 3204e759306cSMatthew G. Knepley PetscFunctionReturn(0); 3205e759306cSMatthew G. Knepley } 3206e759306cSMatthew G. Knepley 320788ed4aceSMatthew G Knepley /*@ 320888ed4aceSMatthew G Knepley DMGetDefaultSection - Get the PetscSection encoding the local data layout for the DM. 320988ed4aceSMatthew G Knepley 321088ed4aceSMatthew G Knepley Input Parameter: 321188ed4aceSMatthew G Knepley . dm - The DM 321288ed4aceSMatthew G Knepley 321388ed4aceSMatthew G Knepley Output Parameter: 321488ed4aceSMatthew G Knepley . section - The PetscSection 321588ed4aceSMatthew G Knepley 321688ed4aceSMatthew G Knepley Level: intermediate 321788ed4aceSMatthew G Knepley 321888ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 321988ed4aceSMatthew G Knepley 322088ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection() 322188ed4aceSMatthew G Knepley @*/ 32220adebc6cSBarry Smith PetscErrorCode DMGetDefaultSection(DM dm, PetscSection *section) 32230adebc6cSBarry Smith { 3224fd59a867SMatthew G. Knepley PetscErrorCode ierr; 3225fd59a867SMatthew G. Knepley 322688ed4aceSMatthew G Knepley PetscFunctionBegin; 322788ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 322888ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 32292f0f8703SMatthew G. Knepley if (!dm->defaultSection && dm->ops->createdefaultsection) { 32302f0f8703SMatthew G. Knepley ierr = (*dm->ops->createdefaultsection)(dm);CHKERRQ(ierr); 3231ae71db08SMatthew G. Knepley if (dm->defaultSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->defaultSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);} 32322f0f8703SMatthew G. Knepley } 323388ed4aceSMatthew G Knepley *section = dm->defaultSection; 323488ed4aceSMatthew G Knepley PetscFunctionReturn(0); 323588ed4aceSMatthew G Knepley } 323688ed4aceSMatthew G Knepley 323788ed4aceSMatthew G Knepley /*@ 323888ed4aceSMatthew G Knepley DMSetDefaultSection - Set the PetscSection encoding the local data layout for the DM. 323988ed4aceSMatthew G Knepley 324088ed4aceSMatthew G Knepley Input Parameters: 324188ed4aceSMatthew G Knepley + dm - The DM 324288ed4aceSMatthew G Knepley - section - The PetscSection 324388ed4aceSMatthew G Knepley 324488ed4aceSMatthew G Knepley Level: intermediate 324588ed4aceSMatthew G Knepley 324688ed4aceSMatthew G Knepley Note: Any existing Section will be destroyed 324788ed4aceSMatthew G Knepley 324888ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection() 324988ed4aceSMatthew G Knepley @*/ 32500adebc6cSBarry Smith PetscErrorCode DMSetDefaultSection(DM dm, PetscSection section) 32510adebc6cSBarry Smith { 3252c473ab19SMatthew G. Knepley PetscInt numFields = 0; 3253af122d2aSMatthew G Knepley PetscInt f; 325488ed4aceSMatthew G Knepley PetscErrorCode ierr; 325588ed4aceSMatthew G Knepley 325688ed4aceSMatthew G Knepley PetscFunctionBegin; 325788ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3258c473ab19SMatthew G. Knepley if (section) { 32591d799100SJed Brown PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 32601d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 3261c473ab19SMatthew G. Knepley } 326288ed4aceSMatthew G Knepley ierr = PetscSectionDestroy(&dm->defaultSection);CHKERRQ(ierr); 326388ed4aceSMatthew G Knepley dm->defaultSection = section; 3264c473ab19SMatthew G. Knepley if (section) {ierr = PetscSectionGetNumFields(dm->defaultSection, &numFields);CHKERRQ(ierr);} 3265af122d2aSMatthew G Knepley if (numFields) { 3266af122d2aSMatthew G Knepley ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr); 3267af122d2aSMatthew G Knepley for (f = 0; f < numFields; ++f) { 32680f21e855SMatthew G. Knepley PetscObject disc; 3269af122d2aSMatthew G Knepley const char *name; 3270af122d2aSMatthew G Knepley 3271af122d2aSMatthew G Knepley ierr = PetscSectionGetFieldName(dm->defaultSection, f, &name);CHKERRQ(ierr); 32720f21e855SMatthew G. Knepley ierr = DMGetField(dm, f, &disc);CHKERRQ(ierr); 32730f21e855SMatthew G. Knepley ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr); 3274af122d2aSMatthew G Knepley } 3275af122d2aSMatthew G Knepley } 32761d799100SJed Brown /* The global section will be rebuilt in the next call to DMGetDefaultGlobalSection(). */ 32771d799100SJed Brown ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr); 327888ed4aceSMatthew G Knepley PetscFunctionReturn(0); 327988ed4aceSMatthew G Knepley } 328088ed4aceSMatthew G Knepley 32819435951eSToby Isaac /*@ 32829435951eSToby Isaac DMGetDefaultConstraints - Get the PetscSection and Mat the specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation. 32839435951eSToby Isaac 3284e228b242SToby Isaac not collective 3285e228b242SToby Isaac 32869435951eSToby Isaac Input Parameter: 32879435951eSToby Isaac . dm - The DM 32889435951eSToby Isaac 32899435951eSToby Isaac Output Parameter: 32909435951eSToby 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. 32919435951eSToby 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. 32929435951eSToby Isaac 32939435951eSToby Isaac Level: advanced 32949435951eSToby Isaac 32959435951eSToby Isaac Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat. 32969435951eSToby Isaac 32979435951eSToby Isaac .seealso: DMSetDefaultConstraints() 32989435951eSToby Isaac @*/ 32999435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat) 33009435951eSToby Isaac { 33019435951eSToby Isaac PetscErrorCode ierr; 33029435951eSToby Isaac 33039435951eSToby Isaac PetscFunctionBegin; 33049435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 33059435951eSToby Isaac if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);} 330645a75d81SToby Isaac if (section) {*section = dm->defaultConstraintSection;} 330745a75d81SToby Isaac if (mat) {*mat = dm->defaultConstraintMat;} 33089435951eSToby Isaac PetscFunctionReturn(0); 33099435951eSToby Isaac } 33109435951eSToby Isaac 33119435951eSToby Isaac /*@ 33129435951eSToby Isaac DMSetDefaultConstraints - Set the PetscSection and Mat the specify the local constraint interpolation. 33139435951eSToby Isaac 33149435951eSToby 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(). 33159435951eSToby Isaac 33169435951eSToby 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. 33179435951eSToby Isaac 3318e228b242SToby Isaac collective on dm 3319e228b242SToby Isaac 33209435951eSToby Isaac Input Parameters: 33219435951eSToby Isaac + dm - The DM 3322e228b242SToby 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). 3323e228b242SToby 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). 33249435951eSToby Isaac 33259435951eSToby Isaac Level: advanced 33269435951eSToby Isaac 33279435951eSToby Isaac Note: This increments the references of the PetscSection and the Mat, so they user can destroy them 33289435951eSToby Isaac 33299435951eSToby Isaac .seealso: DMGetDefaultConstraints() 33309435951eSToby Isaac @*/ 33319435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat) 33329435951eSToby Isaac { 3333e228b242SToby Isaac PetscMPIInt result; 33349435951eSToby Isaac PetscErrorCode ierr; 33359435951eSToby Isaac 33369435951eSToby Isaac PetscFunctionBegin; 33379435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3338e228b242SToby Isaac if (section) { 3339e228b242SToby Isaac PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 3340e228b242SToby Isaac ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRQ(ierr); 3341f60917d2SBarry Smith if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator"); 3342e228b242SToby Isaac } 3343e228b242SToby Isaac if (mat) { 3344e228b242SToby Isaac PetscValidHeaderSpecific(mat,MAT_CLASSID,3); 3345e228b242SToby Isaac ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRQ(ierr); 3346f60917d2SBarry Smith if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator"); 3347e228b242SToby Isaac } 33489435951eSToby Isaac ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 33499435951eSToby Isaac ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr); 33509435951eSToby Isaac dm->defaultConstraintSection = section; 33519435951eSToby Isaac ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr); 33529435951eSToby Isaac ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr); 33539435951eSToby Isaac dm->defaultConstraintMat = mat; 33549435951eSToby Isaac PetscFunctionReturn(0); 33559435951eSToby Isaac } 33569435951eSToby Isaac 3357f741bcd2SMatthew G. Knepley #ifdef PETSC_USE_DEBUG 3358507e4973SMatthew G. Knepley /* 3359507e4973SMatthew G. Knepley DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections. 3360507e4973SMatthew G. Knepley 3361507e4973SMatthew G. Knepley Input Parameters: 3362507e4973SMatthew G. Knepley + dm - The DM 3363507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout 3364507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout 3365507e4973SMatthew G. Knepley 3366507e4973SMatthew G. Knepley Level: intermediate 3367507e4973SMatthew G. Knepley 3368507e4973SMatthew G. Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF() 3369507e4973SMatthew G. Knepley */ 3370f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection) 3371507e4973SMatthew G. Knepley { 3372507e4973SMatthew G. Knepley MPI_Comm comm; 3373507e4973SMatthew G. Knepley PetscLayout layout; 3374507e4973SMatthew G. Knepley const PetscInt *ranges; 3375507e4973SMatthew G. Knepley PetscInt pStart, pEnd, p, nroots; 3376507e4973SMatthew G. Knepley PetscMPIInt size, rank; 3377507e4973SMatthew G. Knepley PetscBool valid = PETSC_TRUE, gvalid; 3378507e4973SMatthew G. Knepley PetscErrorCode ierr; 3379507e4973SMatthew G. Knepley 3380507e4973SMatthew G. Knepley PetscFunctionBegin; 3381507e4973SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr); 3382507e4973SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3383507e4973SMatthew G. Knepley ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 3384507e4973SMatthew G. Knepley ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 3385507e4973SMatthew G. Knepley ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr); 3386507e4973SMatthew G. Knepley ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr); 3387507e4973SMatthew G. Knepley ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr); 3388507e4973SMatthew G. Knepley ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr); 3389507e4973SMatthew G. Knepley ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr); 3390507e4973SMatthew G. Knepley ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr); 3391507e4973SMatthew G. Knepley ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr); 3392507e4973SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 3393f741bcd2SMatthew G. Knepley PetscInt dof, cdof, off, gdof, gcdof, goff, gsize, d; 3394507e4973SMatthew G. Knepley 3395507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr); 3396507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr); 3397507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr); 3398507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 3399507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 3400507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr); 3401507e4973SMatthew G. Knepley if (!gdof) continue; /* Censored point */ 3402507e4973SMatthew 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;} 3403507e4973SMatthew 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;} 3404507e4973SMatthew G. Knepley if (gdof < 0) { 3405507e4973SMatthew G. Knepley gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 3406507e4973SMatthew G. Knepley for (d = 0; d < gsize; ++d) { 3407507e4973SMatthew G. Knepley PetscInt offset = -(goff+1) + d, r; 3408507e4973SMatthew G. Knepley 3409507e4973SMatthew G. Knepley ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr); 3410507e4973SMatthew G. Knepley if (r < 0) r = -(r+2); 3411507e4973SMatthew 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;} 3412507e4973SMatthew G. Knepley } 3413507e4973SMatthew G. Knepley } 3414507e4973SMatthew G. Knepley } 3415507e4973SMatthew G. Knepley ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr); 3416507e4973SMatthew G. Knepley ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr); 3417b2566f29SBarry Smith ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr); 3418507e4973SMatthew G. Knepley if (!gvalid) { 3419507e4973SMatthew G. Knepley ierr = DMView(dm, NULL);CHKERRQ(ierr); 3420507e4973SMatthew G. Knepley SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections"); 3421507e4973SMatthew G. Knepley } 3422507e4973SMatthew G. Knepley PetscFunctionReturn(0); 3423507e4973SMatthew G. Knepley } 3424f741bcd2SMatthew G. Knepley #endif 3425507e4973SMatthew G. Knepley 342688ed4aceSMatthew G Knepley /*@ 342788ed4aceSMatthew G Knepley DMGetDefaultGlobalSection - Get the PetscSection encoding the global data layout for the DM. 342888ed4aceSMatthew G Knepley 34298b1ab98fSJed Brown Collective on DM 34308b1ab98fSJed Brown 343188ed4aceSMatthew G Knepley Input Parameter: 343288ed4aceSMatthew G Knepley . dm - The DM 343388ed4aceSMatthew G Knepley 343488ed4aceSMatthew G Knepley Output Parameter: 343588ed4aceSMatthew G Knepley . section - The PetscSection 343688ed4aceSMatthew G Knepley 343788ed4aceSMatthew G Knepley Level: intermediate 343888ed4aceSMatthew G Knepley 343988ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 344088ed4aceSMatthew G Knepley 344188ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultSection() 344288ed4aceSMatthew G Knepley @*/ 34430adebc6cSBarry Smith PetscErrorCode DMGetDefaultGlobalSection(DM dm, PetscSection *section) 34440adebc6cSBarry Smith { 344588ed4aceSMatthew G Knepley PetscErrorCode ierr; 344688ed4aceSMatthew G Knepley 344788ed4aceSMatthew G Knepley PetscFunctionBegin; 344888ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 344988ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 345088ed4aceSMatthew G Knepley if (!dm->defaultGlobalSection) { 3451fd59a867SMatthew G. Knepley PetscSection s; 3452fd59a867SMatthew G. Knepley 3453fd59a867SMatthew G. Knepley ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr); 3454fd59a867SMatthew 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"); 3455fd59a867SMatthew G. Knepley if (!dm->sf) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSF in order to create a global PetscSection"); 345615b58121SMatthew G. Knepley ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->defaultGlobalSection);CHKERRQ(ierr); 3457cf06b437SMatthew G. Knepley ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr); 3458ce94432eSBarry Smith ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->defaultGlobalSection, &dm->map);CHKERRQ(ierr); 3459685405a1SBarry Smith ierr = PetscSectionViewFromOptions(dm->defaultGlobalSection, NULL, "-global_section_view");CHKERRQ(ierr); 346088ed4aceSMatthew G Knepley } 346188ed4aceSMatthew G Knepley *section = dm->defaultGlobalSection; 346288ed4aceSMatthew G Knepley PetscFunctionReturn(0); 346388ed4aceSMatthew G Knepley } 346488ed4aceSMatthew G Knepley 3465b21d0597SMatthew G Knepley /*@ 3466b21d0597SMatthew G Knepley DMSetDefaultGlobalSection - Set the PetscSection encoding the global data layout for the DM. 3467b21d0597SMatthew G Knepley 3468b21d0597SMatthew G Knepley Input Parameters: 3469b21d0597SMatthew G Knepley + dm - The DM 34705080bbdbSMatthew G Knepley - section - The PetscSection, or NULL 3471b21d0597SMatthew G Knepley 3472b21d0597SMatthew G Knepley Level: intermediate 3473b21d0597SMatthew G Knepley 3474b21d0597SMatthew G Knepley Note: Any existing Section will be destroyed 3475b21d0597SMatthew G Knepley 3476b21d0597SMatthew G Knepley .seealso: DMGetDefaultGlobalSection(), DMSetDefaultSection() 3477b21d0597SMatthew G Knepley @*/ 34780adebc6cSBarry Smith PetscErrorCode DMSetDefaultGlobalSection(DM dm, PetscSection section) 34790adebc6cSBarry Smith { 3480b21d0597SMatthew G Knepley PetscErrorCode ierr; 3481b21d0597SMatthew G Knepley 3482b21d0597SMatthew G Knepley PetscFunctionBegin; 3483b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 34845080bbdbSMatthew G Knepley if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 34851d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 3486b21d0597SMatthew G Knepley ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr); 3487b21d0597SMatthew G Knepley dm->defaultGlobalSection = section; 3488507e4973SMatthew G. Knepley #ifdef PETSC_USE_DEBUG 3489f741bcd2SMatthew G. Knepley if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->defaultSection, section);CHKERRQ(ierr);} 3490507e4973SMatthew G. Knepley #endif 3491b21d0597SMatthew G Knepley PetscFunctionReturn(0); 3492b21d0597SMatthew G Knepley } 3493b21d0597SMatthew G Knepley 349488ed4aceSMatthew G Knepley /*@ 349588ed4aceSMatthew G Knepley DMGetDefaultSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set, 349688ed4aceSMatthew G Knepley it is created from the default PetscSection layouts in the DM. 349788ed4aceSMatthew G Knepley 349888ed4aceSMatthew G Knepley Input Parameter: 349988ed4aceSMatthew G Knepley . dm - The DM 350088ed4aceSMatthew G Knepley 350188ed4aceSMatthew G Knepley Output Parameter: 350288ed4aceSMatthew G Knepley . sf - The PetscSF 350388ed4aceSMatthew G Knepley 350488ed4aceSMatthew G Knepley Level: intermediate 350588ed4aceSMatthew G Knepley 350688ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 350788ed4aceSMatthew G Knepley 350888ed4aceSMatthew G Knepley .seealso: DMSetDefaultSF(), DMCreateDefaultSF() 350988ed4aceSMatthew G Knepley @*/ 35100adebc6cSBarry Smith PetscErrorCode DMGetDefaultSF(DM dm, PetscSF *sf) 35110adebc6cSBarry Smith { 351288ed4aceSMatthew G Knepley PetscInt nroots; 351388ed4aceSMatthew G Knepley PetscErrorCode ierr; 351488ed4aceSMatthew G Knepley 351588ed4aceSMatthew G Knepley PetscFunctionBegin; 351688ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 351788ed4aceSMatthew G Knepley PetscValidPointer(sf, 2); 35180298fd71SBarry Smith ierr = PetscSFGetGraph(dm->defaultSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr); 351988ed4aceSMatthew G Knepley if (nroots < 0) { 352088ed4aceSMatthew G Knepley PetscSection section, gSection; 352188ed4aceSMatthew G Knepley 352288ed4aceSMatthew G Knepley ierr = DMGetDefaultSection(dm, §ion);CHKERRQ(ierr); 352331ea6d37SMatthew G Knepley if (section) { 352488ed4aceSMatthew G Knepley ierr = DMGetDefaultGlobalSection(dm, &gSection);CHKERRQ(ierr); 352588ed4aceSMatthew G Knepley ierr = DMCreateDefaultSF(dm, section, gSection);CHKERRQ(ierr); 352631ea6d37SMatthew G Knepley } else { 35270298fd71SBarry Smith *sf = NULL; 352831ea6d37SMatthew G Knepley PetscFunctionReturn(0); 352931ea6d37SMatthew G Knepley } 353088ed4aceSMatthew G Knepley } 353188ed4aceSMatthew G Knepley *sf = dm->defaultSF; 353288ed4aceSMatthew G Knepley PetscFunctionReturn(0); 353388ed4aceSMatthew G Knepley } 353488ed4aceSMatthew G Knepley 353588ed4aceSMatthew G Knepley /*@ 353688ed4aceSMatthew G Knepley DMSetDefaultSF - Set the PetscSF encoding the parallel dof overlap for the DM 353788ed4aceSMatthew G Knepley 353888ed4aceSMatthew G Knepley Input Parameters: 353988ed4aceSMatthew G Knepley + dm - The DM 354088ed4aceSMatthew G Knepley - sf - The PetscSF 354188ed4aceSMatthew G Knepley 354288ed4aceSMatthew G Knepley Level: intermediate 354388ed4aceSMatthew G Knepley 354488ed4aceSMatthew G Knepley Note: Any previous SF is destroyed 354588ed4aceSMatthew G Knepley 354688ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMCreateDefaultSF() 354788ed4aceSMatthew G Knepley @*/ 35480adebc6cSBarry Smith PetscErrorCode DMSetDefaultSF(DM dm, PetscSF sf) 35490adebc6cSBarry Smith { 355088ed4aceSMatthew G Knepley PetscErrorCode ierr; 355188ed4aceSMatthew G Knepley 355288ed4aceSMatthew G Knepley PetscFunctionBegin; 355388ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 355488ed4aceSMatthew G Knepley PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 355588ed4aceSMatthew G Knepley ierr = PetscSFDestroy(&dm->defaultSF);CHKERRQ(ierr); 355688ed4aceSMatthew G Knepley dm->defaultSF = sf; 355788ed4aceSMatthew G Knepley PetscFunctionReturn(0); 355888ed4aceSMatthew G Knepley } 355988ed4aceSMatthew G Knepley 356088ed4aceSMatthew G Knepley /*@C 356188ed4aceSMatthew G Knepley DMCreateDefaultSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections 356288ed4aceSMatthew G Knepley describing the data layout. 356388ed4aceSMatthew G Knepley 356488ed4aceSMatthew G Knepley Input Parameters: 356588ed4aceSMatthew G Knepley + dm - The DM 356688ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout 356788ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout 356888ed4aceSMatthew G Knepley 356988ed4aceSMatthew G Knepley Level: intermediate 357088ed4aceSMatthew G Knepley 357188ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF() 357288ed4aceSMatthew G Knepley @*/ 357388ed4aceSMatthew G Knepley PetscErrorCode DMCreateDefaultSF(DM dm, PetscSection localSection, PetscSection globalSection) 357488ed4aceSMatthew G Knepley { 357582f516ccSBarry Smith MPI_Comm comm; 357688ed4aceSMatthew G Knepley PetscLayout layout; 357788ed4aceSMatthew G Knepley const PetscInt *ranges; 357888ed4aceSMatthew G Knepley PetscInt *local; 357988ed4aceSMatthew G Knepley PetscSFNode *remote; 3580ecd73843SMatthew G. Knepley PetscInt pStart, pEnd, p, nroots, nleaves = 0, l; 358188ed4aceSMatthew G Knepley PetscMPIInt size, rank; 358288ed4aceSMatthew G Knepley PetscErrorCode ierr; 358388ed4aceSMatthew G Knepley 358488ed4aceSMatthew G Knepley PetscFunctionBegin; 358582f516ccSBarry Smith ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr); 358688ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 358788ed4aceSMatthew G Knepley ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 358888ed4aceSMatthew G Knepley ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 358988ed4aceSMatthew G Knepley ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr); 359088ed4aceSMatthew G Knepley ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr); 359188ed4aceSMatthew G Knepley ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr); 359288ed4aceSMatthew G Knepley ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr); 359388ed4aceSMatthew G Knepley ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr); 359488ed4aceSMatthew G Knepley ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr); 359588ed4aceSMatthew G Knepley ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr); 3596ecd73843SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 35976636e97aSMatthew G Knepley PetscInt gdof, gcdof; 359888ed4aceSMatthew G Knepley 35996636e97aSMatthew G Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 36006636e97aSMatthew G Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 3601235fbf56SMatthew 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)); 36026636e97aSMatthew G Knepley nleaves += gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 360388ed4aceSMatthew G Knepley } 3604785e854fSJed Brown ierr = PetscMalloc1(nleaves, &local);CHKERRQ(ierr); 3605785e854fSJed Brown ierr = PetscMalloc1(nleaves, &remote);CHKERRQ(ierr); 360688ed4aceSMatthew G Knepley for (p = pStart, l = 0; p < pEnd; ++p) { 36071f588964SMatthew G Knepley const PetscInt *cind; 36086636e97aSMatthew G Knepley PetscInt dof, cdof, off, gdof, gcdof, goff, gsize, d, c; 360988ed4aceSMatthew G Knepley 361088ed4aceSMatthew G Knepley ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr); 361188ed4aceSMatthew G Knepley ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr); 361288ed4aceSMatthew G Knepley ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr); 361388ed4aceSMatthew G Knepley ierr = PetscSectionGetConstraintIndices(localSection, p, &cind);CHKERRQ(ierr); 361488ed4aceSMatthew G Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 36156636e97aSMatthew G Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 361688ed4aceSMatthew G Knepley ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr); 36176636e97aSMatthew G Knepley if (!gdof) continue; /* Censored point */ 36186636e97aSMatthew G Knepley gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 36196636e97aSMatthew G Knepley if (gsize != dof-cdof) { 3620057b4bcdSMatthew 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); 36216636e97aSMatthew G Knepley cdof = 0; /* Ignore constraints */ 36226636e97aSMatthew G Knepley } 362388ed4aceSMatthew G Knepley for (d = 0, c = 0; d < dof; ++d) { 362488ed4aceSMatthew G Knepley if ((c < cdof) && (cind[c] == d)) {++c; continue;} 362588ed4aceSMatthew G Knepley local[l+d-c] = off+d; 362688ed4aceSMatthew G Knepley } 362788ed4aceSMatthew G Knepley if (gdof < 0) { 36286636e97aSMatthew G Knepley for (d = 0; d < gsize; ++d, ++l) { 362988ed4aceSMatthew G Knepley PetscInt offset = -(goff+1) + d, r; 363088ed4aceSMatthew G Knepley 363105376888SMatthew G. Knepley ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr); 363231d3f06eSJed Brown if (r < 0) r = -(r+2); 363305376888SMatthew 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); 363488ed4aceSMatthew G Knepley remote[l].rank = r; 363588ed4aceSMatthew G Knepley remote[l].index = offset - ranges[r]; 363688ed4aceSMatthew G Knepley } 363788ed4aceSMatthew G Knepley } else { 36386636e97aSMatthew G Knepley for (d = 0; d < gsize; ++d, ++l) { 363988ed4aceSMatthew G Knepley remote[l].rank = rank; 364088ed4aceSMatthew G Knepley remote[l].index = goff+d - ranges[rank]; 364188ed4aceSMatthew G Knepley } 364288ed4aceSMatthew G Knepley } 364388ed4aceSMatthew G Knepley } 36446636e97aSMatthew G Knepley if (l != nleaves) SETERRQ2(comm, PETSC_ERR_PLIB, "Iteration error, l %d != nleaves %d", l, nleaves); 364588ed4aceSMatthew G Knepley ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr); 364688ed4aceSMatthew G Knepley ierr = PetscSFSetGraph(dm->defaultSF, nroots, nleaves, local, PETSC_OWN_POINTER, remote, PETSC_OWN_POINTER);CHKERRQ(ierr); 364788ed4aceSMatthew G Knepley PetscFunctionReturn(0); 364888ed4aceSMatthew G Knepley } 3649af122d2aSMatthew G Knepley 3650b21d0597SMatthew G Knepley /*@ 3651b21d0597SMatthew G Knepley DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM. 3652b21d0597SMatthew G Knepley 3653b21d0597SMatthew G Knepley Input Parameter: 3654b21d0597SMatthew G Knepley . dm - The DM 3655b21d0597SMatthew G Knepley 3656b21d0597SMatthew G Knepley Output Parameter: 3657b21d0597SMatthew G Knepley . sf - The PetscSF 3658b21d0597SMatthew G Knepley 3659b21d0597SMatthew G Knepley Level: intermediate 3660b21d0597SMatthew G Knepley 3661b21d0597SMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 3662b21d0597SMatthew G Knepley 3663057b4bcdSMatthew G Knepley .seealso: DMSetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF() 3664b21d0597SMatthew G Knepley @*/ 36650adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf) 36660adebc6cSBarry Smith { 3667b21d0597SMatthew G Knepley PetscFunctionBegin; 3668b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3669b21d0597SMatthew G Knepley PetscValidPointer(sf, 2); 3670b21d0597SMatthew G Knepley *sf = dm->sf; 3671b21d0597SMatthew G Knepley PetscFunctionReturn(0); 3672b21d0597SMatthew G Knepley } 3673b21d0597SMatthew G Knepley 3674057b4bcdSMatthew G Knepley /*@ 3675057b4bcdSMatthew G Knepley DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM. 3676057b4bcdSMatthew G Knepley 3677057b4bcdSMatthew G Knepley Input Parameters: 3678057b4bcdSMatthew G Knepley + dm - The DM 3679057b4bcdSMatthew G Knepley - sf - The PetscSF 3680057b4bcdSMatthew G Knepley 3681057b4bcdSMatthew G Knepley Level: intermediate 3682057b4bcdSMatthew G Knepley 3683057b4bcdSMatthew G Knepley .seealso: DMGetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF() 3684057b4bcdSMatthew G Knepley @*/ 36850adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf) 36860adebc6cSBarry Smith { 3687057b4bcdSMatthew G Knepley PetscErrorCode ierr; 3688057b4bcdSMatthew G Knepley 3689057b4bcdSMatthew G Knepley PetscFunctionBegin; 3690057b4bcdSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3691057b4bcdSMatthew G Knepley PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 1); 3692057b4bcdSMatthew G Knepley ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr); 3693057b4bcdSMatthew G Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 3694057b4bcdSMatthew G Knepley dm->sf = sf; 3695057b4bcdSMatthew G Knepley PetscFunctionReturn(0); 3696057b4bcdSMatthew G Knepley } 3697057b4bcdSMatthew G Knepley 36982764a2aaSMatthew G. Knepley /*@ 36992764a2aaSMatthew G. Knepley DMGetDS - Get the PetscDS 37002764a2aaSMatthew G. Knepley 37012764a2aaSMatthew G. Knepley Input Parameter: 37022764a2aaSMatthew G. Knepley . dm - The DM 37032764a2aaSMatthew G. Knepley 37042764a2aaSMatthew G. Knepley Output Parameter: 37052764a2aaSMatthew G. Knepley . prob - The PetscDS 37062764a2aaSMatthew G. Knepley 37072764a2aaSMatthew G. Knepley Level: developer 37082764a2aaSMatthew G. Knepley 37092764a2aaSMatthew G. Knepley .seealso: DMSetDS() 37102764a2aaSMatthew G. Knepley @*/ 37112764a2aaSMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob) 3712af122d2aSMatthew G Knepley { 3713af122d2aSMatthew G Knepley PetscFunctionBegin; 3714af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 37150f21e855SMatthew G. Knepley PetscValidPointer(prob, 2); 37160f21e855SMatthew G. Knepley *prob = dm->prob; 37170f21e855SMatthew G. Knepley PetscFunctionReturn(0); 37180f21e855SMatthew G. Knepley } 37190f21e855SMatthew G. Knepley 37202764a2aaSMatthew G. Knepley /*@ 37212764a2aaSMatthew G. Knepley DMSetDS - Set the PetscDS 37222764a2aaSMatthew G. Knepley 37232764a2aaSMatthew G. Knepley Input Parameters: 37242764a2aaSMatthew G. Knepley + dm - The DM 37252764a2aaSMatthew G. Knepley - prob - The PetscDS 37262764a2aaSMatthew G. Knepley 37272764a2aaSMatthew G. Knepley Level: developer 37282764a2aaSMatthew G. Knepley 37292764a2aaSMatthew G. Knepley .seealso: DMGetDS() 37302764a2aaSMatthew G. Knepley @*/ 37312764a2aaSMatthew G. Knepley PetscErrorCode DMSetDS(DM dm, PetscDS prob) 37320f21e855SMatthew G. Knepley { 37330f21e855SMatthew G. Knepley PetscErrorCode ierr; 37340f21e855SMatthew G. Knepley 37350f21e855SMatthew G. Knepley PetscFunctionBegin; 37360f21e855SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 37372764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 2); 373837316535SToby Isaac ierr = PetscObjectReference((PetscObject) prob);CHKERRQ(ierr); 37392764a2aaSMatthew G. Knepley ierr = PetscDSDestroy(&dm->prob);CHKERRQ(ierr); 37400f21e855SMatthew G. Knepley dm->prob = prob; 37410f21e855SMatthew G. Knepley PetscFunctionReturn(0); 37420f21e855SMatthew G. Knepley } 37430f21e855SMatthew G. Knepley 37440f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields) 37450f21e855SMatthew G. Knepley { 37460f21e855SMatthew G. Knepley PetscErrorCode ierr; 37470f21e855SMatthew G. Knepley 37480f21e855SMatthew G. Knepley PetscFunctionBegin; 37490f21e855SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 37502764a2aaSMatthew G. Knepley ierr = PetscDSGetNumFields(dm->prob, numFields);CHKERRQ(ierr); 3751af122d2aSMatthew G Knepley PetscFunctionReturn(0); 3752af122d2aSMatthew G Knepley } 3753af122d2aSMatthew G Knepley 3754af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields) 3755af122d2aSMatthew G Knepley { 37560f21e855SMatthew G. Knepley PetscInt Nf, f; 3757af122d2aSMatthew G Knepley PetscErrorCode ierr; 3758af122d2aSMatthew G Knepley 3759af122d2aSMatthew G Knepley PetscFunctionBegin; 3760af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 37612764a2aaSMatthew G. Knepley ierr = PetscDSGetNumFields(dm->prob, &Nf);CHKERRQ(ierr); 37620f21e855SMatthew G. Knepley for (f = Nf; f < numFields; ++f) { 37630f21e855SMatthew G. Knepley PetscContainer obj; 37640f21e855SMatthew G. Knepley 37650f21e855SMatthew G. Knepley ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr); 37662764a2aaSMatthew G. Knepley ierr = PetscDSSetDiscretization(dm->prob, f, (PetscObject) obj);CHKERRQ(ierr); 37670f21e855SMatthew G. Knepley ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr); 3768af122d2aSMatthew G Knepley } 3769af122d2aSMatthew G Knepley PetscFunctionReturn(0); 3770af122d2aSMatthew G Knepley } 3771af122d2aSMatthew G Knepley 3772c1929be8SMatthew G. Knepley /*@ 3773c1929be8SMatthew G. Knepley DMGetField - Return the discretization object for a given DM field 3774c1929be8SMatthew G. Knepley 3775c1929be8SMatthew G. Knepley Not collective 3776c1929be8SMatthew G. Knepley 3777c1929be8SMatthew G. Knepley Input Parameters: 3778c1929be8SMatthew G. Knepley + dm - The DM 3779c1929be8SMatthew G. Knepley - f - The field number 3780c1929be8SMatthew G. Knepley 3781c1929be8SMatthew G. Knepley Output Parameter: 3782c1929be8SMatthew G. Knepley . field - The discretization object 3783c1929be8SMatthew G. Knepley 3784c1929be8SMatthew G. Knepley Level: developer 3785c1929be8SMatthew G. Knepley 3786c1929be8SMatthew G. Knepley .seealso: DMSetField() 3787c1929be8SMatthew G. Knepley @*/ 3788af122d2aSMatthew G Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, PetscObject *field) 3789af122d2aSMatthew G Knepley { 37900f21e855SMatthew G. Knepley PetscErrorCode ierr; 37910f21e855SMatthew G. Knepley 3792af122d2aSMatthew G Knepley PetscFunctionBegin; 3793af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 37942764a2aaSMatthew G. Knepley ierr = PetscDSGetDiscretization(dm->prob, f, field);CHKERRQ(ierr); 3795decb47aaSMatthew G. Knepley PetscFunctionReturn(0); 3796decb47aaSMatthew G. Knepley } 3797decb47aaSMatthew G. Knepley 3798c1929be8SMatthew G. Knepley /*@ 3799c1929be8SMatthew G. Knepley DMSetField - Set the discretization object for a given DM field 3800c1929be8SMatthew G. Knepley 3801c1929be8SMatthew G. Knepley Logically collective on DM 3802c1929be8SMatthew G. Knepley 3803c1929be8SMatthew G. Knepley Input Parameters: 3804c1929be8SMatthew G. Knepley + dm - The DM 3805c1929be8SMatthew G. Knepley . f - The field number 3806c1929be8SMatthew G. Knepley - field - The discretization object 3807c1929be8SMatthew G. Knepley 3808c1929be8SMatthew G. Knepley Level: developer 3809c1929be8SMatthew G. Knepley 3810c1929be8SMatthew G. Knepley .seealso: DMGetField() 3811c1929be8SMatthew G. Knepley @*/ 3812decb47aaSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, PetscObject field) 3813decb47aaSMatthew G. Knepley { 3814decb47aaSMatthew G. Knepley PetscErrorCode ierr; 3815decb47aaSMatthew G. Knepley 3816decb47aaSMatthew G. Knepley PetscFunctionBegin; 3817decb47aaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 38182764a2aaSMatthew G. Knepley ierr = PetscDSSetDiscretization(dm->prob, f, field);CHKERRQ(ierr); 3819af122d2aSMatthew G Knepley PetscFunctionReturn(0); 3820af122d2aSMatthew G Knepley } 38216636e97aSMatthew G Knepley 3822b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx) 3823b64e0483SPeter Brune { 3824b64e0483SPeter Brune DM dm_coord,dmc_coord; 3825b64e0483SPeter Brune PetscErrorCode ierr; 3826b64e0483SPeter Brune Vec coords,ccoords; 38276dbf9973SLawrence Mitchell Mat inject; 3828b64e0483SPeter Brune PetscFunctionBegin; 3829b64e0483SPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 3830b64e0483SPeter Brune ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr); 3831b64e0483SPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 3832b64e0483SPeter Brune ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr); 3833b64e0483SPeter Brune if (coords && !ccoords) { 3834b64e0483SPeter Brune ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr); 38356668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 38366dbf9973SLawrence Mitchell ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr); 38372adcf181SLawrence Mitchell ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr); 38386dbf9973SLawrence Mitchell ierr = MatDestroy(&inject);CHKERRQ(ierr); 3839b64e0483SPeter Brune ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr); 3840b64e0483SPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 3841b64e0483SPeter Brune } 3842b64e0483SPeter Brune PetscFunctionReturn(0); 3843b64e0483SPeter Brune } 3844b64e0483SPeter Brune 384503dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx) 384603dadc2fSPeter Brune { 384703dadc2fSPeter Brune DM dm_coord,subdm_coord; 384803dadc2fSPeter Brune PetscErrorCode ierr; 384903dadc2fSPeter Brune Vec coords,ccoords,clcoords; 385003dadc2fSPeter Brune VecScatter *scat_i,*scat_g; 385103dadc2fSPeter Brune PetscFunctionBegin; 385203dadc2fSPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 385303dadc2fSPeter Brune ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr); 385403dadc2fSPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 385503dadc2fSPeter Brune ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr); 385603dadc2fSPeter Brune if (coords && !ccoords) { 385703dadc2fSPeter Brune ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr); 38586668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 385903dadc2fSPeter Brune ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr); 386024640c55SToby Isaac ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr); 386103dadc2fSPeter Brune ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr); 386203dadc2fSPeter Brune ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 386303dadc2fSPeter Brune ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 386403dadc2fSPeter Brune ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 386503dadc2fSPeter Brune ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 386603dadc2fSPeter Brune ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr); 386703dadc2fSPeter Brune ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr); 386803dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr); 386903dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr); 387003dadc2fSPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 387103dadc2fSPeter Brune ierr = VecDestroy(&clcoords);CHKERRQ(ierr); 387203dadc2fSPeter Brune ierr = PetscFree(scat_i);CHKERRQ(ierr); 387303dadc2fSPeter Brune ierr = PetscFree(scat_g);CHKERRQ(ierr); 387403dadc2fSPeter Brune } 387503dadc2fSPeter Brune PetscFunctionReturn(0); 387603dadc2fSPeter Brune } 387703dadc2fSPeter Brune 3878c73cfb54SMatthew G. Knepley /*@ 3879c73cfb54SMatthew G. Knepley DMGetDimension - Return the topological dimension of the DM 3880c73cfb54SMatthew G. Knepley 3881c73cfb54SMatthew G. Knepley Not collective 3882c73cfb54SMatthew G. Knepley 3883c73cfb54SMatthew G. Knepley Input Parameter: 3884c73cfb54SMatthew G. Knepley . dm - The DM 3885c73cfb54SMatthew G. Knepley 3886c73cfb54SMatthew G. Knepley Output Parameter: 3887c73cfb54SMatthew G. Knepley . dim - The topological dimension 3888c73cfb54SMatthew G. Knepley 3889c73cfb54SMatthew G. Knepley Level: beginner 3890c73cfb54SMatthew G. Knepley 3891c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate() 3892c73cfb54SMatthew G. Knepley @*/ 3893c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim) 3894c73cfb54SMatthew G. Knepley { 3895c73cfb54SMatthew G. Knepley PetscFunctionBegin; 3896c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3897c73cfb54SMatthew G. Knepley PetscValidPointer(dim, 2); 3898c73cfb54SMatthew G. Knepley *dim = dm->dim; 3899c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 3900c73cfb54SMatthew G. Knepley } 3901c73cfb54SMatthew G. Knepley 3902c73cfb54SMatthew G. Knepley /*@ 3903c73cfb54SMatthew G. Knepley DMSetDimension - Set the topological dimension of the DM 3904c73cfb54SMatthew G. Knepley 3905c73cfb54SMatthew G. Knepley Collective on dm 3906c73cfb54SMatthew G. Knepley 3907c73cfb54SMatthew G. Knepley Input Parameters: 3908c73cfb54SMatthew G. Knepley + dm - The DM 3909c73cfb54SMatthew G. Knepley - dim - The topological dimension 3910c73cfb54SMatthew G. Knepley 3911c73cfb54SMatthew G. Knepley Level: beginner 3912c73cfb54SMatthew G. Knepley 3913c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate() 3914c73cfb54SMatthew G. Knepley @*/ 3915c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim) 3916c73cfb54SMatthew G. Knepley { 3917c73cfb54SMatthew G. Knepley PetscFunctionBegin; 3918c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 3919c73cfb54SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, dim, 2); 3920c73cfb54SMatthew G. Knepley dm->dim = dim; 3921c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 3922c73cfb54SMatthew G. Knepley } 3923c73cfb54SMatthew G. Knepley 3924793f3fe5SMatthew G. Knepley /*@ 3925793f3fe5SMatthew G. Knepley DMGetDimPoints - Get the half-open interval for all points of a given dimension 3926793f3fe5SMatthew G. Knepley 3927793f3fe5SMatthew G. Knepley Collective on DM 3928793f3fe5SMatthew G. Knepley 3929793f3fe5SMatthew G. Knepley Input Parameters: 3930793f3fe5SMatthew G. Knepley + dm - the DM 3931793f3fe5SMatthew G. Knepley - dim - the dimension 3932793f3fe5SMatthew G. Knepley 3933793f3fe5SMatthew G. Knepley Output Parameters: 3934793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension 3935793f3fe5SMatthew G. Knepley . pEnd - The first point following points of the given dimension 3936793f3fe5SMatthew G. Knepley 3937793f3fe5SMatthew G. Knepley Note: 3938793f3fe5SMatthew G. Knepley The points are vertices in the Hasse diagram encoding the topology. This is explained in 3939793f3fe5SMatthew G. Knepley http://arxiv.org/abs/0908.4427. If not points exist of this dimension in the storage scheme, 3940793f3fe5SMatthew G. Knepley then the interval is empty. 3941793f3fe5SMatthew G. Knepley 3942793f3fe5SMatthew G. Knepley Level: intermediate 3943793f3fe5SMatthew G. Knepley 3944793f3fe5SMatthew G. Knepley .keywords: point, Hasse Diagram, dimension 3945793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum() 3946793f3fe5SMatthew G. Knepley @*/ 3947793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd) 3948793f3fe5SMatthew G. Knepley { 3949793f3fe5SMatthew G. Knepley PetscInt d; 3950793f3fe5SMatthew G. Knepley PetscErrorCode ierr; 3951793f3fe5SMatthew G. Knepley 3952793f3fe5SMatthew G. Knepley PetscFunctionBegin; 3953793f3fe5SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3954793f3fe5SMatthew G. Knepley ierr = DMGetDimension(dm, &d);CHKERRQ(ierr); 3955793f3fe5SMatthew G. Knepley if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d); 3956793f3fe5SMatthew G. Knepley ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr); 3957793f3fe5SMatthew G. Knepley PetscFunctionReturn(0); 3958793f3fe5SMatthew G. Knepley } 3959793f3fe5SMatthew G. Knepley 39606636e97aSMatthew G Knepley /*@ 39616636e97aSMatthew G Knepley DMSetCoordinates - Sets into the DM a global vector that holds the coordinates 39626636e97aSMatthew G Knepley 39636636e97aSMatthew G Knepley Collective on DM 39646636e97aSMatthew G Knepley 39656636e97aSMatthew G Knepley Input Parameters: 39666636e97aSMatthew G Knepley + dm - the DM 39676636e97aSMatthew G Knepley - c - coordinate vector 39686636e97aSMatthew G Knepley 39696636e97aSMatthew G Knepley Note: 39706636e97aSMatthew G Knepley The coordinates do include those for ghost points, which are in the local vector 39716636e97aSMatthew G Knepley 39726636e97aSMatthew G Knepley Level: intermediate 39736636e97aSMatthew G Knepley 39746636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates 39756636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLoca(), DMGetCoordinateDM() 39766636e97aSMatthew G Knepley @*/ 39776636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c) 39786636e97aSMatthew G Knepley { 39796636e97aSMatthew G Knepley PetscErrorCode ierr; 39806636e97aSMatthew G Knepley 39816636e97aSMatthew G Knepley PetscFunctionBegin; 39826636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 39836636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 39846636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 39856636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 39866636e97aSMatthew G Knepley dm->coordinates = c; 39876636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 3988b64e0483SPeter Brune ierr = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 398903dadc2fSPeter Brune ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 39906636e97aSMatthew G Knepley PetscFunctionReturn(0); 39916636e97aSMatthew G Knepley } 39926636e97aSMatthew G Knepley 39936636e97aSMatthew G Knepley /*@ 39946636e97aSMatthew G Knepley DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates 39956636e97aSMatthew G Knepley 39966636e97aSMatthew G Knepley Collective on DM 39976636e97aSMatthew G Knepley 39986636e97aSMatthew G Knepley Input Parameters: 39996636e97aSMatthew G Knepley + dm - the DM 40006636e97aSMatthew G Knepley - c - coordinate vector 40016636e97aSMatthew G Knepley 40026636e97aSMatthew G Knepley Note: 40036636e97aSMatthew G Knepley The coordinates of ghost points can be set using DMSetCoordinates() 40046636e97aSMatthew G Knepley followed by DMGetCoordinatesLocal(). This is intended to enable the 40056636e97aSMatthew G Knepley setting of ghost coordinates outside of the domain. 40066636e97aSMatthew G Knepley 40076636e97aSMatthew G Knepley Level: intermediate 40086636e97aSMatthew G Knepley 40096636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates 40106636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM() 40116636e97aSMatthew G Knepley @*/ 40126636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c) 40136636e97aSMatthew G Knepley { 40146636e97aSMatthew G Knepley PetscErrorCode ierr; 40156636e97aSMatthew G Knepley 40166636e97aSMatthew G Knepley PetscFunctionBegin; 40176636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 40186636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 40196636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 40206636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 40218865f1eaSKarl Rupp 40226636e97aSMatthew G Knepley dm->coordinatesLocal = c; 40238865f1eaSKarl Rupp 40246636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 40256636e97aSMatthew G Knepley PetscFunctionReturn(0); 40266636e97aSMatthew G Knepley } 40276636e97aSMatthew G Knepley 40286636e97aSMatthew G Knepley /*@ 40296636e97aSMatthew G Knepley DMGetCoordinates - Gets a global vector with the coordinates associated with the DM. 40306636e97aSMatthew G Knepley 40316636e97aSMatthew G Knepley Not Collective 40326636e97aSMatthew G Knepley 40336636e97aSMatthew G Knepley Input Parameter: 40346636e97aSMatthew G Knepley . dm - the DM 40356636e97aSMatthew G Knepley 40366636e97aSMatthew G Knepley Output Parameter: 40376636e97aSMatthew G Knepley . c - global coordinate vector 40386636e97aSMatthew G Knepley 40396636e97aSMatthew G Knepley Note: 40406636e97aSMatthew G Knepley This is a borrowed reference, so the user should NOT destroy this vector 40416636e97aSMatthew G Knepley 40426636e97aSMatthew G Knepley Each process has only the local coordinates (does NOT have the ghost coordinates). 40436636e97aSMatthew G Knepley 40446636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 40456636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 40466636e97aSMatthew G Knepley 40476636e97aSMatthew G Knepley Level: intermediate 40486636e97aSMatthew G Knepley 40496636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates 40506636e97aSMatthew G Knepley .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM() 40516636e97aSMatthew G Knepley @*/ 40526636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c) 40536636e97aSMatthew G Knepley { 40546636e97aSMatthew G Knepley PetscErrorCode ierr; 40556636e97aSMatthew G Knepley 40566636e97aSMatthew G Knepley PetscFunctionBegin; 40576636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 40586636e97aSMatthew G Knepley PetscValidPointer(c,2); 40591f588964SMatthew G Knepley if (!dm->coordinates && dm->coordinatesLocal) { 40600298fd71SBarry Smith DM cdm = NULL; 40616636e97aSMatthew G Knepley 40626636e97aSMatthew G Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 40636636e97aSMatthew G Knepley ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr); 40646636e97aSMatthew G Knepley ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr); 40656636e97aSMatthew G Knepley ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 40666636e97aSMatthew G Knepley ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 40676636e97aSMatthew G Knepley } 40686636e97aSMatthew G Knepley *c = dm->coordinates; 40696636e97aSMatthew G Knepley PetscFunctionReturn(0); 40706636e97aSMatthew G Knepley } 40716636e97aSMatthew G Knepley 40726636e97aSMatthew G Knepley /*@ 40736636e97aSMatthew G Knepley DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM. 40746636e97aSMatthew G Knepley 40756636e97aSMatthew G Knepley Collective on DM 40766636e97aSMatthew G Knepley 40776636e97aSMatthew G Knepley Input Parameter: 40786636e97aSMatthew G Knepley . dm - the DM 40796636e97aSMatthew G Knepley 40806636e97aSMatthew G Knepley Output Parameter: 40816636e97aSMatthew G Knepley . c - coordinate vector 40826636e97aSMatthew G Knepley 40836636e97aSMatthew G Knepley Note: 40846636e97aSMatthew G Knepley This is a borrowed reference, so the user should NOT destroy this vector 40856636e97aSMatthew G Knepley 40866636e97aSMatthew G Knepley Each process has the local and ghost coordinates 40876636e97aSMatthew G Knepley 40886636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 40896636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 40906636e97aSMatthew G Knepley 40916636e97aSMatthew G Knepley Level: intermediate 40926636e97aSMatthew G Knepley 40936636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates 40946636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 40956636e97aSMatthew G Knepley @*/ 40966636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c) 40976636e97aSMatthew G Knepley { 40986636e97aSMatthew G Knepley PetscErrorCode ierr; 40996636e97aSMatthew G Knepley 41006636e97aSMatthew G Knepley PetscFunctionBegin; 41016636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 41026636e97aSMatthew G Knepley PetscValidPointer(c,2); 41031f588964SMatthew G Knepley if (!dm->coordinatesLocal && dm->coordinates) { 41040298fd71SBarry Smith DM cdm = NULL; 41056636e97aSMatthew G Knepley 41066636e97aSMatthew G Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 41076636e97aSMatthew G Knepley ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr); 41086636e97aSMatthew G Knepley ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr); 41096636e97aSMatthew G Knepley ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 41106636e97aSMatthew G Knepley ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 41116636e97aSMatthew G Knepley } 41126636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 41136636e97aSMatthew G Knepley PetscFunctionReturn(0); 41146636e97aSMatthew G Knepley } 41156636e97aSMatthew G Knepley 41166636e97aSMatthew G Knepley /*@ 41171cfe2091SMatthew G. Knepley DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates 41186636e97aSMatthew G Knepley 41196636e97aSMatthew G Knepley Collective on DM 41206636e97aSMatthew G Knepley 41216636e97aSMatthew G Knepley Input Parameter: 41226636e97aSMatthew G Knepley . dm - the DM 41236636e97aSMatthew G Knepley 41246636e97aSMatthew G Knepley Output Parameter: 41256636e97aSMatthew G Knepley . cdm - coordinate DM 41266636e97aSMatthew G Knepley 41276636e97aSMatthew G Knepley Level: intermediate 41286636e97aSMatthew G Knepley 41296636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates 41301cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 41316636e97aSMatthew G Knepley @*/ 41326636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm) 41336636e97aSMatthew G Knepley { 41346636e97aSMatthew G Knepley PetscErrorCode ierr; 41356636e97aSMatthew G Knepley 41366636e97aSMatthew G Knepley PetscFunctionBegin; 41376636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 41386636e97aSMatthew G Knepley PetscValidPointer(cdm,2); 41396636e97aSMatthew G Knepley if (!dm->coordinateDM) { 414082f516ccSBarry Smith if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM"); 41416636e97aSMatthew G Knepley ierr = (*dm->ops->createcoordinatedm)(dm, &dm->coordinateDM);CHKERRQ(ierr); 41426636e97aSMatthew G Knepley } 41436636e97aSMatthew G Knepley *cdm = dm->coordinateDM; 41446636e97aSMatthew G Knepley PetscFunctionReturn(0); 41456636e97aSMatthew G Knepley } 4146e87bb0d3SMatthew G Knepley 41471cfe2091SMatthew G. Knepley /*@ 41481cfe2091SMatthew G. Knepley DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates 41491cfe2091SMatthew G. Knepley 41501cfe2091SMatthew G. Knepley Logically Collective on DM 41511cfe2091SMatthew G. Knepley 41521cfe2091SMatthew G. Knepley Input Parameters: 41531cfe2091SMatthew G. Knepley + dm - the DM 41541cfe2091SMatthew G. Knepley - cdm - coordinate DM 41551cfe2091SMatthew G. Knepley 41561cfe2091SMatthew G. Knepley Level: intermediate 41571cfe2091SMatthew G. Knepley 41581cfe2091SMatthew G. Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates 41591cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 41601cfe2091SMatthew G. Knepley @*/ 41611cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm) 41621cfe2091SMatthew G. Knepley { 41631cfe2091SMatthew G. Knepley PetscErrorCode ierr; 41641cfe2091SMatthew G. Knepley 41651cfe2091SMatthew G. Knepley PetscFunctionBegin; 41661cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 41671cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(cdm,DM_CLASSID,2); 4168f26b38b9SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 41691cfe2091SMatthew G. Knepley ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 41701cfe2091SMatthew G. Knepley dm->coordinateDM = cdm; 41711cfe2091SMatthew G. Knepley PetscFunctionReturn(0); 41721cfe2091SMatthew G. Knepley } 41731cfe2091SMatthew G. Knepley 417446e270d4SMatthew G. Knepley /*@ 417546e270d4SMatthew G. Knepley DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values. 417646e270d4SMatthew G. Knepley 417746e270d4SMatthew G. Knepley Not Collective 417846e270d4SMatthew G. Knepley 417946e270d4SMatthew G. Knepley Input Parameter: 418046e270d4SMatthew G. Knepley . dm - The DM object 418146e270d4SMatthew G. Knepley 418246e270d4SMatthew G. Knepley Output Parameter: 418346e270d4SMatthew G. Knepley . dim - The embedding dimension 418446e270d4SMatthew G. Knepley 418546e270d4SMatthew G. Knepley Level: intermediate 418646e270d4SMatthew G. Knepley 418746e270d4SMatthew G. Knepley .keywords: mesh, coordinates 418846e270d4SMatthew G. Knepley .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection() 418946e270d4SMatthew G. Knepley @*/ 419046e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim) 419146e270d4SMatthew G. Knepley { 419246e270d4SMatthew G. Knepley PetscFunctionBegin; 419346e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 419446e270d4SMatthew G. Knepley PetscValidPointer(dim, 2); 41959a9a41abSToby Isaac if (dm->dimEmbed == PETSC_DEFAULT) { 41969a9a41abSToby Isaac dm->dimEmbed = dm->dim; 41979a9a41abSToby Isaac } 419846e270d4SMatthew G. Knepley *dim = dm->dimEmbed; 419946e270d4SMatthew G. Knepley PetscFunctionReturn(0); 420046e270d4SMatthew G. Knepley } 420146e270d4SMatthew G. Knepley 420246e270d4SMatthew G. Knepley /*@ 420346e270d4SMatthew G. Knepley DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values. 420446e270d4SMatthew G. Knepley 420546e270d4SMatthew G. Knepley Not Collective 420646e270d4SMatthew G. Knepley 420746e270d4SMatthew G. Knepley Input Parameters: 420846e270d4SMatthew G. Knepley + dm - The DM object 420946e270d4SMatthew G. Knepley - dim - The embedding dimension 421046e270d4SMatthew G. Knepley 421146e270d4SMatthew G. Knepley Level: intermediate 421246e270d4SMatthew G. Knepley 421346e270d4SMatthew G. Knepley .keywords: mesh, coordinates 421446e270d4SMatthew G. Knepley .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection() 421546e270d4SMatthew G. Knepley @*/ 421646e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim) 421746e270d4SMatthew G. Knepley { 421846e270d4SMatthew G. Knepley PetscFunctionBegin; 421946e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 422046e270d4SMatthew G. Knepley dm->dimEmbed = dim; 422146e270d4SMatthew G. Knepley PetscFunctionReturn(0); 422246e270d4SMatthew G. Knepley } 422346e270d4SMatthew G. Knepley 4224e8abe2deSMatthew G. Knepley /*@ 4225e8abe2deSMatthew G. Knepley DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh. 4226e8abe2deSMatthew G. Knepley 4227e8abe2deSMatthew G. Knepley Not Collective 4228e8abe2deSMatthew G. Knepley 4229e8abe2deSMatthew G. Knepley Input Parameter: 4230e8abe2deSMatthew G. Knepley . dm - The DM object 4231e8abe2deSMatthew G. Knepley 4232e8abe2deSMatthew G. Knepley Output Parameter: 4233e8abe2deSMatthew G. Knepley . section - The PetscSection object 4234e8abe2deSMatthew G. Knepley 4235e8abe2deSMatthew G. Knepley Level: intermediate 4236e8abe2deSMatthew G. Knepley 4237e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates 4238e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection() 4239e8abe2deSMatthew G. Knepley @*/ 4240e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section) 4241e8abe2deSMatthew G. Knepley { 4242e8abe2deSMatthew G. Knepley DM cdm; 4243e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 4244e8abe2deSMatthew G. Knepley 4245e8abe2deSMatthew G. Knepley PetscFunctionBegin; 4246e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4247e8abe2deSMatthew G. Knepley PetscValidPointer(section, 2); 4248e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 4249e8abe2deSMatthew G. Knepley ierr = DMGetDefaultSection(cdm, section);CHKERRQ(ierr); 4250e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 4251e8abe2deSMatthew G. Knepley } 4252e8abe2deSMatthew G. Knepley 4253e8abe2deSMatthew G. Knepley /*@ 4254e8abe2deSMatthew G. Knepley DMSetCoordinateSection - Set the layout of coordinate values over the mesh. 4255e8abe2deSMatthew G. Knepley 4256e8abe2deSMatthew G. Knepley Not Collective 4257e8abe2deSMatthew G. Knepley 4258e8abe2deSMatthew G. Knepley Input Parameters: 4259e8abe2deSMatthew G. Knepley + dm - The DM object 426046e270d4SMatthew G. Knepley . dim - The embedding dimension, or PETSC_DETERMINE 4261e8abe2deSMatthew G. Knepley - section - The PetscSection object 4262e8abe2deSMatthew G. Knepley 4263e8abe2deSMatthew G. Knepley Level: intermediate 4264e8abe2deSMatthew G. Knepley 4265e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates 4266e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection() 4267e8abe2deSMatthew G. Knepley @*/ 426846e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section) 4269e8abe2deSMatthew G. Knepley { 4270e8abe2deSMatthew G. Knepley DM cdm; 4271e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 4272e8abe2deSMatthew G. Knepley 4273e8abe2deSMatthew G. Knepley PetscFunctionBegin; 4274e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 427546e270d4SMatthew G. Knepley PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3); 4276e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 4277e8abe2deSMatthew G. Knepley ierr = DMSetDefaultSection(cdm, section);CHKERRQ(ierr); 427846e270d4SMatthew G. Knepley if (dim == PETSC_DETERMINE) { 42794c1069a6SMatthew G. Knepley PetscInt d = PETSC_DEFAULT; 428046e270d4SMatthew G. Knepley PetscInt pStart, pEnd, vStart, vEnd, v, dd; 428146e270d4SMatthew G. Knepley 428246e270d4SMatthew G. Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 428346e270d4SMatthew G. Knepley ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr); 428446e270d4SMatthew G. Knepley pStart = PetscMax(vStart, pStart); 428546e270d4SMatthew G. Knepley pEnd = PetscMin(vEnd, pEnd); 428646e270d4SMatthew G. Knepley for (v = pStart; v < pEnd; ++v) { 428746e270d4SMatthew G. Knepley ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr); 428846e270d4SMatthew G. Knepley if (dd) {d = dd; break;} 428946e270d4SMatthew G. Knepley } 42906be882deSMatthew G. Knepley if (d < 0) d = PETSC_DEFAULT; 429146e270d4SMatthew G. Knepley ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr); 429246e270d4SMatthew G. Knepley } 4293e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 4294e8abe2deSMatthew G. Knepley } 4295e8abe2deSMatthew G. Knepley 42965dc8c3f7SMatthew G. Knepley /*@C 42975dc8c3f7SMatthew G. Knepley DMSetPeriodicity - Set the description of mesh periodicity 42985dc8c3f7SMatthew G. Knepley 42995dc8c3f7SMatthew G. Knepley Input Parameters: 43005dc8c3f7SMatthew G. Knepley + dm - The DM object 43015dc8c3f7SMatthew 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 43025dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 43035dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 43045dc8c3f7SMatthew G. Knepley 43055dc8c3f7SMatthew G. Knepley Level: developer 43065dc8c3f7SMatthew G. Knepley 43075dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 43085dc8c3f7SMatthew G. Knepley @*/ 43095dc8c3f7SMatthew G. Knepley PetscErrorCode DMGetPeriodicity(DM dm, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd) 4310c6b900c6SMatthew G. Knepley { 4311c6b900c6SMatthew G. Knepley PetscFunctionBegin; 4312c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4313c6b900c6SMatthew G. Knepley if (L) *L = dm->L; 4314c6b900c6SMatthew G. Knepley if (maxCell) *maxCell = dm->maxCell; 43155dc8c3f7SMatthew G. Knepley if (bd) *bd = dm->bdtype; 4316c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 4317c6b900c6SMatthew G. Knepley } 4318c6b900c6SMatthew G. Knepley 43195dc8c3f7SMatthew G. Knepley /*@C 43205dc8c3f7SMatthew G. Knepley DMSetPeriodicity - Set the description of mesh periodicity 43215dc8c3f7SMatthew G. Knepley 43225dc8c3f7SMatthew G. Knepley Input Parameters: 43235dc8c3f7SMatthew G. Knepley + dm - The DM object 43245dc8c3f7SMatthew 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 43255dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 43265dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 43275dc8c3f7SMatthew G. Knepley 43285dc8c3f7SMatthew G. Knepley Level: developer 43295dc8c3f7SMatthew G. Knepley 43305dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 43315dc8c3f7SMatthew G. Knepley @*/ 43325dc8c3f7SMatthew G. Knepley PetscErrorCode DMSetPeriodicity(DM dm, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[]) 4333c6b900c6SMatthew G. Knepley { 4334c6b900c6SMatthew G. Knepley PetscInt dim, d; 4335c6b900c6SMatthew G. Knepley PetscErrorCode ierr; 4336c6b900c6SMatthew G. Knepley 4337c6b900c6SMatthew G. Knepley PetscFunctionBegin; 4338c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 43395dc8c3f7SMatthew G. Knepley PetscValidPointer(L,3);PetscValidPointer(maxCell,2);PetscValidPointer(bd,4); 43405dc8c3f7SMatthew G. Knepley ierr = PetscFree3(dm->L,dm->maxCell,dm->bdtype);CHKERRQ(ierr); 43415dc8c3f7SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 43425dc8c3f7SMatthew G. Knepley ierr = PetscMalloc3(dim,&dm->L,dim,&dm->maxCell,dim,&dm->bdtype);CHKERRQ(ierr); 43435dc8c3f7SMatthew G. Knepley for (d = 0; d < dim; ++d) {dm->L[d] = L[d]; dm->maxCell[d] = maxCell[d]; dm->bdtype[d] = bd[d];} 4344c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 4345c6b900c6SMatthew G. Knepley } 4346c6b900c6SMatthew G. Knepley 43472e17dfb7SMatthew G. Knepley /*@ 43482e17dfb7SMatthew 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. 43492e17dfb7SMatthew G. Knepley 43502e17dfb7SMatthew G. Knepley Input Parameters: 43512e17dfb7SMatthew G. Knepley + dm - The DM 435265da65dcSMatthew G. Knepley . in - The input coordinate point (dim numbers) 435365da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i 43542e17dfb7SMatthew G. Knepley 43552e17dfb7SMatthew G. Knepley Output Parameter: 43562e17dfb7SMatthew G. Knepley . out - The localized coordinate point 43572e17dfb7SMatthew G. Knepley 43582e17dfb7SMatthew G. Knepley Level: developer 43592e17dfb7SMatthew G. Knepley 43602e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 43612e17dfb7SMatthew G. Knepley @*/ 436265da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[]) 43632e17dfb7SMatthew G. Knepley { 43642e17dfb7SMatthew G. Knepley PetscInt dim, d; 43652e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 43662e17dfb7SMatthew G. Knepley 43672e17dfb7SMatthew G. Knepley PetscFunctionBegin; 43682e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr); 43692e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 43702e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 43712e17dfb7SMatthew G. Knepley } else { 437265da65dcSMatthew G. Knepley if (endpoint) { 437365da65dcSMatthew G. Knepley for (d = 0; d < dim; ++d) { 4374da3333bfSMatthew 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)) { 4375da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1); 437665da65dcSMatthew G. Knepley } else { 4377da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 437865da65dcSMatthew G. Knepley } 437965da65dcSMatthew G. Knepley } 438065da65dcSMatthew G. Knepley } else { 43812e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 43821118d4bcSLisandro Dalcin out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 43832e17dfb7SMatthew G. Knepley } 43842e17dfb7SMatthew G. Knepley } 438565da65dcSMatthew G. Knepley } 43862e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 43872e17dfb7SMatthew G. Knepley } 43882e17dfb7SMatthew G. Knepley 43892e17dfb7SMatthew G. Knepley /* 43902e17dfb7SMatthew 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. 43912e17dfb7SMatthew G. Knepley 43922e17dfb7SMatthew G. Knepley Input Parameters: 43932e17dfb7SMatthew G. Knepley + dm - The DM 43942e17dfb7SMatthew G. Knepley . dim - The spatial dimension 43952e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 43962e17dfb7SMatthew G. Knepley - in - The input coordinate point (dim numbers) 43972e17dfb7SMatthew G. Knepley 43982e17dfb7SMatthew G. Knepley Output Parameter: 43992e17dfb7SMatthew G. Knepley . out - The localized coordinate point 44002e17dfb7SMatthew G. Knepley 44012e17dfb7SMatthew G. Knepley Level: developer 44022e17dfb7SMatthew G. Knepley 44032e17dfb7SMatthew 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 44042e17dfb7SMatthew G. Knepley 44052e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 44062e17dfb7SMatthew G. Knepley */ 44072e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 44082e17dfb7SMatthew G. Knepley { 44092e17dfb7SMatthew G. Knepley PetscInt d; 44102e17dfb7SMatthew G. Knepley 44112e17dfb7SMatthew G. Knepley PetscFunctionBegin; 44122e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 44132e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 44142e17dfb7SMatthew G. Knepley } else { 44152e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 4416908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) { 44172e17dfb7SMatthew G. Knepley out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 44182e17dfb7SMatthew G. Knepley } else { 44192e17dfb7SMatthew G. Knepley out[d] = in[d]; 44202e17dfb7SMatthew G. Knepley } 44212e17dfb7SMatthew G. Knepley } 44222e17dfb7SMatthew G. Knepley } 44232e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 44242e17dfb7SMatthew G. Knepley } 44252e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[]) 44262e17dfb7SMatthew G. Knepley { 44272e17dfb7SMatthew G. Knepley PetscInt d; 44282e17dfb7SMatthew G. Knepley 44292e17dfb7SMatthew G. Knepley PetscFunctionBegin; 44302e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 44312e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 44322e17dfb7SMatthew G. Knepley } else { 44332e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 4434908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) { 44352e17dfb7SMatthew G. Knepley out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d]; 44362e17dfb7SMatthew G. Knepley } else { 44372e17dfb7SMatthew G. Knepley out[d] = in[d]; 44382e17dfb7SMatthew G. Knepley } 44392e17dfb7SMatthew G. Knepley } 44402e17dfb7SMatthew G. Knepley } 44412e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 44422e17dfb7SMatthew G. Knepley } 44432e17dfb7SMatthew G. Knepley 44442e17dfb7SMatthew G. Knepley /* 44452e17dfb7SMatthew 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. 44462e17dfb7SMatthew G. Knepley 44472e17dfb7SMatthew G. Knepley Input Parameters: 44482e17dfb7SMatthew G. Knepley + dm - The DM 44492e17dfb7SMatthew G. Knepley . dim - The spatial dimension 44502e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 44512e17dfb7SMatthew G. Knepley . in - The input coordinate delta (dim numbers) 44522e17dfb7SMatthew G. Knepley - out - The input coordinate point (dim numbers) 44532e17dfb7SMatthew G. Knepley 44542e17dfb7SMatthew G. Knepley Output Parameter: 44552e17dfb7SMatthew G. Knepley . out - The localized coordinate in + out 44562e17dfb7SMatthew G. Knepley 44572e17dfb7SMatthew G. Knepley Level: developer 44582e17dfb7SMatthew G. Knepley 44592e17dfb7SMatthew 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 44602e17dfb7SMatthew G. Knepley 44612e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate() 44622e17dfb7SMatthew G. Knepley */ 44632e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 44642e17dfb7SMatthew G. Knepley { 44652e17dfb7SMatthew G. Knepley PetscInt d; 44662e17dfb7SMatthew G. Knepley 44672e17dfb7SMatthew G. Knepley PetscFunctionBegin; 44682e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 44692e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] += in[d]; 44702e17dfb7SMatthew G. Knepley } else { 44712e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 4472908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) { 44732e17dfb7SMatthew G. Knepley out[d] += PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 44742e17dfb7SMatthew G. Knepley } else { 44752e17dfb7SMatthew G. Knepley out[d] += in[d]; 44762e17dfb7SMatthew G. Knepley } 44772e17dfb7SMatthew G. Knepley } 44782e17dfb7SMatthew G. Knepley } 44792e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 44802e17dfb7SMatthew G. Knepley } 44812e17dfb7SMatthew G. Knepley 448236447a5eSToby Isaac /*@ 448336447a5eSToby Isaac DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells 448436447a5eSToby Isaac 448536447a5eSToby Isaac Input Parameter: 448636447a5eSToby Isaac . dm - The DM 448736447a5eSToby Isaac 448836447a5eSToby Isaac Output Parameter: 448936447a5eSToby Isaac areLocalized - True if localized 449036447a5eSToby Isaac 449136447a5eSToby Isaac Level: developer 449236447a5eSToby Isaac 449336447a5eSToby Isaac .seealso: DMLocalizeCoordinates() 449436447a5eSToby Isaac @*/ 449536447a5eSToby Isaac PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized) 449636447a5eSToby Isaac { 449736447a5eSToby Isaac DM cdm; 449836447a5eSToby Isaac PetscSection coordSection; 449936447a5eSToby Isaac PetscInt cStart, cEnd, c, sStart, sEnd, dof; 450036447a5eSToby Isaac PetscBool alreadyLocalized, alreadyLocalizedGlobal; 450136447a5eSToby Isaac PetscErrorCode ierr; 450236447a5eSToby Isaac 450336447a5eSToby Isaac PetscFunctionBegin; 450436447a5eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 45058b09590cSToby Isaac if (!dm->maxCell) { 45068b09590cSToby Isaac *areLocalized = PETSC_FALSE; 45078b09590cSToby Isaac PetscFunctionReturn(0); 45088b09590cSToby Isaac } 450936447a5eSToby Isaac /* We need some generic way of refering to cells/vertices */ 451036447a5eSToby Isaac ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 451136447a5eSToby Isaac { 451236447a5eSToby Isaac PetscBool isplex; 451336447a5eSToby Isaac 451436447a5eSToby Isaac ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr); 451536447a5eSToby Isaac if (isplex) { 451636447a5eSToby Isaac ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr); 451736447a5eSToby Isaac } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM"); 451836447a5eSToby Isaac } 451936447a5eSToby Isaac ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 452036447a5eSToby Isaac ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr); 45215a42012cSToby Isaac alreadyLocalized = alreadyLocalizedGlobal = PETSC_FALSE; 452236447a5eSToby Isaac for (c = cStart; c < cEnd; ++c) { 452336447a5eSToby Isaac if (c < sStart || c >= sEnd) { 452436447a5eSToby Isaac alreadyLocalized = PETSC_FALSE; 452536447a5eSToby Isaac break; 452636447a5eSToby Isaac } 452736447a5eSToby Isaac ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr); 45285a42012cSToby Isaac if (dof) { 45295a42012cSToby Isaac alreadyLocalized = PETSC_TRUE; 453036447a5eSToby Isaac break; 453136447a5eSToby Isaac } 453236447a5eSToby Isaac } 45335a42012cSToby Isaac ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 453436447a5eSToby Isaac *areLocalized = alreadyLocalizedGlobal; 453536447a5eSToby Isaac PetscFunctionReturn(0); 453636447a5eSToby Isaac } 453736447a5eSToby Isaac 453836447a5eSToby Isaac 45392e17dfb7SMatthew G. Knepley /*@ 45402e17dfb7SMatthew G. Knepley DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for each cell 45412e17dfb7SMatthew G. Knepley 45422e17dfb7SMatthew G. Knepley Input Parameter: 45432e17dfb7SMatthew G. Knepley . dm - The DM 45442e17dfb7SMatthew G. Knepley 45452e17dfb7SMatthew G. Knepley Level: developer 45462e17dfb7SMatthew G. Knepley 45472e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinate(), DMLocalizeAddCoordinate() 45482e17dfb7SMatthew G. Knepley @*/ 45492e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm) 45502e17dfb7SMatthew G. Knepley { 45512e17dfb7SMatthew G. Knepley DM cdm; 45522e17dfb7SMatthew G. Knepley PetscSection coordSection, cSection; 45532e17dfb7SMatthew G. Knepley Vec coordinates, cVec; 45543e922f36SToby Isaac PetscScalar *coords, *coords2, *anchor, *localized; 45553e922f36SToby Isaac PetscInt Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize; 4556e0ae35bbSToby Isaac PetscBool alreadyLocalized, alreadyLocalizedGlobal; 45573e922f36SToby Isaac PetscInt maxHeight = 0, h; 45583e922f36SToby Isaac PetscInt *pStart = NULL, *pEnd = NULL; 45592e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 45602e17dfb7SMatthew G. Knepley 45612e17dfb7SMatthew G. Knepley PetscFunctionBegin; 45622e17dfb7SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 45632e17dfb7SMatthew G. Knepley if (!dm->maxCell) PetscFunctionReturn(0); 45642e17dfb7SMatthew G. Knepley /* We need some generic way of refering to cells/vertices */ 45652e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 45662e17dfb7SMatthew G. Knepley { 45672e17dfb7SMatthew G. Knepley PetscBool isplex; 45682e17dfb7SMatthew G. Knepley 45692e17dfb7SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr); 45702e17dfb7SMatthew G. Knepley if (isplex) { 45712e17dfb7SMatthew G. Knepley ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr); 45723e922f36SToby Isaac ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr); 45733e922f36SToby Isaac ierr = DMGetWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr); 45743e922f36SToby Isaac pEnd = &pStart[maxHeight + 1]; 45753e922f36SToby Isaac newStart = vStart; 45763e922f36SToby Isaac newEnd = vEnd; 45773e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 45783e922f36SToby Isaac ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr); 45793e922f36SToby Isaac newStart = PetscMin(newStart,pStart[h]); 45803e922f36SToby Isaac newEnd = PetscMax(newEnd,pEnd[h]); 45813e922f36SToby Isaac } 45822e17dfb7SMatthew G. Knepley } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM"); 45832e17dfb7SMatthew G. Knepley } 45842e17dfb7SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr); 45852e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 45863e922f36SToby Isaac ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr); 4587e0ae35bbSToby Isaac ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr); 45883e922f36SToby Isaac 45892e17dfb7SMatthew G. Knepley ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr); 45902e17dfb7SMatthew G. Knepley ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr); 45912e17dfb7SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr); 45922e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr); 45933e922f36SToby Isaac ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr); 45943e922f36SToby Isaac 45953e922f36SToby Isaac ierr = DMGetWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr); 45963e922f36SToby Isaac localized = &anchor[bs]; 45973e922f36SToby Isaac alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE; 45983e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 45993e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 46003e922f36SToby Isaac 46013e922f36SToby Isaac for (c = cStart; c < cEnd; ++c) { 46023e922f36SToby Isaac PetscScalar *cellCoords = NULL; 46033e922f36SToby Isaac PetscInt b; 46043e922f36SToby Isaac 46053e922f36SToby Isaac if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE; 46063e922f36SToby Isaac ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 46073e922f36SToby Isaac for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 46083e922f36SToby Isaac for (d = 0; d < dof/bs; ++d) { 46093e922f36SToby Isaac ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr); 46103e922f36SToby Isaac for (b = 0; b < bs; b++) { 46113e922f36SToby Isaac if (cellCoords[d*bs + b] != localized[b]) break; 46123e922f36SToby Isaac } 46133e922f36SToby Isaac if (b < bs) break; 46143e922f36SToby Isaac } 46153e922f36SToby Isaac if (d < dof/bs) { 46163e922f36SToby Isaac if (c >= sStart && c < sEnd) { 46173e922f36SToby Isaac PetscInt cdof; 46183e922f36SToby Isaac 46193e922f36SToby Isaac ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr); 46203e922f36SToby Isaac if (cdof != dof) alreadyLocalized = PETSC_FALSE; 46213e922f36SToby Isaac } 46223e922f36SToby Isaac ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr); 46233e922f36SToby Isaac ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr); 46243e922f36SToby Isaac } 46253e922f36SToby Isaac ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 46263e922f36SToby Isaac } 46273e922f36SToby Isaac } 46283e922f36SToby Isaac ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr); 46293e922f36SToby Isaac if (alreadyLocalizedGlobal) { 46303e922f36SToby Isaac ierr = DMRestoreWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr); 46313e922f36SToby Isaac ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 46323e922f36SToby Isaac ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr); 46333e922f36SToby Isaac PetscFunctionReturn(0); 46343e922f36SToby Isaac } 46352e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 46362e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 46372e17dfb7SMatthew G. Knepley ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr); 46382e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr); 46392e17dfb7SMatthew G. Knepley } 46402e17dfb7SMatthew G. Knepley ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr); 46412e17dfb7SMatthew G. Knepley ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr); 4642c2be7e5eSLisandro Dalcin ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr); 46432e17dfb7SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr); 46442e17dfb7SMatthew G. Knepley ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr); 46452e17dfb7SMatthew G. Knepley ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr); 46462e17dfb7SMatthew G. Knepley ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr); 4647c2be7e5eSLisandro Dalcin ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 46482e17dfb7SMatthew G. Knepley ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr); 46492e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 46502e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 46512e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr); 46522e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, v, &off2);CHKERRQ(ierr); 46532e17dfb7SMatthew G. Knepley for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d]; 46542e17dfb7SMatthew G. Knepley } 46553e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 46563e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 46573e922f36SToby Isaac 46582e17dfb7SMatthew G. Knepley for (c = cStart; c < cEnd; ++c) { 46592e17dfb7SMatthew G. Knepley PetscScalar *cellCoords = NULL; 46603e922f36SToby Isaac PetscInt b, cdof; 46612e17dfb7SMatthew G. Knepley 46623e922f36SToby Isaac ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr); 46633e922f36SToby Isaac if (!cdof) continue; 46642e17dfb7SMatthew G. Knepley ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 46652e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr); 46662e17dfb7SMatthew G. Knepley for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 46672e17dfb7SMatthew G. Knepley for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);} 46682e17dfb7SMatthew G. Knepley ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 46692e17dfb7SMatthew G. Knepley } 46703e922f36SToby Isaac } 46713e922f36SToby Isaac ierr = DMRestoreWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr); 46723e922f36SToby Isaac ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr); 4673c2be7e5eSLisandro Dalcin ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 46742e17dfb7SMatthew G. Knepley ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr); 46752e17dfb7SMatthew G. Knepley ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr); 46762e17dfb7SMatthew G. Knepley ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr); 46772e17dfb7SMatthew G. Knepley ierr = VecDestroy(&cVec);CHKERRQ(ierr); 46782e17dfb7SMatthew G. Knepley ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 46792e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 46802e17dfb7SMatthew G. Knepley } 46812e17dfb7SMatthew G. Knepley 4682e87bb0d3SMatthew G Knepley /*@ 46833a93e3b7SToby Isaac DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells 4684e87bb0d3SMatthew G Knepley 46853a93e3b7SToby Isaac Collective on Vec v (see explanation below) 4686e87bb0d3SMatthew G Knepley 4687e87bb0d3SMatthew G Knepley Input Parameters: 4688e87bb0d3SMatthew G Knepley + dm - The DM 46893a93e3b7SToby Isaac . v - The Vec of points 469062a38674SMatthew G. Knepley . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST 46913a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point. 4692e87bb0d3SMatthew G Knepley 469361e3bb9bSMatthew G Knepley Output Parameter: 469462a38674SMatthew G. Knepley + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used 469562a38674SMatthew G. Knepley - cells - The PetscSF containing the ranks and local indices of the containing points. 46963a93e3b7SToby Isaac 4697e87bb0d3SMatthew G Knepley 4698e87bb0d3SMatthew G Knepley Level: developer 469961e3bb9bSMatthew G Knepley 470062a38674SMatthew G. Knepley Notes: 47013a93e3b7SToby Isaac To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator. 470262a38674SMatthew G. Knepley To do a search of all the cells in the distributed mesh, v should have the same communicator as dm. 47033a93e3b7SToby Isaac 47043a93e3b7SToby Isaac If *cellSF is NULL on input, a PetscSF will be created. 470562a38674SMatthew G. Knepley If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses. 47063a93e3b7SToby Isaac 47073a93e3b7SToby Isaac An array that maps each point to its containing cell can be obtained with 47083a93e3b7SToby Isaac 470962a38674SMatthew G. Knepley $ const PetscSFNode *cells; 471062a38674SMatthew G. Knepley $ PetscInt nFound; 471162a38674SMatthew G. Knepley $ const PetscSFNode *found; 471262a38674SMatthew G. Knepley $ 471362a38674SMatthew G. Knepley $ PetscSFGetGraph(cells,NULL,&nFound,&found,&cells); 47143a93e3b7SToby Isaac 47153a93e3b7SToby 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 47163a93e3b7SToby Isaac the index of the cell in its rank's local numbering. 47173a93e3b7SToby Isaac 471861e3bb9bSMatthew G Knepley .keywords: point location, mesh 471962a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType 472061e3bb9bSMatthew G Knepley @*/ 472162a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF) 4722e87bb0d3SMatthew G Knepley { 4723735aa83eSMatthew G Knepley PetscErrorCode ierr; 4724735aa83eSMatthew G Knepley 4725e87bb0d3SMatthew G Knepley PetscFunctionBegin; 4726e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4727e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,2); 4728e0fc9d1bSMatthew G. Knepley PetscValidPointer(cellSF,4); 47293a93e3b7SToby Isaac if (*cellSF) { 47303a93e3b7SToby Isaac PetscMPIInt result; 47313a93e3b7SToby Isaac 4732e0fc9d1bSMatthew G. Knepley PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4); 47333a93e3b7SToby Isaac ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)cellSF),&result);CHKERRQ(ierr); 47343a93e3b7SToby 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"); 4735e0fc9d1bSMatthew G. Knepley } else { 47363a93e3b7SToby Isaac ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr); 47373a93e3b7SToby Isaac } 473847a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 4739735aa83eSMatthew G Knepley if (dm->ops->locatepoints) { 474062a38674SMatthew G. Knepley ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr); 474182f516ccSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM"); 474247a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 4743e87bb0d3SMatthew G Knepley PetscFunctionReturn(0); 4744e87bb0d3SMatthew G Knepley } 474514f150ffSMatthew G. Knepley 4746f4d763aaSMatthew G. Knepley /*@ 4747f4d763aaSMatthew G. Knepley DMGetOutputDM - Retrieve the DM associated with the layout for output 4748f4d763aaSMatthew G. Knepley 4749f4d763aaSMatthew G. Knepley Input Parameter: 4750f4d763aaSMatthew G. Knepley . dm - The original DM 4751f4d763aaSMatthew G. Knepley 4752f4d763aaSMatthew G. Knepley Output Parameter: 4753f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output 4754f4d763aaSMatthew G. Knepley 4755f4d763aaSMatthew G. Knepley Level: intermediate 4756f4d763aaSMatthew G. Knepley 4757f4d763aaSMatthew G. Knepley .seealso: VecView(), DMGetDefaultGlobalSection() 4758f4d763aaSMatthew G. Knepley @*/ 475914f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm) 476014f150ffSMatthew G. Knepley { 4761c26acbdeSMatthew G. Knepley PetscSection section; 47622d4e4a49SMatthew G. Knepley PetscBool hasConstraints, ghasConstraints; 476314f150ffSMatthew G. Knepley PetscErrorCode ierr; 476414f150ffSMatthew G. Knepley 476514f150ffSMatthew G. Knepley PetscFunctionBegin; 476614f150ffSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 476714f150ffSMatthew G. Knepley PetscValidPointer(odm,2); 4768c26acbdeSMatthew G. Knepley ierr = DMGetDefaultSection(dm, §ion);CHKERRQ(ierr); 4769c26acbdeSMatthew G. Knepley ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr); 4770127fe6b9SMatthew G. Knepley ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr); 47712d4e4a49SMatthew G. Knepley if (!ghasConstraints) { 4772c26acbdeSMatthew G. Knepley *odm = dm; 4773c26acbdeSMatthew G. Knepley PetscFunctionReturn(0); 4774c26acbdeSMatthew G. Knepley } 477514f150ffSMatthew G. Knepley if (!dm->dmBC) { 47760305aff6SMatthew G. Knepley PetscDS ds; 4777c26acbdeSMatthew G. Knepley PetscSection newSection, gsection; 477814f150ffSMatthew G. Knepley PetscSF sf; 477914f150ffSMatthew G. Knepley 478014f150ffSMatthew G. Knepley ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr); 47810305aff6SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 47820305aff6SMatthew G. Knepley ierr = DMSetDS(dm->dmBC, ds);CHKERRQ(ierr); 478314f150ffSMatthew G. Knepley ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr); 478414f150ffSMatthew G. Knepley ierr = DMSetDefaultSection(dm->dmBC, newSection);CHKERRQ(ierr); 478514f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr); 478614f150ffSMatthew G. Knepley ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr); 478715b58121SMatthew G. Knepley ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr); 478814f150ffSMatthew G. Knepley ierr = DMSetDefaultGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr); 478914f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr); 479014f150ffSMatthew G. Knepley } 479114f150ffSMatthew G. Knepley *odm = dm->dmBC; 479214f150ffSMatthew G. Knepley PetscFunctionReturn(0); 479314f150ffSMatthew G. Knepley } 4794f4d763aaSMatthew G. Knepley 4795f4d763aaSMatthew G. Knepley /*@ 4796cdb7a50dSMatthew G. Knepley DMGetOutputSequenceNumber - Retrieve the sequence number/value for output 4797f4d763aaSMatthew G. Knepley 4798f4d763aaSMatthew G. Knepley Input Parameter: 4799f4d763aaSMatthew G. Knepley . dm - The original DM 4800f4d763aaSMatthew G. Knepley 4801cdb7a50dSMatthew G. Knepley Output Parameters: 4802cdb7a50dSMatthew G. Knepley + num - The output sequence number 4803cdb7a50dSMatthew G. Knepley - val - The output sequence value 4804f4d763aaSMatthew G. Knepley 4805f4d763aaSMatthew G. Knepley Level: intermediate 4806f4d763aaSMatthew G. Knepley 4807f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 4808f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 4809f4d763aaSMatthew G. Knepley 4810f4d763aaSMatthew G. Knepley .seealso: VecView() 4811f4d763aaSMatthew G. Knepley @*/ 4812cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val) 4813f4d763aaSMatthew G. Knepley { 4814f4d763aaSMatthew G. Knepley PetscFunctionBegin; 4815f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4816cdb7a50dSMatthew G. Knepley if (num) {PetscValidPointer(num,2); *num = dm->outputSequenceNum;} 4817cdb7a50dSMatthew G. Knepley if (val) {PetscValidPointer(val,3);*val = dm->outputSequenceVal;} 4818f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 4819f4d763aaSMatthew G. Knepley } 4820f4d763aaSMatthew G. Knepley 4821f4d763aaSMatthew G. Knepley /*@ 4822cdb7a50dSMatthew G. Knepley DMSetOutputSequenceNumber - Set the sequence number/value for output 4823f4d763aaSMatthew G. Knepley 4824f4d763aaSMatthew G. Knepley Input Parameters: 4825f4d763aaSMatthew G. Knepley + dm - The original DM 4826cdb7a50dSMatthew G. Knepley . num - The output sequence number 4827cdb7a50dSMatthew G. Knepley - val - The output sequence value 4828f4d763aaSMatthew G. Knepley 4829f4d763aaSMatthew G. Knepley Level: intermediate 4830f4d763aaSMatthew G. Knepley 4831f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 4832f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 4833f4d763aaSMatthew G. Knepley 4834f4d763aaSMatthew G. Knepley .seealso: VecView() 4835f4d763aaSMatthew G. Knepley @*/ 4836cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val) 4837f4d763aaSMatthew G. Knepley { 4838f4d763aaSMatthew G. Knepley PetscFunctionBegin; 4839f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4840f4d763aaSMatthew G. Knepley dm->outputSequenceNum = num; 4841cdb7a50dSMatthew G. Knepley dm->outputSequenceVal = val; 4842cdb7a50dSMatthew G. Knepley PetscFunctionReturn(0); 4843cdb7a50dSMatthew G. Knepley } 4844cdb7a50dSMatthew G. Knepley 4845cdb7a50dSMatthew G. Knepley /*@C 4846cdb7a50dSMatthew G. Knepley DMOutputSequenceLoad - Retrieve the sequence value from a Viewer 4847cdb7a50dSMatthew G. Knepley 4848cdb7a50dSMatthew G. Knepley Input Parameters: 4849cdb7a50dSMatthew G. Knepley + dm - The original DM 4850cdb7a50dSMatthew G. Knepley . name - The sequence name 4851cdb7a50dSMatthew G. Knepley - num - The output sequence number 4852cdb7a50dSMatthew G. Knepley 4853cdb7a50dSMatthew G. Knepley Output Parameter: 4854cdb7a50dSMatthew G. Knepley . val - The output sequence value 4855cdb7a50dSMatthew G. Knepley 4856cdb7a50dSMatthew G. Knepley Level: intermediate 4857cdb7a50dSMatthew G. Knepley 4858cdb7a50dSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 4859cdb7a50dSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 4860cdb7a50dSMatthew G. Knepley 4861cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView() 4862cdb7a50dSMatthew G. Knepley @*/ 4863cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val) 4864cdb7a50dSMatthew G. Knepley { 4865cdb7a50dSMatthew G. Knepley PetscBool ishdf5; 4866cdb7a50dSMatthew G. Knepley PetscErrorCode ierr; 4867cdb7a50dSMatthew G. Knepley 4868cdb7a50dSMatthew G. Knepley PetscFunctionBegin; 4869cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4870cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 4871cdb7a50dSMatthew G. Knepley PetscValidPointer(val,4); 4872cdb7a50dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr); 4873cdb7a50dSMatthew G. Knepley if (ishdf5) { 4874cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5) 4875cdb7a50dSMatthew G. Knepley PetscScalar value; 4876cdb7a50dSMatthew G. Knepley 487739d25373SMatthew G. Knepley ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr); 48784aeb217fSMatthew G. Knepley *val = PetscRealPart(value); 4879cdb7a50dSMatthew G. Knepley #endif 4880cdb7a50dSMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()"); 4881f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 4882f4d763aaSMatthew G. Knepley } 48838e4ac7eaSMatthew G. Knepley 48848e4ac7eaSMatthew G. Knepley /*@ 48858e4ac7eaSMatthew G. Knepley DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution 48868e4ac7eaSMatthew G. Knepley 48878e4ac7eaSMatthew G. Knepley Not collective 48888e4ac7eaSMatthew G. Knepley 48898e4ac7eaSMatthew G. Knepley Input Parameter: 48908e4ac7eaSMatthew G. Knepley . dm - The DM 48918e4ac7eaSMatthew G. Knepley 48928e4ac7eaSMatthew G. Knepley Output Parameter: 48938e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution 48948e4ac7eaSMatthew G. Knepley 48958e4ac7eaSMatthew G. Knepley Level: beginner 48968e4ac7eaSMatthew G. Knepley 48978e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate() 48988e4ac7eaSMatthew G. Knepley @*/ 48998e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural) 49008e4ac7eaSMatthew G. Knepley { 49018e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 49028e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 49038e4ac7eaSMatthew G. Knepley PetscValidPointer(useNatural, 2); 49048e4ac7eaSMatthew G. Knepley *useNatural = dm->useNatural; 49058e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 49068e4ac7eaSMatthew G. Knepley } 49078e4ac7eaSMatthew G. Knepley 49088e4ac7eaSMatthew G. Knepley /*@ 49098e4ac7eaSMatthew G. Knepley DMSetUseNatural - Set the flag for creating a mapping to the natural order on distribution 49108e4ac7eaSMatthew G. Knepley 49118e4ac7eaSMatthew G. Knepley Collective on dm 49128e4ac7eaSMatthew G. Knepley 49138e4ac7eaSMatthew G. Knepley Input Parameters: 49148e4ac7eaSMatthew G. Knepley + dm - The DM 49158e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution 49168e4ac7eaSMatthew G. Knepley 49178e4ac7eaSMatthew G. Knepley Level: beginner 49188e4ac7eaSMatthew G. Knepley 49198e4ac7eaSMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate() 49208e4ac7eaSMatthew G. Knepley @*/ 49218e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural) 49228e4ac7eaSMatthew G. Knepley { 49238e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 49248e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 49258e4ac7eaSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, useNatural, 2); 49268e4ac7eaSMatthew G. Knepley dm->useNatural = useNatural; 49278e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 49288e4ac7eaSMatthew G. Knepley } 4929c58f1c22SToby Isaac 4930c58f1c22SToby Isaac 4931c58f1c22SToby Isaac /*@C 4932c58f1c22SToby Isaac DMCreateLabel - Create a label of the given name if it does not already exist 4933c58f1c22SToby Isaac 4934c58f1c22SToby Isaac Not Collective 4935c58f1c22SToby Isaac 4936c58f1c22SToby Isaac Input Parameters: 4937c58f1c22SToby Isaac + dm - The DM object 4938c58f1c22SToby Isaac - name - The label name 4939c58f1c22SToby Isaac 4940c58f1c22SToby Isaac Level: intermediate 4941c58f1c22SToby Isaac 4942c58f1c22SToby Isaac .keywords: mesh 4943c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 4944c58f1c22SToby Isaac @*/ 4945c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[]) 4946c58f1c22SToby Isaac { 4947c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 4948c58f1c22SToby Isaac PetscBool flg = PETSC_FALSE; 4949c58f1c22SToby Isaac PetscErrorCode ierr; 4950c58f1c22SToby Isaac 4951c58f1c22SToby Isaac PetscFunctionBegin; 4952c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4953c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 4954c58f1c22SToby Isaac while (next) { 4955c58f1c22SToby Isaac ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr); 4956c58f1c22SToby Isaac if (flg) break; 4957c58f1c22SToby Isaac next = next->next; 4958c58f1c22SToby Isaac } 4959c58f1c22SToby Isaac if (!flg) { 4960c58f1c22SToby Isaac DMLabelLink tmpLabel; 4961c58f1c22SToby Isaac 4962c58f1c22SToby Isaac ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr); 4963c58f1c22SToby Isaac ierr = DMLabelCreate(name, &tmpLabel->label);CHKERRQ(ierr); 4964c58f1c22SToby Isaac tmpLabel->output = PETSC_TRUE; 4965c58f1c22SToby Isaac tmpLabel->next = dm->labels->next; 4966c58f1c22SToby Isaac dm->labels->next = tmpLabel; 4967c58f1c22SToby Isaac } 4968c58f1c22SToby Isaac PetscFunctionReturn(0); 4969c58f1c22SToby Isaac } 4970c58f1c22SToby Isaac 4971c58f1c22SToby Isaac /*@C 4972c58f1c22SToby Isaac DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default 4973c58f1c22SToby Isaac 4974c58f1c22SToby Isaac Not Collective 4975c58f1c22SToby Isaac 4976c58f1c22SToby Isaac Input Parameters: 4977c58f1c22SToby Isaac + dm - The DM object 4978c58f1c22SToby Isaac . name - The label name 4979c58f1c22SToby Isaac - point - The mesh point 4980c58f1c22SToby Isaac 4981c58f1c22SToby Isaac Output Parameter: 4982c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label 4983c58f1c22SToby Isaac 4984c58f1c22SToby Isaac Level: beginner 4985c58f1c22SToby Isaac 4986c58f1c22SToby Isaac .keywords: mesh 4987c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS() 4988c58f1c22SToby Isaac @*/ 4989c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value) 4990c58f1c22SToby Isaac { 4991c58f1c22SToby Isaac DMLabel label; 4992c58f1c22SToby Isaac PetscErrorCode ierr; 4993c58f1c22SToby Isaac 4994c58f1c22SToby Isaac PetscFunctionBegin; 4995c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4996c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 4997c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 4998c58f1c22SToby Isaac if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);CHKERRQ(ierr); 4999c58f1c22SToby Isaac ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr); 5000c58f1c22SToby Isaac PetscFunctionReturn(0); 5001c58f1c22SToby Isaac } 5002c58f1c22SToby Isaac 5003c58f1c22SToby Isaac /*@C 5004c58f1c22SToby Isaac DMSetLabelValue - Add a point to a Sieve Label with given value 5005c58f1c22SToby Isaac 5006c58f1c22SToby Isaac Not Collective 5007c58f1c22SToby Isaac 5008c58f1c22SToby Isaac Input Parameters: 5009c58f1c22SToby Isaac + dm - The DM object 5010c58f1c22SToby Isaac . name - The label name 5011c58f1c22SToby Isaac . point - The mesh point 5012c58f1c22SToby Isaac - value - The label value for this point 5013c58f1c22SToby Isaac 5014c58f1c22SToby Isaac Output Parameter: 5015c58f1c22SToby Isaac 5016c58f1c22SToby Isaac Level: beginner 5017c58f1c22SToby Isaac 5018c58f1c22SToby Isaac .keywords: mesh 5019c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue() 5020c58f1c22SToby Isaac @*/ 5021c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 5022c58f1c22SToby Isaac { 5023c58f1c22SToby Isaac DMLabel label; 5024c58f1c22SToby Isaac PetscErrorCode ierr; 5025c58f1c22SToby Isaac 5026c58f1c22SToby Isaac PetscFunctionBegin; 5027c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5028c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5029c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 5030c58f1c22SToby Isaac if (!label) { 5031c58f1c22SToby Isaac ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 5032c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 5033c58f1c22SToby Isaac } 5034c58f1c22SToby Isaac ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr); 5035c58f1c22SToby Isaac PetscFunctionReturn(0); 5036c58f1c22SToby Isaac } 5037c58f1c22SToby Isaac 5038c58f1c22SToby Isaac /*@C 5039c58f1c22SToby Isaac DMClearLabelValue - Remove a point from a Sieve Label with given value 5040c58f1c22SToby Isaac 5041c58f1c22SToby Isaac Not Collective 5042c58f1c22SToby Isaac 5043c58f1c22SToby Isaac Input Parameters: 5044c58f1c22SToby Isaac + dm - The DM object 5045c58f1c22SToby Isaac . name - The label name 5046c58f1c22SToby Isaac . point - The mesh point 5047c58f1c22SToby Isaac - value - The label value for this point 5048c58f1c22SToby Isaac 5049c58f1c22SToby Isaac Output Parameter: 5050c58f1c22SToby Isaac 5051c58f1c22SToby Isaac Level: beginner 5052c58f1c22SToby Isaac 5053c58f1c22SToby Isaac .keywords: mesh 5054c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS() 5055c58f1c22SToby Isaac @*/ 5056c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 5057c58f1c22SToby Isaac { 5058c58f1c22SToby Isaac DMLabel label; 5059c58f1c22SToby Isaac PetscErrorCode ierr; 5060c58f1c22SToby Isaac 5061c58f1c22SToby Isaac PetscFunctionBegin; 5062c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5063c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5064c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 5065c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 5066c58f1c22SToby Isaac ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr); 5067c58f1c22SToby Isaac PetscFunctionReturn(0); 5068c58f1c22SToby Isaac } 5069c58f1c22SToby Isaac 5070c58f1c22SToby Isaac /*@C 5071c58f1c22SToby Isaac DMGetLabelSize - Get the number of different integer ids in a Label 5072c58f1c22SToby Isaac 5073c58f1c22SToby Isaac Not Collective 5074c58f1c22SToby Isaac 5075c58f1c22SToby Isaac Input Parameters: 5076c58f1c22SToby Isaac + dm - The DM object 5077c58f1c22SToby Isaac - name - The label name 5078c58f1c22SToby Isaac 5079c58f1c22SToby Isaac Output Parameter: 5080c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist 5081c58f1c22SToby Isaac 5082c58f1c22SToby Isaac Level: beginner 5083c58f1c22SToby Isaac 5084c58f1c22SToby Isaac .keywords: mesh 5085c58f1c22SToby Isaac .seealso: DMLabeGetNumValues(), DMSetLabelValue() 5086c58f1c22SToby Isaac @*/ 5087c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size) 5088c58f1c22SToby Isaac { 5089c58f1c22SToby Isaac DMLabel label; 5090c58f1c22SToby Isaac PetscErrorCode ierr; 5091c58f1c22SToby Isaac 5092c58f1c22SToby Isaac PetscFunctionBegin; 5093c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5094c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5095c58f1c22SToby Isaac PetscValidPointer(size, 3); 5096c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 5097c58f1c22SToby Isaac *size = 0; 5098c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 5099c58f1c22SToby Isaac ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr); 5100c58f1c22SToby Isaac PetscFunctionReturn(0); 5101c58f1c22SToby Isaac } 5102c58f1c22SToby Isaac 5103c58f1c22SToby Isaac /*@C 5104c58f1c22SToby Isaac DMGetLabelIdIS - Get the integer ids in a label 5105c58f1c22SToby Isaac 5106c58f1c22SToby Isaac Not Collective 5107c58f1c22SToby Isaac 5108c58f1c22SToby Isaac Input Parameters: 5109c58f1c22SToby Isaac + mesh - The DM object 5110c58f1c22SToby Isaac - name - The label name 5111c58f1c22SToby Isaac 5112c58f1c22SToby Isaac Output Parameter: 5113c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist 5114c58f1c22SToby Isaac 5115c58f1c22SToby Isaac Level: beginner 5116c58f1c22SToby Isaac 5117c58f1c22SToby Isaac .keywords: mesh 5118c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize() 5119c58f1c22SToby Isaac @*/ 5120c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids) 5121c58f1c22SToby Isaac { 5122c58f1c22SToby Isaac DMLabel label; 5123c58f1c22SToby Isaac PetscErrorCode ierr; 5124c58f1c22SToby Isaac 5125c58f1c22SToby Isaac PetscFunctionBegin; 5126c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5127c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5128c58f1c22SToby Isaac PetscValidPointer(ids, 3); 5129c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 5130c58f1c22SToby Isaac *ids = NULL; 5131c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 5132c58f1c22SToby Isaac ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr); 5133c58f1c22SToby Isaac PetscFunctionReturn(0); 5134c58f1c22SToby Isaac } 5135c58f1c22SToby Isaac 5136c58f1c22SToby Isaac /*@C 5137c58f1c22SToby Isaac DMGetStratumSize - Get the number of points in a label stratum 5138c58f1c22SToby Isaac 5139c58f1c22SToby Isaac Not Collective 5140c58f1c22SToby Isaac 5141c58f1c22SToby Isaac Input Parameters: 5142c58f1c22SToby Isaac + dm - The DM object 5143c58f1c22SToby Isaac . name - The label name 5144c58f1c22SToby Isaac - value - The stratum value 5145c58f1c22SToby Isaac 5146c58f1c22SToby Isaac Output Parameter: 5147c58f1c22SToby Isaac . size - The stratum size 5148c58f1c22SToby Isaac 5149c58f1c22SToby Isaac Level: beginner 5150c58f1c22SToby Isaac 5151c58f1c22SToby Isaac .keywords: mesh 5152c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds() 5153c58f1c22SToby Isaac @*/ 5154c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size) 5155c58f1c22SToby Isaac { 5156c58f1c22SToby Isaac DMLabel label; 5157c58f1c22SToby Isaac PetscErrorCode ierr; 5158c58f1c22SToby Isaac 5159c58f1c22SToby Isaac PetscFunctionBegin; 5160c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5161c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5162c58f1c22SToby Isaac PetscValidPointer(size, 4); 5163c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 5164c58f1c22SToby Isaac *size = 0; 5165c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 5166c58f1c22SToby Isaac ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr); 5167c58f1c22SToby Isaac PetscFunctionReturn(0); 5168c58f1c22SToby Isaac } 5169c58f1c22SToby Isaac 5170c58f1c22SToby Isaac /*@C 5171c58f1c22SToby Isaac DMGetStratumIS - Get the points in a label stratum 5172c58f1c22SToby Isaac 5173c58f1c22SToby Isaac Not Collective 5174c58f1c22SToby Isaac 5175c58f1c22SToby Isaac Input Parameters: 5176c58f1c22SToby Isaac + dm - The DM object 5177c58f1c22SToby Isaac . name - The label name 5178c58f1c22SToby Isaac - value - The stratum value 5179c58f1c22SToby Isaac 5180c58f1c22SToby Isaac Output Parameter: 5181c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value 5182c58f1c22SToby Isaac 5183c58f1c22SToby Isaac Level: beginner 5184c58f1c22SToby Isaac 5185c58f1c22SToby Isaac .keywords: mesh 5186c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize() 5187c58f1c22SToby Isaac @*/ 5188c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points) 5189c58f1c22SToby Isaac { 5190c58f1c22SToby Isaac DMLabel label; 5191c58f1c22SToby Isaac PetscErrorCode ierr; 5192c58f1c22SToby Isaac 5193c58f1c22SToby Isaac PetscFunctionBegin; 5194c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5195c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5196c58f1c22SToby Isaac PetscValidPointer(points, 4); 5197c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 5198c58f1c22SToby Isaac *points = NULL; 5199c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 5200c58f1c22SToby Isaac ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr); 5201c58f1c22SToby Isaac PetscFunctionReturn(0); 5202c58f1c22SToby Isaac } 5203c58f1c22SToby Isaac 52044de306b1SToby Isaac /*@C 52054de306b1SToby Isaac DMGetStratumIS - Set the points in a label stratum 52064de306b1SToby Isaac 52074de306b1SToby Isaac Not Collective 52084de306b1SToby Isaac 52094de306b1SToby Isaac Input Parameters: 52104de306b1SToby Isaac + dm - The DM object 52114de306b1SToby Isaac . name - The label name 52124de306b1SToby Isaac . value - The stratum value 52134de306b1SToby Isaac - points - The stratum points 52144de306b1SToby Isaac 52154de306b1SToby Isaac Level: beginner 52164de306b1SToby Isaac 52174de306b1SToby Isaac .keywords: mesh 52184de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize() 52194de306b1SToby Isaac @*/ 52204de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points) 52214de306b1SToby Isaac { 52224de306b1SToby Isaac DMLabel label; 52234de306b1SToby Isaac PetscErrorCode ierr; 52244de306b1SToby Isaac 52254de306b1SToby Isaac PetscFunctionBegin; 52264de306b1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 52274de306b1SToby Isaac PetscValidCharPointer(name, 2); 52284de306b1SToby Isaac PetscValidPointer(points, 4); 52294de306b1SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 52304de306b1SToby Isaac if (!label) PetscFunctionReturn(0); 52314de306b1SToby Isaac ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr); 52324de306b1SToby Isaac PetscFunctionReturn(0); 52334de306b1SToby Isaac } 52344de306b1SToby Isaac 5235c58f1c22SToby Isaac /*@C 5236c58f1c22SToby Isaac DMClearLabelStratum - Remove all points from a stratum from a Sieve Label 5237c58f1c22SToby Isaac 5238c58f1c22SToby Isaac Not Collective 5239c58f1c22SToby Isaac 5240c58f1c22SToby Isaac Input Parameters: 5241c58f1c22SToby Isaac + dm - The DM object 5242c58f1c22SToby Isaac . name - The label name 5243c58f1c22SToby Isaac - value - The label value for this point 5244c58f1c22SToby Isaac 5245c58f1c22SToby Isaac Output Parameter: 5246c58f1c22SToby Isaac 5247c58f1c22SToby Isaac Level: beginner 5248c58f1c22SToby Isaac 5249c58f1c22SToby Isaac .keywords: mesh 5250c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue() 5251c58f1c22SToby Isaac @*/ 5252c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value) 5253c58f1c22SToby Isaac { 5254c58f1c22SToby Isaac DMLabel label; 5255c58f1c22SToby Isaac PetscErrorCode ierr; 5256c58f1c22SToby Isaac 5257c58f1c22SToby Isaac PetscFunctionBegin; 5258c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5259c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5260c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 5261c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 5262c58f1c22SToby Isaac ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr); 5263c58f1c22SToby Isaac PetscFunctionReturn(0); 5264c58f1c22SToby Isaac } 5265c58f1c22SToby Isaac 5266c58f1c22SToby Isaac /*@ 5267c58f1c22SToby Isaac DMGetNumLabels - Return the number of labels defined by the mesh 5268c58f1c22SToby Isaac 5269c58f1c22SToby Isaac Not Collective 5270c58f1c22SToby Isaac 5271c58f1c22SToby Isaac Input Parameter: 5272c58f1c22SToby Isaac . dm - The DM object 5273c58f1c22SToby Isaac 5274c58f1c22SToby Isaac Output Parameter: 5275c58f1c22SToby Isaac . numLabels - the number of Labels 5276c58f1c22SToby Isaac 5277c58f1c22SToby Isaac Level: intermediate 5278c58f1c22SToby Isaac 5279c58f1c22SToby Isaac .keywords: mesh 5280c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5281c58f1c22SToby Isaac @*/ 5282c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels) 5283c58f1c22SToby Isaac { 5284c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 5285c58f1c22SToby Isaac PetscInt n = 0; 5286c58f1c22SToby Isaac 5287c58f1c22SToby Isaac PetscFunctionBegin; 5288c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5289c58f1c22SToby Isaac PetscValidPointer(numLabels, 2); 5290c58f1c22SToby Isaac while (next) {++n; next = next->next;} 5291c58f1c22SToby Isaac *numLabels = n; 5292c58f1c22SToby Isaac PetscFunctionReturn(0); 5293c58f1c22SToby Isaac } 5294c58f1c22SToby Isaac 5295c58f1c22SToby Isaac /*@C 5296c58f1c22SToby Isaac DMGetLabelName - Return the name of nth label 5297c58f1c22SToby Isaac 5298c58f1c22SToby Isaac Not Collective 5299c58f1c22SToby Isaac 5300c58f1c22SToby Isaac Input Parameters: 5301c58f1c22SToby Isaac + dm - The DM object 5302c58f1c22SToby Isaac - n - the label number 5303c58f1c22SToby Isaac 5304c58f1c22SToby Isaac Output Parameter: 5305c58f1c22SToby Isaac . name - the label name 5306c58f1c22SToby Isaac 5307c58f1c22SToby Isaac Level: intermediate 5308c58f1c22SToby Isaac 5309c58f1c22SToby Isaac .keywords: mesh 5310c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5311c58f1c22SToby Isaac @*/ 5312c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name) 5313c58f1c22SToby Isaac { 5314c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 5315c58f1c22SToby Isaac PetscInt l = 0; 5316c58f1c22SToby Isaac 5317c58f1c22SToby Isaac PetscFunctionBegin; 5318c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5319c58f1c22SToby Isaac PetscValidPointer(name, 3); 5320c58f1c22SToby Isaac while (next) { 5321c58f1c22SToby Isaac if (l == n) { 5322c58f1c22SToby Isaac *name = next->label->name; 5323c58f1c22SToby Isaac PetscFunctionReturn(0); 5324c58f1c22SToby Isaac } 5325c58f1c22SToby Isaac ++l; 5326c58f1c22SToby Isaac next = next->next; 5327c58f1c22SToby Isaac } 5328c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 5329c58f1c22SToby Isaac } 5330c58f1c22SToby Isaac 5331c58f1c22SToby Isaac /*@C 5332c58f1c22SToby Isaac DMHasLabel - Determine whether the mesh has a label of a given name 5333c58f1c22SToby Isaac 5334c58f1c22SToby Isaac Not Collective 5335c58f1c22SToby Isaac 5336c58f1c22SToby Isaac Input Parameters: 5337c58f1c22SToby Isaac + dm - The DM object 5338c58f1c22SToby Isaac - name - The label name 5339c58f1c22SToby Isaac 5340c58f1c22SToby Isaac Output Parameter: 5341c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present 5342c58f1c22SToby Isaac 5343c58f1c22SToby Isaac Level: intermediate 5344c58f1c22SToby Isaac 5345c58f1c22SToby Isaac .keywords: mesh 5346c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5347c58f1c22SToby Isaac @*/ 5348c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel) 5349c58f1c22SToby Isaac { 5350c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 5351c58f1c22SToby Isaac PetscErrorCode ierr; 5352c58f1c22SToby Isaac 5353c58f1c22SToby Isaac PetscFunctionBegin; 5354c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5355c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5356c58f1c22SToby Isaac PetscValidPointer(hasLabel, 3); 5357c58f1c22SToby Isaac *hasLabel = PETSC_FALSE; 5358c58f1c22SToby Isaac while (next) { 5359c58f1c22SToby Isaac ierr = PetscStrcmp(name, next->label->name, hasLabel);CHKERRQ(ierr); 5360c58f1c22SToby Isaac if (*hasLabel) break; 5361c58f1c22SToby Isaac next = next->next; 5362c58f1c22SToby Isaac } 5363c58f1c22SToby Isaac PetscFunctionReturn(0); 5364c58f1c22SToby Isaac } 5365c58f1c22SToby Isaac 5366c58f1c22SToby Isaac /*@C 5367c58f1c22SToby Isaac DMGetLabel - Return the label of a given name, or NULL 5368c58f1c22SToby Isaac 5369c58f1c22SToby Isaac Not Collective 5370c58f1c22SToby Isaac 5371c58f1c22SToby Isaac Input Parameters: 5372c58f1c22SToby Isaac + dm - The DM object 5373c58f1c22SToby Isaac - name - The label name 5374c58f1c22SToby Isaac 5375c58f1c22SToby Isaac Output Parameter: 5376c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 5377c58f1c22SToby Isaac 5378c58f1c22SToby Isaac Level: intermediate 5379c58f1c22SToby Isaac 5380c58f1c22SToby Isaac .keywords: mesh 5381c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5382c58f1c22SToby Isaac @*/ 5383c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label) 5384c58f1c22SToby Isaac { 5385c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 5386c58f1c22SToby Isaac PetscBool hasLabel; 5387c58f1c22SToby Isaac PetscErrorCode ierr; 5388c58f1c22SToby Isaac 5389c58f1c22SToby Isaac PetscFunctionBegin; 5390c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5391c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 5392c58f1c22SToby Isaac PetscValidPointer(label, 3); 5393c58f1c22SToby Isaac *label = NULL; 5394c58f1c22SToby Isaac while (next) { 5395c58f1c22SToby Isaac ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr); 5396c58f1c22SToby Isaac if (hasLabel) { 5397c58f1c22SToby Isaac *label = next->label; 5398c58f1c22SToby Isaac break; 5399c58f1c22SToby Isaac } 5400c58f1c22SToby Isaac next = next->next; 5401c58f1c22SToby Isaac } 5402c58f1c22SToby Isaac PetscFunctionReturn(0); 5403c58f1c22SToby Isaac } 5404c58f1c22SToby Isaac 5405c58f1c22SToby Isaac /*@C 5406c58f1c22SToby Isaac DMGetLabelByNum - Return the nth label 5407c58f1c22SToby Isaac 5408c58f1c22SToby Isaac Not Collective 5409c58f1c22SToby Isaac 5410c58f1c22SToby Isaac Input Parameters: 5411c58f1c22SToby Isaac + dm - The DM object 5412c58f1c22SToby Isaac - n - the label number 5413c58f1c22SToby Isaac 5414c58f1c22SToby Isaac Output Parameter: 5415c58f1c22SToby Isaac . label - the label 5416c58f1c22SToby Isaac 5417c58f1c22SToby Isaac Level: intermediate 5418c58f1c22SToby Isaac 5419c58f1c22SToby Isaac .keywords: mesh 5420c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5421c58f1c22SToby Isaac @*/ 5422c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label) 5423c58f1c22SToby Isaac { 5424c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 5425c58f1c22SToby Isaac PetscInt l = 0; 5426c58f1c22SToby Isaac 5427c58f1c22SToby Isaac PetscFunctionBegin; 5428c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5429c58f1c22SToby Isaac PetscValidPointer(label, 3); 5430c58f1c22SToby Isaac while (next) { 5431c58f1c22SToby Isaac if (l == n) { 5432c58f1c22SToby Isaac *label = next->label; 5433c58f1c22SToby Isaac PetscFunctionReturn(0); 5434c58f1c22SToby Isaac } 5435c58f1c22SToby Isaac ++l; 5436c58f1c22SToby Isaac next = next->next; 5437c58f1c22SToby Isaac } 5438c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 5439c58f1c22SToby Isaac } 5440c58f1c22SToby Isaac 5441c58f1c22SToby Isaac /*@C 5442c58f1c22SToby Isaac DMAddLabel - Add the label to this mesh 5443c58f1c22SToby Isaac 5444c58f1c22SToby Isaac Not Collective 5445c58f1c22SToby Isaac 5446c58f1c22SToby Isaac Input Parameters: 5447c58f1c22SToby Isaac + dm - The DM object 5448c58f1c22SToby Isaac - label - The DMLabel 5449c58f1c22SToby Isaac 5450c58f1c22SToby Isaac Level: developer 5451c58f1c22SToby Isaac 5452c58f1c22SToby Isaac .keywords: mesh 5453c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5454c58f1c22SToby Isaac @*/ 5455c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label) 5456c58f1c22SToby Isaac { 5457c58f1c22SToby Isaac DMLabelLink tmpLabel; 5458c58f1c22SToby Isaac PetscBool hasLabel; 5459c58f1c22SToby Isaac PetscErrorCode ierr; 5460c58f1c22SToby Isaac 5461c58f1c22SToby Isaac PetscFunctionBegin; 5462c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5463c58f1c22SToby Isaac ierr = DMHasLabel(dm, label->name, &hasLabel);CHKERRQ(ierr); 5464c58f1c22SToby Isaac if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", label->name); 5465c58f1c22SToby Isaac ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr); 5466c58f1c22SToby Isaac tmpLabel->label = label; 5467c58f1c22SToby Isaac tmpLabel->output = PETSC_TRUE; 5468c58f1c22SToby Isaac tmpLabel->next = dm->labels->next; 5469c58f1c22SToby Isaac dm->labels->next = tmpLabel; 5470c58f1c22SToby Isaac PetscFunctionReturn(0); 5471c58f1c22SToby Isaac } 5472c58f1c22SToby Isaac 5473c58f1c22SToby Isaac /*@C 5474c58f1c22SToby Isaac DMRemoveLabel - Remove the label from this mesh 5475c58f1c22SToby Isaac 5476c58f1c22SToby Isaac Not Collective 5477c58f1c22SToby Isaac 5478c58f1c22SToby Isaac Input Parameters: 5479c58f1c22SToby Isaac + dm - The DM object 5480c58f1c22SToby Isaac - name - The label name 5481c58f1c22SToby Isaac 5482c58f1c22SToby Isaac Output Parameter: 5483c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 5484c58f1c22SToby Isaac 5485c58f1c22SToby Isaac Level: developer 5486c58f1c22SToby Isaac 5487c58f1c22SToby Isaac .keywords: mesh 5488c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5489c58f1c22SToby Isaac @*/ 5490c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label) 5491c58f1c22SToby Isaac { 5492c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 5493c58f1c22SToby Isaac DMLabelLink last = NULL; 5494c58f1c22SToby Isaac PetscBool hasLabel; 5495c58f1c22SToby Isaac PetscErrorCode ierr; 5496c58f1c22SToby Isaac 5497c58f1c22SToby Isaac PetscFunctionBegin; 5498c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5499c58f1c22SToby Isaac ierr = DMHasLabel(dm, name, &hasLabel);CHKERRQ(ierr); 5500c58f1c22SToby Isaac *label = NULL; 5501c58f1c22SToby Isaac if (!hasLabel) PetscFunctionReturn(0); 5502c58f1c22SToby Isaac while (next) { 5503c58f1c22SToby Isaac ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr); 5504c58f1c22SToby Isaac if (hasLabel) { 5505c58f1c22SToby Isaac if (last) last->next = next->next; 5506c58f1c22SToby Isaac else dm->labels->next = next->next; 5507c58f1c22SToby Isaac next->next = NULL; 5508c58f1c22SToby Isaac *label = next->label; 5509c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr); 5510c58f1c22SToby Isaac if (hasLabel) { 5511c58f1c22SToby Isaac dm->depthLabel = NULL; 5512c58f1c22SToby Isaac } 5513c58f1c22SToby Isaac ierr = PetscFree(next);CHKERRQ(ierr); 5514c58f1c22SToby Isaac break; 5515c58f1c22SToby Isaac } 5516c58f1c22SToby Isaac last = next; 5517c58f1c22SToby Isaac next = next->next; 5518c58f1c22SToby Isaac } 5519c58f1c22SToby Isaac PetscFunctionReturn(0); 5520c58f1c22SToby Isaac } 5521c58f1c22SToby Isaac 5522c58f1c22SToby Isaac /*@C 5523c58f1c22SToby Isaac DMGetLabelOutput - Get the output flag for a given label 5524c58f1c22SToby Isaac 5525c58f1c22SToby Isaac Not Collective 5526c58f1c22SToby Isaac 5527c58f1c22SToby Isaac Input Parameters: 5528c58f1c22SToby Isaac + dm - The DM object 5529c58f1c22SToby Isaac - name - The label name 5530c58f1c22SToby Isaac 5531c58f1c22SToby Isaac Output Parameter: 5532c58f1c22SToby Isaac . output - The flag for output 5533c58f1c22SToby Isaac 5534c58f1c22SToby Isaac Level: developer 5535c58f1c22SToby Isaac 5536c58f1c22SToby Isaac .keywords: mesh 5537c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5538c58f1c22SToby Isaac @*/ 5539c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output) 5540c58f1c22SToby Isaac { 5541c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 5542c58f1c22SToby Isaac PetscErrorCode ierr; 5543c58f1c22SToby Isaac 5544c58f1c22SToby Isaac PetscFunctionBegin; 5545c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5546c58f1c22SToby Isaac PetscValidPointer(name, 2); 5547c58f1c22SToby Isaac PetscValidPointer(output, 3); 5548c58f1c22SToby Isaac while (next) { 5549c58f1c22SToby Isaac PetscBool flg; 5550c58f1c22SToby Isaac 5551c58f1c22SToby Isaac ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr); 5552c58f1c22SToby Isaac if (flg) {*output = next->output; PetscFunctionReturn(0);} 5553c58f1c22SToby Isaac next = next->next; 5554c58f1c22SToby Isaac } 5555c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 5556c58f1c22SToby Isaac } 5557c58f1c22SToby Isaac 5558c58f1c22SToby Isaac /*@C 5559c58f1c22SToby Isaac DMSetLabelOutput - Set the output flag for a given label 5560c58f1c22SToby Isaac 5561c58f1c22SToby Isaac Not Collective 5562c58f1c22SToby Isaac 5563c58f1c22SToby Isaac Input Parameters: 5564c58f1c22SToby Isaac + dm - The DM object 5565c58f1c22SToby Isaac . name - The label name 5566c58f1c22SToby Isaac - output - The flag for output 5567c58f1c22SToby Isaac 5568c58f1c22SToby Isaac Level: developer 5569c58f1c22SToby Isaac 5570c58f1c22SToby Isaac .keywords: mesh 5571c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 5572c58f1c22SToby Isaac @*/ 5573c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output) 5574c58f1c22SToby Isaac { 5575c58f1c22SToby Isaac DMLabelLink next = dm->labels->next; 5576c58f1c22SToby Isaac PetscErrorCode ierr; 5577c58f1c22SToby Isaac 5578c58f1c22SToby Isaac PetscFunctionBegin; 5579c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5580c58f1c22SToby Isaac PetscValidPointer(name, 2); 5581c58f1c22SToby Isaac while (next) { 5582c58f1c22SToby Isaac PetscBool flg; 5583c58f1c22SToby Isaac 5584c58f1c22SToby Isaac ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr); 5585c58f1c22SToby Isaac if (flg) {next->output = output; PetscFunctionReturn(0);} 5586c58f1c22SToby Isaac next = next->next; 5587c58f1c22SToby Isaac } 5588c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 5589c58f1c22SToby Isaac } 5590c58f1c22SToby Isaac 5591c58f1c22SToby Isaac 5592c58f1c22SToby Isaac /*@ 5593c58f1c22SToby Isaac DMCopyLabels - Copy labels from one mesh to another with a superset of the points 5594c58f1c22SToby Isaac 5595c58f1c22SToby Isaac Collective on DM 5596c58f1c22SToby Isaac 5597c58f1c22SToby Isaac Input Parameter: 55982e17dfb7SMatthew G. Knepley . dmA - The DM object with initial labels 5599c58f1c22SToby Isaac 5600c58f1c22SToby Isaac Output Parameter: 56012e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels 5602c58f1c22SToby Isaac 5603c58f1c22SToby Isaac Level: intermediate 5604c58f1c22SToby Isaac 5605c58f1c22SToby Isaac Note: This is typically used when interpolating or otherwise adding to a mesh 5606c58f1c22SToby Isaac 5607c58f1c22SToby Isaac .keywords: mesh 5608c58f1c22SToby Isaac .seealso: DMCopyCoordinates(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection() 5609c58f1c22SToby Isaac @*/ 5610c58f1c22SToby Isaac PetscErrorCode DMCopyLabels(DM dmA, DM dmB) 5611c58f1c22SToby Isaac { 5612c58f1c22SToby Isaac PetscInt numLabels, l; 5613c58f1c22SToby Isaac PetscErrorCode ierr; 5614c58f1c22SToby Isaac 5615c58f1c22SToby Isaac PetscFunctionBegin; 5616c58f1c22SToby Isaac if (dmA == dmB) PetscFunctionReturn(0); 5617c58f1c22SToby Isaac ierr = DMGetNumLabels(dmA, &numLabels);CHKERRQ(ierr); 5618c58f1c22SToby Isaac for (l = 0; l < numLabels; ++l) { 5619c58f1c22SToby Isaac DMLabel label, labelNew; 5620c58f1c22SToby Isaac const char *name; 5621c58f1c22SToby Isaac PetscBool flg; 5622c58f1c22SToby Isaac 5623c58f1c22SToby Isaac ierr = DMGetLabelName(dmA, l, &name);CHKERRQ(ierr); 5624c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr); 5625c58f1c22SToby Isaac if (flg) continue; 5626c58f1c22SToby Isaac ierr = DMGetLabel(dmA, name, &label);CHKERRQ(ierr); 5627c58f1c22SToby Isaac ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr); 5628c58f1c22SToby Isaac ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr); 5629c58f1c22SToby Isaac } 5630c58f1c22SToby Isaac PetscFunctionReturn(0); 5631c58f1c22SToby Isaac } 5632a8fb8f29SToby Isaac 5633a8fb8f29SToby Isaac /*@ 5634a8fb8f29SToby Isaac DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement 5635a8fb8f29SToby Isaac 5636a8fb8f29SToby Isaac Input Parameter: 5637a8fb8f29SToby Isaac . dm - The DM object 5638a8fb8f29SToby Isaac 5639a8fb8f29SToby Isaac Output Parameter: 5640a8fb8f29SToby Isaac . cdm - The coarse DM 5641a8fb8f29SToby Isaac 5642a8fb8f29SToby Isaac Level: intermediate 5643a8fb8f29SToby Isaac 5644a8fb8f29SToby Isaac .seealso: DMSetCoarseDM() 5645a8fb8f29SToby Isaac @*/ 5646a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm) 5647a8fb8f29SToby Isaac { 5648a8fb8f29SToby Isaac PetscFunctionBegin; 5649a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5650a8fb8f29SToby Isaac PetscValidPointer(cdm, 2); 5651a8fb8f29SToby Isaac *cdm = dm->coarseMesh; 5652a8fb8f29SToby Isaac PetscFunctionReturn(0); 5653a8fb8f29SToby Isaac } 5654a8fb8f29SToby Isaac 5655a8fb8f29SToby Isaac /*@ 5656a8fb8f29SToby Isaac DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement 5657a8fb8f29SToby Isaac 5658a8fb8f29SToby Isaac Input Parameters: 5659a8fb8f29SToby Isaac + dm - The DM object 5660a8fb8f29SToby Isaac - cdm - The coarse DM 5661a8fb8f29SToby Isaac 5662a8fb8f29SToby Isaac Level: intermediate 5663a8fb8f29SToby Isaac 5664a8fb8f29SToby Isaac .seealso: DMGetCoarseDM() 5665a8fb8f29SToby Isaac @*/ 5666a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm) 5667a8fb8f29SToby Isaac { 5668a8fb8f29SToby Isaac PetscErrorCode ierr; 5669a8fb8f29SToby Isaac 5670a8fb8f29SToby Isaac PetscFunctionBegin; 5671a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5672a8fb8f29SToby Isaac if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2); 5673a8fb8f29SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 5674a8fb8f29SToby Isaac ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr); 5675a8fb8f29SToby Isaac dm->coarseMesh = cdm; 5676a8fb8f29SToby Isaac PetscFunctionReturn(0); 5677a8fb8f29SToby Isaac } 5678a8fb8f29SToby Isaac 567988bdff64SToby Isaac /*@ 568088bdff64SToby Isaac DMGetFineDM - Get the fine mesh from which this was obtained by refinement 568188bdff64SToby Isaac 568288bdff64SToby Isaac Input Parameter: 568388bdff64SToby Isaac . dm - The DM object 568488bdff64SToby Isaac 568588bdff64SToby Isaac Output Parameter: 568688bdff64SToby Isaac . fdm - The fine DM 568788bdff64SToby Isaac 568888bdff64SToby Isaac Level: intermediate 568988bdff64SToby Isaac 569088bdff64SToby Isaac .seealso: DMSetFineDM() 569188bdff64SToby Isaac @*/ 569288bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm) 569388bdff64SToby Isaac { 569488bdff64SToby Isaac PetscFunctionBegin; 569588bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 569688bdff64SToby Isaac PetscValidPointer(fdm, 2); 569788bdff64SToby Isaac *fdm = dm->fineMesh; 569888bdff64SToby Isaac PetscFunctionReturn(0); 569988bdff64SToby Isaac } 570088bdff64SToby Isaac 570188bdff64SToby Isaac /*@ 570288bdff64SToby Isaac DMSetFineDM - Set the fine mesh from which this was obtained by refinement 570388bdff64SToby Isaac 570488bdff64SToby Isaac Input Parameters: 570588bdff64SToby Isaac + dm - The DM object 570688bdff64SToby Isaac - fdm - The fine DM 570788bdff64SToby Isaac 570888bdff64SToby Isaac Level: intermediate 570988bdff64SToby Isaac 571088bdff64SToby Isaac .seealso: DMGetFineDM() 571188bdff64SToby Isaac @*/ 571288bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm) 571388bdff64SToby Isaac { 571488bdff64SToby Isaac PetscErrorCode ierr; 571588bdff64SToby Isaac 571688bdff64SToby Isaac PetscFunctionBegin; 571788bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 571888bdff64SToby Isaac if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2); 571988bdff64SToby Isaac ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr); 572088bdff64SToby Isaac ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr); 572188bdff64SToby Isaac dm->fineMesh = fdm; 572288bdff64SToby Isaac PetscFunctionReturn(0); 572388bdff64SToby Isaac } 572488bdff64SToby Isaac 5725a6ba4734SToby Isaac /*=== DMBoundary code ===*/ 5726a6ba4734SToby Isaac 5727a6ba4734SToby Isaac PetscErrorCode DMCopyBoundary(DM dm, DM dmNew) 5728a6ba4734SToby Isaac { 5729a6ba4734SToby Isaac PetscErrorCode ierr; 5730a6ba4734SToby Isaac 5731a6ba4734SToby Isaac PetscFunctionBegin; 5732e6f8dbb6SToby Isaac ierr = PetscDSCopyBoundary(dm->prob,dmNew->prob);CHKERRQ(ierr); 5733a6ba4734SToby Isaac PetscFunctionReturn(0); 5734a6ba4734SToby Isaac } 5735a6ba4734SToby Isaac 5736a6ba4734SToby Isaac /*@C 5737a6ba4734SToby Isaac DMAddBoundary - Add a boundary condition to the model 5738a6ba4734SToby Isaac 5739a6ba4734SToby Isaac Input Parameters: 57404c258f51SMatthew G. Knepley + dm - The DM, with a PetscDS that matches the problem being constrained 5741f971fd6bSMatthew G. Knepley . type - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 5742a6ba4734SToby Isaac . name - The BC name 5743a6ba4734SToby Isaac . labelname - The label defining constrained points 5744a6ba4734SToby Isaac . field - The field to constrain 5745a6ba4734SToby Isaac . numcomps - The number of constrained field components 5746a6ba4734SToby Isaac . comps - An array of constrained component numbers 5747a6ba4734SToby Isaac . bcFunc - A pointwise function giving boundary values 5748a6ba4734SToby Isaac . numids - The number of DMLabel ids for constrained points 5749a6ba4734SToby Isaac . ids - An array of ids for constrained points 5750a6ba4734SToby Isaac - ctx - An optional user context for bcFunc 5751a6ba4734SToby Isaac 5752a6ba4734SToby Isaac Options Database Keys: 5753a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 5754a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 5755a6ba4734SToby Isaac 5756a6ba4734SToby Isaac Level: developer 5757a6ba4734SToby Isaac 5758a6ba4734SToby Isaac .seealso: DMGetBoundary() 5759a6ba4734SToby Isaac @*/ 5760a30ec4eaSSatish 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) 5761a6ba4734SToby Isaac { 5762a6ba4734SToby Isaac PetscErrorCode ierr; 5763a6ba4734SToby Isaac 5764a6ba4734SToby Isaac PetscFunctionBegin; 5765a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5766f971fd6bSMatthew G. Knepley ierr = PetscDSAddBoundary(dm->prob,type,name,labelname,field,numcomps,comps,bcFunc,numids,ids,ctx);CHKERRQ(ierr); 5767a6ba4734SToby Isaac PetscFunctionReturn(0); 5768a6ba4734SToby Isaac } 5769a6ba4734SToby Isaac 5770a6ba4734SToby Isaac /*@ 5771a6ba4734SToby Isaac DMGetNumBoundary - Get the number of registered BC 5772a6ba4734SToby Isaac 5773a6ba4734SToby Isaac Input Parameters: 5774a6ba4734SToby Isaac . dm - The mesh object 5775a6ba4734SToby Isaac 5776a6ba4734SToby Isaac Output Parameters: 5777a6ba4734SToby Isaac . numBd - The number of BC 5778a6ba4734SToby Isaac 5779a6ba4734SToby Isaac Level: intermediate 5780a6ba4734SToby Isaac 5781a6ba4734SToby Isaac .seealso: DMAddBoundary(), DMGetBoundary() 5782a6ba4734SToby Isaac @*/ 5783a6ba4734SToby Isaac PetscErrorCode DMGetNumBoundary(DM dm, PetscInt *numBd) 5784a6ba4734SToby Isaac { 578558ebd649SToby Isaac PetscErrorCode ierr; 5786a6ba4734SToby Isaac 5787a6ba4734SToby Isaac PetscFunctionBegin; 5788a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 578958ebd649SToby Isaac ierr = PetscDSGetNumBoundary(dm->prob,numBd);CHKERRQ(ierr); 5790a6ba4734SToby Isaac PetscFunctionReturn(0); 5791a6ba4734SToby Isaac } 5792a6ba4734SToby Isaac 5793a6ba4734SToby Isaac /*@C 5794a6ba4734SToby Isaac DMGetBoundary - Add a boundary condition to the model 5795a6ba4734SToby Isaac 5796a6ba4734SToby Isaac Input Parameters: 5797a6ba4734SToby Isaac + dm - The mesh object 5798a6ba4734SToby Isaac - bd - The BC number 5799a6ba4734SToby Isaac 5800a6ba4734SToby Isaac Output Parameters: 5801f971fd6bSMatthew G. Knepley + type - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 5802a6ba4734SToby Isaac . name - The BC name 5803a6ba4734SToby Isaac . labelname - The label defining constrained points 5804a6ba4734SToby Isaac . field - The field to constrain 5805a6ba4734SToby Isaac . numcomps - The number of constrained field components 5806a6ba4734SToby Isaac . comps - An array of constrained component numbers 5807a6ba4734SToby Isaac . bcFunc - A pointwise function giving boundary values 5808a6ba4734SToby Isaac . numids - The number of DMLabel ids for constrained points 5809a6ba4734SToby Isaac . ids - An array of ids for constrained points 5810a6ba4734SToby Isaac - ctx - An optional user context for bcFunc 5811a6ba4734SToby Isaac 5812a6ba4734SToby Isaac Options Database Keys: 5813a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 5814a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 5815a6ba4734SToby Isaac 5816a6ba4734SToby Isaac Level: developer 5817a6ba4734SToby Isaac 5818a6ba4734SToby Isaac .seealso: DMAddBoundary() 5819a6ba4734SToby Isaac @*/ 5820a30ec4eaSSatish 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) 5821a6ba4734SToby Isaac { 582258ebd649SToby Isaac PetscErrorCode ierr; 5823a6ba4734SToby Isaac 5824a6ba4734SToby Isaac PetscFunctionBegin; 5825a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5826f971fd6bSMatthew G. Knepley ierr = PetscDSGetBoundary(dm->prob,bd,type,name,labelname,field,numcomps,comps,func,numids,ids,ctx);CHKERRQ(ierr); 5827a6ba4734SToby Isaac PetscFunctionReturn(0); 5828a6ba4734SToby Isaac } 5829a6ba4734SToby Isaac 5830e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm) 5831e6f8dbb6SToby Isaac { 5832dff059c6SToby Isaac DMBoundary *lastnext; 5833e6f8dbb6SToby Isaac DSBoundary dsbound; 5834e6f8dbb6SToby Isaac PetscErrorCode ierr; 5835e6f8dbb6SToby Isaac 5836e6f8dbb6SToby Isaac PetscFunctionBegin; 5837e6f8dbb6SToby Isaac dsbound = dm->prob->boundary; 583847a1f5adSToby Isaac if (dm->boundary) { 583947a1f5adSToby Isaac DMBoundary next = dm->boundary; 584047a1f5adSToby Isaac 584147a1f5adSToby Isaac /* quick check to see if the PetscDS has changed */ 584247a1f5adSToby Isaac if (next->dsboundary == dsbound) PetscFunctionReturn(0); 584347a1f5adSToby Isaac /* the PetscDS has changed: tear down and rebuild */ 584447a1f5adSToby Isaac while (next) { 584547a1f5adSToby Isaac DMBoundary b = next; 584647a1f5adSToby Isaac 584747a1f5adSToby Isaac next = b->next; 584847a1f5adSToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 5849a6ba4734SToby Isaac } 585047a1f5adSToby Isaac dm->boundary = NULL; 5851a6ba4734SToby Isaac } 585247a1f5adSToby Isaac 5853dff059c6SToby Isaac lastnext = &(dm->boundary); 5854e6f8dbb6SToby Isaac while (dsbound) { 5855e6f8dbb6SToby Isaac DMBoundary dmbound; 5856e6f8dbb6SToby Isaac 5857e6f8dbb6SToby Isaac ierr = PetscNew(&dmbound);CHKERRQ(ierr); 5858e6f8dbb6SToby Isaac dmbound->dsboundary = dsbound; 5859e6f8dbb6SToby Isaac ierr = DMGetLabel(dm, dsbound->labelname, &(dmbound->label));CHKERRQ(ierr); 5860e6f8dbb6SToby Isaac if (!dmbound->label) PetscInfo2(dm, "DSBoundary %s wants label %s, which is not in this dm.\n",dsbound->name,dsbound->labelname);CHKERRQ(ierr); 586147a1f5adSToby Isaac /* push on the back instead of the front so that it is in the same order as in the PetscDS */ 5862dff059c6SToby Isaac *lastnext = dmbound; 5863dff059c6SToby Isaac lastnext = &(dmbound->next); 5864dff059c6SToby Isaac dsbound = dsbound->next; 5865a6ba4734SToby Isaac } 5866a6ba4734SToby Isaac PetscFunctionReturn(0); 5867a6ba4734SToby Isaac } 5868a6ba4734SToby Isaac 5869a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd) 5870a6ba4734SToby Isaac { 5871b95f2879SToby Isaac DMBoundary b; 5872a6ba4734SToby Isaac PetscErrorCode ierr; 5873a6ba4734SToby Isaac 5874a6ba4734SToby Isaac PetscFunctionBegin; 5875a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5876a6ba4734SToby Isaac PetscValidPointer(isBd, 3); 5877a6ba4734SToby Isaac *isBd = PETSC_FALSE; 5878e6f8dbb6SToby Isaac ierr = DMPopulateBoundary(dm);CHKERRQ(ierr); 5879b95f2879SToby Isaac b = dm->boundary; 5880a6ba4734SToby Isaac while (b && !(*isBd)) { 5881e6f8dbb6SToby Isaac DMLabel label = b->label; 5882e6f8dbb6SToby Isaac DSBoundary dsb = b->dsboundary; 58833424c85cSToby Isaac 58843424c85cSToby Isaac if (label) { 5885a6ba4734SToby Isaac PetscInt i; 5886a6ba4734SToby Isaac 5887e6f8dbb6SToby Isaac for (i = 0; i < dsb->numids && !(*isBd); ++i) { 5888e6f8dbb6SToby Isaac ierr = DMLabelStratumHasPoint(label, dsb->ids[i], point, isBd);CHKERRQ(ierr); 5889a6ba4734SToby Isaac } 5890a6ba4734SToby Isaac } 5891a6ba4734SToby Isaac b = b->next; 5892a6ba4734SToby Isaac } 5893a6ba4734SToby Isaac PetscFunctionReturn(0); 5894a6ba4734SToby Isaac } 58954d6f44ffSToby Isaac 58964d6f44ffSToby Isaac /*@C 58974d6f44ffSToby Isaac DMProjectFunction - This projects the given function into the function space provided. 58984d6f44ffSToby Isaac 58994d6f44ffSToby Isaac Input Parameters: 59004d6f44ffSToby Isaac + dm - The DM 59010709b2feSToby Isaac . time - The time 59024d6f44ffSToby Isaac . funcs - The coordinate functions to evaluate, one per field 59034d6f44ffSToby Isaac . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 59044d6f44ffSToby Isaac - mode - The insertion mode for values 59054d6f44ffSToby Isaac 59064d6f44ffSToby Isaac Output Parameter: 59074d6f44ffSToby Isaac . X - vector 59084d6f44ffSToby Isaac 59094d6f44ffSToby Isaac Calling sequence of func: 59100709b2feSToby Isaac $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx); 59114d6f44ffSToby Isaac 59124d6f44ffSToby Isaac + dim - The spatial dimension 59134d6f44ffSToby Isaac . x - The coordinates 59144d6f44ffSToby Isaac . Nf - The number of fields 59154d6f44ffSToby Isaac . u - The output field values 59164d6f44ffSToby Isaac - ctx - optional user-defined function context 59174d6f44ffSToby Isaac 59184d6f44ffSToby Isaac Level: developer 59194d6f44ffSToby Isaac 59202716604bSToby Isaac .seealso: DMComputeL2Diff() 59214d6f44ffSToby Isaac @*/ 59220709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X) 59234d6f44ffSToby Isaac { 59244d6f44ffSToby Isaac Vec localX; 59254d6f44ffSToby Isaac PetscErrorCode ierr; 59264d6f44ffSToby Isaac 59274d6f44ffSToby Isaac PetscFunctionBegin; 59284d6f44ffSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 59294d6f44ffSToby Isaac ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 59300709b2feSToby Isaac ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 59314d6f44ffSToby Isaac ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 59324d6f44ffSToby Isaac ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 59334d6f44ffSToby Isaac ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 59344d6f44ffSToby Isaac PetscFunctionReturn(0); 59354d6f44ffSToby Isaac } 59364d6f44ffSToby Isaac 59370709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 59384d6f44ffSToby Isaac { 59394d6f44ffSToby Isaac PetscErrorCode ierr; 59404d6f44ffSToby Isaac 59414d6f44ffSToby Isaac PetscFunctionBegin; 59424d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 59434d6f44ffSToby Isaac PetscValidHeaderSpecific(localX,VEC_CLASSID,5); 59444d6f44ffSToby Isaac if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLocal",((PetscObject)dm)->type_name); 59450709b2feSToby Isaac ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 59464d6f44ffSToby Isaac PetscFunctionReturn(0); 59474d6f44ffSToby Isaac } 59484d6f44ffSToby Isaac 59490709b2feSToby Isaac PetscErrorCode DMProjectFunctionLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 59504d6f44ffSToby Isaac { 59514d6f44ffSToby Isaac PetscErrorCode ierr; 59524d6f44ffSToby Isaac 59534d6f44ffSToby Isaac PetscFunctionBegin; 59544d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 59554d6f44ffSToby Isaac PetscValidHeaderSpecific(localX,VEC_CLASSID,5); 59564d6f44ffSToby Isaac if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name); 59570709b2feSToby Isaac ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, funcs, ctxs, mode, localX);CHKERRQ(ierr); 59584d6f44ffSToby Isaac PetscFunctionReturn(0); 59594d6f44ffSToby Isaac } 59602716604bSToby Isaac 59618c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU, 59628c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 59638c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 59648c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 5965191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 59668c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 59678c6c5593SMatthew G. Knepley { 59688c6c5593SMatthew G. Knepley PetscErrorCode ierr; 59698c6c5593SMatthew G. Knepley 59708c6c5593SMatthew G. Knepley PetscFunctionBegin; 59718c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 59728c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localU,VEC_CLASSID,3); 59738c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 59748c6c5593SMatthew G. Knepley if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFieldLocal",((PetscObject)dm)->type_name); 59758c6c5593SMatthew G. Knepley ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr); 59768c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 59778c6c5593SMatthew G. Knepley } 59788c6c5593SMatthew G. Knepley 59798c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], Vec localU, 59808c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 59818c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 59828c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 5983191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 59848c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 59858c6c5593SMatthew G. Knepley { 59868c6c5593SMatthew G. Knepley PetscErrorCode ierr; 59878c6c5593SMatthew G. Knepley 59888c6c5593SMatthew G. Knepley PetscFunctionBegin; 59898c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 59908c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localU,VEC_CLASSID,6); 59918c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localX,VEC_CLASSID,9); 59928c6c5593SMatthew G. Knepley if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFieldLocal",((PetscObject)dm)->type_name); 59938c6c5593SMatthew G. Knepley ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, localU, funcs, mode, localX);CHKERRQ(ierr); 59948c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 59958c6c5593SMatthew G. Knepley } 59968c6c5593SMatthew G. Knepley 59972716604bSToby Isaac /*@C 59982716604bSToby Isaac DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h. 59992716604bSToby Isaac 60002716604bSToby Isaac Input Parameters: 60012716604bSToby Isaac + dm - The DM 60020709b2feSToby Isaac . time - The time 60032716604bSToby Isaac . funcs - The functions to evaluate for each field component 60042716604bSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 60052716604bSToby Isaac - X - The coefficient vector u_h 60062716604bSToby Isaac 60072716604bSToby Isaac Output Parameter: 60082716604bSToby Isaac . diff - The diff ||u - u_h||_2 60092716604bSToby Isaac 60102716604bSToby Isaac Level: developer 60112716604bSToby Isaac 60121189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 60132716604bSToby Isaac @*/ 60140709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff) 60152716604bSToby Isaac { 60162716604bSToby Isaac PetscErrorCode ierr; 60172716604bSToby Isaac 60182716604bSToby Isaac PetscFunctionBegin; 60192716604bSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6020b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 60212716604bSToby Isaac if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2Diff",((PetscObject)dm)->type_name); 60220709b2feSToby Isaac ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 60232716604bSToby Isaac PetscFunctionReturn(0); 60242716604bSToby Isaac } 6025b698f381SToby Isaac 6026b698f381SToby Isaac /*@C 6027b698f381SToby Isaac DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h. 6028b698f381SToby Isaac 6029b698f381SToby Isaac Input Parameters: 6030b698f381SToby Isaac + dm - The DM 6031b698f381SToby Isaac , time - The time 6032b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component 6033b698f381SToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 6034b698f381SToby Isaac . X - The coefficient vector u_h 6035b698f381SToby Isaac - n - The vector to project along 6036b698f381SToby Isaac 6037b698f381SToby Isaac Output Parameter: 6038b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2 6039b698f381SToby Isaac 6040b698f381SToby Isaac Level: developer 6041b698f381SToby Isaac 6042b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff() 6043b698f381SToby Isaac @*/ 6044b698f381SToby 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) 6045b698f381SToby Isaac { 6046b698f381SToby Isaac PetscErrorCode ierr; 6047b698f381SToby Isaac 6048b698f381SToby Isaac PetscFunctionBegin; 6049b698f381SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6050b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 6051b698f381SToby Isaac if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name); 6052b698f381SToby Isaac ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr); 6053b698f381SToby Isaac PetscFunctionReturn(0); 6054b698f381SToby Isaac } 6055b698f381SToby Isaac 60562a16baeaSToby Isaac /*@C 60572a16baeaSToby Isaac DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components. 60582a16baeaSToby Isaac 60592a16baeaSToby Isaac Input Parameters: 60602a16baeaSToby Isaac + dm - The DM 60612a16baeaSToby Isaac . time - The time 60622a16baeaSToby Isaac . funcs - The functions to evaluate for each field component 60632a16baeaSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 60642a16baeaSToby Isaac - X - The coefficient vector u_h 60652a16baeaSToby Isaac 60662a16baeaSToby Isaac Output Parameter: 60672a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2 60682a16baeaSToby Isaac 60692a16baeaSToby Isaac Level: developer 60702a16baeaSToby Isaac 60711189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 60722a16baeaSToby Isaac @*/ 60731189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[]) 60742a16baeaSToby Isaac { 60752a16baeaSToby Isaac PetscErrorCode ierr; 60762a16baeaSToby Isaac 60772a16baeaSToby Isaac PetscFunctionBegin; 60782a16baeaSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 60792a16baeaSToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 60802a16baeaSToby Isaac if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2FieldDiff",((PetscObject)dm)->type_name); 60812a16baeaSToby Isaac ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 60822a16baeaSToby Isaac PetscFunctionReturn(0); 60832a16baeaSToby Isaac } 60842a16baeaSToby Isaac 6085df0b854cSToby Isaac /*@C 6086df0b854cSToby Isaac DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags. Specific implementations of DM maybe have 6087cd3c525cSToby Isaac specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN. 6088df0b854cSToby Isaac 6089df0b854cSToby Isaac Collective on dm 6090df0b854cSToby Isaac 6091df0b854cSToby Isaac Input parameters: 6092df0b854cSToby Isaac + dm - the pre-adaptation DM object 6093a1b0c543SToby Isaac - label - label with the flags 6094df0b854cSToby Isaac 6095df0b854cSToby Isaac Output parameters: 6096df0b854cSToby Isaac . adaptedDM - the adapted DM object: may be NULL if an adapted DM could not be produced. 6097df0b854cSToby Isaac 6098df0b854cSToby Isaac Level: intermediate 6099df0b854cSToby Isaac @*/ 6100a1b0c543SToby Isaac PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *adaptedDM) 6101df0b854cSToby Isaac { 6102df0b854cSToby Isaac PetscErrorCode ierr; 6103df0b854cSToby Isaac 6104df0b854cSToby Isaac PetscFunctionBegin; 6105df0b854cSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6106a1b0c543SToby Isaac PetscValidPointer(label,2); 6107df0b854cSToby Isaac PetscValidPointer(adaptedDM,3); 6108df0b854cSToby Isaac *adaptedDM = NULL; 6109a1b0c543SToby Isaac ierr = PetscTryMethod((PetscObject)dm,"DMAdaptLabel_C",(DM,DMLabel, DM*),(dm,label,adaptedDM));CHKERRQ(ierr); 6110df0b854cSToby Isaac PetscFunctionReturn(0); 6111df0b854cSToby Isaac } 6112c4088d22SMatthew G. Knepley 6113502a2867SDave May /*@C 6114502a2867SDave May DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors 6115502a2867SDave May 6116502a2867SDave May Not Collective 6117502a2867SDave May 6118502a2867SDave May Input Parameter: 6119502a2867SDave May . dm - The DM 6120502a2867SDave May 6121502a2867SDave May Output Parameter: 6122502a2867SDave May . nranks - the number of neighbours 6123502a2867SDave May . ranks - the neighbors ranks 6124502a2867SDave May 6125502a2867SDave May Notes: 6126502a2867SDave May Do not free the array, it is freed when the DM is destroyed. 6127502a2867SDave May 6128502a2867SDave May Level: beginner 6129502a2867SDave May 6130dee935c1SDave May .seealso: DMDAGetNeighbors(), PetscSFGetRanks() 6131502a2867SDave May @*/ 6132502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[]) 6133502a2867SDave May { 6134502a2867SDave May PetscErrorCode ierr; 6135502a2867SDave May 6136502a2867SDave May PetscFunctionBegin; 6137502a2867SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6138502a2867SDave May if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMGetNeighbors",((PetscObject)dm)->type_name); 6139502a2867SDave May ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr); 6140502a2867SDave May PetscFunctionReturn(0); 6141502a2867SDave May } 6142502a2867SDave May 6143531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */ 6144531c7667SBarry Smith 6145531c7667SBarry Smith /* 6146531c7667SBarry Smith Converts the input vector to a ghosted vector and then calls the standard coloring code. 6147531c7667SBarry Smith This has be a different function because it requires DM which is not defined in the Mat library 6148531c7667SBarry Smith */ 6149531c7667SBarry Smith PetscErrorCode MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx) 6150531c7667SBarry Smith { 6151531c7667SBarry Smith PetscErrorCode ierr; 6152531c7667SBarry Smith 6153531c7667SBarry Smith PetscFunctionBegin; 6154531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 6155531c7667SBarry Smith Vec x1local; 6156531c7667SBarry Smith DM dm; 6157531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 6158531c7667SBarry Smith if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM"); 6159531c7667SBarry Smith ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr); 6160531c7667SBarry Smith ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 6161531c7667SBarry Smith ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 6162531c7667SBarry Smith x1 = x1local; 6163531c7667SBarry Smith } 6164531c7667SBarry Smith ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr); 6165531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 6166531c7667SBarry Smith DM dm; 6167531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 6168531c7667SBarry Smith ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr); 6169531c7667SBarry Smith } 6170531c7667SBarry Smith PetscFunctionReturn(0); 6171531c7667SBarry Smith } 6172531c7667SBarry Smith 6173531c7667SBarry Smith /*@ 6174531c7667SBarry Smith MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring 6175531c7667SBarry Smith 6176531c7667SBarry Smith Input Parameter: 6177531c7667SBarry Smith . coloring - the MatFDColoring object 6178531c7667SBarry Smith 6179531c7667SBarry Smith Developer Notes: this routine exists because the PETSc Mat library does not know about the DM objects 6180531c7667SBarry Smith 61811b266c99SBarry Smith Level: advanced 61821b266c99SBarry Smith 6183531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType 6184531c7667SBarry Smith @*/ 6185531c7667SBarry Smith PetscErrorCode MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring) 6186531c7667SBarry Smith { 6187531c7667SBarry Smith PetscFunctionBegin; 6188531c7667SBarry Smith coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM; 6189531c7667SBarry Smith PetscFunctionReturn(0); 6190531c7667SBarry Smith } 6191