1d0295fc0SJunchao Zhang #include <petscvec.h> 2af0996ceSBarry Smith #include <petsc/private/dmimpl.h> /*I "petscdm.h" I*/ 3c58f1c22SToby Isaac #include <petsc/private/dmlabelimpl.h> /*I "petscdmlabel.h" I*/ 4e6f8dbb6SToby Isaac #include <petsc/private/petscdsimpl.h> /*I "petscds.h" I*/ 53e922f36SToby Isaac #include <petscdmplex.h> 6f19dbd58SToby Isaac #include <petscdmfield.h> 70c312b8eSJed Brown #include <petscsf.h> 82764a2aaSMatthew G. Knepley #include <petscds.h> 947c6ae99SBarry Smith 10f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 11f918ec44SMatthew G. Knepley #include <petscfeceed.h> 12f918ec44SMatthew G. Knepley #endif 13f918ec44SMatthew G. Knepley 1400d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND) 1500d952a4SJed Brown # include <valgrind/memcheck.h> 1600d952a4SJed Brown #endif 1700d952a4SJed Brown 18732e2eb9SMatthew G Knepley PetscClassId DM_CLASSID; 19d67d17b1SMatthew G. Knepley PetscClassId DMLABEL_CLASSID; 20557cf195SMatthew G. Knepley PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_Refine, DM_CreateInterpolation, DM_CreateRestriction, DM_CreateInjection, DM_CreateMatrix, DM_Load, DM_AdaptInterpolator; 2167a56275SMatthew G Knepley 22ea78f98cSLisandro Dalcin const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DMBoundaryType","DM_BOUNDARY_", NULL}; 23d1b3049bSMatthew G. Knepley const char *const DMBoundaryConditionTypes[] = {"INVALID","ESSENTIAL","NATURAL","INVALID","INVALID","ESSENTIAL_FIELD","NATURAL_FIELD","INVALID","INVALID","ESSENTIAL_BD_FIELD","NATURAL_RIEMANN","DMBoundaryConditionType","DM_BC_", NULL}; 24da9060c4SMatthew G. Knepley const char *const DMPolytopeTypes[] = {"vertex", "segment", "tensor_segment", "triangle", "quadrilateral", "tensor_quad", "tetrahedron", "hexahedron", "triangular_prism", "tensor_triangular_prism", "tensor_quadrilateral_prism", "pyramid", "FV_ghost_cell", "interior_ghost_cell", "unknown", "invalid", "DMPolytopeType", "DM_POLYTOPE_", NULL}; 252cbb9b06SVaclav Hapla const char *const DMCopyLabelsModes[] = {"replace","keep","fail","DMCopyLabelsMode","DM_COPY_LABELS_", NULL}; 2660c22052SBarry Smith 27a4121054SBarry Smith /*@ 28de043629SMatthew G Knepley DMCreate - Creates an empty DM object. The type can then be set with DMSetType(). 29a4121054SBarry Smith 30a4121054SBarry Smith If you never call DMSetType() it will generate an 31a4121054SBarry Smith error when you try to use the vector. 32a4121054SBarry Smith 33d083f849SBarry Smith Collective 34a4121054SBarry Smith 35a4121054SBarry Smith Input Parameter: 36a4121054SBarry Smith . comm - The communicator for the DM object 37a4121054SBarry Smith 38a4121054SBarry Smith Output Parameter: 39a4121054SBarry Smith . dm - The DM object 40a4121054SBarry Smith 41a4121054SBarry Smith Level: beginner 42a4121054SBarry Smith 438472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK 44a4121054SBarry Smith @*/ 457087cfbeSBarry Smith PetscErrorCode DMCreate(MPI_Comm comm,DM *dm) 46a4121054SBarry Smith { 47a4121054SBarry Smith DM v; 48e5e52638SMatthew G. Knepley PetscDS ds; 49a4121054SBarry Smith PetscErrorCode ierr; 50a4121054SBarry Smith 51a4121054SBarry Smith PetscFunctionBegin; 521411c6eeSJed Brown PetscValidPointer(dm,2); 530298fd71SBarry Smith *dm = NULL; 54607a6623SBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 55a4121054SBarry Smith 5673107ff1SLisandro Dalcin ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr); 57e7c4fc90SDmitry Karpeev 5849be4549SMatthew G. Knepley v->setupcalled = PETSC_FALSE; 5949be4549SMatthew G. Knepley v->setfromoptionscalled = PETSC_FALSE; 600298fd71SBarry Smith v->ltogmap = NULL; 61a4ea9b21SRichard Tran Mills v->bind_below = 0; 621411c6eeSJed Brown v->bs = 1; 63171400e9SBarry Smith v->coloringtype = IS_COLORING_GLOBAL; 6488ed4aceSMatthew G Knepley ierr = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr); 651bb6d2a8SBarry Smith ierr = PetscSFCreate(comm, &v->sectionSF);CHKERRQ(ierr); 66c58f1c22SToby Isaac v->labels = NULL; 6734aa8a36SMatthew G. Knepley v->adjacency[0] = PETSC_FALSE; 6834aa8a36SMatthew G. Knepley v->adjacency[1] = PETSC_TRUE; 69c58f1c22SToby Isaac v->depthLabel = NULL; 70ba2698f1SMatthew G. Knepley v->celltypeLabel = NULL; 711bb6d2a8SBarry Smith v->localSection = NULL; 721bb6d2a8SBarry Smith v->globalSection = NULL; 73fba222abSToby Isaac v->defaultConstraintSection = NULL; 74fba222abSToby Isaac v->defaultConstraintMat = NULL; 75c6b900c6SMatthew G. Knepley v->L = NULL; 76c6b900c6SMatthew G. Knepley v->maxCell = NULL; 775dc8c3f7SMatthew G. Knepley v->bdtype = NULL; 789a9a41abSToby Isaac v->dimEmbed = PETSC_DEFAULT; 7996173672SStefano Zampini v->dim = PETSC_DETERMINE; 80435a35e8SMatthew G Knepley { 81435a35e8SMatthew G Knepley PetscInt i; 82435a35e8SMatthew G Knepley for (i = 0; i < 10; ++i) { 830298fd71SBarry Smith v->nullspaceConstructors[i] = NULL; 84f9d4088aSMatthew G. Knepley v->nearnullspaceConstructors[i] = NULL; 85435a35e8SMatthew G Knepley } 86435a35e8SMatthew G Knepley } 8745480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 88b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr); 89e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 909a2a23afSMatthew G. Knepley ierr = PetscHMapAuxCreate(&v->auxData);CHKERRQ(ierr); 9114f150ffSMatthew G. Knepley v->dmBC = NULL; 92a8fb8f29SToby Isaac v->coarseMesh = NULL; 93f4d763aaSMatthew G. Knepley v->outputSequenceNum = -1; 94cdb7a50dSMatthew G. Knepley v->outputSequenceVal = 0.0; 95c0dedaeaSBarry Smith ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr); 96b412c318SBarry Smith ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr); 974a7a4c06SLawrence Mitchell 981411c6eeSJed Brown *dm = v; 99a4121054SBarry Smith PetscFunctionReturn(0); 100a4121054SBarry Smith } 101a4121054SBarry Smith 10238221697SMatthew G. Knepley /*@ 10338221697SMatthew G. Knepley DMClone - Creates a DM object with the same topology as the original. 10438221697SMatthew G. Knepley 105d083f849SBarry Smith Collective 10638221697SMatthew G. Knepley 10738221697SMatthew G. Knepley Input Parameter: 10838221697SMatthew G. Knepley . dm - The original DM object 10938221697SMatthew G. Knepley 11038221697SMatthew G. Knepley Output Parameter: 11138221697SMatthew G. Knepley . newdm - The new DM object 11238221697SMatthew G. Knepley 11338221697SMatthew G. Knepley Level: beginner 11438221697SMatthew G. Knepley 1151cb8cacdSPatrick Sanan Notes: 1161cb8cacdSPatrick Sanan For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example, 1171cb8cacdSPatrick Sanan DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not 1181cb8cacdSPatrick Sanan share the PetscSection of the original DM. 1191bb6d2a8SBarry Smith 12089706ed2SPatrick Sanan The clone is considered set up iff the original is. 12189706ed2SPatrick Sanan 12292cfd99aSMartin Diehl .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection() 1231bb6d2a8SBarry Smith 12438221697SMatthew G. Knepley @*/ 12538221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm) 12638221697SMatthew G. Knepley { 12738221697SMatthew G. Knepley PetscSF sf; 12838221697SMatthew G. Knepley Vec coords; 12938221697SMatthew G. Knepley void *ctx; 130a3219837SMatthew G. Knepley PetscInt dim, cdim; 13138221697SMatthew G. Knepley PetscErrorCode ierr; 13238221697SMatthew G. Knepley 13338221697SMatthew G. Knepley PetscFunctionBegin; 13438221697SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 13538221697SMatthew G. Knepley PetscValidPointer(newdm,2); 13638221697SMatthew G. Knepley ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr); 1372cbb9b06SVaclav Hapla ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE, DM_COPY_LABELS_FAIL);CHKERRQ(ierr); 138ddf8437dSMatthew G. Knepley (*newdm)->leveldown = dm->leveldown; 139ddf8437dSMatthew G. Knepley (*newdm)->levelup = dm->levelup; 140c8a6034eSMark (*newdm)->prealloc_only = dm->prealloc_only; 141a587d139SMark ierr = PetscFree((*newdm)->vectype);CHKERRQ(ierr); 142a587d139SMark ierr = PetscStrallocpy(dm->vectype,(char**)&(*newdm)->vectype);CHKERRQ(ierr); 143a587d139SMark ierr = PetscFree((*newdm)->mattype);CHKERRQ(ierr); 144a587d139SMark ierr = PetscStrallocpy(dm->mattype,(char**)&(*newdm)->mattype);CHKERRQ(ierr); 1451de53e9aSMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 1461de53e9aSMatthew G. Knepley ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr); 14738221697SMatthew G. Knepley if (dm->ops->clone) { 14838221697SMatthew G. Knepley ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr); 14938221697SMatthew G. Knepley } 1503f22bcbcSToby Isaac (*newdm)->setupcalled = dm->setupcalled; 15138221697SMatthew G. Knepley ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr); 15238221697SMatthew G. Knepley ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr); 15338221697SMatthew G. Knepley ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr); 15438221697SMatthew G. Knepley ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr); 155be4c1c3eSMatthew G. Knepley if (dm->coordinateDM) { 156be4c1c3eSMatthew G. Knepley DM ncdm; 157be4c1c3eSMatthew G. Knepley PetscSection cs; 1585a0206caSToby Isaac PetscInt pEnd = -1, pEndMax = -1; 159be4c1c3eSMatthew G. Knepley 16092fd8e1eSJed Brown ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr); 161be4c1c3eSMatthew G. Knepley if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);} 162ffc4695bSBarry Smith ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 1635a0206caSToby Isaac if (pEndMax >= 0) { 164be4c1c3eSMatthew G. Knepley ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr); 16583bfc06fSMatthew Knepley ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr); 16692fd8e1eSJed Brown ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr); 167a61e840bSMatthew G. Knepley ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr); 168be4c1c3eSMatthew G. Knepley ierr = DMDestroy(&ncdm);CHKERRQ(ierr); 169be4c1c3eSMatthew G. Knepley } 170be4c1c3eSMatthew G. Knepley } 171a3219837SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 172a3219837SMatthew G. Knepley ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr); 17338221697SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr); 17438221697SMatthew G. Knepley if (coords) { 17538221697SMatthew G. Knepley ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr); 17638221697SMatthew G. Knepley } else { 17738221697SMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 17838221697SMatthew G. Knepley if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);} 17938221697SMatthew G. Knepley } 18090b157c4SStefano Zampini { 18190b157c4SStefano Zampini PetscBool isper; 182c6b900c6SMatthew G. Knepley const PetscReal *maxCell, *L; 1835dc8c3f7SMatthew G. Knepley const DMBoundaryType *bd; 18490b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 18590b157c4SStefano Zampini ierr = DMSetPeriodicity(*newdm, isper, maxCell, L, bd);CHKERRQ(ierr); 186c6b900c6SMatthew G. Knepley } 18734aa8a36SMatthew G. Knepley { 18834aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 18934aa8a36SMatthew G. Knepley 19034aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr); 19134aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 19234aa8a36SMatthew G. Knepley } 19338221697SMatthew G. Knepley PetscFunctionReturn(0); 19438221697SMatthew G. Knepley } 19538221697SMatthew G. Knepley 1969a42bb27SBarry Smith /*@C 197564755cdSBarry Smith DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 1989a42bb27SBarry Smith 199d083f849SBarry Smith Logically Collective on da 2009a42bb27SBarry Smith 2019a42bb27SBarry Smith Input Parameter: 2029a42bb27SBarry Smith + da - initial distributed array 203e9e886b6SKarl Rupp . ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL 2049a42bb27SBarry Smith 2059a42bb27SBarry Smith Options Database: 206dd85299cSBarry Smith . -dm_vec_type ctype 2079a42bb27SBarry Smith 2089a42bb27SBarry Smith Level: intermediate 2099a42bb27SBarry Smith 210a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType() 2119a42bb27SBarry Smith @*/ 21219fd82e9SBarry Smith PetscErrorCode DMSetVecType(DM da,VecType ctype) 2139a42bb27SBarry Smith { 2149a42bb27SBarry Smith PetscErrorCode ierr; 2159a42bb27SBarry Smith 2169a42bb27SBarry Smith PetscFunctionBegin; 2179a42bb27SBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 2189a42bb27SBarry Smith ierr = PetscFree(da->vectype);CHKERRQ(ierr); 21919fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr); 2209a42bb27SBarry Smith PetscFunctionReturn(0); 2219a42bb27SBarry Smith } 2229a42bb27SBarry Smith 223c0dedaeaSBarry Smith /*@C 224c0dedaeaSBarry Smith DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 225c0dedaeaSBarry Smith 226d083f849SBarry Smith Logically Collective on da 227c0dedaeaSBarry Smith 228c0dedaeaSBarry Smith Input Parameter: 229c0dedaeaSBarry Smith . da - initial distributed array 230c0dedaeaSBarry Smith 231c0dedaeaSBarry Smith Output Parameter: 232c0dedaeaSBarry Smith . ctype - the vector type 233c0dedaeaSBarry Smith 234c0dedaeaSBarry Smith Level: intermediate 235c0dedaeaSBarry Smith 236a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType() 237c0dedaeaSBarry Smith @*/ 238c0dedaeaSBarry Smith PetscErrorCode DMGetVecType(DM da,VecType *ctype) 239c0dedaeaSBarry Smith { 240c0dedaeaSBarry Smith PetscFunctionBegin; 241c0dedaeaSBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 242c0dedaeaSBarry Smith *ctype = da->vectype; 243c0dedaeaSBarry Smith PetscFunctionReturn(0); 244c0dedaeaSBarry Smith } 245c0dedaeaSBarry Smith 2465f1ad066SMatthew G Knepley /*@ 24734f98d34SBarry Smith VecGetDM - Gets the DM defining the data layout of the vector 2485f1ad066SMatthew G Knepley 2495f1ad066SMatthew G Knepley Not collective 2505f1ad066SMatthew G Knepley 2515f1ad066SMatthew G Knepley Input Parameter: 2525f1ad066SMatthew G Knepley . v - The Vec 2535f1ad066SMatthew G Knepley 2545f1ad066SMatthew G Knepley Output Parameter: 2555f1ad066SMatthew G Knepley . dm - The DM 2565f1ad066SMatthew G Knepley 2575f1ad066SMatthew G Knepley Level: intermediate 2585f1ad066SMatthew G Knepley 2595f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2605f1ad066SMatthew G Knepley @*/ 2615f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm) 2625f1ad066SMatthew G Knepley { 2635f1ad066SMatthew G Knepley PetscErrorCode ierr; 2645f1ad066SMatthew G Knepley 2655f1ad066SMatthew G Knepley PetscFunctionBegin; 2665f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 2675f1ad066SMatthew G Knepley PetscValidPointer(dm,2); 2685f1ad066SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 2695f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2705f1ad066SMatthew G Knepley } 2715f1ad066SMatthew G Knepley 2725f1ad066SMatthew G Knepley /*@ 273d9805387SMatthew G. Knepley VecSetDM - Sets the DM defining the data layout of the vector. 2745f1ad066SMatthew G Knepley 2755f1ad066SMatthew G Knepley Not collective 2765f1ad066SMatthew G Knepley 2775f1ad066SMatthew G Knepley Input Parameters: 2785f1ad066SMatthew G Knepley + v - The Vec 2795f1ad066SMatthew G Knepley - dm - The DM 2805f1ad066SMatthew G Knepley 281d9805387SMatthew 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. 282d9805387SMatthew G. Knepley 2835f1ad066SMatthew G Knepley Level: intermediate 2845f1ad066SMatthew G Knepley 2855f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2865f1ad066SMatthew G Knepley @*/ 2875f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm) 2885f1ad066SMatthew G Knepley { 2895f1ad066SMatthew G Knepley PetscErrorCode ierr; 2905f1ad066SMatthew G Knepley 2915f1ad066SMatthew G Knepley PetscFunctionBegin; 2925f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 293d7f50e27SLisandro Dalcin if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 2945f1ad066SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 2955f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2965f1ad066SMatthew G Knepley } 2975f1ad066SMatthew G Knepley 298521d9a4cSLisandro Dalcin /*@C 2998f1509bcSBarry Smith DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM 3008f1509bcSBarry Smith 301d083f849SBarry Smith Logically Collective on dm 3028f1509bcSBarry Smith 3038f1509bcSBarry Smith Input Parameters: 3048f1509bcSBarry Smith + dm - the DM context 3058f1509bcSBarry Smith - ctype - the matrix type 3068f1509bcSBarry Smith 3078f1509bcSBarry Smith Options Database: 3088f1509bcSBarry Smith . -dm_is_coloring_type - global or local 3098f1509bcSBarry Smith 3108f1509bcSBarry Smith Level: intermediate 3118f1509bcSBarry Smith 3128f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), 3138f1509bcSBarry Smith DMGetISColoringType() 3148f1509bcSBarry Smith @*/ 3158f1509bcSBarry Smith PetscErrorCode DMSetISColoringType(DM dm,ISColoringType ctype) 3168f1509bcSBarry Smith { 3178f1509bcSBarry Smith PetscFunctionBegin; 3188f1509bcSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3198f1509bcSBarry Smith dm->coloringtype = ctype; 3208f1509bcSBarry Smith PetscFunctionReturn(0); 3218f1509bcSBarry Smith } 3228f1509bcSBarry Smith 3238f1509bcSBarry Smith /*@C 3248f1509bcSBarry Smith DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM 325521d9a4cSLisandro Dalcin 326d083f849SBarry Smith Logically Collective on dm 327521d9a4cSLisandro Dalcin 328521d9a4cSLisandro Dalcin Input Parameter: 3298f1509bcSBarry Smith . dm - the DM context 3308f1509bcSBarry Smith 3318f1509bcSBarry Smith Output Parameter: 3328f1509bcSBarry Smith . ctype - the matrix type 3338f1509bcSBarry Smith 3348f1509bcSBarry Smith Options Database: 3358f1509bcSBarry Smith . -dm_is_coloring_type - global or local 3368f1509bcSBarry Smith 3378f1509bcSBarry Smith Level: intermediate 3388f1509bcSBarry Smith 3398f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), 3408f1509bcSBarry Smith DMGetISColoringType() 3418f1509bcSBarry Smith @*/ 3428f1509bcSBarry Smith PetscErrorCode DMGetISColoringType(DM dm,ISColoringType *ctype) 3438f1509bcSBarry Smith { 3448f1509bcSBarry Smith PetscFunctionBegin; 3458f1509bcSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3468f1509bcSBarry Smith *ctype = dm->coloringtype; 3478f1509bcSBarry Smith PetscFunctionReturn(0); 3488f1509bcSBarry Smith } 3498f1509bcSBarry Smith 3508f1509bcSBarry Smith /*@C 3518f1509bcSBarry Smith DMSetMatType - Sets the type of matrix created with DMCreateMatrix() 3528f1509bcSBarry Smith 353d083f849SBarry Smith Logically Collective on dm 3548f1509bcSBarry Smith 3558f1509bcSBarry Smith Input Parameters: 356521d9a4cSLisandro Dalcin + dm - the DM context 357a2b5a043SBarry Smith - ctype - the matrix type 358521d9a4cSLisandro Dalcin 359521d9a4cSLisandro Dalcin Options Database: 360521d9a4cSLisandro Dalcin . -dm_mat_type ctype 361521d9a4cSLisandro Dalcin 362521d9a4cSLisandro Dalcin Level: intermediate 363521d9a4cSLisandro Dalcin 364a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType() 365521d9a4cSLisandro Dalcin @*/ 36619fd82e9SBarry Smith PetscErrorCode DMSetMatType(DM dm,MatType ctype) 367521d9a4cSLisandro Dalcin { 368521d9a4cSLisandro Dalcin PetscErrorCode ierr; 36988f0584fSBarry Smith 370521d9a4cSLisandro Dalcin PetscFunctionBegin; 371521d9a4cSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 372521d9a4cSLisandro Dalcin ierr = PetscFree(dm->mattype);CHKERRQ(ierr); 37319fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr); 374521d9a4cSLisandro Dalcin PetscFunctionReturn(0); 375521d9a4cSLisandro Dalcin } 376521d9a4cSLisandro Dalcin 377c0dedaeaSBarry Smith /*@C 378c0dedaeaSBarry Smith DMGetMatType - Gets the type of matrix created with DMCreateMatrix() 379c0dedaeaSBarry Smith 380d083f849SBarry Smith Logically Collective on dm 381c0dedaeaSBarry Smith 382c0dedaeaSBarry Smith Input Parameter: 383c0dedaeaSBarry Smith . dm - the DM context 384c0dedaeaSBarry Smith 385c0dedaeaSBarry Smith Output Parameter: 386c0dedaeaSBarry Smith . ctype - the matrix type 387c0dedaeaSBarry Smith 388c0dedaeaSBarry Smith Options Database: 389c0dedaeaSBarry Smith . -dm_mat_type ctype 390c0dedaeaSBarry Smith 391c0dedaeaSBarry Smith Level: intermediate 392c0dedaeaSBarry Smith 393a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType() 394c0dedaeaSBarry Smith @*/ 395c0dedaeaSBarry Smith PetscErrorCode DMGetMatType(DM dm,MatType *ctype) 396c0dedaeaSBarry Smith { 397c0dedaeaSBarry Smith PetscFunctionBegin; 398c0dedaeaSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 399c0dedaeaSBarry Smith *ctype = dm->mattype; 400c0dedaeaSBarry Smith PetscFunctionReturn(0); 401c0dedaeaSBarry Smith } 402c0dedaeaSBarry Smith 403c688c046SMatthew G Knepley /*@ 40434f98d34SBarry Smith MatGetDM - Gets the DM defining the data layout of the matrix 405c688c046SMatthew G Knepley 406c688c046SMatthew G Knepley Not collective 407c688c046SMatthew G Knepley 408c688c046SMatthew G Knepley Input Parameter: 409c688c046SMatthew G Knepley . A - The Mat 410c688c046SMatthew G Knepley 411c688c046SMatthew G Knepley Output Parameter: 412c688c046SMatthew G Knepley . dm - The DM 413c688c046SMatthew G Knepley 414c688c046SMatthew G Knepley Level: intermediate 415c688c046SMatthew G Knepley 4168f1509bcSBarry Smith Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with 4178f1509bcSBarry Smith the Mat through a PetscObjectCompose() operation 4188f1509bcSBarry Smith 419c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType() 420c688c046SMatthew G Knepley @*/ 421c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm) 422c688c046SMatthew G Knepley { 423c688c046SMatthew G Knepley PetscErrorCode ierr; 424c688c046SMatthew G Knepley 425c688c046SMatthew G Knepley PetscFunctionBegin; 426c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 427c688c046SMatthew G Knepley PetscValidPointer(dm,2); 428c688c046SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 429c688c046SMatthew G Knepley PetscFunctionReturn(0); 430c688c046SMatthew G Knepley } 431c688c046SMatthew G Knepley 432c688c046SMatthew G Knepley /*@ 433c688c046SMatthew G Knepley MatSetDM - Sets the DM defining the data layout of the matrix 434c688c046SMatthew G Knepley 435c688c046SMatthew G Knepley Not collective 436c688c046SMatthew G Knepley 437c688c046SMatthew G Knepley Input Parameters: 438c688c046SMatthew G Knepley + A - The Mat 439c688c046SMatthew G Knepley - dm - The DM 440c688c046SMatthew G Knepley 441c688c046SMatthew G Knepley Level: intermediate 442c688c046SMatthew G Knepley 4438f1509bcSBarry Smith Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with 4448f1509bcSBarry Smith the Mat through a PetscObjectCompose() operation 4458f1509bcSBarry Smith 446c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType() 447c688c046SMatthew G Knepley @*/ 448c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm) 449c688c046SMatthew G Knepley { 450c688c046SMatthew G Knepley PetscErrorCode ierr; 451c688c046SMatthew G Knepley 452c688c046SMatthew G Knepley PetscFunctionBegin; 453c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 4548865f1eaSKarl Rupp if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 455c688c046SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 456c688c046SMatthew G Knepley PetscFunctionReturn(0); 457c688c046SMatthew G Knepley } 458c688c046SMatthew G Knepley 4599a42bb27SBarry Smith /*@C 4609a42bb27SBarry Smith DMSetOptionsPrefix - Sets the prefix used for searching for all 4616757b960SDave May DM options in the database. 4629a42bb27SBarry Smith 463d083f849SBarry Smith Logically Collective on dm 4649a42bb27SBarry Smith 465d8d19677SJose E. Roman Input Parameters: 4668353ddbbSDave May + da - the DM context 4679a42bb27SBarry Smith - prefix - the prefix to prepend to all option names 4689a42bb27SBarry Smith 4699a42bb27SBarry Smith Notes: 4709a42bb27SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4719a42bb27SBarry Smith The first character of all runtime options is AUTOMATICALLY the hyphen. 4729a42bb27SBarry Smith 4739a42bb27SBarry Smith Level: advanced 4749a42bb27SBarry Smith 4759a42bb27SBarry Smith .seealso: DMSetFromOptions() 4769a42bb27SBarry Smith @*/ 4777087cfbeSBarry Smith PetscErrorCode DMSetOptionsPrefix(DM dm,const char prefix[]) 4789a42bb27SBarry Smith { 4799a42bb27SBarry Smith PetscErrorCode ierr; 4809a42bb27SBarry Smith 4819a42bb27SBarry Smith PetscFunctionBegin; 4829a42bb27SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4839a42bb27SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 484691be533SLawrence Mitchell if (dm->sf) { 485691be533SLawrence Mitchell ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr); 486691be533SLawrence Mitchell } 4871bb6d2a8SBarry Smith if (dm->sectionSF) { 4881bb6d2a8SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr); 489691be533SLawrence Mitchell } 4909a42bb27SBarry Smith PetscFunctionReturn(0); 4919a42bb27SBarry Smith } 4929a42bb27SBarry Smith 49331697293SDave May /*@C 49431697293SDave May DMAppendOptionsPrefix - Appends to the prefix used for searching for all 49531697293SDave May DM options in the database. 49631697293SDave May 497d083f849SBarry Smith Logically Collective on dm 49831697293SDave May 49931697293SDave May Input Parameters: 50031697293SDave May + dm - the DM context 50131697293SDave May - prefix - the prefix string to prepend to all DM option requests 50231697293SDave May 50331697293SDave May Notes: 50431697293SDave May A hyphen (-) must NOT be given at the beginning of the prefix name. 50531697293SDave May The first character of all runtime options is AUTOMATICALLY the hyphen. 50631697293SDave May 50731697293SDave May Level: advanced 50831697293SDave May 50931697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix() 51031697293SDave May @*/ 51131697293SDave May PetscErrorCode DMAppendOptionsPrefix(DM dm,const char prefix[]) 51231697293SDave May { 51331697293SDave May PetscErrorCode ierr; 51431697293SDave May 51531697293SDave May PetscFunctionBegin; 51631697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 51731697293SDave May ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 51831697293SDave May PetscFunctionReturn(0); 51931697293SDave May } 52031697293SDave May 52131697293SDave May /*@C 52231697293SDave May DMGetOptionsPrefix - Gets the prefix used for searching for all 52331697293SDave May DM options in the database. 52431697293SDave May 52531697293SDave May Not Collective 52631697293SDave May 52731697293SDave May Input Parameters: 52831697293SDave May . dm - the DM context 52931697293SDave May 53031697293SDave May Output Parameters: 53131697293SDave May . prefix - pointer to the prefix string used is returned 53231697293SDave May 53395452b02SPatrick Sanan Notes: 53495452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prefix' of 53531697293SDave May sufficient length to hold the prefix. 53631697293SDave May 53731697293SDave May Level: advanced 53831697293SDave May 53931697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix() 54031697293SDave May @*/ 54131697293SDave May PetscErrorCode DMGetOptionsPrefix(DM dm,const char *prefix[]) 54231697293SDave May { 54331697293SDave May PetscErrorCode ierr; 54431697293SDave May 54531697293SDave May PetscFunctionBegin; 54631697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 54731697293SDave May ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 54831697293SDave May PetscFunctionReturn(0); 54931697293SDave May } 55031697293SDave May 55188bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct) 55288bdff64SToby Isaac { 5536eb26441SStefano Zampini PetscInt refct = ((PetscObject) dm)->refct; 55488bdff64SToby Isaac PetscErrorCode ierr; 55588bdff64SToby Isaac 55688bdff64SToby Isaac PetscFunctionBegin; 557aab5bcd8SJed Brown *ncrefct = 0; 55888bdff64SToby Isaac if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) { 55988bdff64SToby Isaac refct--; 56088bdff64SToby Isaac if (recurseCoarse) { 56188bdff64SToby Isaac PetscInt coarseCount; 56288bdff64SToby Isaac 56388bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr); 56488bdff64SToby Isaac refct += coarseCount; 56588bdff64SToby Isaac } 56688bdff64SToby Isaac } 56788bdff64SToby Isaac if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) { 56888bdff64SToby Isaac refct--; 56988bdff64SToby Isaac if (recurseFine) { 57088bdff64SToby Isaac PetscInt fineCount; 57188bdff64SToby Isaac 57288bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr); 57388bdff64SToby Isaac refct += fineCount; 57488bdff64SToby Isaac } 57588bdff64SToby Isaac } 57688bdff64SToby Isaac *ncrefct = refct; 57788bdff64SToby Isaac PetscFunctionReturn(0); 57888bdff64SToby Isaac } 57988bdff64SToby Isaac 580f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm) 581354557abSToby Isaac { 5825d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 583354557abSToby Isaac PetscErrorCode ierr; 584354557abSToby Isaac 585354557abSToby Isaac PetscFunctionBegin; 586354557abSToby Isaac /* destroy the labels */ 587354557abSToby Isaac while (next) { 588354557abSToby Isaac DMLabelLink tmp = next->next; 589354557abSToby Isaac 5905d80c0bfSVaclav Hapla if (next->label == dm->depthLabel) dm->depthLabel = NULL; 591ba2698f1SMatthew G. Knepley if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL; 592354557abSToby Isaac ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 593354557abSToby Isaac ierr = PetscFree(next);CHKERRQ(ierr); 594354557abSToby Isaac next = tmp; 595354557abSToby Isaac } 5965d80c0bfSVaclav Hapla dm->labels = NULL; 597354557abSToby Isaac PetscFunctionReturn(0); 598354557abSToby Isaac } 599354557abSToby Isaac 6001fb7b255SJunchao Zhang /*@C 6018472ad0fSDave May DMDestroy - Destroys a vector packer or DM. 60247c6ae99SBarry Smith 603d083f849SBarry Smith Collective on dm 60447c6ae99SBarry Smith 60547c6ae99SBarry Smith Input Parameter: 60647c6ae99SBarry Smith . dm - the DM object to destroy 60747c6ae99SBarry Smith 60847c6ae99SBarry Smith Level: developer 60947c6ae99SBarry Smith 610e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 61147c6ae99SBarry Smith 61247c6ae99SBarry Smith @*/ 613fcfd50ebSBarry Smith PetscErrorCode DMDestroy(DM *dm) 61447c6ae99SBarry Smith { 6156eb26441SStefano Zampini PetscInt cnt; 616dfe15315SJed Brown DMNamedVecLink nlink,nnext; 61747c6ae99SBarry Smith PetscErrorCode ierr; 61847c6ae99SBarry Smith 61947c6ae99SBarry Smith PetscFunctionBegin; 6206bf464f9SBarry Smith if (!*dm) PetscFunctionReturn(0); 6216bf464f9SBarry Smith PetscValidHeaderSpecific((*dm),DM_CLASSID,1); 62287e657c6SBarry Smith 62388bdff64SToby Isaac /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */ 62488bdff64SToby Isaac ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr); 62588bdff64SToby Isaac --((PetscObject)(*dm))->refct; 626ea78f98cSLisandro Dalcin if (--cnt > 0) {*dm = NULL; PetscFunctionReturn(0);} 6276bf464f9SBarry Smith if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0); 6286bf464f9SBarry Smith ((PetscObject)(*dm))->refct = 0; 6296eb26441SStefano Zampini 6306eb26441SStefano Zampini ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr); 6316eb26441SStefano Zampini ierr = DMClearLocalVectors(*dm);CHKERRQ(ierr); 6326eb26441SStefano Zampini 633f490541aSPeter Brune nnext=(*dm)->namedglobal; 6340298fd71SBarry Smith (*dm)->namedglobal = NULL; 635f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */ 6362348bcf4SPeter Brune nnext = nlink->next; 6372348bcf4SPeter 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); 6382348bcf4SPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 6392348bcf4SPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 6402348bcf4SPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 6412348bcf4SPeter Brune } 642f490541aSPeter Brune nnext=(*dm)->namedlocal; 6430298fd71SBarry Smith (*dm)->namedlocal = NULL; 644f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */ 645f490541aSPeter Brune nnext = nlink->next; 646f490541aSPeter 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); 647f490541aSPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 648f490541aSPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 649f490541aSPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 650f490541aSPeter Brune } 6512348bcf4SPeter Brune 652b17ce1afSJed Brown /* Destroy the list of hooks */ 653c833c3b5SJed Brown { 654c833c3b5SJed Brown DMCoarsenHookLink link,next; 655b17ce1afSJed Brown for (link=(*dm)->coarsenhook; link; link=next) { 656b17ce1afSJed Brown next = link->next; 657b17ce1afSJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 658b17ce1afSJed Brown } 6590298fd71SBarry Smith (*dm)->coarsenhook = NULL; 660c833c3b5SJed Brown } 661c833c3b5SJed Brown { 662c833c3b5SJed Brown DMRefineHookLink link,next; 663c833c3b5SJed Brown for (link=(*dm)->refinehook; link; link=next) { 664c833c3b5SJed Brown next = link->next; 665c833c3b5SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 666c833c3b5SJed Brown } 6670298fd71SBarry Smith (*dm)->refinehook = NULL; 668c833c3b5SJed Brown } 669be081cd6SPeter Brune { 670be081cd6SPeter Brune DMSubDomainHookLink link,next; 671be081cd6SPeter Brune for (link=(*dm)->subdomainhook; link; link=next) { 672be081cd6SPeter Brune next = link->next; 673be081cd6SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 674be081cd6SPeter Brune } 6750298fd71SBarry Smith (*dm)->subdomainhook = NULL; 676be081cd6SPeter Brune } 677baf369e7SPeter Brune { 678baf369e7SPeter Brune DMGlobalToLocalHookLink link,next; 679baf369e7SPeter Brune for (link=(*dm)->gtolhook; link; link=next) { 680baf369e7SPeter Brune next = link->next; 681baf369e7SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 682baf369e7SPeter Brune } 6830298fd71SBarry Smith (*dm)->gtolhook = NULL; 684baf369e7SPeter Brune } 685d4d07f1eSToby Isaac { 686d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,next; 687d4d07f1eSToby Isaac for (link=(*dm)->ltoghook; link; link=next) { 688d4d07f1eSToby Isaac next = link->next; 689d4d07f1eSToby Isaac ierr = PetscFree(link);CHKERRQ(ierr); 690d4d07f1eSToby Isaac } 691d4d07f1eSToby Isaac (*dm)->ltoghook = NULL; 692d4d07f1eSToby Isaac } 693aa1993deSMatthew G Knepley /* Destroy the work arrays */ 694aa1993deSMatthew G Knepley { 695aa1993deSMatthew G Knepley DMWorkLink link,next; 696aa1993deSMatthew G Knepley if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out"); 697aa1993deSMatthew G Knepley for (link=(*dm)->workin; link; link=next) { 698aa1993deSMatthew G Knepley next = link->next; 699aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 700aa1993deSMatthew G Knepley ierr = PetscFree(link);CHKERRQ(ierr); 701aa1993deSMatthew G Knepley } 7020298fd71SBarry Smith (*dm)->workin = NULL; 703aa1993deSMatthew G Knepley } 704c58f1c22SToby Isaac /* destroy the labels */ 705f4cdcedcSVaclav Hapla ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr); 706f4cdcedcSVaclav Hapla /* destroy the fields */ 707e5e52638SMatthew G. Knepley ierr = DMClearFields(*dm);CHKERRQ(ierr); 708f4cdcedcSVaclav Hapla /* destroy the boundaries */ 709e6f8dbb6SToby Isaac { 710e6f8dbb6SToby Isaac DMBoundary next = (*dm)->boundary; 711e6f8dbb6SToby Isaac while (next) { 712e6f8dbb6SToby Isaac DMBoundary b = next; 713e6f8dbb6SToby Isaac 714e6f8dbb6SToby Isaac next = b->next; 715e6f8dbb6SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 716e6f8dbb6SToby Isaac } 717e6f8dbb6SToby Isaac } 718b17ce1afSJed Brown 71952536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr); 72052536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr); 72152536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr); 72252536dc3SBarry Smith 7231a266240SBarry Smith if ((*dm)->ctx && (*dm)->ctxdestroy) { 7241a266240SBarry Smith ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr); 7251a266240SBarry Smith } 72671cd77b2SBarry Smith ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr); 7276bf464f9SBarry Smith ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr); 7286bf464f9SBarry Smith ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr); 729073dac72SJed Brown ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr); 73088ed4aceSMatthew G Knepley 7311bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr); 7321bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr); 7338b1ab98fSJed Brown ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr); 734fba222abSToby Isaac ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr); 735fba222abSToby Isaac ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr); 73688ed4aceSMatthew G Knepley ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr); 7371bb6d2a8SBarry Smith ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr); 738736995cdSBlaise Bourdin if ((*dm)->useNatural) { 739736995cdSBlaise Bourdin if ((*dm)->sfNatural) { 7408e4ac7eaSMatthew G. Knepley ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr); 741736995cdSBlaise Bourdin } 742736995cdSBlaise Bourdin ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr); 743736995cdSBlaise Bourdin } 7449a2a23afSMatthew G. Knepley { 7459a2a23afSMatthew G. Knepley Vec *auxData; 7469a2a23afSMatthew G. Knepley PetscInt n, i, off = 0; 7479a2a23afSMatthew G. Knepley 7489a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetSize((*dm)->auxData, &n);CHKERRQ(ierr); 7499a2a23afSMatthew G. Knepley ierr = PetscMalloc1(n, &auxData);CHKERRQ(ierr); 7509a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetVals((*dm)->auxData, &off, auxData);CHKERRQ(ierr); 7519a2a23afSMatthew G. Knepley for (i = 0; i < n; ++i) {ierr = VecDestroy(&auxData[i]);CHKERRQ(ierr);} 7529a2a23afSMatthew G. Knepley ierr = PetscFree(auxData);CHKERRQ(ierr); 7539a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDestroy(&(*dm)->auxData);CHKERRQ(ierr); 7549a2a23afSMatthew G. Knepley } 75588bdff64SToby Isaac if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) { 75688bdff64SToby Isaac ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr); 75788bdff64SToby Isaac } 7586eb26441SStefano Zampini 759a8fb8f29SToby Isaac ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr); 76088bdff64SToby Isaac if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) { 76188bdff64SToby Isaac ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr); 76288bdff64SToby Isaac } 76388bdff64SToby Isaac ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr); 764f19dbd58SToby Isaac ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr); 7656636e97aSMatthew G Knepley ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr); 7666636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr); 7676636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr); 768412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->L);CHKERRQ(ierr); 769412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->maxCell);CHKERRQ(ierr); 770412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->bdtype);CHKERRQ(ierr); 771ca3d3a14SMatthew G. Knepley if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);} 772ca3d3a14SMatthew G. Knepley ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr); 773ca3d3a14SMatthew G. Knepley ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr); 7746636e97aSMatthew G Knepley 775e5e52638SMatthew G. Knepley ierr = DMClearDS(*dm);CHKERRQ(ierr); 77614f150ffSMatthew G. Knepley ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr); 777e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 778e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr); 779732e2eb9SMatthew G Knepley 780ed3c66a1SDave May if ((*dm)->ops->destroy) { 7816bf464f9SBarry Smith ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr); 782ed3c66a1SDave May } 783c0f0dcc3SMatthew G. Knepley ierr = DMMonitorCancel(*dm);CHKERRQ(ierr); 784f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 785f918ec44SMatthew G. Knepley ierr = CeedElemRestrictionDestroy(&(*dm)->ceedERestrict);CHKERRQ(ierr); 786f918ec44SMatthew G. Knepley ierr = CeedDestroy(&(*dm)->ceed);CHKERRQ(ierr); 787f918ec44SMatthew G. Knepley #endif 788435a35e8SMatthew G Knepley /* We do not destroy (*dm)->data here so that we can reference count backend objects */ 789732e2eb9SMatthew G Knepley ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr); 79047c6ae99SBarry Smith PetscFunctionReturn(0); 79147c6ae99SBarry Smith } 79247c6ae99SBarry Smith 793d7bf68aeSBarry Smith /*@ 794d7bf68aeSBarry Smith DMSetUp - sets up the data structures inside a DM object 795d7bf68aeSBarry Smith 796d083f849SBarry Smith Collective on dm 797d7bf68aeSBarry Smith 798d7bf68aeSBarry Smith Input Parameter: 799d7bf68aeSBarry Smith . dm - the DM object to setup 800d7bf68aeSBarry Smith 801d7bf68aeSBarry Smith Level: developer 802d7bf68aeSBarry Smith 803e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 804d7bf68aeSBarry Smith 805d7bf68aeSBarry Smith @*/ 8067087cfbeSBarry Smith PetscErrorCode DMSetUp(DM dm) 807d7bf68aeSBarry Smith { 808d7bf68aeSBarry Smith PetscErrorCode ierr; 809d7bf68aeSBarry Smith 810d7bf68aeSBarry Smith PetscFunctionBegin; 811171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8128387afaaSJed Brown if (dm->setupcalled) PetscFunctionReturn(0); 813d7bf68aeSBarry Smith if (dm->ops->setup) { 814d7bf68aeSBarry Smith ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr); 815d7bf68aeSBarry Smith } 8168387afaaSJed Brown dm->setupcalled = PETSC_TRUE; 817d7bf68aeSBarry Smith PetscFunctionReturn(0); 818d7bf68aeSBarry Smith } 819d7bf68aeSBarry Smith 820d7bf68aeSBarry Smith /*@ 821d7bf68aeSBarry Smith DMSetFromOptions - sets parameters in a DM from the options database 822d7bf68aeSBarry Smith 823d083f849SBarry Smith Collective on dm 824d7bf68aeSBarry Smith 825d7bf68aeSBarry Smith Input Parameter: 826d7bf68aeSBarry Smith . dm - the DM object to set options for 827d7bf68aeSBarry Smith 828732e2eb9SMatthew G Knepley Options Database: 8294164ae61SDominic Meiser + -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 8304164ae61SDominic Meiser . -dm_vec_type <type> - type of vector to create inside DM 8314164ae61SDominic Meiser . -dm_mat_type <type> - type of matrix to create inside DM 832a4ea9b21SRichard Tran Mills . -dm_is_coloring_type - <global or local> 833a4ea9b21SRichard Tran Mills - -dm_bind_below <n> - bind (force execution on CPU) for Vec and Mat objects with local size (number of vector entries or matrix rows) below n; currently only supported for DMDA 834732e2eb9SMatthew G Knepley 8359318fe57SMatthew G. Knepley DMPLEX Specific creation options 8369318fe57SMatthew G. Knepley + -dm_plex_filename <str> - File containing a mesh 8379318fe57SMatthew G. Knepley . -dm_plex_boundary_filename <str> - File containing a mesh boundary 838cd7e8a5eSksagiyam . -dm_plex_name <str> - Name of the mesh in the file 8399318fe57SMatthew G. Knepley . -dm_plex_shape <shape> - The domain shape, such as DM_SHAPE_BOX, DM_SHAPE_SPHERE, etc. 8409318fe57SMatthew G. Knepley . -dm_plex_cell <ct> - Cell shape 8419318fe57SMatthew G. Knepley . -dm_plex_reference_cell_domain <bool> - Use a reference cell domain 8429318fe57SMatthew G. Knepley . -dm_plex_dim <dim> - Set the topological dimension 8439318fe57SMatthew G. Knepley . -dm_plex_simplex <bool> - PETSC_TRUE for simplex elements, PETSC_FALSE for tensor elements 8449318fe57SMatthew G. Knepley . -dm_plex_interpolate <bool> - PETSC_TRUE turns on topological interpolation (creating edges and faces) 8459318fe57SMatthew G. Knepley . -dm_plex_scale <sc> - Scale factor for mesh coordinates 8469318fe57SMatthew G. Knepley . -dm_plex_box_faces <m,n,p> - Number of faces along each dimension 8479318fe57SMatthew G. Knepley . -dm_plex_box_lower <x,y,z> - Specify lower-left-bottom coordinates for the box 8489318fe57SMatthew G. Knepley . -dm_plex_box_upper <x,y,z> - Specify upper-right-top coordinates for the box 8499318fe57SMatthew G. Knepley . -dm_plex_box_bd <bx,by,bz> - Specify the DMBoundaryType for each direction 8509318fe57SMatthew G. Knepley . -dm_plex_sphere_radius <r> - The sphere radius 8519318fe57SMatthew G. Knepley . -dm_plex_ball_radius <r> - Radius of the ball 8529318fe57SMatthew G. Knepley . -dm_plex_cylinder_bd <bz> - Boundary type in the z direction 8539318fe57SMatthew G. Knepley . -dm_plex_cylinder_num_wedges <n> - Number of wedges around the cylinder 854bdf63967SMatthew G. Knepley . -dm_plex_reorder <order> - Reorder the mesh using the specified algorithm 8559318fe57SMatthew G. Knepley . -dm_refine_pre <n> - The number of refinements before distribution 8569318fe57SMatthew G. Knepley . -dm_refine_uniform_pre <bool> - Flag for uniform refinement before distribution 8579318fe57SMatthew G. Knepley . -dm_refine_volume_limit_pre <v> - The maximum cell volume after refinement before distribution 8589318fe57SMatthew G. Knepley . -dm_refine <n> - The number of refinements after distribution 859bdf63967SMatthew G. Knepley . -dm_extrude <l> - Activate extrusion and specify the number of layers to extrude 860d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thickness <t> - The total thickness of extruded layers 861d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_use_tensor <bool> - Use tensor cells when extruding 862d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_symmetric <bool> - Extrude layers symmetrically about the surface 863d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_normal <n0,...,nd> - Specify the extrusion direction 864d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thicknesses <t0,...,tl> - Specify thickness of each layer 865909dfd52SMatthew G. Knepley . -dm_plex_create_fv_ghost_cells - Flag to create finite volume ghost cells on the boundary 866909dfd52SMatthew G. Knepley . -dm_plex_fv_ghost_cells_label <name> - Label name for ghost cells boundary 8679318fe57SMatthew G. Knepley . -dm_distribute <bool> - Flag to redistribute a mesh among processes 8689318fe57SMatthew G. Knepley . -dm_distribute_overlap <n> - The size of the overlap halo 8699318fe57SMatthew G. Knepley . -dm_plex_adj_cone <bool> - Set adjacency direction 8709318fe57SMatthew G. Knepley - -dm_plex_adj_closure <bool> - Set adjacency size 8719318fe57SMatthew G. Knepley 872384a6580SVaclav Hapla DMPLEX Specific Checks 873384a6580SVaclav Hapla + -dm_plex_check_symmetry - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry() 874384a6580SVaclav Hapla . -dm_plex_check_skeleton - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton() 875384a6580SVaclav Hapla . -dm_plex_check_faces - Check that the faces of each cell give a vertex order this is consistent with what we expect from the cell type - DMPlexCheckFaces() 876384a6580SVaclav Hapla . -dm_plex_check_geometry - Check that cells have positive volume - DMPlexCheckGeometry() 877384a6580SVaclav Hapla . -dm_plex_check_pointsf - Check some necessary conditions for PointSF - DMPlexCheckPointSF() 878384a6580SVaclav Hapla . -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones() 879384a6580SVaclav Hapla - -dm_plex_check_all - Perform all the checks above 880d7bf68aeSBarry Smith 88195eb5ee5SVaclav Hapla Level: intermediate 88295eb5ee5SVaclav Hapla 88395eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), 88495eb5ee5SVaclav Hapla DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones() 885d7bf68aeSBarry Smith 886d7bf68aeSBarry Smith @*/ 8877087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm) 888d7bf68aeSBarry Smith { 8897781c08eSBarry Smith char typeName[256]; 890ca266f36SBarry Smith PetscBool flg; 891d7bf68aeSBarry Smith PetscErrorCode ierr; 892d7bf68aeSBarry Smith 893d7bf68aeSBarry Smith PetscFunctionBegin; 894171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 89549be4549SMatthew G. Knepley dm->setfromoptionscalled = PETSC_TRUE; 89649be4549SMatthew G. Knepley if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);} 8971bb6d2a8SBarry Smith if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);} 8983194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr); 8990298fd71SBarry 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); 900a264d7a6SBarry Smith ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr); 901f9ba7244SBarry Smith if (flg) { 902f9ba7244SBarry Smith ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr); 903f9ba7244SBarry Smith } 904a264d7a6SBarry 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); 905073dac72SJed Brown if (flg) { 906521d9a4cSLisandro Dalcin ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr); 907073dac72SJed Brown } 9088f1509bcSBarry Smith ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr); 909a4ea9b21SRichard Tran Mills ierr = PetscOptionsInt("-dm_bind_below","Set the size threshold (in entries) below which the Vec is bound to the CPU","VecBindToCPU",dm->bind_below,&dm->bind_below,&flg);CHKERRQ(ierr); 910f9ba7244SBarry Smith if (dm->ops->setfromoptions) { 911e55864a3SBarry Smith ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr); 912f9ba7244SBarry Smith } 913f9ba7244SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 9140633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr); 91582fcb398SMatthew G Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 916d7bf68aeSBarry Smith PetscFunctionReturn(0); 917d7bf68aeSBarry Smith } 918d7bf68aeSBarry Smith 919fc9bc008SSatish Balay /*@C 920fe2efc57SMark DMViewFromOptions - View from Options 921fe2efc57SMark 922fe2efc57SMark Collective on DM 923fe2efc57SMark 924fe2efc57SMark Input Parameters: 925fe2efc57SMark + dm - the DM object 926736c3998SJose E. Roman . obj - Optional object 927736c3998SJose E. Roman - name - command line option 928fe2efc57SMark 929fe2efc57SMark Level: intermediate 930fe2efc57SMark .seealso: DM, DMView, PetscObjectViewFromOptions(), DMCreate() 931fe2efc57SMark @*/ 932fe2efc57SMark PetscErrorCode DMViewFromOptions(DM dm,PetscObject obj,const char name[]) 933fe2efc57SMark { 934fe2efc57SMark PetscErrorCode ierr; 935fe2efc57SMark 936fe2efc57SMark PetscFunctionBegin; 937fe2efc57SMark PetscValidHeaderSpecific(dm,DM_CLASSID,1); 938fe2efc57SMark ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr); 939fe2efc57SMark PetscFunctionReturn(0); 940fe2efc57SMark } 941fe2efc57SMark 942fe2efc57SMark /*@C 943224748a4SBarry Smith DMView - Views a DM 94447c6ae99SBarry Smith 945d083f849SBarry Smith Collective on dm 94647c6ae99SBarry Smith 947d8d19677SJose E. Roman Input Parameters: 94847c6ae99SBarry Smith + dm - the DM object to view 94947c6ae99SBarry Smith - v - the viewer 95047c6ae99SBarry Smith 951cd7e8a5eSksagiyam Notes: 952cd7e8a5eSksagiyam Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex 953cd7e8a5eSksagiyam meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName() 954cd7e8a5eSksagiyam before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object. 955cd7e8a5eSksagiyam 956224748a4SBarry Smith Level: beginner 95747c6ae99SBarry Smith 958cd7e8a5eSksagiyam .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMLoad(), PetscObjectSetName() 95947c6ae99SBarry Smith 96047c6ae99SBarry Smith @*/ 9617087cfbeSBarry Smith PetscErrorCode DMView(DM dm,PetscViewer v) 96247c6ae99SBarry Smith { 96347c6ae99SBarry Smith PetscErrorCode ierr; 96432c0f0efSBarry Smith PetscBool isbinary; 96576a8abe0SBarry Smith PetscMPIInt size; 96676a8abe0SBarry Smith PetscViewerFormat format; 96747c6ae99SBarry Smith 96847c6ae99SBarry Smith PetscFunctionBegin; 969171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9703014e516SBarry Smith if (!v) { 971ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr); 9723014e516SBarry Smith } 973b1b135c8SBarry Smith PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2); 97474903a4fSStefano Zampini /* Ideally, we would like to have this test on. 97574903a4fSStefano Zampini However, it currently breaks socket viz via GLVis. 97674903a4fSStefano Zampini During DMView(parallel_mesh,glvis_viewer), each 97774903a4fSStefano Zampini process opens a sequential ASCII socket to visualize 97874903a4fSStefano Zampini the local mesh, and PetscObjectView(dm,local_socket) 97974903a4fSStefano Zampini is internally called inside VecView_GLVis, incurring 98074903a4fSStefano Zampini in an error here */ 98174903a4fSStefano Zampini /* PetscCheckSameComm(dm,1,v,2); */ 9828bfd1ab9SVaclav Hapla ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr); 983b1b135c8SBarry Smith 98476a8abe0SBarry Smith ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr); 985ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRMPI(ierr); 98676a8abe0SBarry Smith if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0); 98798c3331eSBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr); 98832c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 98932c0f0efSBarry Smith if (isbinary) { 99055849f57SBarry Smith PetscInt classid = DM_FILE_CLASSID; 99132c0f0efSBarry Smith char type[256]; 99232c0f0efSBarry Smith 993f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr); 99432c0f0efSBarry Smith ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr); 995f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr); 99632c0f0efSBarry Smith } 9970c010503SBarry Smith if (dm->ops->view) { 9980c010503SBarry Smith ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr); 99947c6ae99SBarry Smith } 100047c6ae99SBarry Smith PetscFunctionReturn(0); 100147c6ae99SBarry Smith } 100247c6ae99SBarry Smith 100347c6ae99SBarry Smith /*@ 10048472ad0fSDave May DMCreateGlobalVector - Creates a global vector from a DM object 100547c6ae99SBarry Smith 1006d083f849SBarry Smith Collective on dm 100747c6ae99SBarry Smith 100847c6ae99SBarry Smith Input Parameter: 100947c6ae99SBarry Smith . dm - the DM object 101047c6ae99SBarry Smith 101147c6ae99SBarry Smith Output Parameter: 101247c6ae99SBarry Smith . vec - the global vector 101347c6ae99SBarry Smith 1014073dac72SJed Brown Level: beginner 101547c6ae99SBarry Smith 1016ec075b9fSPatrick Sanan .seealso DMCreateLocalVector(), DMGetGlobalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 101747c6ae99SBarry Smith 101847c6ae99SBarry Smith @*/ 10197087cfbeSBarry Smith PetscErrorCode DMCreateGlobalVector(DM dm,Vec *vec) 102047c6ae99SBarry Smith { 102147c6ae99SBarry Smith PetscErrorCode ierr; 102247c6ae99SBarry Smith 102347c6ae99SBarry Smith PetscFunctionBegin; 1024171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1025b9d85ea2SLisandro Dalcin PetscValidPointer(vec,2); 1026b9d85ea2SLisandro Dalcin if (!dm->ops->createglobalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name); 102747c6ae99SBarry Smith ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr); 102876bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1029c6b011d8SStefano Zampini DM vdm; 1030c6b011d8SStefano Zampini 1031c6b011d8SStefano Zampini ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr); 1032c6b011d8SStefano Zampini if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name); 1033c6b011d8SStefano Zampini } 103447c6ae99SBarry Smith PetscFunctionReturn(0); 103547c6ae99SBarry Smith } 103647c6ae99SBarry Smith 103747c6ae99SBarry Smith /*@ 10388472ad0fSDave May DMCreateLocalVector - Creates a local vector from a DM object 103947c6ae99SBarry Smith 104047c6ae99SBarry Smith Not Collective 104147c6ae99SBarry Smith 104247c6ae99SBarry Smith Input Parameter: 104347c6ae99SBarry Smith . dm - the DM object 104447c6ae99SBarry Smith 104547c6ae99SBarry Smith Output Parameter: 104647c6ae99SBarry Smith . vec - the local vector 104747c6ae99SBarry Smith 1048073dac72SJed Brown Level: beginner 104947c6ae99SBarry Smith 1050ec075b9fSPatrick Sanan .seealso DMCreateGlobalVector(), DMGetLocalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 105147c6ae99SBarry Smith 105247c6ae99SBarry Smith @*/ 10537087cfbeSBarry Smith PetscErrorCode DMCreateLocalVector(DM dm,Vec *vec) 105447c6ae99SBarry Smith { 105547c6ae99SBarry Smith PetscErrorCode ierr; 105647c6ae99SBarry Smith 105747c6ae99SBarry Smith PetscFunctionBegin; 1058171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1059b9d85ea2SLisandro Dalcin PetscValidPointer(vec,2); 1060b9d85ea2SLisandro Dalcin if (!dm->ops->createlocalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name); 106147c6ae99SBarry Smith ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr); 106276bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1063c6b011d8SStefano Zampini DM vdm; 1064c6b011d8SStefano Zampini 1065c6b011d8SStefano Zampini ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr); 1066c6b011d8SStefano Zampini if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name); 1067c6b011d8SStefano Zampini } 106847c6ae99SBarry Smith PetscFunctionReturn(0); 106947c6ae99SBarry Smith } 107047c6ae99SBarry Smith 10711411c6eeSJed Brown /*@ 10721411c6eeSJed Brown DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM. 10731411c6eeSJed Brown 1074d083f849SBarry Smith Collective on dm 10751411c6eeSJed Brown 10761411c6eeSJed Brown Input Parameter: 10771411c6eeSJed Brown . dm - the DM that provides the mapping 10781411c6eeSJed Brown 10791411c6eeSJed Brown Output Parameter: 10801411c6eeSJed Brown . ltog - the mapping 10811411c6eeSJed Brown 10821411c6eeSJed Brown Level: intermediate 10831411c6eeSJed Brown 10841411c6eeSJed Brown Notes: 10851411c6eeSJed Brown This mapping can then be used by VecSetLocalToGlobalMapping() or 10861411c6eeSJed Brown MatSetLocalToGlobalMapping(). 10871411c6eeSJed Brown 1088fc31e74dSBarry Smith .seealso: DMCreateLocalVector() 10891411c6eeSJed Brown @*/ 10907087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog) 10911411c6eeSJed Brown { 10920be3e97aSMatthew G. Knepley PetscInt bs = -1, bsLocal[2], bsMinMax[2]; 10931411c6eeSJed Brown PetscErrorCode ierr; 10941411c6eeSJed Brown 10951411c6eeSJed Brown PetscFunctionBegin; 10961411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 10971411c6eeSJed Brown PetscValidPointer(ltog,2); 10981411c6eeSJed Brown if (!dm->ltogmap) { 109937d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 110037d0c07bSMatthew G Knepley 110192fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 110237d0c07bSMatthew G Knepley if (section) { 1103a974ec88SMatthew G. Knepley const PetscInt *cdofs; 110437d0c07bSMatthew G Knepley PetscInt *ltog; 1105ccf3bd66SMatthew G. Knepley PetscInt pStart, pEnd, n, p, k, l; 110637d0c07bSMatthew G Knepley 1107e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 110837d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 1109ccf3bd66SMatthew G. Knepley ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr); 1110ccf3bd66SMatthew G. Knepley ierr = PetscMalloc1(n, <og);CHKERRQ(ierr); /* We want the local+overlap size */ 111137d0c07bSMatthew G Knepley for (p = pStart, l = 0; p < pEnd; ++p) { 1112a974ec88SMatthew G. Knepley PetscInt bdof, cdof, dof, off, c, cind = 0; 111337d0c07bSMatthew G Knepley 111437d0c07bSMatthew G Knepley /* Should probably use constrained dofs */ 111537d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr); 1116a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr); 1117a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr); 111837d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr); 11191a7dc684SMatthew G. Knepley /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */ 11201a7dc684SMatthew G. Knepley bdof = cdof && (dof-cdof) ? 1 : dof; 11211a7dc684SMatthew G. Knepley if (dof) { 1122b190aa46SMatthew G. Knepley if (bs < 0) {bs = bdof;} 1123b190aa46SMatthew G. Knepley else if (bs != bdof) {bs = 1;} 11241a7dc684SMatthew G. Knepley } 112537d0c07bSMatthew G Knepley for (c = 0; c < dof; ++c, ++l) { 1126a974ec88SMatthew G. Knepley if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c; 1127a974ec88SMatthew G. Knepley else ltog[l] = (off < 0 ? -(off+1) : off) + c; 112837d0c07bSMatthew G Knepley } 112937d0c07bSMatthew G Knepley } 1130bff27382SMatthew G. Knepley /* Must have same blocksize on all procs (some might have no points) */ 11310be3e97aSMatthew G. Knepley bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs; 11320be3e97aSMatthew G. Knepley ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr); 11330be3e97aSMatthew G. Knepley if (bsMinMax[0] != bsMinMax[1]) {bs = 1;} 11340be3e97aSMatthew G. Knepley else {bs = bsMinMax[0];} 11357591dbb2SMatthew G. Knepley bs = bs < 0 ? 1 : bs; 11367591dbb2SMatthew G. Knepley /* Must reduce indices by blocksize */ 1137ccf3bd66SMatthew G. Knepley if (bs > 1) { 1138ccf3bd66SMatthew G. Knepley for (l = 0, k = 0; l < n; l += bs, ++k) ltog[k] = ltog[l]/bs; 1139ccf3bd66SMatthew G. Knepley n /= bs; 1140ccf3bd66SMatthew G. Knepley } 1141ccf3bd66SMatthew G. Knepley ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr); 11423bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr); 114337d0c07bSMatthew G Knepley } else { 1144b9d85ea2SLisandro Dalcin if (!dm->ops->getlocaltoglobalmapping) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name); 1145184d77edSJed Brown ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr); 11461411c6eeSJed Brown } 114737d0c07bSMatthew G Knepley } 11481411c6eeSJed Brown *ltog = dm->ltogmap; 11491411c6eeSJed Brown PetscFunctionReturn(0); 11501411c6eeSJed Brown } 11511411c6eeSJed Brown 11521411c6eeSJed Brown /*@ 11531411c6eeSJed Brown DMGetBlockSize - Gets the inherent block size associated with a DM 11541411c6eeSJed Brown 11551411c6eeSJed Brown Not Collective 11561411c6eeSJed Brown 11571411c6eeSJed Brown Input Parameter: 11581411c6eeSJed Brown . dm - the DM with block structure 11591411c6eeSJed Brown 11601411c6eeSJed Brown Output Parameter: 11611411c6eeSJed Brown . bs - the block size, 1 implies no exploitable block structure 11621411c6eeSJed Brown 11631411c6eeSJed Brown Level: intermediate 11641411c6eeSJed Brown 1165fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping() 11661411c6eeSJed Brown @*/ 11677087cfbeSBarry Smith PetscErrorCode DMGetBlockSize(DM dm,PetscInt *bs) 11681411c6eeSJed Brown { 11691411c6eeSJed Brown PetscFunctionBegin; 11701411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1171534a8f05SLisandro Dalcin PetscValidIntPointer(bs,2); 11721411c6eeSJed 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"); 11731411c6eeSJed Brown *bs = dm->bs; 11741411c6eeSJed Brown PetscFunctionReturn(0); 11751411c6eeSJed Brown } 11761411c6eeSJed Brown 117748eeb7c8SBarry Smith /*@C 11788472ad0fSDave May DMCreateInterpolation - Gets interpolation matrix between two DM objects 117947c6ae99SBarry Smith 1180a5bc1bf3SBarry Smith Collective on dmc 118147c6ae99SBarry Smith 1182d8d19677SJose E. Roman Input Parameters: 1183a5bc1bf3SBarry Smith + dmc - the DM object 1184a5bc1bf3SBarry Smith - dmf - the second, finer DM object 118547c6ae99SBarry Smith 1186d8d19677SJose E. Roman Output Parameters: 118747c6ae99SBarry Smith + mat - the interpolation 118847c6ae99SBarry Smith - vec - the scaling (optional) 118947c6ae99SBarry Smith 119047c6ae99SBarry Smith Level: developer 119147c6ae99SBarry Smith 119295452b02SPatrick Sanan Notes: 119395452b02SPatrick Sanan For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 119485afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 1195d52bd9f3SBarry Smith 11961f588964SMatthew G Knepley For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors 1197d52bd9f3SBarry Smith EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic. 119885afcc9aSBarry Smith 11992ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale() 120047c6ae99SBarry Smith 120147c6ae99SBarry Smith @*/ 1202a5bc1bf3SBarry Smith PetscErrorCode DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec) 120347c6ae99SBarry Smith { 120447c6ae99SBarry Smith PetscErrorCode ierr; 120547c6ae99SBarry Smith 120647c6ae99SBarry Smith PetscFunctionBegin; 1207a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 1208a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 1209c7d20fa0SStefano Zampini PetscValidPointer(mat,3); 1210a5bc1bf3SBarry Smith if (!dmc->ops->createinterpolation) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name); 1211a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr); 1212a5bc1bf3SBarry Smith ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr); 1213a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr); 121447c6ae99SBarry Smith PetscFunctionReturn(0); 121547c6ae99SBarry Smith } 121647c6ae99SBarry Smith 12173ad4599aSBarry Smith /*@ 1218d3e313eaSPatrick Sanan DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction. 12192ed6491fSPatrick Sanan 12202ed6491fSPatrick Sanan Input Parameters: 12212ed6491fSPatrick Sanan + dac - DM that defines a coarse mesh 12222ed6491fSPatrick Sanan . daf - DM that defines a fine mesh 12232ed6491fSPatrick Sanan - mat - the restriction (or interpolation operator) from fine to coarse 12242ed6491fSPatrick Sanan 12252ed6491fSPatrick Sanan Output Parameter: 12262ed6491fSPatrick Sanan . scale - the scaled vector 12272ed6491fSPatrick Sanan 12282ed6491fSPatrick Sanan Level: developer 12292ed6491fSPatrick Sanan 1230e9c74fd6SRichard Tran Mills Developer Notes: 1231e9c74fd6SRichard Tran Mills If the fine-scale DMDA has the -dm_bind_below option set to true, then DMCreateInterpolationScale() calls MatSetBindingPropagates() 1232e9c74fd6SRichard Tran Mills on the restriction/interpolation operator to set the bindingpropagates flag to true. 1233e9c74fd6SRichard Tran Mills 12342ed6491fSPatrick Sanan .seealso: DMCreateInterpolation() 12352ed6491fSPatrick Sanan 12362ed6491fSPatrick Sanan @*/ 12372ed6491fSPatrick Sanan PetscErrorCode DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale) 12382ed6491fSPatrick Sanan { 12392ed6491fSPatrick Sanan PetscErrorCode ierr; 12402ed6491fSPatrick Sanan Vec fine; 12412ed6491fSPatrick Sanan PetscScalar one = 1.0; 12429704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA) 1243e9c74fd6SRichard Tran Mills PetscBool bindingpropagates,isbound; 12449704db99SRichard Tran Mills #endif 12452ed6491fSPatrick Sanan 12462ed6491fSPatrick Sanan PetscFunctionBegin; 12472ed6491fSPatrick Sanan ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr); 12482ed6491fSPatrick Sanan ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr); 12492ed6491fSPatrick Sanan ierr = VecSet(fine,one);CHKERRQ(ierr); 12509704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA) 12519704db99SRichard Tran Mills /* If the 'fine' Vec is bound to the CPU, it makes sense to bind 'mat' as well. 12529704db99SRichard Tran Mills * Note that we only do this for the CUDA case, right now, but if we add support for MatMultTranspose() via ViennaCL, 12539704db99SRichard Tran Mills * we'll need to do it for that case, too.*/ 1254e9c74fd6SRichard Tran Mills ierr = VecGetBindingPropagates(fine,&bindingpropagates);CHKERRQ(ierr); 1255e9c74fd6SRichard Tran Mills if (bindingpropagates) { 1256b1538989SRichard Tran Mills ierr = MatSetBindingPropagates(mat,PETSC_TRUE);CHKERRQ(ierr); 1257e9c74fd6SRichard Tran Mills ierr = VecBoundToCPU(fine,&isbound);CHKERRQ(ierr); 1258e9c74fd6SRichard Tran Mills ierr = MatBindToCPU(mat,isbound);CHKERRQ(ierr); 125983aa49f4SRichard Tran Mills } 12609704db99SRichard Tran Mills #endif 12612ed6491fSPatrick Sanan ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr); 12622ed6491fSPatrick Sanan ierr = VecDestroy(&fine);CHKERRQ(ierr); 12632ed6491fSPatrick Sanan ierr = VecReciprocal(*scale);CHKERRQ(ierr); 12642ed6491fSPatrick Sanan PetscFunctionReturn(0); 12652ed6491fSPatrick Sanan } 12662ed6491fSPatrick Sanan 12672ed6491fSPatrick Sanan /*@ 12683ad4599aSBarry Smith DMCreateRestriction - Gets restriction matrix between two DM objects 12693ad4599aSBarry Smith 1270a5bc1bf3SBarry Smith Collective on dmc 12713ad4599aSBarry Smith 1272d8d19677SJose E. Roman Input Parameters: 1273a5bc1bf3SBarry Smith + dmc - the DM object 1274a5bc1bf3SBarry Smith - dmf - the second, finer DM object 12753ad4599aSBarry Smith 12763ad4599aSBarry Smith Output Parameter: 12773ad4599aSBarry Smith . mat - the restriction 12783ad4599aSBarry Smith 12793ad4599aSBarry Smith Level: developer 12803ad4599aSBarry Smith 128195452b02SPatrick Sanan Notes: 128295452b02SPatrick Sanan For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 12833ad4599aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 12843ad4599aSBarry Smith 12853ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation() 12863ad4599aSBarry Smith 12873ad4599aSBarry Smith @*/ 1288a5bc1bf3SBarry Smith PetscErrorCode DMCreateRestriction(DM dmc,DM dmf,Mat *mat) 12893ad4599aSBarry Smith { 12903ad4599aSBarry Smith PetscErrorCode ierr; 12913ad4599aSBarry Smith 12923ad4599aSBarry Smith PetscFunctionBegin; 1293a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 1294a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 12955a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1296a5bc1bf3SBarry Smith if (!dmc->ops->createrestriction) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name); 1297a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr); 1298a5bc1bf3SBarry Smith ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr); 1299a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr); 13003ad4599aSBarry Smith PetscFunctionReturn(0); 13013ad4599aSBarry Smith } 13023ad4599aSBarry Smith 130347c6ae99SBarry Smith /*@ 13048472ad0fSDave May DMCreateInjection - Gets injection matrix between two DM objects 130547c6ae99SBarry Smith 1306a5bc1bf3SBarry Smith Collective on dac 130747c6ae99SBarry Smith 1308d8d19677SJose E. Roman Input Parameters: 1309a5bc1bf3SBarry Smith + dac - the DM object 1310a5bc1bf3SBarry Smith - daf - the second, finer DM object 131147c6ae99SBarry Smith 131247c6ae99SBarry Smith Output Parameter: 13136dbf9973SLawrence Mitchell . mat - the injection 131447c6ae99SBarry Smith 131547c6ae99SBarry Smith Level: developer 131647c6ae99SBarry Smith 131795452b02SPatrick Sanan Notes: 131895452b02SPatrick Sanan For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by 131985afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection. 132085afcc9aSBarry Smith 1321e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation() 132247c6ae99SBarry Smith 132347c6ae99SBarry Smith @*/ 1324a5bc1bf3SBarry Smith PetscErrorCode DMCreateInjection(DM dac,DM daf,Mat *mat) 132547c6ae99SBarry Smith { 132647c6ae99SBarry Smith PetscErrorCode ierr; 132747c6ae99SBarry Smith 132847c6ae99SBarry Smith PetscFunctionBegin; 1329a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dac,DM_CLASSID,1); 1330a5bc1bf3SBarry Smith PetscValidHeaderSpecific(daf,DM_CLASSID,2); 13315a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1332a5bc1bf3SBarry Smith if (!dac->ops->createinjection) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name); 1333a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr); 1334a5bc1bf3SBarry Smith ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr); 1335a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr); 133647c6ae99SBarry Smith PetscFunctionReturn(0); 133747c6ae99SBarry Smith } 133847c6ae99SBarry Smith 1339b412c318SBarry Smith /*@ 1340bd041c0cSMatthew G. Knepley DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j 1341bd041c0cSMatthew G. Knepley 1342a5bc1bf3SBarry Smith Collective on dac 1343bd041c0cSMatthew G. Knepley 1344d8d19677SJose E. Roman Input Parameters: 1345a5bc1bf3SBarry Smith + dac - the DM object 1346a5bc1bf3SBarry Smith - daf - the second, finer DM object 1347bd041c0cSMatthew G. Knepley 1348bd041c0cSMatthew G. Knepley Output Parameter: 1349bd041c0cSMatthew G. Knepley . mat - the interpolation 1350bd041c0cSMatthew G. Knepley 1351bd041c0cSMatthew G. Knepley Level: developer 1352bd041c0cSMatthew G. Knepley 1353bd041c0cSMatthew G. Knepley .seealso DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection() 1354bd041c0cSMatthew G. Knepley @*/ 1355a5bc1bf3SBarry Smith PetscErrorCode DMCreateMassMatrix(DM dac, DM daf, Mat *mat) 1356bd041c0cSMatthew G. Knepley { 1357bd041c0cSMatthew G. Knepley PetscErrorCode ierr; 1358bd041c0cSMatthew G. Knepley 1359bd041c0cSMatthew G. Knepley PetscFunctionBegin; 1360a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dac, DM_CLASSID, 1); 1361a5bc1bf3SBarry Smith PetscValidHeaderSpecific(daf, DM_CLASSID, 2); 13625a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1363a5bc1bf3SBarry Smith if (!dac->ops->createmassmatrix) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dac)->type_name); 1364a5bc1bf3SBarry Smith ierr = (*dac->ops->createmassmatrix)(dac, daf, mat);CHKERRQ(ierr); 1365bd041c0cSMatthew G. Knepley PetscFunctionReturn(0); 1366bd041c0cSMatthew G. Knepley } 1367bd041c0cSMatthew G. Knepley 1368bd041c0cSMatthew G. Knepley /*@ 1369b412c318SBarry Smith DMCreateColoring - Gets coloring for a DM 137047c6ae99SBarry Smith 1371d083f849SBarry Smith Collective on dm 137247c6ae99SBarry Smith 1373d8d19677SJose E. Roman Input Parameters: 137447c6ae99SBarry Smith + dm - the DM object 13755bdb020cSBarry Smith - ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL 137647c6ae99SBarry Smith 137747c6ae99SBarry Smith Output Parameter: 137847c6ae99SBarry Smith . coloring - the coloring 137947c6ae99SBarry Smith 1380ec5066bdSBarry Smith Notes: 1381ec5066bdSBarry Smith Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the MatColoring object or from the mesh from which the 1382ec5066bdSBarry Smith matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors). 1383ec5066bdSBarry Smith 1384ec5066bdSBarry Smith This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate() 1385ec5066bdSBarry Smith 138647c6ae99SBarry Smith Level: developer 138747c6ae99SBarry Smith 1388ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate() 138947c6ae99SBarry Smith 1390aab9d709SJed Brown @*/ 1391b412c318SBarry Smith PetscErrorCode DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring) 139247c6ae99SBarry Smith { 139347c6ae99SBarry Smith PetscErrorCode ierr; 139447c6ae99SBarry Smith 139547c6ae99SBarry Smith PetscFunctionBegin; 1396171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 13975a84ad33SLisandro Dalcin PetscValidPointer(coloring,3); 1398b9d85ea2SLisandro Dalcin if (!dm->ops->getcoloring) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name); 1399b412c318SBarry Smith ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr); 140047c6ae99SBarry Smith PetscFunctionReturn(0); 140147c6ae99SBarry Smith } 140247c6ae99SBarry Smith 1403b412c318SBarry Smith /*@ 14048472ad0fSDave May DMCreateMatrix - Gets empty Jacobian for a DM 140547c6ae99SBarry Smith 1406d083f849SBarry Smith Collective on dm 140747c6ae99SBarry Smith 140847c6ae99SBarry Smith Input Parameter: 1409b412c318SBarry Smith . dm - the DM object 141047c6ae99SBarry Smith 141147c6ae99SBarry Smith Output Parameter: 141247c6ae99SBarry Smith . mat - the empty Jacobian 141347c6ae99SBarry Smith 1414073dac72SJed Brown Level: beginner 141547c6ae99SBarry Smith 1416f27dd7c6SMatthew G. Knepley Options Database Keys: 1417f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 1418f27dd7c6SMatthew G. Knepley 141995452b02SPatrick Sanan Notes: 142095452b02SPatrick Sanan This properly preallocates the number of nonzeros in the sparse matrix so you 142194013140SBarry Smith do not need to do it yourself. 142294013140SBarry Smith 142394013140SBarry Smith By default it also sets the nonzero structure and puts in the zero entries. To prevent setting 14247889ec69SBarry Smith the nonzero pattern call DMSetMatrixPreallocateOnly() 142594013140SBarry Smith 142694013140SBarry 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 142794013140SBarry Smith internally by PETSc. 142894013140SBarry Smith 142994013140SBarry Smith For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires 1430aa219208SBarry Smith the indices for the global numbering for DMDAs which is complicated. 143194013140SBarry Smith 1432b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType() 143347c6ae99SBarry Smith 1434aab9d709SJed Brown @*/ 1435b412c318SBarry Smith PetscErrorCode DMCreateMatrix(DM dm,Mat *mat) 143647c6ae99SBarry Smith { 143747c6ae99SBarry Smith PetscErrorCode ierr; 143847c6ae99SBarry Smith 143947c6ae99SBarry Smith PetscFunctionBegin; 1440171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1441064a246eSJacob Faibussowitsch PetscValidPointer(mat,2); 1442b9d85ea2SLisandro Dalcin if (!dm->ops->creatematrix) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name); 14435a84ad33SLisandro Dalcin ierr = MatInitializePackage();CHKERRQ(ierr); 1444fdc842d1SBarry Smith ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 1445b412c318SBarry Smith ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr); 144676bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1447c6b011d8SStefano Zampini DM mdm; 1448c6b011d8SStefano Zampini 1449c6b011d8SStefano Zampini ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr); 1450c6b011d8SStefano Zampini if (!mdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix\n",((PetscObject)dm)->type_name); 1451c6b011d8SStefano Zampini } 1452e571a35bSMatthew G. Knepley /* Handle nullspace and near nullspace */ 1453e5e52638SMatthew G. Knepley if (dm->Nf) { 1454e571a35bSMatthew G. Knepley MatNullSpace nullSpace; 1455649ef022SMatthew Knepley PetscInt Nf, f; 1456e571a35bSMatthew G. Knepley 1457e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 1458649ef022SMatthew Knepley for (f = 0; f < Nf; ++f) { 1459649ef022SMatthew Knepley if (dm->nullspaceConstructors[f]) { 1460649ef022SMatthew Knepley ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr); 1461e571a35bSMatthew G. Knepley ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1462e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1463649ef022SMatthew Knepley break; 1464e571a35bSMatthew G. Knepley } 1465649ef022SMatthew Knepley } 1466649ef022SMatthew Knepley for (f = 0; f < Nf; ++f) { 1467649ef022SMatthew Knepley if (dm->nearnullspaceConstructors[f]) { 1468649ef022SMatthew Knepley ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr); 1469e571a35bSMatthew G. Knepley ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1470e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1471e571a35bSMatthew G. Knepley } 1472e571a35bSMatthew G. Knepley } 1473e571a35bSMatthew G. Knepley } 1474fdc842d1SBarry Smith ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 147547c6ae99SBarry Smith PetscFunctionReturn(0); 147647c6ae99SBarry Smith } 147747c6ae99SBarry Smith 1478732e2eb9SMatthew G Knepley /*@ 1479950540a4SJed Brown DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly 1480732e2eb9SMatthew G Knepley preallocated but the nonzero structure and zero values will not be set. 1481732e2eb9SMatthew G Knepley 1482d083f849SBarry Smith Logically Collective on dm 1483732e2eb9SMatthew G Knepley 1484d8d19677SJose E. Roman Input Parameters: 1485732e2eb9SMatthew G Knepley + dm - the DM 1486732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation 1487732e2eb9SMatthew G Knepley 1488732e2eb9SMatthew G Knepley Level: developer 1489f27dd7c6SMatthew G. Knepley 1490f27dd7c6SMatthew G. Knepley Options Database Keys: 1491f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 1492f27dd7c6SMatthew G. Knepley 1493b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly() 1494732e2eb9SMatthew G Knepley @*/ 1495732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only) 1496732e2eb9SMatthew G Knepley { 1497732e2eb9SMatthew G Knepley PetscFunctionBegin; 1498732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1499732e2eb9SMatthew G Knepley dm->prealloc_only = only; 1500732e2eb9SMatthew G Knepley PetscFunctionReturn(0); 1501732e2eb9SMatthew G Knepley } 1502732e2eb9SMatthew G Knepley 1503b06ff27eSHong Zhang /*@ 1504b06ff27eSHong Zhang DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created 1505b06ff27eSHong Zhang but the array for values will not be allocated. 1506b06ff27eSHong Zhang 1507d083f849SBarry Smith Logically Collective on dm 1508b06ff27eSHong Zhang 1509d8d19677SJose E. Roman Input Parameters: 1510b06ff27eSHong Zhang + dm - the DM 1511b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture 1512b06ff27eSHong Zhang 1513b06ff27eSHong Zhang Level: developer 1514b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly() 1515b06ff27eSHong Zhang @*/ 1516b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only) 1517b06ff27eSHong Zhang { 1518b06ff27eSHong Zhang PetscFunctionBegin; 1519b06ff27eSHong Zhang PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1520b06ff27eSHong Zhang dm->structure_only = only; 1521b06ff27eSHong Zhang PetscFunctionReturn(0); 1522b06ff27eSHong Zhang } 1523b06ff27eSHong Zhang 1524a89ea682SMatthew G Knepley /*@C 1525aa1993deSMatthew G Knepley DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1526a89ea682SMatthew G Knepley 1527a89ea682SMatthew G Knepley Not Collective 1528a89ea682SMatthew G Knepley 1529a89ea682SMatthew G Knepley Input Parameters: 1530a89ea682SMatthew G Knepley + dm - the DM object 1531a5b23f4aSJose E. Roman . count - The minimum size 153269291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT) 1533a89ea682SMatthew G Knepley 1534a89ea682SMatthew G Knepley Output Parameter: 1535a89ea682SMatthew G Knepley . array - the work array 1536a89ea682SMatthew G Knepley 1537a89ea682SMatthew G Knepley Level: developer 1538a89ea682SMatthew G Knepley 1539a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate() 1540a89ea682SMatthew G Knepley @*/ 154169291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1542a89ea682SMatthew G Knepley { 1543a89ea682SMatthew G Knepley PetscErrorCode ierr; 1544aa1993deSMatthew G Knepley DMWorkLink link; 154569291d52SBarry Smith PetscMPIInt dsize; 1546a89ea682SMatthew G Knepley 1547a89ea682SMatthew G Knepley PetscFunctionBegin; 1548a89ea682SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1549aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1550aa1993deSMatthew G Knepley if (dm->workin) { 1551aa1993deSMatthew G Knepley link = dm->workin; 1552aa1993deSMatthew G Knepley dm->workin = dm->workin->next; 1553aa1993deSMatthew G Knepley } else { 1554b00a9115SJed Brown ierr = PetscNewLog(dm,&link);CHKERRQ(ierr); 1555a89ea682SMatthew G Knepley } 1556ffc4695bSBarry Smith ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr); 15575056fcd2SBarry Smith if (((size_t)dsize*count) > link->bytes) { 1558aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 1559854ce69bSBarry Smith ierr = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr); 1560854ce69bSBarry Smith link->bytes = dsize*count; 1561aa1993deSMatthew G Knepley } 1562aa1993deSMatthew G Knepley link->next = dm->workout; 1563aa1993deSMatthew G Knepley dm->workout = link; 156400d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND) 156500d952a4SJed Brown VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count); 156600d952a4SJed Brown VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count); 156700d952a4SJed Brown #endif 1568aa1993deSMatthew G Knepley *(void**)mem = link->mem; 1569a89ea682SMatthew G Knepley PetscFunctionReturn(0); 1570a89ea682SMatthew G Knepley } 1571a89ea682SMatthew G Knepley 1572aa1993deSMatthew G Knepley /*@C 1573aa1993deSMatthew G Knepley DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1574aa1993deSMatthew G Knepley 1575aa1993deSMatthew G Knepley Not Collective 1576aa1993deSMatthew G Knepley 1577aa1993deSMatthew G Knepley Input Parameters: 1578aa1993deSMatthew G Knepley + dm - the DM object 1579a5b23f4aSJose E. Roman . count - The minimum size 158069291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT 1581aa1993deSMatthew G Knepley 1582aa1993deSMatthew G Knepley Output Parameter: 1583aa1993deSMatthew G Knepley . array - the work array 1584aa1993deSMatthew G Knepley 1585aa1993deSMatthew G Knepley Level: developer 1586aa1993deSMatthew G Knepley 158795452b02SPatrick Sanan Developer Notes: 158895452b02SPatrick Sanan count and dtype are ignored, they are only needed for DMGetWorkArray() 1589aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate() 1590aa1993deSMatthew G Knepley @*/ 159169291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1592aa1993deSMatthew G Knepley { 1593aa1993deSMatthew G Knepley DMWorkLink *p,link; 1594aa1993deSMatthew G Knepley 1595aa1993deSMatthew G Knepley PetscFunctionBegin; 1596aa1993deSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1597aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1598aa1993deSMatthew G Knepley for (p=&dm->workout; (link=*p); p=&link->next) { 1599aa1993deSMatthew G Knepley if (link->mem == *(void**)mem) { 1600aa1993deSMatthew G Knepley *p = link->next; 1601aa1993deSMatthew G Knepley link->next = dm->workin; 1602aa1993deSMatthew G Knepley dm->workin = link; 16030298fd71SBarry Smith *(void**)mem = NULL; 1604aa1993deSMatthew G Knepley PetscFunctionReturn(0); 1605aa1993deSMatthew G Knepley } 1606aa1993deSMatthew G Knepley } 1607aa1993deSMatthew G Knepley SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out"); 1608aa1993deSMatthew G Knepley } 1609e7c4fc90SDmitry Karpeev 16108cda7954SMatthew G. Knepley /*@C 16118cda7954SMatthew G. Knepley DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field 16128cda7954SMatthew G. Knepley 16138cda7954SMatthew G. Knepley Logically collective on DM 16148cda7954SMatthew G. Knepley 16158cda7954SMatthew G. Knepley Input Parameters: 16168cda7954SMatthew G. Knepley + dm - The DM 16178cda7954SMatthew G. Knepley . field - The field number for the nullspace 16188cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace 16198cda7954SMatthew G. Knepley 16208cda7954SMatthew G. Knepley Notes: 16218cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 16228cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 16238cda7954SMatthew G. Knepley $ dm - The present DM 16248cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 16258cda7954SMatthew G. Knepley $ field - The field number in dm 16268cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 16278cda7954SMatthew G. Knepley 16288cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16298cda7954SMatthew G. Knepley 16308cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 16318cda7954SMatthew G. Knepley */ 16328cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1633435a35e8SMatthew G Knepley { 1634435a35e8SMatthew G Knepley PetscFunctionBegin; 1635435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 163682f516ccSBarry Smith if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1637435a35e8SMatthew G Knepley dm->nullspaceConstructors[field] = nullsp; 1638435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1639435a35e8SMatthew G Knepley } 1640435a35e8SMatthew G Knepley 16418cda7954SMatthew G. Knepley /*@C 16428cda7954SMatthew G. Knepley DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL 16438cda7954SMatthew G. Knepley 16448cda7954SMatthew G. Knepley Not collective 16458cda7954SMatthew G. Knepley 16468cda7954SMatthew G. Knepley Input Parameters: 16478cda7954SMatthew G. Knepley + dm - The DM 16488cda7954SMatthew G. Knepley - field - The field number for the nullspace 16498cda7954SMatthew G. Knepley 16508cda7954SMatthew G. Knepley Output Parameter: 16518cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace 16528cda7954SMatthew G. Knepley 16538cda7954SMatthew G. Knepley Notes: 16548cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 16558cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 16568cda7954SMatthew G. Knepley $ dm - The present DM 16578cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 16588cda7954SMatthew G. Knepley $ field - The field number in dm 16598cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 16608cda7954SMatthew G. Knepley 16618cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16628cda7954SMatthew G. Knepley 16638cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 16648cda7954SMatthew G. Knepley */ 16658cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 16660a50eb56SMatthew G. Knepley { 16670a50eb56SMatthew G. Knepley PetscFunctionBegin; 16680a50eb56SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1669f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 16700a50eb56SMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 16710a50eb56SMatthew G. Knepley *nullsp = dm->nullspaceConstructors[field]; 16720a50eb56SMatthew G. Knepley PetscFunctionReturn(0); 16730a50eb56SMatthew G. Knepley } 16740a50eb56SMatthew G. Knepley 16758cda7954SMatthew G. Knepley /*@C 16768cda7954SMatthew G. Knepley DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field 16778cda7954SMatthew G. Knepley 16788cda7954SMatthew G. Knepley Logically collective on DM 16798cda7954SMatthew G. Knepley 16808cda7954SMatthew G. Knepley Input Parameters: 16818cda7954SMatthew G. Knepley + dm - The DM 16828cda7954SMatthew G. Knepley . field - The field number for the nullspace 16838cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace 16848cda7954SMatthew G. Knepley 16858cda7954SMatthew G. Knepley Notes: 16868cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 16878cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 16888cda7954SMatthew G. Knepley $ dm - The present DM 16898cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 16908cda7954SMatthew G. Knepley $ field - The field number in dm 16918cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 16928cda7954SMatthew G. Knepley 16938cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16948cda7954SMatthew G. Knepley 16958cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 16968cda7954SMatthew G. Knepley */ 16978cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1698f9d4088aSMatthew G. Knepley { 1699f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1700f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1701f9d4088aSMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1702f9d4088aSMatthew G. Knepley dm->nearnullspaceConstructors[field] = nullsp; 1703f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1704f9d4088aSMatthew G. Knepley } 1705f9d4088aSMatthew G. Knepley 17068cda7954SMatthew G. Knepley /*@C 17078cda7954SMatthew G. Knepley DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL 17088cda7954SMatthew G. Knepley 17098cda7954SMatthew G. Knepley Not collective 17108cda7954SMatthew G. Knepley 17118cda7954SMatthew G. Knepley Input Parameters: 17128cda7954SMatthew G. Knepley + dm - The DM 17138cda7954SMatthew G. Knepley - field - The field number for the nullspace 17148cda7954SMatthew G. Knepley 17158cda7954SMatthew G. Knepley Output Parameter: 17168cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace 17178cda7954SMatthew G. Knepley 17188cda7954SMatthew G. Knepley Notes: 17198cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 17208cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 17218cda7954SMatthew G. Knepley $ dm - The present DM 17228cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 17238cda7954SMatthew G. Knepley $ field - The field number in dm 17248cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 17258cda7954SMatthew G. Knepley 17268cda7954SMatthew G. Knepley This function is currently not available from Fortran. 17278cda7954SMatthew G. Knepley 17288cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 17298cda7954SMatthew G. Knepley */ 17308cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1731f9d4088aSMatthew G. Knepley { 1732f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1733f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1734f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 1735f9d4088aSMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1736f9d4088aSMatthew G. Knepley *nullsp = dm->nearnullspaceConstructors[field]; 1737f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1738f9d4088aSMatthew G. Knepley } 1739f9d4088aSMatthew G. Knepley 17404f3b5142SJed Brown /*@C 17414d343eeaSMatthew G Knepley DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field 17424d343eeaSMatthew G Knepley 17434d343eeaSMatthew G Knepley Not collective 17444d343eeaSMatthew G Knepley 17454d343eeaSMatthew G Knepley Input Parameter: 17464d343eeaSMatthew G Knepley . dm - the DM object 17474d343eeaSMatthew G Knepley 17484d343eeaSMatthew G Knepley Output Parameters: 17490298fd71SBarry Smith + numFields - The number of fields (or NULL if not requested) 17500298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested) 17510298fd71SBarry Smith - fields - The global indices for each field (or NULL if not requested) 17524d343eeaSMatthew G Knepley 17534d343eeaSMatthew G Knepley Level: intermediate 17544d343eeaSMatthew G Knepley 175521c9b008SJed Brown Notes: 175621c9b008SJed Brown The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 175721c9b008SJed Brown PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with 175821c9b008SJed Brown PetscFree(). 175921c9b008SJed Brown 17604d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 17614d343eeaSMatthew G Knepley @*/ 176237d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields) 17634d343eeaSMatthew G Knepley { 176437d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 17654d343eeaSMatthew G Knepley PetscErrorCode ierr; 17664d343eeaSMatthew G Knepley 17674d343eeaSMatthew G Knepley PetscFunctionBegin; 17684d343eeaSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 176969ca1f37SDmitry Karpeev if (numFields) { 1770534a8f05SLisandro Dalcin PetscValidIntPointer(numFields,2); 177169ca1f37SDmitry Karpeev *numFields = 0; 177269ca1f37SDmitry Karpeev } 177337d0c07bSMatthew G Knepley if (fieldNames) { 177437d0c07bSMatthew G Knepley PetscValidPointer(fieldNames,3); 17750298fd71SBarry Smith *fieldNames = NULL; 177669ca1f37SDmitry Karpeev } 177769ca1f37SDmitry Karpeev if (fields) { 177869ca1f37SDmitry Karpeev PetscValidPointer(fields,4); 17790298fd71SBarry Smith *fields = NULL; 178069ca1f37SDmitry Karpeev } 178192fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 178237d0c07bSMatthew G Knepley if (section) { 17833a544194SStefano Zampini PetscInt *fieldSizes, *fieldNc, **fieldIndices; 178437d0c07bSMatthew G Knepley PetscInt nF, f, pStart, pEnd, p; 178537d0c07bSMatthew G Knepley 1786e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 178737d0c07bSMatthew G Knepley ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr); 17883a544194SStefano Zampini ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr); 178937d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr); 179037d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 179137d0c07bSMatthew G Knepley fieldSizes[f] = 0; 17923a544194SStefano Zampini ierr = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr); 179337d0c07bSMatthew G Knepley } 179437d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 179537d0c07bSMatthew G Knepley PetscInt gdof; 179637d0c07bSMatthew G Knepley 179737d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 179837d0c07bSMatthew G Knepley if (gdof > 0) { 179937d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 18003a544194SStefano Zampini PetscInt fdof, fcdof, fpdof; 180137d0c07bSMatthew G Knepley 180237d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 180337d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 18043a544194SStefano Zampini fpdof = fdof-fcdof; 18053a544194SStefano Zampini if (fpdof && fpdof != fieldNc[f]) { 18063a544194SStefano Zampini /* Layout does not admit a pointwise block size */ 18073a544194SStefano Zampini fieldNc[f] = 1; 18083a544194SStefano Zampini } 18093a544194SStefano Zampini fieldSizes[f] += fpdof; 181037d0c07bSMatthew G Knepley } 181137d0c07bSMatthew G Knepley } 181237d0c07bSMatthew G Knepley } 181337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 1814785e854fSJed Brown ierr = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr); 181537d0c07bSMatthew G Knepley fieldSizes[f] = 0; 181637d0c07bSMatthew G Knepley } 181737d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 181837d0c07bSMatthew G Knepley PetscInt gdof, goff; 181937d0c07bSMatthew G Knepley 182037d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 182137d0c07bSMatthew G Knepley if (gdof > 0) { 182237d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr); 182337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 182437d0c07bSMatthew G Knepley PetscInt fdof, fcdof, fc; 182537d0c07bSMatthew G Knepley 182637d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 182737d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 182837d0c07bSMatthew G Knepley for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) { 182937d0c07bSMatthew G Knepley fieldIndices[f][fieldSizes[f]] = goff++; 183037d0c07bSMatthew G Knepley } 183137d0c07bSMatthew G Knepley } 183237d0c07bSMatthew G Knepley } 183337d0c07bSMatthew G Knepley } 18348865f1eaSKarl Rupp if (numFields) *numFields = nF; 183537d0c07bSMatthew G Knepley if (fieldNames) { 1836785e854fSJed Brown ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr); 183737d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 183837d0c07bSMatthew G Knepley const char *fieldName; 183937d0c07bSMatthew G Knepley 184037d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 184137d0c07bSMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr); 184237d0c07bSMatthew G Knepley } 184337d0c07bSMatthew G Knepley } 184437d0c07bSMatthew G Knepley if (fields) { 1845785e854fSJed Brown ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr); 184637d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 18473a544194SStefano Zampini PetscInt bs, in[2], out[2]; 18483a544194SStefano Zampini 184982f516ccSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr); 18503a544194SStefano Zampini in[0] = -fieldNc[f]; 18513a544194SStefano Zampini in[1] = fieldNc[f]; 1852820f2d46SBarry Smith ierr = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 18533a544194SStefano Zampini bs = (-out[0] == out[1]) ? out[1] : 1; 18543a544194SStefano Zampini ierr = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr); 185537d0c07bSMatthew G Knepley } 185637d0c07bSMatthew G Knepley } 18573a544194SStefano Zampini ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr); 18588865f1eaSKarl Rupp } else if (dm->ops->createfieldis) { 18598865f1eaSKarl Rupp ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr); 186069ca1f37SDmitry Karpeev } 18614d343eeaSMatthew G Knepley PetscFunctionReturn(0); 18624d343eeaSMatthew G Knepley } 18634d343eeaSMatthew G Knepley 186416621825SDmitry Karpeev /*@C 186516621825SDmitry Karpeev DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems 186616621825SDmitry Karpeev corresponding to different fields: each IS contains the global indices of the dofs of the 186716621825SDmitry Karpeev corresponding field. The optional list of DMs define the DM for each subproblem. 1868e7c4fc90SDmitry Karpeev Generalizes DMCreateFieldIS(). 1869e7c4fc90SDmitry Karpeev 1870e7c4fc90SDmitry Karpeev Not collective 1871e7c4fc90SDmitry Karpeev 1872e7c4fc90SDmitry Karpeev Input Parameter: 1873e7c4fc90SDmitry Karpeev . dm - the DM object 1874e7c4fc90SDmitry Karpeev 1875e7c4fc90SDmitry Karpeev Output Parameters: 18760298fd71SBarry Smith + len - The number of subproblems in the field decomposition (or NULL if not requested) 18770298fd71SBarry Smith . namelist - The name for each field (or NULL if not requested) 18780298fd71SBarry Smith . islist - The global indices for each field (or NULL if not requested) 18790298fd71SBarry Smith - dmlist - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 1880e7c4fc90SDmitry Karpeev 1881e7c4fc90SDmitry Karpeev Level: intermediate 1882e7c4fc90SDmitry Karpeev 1883e7c4fc90SDmitry Karpeev Notes: 1884e7c4fc90SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 1885e7c4fc90SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 1886e7c4fc90SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 1887e7c4fc90SDmitry Karpeev 1888e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1889e7c4fc90SDmitry Karpeev @*/ 189016621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist) 1891e7c4fc90SDmitry Karpeev { 1892e7c4fc90SDmitry Karpeev PetscErrorCode ierr; 1893e7c4fc90SDmitry Karpeev 1894e7c4fc90SDmitry Karpeev PetscFunctionBegin; 1895e7c4fc90SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 18968865f1eaSKarl Rupp if (len) { 1897534a8f05SLisandro Dalcin PetscValidIntPointer(len,2); 18988865f1eaSKarl Rupp *len = 0; 18998865f1eaSKarl Rupp } 19008865f1eaSKarl Rupp if (namelist) { 19018865f1eaSKarl Rupp PetscValidPointer(namelist,3); 1902ea78f98cSLisandro Dalcin *namelist = NULL; 19038865f1eaSKarl Rupp } 19048865f1eaSKarl Rupp if (islist) { 19058865f1eaSKarl Rupp PetscValidPointer(islist,4); 1906ea78f98cSLisandro Dalcin *islist = NULL; 19078865f1eaSKarl Rupp } 19088865f1eaSKarl Rupp if (dmlist) { 19098865f1eaSKarl Rupp PetscValidPointer(dmlist,5); 1910ea78f98cSLisandro Dalcin *dmlist = NULL; 19118865f1eaSKarl Rupp } 1912f3f0edfdSDmitry Karpeev /* 1913f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 1914f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 1915f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 1916f3f0edfdSDmitry Karpeev */ 1917ce94432eSBarry Smith if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 191816621825SDmitry Karpeev if (!dm->ops->createfielddecomposition) { 1919435a35e8SMatthew G Knepley PetscSection section; 1920435a35e8SMatthew G Knepley PetscInt numFields, f; 1921435a35e8SMatthew G Knepley 192292fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 1923435a35e8SMatthew G Knepley if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);} 1924435a35e8SMatthew G Knepley if (section && numFields && dm->ops->createsubdm) { 1925f25d98f1SMatthew G. Knepley if (len) *len = numFields; 192603dc3394SMatthew G. Knepley if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);} 192703dc3394SMatthew G. Knepley if (islist) {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);} 192803dc3394SMatthew G. Knepley if (dmlist) {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);} 1929435a35e8SMatthew G Knepley for (f = 0; f < numFields; ++f) { 1930435a35e8SMatthew G Knepley const char *fieldName; 1931435a35e8SMatthew G Knepley 193203dc3394SMatthew G. Knepley ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr); 193303dc3394SMatthew G. Knepley if (namelist) { 1934435a35e8SMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 1935435a35e8SMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr); 1936435a35e8SMatthew G Knepley } 193703dc3394SMatthew G. Knepley } 1938435a35e8SMatthew G Knepley } else { 193969ca1f37SDmitry Karpeev ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr); 1940e7c4fc90SDmitry Karpeev /* By default there are no DMs associated with subproblems. */ 19410298fd71SBarry Smith if (dmlist) *dmlist = NULL; 1942e7c4fc90SDmitry Karpeev } 19438865f1eaSKarl Rupp } else { 194416621825SDmitry Karpeev ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr); 194516621825SDmitry Karpeev } 194616621825SDmitry Karpeev PetscFunctionReturn(0); 194716621825SDmitry Karpeev } 194816621825SDmitry Karpeev 1949564cec59SMatthew G. Knepley /*@ 1950435a35e8SMatthew G Knepley DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in. 1951435a35e8SMatthew G Knepley The fields are defined by DMCreateFieldIS(). 1952435a35e8SMatthew G Knepley 1953435a35e8SMatthew G Knepley Not collective 1954435a35e8SMatthew G Knepley 1955435a35e8SMatthew G Knepley Input Parameters: 19562adcc780SMatthew G. Knepley + dm - The DM object 19572adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem 19582adcc780SMatthew G. Knepley - fields - The field numbers of the selected fields 1959435a35e8SMatthew G Knepley 1960435a35e8SMatthew G Knepley Output Parameters: 19612adcc780SMatthew G. Knepley + is - The global indices for the subproblem 19622adcc780SMatthew G. Knepley - subdm - The DM for the subproblem 1963435a35e8SMatthew G Knepley 19645d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 19655d3b26e6SMatthew G. Knepley 1966435a35e8SMatthew G Knepley Level: intermediate 1967435a35e8SMatthew G Knepley 19685d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1969435a35e8SMatthew G Knepley @*/ 197037bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm) 1971435a35e8SMatthew G Knepley { 1972435a35e8SMatthew G Knepley PetscErrorCode ierr; 1973435a35e8SMatthew G Knepley 1974435a35e8SMatthew G Knepley PetscFunctionBegin; 1975435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1976435a35e8SMatthew G Knepley PetscValidPointer(fields,3); 19778865f1eaSKarl Rupp if (is) PetscValidPointer(is,4); 19788865f1eaSKarl Rupp if (subdm) PetscValidPointer(subdm,5); 1979b9d85ea2SLisandro Dalcin if (!dm->ops->createsubdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name); 1980435a35e8SMatthew G Knepley ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr); 1981435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1982435a35e8SMatthew G Knepley } 1983435a35e8SMatthew G Knepley 19842adcc780SMatthew G. Knepley /*@C 19852adcc780SMatthew G. Knepley DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in. 19862adcc780SMatthew G. Knepley 19872adcc780SMatthew G. Knepley Not collective 19882adcc780SMatthew G. Knepley 1989d8d19677SJose E. Roman Input Parameters: 19902adcc780SMatthew G. Knepley + dms - The DM objects 19912adcc780SMatthew G. Knepley - len - The number of DMs 19922adcc780SMatthew G. Knepley 19932adcc780SMatthew G. Knepley Output Parameters: 1994a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL 19952adcc780SMatthew G. Knepley - superdm - The DM for the superproblem 19962adcc780SMatthew G. Knepley 19975d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 19985d3b26e6SMatthew G. Knepley 19992adcc780SMatthew G. Knepley Level: intermediate 20002adcc780SMatthew G. Knepley 20015d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 20022adcc780SMatthew G. Knepley @*/ 20032adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm) 20042adcc780SMatthew G. Knepley { 20052adcc780SMatthew G. Knepley PetscInt i; 20062adcc780SMatthew G. Knepley PetscErrorCode ierr; 20072adcc780SMatthew G. Knepley 20082adcc780SMatthew G. Knepley PetscFunctionBegin; 20092adcc780SMatthew G. Knepley PetscValidPointer(dms,1); 20102adcc780SMatthew G. Knepley for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);} 20112adcc780SMatthew G. Knepley if (is) PetscValidPointer(is,3); 2012a42bd24dSMatthew G. Knepley PetscValidPointer(superdm,4); 20132adcc780SMatthew G. Knepley if (len < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len); 20142adcc780SMatthew G. Knepley if (len) { 2015b9d85ea2SLisandro Dalcin DM dm = dms[0]; 2016b9d85ea2SLisandro Dalcin if (!dm->ops->createsuperdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name); 2017b9d85ea2SLisandro Dalcin ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr); 20182adcc780SMatthew G. Knepley } 20192adcc780SMatthew G. Knepley PetscFunctionReturn(0); 20202adcc780SMatthew G. Knepley } 20212adcc780SMatthew G. Knepley 202216621825SDmitry Karpeev /*@C 20238d4ac253SDmitry Karpeev DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems 20248d4ac253SDmitry Karpeev corresponding to restrictions to pairs nested subdomains: each IS contains the global 20258d4ac253SDmitry Karpeev indices of the dofs of the corresponding subdomains. The inner subdomains conceptually 20268d4ac253SDmitry Karpeev define a nonoverlapping covering, while outer subdomains can overlap. 20278d4ac253SDmitry Karpeev The optional list of DMs define the DM for each subproblem. 202816621825SDmitry Karpeev 202916621825SDmitry Karpeev Not collective 203016621825SDmitry Karpeev 203116621825SDmitry Karpeev Input Parameter: 203216621825SDmitry Karpeev . dm - the DM object 203316621825SDmitry Karpeev 203416621825SDmitry Karpeev Output Parameters: 20350298fd71SBarry Smith + len - The number of subproblems in the domain decomposition (or NULL if not requested) 20360298fd71SBarry Smith . namelist - The name for each subdomain (or NULL if not requested) 20370298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested) 20380298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested) 20390298fd71SBarry Smith - dmlist - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 204016621825SDmitry Karpeev 204116621825SDmitry Karpeev Level: intermediate 204216621825SDmitry Karpeev 204316621825SDmitry Karpeev Notes: 204416621825SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 204516621825SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 204616621825SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 204716621825SDmitry Karpeev 2048245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition() 204916621825SDmitry Karpeev @*/ 20508d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist) 205116621825SDmitry Karpeev { 205216621825SDmitry Karpeev PetscErrorCode ierr; 2053be081cd6SPeter Brune DMSubDomainHookLink link; 2054be081cd6SPeter Brune PetscInt i,l; 205516621825SDmitry Karpeev 205616621825SDmitry Karpeev PetscFunctionBegin; 205716621825SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 205814a18fd3SPeter Brune if (len) {PetscValidPointer(len,2); *len = 0;} 20590298fd71SBarry Smith if (namelist) {PetscValidPointer(namelist,3); *namelist = NULL;} 20600298fd71SBarry Smith if (innerislist) {PetscValidPointer(innerislist,4); *innerislist = NULL;} 20610298fd71SBarry Smith if (outerislist) {PetscValidPointer(outerislist,5); *outerislist = NULL;} 20620298fd71SBarry Smith if (dmlist) {PetscValidPointer(dmlist,6); *dmlist = NULL;} 2063f3f0edfdSDmitry Karpeev /* 2064f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 2065f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 2066f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 2067f3f0edfdSDmitry Karpeev */ 2068ce94432eSBarry Smith if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 206916621825SDmitry Karpeev if (dm->ops->createdomaindecomposition) { 2070be081cd6SPeter Brune ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr); 207114a18fd3SPeter Brune /* copy subdomain hooks and context over to the subdomain DMs */ 2072f891f5b9SPatrick Sanan if (dmlist && *dmlist) { 2073be081cd6SPeter Brune for (i = 0; i < l; i++) { 2074be081cd6SPeter Brune for (link=dm->subdomainhook; link; link=link->next) { 2075be081cd6SPeter Brune if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);} 2076be081cd6SPeter Brune } 2077648262bbSPatrick Sanan if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx; 2078e7c4fc90SDmitry Karpeev } 207914a18fd3SPeter Brune } 208014a18fd3SPeter Brune if (len) *len = l; 208114a18fd3SPeter Brune } 2082e30e807fSPeter Brune PetscFunctionReturn(0); 2083e30e807fSPeter Brune } 2084e30e807fSPeter Brune 2085e30e807fSPeter Brune /*@C 2086e30e807fSPeter Brune DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector 2087e30e807fSPeter Brune 2088e30e807fSPeter Brune Not collective 2089e30e807fSPeter Brune 2090e30e807fSPeter Brune Input Parameters: 2091e30e807fSPeter Brune + dm - the DM object 2092e30e807fSPeter Brune . n - the number of subdomain scatters 2093e30e807fSPeter Brune - subdms - the local subdomains 2094e30e807fSPeter Brune 2095e30e807fSPeter Brune Output Parameters: 20966b867d5aSJose E. Roman + iscat - scatter from global vector to nonoverlapping global vector entries on subdomain 2097e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain 2098e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts) 2099e30e807fSPeter Brune 210095452b02SPatrick Sanan Notes: 210195452b02SPatrick Sanan This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution 2102e30e807fSPeter Brune of general nonlinear problems with overlapping subdomain methods. While merely having index sets that enable subsets 2103e30e807fSPeter Brune of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of 2104e30e807fSPeter Brune solution and residual data. 2105e30e807fSPeter Brune 2106e30e807fSPeter Brune Level: developer 2107e30e807fSPeter Brune 2108e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 2109e30e807fSPeter Brune @*/ 2110e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat) 2111e30e807fSPeter Brune { 2112e30e807fSPeter Brune PetscErrorCode ierr; 2113e30e807fSPeter Brune 2114e30e807fSPeter Brune PetscFunctionBegin; 2115e30e807fSPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2116e30e807fSPeter Brune PetscValidPointer(subdms,3); 2117b9d85ea2SLisandro Dalcin if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name); 2118e30e807fSPeter Brune ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr); 2119e7c4fc90SDmitry Karpeev PetscFunctionReturn(0); 2120e7c4fc90SDmitry Karpeev } 2121e7c4fc90SDmitry Karpeev 212247c6ae99SBarry Smith /*@ 212347c6ae99SBarry Smith DMRefine - Refines a DM object 212447c6ae99SBarry Smith 2125d083f849SBarry Smith Collective on dm 212647c6ae99SBarry Smith 2127d8d19677SJose E. Roman Input Parameters: 212847c6ae99SBarry Smith + dm - the DM object 212991d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 213047c6ae99SBarry Smith 213147c6ae99SBarry Smith Output Parameter: 21320298fd71SBarry Smith . dmf - the refined DM, or NULL 2133ae0a1c52SMatthew G Knepley 2134f27dd7c6SMatthew G. Knepley Options Database Keys: 2135412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex 2136412e9a14SMatthew G. Knepley 21370298fd71SBarry Smith Note: If no refinement was done, the return value is NULL 213847c6ae99SBarry Smith 213947c6ae99SBarry Smith Level: developer 214047c6ae99SBarry Smith 2141e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 214247c6ae99SBarry Smith @*/ 21437087cfbeSBarry Smith PetscErrorCode DMRefine(DM dm,MPI_Comm comm,DM *dmf) 214447c6ae99SBarry Smith { 214547c6ae99SBarry Smith PetscErrorCode ierr; 2146c833c3b5SJed Brown DMRefineHookLink link; 214747c6ae99SBarry Smith 214847c6ae99SBarry Smith PetscFunctionBegin; 2149732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2150b9d85ea2SLisandro Dalcin if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name); 21511ac00216SMatthew G. Knepley ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 215247c6ae99SBarry Smith ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr); 21534057135bSMatthew G Knepley if (*dmf) { 215443842a1eSJed Brown (*dmf)->ops->creatematrix = dm->ops->creatematrix; 21558865f1eaSKarl Rupp 21568cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr); 21578865f1eaSKarl Rupp 2158644e2e5bSBarry Smith (*dmf)->ctx = dm->ctx; 21590598a293SJed Brown (*dmf)->leveldown = dm->leveldown; 2160656b349aSBarry Smith (*dmf)->levelup = dm->levelup + 1; 21618865f1eaSKarl Rupp 2162e4b4b23bSJed Brown ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr); 2163c833c3b5SJed Brown for (link=dm->refinehook; link; link=link->next) { 21648865f1eaSKarl Rupp if (link->refinehook) { 21658865f1eaSKarl Rupp ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr); 21668865f1eaSKarl Rupp } 2167c833c3b5SJed Brown } 2168c833c3b5SJed Brown } 21691ac00216SMatthew G. Knepley ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 2170c833c3b5SJed Brown PetscFunctionReturn(0); 2171c833c3b5SJed Brown } 2172c833c3b5SJed Brown 2173bb9467b5SJed Brown /*@C 2174c833c3b5SJed Brown DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid 2175c833c3b5SJed Brown 2176c833c3b5SJed Brown Logically Collective 2177c833c3b5SJed Brown 21784165533cSJose E. Roman Input Parameters: 2179c833c3b5SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 2180c833c3b5SJed Brown . refinehook - function to run when setting up a coarser level 2181c833c3b5SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 21820298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2183c833c3b5SJed Brown 2184c833c3b5SJed Brown Calling sequence of refinehook: 2185c833c3b5SJed Brown $ refinehook(DM coarse,DM fine,void *ctx); 2186c833c3b5SJed Brown 2187c833c3b5SJed Brown + coarse - coarse level DM 2188c833c3b5SJed Brown . fine - fine level DM to interpolate problem to 2189c833c3b5SJed Brown - ctx - optional user-defined function context 2190c833c3b5SJed Brown 2191c833c3b5SJed Brown Calling sequence for interphook: 2192c833c3b5SJed Brown $ interphook(DM coarse,Mat interp,DM fine,void *ctx) 2193c833c3b5SJed Brown 2194c833c3b5SJed Brown + coarse - coarse level DM 2195c833c3b5SJed Brown . interp - matrix interpolating a coarse-level solution to the finer grid 2196c833c3b5SJed Brown . fine - fine level DM to update 2197c833c3b5SJed Brown - ctx - optional user-defined function context 2198c833c3b5SJed Brown 2199c833c3b5SJed Brown Level: advanced 2200c833c3b5SJed Brown 2201c833c3b5SJed Brown Notes: 2202c833c3b5SJed Brown This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing 2203c833c3b5SJed Brown 2204c833c3b5SJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 2205c833c3b5SJed Brown 2206bb9467b5SJed Brown This function is currently not available from Fortran. 2207bb9467b5SJed Brown 2208c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2209c833c3b5SJed Brown @*/ 2210c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 2211c833c3b5SJed Brown { 2212c833c3b5SJed Brown PetscErrorCode ierr; 2213c833c3b5SJed Brown DMRefineHookLink link,*p; 2214c833c3b5SJed Brown 2215c833c3b5SJed Brown PetscFunctionBegin; 2216c833c3b5SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 22173d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 22183d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0); 22193d8e3701SJed Brown } 222095dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2221c833c3b5SJed Brown link->refinehook = refinehook; 2222c833c3b5SJed Brown link->interphook = interphook; 2223c833c3b5SJed Brown link->ctx = ctx; 22240298fd71SBarry Smith link->next = NULL; 2225c833c3b5SJed Brown *p = link; 2226c833c3b5SJed Brown PetscFunctionReturn(0); 2227c833c3b5SJed Brown } 2228c833c3b5SJed Brown 22293d8e3701SJed Brown /*@C 22303d8e3701SJed Brown DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid 22313d8e3701SJed Brown 22323d8e3701SJed Brown Logically Collective 22333d8e3701SJed Brown 22344165533cSJose E. Roman Input Parameters: 22353d8e3701SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 22363d8e3701SJed Brown . refinehook - function to run when setting up a coarser level 22373d8e3701SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 22383d8e3701SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 22393d8e3701SJed Brown 22403d8e3701SJed Brown Level: advanced 22413d8e3701SJed Brown 22423d8e3701SJed Brown Notes: 22433d8e3701SJed Brown This function does nothing if the hook is not in the list. 22443d8e3701SJed Brown 22453d8e3701SJed Brown This function is currently not available from Fortran. 22463d8e3701SJed Brown 22473d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 22483d8e3701SJed Brown @*/ 22493d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 22503d8e3701SJed Brown { 22513d8e3701SJed Brown PetscErrorCode ierr; 22523d8e3701SJed Brown DMRefineHookLink link,*p; 22533d8e3701SJed Brown 22543d8e3701SJed Brown PetscFunctionBegin; 22553d8e3701SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 22563d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 22573d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) { 22583d8e3701SJed Brown link = *p; 22593d8e3701SJed Brown *p = link->next; 22603d8e3701SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 22613d8e3701SJed Brown break; 22623d8e3701SJed Brown } 22633d8e3701SJed Brown } 22643d8e3701SJed Brown PetscFunctionReturn(0); 22653d8e3701SJed Brown } 22663d8e3701SJed Brown 2267c833c3b5SJed Brown /*@ 2268c833c3b5SJed Brown DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd() 2269c833c3b5SJed Brown 2270c833c3b5SJed Brown Collective if any hooks are 2271c833c3b5SJed Brown 22724165533cSJose E. Roman Input Parameters: 2273c833c3b5SJed Brown + coarse - coarser DM to use as a base 2274e91eccc2SStefano Zampini . interp - interpolation matrix, apply using MatInterpolate() 2275c833c3b5SJed Brown - fine - finer DM to update 2276c833c3b5SJed Brown 2277c833c3b5SJed Brown Level: developer 2278c833c3b5SJed Brown 2279c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate() 2280c833c3b5SJed Brown @*/ 2281c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine) 2282c833c3b5SJed Brown { 2283c833c3b5SJed Brown PetscErrorCode ierr; 2284c833c3b5SJed Brown DMRefineHookLink link; 2285c833c3b5SJed Brown 2286c833c3b5SJed Brown PetscFunctionBegin; 2287c833c3b5SJed Brown for (link=fine->refinehook; link; link=link->next) { 22888865f1eaSKarl Rupp if (link->interphook) { 22898865f1eaSKarl Rupp ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr); 22908865f1eaSKarl Rupp } 22914057135bSMatthew G Knepley } 229247c6ae99SBarry Smith PetscFunctionReturn(0); 229347c6ae99SBarry Smith } 229447c6ae99SBarry Smith 2295eb3f98d2SBarry Smith /*@ 22961f3379b2SToby Isaac DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh. 22971f3379b2SToby Isaac 22981f3379b2SToby Isaac Collective on DM 22991f3379b2SToby Isaac 23004165533cSJose E. Roman Input Parameters: 23011f3379b2SToby Isaac + coarse - coarse DM 23021f3379b2SToby Isaac . fine - fine DM 23031f3379b2SToby Isaac . interp - (optional) the matrix computed by DMCreateInterpolation(). Implementations may not need this, but if it 23041f3379b2SToby Isaac is available it can avoid some recomputation. If it is provided, MatInterpolate() will be used if 23051f3379b2SToby Isaac the coarse DM does not have a specialized implementation. 23061f3379b2SToby Isaac - coarseSol - solution on the coarse mesh 23071f3379b2SToby Isaac 23084165533cSJose E. Roman Output Parameter: 23091f3379b2SToby Isaac . fineSol - the interpolation of coarseSol to the fine mesh 23101f3379b2SToby Isaac 23111f3379b2SToby Isaac Level: developer 23121f3379b2SToby Isaac 23131f3379b2SToby Isaac Note: This function exists because the interpolation of a solution vector between meshes is not always a linear 23141f3379b2SToby Isaac map. For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed 23151f3379b2SToby Isaac out of the solution vector. Or if interpolation is inherently a nonlinear operation, such as a method using 23161f3379b2SToby Isaac slope-limiting reconstruction. 23171f3379b2SToby Isaac 23181f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation() 23191f3379b2SToby Isaac @*/ 23201f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol) 23211f3379b2SToby Isaac { 23221f3379b2SToby Isaac PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL; 23231f3379b2SToby Isaac PetscErrorCode ierr; 23241f3379b2SToby Isaac 23251f3379b2SToby Isaac PetscFunctionBegin; 23261f3379b2SToby Isaac PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 23271f3379b2SToby Isaac if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3); 23281f3379b2SToby Isaac PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4); 23291f3379b2SToby Isaac PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5); 23301f3379b2SToby Isaac 23311f3379b2SToby Isaac ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr); 23321f3379b2SToby Isaac if (interpsol) { 23331f3379b2SToby Isaac ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr); 23341f3379b2SToby Isaac } else if (interp) { 23351f3379b2SToby Isaac ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr); 23361f3379b2SToby Isaac } else SETERRQ1(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name); 23371f3379b2SToby Isaac PetscFunctionReturn(0); 23381f3379b2SToby Isaac } 23391f3379b2SToby Isaac 23401f3379b2SToby Isaac /*@ 2341aed49f88SRichard Tran Mills DMGetRefineLevel - Gets the number of refinements that have generated this DM. 2342eb3f98d2SBarry Smith 2343eb3f98d2SBarry Smith Not Collective 2344eb3f98d2SBarry Smith 2345eb3f98d2SBarry Smith Input Parameter: 2346eb3f98d2SBarry Smith . dm - the DM object 2347eb3f98d2SBarry Smith 2348eb3f98d2SBarry Smith Output Parameter: 2349eb3f98d2SBarry Smith . level - number of refinements 2350eb3f98d2SBarry Smith 2351eb3f98d2SBarry Smith Level: developer 2352eb3f98d2SBarry Smith 23536a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2354eb3f98d2SBarry Smith 2355eb3f98d2SBarry Smith @*/ 2356eb3f98d2SBarry Smith PetscErrorCode DMGetRefineLevel(DM dm,PetscInt *level) 2357eb3f98d2SBarry Smith { 2358eb3f98d2SBarry Smith PetscFunctionBegin; 2359eb3f98d2SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2360eb3f98d2SBarry Smith *level = dm->levelup; 2361eb3f98d2SBarry Smith PetscFunctionReturn(0); 2362eb3f98d2SBarry Smith } 2363eb3f98d2SBarry Smith 2364fef3a512SBarry Smith /*@ 2365aed49f88SRichard Tran Mills DMSetRefineLevel - Sets the number of refinements that have generated this DM. 2366fef3a512SBarry Smith 2367fef3a512SBarry Smith Not Collective 2368fef3a512SBarry Smith 2369d8d19677SJose E. Roman Input Parameters: 2370fef3a512SBarry Smith + dm - the DM object 2371fef3a512SBarry Smith - level - number of refinements 2372fef3a512SBarry Smith 2373fef3a512SBarry Smith Level: advanced 2374fef3a512SBarry Smith 237595452b02SPatrick Sanan Notes: 237695452b02SPatrick Sanan This value is used by PCMG to determine how many multigrid levels to use 2377fef3a512SBarry Smith 2378fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2379fef3a512SBarry Smith 2380fef3a512SBarry Smith @*/ 2381fef3a512SBarry Smith PetscErrorCode DMSetRefineLevel(DM dm,PetscInt level) 2382fef3a512SBarry Smith { 2383fef3a512SBarry Smith PetscFunctionBegin; 2384fef3a512SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2385fef3a512SBarry Smith dm->levelup = level; 2386fef3a512SBarry Smith PetscFunctionReturn(0); 2387fef3a512SBarry Smith } 2388fef3a512SBarry Smith 2389d410b0cfSMatthew G. Knepley /*@ 2390d410b0cfSMatthew G. Knepley DMExtrude - Extrude a DM object from a surface 2391d410b0cfSMatthew G. Knepley 2392d410b0cfSMatthew G. Knepley Collective on dm 2393d410b0cfSMatthew G. Knepley 2394d410b0cfSMatthew G. Knepley Input Parameter: 2395d410b0cfSMatthew G. Knepley + dm - the DM object 2396d410b0cfSMatthew G. Knepley - layers - the number of extruded cell layers 2397d410b0cfSMatthew G. Knepley 2398d410b0cfSMatthew G. Knepley Output Parameter: 2399d410b0cfSMatthew G. Knepley . dme - the extruded DM, or NULL 2400d410b0cfSMatthew G. Knepley 2401d410b0cfSMatthew G. Knepley Note: If no extrusion was done, the return value is NULL 2402d410b0cfSMatthew G. Knepley 2403d410b0cfSMatthew G. Knepley Level: developer 2404d410b0cfSMatthew G. Knepley 2405d410b0cfSMatthew G. Knepley .seealso DMRefine(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector() 2406d410b0cfSMatthew G. Knepley @*/ 2407d410b0cfSMatthew G. Knepley PetscErrorCode DMExtrude(DM dm, PetscInt layers, DM *dme) 2408d410b0cfSMatthew G. Knepley { 2409d410b0cfSMatthew G. Knepley PetscErrorCode ierr; 2410d410b0cfSMatthew G. Knepley 2411d410b0cfSMatthew G. Knepley PetscFunctionBegin; 2412d410b0cfSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2413d410b0cfSMatthew G. Knepley if (!dm->ops->extrude) SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_SUP, "DM type %s does not implement DMExtrude", ((PetscObject) dm)->type_name); 2414d410b0cfSMatthew G. Knepley ierr = (*dm->ops->extrude)(dm, layers, dme);CHKERRQ(ierr); 2415d410b0cfSMatthew G. Knepley if (*dme) { 2416d410b0cfSMatthew G. Knepley (*dme)->ops->creatematrix = dm->ops->creatematrix; 2417d410b0cfSMatthew G. Knepley ierr = PetscObjectCopyFortranFunctionPointers((PetscObject) dm, (PetscObject) *dme);CHKERRQ(ierr); 2418d410b0cfSMatthew G. Knepley (*dme)->ctx = dm->ctx; 2419d410b0cfSMatthew G. Knepley ierr = DMSetMatType(*dme, dm->mattype);CHKERRQ(ierr); 2420d410b0cfSMatthew G. Knepley } 2421d410b0cfSMatthew G. Knepley PetscFunctionReturn(0); 2422d410b0cfSMatthew G. Knepley } 2423d410b0cfSMatthew G. Knepley 2424ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm) 2425ca3d3a14SMatthew G. Knepley { 2426ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2427ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2428ca3d3a14SMatthew G. Knepley PetscValidPointer(tdm, 2); 2429ca3d3a14SMatthew G. Knepley *tdm = dm->transformDM; 2430ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2431ca3d3a14SMatthew G. Knepley } 2432ca3d3a14SMatthew G. Knepley 2433ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv) 2434ca3d3a14SMatthew G. Knepley { 2435ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2436ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2437ca3d3a14SMatthew G. Knepley PetscValidPointer(tv, 2); 2438ca3d3a14SMatthew G. Knepley *tv = dm->transform; 2439ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2440ca3d3a14SMatthew G. Knepley } 2441ca3d3a14SMatthew G. Knepley 2442ca3d3a14SMatthew G. Knepley /*@ 2443c0f8e1fdSMatthew G. Knepley DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors 2444ca3d3a14SMatthew G. Knepley 2445ca3d3a14SMatthew G. Knepley Input Parameter: 2446ca3d3a14SMatthew G. Knepley . dm - The DM 2447ca3d3a14SMatthew G. Knepley 2448ca3d3a14SMatthew G. Knepley Output Parameter: 2449ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done 2450ca3d3a14SMatthew G. Knepley 2451ca3d3a14SMatthew G. Knepley Level: developer 2452ca3d3a14SMatthew G. Knepley 2453436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation() 2454ca3d3a14SMatthew G. Knepley @*/ 2455ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg) 2456ca3d3a14SMatthew G. Knepley { 2457ca3d3a14SMatthew G. Knepley Vec tv; 2458ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2459ca3d3a14SMatthew G. Knepley 2460ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2461ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2462534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 2463ca3d3a14SMatthew G. Knepley ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr); 2464ca3d3a14SMatthew G. Knepley *flg = tv ? PETSC_TRUE : PETSC_FALSE; 2465ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2466ca3d3a14SMatthew G. Knepley } 2467ca3d3a14SMatthew G. Knepley 2468ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm) 2469ca3d3a14SMatthew G. Knepley { 2470ca3d3a14SMatthew G. Knepley PetscSection s, ts; 2471ca3d3a14SMatthew G. Knepley PetscScalar *ta; 2472ca3d3a14SMatthew G. Knepley PetscInt cdim, pStart, pEnd, p, Nf, f, Nc, dof; 2473ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2474ca3d3a14SMatthew G. Knepley 2475ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2476ca3d3a14SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 247792fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 2478ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 2479ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr); 2480ca3d3a14SMatthew G. Knepley ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr); 248192fd8e1eSJed Brown ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr); 2482ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr); 2483ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr); 2484ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2485ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr); 2486ca3d3a14SMatthew G. Knepley /* We could start to label fields by their transformation properties */ 2487ca3d3a14SMatthew G. Knepley if (Nc != cdim) continue; 2488ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2489ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr); 2490ca3d3a14SMatthew G. Knepley if (!dof) continue; 2491ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr); 2492ca3d3a14SMatthew G. Knepley ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr); 2493ca3d3a14SMatthew G. Knepley } 2494ca3d3a14SMatthew G. Knepley } 2495ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetUp(ts);CHKERRQ(ierr); 2496ca3d3a14SMatthew G. Knepley ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr); 2497ca3d3a14SMatthew G. Knepley ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr); 2498ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2499ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2500ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr); 2501ca3d3a14SMatthew G. Knepley if (dof) { 2502ca3d3a14SMatthew G. Knepley PetscReal x[3] = {0.0, 0.0, 0.0}; 2503ca3d3a14SMatthew G. Knepley PetscScalar *tva; 2504ca3d3a14SMatthew G. Knepley const PetscScalar *A; 2505ca3d3a14SMatthew G. Knepley 2506ca3d3a14SMatthew G. Knepley /* TODO Get quadrature point for this dual basis vector for coordinate */ 2507ca3d3a14SMatthew G. Knepley ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr); 2508ca3d3a14SMatthew G. Knepley ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr); 2509580bdb30SBarry Smith ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr); 2510ca3d3a14SMatthew G. Knepley } 2511ca3d3a14SMatthew G. Knepley } 2512ca3d3a14SMatthew G. Knepley } 2513ca3d3a14SMatthew G. Knepley ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr); 2514ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2515ca3d3a14SMatthew G. Knepley } 2516ca3d3a14SMatthew G. Knepley 2517ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm) 2518ca3d3a14SMatthew G. Knepley { 2519ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2520ca3d3a14SMatthew G. Knepley 2521ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2522ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2523ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(newdm, DM_CLASSID, 2); 2524ca3d3a14SMatthew G. Knepley newdm->transformCtx = dm->transformCtx; 2525ca3d3a14SMatthew G. Knepley newdm->transformSetUp = dm->transformSetUp; 2526ca3d3a14SMatthew G. Knepley newdm->transformDestroy = NULL; 2527ca3d3a14SMatthew G. Knepley newdm->transformGetMatrix = dm->transformGetMatrix; 2528ca3d3a14SMatthew G. Knepley if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);} 2529ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2530ca3d3a14SMatthew G. Knepley } 2531ca3d3a14SMatthew G. Knepley 2532bb9467b5SJed Brown /*@C 2533baf369e7SPeter Brune DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called 2534baf369e7SPeter Brune 2535baf369e7SPeter Brune Logically Collective 2536baf369e7SPeter Brune 25374165533cSJose E. Roman Input Parameters: 2538baf369e7SPeter Brune + dm - the DM 2539baf369e7SPeter Brune . beginhook - function to run at the beginning of DMGlobalToLocalBegin() 2540baf369e7SPeter Brune . endhook - function to run after DMGlobalToLocalEnd() has completed 25410298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2542baf369e7SPeter Brune 2543baf369e7SPeter Brune Calling sequence for beginhook: 2544baf369e7SPeter Brune $ beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2545baf369e7SPeter Brune 2546baf369e7SPeter Brune + dm - global DM 2547baf369e7SPeter Brune . g - global vector 2548baf369e7SPeter Brune . mode - mode 2549baf369e7SPeter Brune . l - local vector 2550baf369e7SPeter Brune - ctx - optional user-defined function context 2551baf369e7SPeter Brune 2552baf369e7SPeter Brune Calling sequence for endhook: 2553ec4806b8SPeter Brune $ endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2554baf369e7SPeter Brune 2555baf369e7SPeter Brune + global - global DM 2556baf369e7SPeter Brune - ctx - optional user-defined function context 2557baf369e7SPeter Brune 2558baf369e7SPeter Brune Level: advanced 2559baf369e7SPeter Brune 2560baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2561baf369e7SPeter Brune @*/ 2562baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2563baf369e7SPeter Brune { 2564baf369e7SPeter Brune PetscErrorCode ierr; 2565baf369e7SPeter Brune DMGlobalToLocalHookLink link,*p; 2566baf369e7SPeter Brune 2567baf369e7SPeter Brune PetscFunctionBegin; 2568baf369e7SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2569baf369e7SPeter Brune for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 257095dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2571baf369e7SPeter Brune link->beginhook = beginhook; 2572baf369e7SPeter Brune link->endhook = endhook; 2573baf369e7SPeter Brune link->ctx = ctx; 25740298fd71SBarry Smith link->next = NULL; 2575baf369e7SPeter Brune *p = link; 2576baf369e7SPeter Brune PetscFunctionReturn(0); 2577baf369e7SPeter Brune } 2578baf369e7SPeter Brune 25794c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx) 25804c274da1SToby Isaac { 25814c274da1SToby Isaac Mat cMat; 25824c274da1SToby Isaac Vec cVec; 25834c274da1SToby Isaac PetscSection section, cSec; 25844c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 25854c274da1SToby Isaac PetscErrorCode ierr; 25864c274da1SToby Isaac 25874c274da1SToby Isaac PetscFunctionBegin; 25884c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 25894c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 25904c274da1SToby Isaac if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) { 25915db9a05bSToby Isaac PetscInt nRows; 25925db9a05bSToby Isaac 25935db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 25945db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 259592fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 25967711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 25974c274da1SToby Isaac ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr); 25984c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 25994c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 26004c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 26014c274da1SToby Isaac if (dof) { 26024c274da1SToby Isaac PetscScalar *vals; 26034c274da1SToby Isaac ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr); 26044c274da1SToby Isaac ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr); 26054c274da1SToby Isaac } 26064c274da1SToby Isaac } 26074c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 26084c274da1SToby Isaac } 26094c274da1SToby Isaac PetscFunctionReturn(0); 26104c274da1SToby Isaac } 26114c274da1SToby Isaac 261247c6ae99SBarry Smith /*@ 261301729b5cSPatrick Sanan DMGlobalToLocal - update local vectors from global vector 261401729b5cSPatrick Sanan 2615d083f849SBarry Smith Neighbor-wise Collective on dm 261601729b5cSPatrick Sanan 261701729b5cSPatrick Sanan Input Parameters: 261801729b5cSPatrick Sanan + dm - the DM object 261901729b5cSPatrick Sanan . g - the global vector 262001729b5cSPatrick Sanan . mode - INSERT_VALUES or ADD_VALUES 262101729b5cSPatrick Sanan - l - the local vector 262201729b5cSPatrick Sanan 262301729b5cSPatrick Sanan Notes: 262401729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 262501729b5cSPatrick Sanan DMGlobalToLocalBegin() and DMGlobalToLocalEnd(). 262601729b5cSPatrick Sanan 262701729b5cSPatrick Sanan Level: beginner 262801729b5cSPatrick Sanan 262901729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 263001729b5cSPatrick Sanan 263101729b5cSPatrick Sanan @*/ 263201729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l) 263301729b5cSPatrick Sanan { 263401729b5cSPatrick Sanan PetscErrorCode ierr; 263501729b5cSPatrick Sanan 263601729b5cSPatrick Sanan PetscFunctionBegin; 263701729b5cSPatrick Sanan ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr); 263801729b5cSPatrick Sanan ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr); 263901729b5cSPatrick Sanan PetscFunctionReturn(0); 264001729b5cSPatrick Sanan } 264101729b5cSPatrick Sanan 264201729b5cSPatrick Sanan /*@ 264347c6ae99SBarry Smith DMGlobalToLocalBegin - Begins updating local vectors from global vector 264447c6ae99SBarry Smith 2645d083f849SBarry Smith Neighbor-wise Collective on dm 264647c6ae99SBarry Smith 264747c6ae99SBarry Smith Input Parameters: 264847c6ae99SBarry Smith + dm - the DM object 264947c6ae99SBarry Smith . g - the global vector 265047c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 265147c6ae99SBarry Smith - l - the local vector 265247c6ae99SBarry Smith 265301729b5cSPatrick Sanan Level: intermediate 265447c6ae99SBarry Smith 265501729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 265647c6ae99SBarry Smith 265747c6ae99SBarry Smith @*/ 26587087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 265947c6ae99SBarry Smith { 26607128ae9fSMatthew G Knepley PetscSF sf; 266147c6ae99SBarry Smith PetscErrorCode ierr; 2662baf369e7SPeter Brune DMGlobalToLocalHookLink link; 266347c6ae99SBarry Smith 266447c6ae99SBarry Smith PetscFunctionBegin; 2665171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2666baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 26678865f1eaSKarl Rupp if (link->beginhook) { 26688865f1eaSKarl Rupp ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr); 26698865f1eaSKarl Rupp } 2670baf369e7SPeter Brune } 26711bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 26727128ae9fSMatthew G Knepley if (sf) { 2673ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2674ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2675d0295fc0SJunchao Zhang PetscMemType lmtype,gmtype; 26767128ae9fSMatthew G Knepley 267782f516ccSBarry Smith if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 2678a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2679a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2680ad227feaSJunchao Zhang ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr); 2681a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr); 2682a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr); 26837128ae9fSMatthew G Knepley } else { 268433907cc2SStefano Zampini if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name); 2685843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 26867128ae9fSMatthew G Knepley } 268747c6ae99SBarry Smith PetscFunctionReturn(0); 268847c6ae99SBarry Smith } 268947c6ae99SBarry Smith 269047c6ae99SBarry Smith /*@ 269147c6ae99SBarry Smith DMGlobalToLocalEnd - Ends updating local vectors from global vector 269247c6ae99SBarry Smith 2693d083f849SBarry Smith Neighbor-wise Collective on dm 269447c6ae99SBarry Smith 269547c6ae99SBarry Smith Input Parameters: 269647c6ae99SBarry Smith + dm - the DM object 269747c6ae99SBarry Smith . g - the global vector 269847c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 269947c6ae99SBarry Smith - l - the local vector 270047c6ae99SBarry Smith 270101729b5cSPatrick Sanan Level: intermediate 270247c6ae99SBarry Smith 270301729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 270447c6ae99SBarry Smith 270547c6ae99SBarry Smith @*/ 27067087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 270747c6ae99SBarry Smith { 27087128ae9fSMatthew G Knepley PetscSF sf; 270947c6ae99SBarry Smith PetscErrorCode ierr; 2710ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2711ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2712ca3d3a14SMatthew G. Knepley PetscBool transform; 2713baf369e7SPeter Brune DMGlobalToLocalHookLink link; 2714d0295fc0SJunchao Zhang PetscMemType lmtype,gmtype; 271547c6ae99SBarry Smith 271647c6ae99SBarry Smith PetscFunctionBegin; 2717171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 27181bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 2719ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 27207128ae9fSMatthew G Knepley if (sf) { 272182f516ccSBarry Smith if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 27227128ae9fSMatthew G Knepley 2723a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2724a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2725ad227feaSJunchao Zhang ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr); 2726a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr); 2727a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr); 2728ca3d3a14SMatthew G. Knepley if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);} 27297128ae9fSMatthew G Knepley } else { 273033907cc2SStefano Zampini if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name); 2731843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 27327128ae9fSMatthew G Knepley } 27334c274da1SToby Isaac ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr); 2734baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 2735baf369e7SPeter Brune if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 2736baf369e7SPeter Brune } 273747c6ae99SBarry Smith PetscFunctionReturn(0); 273847c6ae99SBarry Smith } 273947c6ae99SBarry Smith 2740d4d07f1eSToby Isaac /*@C 2741d4d07f1eSToby Isaac DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called 2742d4d07f1eSToby Isaac 2743d4d07f1eSToby Isaac Logically Collective 2744d4d07f1eSToby Isaac 27454165533cSJose E. Roman Input Parameters: 2746d4d07f1eSToby Isaac + dm - the DM 2747d4d07f1eSToby Isaac . beginhook - function to run at the beginning of DMLocalToGlobalBegin() 2748d4d07f1eSToby Isaac . endhook - function to run after DMLocalToGlobalEnd() has completed 2749d4d07f1eSToby Isaac - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2750d4d07f1eSToby Isaac 2751d4d07f1eSToby Isaac Calling sequence for beginhook: 2752d4d07f1eSToby Isaac $ beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2753d4d07f1eSToby Isaac 2754d4d07f1eSToby Isaac + dm - global DM 2755d4d07f1eSToby Isaac . l - local vector 2756d4d07f1eSToby Isaac . mode - mode 2757d4d07f1eSToby Isaac . g - global vector 2758d4d07f1eSToby Isaac - ctx - optional user-defined function context 2759d4d07f1eSToby Isaac 2760d4d07f1eSToby Isaac Calling sequence for endhook: 2761d4d07f1eSToby Isaac $ endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2762d4d07f1eSToby Isaac 2763d4d07f1eSToby Isaac + global - global DM 2764d4d07f1eSToby Isaac . l - local vector 2765d4d07f1eSToby Isaac . mode - mode 2766d4d07f1eSToby Isaac . g - global vector 2767d4d07f1eSToby Isaac - ctx - optional user-defined function context 2768d4d07f1eSToby Isaac 2769d4d07f1eSToby Isaac Level: advanced 2770d4d07f1eSToby Isaac 2771d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2772d4d07f1eSToby Isaac @*/ 2773d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2774d4d07f1eSToby Isaac { 2775d4d07f1eSToby Isaac PetscErrorCode ierr; 2776d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,*p; 2777d4d07f1eSToby Isaac 2778d4d07f1eSToby Isaac PetscFunctionBegin; 2779d4d07f1eSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2780d4d07f1eSToby Isaac for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 278195dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2782d4d07f1eSToby Isaac link->beginhook = beginhook; 2783d4d07f1eSToby Isaac link->endhook = endhook; 2784d4d07f1eSToby Isaac link->ctx = ctx; 2785d4d07f1eSToby Isaac link->next = NULL; 2786d4d07f1eSToby Isaac *p = link; 2787d4d07f1eSToby Isaac PetscFunctionReturn(0); 2788d4d07f1eSToby Isaac } 2789d4d07f1eSToby Isaac 27904c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx) 27914c274da1SToby Isaac { 27924c274da1SToby Isaac Mat cMat; 27934c274da1SToby Isaac Vec cVec; 27944c274da1SToby Isaac PetscSection section, cSec; 27954c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 27964c274da1SToby Isaac PetscErrorCode ierr; 27974c274da1SToby Isaac 27984c274da1SToby Isaac PetscFunctionBegin; 27994c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 28004c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 28014c274da1SToby Isaac if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) { 28025db9a05bSToby Isaac PetscInt nRows; 28035db9a05bSToby Isaac 28045db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 28055db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 280692fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 28077711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 28084c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 28094c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 28104c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 28114c274da1SToby Isaac if (dof) { 28124c274da1SToby Isaac PetscInt d; 28134c274da1SToby Isaac PetscScalar *vals; 28144c274da1SToby Isaac ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr); 28154c274da1SToby Isaac ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr); 28164c274da1SToby Isaac /* for this to be the true transpose, we have to zero the values that 28174c274da1SToby Isaac * we just extracted */ 28184c274da1SToby Isaac for (d = 0; d < dof; d++) { 28194c274da1SToby Isaac vals[d] = 0.; 28204c274da1SToby Isaac } 28214c274da1SToby Isaac } 28224c274da1SToby Isaac } 28234c274da1SToby Isaac ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr); 28244c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 28254c274da1SToby Isaac } 28264c274da1SToby Isaac PetscFunctionReturn(0); 28274c274da1SToby Isaac } 282801729b5cSPatrick Sanan /*@ 282901729b5cSPatrick Sanan DMLocalToGlobal - updates global vectors from local vectors 283001729b5cSPatrick Sanan 2831d083f849SBarry Smith Neighbor-wise Collective on dm 283201729b5cSPatrick Sanan 283301729b5cSPatrick Sanan Input Parameters: 283401729b5cSPatrick Sanan + dm - the DM object 283501729b5cSPatrick Sanan . l - the local vector 283601729b5cSPatrick Sanan . mode - if INSERT_VALUES then no parallel communication is used, if ADD_VALUES then all ghost points from the same base point accumulate into that base point. 283701729b5cSPatrick Sanan - g - the global vector 283801729b5cSPatrick Sanan 283901729b5cSPatrick Sanan Notes: 284001729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 284101729b5cSPatrick Sanan DMLocalToGlobalBegin() and DMLocalToGlobalEnd(). 284201729b5cSPatrick Sanan 284301729b5cSPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 284401729b5cSPatrick Sanan INSERT_VALUES is not supported for DMDA; in that case simply compute the values directly into a global vector instead of a local one. 284501729b5cSPatrick Sanan 284601729b5cSPatrick Sanan Level: beginner 284701729b5cSPatrick Sanan 284801729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 284901729b5cSPatrick Sanan 285001729b5cSPatrick Sanan @*/ 285101729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g) 285201729b5cSPatrick Sanan { 285301729b5cSPatrick Sanan PetscErrorCode ierr; 285401729b5cSPatrick Sanan 285501729b5cSPatrick Sanan PetscFunctionBegin; 285601729b5cSPatrick Sanan ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr); 285701729b5cSPatrick Sanan ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr); 285801729b5cSPatrick Sanan PetscFunctionReturn(0); 285901729b5cSPatrick Sanan } 28604c274da1SToby Isaac 286147c6ae99SBarry Smith /*@ 286201729b5cSPatrick Sanan DMLocalToGlobalBegin - begins updating global vectors from local vectors 28639a42bb27SBarry Smith 2864d083f849SBarry Smith Neighbor-wise Collective on dm 28659a42bb27SBarry Smith 28669a42bb27SBarry Smith Input Parameters: 28679a42bb27SBarry Smith + dm - the DM object 2868f6813fd5SJed Brown . l - the local vector 28691eb28f2eSBarry 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. 28701eb28f2eSBarry Smith - g - the global vector 28719a42bb27SBarry Smith 287295452b02SPatrick Sanan Notes: 287395452b02SPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 287484330215SMatthew 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. 28759a42bb27SBarry Smith 287601729b5cSPatrick Sanan Level: intermediate 28779a42bb27SBarry Smith 287801729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 28799a42bb27SBarry Smith 28809a42bb27SBarry Smith @*/ 28817087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g) 28829a42bb27SBarry Smith { 28837128ae9fSMatthew G Knepley PetscSF sf; 288484330215SMatthew G. Knepley PetscSection s, gs; 2885d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 2886ca3d3a14SMatthew G. Knepley Vec tmpl; 2887ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2888ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 2889fa88e482SJed Brown PetscBool isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE; 289084330215SMatthew G. Knepley PetscErrorCode ierr; 2891d0295fc0SJunchao Zhang PetscMemType lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST; 28929a42bb27SBarry Smith 28939a42bb27SBarry Smith PetscFunctionBegin; 2894171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2895d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2896d4d07f1eSToby Isaac if (link->beginhook) { 2897d4d07f1eSToby Isaac ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr); 2898d4d07f1eSToby Isaac } 2899d4d07f1eSToby Isaac } 29004c274da1SToby Isaac ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr); 29011bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 290292fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 29037128ae9fSMatthew G Knepley switch (mode) { 29047128ae9fSMatthew G Knepley case INSERT_VALUES: 29057128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 2906304ab55fSMatthew G. Knepley case INSERT_BC_VALUES: 290784330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 29087128ae9fSMatthew G Knepley case ADD_VALUES: 29097128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 2910304ab55fSMatthew G. Knepley case ADD_BC_VALUES: 291184330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 29127128ae9fSMatthew G Knepley default: 291382f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 29147128ae9fSMatthew G Knepley } 2915ca3d3a14SMatthew G. Knepley if ((sf && !isInsert) || (s && isInsert)) { 2916ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 2917ca3d3a14SMatthew G. Knepley if (transform) { 2918ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2919ca3d3a14SMatthew G. Knepley ierr = VecCopy(l, tmpl);CHKERRQ(ierr); 2920ca3d3a14SMatthew G. Knepley ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr); 2921ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2922fa88e482SJed Brown } else if (isInsert) { 2923ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 2924fa88e482SJed Brown } else { 2925a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2926fa88e482SJed Brown l_inplace = PETSC_TRUE; 2927ca3d3a14SMatthew G. Knepley } 2928fa88e482SJed Brown if (s && isInsert) { 29297128ae9fSMatthew G Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 2930fa88e482SJed Brown } else { 2931a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2932fa88e482SJed Brown g_inplace = PETSC_TRUE; 2933fa88e482SJed Brown } 2934ca3d3a14SMatthew G. Knepley if (sf && !isInsert) { 2935d0295fc0SJunchao Zhang ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr); 293684330215SMatthew G. Knepley } else if (s && isInsert) { 293784330215SMatthew G. Knepley PetscInt gStart, pStart, pEnd, p; 293884330215SMatthew G. Knepley 2939e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr); 294084330215SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 294184330215SMatthew G. Knepley ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr); 294284330215SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2943b3b16f48SMatthew G. Knepley PetscInt dof, gdof, cdof, gcdof, off, goff, d, e; 294484330215SMatthew G. Knepley 294584330215SMatthew G. Knepley ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr); 294603442857SMatthew G. Knepley ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr); 294784330215SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr); 2948b3b16f48SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr); 294984330215SMatthew G. Knepley ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr); 295084330215SMatthew G. Knepley ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr); 2951b3b16f48SMatthew G. Knepley /* Ignore off-process data and points with no global data */ 295203442857SMatthew G. Knepley if (!gdof || goff < 0) continue; 2953b3b16f48SMatthew 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); 2954b3b16f48SMatthew G. Knepley /* If no constraints are enforced in the global vector */ 2955b3b16f48SMatthew G. Knepley if (!gcdof) { 295684330215SMatthew G. Knepley for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d]; 2957b3b16f48SMatthew G. Knepley /* If constraints are enforced in the global vector */ 2958b3b16f48SMatthew G. Knepley } else if (cdof == gcdof) { 295984330215SMatthew G. Knepley const PetscInt *cdofs; 296084330215SMatthew G. Knepley PetscInt cind = 0; 296184330215SMatthew G. Knepley 296284330215SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr); 2963b3b16f48SMatthew G. Knepley for (d = 0, e = 0; d < dof; ++d) { 296484330215SMatthew G. Knepley if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;} 2965b3b16f48SMatthew G. Knepley gArray[goff-gStart+e++] = lArray[off+d]; 296684330215SMatthew G. Knepley } 2967b3b16f48SMatthew 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); 296884330215SMatthew G. Knepley } 2969ca3d3a14SMatthew G. Knepley } 2970fa88e482SJed Brown if (g_inplace) { 2971a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr); 2972fa88e482SJed Brown } else { 29737128ae9fSMatthew G Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 2974fa88e482SJed Brown } 2975ca3d3a14SMatthew G. Knepley if (transform) { 2976ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2977ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2978fa88e482SJed Brown } else if (l_inplace) { 2979a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr); 2980ca3d3a14SMatthew G. Knepley } else { 2981ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 2982ca3d3a14SMatthew G. Knepley } 29837128ae9fSMatthew G Knepley } else { 2984b9d85ea2SLisandro Dalcin if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name); 2985843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 29867128ae9fSMatthew G Knepley } 29879a42bb27SBarry Smith PetscFunctionReturn(0); 29889a42bb27SBarry Smith } 29899a42bb27SBarry Smith 29909a42bb27SBarry Smith /*@ 29919a42bb27SBarry Smith DMLocalToGlobalEnd - updates global vectors from local vectors 299247c6ae99SBarry Smith 2993d083f849SBarry Smith Neighbor-wise Collective on dm 299447c6ae99SBarry Smith 299547c6ae99SBarry Smith Input Parameters: 299647c6ae99SBarry Smith + dm - the DM object 2997f6813fd5SJed Brown . l - the local vector 299847c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 2999f6813fd5SJed Brown - g - the global vector 300047c6ae99SBarry Smith 300101729b5cSPatrick Sanan Level: intermediate 300247c6ae99SBarry Smith 3003e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd() 300447c6ae99SBarry Smith 300547c6ae99SBarry Smith @*/ 30067087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g) 300747c6ae99SBarry Smith { 30087128ae9fSMatthew G Knepley PetscSF sf; 300984330215SMatthew G. Knepley PetscSection s; 3010d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 3011ca3d3a14SMatthew G. Knepley PetscBool isInsert, transform; 301284330215SMatthew G. Knepley PetscErrorCode ierr; 301347c6ae99SBarry Smith 301447c6ae99SBarry Smith PetscFunctionBegin; 3015171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 30161bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 301792fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 30187128ae9fSMatthew G Knepley switch (mode) { 30197128ae9fSMatthew G Knepley case INSERT_VALUES: 30207128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 302184330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 30227128ae9fSMatthew G Knepley case ADD_VALUES: 30237128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 302484330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 30257128ae9fSMatthew G Knepley default: 302682f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 30277128ae9fSMatthew G Knepley } 302884330215SMatthew G. Knepley if (sf && !isInsert) { 3029ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 3030ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 3031ca3d3a14SMatthew G. Knepley Vec tmpl; 303284330215SMatthew G. Knepley 3033ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 3034ca3d3a14SMatthew G. Knepley if (transform) { 3035ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 3036ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 3037ca3d3a14SMatthew G. Knepley } else { 3038a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr); 3039ca3d3a14SMatthew G. Knepley } 3040a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr); 3041a9b180a6SBarry Smith ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr); 3042ca3d3a14SMatthew G. Knepley if (transform) { 3043ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 3044ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 3045ca3d3a14SMatthew G. Knepley } else { 3046a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr); 3047ca3d3a14SMatthew G. Knepley } 3048a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr); 304984330215SMatthew G. Knepley } else if (s && isInsert) { 30507128ae9fSMatthew G Knepley } else { 3051b9d85ea2SLisandro Dalcin if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name); 3052843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 30537128ae9fSMatthew G Knepley } 3054d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 3055d4d07f1eSToby Isaac if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 3056d4d07f1eSToby Isaac } 305747c6ae99SBarry Smith PetscFunctionReturn(0); 305847c6ae99SBarry Smith } 305947c6ae99SBarry Smith 3060f089877aSRichard Tran Mills /*@ 3061bc0a1609SRichard Tran Mills DMLocalToLocalBegin - Maps from a local vector (including ghost points 3062bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 3063d78e899eSRichard Tran Mills points in the second are set correctly. Must be followed by DMLocalToLocalEnd(). 3064f089877aSRichard Tran Mills 3065d083f849SBarry Smith Neighbor-wise Collective on dm 3066f089877aSRichard Tran Mills 3067f089877aSRichard Tran Mills Input Parameters: 3068f089877aSRichard Tran Mills + dm - the DM object 3069bc0a1609SRichard Tran Mills . g - the original local vector 3070bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 3071f089877aSRichard Tran Mills 3072bc0a1609SRichard Tran Mills Output Parameter: 3073bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 3074f089877aSRichard Tran Mills 3075f089877aSRichard Tran Mills Level: intermediate 3076f089877aSRichard Tran Mills 3077bc0a1609SRichard Tran Mills Notes: 3078bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 3079bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 3080bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 3081bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 3082bc0a1609SRichard Tran Mills 3083bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 3084f089877aSRichard Tran Mills 3085f089877aSRichard Tran Mills @*/ 3086f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 3087f089877aSRichard Tran Mills { 3088f089877aSRichard Tran Mills PetscErrorCode ierr; 3089f089877aSRichard Tran Mills 3090f089877aSRichard Tran Mills PetscFunctionBegin; 3091f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3092bb358533SPatrick Sanan if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 3093f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 3094f089877aSRichard Tran Mills PetscFunctionReturn(0); 3095f089877aSRichard Tran Mills } 3096f089877aSRichard Tran Mills 3097f089877aSRichard Tran Mills /*@ 3098bc0a1609SRichard Tran Mills DMLocalToLocalEnd - Maps from a local vector (including ghost points 3099bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 3100d78e899eSRichard Tran Mills points in the second are set correctly. Must be preceded by DMLocalToLocalBegin(). 3101f089877aSRichard Tran Mills 3102d083f849SBarry Smith Neighbor-wise Collective on dm 3103f089877aSRichard Tran Mills 3104f089877aSRichard Tran Mills Input Parameters: 3105bc0a1609SRichard Tran Mills + da - the DM object 3106bc0a1609SRichard Tran Mills . g - the original local vector 3107bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 3108f089877aSRichard Tran Mills 3109bc0a1609SRichard Tran Mills Output Parameter: 3110bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 3111f089877aSRichard Tran Mills 3112f089877aSRichard Tran Mills Level: intermediate 3113f089877aSRichard Tran Mills 3114bc0a1609SRichard Tran Mills Notes: 3115bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 3116bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 3117bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 3118bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 3119bc0a1609SRichard Tran Mills 3120bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 3121f089877aSRichard Tran Mills 3122f089877aSRichard Tran Mills @*/ 3123f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 3124f089877aSRichard Tran Mills { 3125f089877aSRichard Tran Mills PetscErrorCode ierr; 3126f089877aSRichard Tran Mills 3127f089877aSRichard Tran Mills PetscFunctionBegin; 3128f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3129bb358533SPatrick Sanan if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 3130f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 3131f089877aSRichard Tran Mills PetscFunctionReturn(0); 3132f089877aSRichard Tran Mills } 3133f089877aSRichard Tran Mills 313447c6ae99SBarry Smith /*@ 313547c6ae99SBarry Smith DMCoarsen - Coarsens a DM object 313647c6ae99SBarry Smith 3137d083f849SBarry Smith Collective on dm 313847c6ae99SBarry Smith 3139d8d19677SJose E. Roman Input Parameters: 314047c6ae99SBarry Smith + dm - the DM object 314191d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 314247c6ae99SBarry Smith 314347c6ae99SBarry Smith Output Parameter: 314447c6ae99SBarry Smith . dmc - the coarsened DM 314547c6ae99SBarry Smith 314647c6ae99SBarry Smith Level: developer 314747c6ae99SBarry Smith 3148e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 314947c6ae99SBarry Smith 315047c6ae99SBarry Smith @*/ 31517087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc) 315247c6ae99SBarry Smith { 315347c6ae99SBarry Smith PetscErrorCode ierr; 3154b17ce1afSJed Brown DMCoarsenHookLink link; 315547c6ae99SBarry Smith 315647c6ae99SBarry Smith PetscFunctionBegin; 3157171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3158b9d85ea2SLisandro Dalcin if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name); 315947a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 316047c6ae99SBarry Smith ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr); 3161b9d85ea2SLisandro Dalcin if (*dmc) { 3162a3574896SRichard Tran Mills (*dmc)->bind_below = dm->bind_below; /* Propagate this from parent DM; otherwise -dm_bind_below will be useless for multigrid cases. */ 3163a8fb8f29SToby Isaac ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr); 316443842a1eSJed Brown (*dmc)->ops->creatematrix = dm->ops->creatematrix; 31658cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr); 3166644e2e5bSBarry Smith (*dmc)->ctx = dm->ctx; 31670598a293SJed Brown (*dmc)->levelup = dm->levelup; 3168656b349aSBarry Smith (*dmc)->leveldown = dm->leveldown + 1; 3169e4b4b23bSJed Brown ierr = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr); 3170b17ce1afSJed Brown for (link=dm->coarsenhook; link; link=link->next) { 3171b17ce1afSJed Brown if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);} 3172b17ce1afSJed Brown } 3173b9d85ea2SLisandro Dalcin } 317447a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 3175b9d85ea2SLisandro Dalcin if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced"); 3176b17ce1afSJed Brown PetscFunctionReturn(0); 3177b17ce1afSJed Brown } 3178b17ce1afSJed Brown 3179bb9467b5SJed Brown /*@C 3180b17ce1afSJed Brown DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid 3181b17ce1afSJed Brown 3182b17ce1afSJed Brown Logically Collective 3183b17ce1afSJed Brown 31844165533cSJose E. Roman Input Parameters: 3185b17ce1afSJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 3186b17ce1afSJed Brown . coarsenhook - function to run when setting up a coarser level 3187b17ce1afSJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 31880298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3189b17ce1afSJed Brown 3190b17ce1afSJed Brown Calling sequence of coarsenhook: 3191b17ce1afSJed Brown $ coarsenhook(DM fine,DM coarse,void *ctx); 3192b17ce1afSJed Brown 3193b17ce1afSJed Brown + fine - fine level DM 3194b17ce1afSJed Brown . coarse - coarse level DM to restrict problem to 3195b17ce1afSJed Brown - ctx - optional user-defined function context 3196b17ce1afSJed Brown 3197b17ce1afSJed Brown Calling sequence for restricthook: 3198c833c3b5SJed Brown $ restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx) 3199b17ce1afSJed Brown 3200b17ce1afSJed Brown + fine - fine level DM 3201b17ce1afSJed Brown . mrestrict - matrix restricting a fine-level solution to the coarse grid 3202c833c3b5SJed Brown . rscale - scaling vector for restriction 3203c833c3b5SJed Brown . inject - matrix restricting by injection 3204b17ce1afSJed Brown . coarse - coarse level DM to update 3205b17ce1afSJed Brown - ctx - optional user-defined function context 3206b17ce1afSJed Brown 3207b17ce1afSJed Brown Level: advanced 3208b17ce1afSJed Brown 3209b17ce1afSJed Brown Notes: 3210b17ce1afSJed Brown This function is only needed if auxiliary data needs to be set up on coarse grids. 3211b17ce1afSJed Brown 3212b17ce1afSJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 3213b17ce1afSJed Brown 3214b17ce1afSJed Brown In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3215b17ce1afSJed Brown extract the finest level information from its context (instead of from the SNES). 3216b17ce1afSJed Brown 3217bb9467b5SJed Brown This function is currently not available from Fortran. 3218bb9467b5SJed Brown 3219dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3220b17ce1afSJed Brown @*/ 3221b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 3222b17ce1afSJed Brown { 3223b17ce1afSJed Brown PetscErrorCode ierr; 3224b17ce1afSJed Brown DMCoarsenHookLink link,*p; 3225b17ce1afSJed Brown 3226b17ce1afSJed Brown PetscFunctionBegin; 3227b17ce1afSJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 32281e3d8eccSJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 32291e3d8eccSJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 32301e3d8eccSJed Brown } 323195dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 3232b17ce1afSJed Brown link->coarsenhook = coarsenhook; 3233b17ce1afSJed Brown link->restricthook = restricthook; 3234b17ce1afSJed Brown link->ctx = ctx; 32350298fd71SBarry Smith link->next = NULL; 3236b17ce1afSJed Brown *p = link; 3237b17ce1afSJed Brown PetscFunctionReturn(0); 3238b17ce1afSJed Brown } 3239b17ce1afSJed Brown 3240dc822a44SJed Brown /*@C 3241dc822a44SJed Brown DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid 3242dc822a44SJed Brown 3243dc822a44SJed Brown Logically Collective 3244dc822a44SJed Brown 32454165533cSJose E. Roman Input Parameters: 3246dc822a44SJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 3247dc822a44SJed Brown . coarsenhook - function to run when setting up a coarser level 3248dc822a44SJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 3249dc822a44SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3250dc822a44SJed Brown 3251dc822a44SJed Brown Level: advanced 3252dc822a44SJed Brown 3253dc822a44SJed Brown Notes: 3254dc822a44SJed Brown This function does nothing if the hook is not in the list. 3255dc822a44SJed Brown 3256dc822a44SJed Brown This function is currently not available from Fortran. 3257dc822a44SJed Brown 3258dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3259dc822a44SJed Brown @*/ 3260dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 3261dc822a44SJed Brown { 3262dc822a44SJed Brown PetscErrorCode ierr; 3263dc822a44SJed Brown DMCoarsenHookLink link,*p; 3264dc822a44SJed Brown 3265dc822a44SJed Brown PetscFunctionBegin; 3266dc822a44SJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 3267dc822a44SJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3268dc822a44SJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3269dc822a44SJed Brown link = *p; 3270dc822a44SJed Brown *p = link->next; 3271dc822a44SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3272dc822a44SJed Brown break; 3273dc822a44SJed Brown } 3274dc822a44SJed Brown } 3275dc822a44SJed Brown PetscFunctionReturn(0); 3276dc822a44SJed Brown } 3277dc822a44SJed Brown 3278b17ce1afSJed Brown /*@ 3279b17ce1afSJed Brown DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd() 3280b17ce1afSJed Brown 3281b17ce1afSJed Brown Collective if any hooks are 3282b17ce1afSJed Brown 32834165533cSJose E. Roman Input Parameters: 3284b17ce1afSJed Brown + fine - finer DM to use as a base 3285b17ce1afSJed Brown . restrct - restriction matrix, apply using MatRestrict() 3286e91eccc2SStefano Zampini . rscale - scaling vector for restriction 3287b17ce1afSJed Brown . inject - injection matrix, also use MatRestrict() 3288e91eccc2SStefano Zampini - coarse - coarser DM to update 3289b17ce1afSJed Brown 3290b17ce1afSJed Brown Level: developer 3291b17ce1afSJed Brown 3292b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict() 3293b17ce1afSJed Brown @*/ 3294b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse) 3295b17ce1afSJed Brown { 3296b17ce1afSJed Brown PetscErrorCode ierr; 3297b17ce1afSJed Brown DMCoarsenHookLink link; 3298b17ce1afSJed Brown 3299b17ce1afSJed Brown PetscFunctionBegin; 3300b17ce1afSJed Brown for (link=fine->coarsenhook; link; link=link->next) { 33018865f1eaSKarl Rupp if (link->restricthook) { 33028865f1eaSKarl Rupp ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr); 33038865f1eaSKarl Rupp } 3304b17ce1afSJed Brown } 330547c6ae99SBarry Smith PetscFunctionReturn(0); 330647c6ae99SBarry Smith } 330747c6ae99SBarry Smith 3308bb9467b5SJed Brown /*@C 3309be081cd6SPeter Brune DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid 33105dbd56e3SPeter Brune 3311d083f849SBarry Smith Logically Collective on global 33125dbd56e3SPeter Brune 33134165533cSJose E. Roman Input Parameters: 33145dbd56e3SPeter Brune + global - global DM 3315ec4806b8SPeter Brune . ddhook - function to run to pass data to the decomposition DM upon its creation 33165dbd56e3SPeter Brune . restricthook - function to run to update data on block solve (at the beginning of the block solve) 33170298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 33185dbd56e3SPeter Brune 3319ec4806b8SPeter Brune Calling sequence for ddhook: 3320ec4806b8SPeter Brune $ ddhook(DM global,DM block,void *ctx) 3321ec4806b8SPeter Brune 3322ec4806b8SPeter Brune + global - global DM 3323ec4806b8SPeter Brune . block - block DM 3324ec4806b8SPeter Brune - ctx - optional user-defined function context 3325ec4806b8SPeter Brune 33265dbd56e3SPeter Brune Calling sequence for restricthook: 3327ec4806b8SPeter Brune $ restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx) 33285dbd56e3SPeter Brune 33295dbd56e3SPeter Brune + global - global DM 33305dbd56e3SPeter Brune . out - scatter to the outer (with ghost and overlap points) block vector 33315dbd56e3SPeter Brune . in - scatter to block vector values only owned locally 3332ec4806b8SPeter Brune . block - block DM 33335dbd56e3SPeter Brune - ctx - optional user-defined function context 33345dbd56e3SPeter Brune 33355dbd56e3SPeter Brune Level: advanced 33365dbd56e3SPeter Brune 33375dbd56e3SPeter Brune Notes: 3338ec4806b8SPeter Brune This function is only needed if auxiliary data needs to be set up on subdomain DMs. 33395dbd56e3SPeter Brune 33405dbd56e3SPeter Brune If this function is called multiple times, the hooks will be run in the order they are added. 33415dbd56e3SPeter Brune 33425dbd56e3SPeter Brune In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3343ec4806b8SPeter Brune extract the global information from its context (instead of from the SNES). 33445dbd56e3SPeter Brune 3345bb9467b5SJed Brown This function is currently not available from Fortran. 3346bb9467b5SJed Brown 33475dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 33485dbd56e3SPeter Brune @*/ 3349be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 33505dbd56e3SPeter Brune { 33515dbd56e3SPeter Brune PetscErrorCode ierr; 3352be081cd6SPeter Brune DMSubDomainHookLink link,*p; 33535dbd56e3SPeter Brune 33545dbd56e3SPeter Brune PetscFunctionBegin; 33555dbd56e3SPeter Brune PetscValidHeaderSpecific(global,DM_CLASSID,1); 3356b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 3357b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 3358b3a6b972SJed Brown } 335995dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 33605dbd56e3SPeter Brune link->restricthook = restricthook; 3361be081cd6SPeter Brune link->ddhook = ddhook; 33625dbd56e3SPeter Brune link->ctx = ctx; 33630298fd71SBarry Smith link->next = NULL; 33645dbd56e3SPeter Brune *p = link; 33655dbd56e3SPeter Brune PetscFunctionReturn(0); 33665dbd56e3SPeter Brune } 33675dbd56e3SPeter Brune 3368b3a6b972SJed Brown /*@C 3369b3a6b972SJed Brown DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid 3370b3a6b972SJed Brown 3371b3a6b972SJed Brown Logically Collective 3372b3a6b972SJed Brown 33734165533cSJose E. Roman Input Parameters: 3374b3a6b972SJed Brown + global - global DM 3375b3a6b972SJed Brown . ddhook - function to run to pass data to the decomposition DM upon its creation 3376b3a6b972SJed Brown . restricthook - function to run to update data on block solve (at the beginning of the block solve) 3377b3a6b972SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3378b3a6b972SJed Brown 3379b3a6b972SJed Brown Level: advanced 3380b3a6b972SJed Brown 3381b3a6b972SJed Brown Notes: 3382b3a6b972SJed Brown 3383b3a6b972SJed Brown This function is currently not available from Fortran. 3384b3a6b972SJed Brown 3385b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3386b3a6b972SJed Brown @*/ 3387b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 3388b3a6b972SJed Brown { 3389b3a6b972SJed Brown PetscErrorCode ierr; 3390b3a6b972SJed Brown DMSubDomainHookLink link,*p; 3391b3a6b972SJed Brown 3392b3a6b972SJed Brown PetscFunctionBegin; 3393b3a6b972SJed Brown PetscValidHeaderSpecific(global,DM_CLASSID,1); 3394b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3395b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3396b3a6b972SJed Brown link = *p; 3397b3a6b972SJed Brown *p = link->next; 3398b3a6b972SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3399b3a6b972SJed Brown break; 3400b3a6b972SJed Brown } 3401b3a6b972SJed Brown } 3402b3a6b972SJed Brown PetscFunctionReturn(0); 3403b3a6b972SJed Brown } 3404b3a6b972SJed Brown 34055dbd56e3SPeter Brune /*@ 3406be081cd6SPeter Brune DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd() 34075dbd56e3SPeter Brune 34085dbd56e3SPeter Brune Collective if any hooks are 34095dbd56e3SPeter Brune 34104165533cSJose E. Roman Input Parameters: 34115dbd56e3SPeter Brune + fine - finer DM to use as a base 3412be081cd6SPeter Brune . oscatter - scatter from domain global vector filling subdomain global vector with overlap 3413be081cd6SPeter Brune . gscatter - scatter from domain global vector filling subdomain local vector with ghosts 34145dbd56e3SPeter Brune - coarse - coarer DM to update 34155dbd56e3SPeter Brune 34165dbd56e3SPeter Brune Level: developer 34175dbd56e3SPeter Brune 34185dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict() 34195dbd56e3SPeter Brune @*/ 3420be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm) 34215dbd56e3SPeter Brune { 34225dbd56e3SPeter Brune PetscErrorCode ierr; 3423be081cd6SPeter Brune DMSubDomainHookLink link; 34245dbd56e3SPeter Brune 34255dbd56e3SPeter Brune PetscFunctionBegin; 3426be081cd6SPeter Brune for (link=global->subdomainhook; link; link=link->next) { 34278865f1eaSKarl Rupp if (link->restricthook) { 34288865f1eaSKarl Rupp ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr); 34298865f1eaSKarl Rupp } 34305dbd56e3SPeter Brune } 34315dbd56e3SPeter Brune PetscFunctionReturn(0); 34325dbd56e3SPeter Brune } 34335dbd56e3SPeter Brune 34345fe1f584SPeter Brune /*@ 34356a7d9d85SPeter Brune DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM. 34365fe1f584SPeter Brune 34375fe1f584SPeter Brune Not Collective 34385fe1f584SPeter Brune 34395fe1f584SPeter Brune Input Parameter: 34405fe1f584SPeter Brune . dm - the DM object 34415fe1f584SPeter Brune 34425fe1f584SPeter Brune Output Parameter: 34436a7d9d85SPeter Brune . level - number of coarsenings 34445fe1f584SPeter Brune 34455fe1f584SPeter Brune Level: developer 34465fe1f584SPeter Brune 34476a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 34485fe1f584SPeter Brune 34495fe1f584SPeter Brune @*/ 34505fe1f584SPeter Brune PetscErrorCode DMGetCoarsenLevel(DM dm,PetscInt *level) 34515fe1f584SPeter Brune { 34525fe1f584SPeter Brune PetscFunctionBegin; 34535fe1f584SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3454b9d85ea2SLisandro Dalcin PetscValidIntPointer(level,2); 34555fe1f584SPeter Brune *level = dm->leveldown; 34565fe1f584SPeter Brune PetscFunctionReturn(0); 34575fe1f584SPeter Brune } 34585fe1f584SPeter Brune 34599a64c4a8SMatthew G. Knepley /*@ 34609a64c4a8SMatthew G. Knepley DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM. 34619a64c4a8SMatthew G. Knepley 34629a64c4a8SMatthew G. Knepley Not Collective 34639a64c4a8SMatthew G. Knepley 34649a64c4a8SMatthew G. Knepley Input Parameters: 34659a64c4a8SMatthew G. Knepley + dm - the DM object 34669a64c4a8SMatthew G. Knepley - level - number of coarsenings 34679a64c4a8SMatthew G. Knepley 34689a64c4a8SMatthew G. Knepley Level: developer 34699a64c4a8SMatthew G. Knepley 34709a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 34719a64c4a8SMatthew G. Knepley @*/ 34729a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level) 34739a64c4a8SMatthew G. Knepley { 34749a64c4a8SMatthew G. Knepley PetscFunctionBegin; 34759a64c4a8SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 34769a64c4a8SMatthew G. Knepley dm->leveldown = level; 34779a64c4a8SMatthew G. Knepley PetscFunctionReturn(0); 34789a64c4a8SMatthew G. Knepley } 34799a64c4a8SMatthew G. Knepley 348047c6ae99SBarry Smith /*@C 348147c6ae99SBarry Smith DMRefineHierarchy - Refines a DM object, all levels at once 348247c6ae99SBarry Smith 3483d083f849SBarry Smith Collective on dm 348447c6ae99SBarry Smith 3485d8d19677SJose E. Roman Input Parameters: 348647c6ae99SBarry Smith + dm - the DM object 348747c6ae99SBarry Smith - nlevels - the number of levels of refinement 348847c6ae99SBarry Smith 348947c6ae99SBarry Smith Output Parameter: 349047c6ae99SBarry Smith . dmf - the refined DM hierarchy 349147c6ae99SBarry Smith 349247c6ae99SBarry Smith Level: developer 349347c6ae99SBarry Smith 3494e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 349547c6ae99SBarry Smith 349647c6ae99SBarry Smith @*/ 34977087cfbeSBarry Smith PetscErrorCode DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[]) 349847c6ae99SBarry Smith { 349947c6ae99SBarry Smith PetscErrorCode ierr; 350047c6ae99SBarry Smith 350147c6ae99SBarry Smith PetscFunctionBegin; 3502171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3503ce94432eSBarry Smith if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 350447c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 3505b9d85ea2SLisandro Dalcin PetscValidPointer(dmf,3); 350647c6ae99SBarry Smith if (dm->ops->refinehierarchy) { 350747c6ae99SBarry Smith ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr); 350847c6ae99SBarry Smith } else if (dm->ops->refine) { 350947c6ae99SBarry Smith PetscInt i; 351047c6ae99SBarry Smith 3511ce94432eSBarry Smith ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr); 351247c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3513ce94432eSBarry Smith ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr); 351447c6ae99SBarry Smith } 3515ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet"); 351647c6ae99SBarry Smith PetscFunctionReturn(0); 351747c6ae99SBarry Smith } 351847c6ae99SBarry Smith 351947c6ae99SBarry Smith /*@C 352047c6ae99SBarry Smith DMCoarsenHierarchy - Coarsens a DM object, all levels at once 352147c6ae99SBarry Smith 3522d083f849SBarry Smith Collective on dm 352347c6ae99SBarry Smith 3524d8d19677SJose E. Roman Input Parameters: 352547c6ae99SBarry Smith + dm - the DM object 352647c6ae99SBarry Smith - nlevels - the number of levels of coarsening 352747c6ae99SBarry Smith 352847c6ae99SBarry Smith Output Parameter: 352947c6ae99SBarry Smith . dmc - the coarsened DM hierarchy 353047c6ae99SBarry Smith 353147c6ae99SBarry Smith Level: developer 353247c6ae99SBarry Smith 3533e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 353447c6ae99SBarry Smith 353547c6ae99SBarry Smith @*/ 35367087cfbeSBarry Smith PetscErrorCode DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[]) 353747c6ae99SBarry Smith { 353847c6ae99SBarry Smith PetscErrorCode ierr; 353947c6ae99SBarry Smith 354047c6ae99SBarry Smith PetscFunctionBegin; 3541171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3542ce94432eSBarry Smith if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 354347c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 354447c6ae99SBarry Smith PetscValidPointer(dmc,3); 354547c6ae99SBarry Smith if (dm->ops->coarsenhierarchy) { 354647c6ae99SBarry Smith ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr); 354747c6ae99SBarry Smith } else if (dm->ops->coarsen) { 354847c6ae99SBarry Smith PetscInt i; 354947c6ae99SBarry Smith 3550ce94432eSBarry Smith ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr); 355147c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3552ce94432eSBarry Smith ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr); 355347c6ae99SBarry Smith } 3554ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet"); 355547c6ae99SBarry Smith PetscFunctionReturn(0); 355647c6ae99SBarry Smith } 355747c6ae99SBarry Smith 35581a266240SBarry Smith /*@C 35591a266240SBarry Smith DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed 35601a266240SBarry Smith 35611a266240SBarry Smith Not Collective 35621a266240SBarry Smith 35631a266240SBarry Smith Input Parameters: 35641a266240SBarry Smith + dm - the DM object 35651a266240SBarry Smith - destroy - the destroy function 35661a266240SBarry Smith 35671a266240SBarry Smith Level: intermediate 35681a266240SBarry Smith 3569e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 35701a266240SBarry Smith 3571f07f9ceaSJed Brown @*/ 35721a266240SBarry Smith PetscErrorCode DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**)) 35731a266240SBarry Smith { 35741a266240SBarry Smith PetscFunctionBegin; 3575171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35761a266240SBarry Smith dm->ctxdestroy = destroy; 35771a266240SBarry Smith PetscFunctionReturn(0); 35781a266240SBarry Smith } 35791a266240SBarry Smith 3580b07ff414SBarry Smith /*@ 35811b2093e4SBarry Smith DMSetApplicationContext - Set a user context into a DM object 358247c6ae99SBarry Smith 358347c6ae99SBarry Smith Not Collective 358447c6ae99SBarry Smith 358547c6ae99SBarry Smith Input Parameters: 358647c6ae99SBarry Smith + dm - the DM object 358747c6ae99SBarry Smith - ctx - the user context 358847c6ae99SBarry Smith 358947c6ae99SBarry Smith Level: intermediate 359047c6ae99SBarry Smith 3591e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 359247c6ae99SBarry Smith 359347c6ae99SBarry Smith @*/ 35941b2093e4SBarry Smith PetscErrorCode DMSetApplicationContext(DM dm,void *ctx) 359547c6ae99SBarry Smith { 359647c6ae99SBarry Smith PetscFunctionBegin; 3597171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 359847c6ae99SBarry Smith dm->ctx = ctx; 359947c6ae99SBarry Smith PetscFunctionReturn(0); 360047c6ae99SBarry Smith } 360147c6ae99SBarry Smith 360247c6ae99SBarry Smith /*@ 36031b2093e4SBarry Smith DMGetApplicationContext - Gets a user context from a DM object 360447c6ae99SBarry Smith 360547c6ae99SBarry Smith Not Collective 360647c6ae99SBarry Smith 360747c6ae99SBarry Smith Input Parameter: 360847c6ae99SBarry Smith . dm - the DM object 360947c6ae99SBarry Smith 361047c6ae99SBarry Smith Output Parameter: 361147c6ae99SBarry Smith . ctx - the user context 361247c6ae99SBarry Smith 361347c6ae99SBarry Smith Level: intermediate 361447c6ae99SBarry Smith 3615e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 361647c6ae99SBarry Smith 361747c6ae99SBarry Smith @*/ 36181b2093e4SBarry Smith PetscErrorCode DMGetApplicationContext(DM dm,void *ctx) 361947c6ae99SBarry Smith { 362047c6ae99SBarry Smith PetscFunctionBegin; 3621171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 36221b2093e4SBarry Smith *(void**)ctx = dm->ctx; 362347c6ae99SBarry Smith PetscFunctionReturn(0); 362447c6ae99SBarry Smith } 362547c6ae99SBarry Smith 362608da532bSDmitry Karpeev /*@C 3627df3898eeSBarry Smith DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI. 362808da532bSDmitry Karpeev 3629d083f849SBarry Smith Logically Collective on dm 363008da532bSDmitry Karpeev 3631d8d19677SJose E. Roman Input Parameters: 363208da532bSDmitry Karpeev + dm - the DM object 36330298fd71SBarry Smith - f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set) 363408da532bSDmitry Karpeev 363508da532bSDmitry Karpeev Level: intermediate 363608da532bSDmitry Karpeev 3637835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(), 363808da532bSDmitry Karpeev DMSetJacobian() 363908da532bSDmitry Karpeev 364008da532bSDmitry Karpeev @*/ 364108da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec)) 364208da532bSDmitry Karpeev { 364308da532bSDmitry Karpeev PetscFunctionBegin; 36445a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 364508da532bSDmitry Karpeev dm->ops->computevariablebounds = f; 364608da532bSDmitry Karpeev PetscFunctionReturn(0); 364708da532bSDmitry Karpeev } 364808da532bSDmitry Karpeev 364908da532bSDmitry Karpeev /*@ 365008da532bSDmitry Karpeev DMHasVariableBounds - does the DM object have a variable bounds function? 365108da532bSDmitry Karpeev 365208da532bSDmitry Karpeev Not Collective 365308da532bSDmitry Karpeev 365408da532bSDmitry Karpeev Input Parameter: 365508da532bSDmitry Karpeev . dm - the DM object to destroy 365608da532bSDmitry Karpeev 365708da532bSDmitry Karpeev Output Parameter: 365808da532bSDmitry Karpeev . flg - PETSC_TRUE if the variable bounds function exists 365908da532bSDmitry Karpeev 366008da532bSDmitry Karpeev Level: developer 366108da532bSDmitry Karpeev 366274e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 366308da532bSDmitry Karpeev 366408da532bSDmitry Karpeev @*/ 366508da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg) 366608da532bSDmitry Karpeev { 366708da532bSDmitry Karpeev PetscFunctionBegin; 36685a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3669534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 367008da532bSDmitry Karpeev *flg = (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE; 367108da532bSDmitry Karpeev PetscFunctionReturn(0); 367208da532bSDmitry Karpeev } 367308da532bSDmitry Karpeev 367408da532bSDmitry Karpeev /*@C 367508da532bSDmitry Karpeev DMComputeVariableBounds - compute variable bounds used by SNESVI. 367608da532bSDmitry Karpeev 3677d083f849SBarry Smith Logically Collective on dm 367808da532bSDmitry Karpeev 3679f899ff85SJose E. Roman Input Parameter: 3680907376e6SBarry Smith . dm - the DM object 368108da532bSDmitry Karpeev 368208da532bSDmitry Karpeev Output parameters: 368308da532bSDmitry Karpeev + xl - lower bound 368408da532bSDmitry Karpeev - xu - upper bound 368508da532bSDmitry Karpeev 3686907376e6SBarry Smith Level: advanced 3687907376e6SBarry Smith 368895452b02SPatrick Sanan Notes: 368995452b02SPatrick Sanan This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds() 369008da532bSDmitry Karpeev 369174e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 369208da532bSDmitry Karpeev 369308da532bSDmitry Karpeev @*/ 369408da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu) 369508da532bSDmitry Karpeev { 369608da532bSDmitry Karpeev PetscErrorCode ierr; 36975fd66863SKarl Rupp 369808da532bSDmitry Karpeev PetscFunctionBegin; 36995a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 370008da532bSDmitry Karpeev PetscValidHeaderSpecific(xl,VEC_CLASSID,2); 37015a84ad33SLisandro Dalcin PetscValidHeaderSpecific(xu,VEC_CLASSID,3); 3702b9d85ea2SLisandro Dalcin if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name); 370308da532bSDmitry Karpeev ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr); 370408da532bSDmitry Karpeev PetscFunctionReturn(0); 370508da532bSDmitry Karpeev } 370608da532bSDmitry Karpeev 3707b0ae01b7SPeter Brune /*@ 3708b0ae01b7SPeter Brune DMHasColoring - does the DM object have a method of providing a coloring? 3709b0ae01b7SPeter Brune 3710b0ae01b7SPeter Brune Not Collective 3711b0ae01b7SPeter Brune 3712b0ae01b7SPeter Brune Input Parameter: 3713b0ae01b7SPeter Brune . dm - the DM object 3714b0ae01b7SPeter Brune 3715b0ae01b7SPeter Brune Output Parameter: 3716b0ae01b7SPeter Brune . flg - PETSC_TRUE if the DM has facilities for DMCreateColoring(). 3717b0ae01b7SPeter Brune 3718b0ae01b7SPeter Brune Level: developer 3719b0ae01b7SPeter Brune 37201565f0a7SPatrick Sanan .seealso DMCreateColoring() 3721b0ae01b7SPeter Brune 3722b0ae01b7SPeter Brune @*/ 3723b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg) 3724b0ae01b7SPeter Brune { 3725b0ae01b7SPeter Brune PetscFunctionBegin; 37265a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3727534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 3728b0ae01b7SPeter Brune *flg = (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE; 3729b0ae01b7SPeter Brune PetscFunctionReturn(0); 3730b0ae01b7SPeter Brune } 3731b0ae01b7SPeter Brune 37323ad4599aSBarry Smith /*@ 37333ad4599aSBarry Smith DMHasCreateRestriction - does the DM object have a method of providing a restriction? 37343ad4599aSBarry Smith 37353ad4599aSBarry Smith Not Collective 37363ad4599aSBarry Smith 37373ad4599aSBarry Smith Input Parameter: 37383ad4599aSBarry Smith . dm - the DM object 37393ad4599aSBarry Smith 37403ad4599aSBarry Smith Output Parameter: 37413ad4599aSBarry Smith . flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction(). 37423ad4599aSBarry Smith 37433ad4599aSBarry Smith Level: developer 37443ad4599aSBarry Smith 37451565f0a7SPatrick Sanan .seealso DMCreateRestriction() 37463ad4599aSBarry Smith 37473ad4599aSBarry Smith @*/ 37483ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg) 37493ad4599aSBarry Smith { 37503ad4599aSBarry Smith PetscFunctionBegin; 37515a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3752534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 37533ad4599aSBarry Smith *flg = (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE; 37543ad4599aSBarry Smith PetscFunctionReturn(0); 37553ad4599aSBarry Smith } 37563ad4599aSBarry Smith 3757a7058e45SLawrence Mitchell /*@ 3758a7058e45SLawrence Mitchell DMHasCreateInjection - does the DM object have a method of providing an injection? 3759a7058e45SLawrence Mitchell 3760a7058e45SLawrence Mitchell Not Collective 3761a7058e45SLawrence Mitchell 3762a7058e45SLawrence Mitchell Input Parameter: 3763a7058e45SLawrence Mitchell . dm - the DM object 3764a7058e45SLawrence Mitchell 3765a7058e45SLawrence Mitchell Output Parameter: 3766a7058e45SLawrence Mitchell . flg - PETSC_TRUE if the DM has facilities for DMCreateInjection(). 3767a7058e45SLawrence Mitchell 3768a7058e45SLawrence Mitchell Level: developer 3769a7058e45SLawrence Mitchell 37701565f0a7SPatrick Sanan .seealso DMCreateInjection() 3771a7058e45SLawrence Mitchell 3772a7058e45SLawrence Mitchell @*/ 3773a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg) 3774a7058e45SLawrence Mitchell { 37754a7a4c06SLawrence Mitchell PetscErrorCode ierr; 37765a84ad33SLisandro Dalcin 3777a7058e45SLawrence Mitchell PetscFunctionBegin; 37785a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3779534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 37805a84ad33SLisandro Dalcin if (dm->ops->hascreateinjection) { 37814a7a4c06SLawrence Mitchell ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr); 37825a84ad33SLisandro Dalcin } else { 37835a84ad33SLisandro Dalcin *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE; 37845a84ad33SLisandro Dalcin } 3785a7058e45SLawrence Mitchell PetscFunctionReturn(0); 3786a7058e45SLawrence Mitchell } 3787a7058e45SLawrence Mitchell 37880298fd71SBarry Smith PetscFunctionList DMList = NULL; 3789264ace61SBarry Smith PetscBool DMRegisterAllCalled = PETSC_FALSE; 3790264ace61SBarry Smith 3791264ace61SBarry Smith /*@C 3792264ace61SBarry Smith DMSetType - Builds a DM, for a particular DM implementation. 3793264ace61SBarry Smith 3794d083f849SBarry Smith Collective on dm 3795264ace61SBarry Smith 3796264ace61SBarry Smith Input Parameters: 3797264ace61SBarry Smith + dm - The DM object 3798264ace61SBarry Smith - method - The name of the DM type 3799264ace61SBarry Smith 3800264ace61SBarry Smith Options Database Key: 3801264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types 3802264ace61SBarry Smith 3803264ace61SBarry Smith Notes: 3804e1589f56SBarry Smith See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D). 3805264ace61SBarry Smith 3806264ace61SBarry Smith Level: intermediate 3807264ace61SBarry Smith 3808264ace61SBarry Smith .seealso: DMGetType(), DMCreate() 3809264ace61SBarry Smith @*/ 381019fd82e9SBarry Smith PetscErrorCode DMSetType(DM dm, DMType method) 3811264ace61SBarry Smith { 3812264ace61SBarry Smith PetscErrorCode (*r)(DM); 3813264ace61SBarry Smith PetscBool match; 3814264ace61SBarry Smith PetscErrorCode ierr; 3815264ace61SBarry Smith 3816264ace61SBarry Smith PetscFunctionBegin; 3817264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3818251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr); 3819264ace61SBarry Smith if (match) PetscFunctionReturn(0); 3820264ace61SBarry Smith 38210f51fdf8SToby Isaac ierr = DMRegisterAll();CHKERRQ(ierr); 38221c9cd337SJed Brown ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr); 3823ce94432eSBarry Smith if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method); 3824264ace61SBarry Smith 3825264ace61SBarry Smith if (dm->ops->destroy) { 3826264ace61SBarry Smith ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr); 3827264ace61SBarry Smith } 3828d57f96a3SLisandro Dalcin ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr); 3829264ace61SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr); 3830d57f96a3SLisandro Dalcin ierr = (*r)(dm);CHKERRQ(ierr); 3831264ace61SBarry Smith PetscFunctionReturn(0); 3832264ace61SBarry Smith } 3833264ace61SBarry Smith 3834264ace61SBarry Smith /*@C 3835264ace61SBarry Smith DMGetType - Gets the DM type name (as a string) from the DM. 3836264ace61SBarry Smith 3837264ace61SBarry Smith Not Collective 3838264ace61SBarry Smith 3839264ace61SBarry Smith Input Parameter: 3840264ace61SBarry Smith . dm - The DM 3841264ace61SBarry Smith 3842264ace61SBarry Smith Output Parameter: 3843264ace61SBarry Smith . type - The DM type name 3844264ace61SBarry Smith 3845264ace61SBarry Smith Level: intermediate 3846264ace61SBarry Smith 3847264ace61SBarry Smith .seealso: DMSetType(), DMCreate() 3848264ace61SBarry Smith @*/ 384919fd82e9SBarry Smith PetscErrorCode DMGetType(DM dm, DMType *type) 3850264ace61SBarry Smith { 3851264ace61SBarry Smith PetscErrorCode ierr; 3852264ace61SBarry Smith 3853264ace61SBarry Smith PetscFunctionBegin; 3854264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3855c959eef4SJed Brown PetscValidPointer(type,2); 3856607a6623SBarry Smith ierr = DMRegisterAll();CHKERRQ(ierr); 3857264ace61SBarry Smith *type = ((PetscObject)dm)->type_name; 3858264ace61SBarry Smith PetscFunctionReturn(0); 3859264ace61SBarry Smith } 3860264ace61SBarry Smith 386167a56275SMatthew G Knepley /*@C 386267a56275SMatthew G Knepley DMConvert - Converts a DM to another DM, either of the same or different type. 386367a56275SMatthew G Knepley 3864d083f849SBarry Smith Collective on dm 386567a56275SMatthew G Knepley 386667a56275SMatthew G Knepley Input Parameters: 386767a56275SMatthew G Knepley + dm - the DM 386867a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type) 386967a56275SMatthew G Knepley 387067a56275SMatthew G Knepley Output Parameter: 387167a56275SMatthew G Knepley . M - pointer to new DM 387267a56275SMatthew G Knepley 387367a56275SMatthew G Knepley Notes: 387467a56275SMatthew G Knepley Cannot be used to convert a sequential DM to parallel or parallel to sequential, 387567a56275SMatthew G Knepley the MPI communicator of the generated DM is always the same as the communicator 387667a56275SMatthew G Knepley of the input DM. 387767a56275SMatthew G Knepley 387867a56275SMatthew G Knepley Level: intermediate 387967a56275SMatthew G Knepley 388067a56275SMatthew G Knepley .seealso: DMCreate() 388167a56275SMatthew G Knepley @*/ 388219fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M) 388367a56275SMatthew G Knepley { 388467a56275SMatthew G Knepley DM B; 388567a56275SMatthew G Knepley char convname[256]; 3886c067b6caSMatthew G. Knepley PetscBool sametype/*, issame */; 388767a56275SMatthew G Knepley PetscErrorCode ierr; 388867a56275SMatthew G Knepley 388967a56275SMatthew G Knepley PetscFunctionBegin; 389067a56275SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 389167a56275SMatthew G Knepley PetscValidType(dm,1); 389267a56275SMatthew G Knepley PetscValidPointer(M,3); 3893251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr); 3894c067b6caSMatthew G. Knepley /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */ 3895c067b6caSMatthew G. Knepley if (sametype) { 3896c067b6caSMatthew G. Knepley *M = dm; 3897c067b6caSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr); 3898c067b6caSMatthew G. Knepley PetscFunctionReturn(0); 3899c067b6caSMatthew G. Knepley } else { 39000298fd71SBarry Smith PetscErrorCode (*conv)(DM, DMType, DM*) = NULL; 390167a56275SMatthew G Knepley 390267a56275SMatthew G Knepley /* 390367a56275SMatthew G Knepley Order of precedence: 390467a56275SMatthew G Knepley 1) See if a specialized converter is known to the current DM. 390567a56275SMatthew G Knepley 2) See if a specialized converter is known to the desired DM class. 390667a56275SMatthew G Knepley 3) See if a good general converter is registered for the desired class 390767a56275SMatthew G Knepley 4) See if a good general converter is known for the current matrix. 390867a56275SMatthew G Knepley 5) Use a really basic converter. 390967a56275SMatthew G Knepley */ 391067a56275SMatthew G Knepley 391167a56275SMatthew G Knepley /* 1) See if a specialized converter is known to the current DM and the desired class */ 3912a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3913a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3914a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3915a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3916a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 39170005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr); 391867a56275SMatthew G Knepley if (conv) goto foundconv; 391967a56275SMatthew G Knepley 392067a56275SMatthew G Knepley /* 2) See if a specialized converter is known to the desired DM class. */ 392182f516ccSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr); 392267a56275SMatthew G Knepley ierr = DMSetType(B, newtype);CHKERRQ(ierr); 3923a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3924a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3925a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3926a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3927a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 39280005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr); 392967a56275SMatthew G Knepley if (conv) { 3930fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 393167a56275SMatthew G Knepley goto foundconv; 393267a56275SMatthew G Knepley } 393367a56275SMatthew G Knepley 393467a56275SMatthew G Knepley #if 0 393567a56275SMatthew G Knepley /* 3) See if a good general converter is registered for the desired class */ 393667a56275SMatthew G Knepley conv = B->ops->convertfrom; 3937fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 393867a56275SMatthew G Knepley if (conv) goto foundconv; 393967a56275SMatthew G Knepley 394067a56275SMatthew G Knepley /* 4) See if a good general converter is known for the current matrix */ 394167a56275SMatthew G Knepley if (dm->ops->convert) { 394267a56275SMatthew G Knepley conv = dm->ops->convert; 394367a56275SMatthew G Knepley } 394467a56275SMatthew G Knepley if (conv) goto foundconv; 394567a56275SMatthew G Knepley #endif 394667a56275SMatthew G Knepley 394767a56275SMatthew G Knepley /* 5) Use a really basic converter. */ 394882f516ccSBarry Smith SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype); 394967a56275SMatthew G Knepley 395067a56275SMatthew G Knepley foundconv: 395167a56275SMatthew G Knepley ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 395267a56275SMatthew G Knepley ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr); 395312fa691eSMatthew G. Knepley /* Things that are independent of DM type: We should consult DMClone() here */ 395490b157c4SStefano Zampini { 395590b157c4SStefano Zampini PetscBool isper; 395612fa691eSMatthew G. Knepley const PetscReal *maxCell, *L; 395712fa691eSMatthew G. Knepley const DMBoundaryType *bd; 395890b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 395990b157c4SStefano Zampini ierr = DMSetPeriodicity(*M, isper, maxCell, L, bd);CHKERRQ(ierr); 3960c8a6034eSMark (*M)->prealloc_only = dm->prealloc_only; 3961a587d139SMark ierr = PetscFree((*M)->vectype);CHKERRQ(ierr); 3962a587d139SMark ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr); 3963a587d139SMark ierr = PetscFree((*M)->mattype);CHKERRQ(ierr); 3964a587d139SMark ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr); 396512fa691eSMatthew G. Knepley } 396667a56275SMatthew G Knepley ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 396767a56275SMatthew G Knepley } 396867a56275SMatthew G Knepley ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr); 396967a56275SMatthew G Knepley PetscFunctionReturn(0); 397067a56275SMatthew G Knepley } 3971264ace61SBarry Smith 3972264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/ 3973264ace61SBarry Smith 3974264ace61SBarry Smith /*@C 39751c84c290SBarry Smith DMRegister - Adds a new DM component implementation 39761c84c290SBarry Smith 39771c84c290SBarry Smith Not Collective 39781c84c290SBarry Smith 39791c84c290SBarry Smith Input Parameters: 39801c84c290SBarry Smith + name - The name of a new user-defined creation routine 39811c84c290SBarry Smith - create_func - The creation routine itself 39821c84c290SBarry Smith 39831c84c290SBarry Smith Notes: 39841c84c290SBarry Smith DMRegister() may be called multiple times to add several user-defined DMs 39851c84c290SBarry Smith 39861c84c290SBarry Smith Sample usage: 39871c84c290SBarry Smith .vb 3988bdf89e91SBarry Smith DMRegister("my_da", MyDMCreate); 39891c84c290SBarry Smith .ve 39901c84c290SBarry Smith 39911c84c290SBarry Smith Then, your DM type can be chosen with the procedural interface via 39921c84c290SBarry Smith .vb 39931c84c290SBarry Smith DMCreate(MPI_Comm, DM *); 39941c84c290SBarry Smith DMSetType(DM,"my_da"); 39951c84c290SBarry Smith .ve 39961c84c290SBarry Smith or at runtime via the option 39971c84c290SBarry Smith .vb 39981c84c290SBarry Smith -da_type my_da 39991c84c290SBarry Smith .ve 4000264ace61SBarry Smith 4001264ace61SBarry Smith Level: advanced 40021c84c290SBarry Smith 4003bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy() 40041c84c290SBarry Smith 4005264ace61SBarry Smith @*/ 4006bdf89e91SBarry Smith PetscErrorCode DMRegister(const char sname[],PetscErrorCode (*function)(DM)) 4007264ace61SBarry Smith { 4008264ace61SBarry Smith PetscErrorCode ierr; 4009264ace61SBarry Smith 4010264ace61SBarry Smith PetscFunctionBegin; 40111d36bdfdSBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 4012a240a19fSJed Brown ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr); 4013264ace61SBarry Smith PetscFunctionReturn(0); 4014264ace61SBarry Smith } 4015264ace61SBarry Smith 4016b859378eSBarry Smith /*@C 401755849f57SBarry Smith DMLoad - Loads a DM that has been stored in binary with DMView(). 4018b859378eSBarry Smith 4019d083f849SBarry Smith Collective on viewer 4020b859378eSBarry Smith 4021b859378eSBarry Smith Input Parameters: 4022b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or 4023b859378eSBarry Smith some related function before a call to DMLoad(). 4024b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or 4025b859378eSBarry Smith HDF5 file viewer, obtained from PetscViewerHDF5Open() 4026b859378eSBarry Smith 4027b859378eSBarry Smith Level: intermediate 4028b859378eSBarry Smith 4029b859378eSBarry Smith Notes: 403055849f57SBarry Smith The type is determined by the data in the file, any type set into the DM before this call is ignored. 4031b859378eSBarry Smith 4032cd7e8a5eSksagiyam Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex 4033cd7e8a5eSksagiyam meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName() 4034cd7e8a5eSksagiyam before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object. 4035cd7e8a5eSksagiyam 4036b859378eSBarry Smith Notes for advanced users: 4037b859378eSBarry Smith Most users should not need to know the details of the binary storage 4038b859378eSBarry Smith format, since DMLoad() and DMView() completely hide these details. 4039b859378eSBarry Smith But for anyone who's interested, the standard binary matrix storage 4040b859378eSBarry Smith format is 4041b859378eSBarry Smith .vb 4042b859378eSBarry Smith has not yet been determined 4043b859378eSBarry Smith .ve 4044b859378eSBarry Smith 4045b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad() 4046b859378eSBarry Smith @*/ 4047b859378eSBarry Smith PetscErrorCode DMLoad(DM newdm, PetscViewer viewer) 4048b859378eSBarry Smith { 40499331c7a4SMatthew G. Knepley PetscBool isbinary, ishdf5; 4050b859378eSBarry Smith PetscErrorCode ierr; 4051b859378eSBarry Smith 4052b859378eSBarry Smith PetscFunctionBegin; 4053b859378eSBarry Smith PetscValidHeaderSpecific(newdm,DM_CLASSID,1); 4054b859378eSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 4055fb694a9eSVaclav Hapla ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr); 405632c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 40579331c7a4SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr); 405858cd63d5SVaclav Hapla ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr); 40599331c7a4SMatthew G. Knepley if (isbinary) { 40609331c7a4SMatthew G. Knepley PetscInt classid; 40619331c7a4SMatthew G. Knepley char type[256]; 4062b859378eSBarry Smith 4063060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 40649200755eSBarry Smith if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid); 4065060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 406632c0f0efSBarry Smith ierr = DMSetType(newdm, type);CHKERRQ(ierr); 40679331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 40689331c7a4SMatthew G. Knepley } else if (ishdf5) { 40699331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 40709331c7a4SMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()"); 407158cd63d5SVaclav Hapla ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr); 4072b859378eSBarry Smith PetscFunctionReturn(0); 4073b859378eSBarry Smith } 4074b859378eSBarry Smith 4075b2e4378dSMatthew G. Knepley /*@ 4076b2e4378dSMatthew G. Knepley DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process. 4077b2e4378dSMatthew G. Knepley 4078b2e4378dSMatthew G. Knepley Not collective 4079b2e4378dSMatthew G. Knepley 4080b2e4378dSMatthew G. Knepley Input Parameter: 4081b2e4378dSMatthew G. Knepley . dm - the DM 4082b2e4378dSMatthew G. Knepley 4083b2e4378dSMatthew G. Knepley Output Parameters: 4084b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional) 4085b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional) 4086b2e4378dSMatthew G. Knepley 4087b2e4378dSMatthew G. Knepley Level: beginner 4088b2e4378dSMatthew G. Knepley 4089b2e4378dSMatthew G. Knepley Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead. 4090b2e4378dSMatthew G. Knepley 4091b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox() 4092b2e4378dSMatthew G. Knepley @*/ 4093b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[]) 4094b2e4378dSMatthew G. Knepley { 4095b2e4378dSMatthew G. Knepley Vec coords = NULL; 4096b2e4378dSMatthew G. Knepley PetscReal min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL}; 4097b2e4378dSMatthew G. Knepley PetscReal max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL}; 4098b2e4378dSMatthew G. Knepley const PetscScalar *local_coords; 4099b2e4378dSMatthew G. Knepley PetscInt N, Ni; 4100b2e4378dSMatthew G. Knepley PetscInt cdim, i, j; 4101b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 4102b2e4378dSMatthew G. Knepley 4103b2e4378dSMatthew G. Knepley PetscFunctionBegin; 4104b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4105b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 4106b2e4378dSMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 4107b2e4378dSMatthew G. Knepley if (coords) { 4108b2e4378dSMatthew G. Knepley ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr); 4109b2e4378dSMatthew G. Knepley ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr); 4110b2e4378dSMatthew G. Knepley Ni = N/cdim; 4111b2e4378dSMatthew G. Knepley for (i = 0; i < Ni; ++i) { 4112b2e4378dSMatthew G. Knepley for (j = 0; j < 3; ++j) { 4113b2e4378dSMatthew G. Knepley min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 4114b2e4378dSMatthew G. Knepley max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 4115b2e4378dSMatthew G. Knepley } 4116b2e4378dSMatthew G. Knepley } 4117b2e4378dSMatthew G. Knepley ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr); 4118b2e4378dSMatthew G. Knepley } else { 4119b2e4378dSMatthew G. Knepley PetscBool isda; 4120b2e4378dSMatthew G. Knepley 4121b2e4378dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr); 4122b2e4378dSMatthew G. Knepley if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);} 4123b2e4378dSMatthew G. Knepley } 4124b2e4378dSMatthew G. Knepley if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);} 4125b2e4378dSMatthew G. Knepley if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);} 4126b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 4127b2e4378dSMatthew G. Knepley } 4128b2e4378dSMatthew G. Knepley 4129b2e4378dSMatthew G. Knepley /*@ 4130b2e4378dSMatthew G. Knepley DMGetBoundingBox - Returns the global bounding box for the DM. 4131b2e4378dSMatthew G. Knepley 4132b2e4378dSMatthew G. Knepley Collective 4133b2e4378dSMatthew G. Knepley 4134b2e4378dSMatthew G. Knepley Input Parameter: 4135b2e4378dSMatthew G. Knepley . dm - the DM 4136b2e4378dSMatthew G. Knepley 4137b2e4378dSMatthew G. Knepley Output Parameters: 4138b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional) 4139b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional) 4140b2e4378dSMatthew G. Knepley 4141b2e4378dSMatthew G. Knepley Level: beginner 4142b2e4378dSMatthew G. Knepley 4143b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal() 4144b2e4378dSMatthew G. Knepley @*/ 4145b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[]) 4146b2e4378dSMatthew G. Knepley { 4147b2e4378dSMatthew G. Knepley PetscReal lmin[3], lmax[3]; 41486ce308c4SMatthew G. Knepley PetscInt cdim; 41496ce308c4SMatthew G. Knepley PetscMPIInt count; 4150b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 4151b2e4378dSMatthew G. Knepley 4152b2e4378dSMatthew G. Knepley PetscFunctionBegin; 4153b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4154b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 4155b2e4378dSMatthew G. Knepley ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr); 4156b2e4378dSMatthew G. Knepley ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr); 4157820f2d46SBarry Smith if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);} 4158820f2d46SBarry Smith if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);} 4159b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 4160b2e4378dSMatthew G. Knepley } 4161b2e4378dSMatthew G. Knepley 41627da65231SMatthew G Knepley /******************************** FEM Support **********************************/ 41637da65231SMatthew G Knepley 4164a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[]) 4165a6dfd86eSKarl Rupp { 41661d47ebbbSSatish Balay PetscInt f; 41671b30c384SMatthew G Knepley PetscErrorCode ierr; 41681b30c384SMatthew G Knepley 41697da65231SMatthew G Knepley PetscFunctionBegin; 417074778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 41711d47ebbbSSatish Balay for (f = 0; f < len; ++f) { 417257622a8eSBarry Smith ierr = PetscPrintf(PETSC_COMM_SELF, " | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr); 41737da65231SMatthew G Knepley } 41747da65231SMatthew G Knepley PetscFunctionReturn(0); 41757da65231SMatthew G Knepley } 41767da65231SMatthew G Knepley 4177a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[]) 4178a6dfd86eSKarl Rupp { 41791b30c384SMatthew G Knepley PetscInt f, g; 41807da65231SMatthew G Knepley PetscErrorCode ierr; 41817da65231SMatthew G Knepley 41827da65231SMatthew G Knepley PetscFunctionBegin; 418374778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 41841d47ebbbSSatish Balay for (f = 0; f < rows; ++f) { 418574778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |");CHKERRQ(ierr); 41861d47ebbbSSatish Balay for (g = 0; g < cols; ++g) { 4187e3556bceSMatthew G. Knepley ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr); 41887da65231SMatthew G Knepley } 418974778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr); 41907da65231SMatthew G Knepley } 41917da65231SMatthew G Knepley PetscFunctionReturn(0); 41927da65231SMatthew G Knepley } 4193e7c4fc90SDmitry Karpeev 41946113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X) 4195e759306cSMatthew G. Knepley { 41960c5b8624SToby Isaac PetscInt localSize, bs; 41970c5b8624SToby Isaac PetscMPIInt size; 41980c5b8624SToby Isaac Vec x, xglob; 41990c5b8624SToby Isaac const PetscScalar *xarray; 4200e759306cSMatthew G. Knepley PetscErrorCode ierr; 4201e759306cSMatthew G. Knepley 4202e759306cSMatthew G. Knepley PetscFunctionBegin; 4203ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr); 4204e759306cSMatthew G. Knepley ierr = VecDuplicate(X, &x);CHKERRQ(ierr); 4205e759306cSMatthew G. Knepley ierr = VecCopy(X, x);CHKERRQ(ierr); 42066113b454SMatthew G. Knepley ierr = VecChop(x, tol);CHKERRQ(ierr); 42070c5b8624SToby Isaac ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr); 42080c5b8624SToby Isaac if (size > 1) { 42090c5b8624SToby Isaac ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr); 42100c5b8624SToby Isaac ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr); 42110c5b8624SToby Isaac ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 42120c5b8624SToby Isaac ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr); 42130c5b8624SToby Isaac } else { 42140c5b8624SToby Isaac xglob = x; 42150c5b8624SToby Isaac } 42160c5b8624SToby Isaac ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr); 42170c5b8624SToby Isaac if (size > 1) { 42180c5b8624SToby Isaac ierr = VecDestroy(&xglob);CHKERRQ(ierr); 42190c5b8624SToby Isaac ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr); 42200c5b8624SToby Isaac } 4221e759306cSMatthew G. Knepley ierr = VecDestroy(&x);CHKERRQ(ierr); 4222e759306cSMatthew G. Knepley PetscFunctionReturn(0); 4223e759306cSMatthew G. Knepley } 4224e759306cSMatthew G. Knepley 422588ed4aceSMatthew G Knepley /*@ 42261bb6d2a8SBarry Smith DMGetSection - Get the PetscSection encoding the local data layout for the DM. This is equivalent to DMGetLocalSection(). Deprecated in v3.12 4227061576a5SJed Brown 4228061576a5SJed Brown Input Parameter: 4229061576a5SJed Brown . dm - The DM 4230061576a5SJed Brown 4231061576a5SJed Brown Output Parameter: 4232061576a5SJed Brown . section - The PetscSection 4233061576a5SJed Brown 4234061576a5SJed Brown Options Database Keys: 4235061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM 4236061576a5SJed Brown 4237061576a5SJed Brown Level: advanced 4238061576a5SJed Brown 4239061576a5SJed Brown Notes: 4240061576a5SJed Brown Use DMGetLocalSection() in new code. 4241061576a5SJed Brown 4242061576a5SJed Brown This gets a borrowed reference, so the user should not destroy this PetscSection. 4243061576a5SJed Brown 4244061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection() 4245061576a5SJed Brown @*/ 4246061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section) 4247061576a5SJed Brown { 4248061576a5SJed Brown PetscErrorCode ierr; 4249061576a5SJed Brown 4250061576a5SJed Brown PetscFunctionBegin; 4251061576a5SJed Brown ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr); 4252061576a5SJed Brown PetscFunctionReturn(0); 4253061576a5SJed Brown } 4254061576a5SJed Brown 4255061576a5SJed Brown /*@ 4256061576a5SJed Brown DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM. 425788ed4aceSMatthew G Knepley 425888ed4aceSMatthew G Knepley Input Parameter: 425988ed4aceSMatthew G Knepley . dm - The DM 426088ed4aceSMatthew G Knepley 426188ed4aceSMatthew G Knepley Output Parameter: 426288ed4aceSMatthew G Knepley . section - The PetscSection 426388ed4aceSMatthew G Knepley 4264e5893cccSMatthew G. Knepley Options Database Keys: 4265e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM 4266e5893cccSMatthew G. Knepley 426788ed4aceSMatthew G Knepley Level: intermediate 426888ed4aceSMatthew G Knepley 426988ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 427088ed4aceSMatthew G Knepley 4271061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection() 427288ed4aceSMatthew G Knepley @*/ 4273061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section) 42740adebc6cSBarry Smith { 4275fd59a867SMatthew G. Knepley PetscErrorCode ierr; 4276fd59a867SMatthew G. Knepley 427788ed4aceSMatthew G Knepley PetscFunctionBegin; 427888ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 427988ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 42801bb6d2a8SBarry Smith if (!dm->localSection && dm->ops->createlocalsection) { 4281e5e52638SMatthew G. Knepley PetscInt d; 4282e5e52638SMatthew G. Knepley 428345480ffeSMatthew G. Knepley if (dm->setfromoptionscalled) { 428445480ffeSMatthew G. Knepley PetscObject obj = (PetscObject) dm; 428545480ffeSMatthew G. Knepley PetscViewer viewer; 428645480ffeSMatthew G. Knepley PetscViewerFormat format; 428745480ffeSMatthew G. Knepley PetscBool flg; 428845480ffeSMatthew G. Knepley 428945480ffeSMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr); 429045480ffeSMatthew G. Knepley if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);} 429145480ffeSMatthew G. Knepley for (d = 0; d < dm->Nds; ++d) { 429245480ffeSMatthew G. Knepley ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr); 429345480ffeSMatthew G. Knepley if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);} 429445480ffeSMatthew G. Knepley } 429545480ffeSMatthew G. Knepley if (flg) { 429645480ffeSMatthew G. Knepley ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 429745480ffeSMatthew G. Knepley ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 429845480ffeSMatthew G. Knepley ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 429945480ffeSMatthew G. Knepley } 430045480ffeSMatthew G. Knepley } 43011bb6d2a8SBarry Smith ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr); 43021bb6d2a8SBarry Smith if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);} 43032f0f8703SMatthew G. Knepley } 43041bb6d2a8SBarry Smith *section = dm->localSection; 430588ed4aceSMatthew G Knepley PetscFunctionReturn(0); 430688ed4aceSMatthew G Knepley } 430788ed4aceSMatthew G Knepley 430888ed4aceSMatthew G Knepley /*@ 43091bb6d2a8SBarry Smith DMSetSection - Set the PetscSection encoding the local data layout for the DM. This is equivalent to DMSetLocalSection(). Deprecated in v3.12 4310061576a5SJed Brown 4311061576a5SJed Brown Input Parameters: 4312061576a5SJed Brown + dm - The DM 4313061576a5SJed Brown - section - The PetscSection 4314061576a5SJed Brown 4315061576a5SJed Brown Level: advanced 4316061576a5SJed Brown 4317061576a5SJed Brown Notes: 4318061576a5SJed Brown Use DMSetLocalSection() in new code. 4319061576a5SJed Brown 4320061576a5SJed Brown Any existing Section will be destroyed 4321061576a5SJed Brown 4322061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection() 4323061576a5SJed Brown @*/ 4324061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section) 4325061576a5SJed Brown { 4326061576a5SJed Brown PetscErrorCode ierr; 4327061576a5SJed Brown 4328061576a5SJed Brown PetscFunctionBegin; 4329061576a5SJed Brown ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr); 4330061576a5SJed Brown PetscFunctionReturn(0); 4331061576a5SJed Brown } 4332061576a5SJed Brown 4333061576a5SJed Brown /*@ 4334061576a5SJed Brown DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM. 433588ed4aceSMatthew G Knepley 433688ed4aceSMatthew G Knepley Input Parameters: 433788ed4aceSMatthew G Knepley + dm - The DM 433888ed4aceSMatthew G Knepley - section - The PetscSection 433988ed4aceSMatthew G Knepley 434088ed4aceSMatthew G Knepley Level: intermediate 434188ed4aceSMatthew G Knepley 434288ed4aceSMatthew G Knepley Note: Any existing Section will be destroyed 434388ed4aceSMatthew G Knepley 4344061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection() 434588ed4aceSMatthew G Knepley @*/ 4346061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section) 43470adebc6cSBarry Smith { 4348c473ab19SMatthew G. Knepley PetscInt numFields = 0; 4349af122d2aSMatthew G Knepley PetscInt f; 435088ed4aceSMatthew G Knepley PetscErrorCode ierr; 435188ed4aceSMatthew G Knepley 435288ed4aceSMatthew G Knepley PetscFunctionBegin; 435388ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4354b9d85ea2SLisandro Dalcin if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 43551d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 43561bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr); 43571bb6d2a8SBarry Smith dm->localSection = section; 43581bb6d2a8SBarry Smith if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);} 4359af122d2aSMatthew G Knepley if (numFields) { 4360af122d2aSMatthew G Knepley ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr); 4361af122d2aSMatthew G Knepley for (f = 0; f < numFields; ++f) { 43620f21e855SMatthew G. Knepley PetscObject disc; 4363af122d2aSMatthew G Knepley const char *name; 4364af122d2aSMatthew G Knepley 43651bb6d2a8SBarry Smith ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr); 436644a7f3ddSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr); 43670f21e855SMatthew G. Knepley ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr); 4368af122d2aSMatthew G Knepley } 4369af122d2aSMatthew G Knepley } 4370e87a4003SBarry Smith /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */ 43711bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 437288ed4aceSMatthew G Knepley PetscFunctionReturn(0); 437388ed4aceSMatthew G Knepley } 437488ed4aceSMatthew G Knepley 43759435951eSToby Isaac /*@ 4376b7385021SStefano Zampini DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation. 43779435951eSToby Isaac 4378e228b242SToby Isaac not collective 4379e228b242SToby Isaac 43809435951eSToby Isaac Input Parameter: 43819435951eSToby Isaac . dm - The DM 43829435951eSToby Isaac 4383d8d19677SJose E. Roman Output Parameters: 43849435951eSToby 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. 43859435951eSToby 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. 43869435951eSToby Isaac 43879435951eSToby Isaac Level: advanced 43889435951eSToby Isaac 43899435951eSToby Isaac Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat. 43909435951eSToby Isaac 43919435951eSToby Isaac .seealso: DMSetDefaultConstraints() 43929435951eSToby Isaac @*/ 43939435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat) 43949435951eSToby Isaac { 43959435951eSToby Isaac PetscErrorCode ierr; 43969435951eSToby Isaac 43979435951eSToby Isaac PetscFunctionBegin; 43989435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 43999435951eSToby Isaac if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);} 440045a75d81SToby Isaac if (section) {*section = dm->defaultConstraintSection;} 440145a75d81SToby Isaac if (mat) {*mat = dm->defaultConstraintMat;} 44029435951eSToby Isaac PetscFunctionReturn(0); 44039435951eSToby Isaac } 44049435951eSToby Isaac 44059435951eSToby Isaac /*@ 4406b7385021SStefano Zampini DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation. 44079435951eSToby Isaac 44089435951eSToby 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(). 44099435951eSToby Isaac 44109435951eSToby 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. 44119435951eSToby Isaac 4412e228b242SToby Isaac collective on dm 4413e228b242SToby Isaac 44149435951eSToby Isaac Input Parameters: 44159435951eSToby Isaac + dm - The DM 4416e228b242SToby 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). 4417e228b242SToby 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). 44189435951eSToby Isaac 44199435951eSToby Isaac Level: advanced 44209435951eSToby Isaac 44219435951eSToby Isaac Note: This increments the references of the PetscSection and the Mat, so they user can destroy them 44229435951eSToby Isaac 44239435951eSToby Isaac .seealso: DMGetDefaultConstraints() 44249435951eSToby Isaac @*/ 44259435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat) 44269435951eSToby Isaac { 4427e228b242SToby Isaac PetscMPIInt result; 44289435951eSToby Isaac PetscErrorCode ierr; 44299435951eSToby Isaac 44309435951eSToby Isaac PetscFunctionBegin; 44319435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4432e228b242SToby Isaac if (section) { 4433e228b242SToby Isaac PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 4434ffc4695bSBarry Smith ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr); 4435f60917d2SBarry Smith if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator"); 4436e228b242SToby Isaac } 4437e228b242SToby Isaac if (mat) { 4438e228b242SToby Isaac PetscValidHeaderSpecific(mat,MAT_CLASSID,3); 4439ffc4695bSBarry Smith ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr); 4440f60917d2SBarry Smith if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator"); 4441e228b242SToby Isaac } 44429435951eSToby Isaac ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 44439435951eSToby Isaac ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr); 44449435951eSToby Isaac dm->defaultConstraintSection = section; 44459435951eSToby Isaac ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr); 44469435951eSToby Isaac ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr); 44479435951eSToby Isaac dm->defaultConstraintMat = mat; 44489435951eSToby Isaac PetscFunctionReturn(0); 44499435951eSToby Isaac } 44509435951eSToby Isaac 4451497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 4452507e4973SMatthew G. Knepley /* 4453507e4973SMatthew G. Knepley DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections. 4454507e4973SMatthew G. Knepley 4455507e4973SMatthew G. Knepley Input Parameters: 4456507e4973SMatthew G. Knepley + dm - The DM 4457507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout 4458507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout 4459507e4973SMatthew G. Knepley 4460507e4973SMatthew G. Knepley Level: intermediate 4461507e4973SMatthew G. Knepley 44621bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF() 4463507e4973SMatthew G. Knepley */ 4464f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection) 4465507e4973SMatthew G. Knepley { 4466507e4973SMatthew G. Knepley MPI_Comm comm; 4467507e4973SMatthew G. Knepley PetscLayout layout; 4468507e4973SMatthew G. Knepley const PetscInt *ranges; 4469507e4973SMatthew G. Knepley PetscInt pStart, pEnd, p, nroots; 4470507e4973SMatthew G. Knepley PetscMPIInt size, rank; 4471507e4973SMatthew G. Knepley PetscBool valid = PETSC_TRUE, gvalid; 4472507e4973SMatthew G. Knepley PetscErrorCode ierr; 4473507e4973SMatthew G. Knepley 4474507e4973SMatthew G. Knepley PetscFunctionBegin; 4475507e4973SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr); 4476507e4973SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4477ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 4478ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 4479507e4973SMatthew G. Knepley ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr); 4480507e4973SMatthew G. Knepley ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr); 4481507e4973SMatthew G. Knepley ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr); 4482507e4973SMatthew G. Knepley ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr); 4483507e4973SMatthew G. Knepley ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr); 4484507e4973SMatthew G. Knepley ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr); 4485507e4973SMatthew G. Knepley ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr); 4486507e4973SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 4487f741bcd2SMatthew G. Knepley PetscInt dof, cdof, off, gdof, gcdof, goff, gsize, d; 4488507e4973SMatthew G. Knepley 4489507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr); 4490507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr); 4491507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr); 4492507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 4493507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 4494507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr); 4495507e4973SMatthew G. Knepley if (!gdof) continue; /* Censored point */ 4496507e4973SMatthew 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;} 4497507e4973SMatthew 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;} 4498507e4973SMatthew G. Knepley if (gdof < 0) { 4499507e4973SMatthew G. Knepley gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 4500507e4973SMatthew G. Knepley for (d = 0; d < gsize; ++d) { 4501507e4973SMatthew G. Knepley PetscInt offset = -(goff+1) + d, r; 4502507e4973SMatthew G. Knepley 4503507e4973SMatthew G. Knepley ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr); 4504507e4973SMatthew G. Knepley if (r < 0) r = -(r+2); 4505507e4973SMatthew 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;} 4506507e4973SMatthew G. Knepley } 4507507e4973SMatthew G. Knepley } 4508507e4973SMatthew G. Knepley } 4509507e4973SMatthew G. Knepley ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr); 4510507e4973SMatthew G. Knepley ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr); 4511820f2d46SBarry Smith ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 4512507e4973SMatthew G. Knepley if (!gvalid) { 4513507e4973SMatthew G. Knepley ierr = DMView(dm, NULL);CHKERRQ(ierr); 4514507e4973SMatthew G. Knepley SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections"); 4515507e4973SMatthew G. Knepley } 4516507e4973SMatthew G. Knepley PetscFunctionReturn(0); 4517507e4973SMatthew G. Knepley } 4518f741bcd2SMatthew G. Knepley #endif 4519507e4973SMatthew G. Knepley 452088ed4aceSMatthew G Knepley /*@ 4521e87a4003SBarry Smith DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM. 452288ed4aceSMatthew G Knepley 4523d083f849SBarry Smith Collective on dm 45248b1ab98fSJed Brown 452588ed4aceSMatthew G Knepley Input Parameter: 452688ed4aceSMatthew G Knepley . dm - The DM 452788ed4aceSMatthew G Knepley 452888ed4aceSMatthew G Knepley Output Parameter: 452988ed4aceSMatthew G Knepley . section - The PetscSection 453088ed4aceSMatthew G Knepley 453188ed4aceSMatthew G Knepley Level: intermediate 453288ed4aceSMatthew G Knepley 453388ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 453488ed4aceSMatthew G Knepley 453592fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection() 453688ed4aceSMatthew G Knepley @*/ 4537e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section) 45380adebc6cSBarry Smith { 453988ed4aceSMatthew G Knepley PetscErrorCode ierr; 454088ed4aceSMatthew G Knepley 454188ed4aceSMatthew G Knepley PetscFunctionBegin; 454288ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 454388ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 45441bb6d2a8SBarry Smith if (!dm->globalSection) { 4545fd59a867SMatthew G. Knepley PetscSection s; 4546fd59a867SMatthew G. Knepley 454792fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 4548fd59a867SMatthew 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"); 454933907cc2SStefano Zampini if (!dm->sf) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection"); 45501bb6d2a8SBarry Smith ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr); 4551cf06b437SMatthew G. Knepley ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr); 45521bb6d2a8SBarry Smith ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr); 45531bb6d2a8SBarry Smith ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr); 455488ed4aceSMatthew G Knepley } 45551bb6d2a8SBarry Smith *section = dm->globalSection; 455688ed4aceSMatthew G Knepley PetscFunctionReturn(0); 455788ed4aceSMatthew G Knepley } 455888ed4aceSMatthew G Knepley 4559b21d0597SMatthew G Knepley /*@ 4560e87a4003SBarry Smith DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM. 4561b21d0597SMatthew G Knepley 4562b21d0597SMatthew G Knepley Input Parameters: 4563b21d0597SMatthew G Knepley + dm - The DM 45645080bbdbSMatthew G Knepley - section - The PetscSection, or NULL 4565b21d0597SMatthew G Knepley 4566b21d0597SMatthew G Knepley Level: intermediate 4567b21d0597SMatthew G Knepley 4568b21d0597SMatthew G Knepley Note: Any existing Section will be destroyed 4569b21d0597SMatthew G Knepley 457092fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection() 4571b21d0597SMatthew G Knepley @*/ 4572e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section) 45730adebc6cSBarry Smith { 4574b21d0597SMatthew G Knepley PetscErrorCode ierr; 4575b21d0597SMatthew G Knepley 4576b21d0597SMatthew G Knepley PetscFunctionBegin; 4577b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 45785080bbdbSMatthew G Knepley if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 45791d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 45801bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 45811bb6d2a8SBarry Smith dm->globalSection = section; 4582497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 45831bb6d2a8SBarry Smith if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);} 4584507e4973SMatthew G. Knepley #endif 4585b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4586b21d0597SMatthew G Knepley } 4587b21d0597SMatthew G Knepley 458888ed4aceSMatthew G Knepley /*@ 45891bb6d2a8SBarry Smith DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set, 459088ed4aceSMatthew G Knepley it is created from the default PetscSection layouts in the DM. 459188ed4aceSMatthew G Knepley 459288ed4aceSMatthew G Knepley Input Parameter: 459388ed4aceSMatthew G Knepley . dm - The DM 459488ed4aceSMatthew G Knepley 459588ed4aceSMatthew G Knepley Output Parameter: 459688ed4aceSMatthew G Knepley . sf - The PetscSF 459788ed4aceSMatthew G Knepley 459888ed4aceSMatthew G Knepley Level: intermediate 459988ed4aceSMatthew G Knepley 460088ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 460188ed4aceSMatthew G Knepley 46021bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF() 460388ed4aceSMatthew G Knepley @*/ 46041bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf) 46050adebc6cSBarry Smith { 460688ed4aceSMatthew G Knepley PetscInt nroots; 460788ed4aceSMatthew G Knepley PetscErrorCode ierr; 460888ed4aceSMatthew G Knepley 460988ed4aceSMatthew G Knepley PetscFunctionBegin; 461088ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 461188ed4aceSMatthew G Knepley PetscValidPointer(sf, 2); 46121bb6d2a8SBarry Smith if (!dm->sectionSF) { 46131bb6d2a8SBarry Smith ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr); 461433907cc2SStefano Zampini } 46151bb6d2a8SBarry Smith ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr); 461688ed4aceSMatthew G Knepley if (nroots < 0) { 461788ed4aceSMatthew G Knepley PetscSection section, gSection; 461888ed4aceSMatthew G Knepley 461992fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 462031ea6d37SMatthew G Knepley if (section) { 4621e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr); 46221bb6d2a8SBarry Smith ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr); 462331ea6d37SMatthew G Knepley } else { 46240298fd71SBarry Smith *sf = NULL; 462531ea6d37SMatthew G Knepley PetscFunctionReturn(0); 462631ea6d37SMatthew G Knepley } 462788ed4aceSMatthew G Knepley } 46281bb6d2a8SBarry Smith *sf = dm->sectionSF; 462988ed4aceSMatthew G Knepley PetscFunctionReturn(0); 463088ed4aceSMatthew G Knepley } 463188ed4aceSMatthew G Knepley 463288ed4aceSMatthew G Knepley /*@ 46331bb6d2a8SBarry Smith DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM 463488ed4aceSMatthew G Knepley 463588ed4aceSMatthew G Knepley Input Parameters: 463688ed4aceSMatthew G Knepley + dm - The DM 463788ed4aceSMatthew G Knepley - sf - The PetscSF 463888ed4aceSMatthew G Knepley 463988ed4aceSMatthew G Knepley Level: intermediate 464088ed4aceSMatthew G Knepley 464188ed4aceSMatthew G Knepley Note: Any previous SF is destroyed 464288ed4aceSMatthew G Knepley 46431bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF() 464488ed4aceSMatthew G Knepley @*/ 46451bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf) 46460adebc6cSBarry Smith { 464788ed4aceSMatthew G Knepley PetscErrorCode ierr; 464888ed4aceSMatthew G Knepley 464988ed4aceSMatthew G Knepley PetscFunctionBegin; 465088ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4651b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 465233907cc2SStefano Zampini ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 46531bb6d2a8SBarry Smith ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr); 46541bb6d2a8SBarry Smith dm->sectionSF = sf; 465588ed4aceSMatthew G Knepley PetscFunctionReturn(0); 465688ed4aceSMatthew G Knepley } 465788ed4aceSMatthew G Knepley 465888ed4aceSMatthew G Knepley /*@C 46591bb6d2a8SBarry Smith DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections 466088ed4aceSMatthew G Knepley describing the data layout. 466188ed4aceSMatthew G Knepley 466288ed4aceSMatthew G Knepley Input Parameters: 466388ed4aceSMatthew G Knepley + dm - The DM 466488ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout 466588ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout 466688ed4aceSMatthew G Knepley 46671bb6d2a8SBarry Smith Notes: One usually uses DMGetSectionSF() to obtain the PetscSF 466888ed4aceSMatthew G Knepley 46691bb6d2a8SBarry Smith Level: developer 46701bb6d2a8SBarry Smith 46711bb6d2a8SBarry Smith Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF 46721bb6d2a8SBarry Smith directly into the DM, perhaps this function should not take the local and global sections as 46731bb6d2a8SBarry Smith input and should just obtain them from the DM? 46741bb6d2a8SBarry Smith 46751bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection() 467688ed4aceSMatthew G Knepley @*/ 46771bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection) 467888ed4aceSMatthew G Knepley { 467988ed4aceSMatthew G Knepley PetscErrorCode ierr; 468088ed4aceSMatthew G Knepley 468188ed4aceSMatthew G Knepley PetscFunctionBegin; 468288ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4683b0c7db22SLisandro Dalcin ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr); 468488ed4aceSMatthew G Knepley PetscFunctionReturn(0); 468588ed4aceSMatthew G Knepley } 4686af122d2aSMatthew G Knepley 4687b21d0597SMatthew G Knepley /*@ 4688b21d0597SMatthew G Knepley DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM. 4689b21d0597SMatthew G Knepley 4690b21d0597SMatthew G Knepley Input Parameter: 4691b21d0597SMatthew G Knepley . dm - The DM 4692b21d0597SMatthew G Knepley 4693b21d0597SMatthew G Knepley Output Parameter: 4694b21d0597SMatthew G Knepley . sf - The PetscSF 4695b21d0597SMatthew G Knepley 4696b21d0597SMatthew G Knepley Level: intermediate 4697b21d0597SMatthew G Knepley 4698b21d0597SMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 4699b21d0597SMatthew G Knepley 47001bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4701b21d0597SMatthew G Knepley @*/ 47020adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf) 47030adebc6cSBarry Smith { 4704b21d0597SMatthew G Knepley PetscFunctionBegin; 4705b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4706b21d0597SMatthew G Knepley PetscValidPointer(sf, 2); 4707b21d0597SMatthew G Knepley *sf = dm->sf; 4708b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4709b21d0597SMatthew G Knepley } 4710b21d0597SMatthew G Knepley 4711057b4bcdSMatthew G Knepley /*@ 4712057b4bcdSMatthew G Knepley DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM. 4713057b4bcdSMatthew G Knepley 4714057b4bcdSMatthew G Knepley Input Parameters: 4715057b4bcdSMatthew G Knepley + dm - The DM 4716057b4bcdSMatthew G Knepley - sf - The PetscSF 4717057b4bcdSMatthew G Knepley 4718057b4bcdSMatthew G Knepley Level: intermediate 4719057b4bcdSMatthew G Knepley 47201bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4721057b4bcdSMatthew G Knepley @*/ 47220adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf) 47230adebc6cSBarry Smith { 4724057b4bcdSMatthew G Knepley PetscErrorCode ierr; 4725057b4bcdSMatthew G Knepley 4726057b4bcdSMatthew G Knepley PetscFunctionBegin; 4727057b4bcdSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4728b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 4729057b4bcdSMatthew G Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 473033907cc2SStefano Zampini ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr); 4731057b4bcdSMatthew G Knepley dm->sf = sf; 4732057b4bcdSMatthew G Knepley PetscFunctionReturn(0); 4733057b4bcdSMatthew G Knepley } 4734057b4bcdSMatthew G Knepley 47354f37162bSMatthew G. Knepley /*@ 47364f37162bSMatthew G. Knepley DMGetNaturalSF - Get the PetscSF encoding the map back to the original mesh ordering 47374f37162bSMatthew G. Knepley 47384f37162bSMatthew G. Knepley Input Parameter: 47394f37162bSMatthew G. Knepley . dm - The DM 47404f37162bSMatthew G. Knepley 47414f37162bSMatthew G. Knepley Output Parameter: 47424f37162bSMatthew G. Knepley . sf - The PetscSF 47434f37162bSMatthew G. Knepley 47444f37162bSMatthew G. Knepley Level: intermediate 47454f37162bSMatthew G. Knepley 47464f37162bSMatthew G. Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 47474f37162bSMatthew G. Knepley 47484f37162bSMatthew G. Knepley .seealso: DMSetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute() 47494f37162bSMatthew G. Knepley @*/ 47504f37162bSMatthew G. Knepley PetscErrorCode DMGetNaturalSF(DM dm, PetscSF *sf) 47514f37162bSMatthew G. Knepley { 47524f37162bSMatthew G. Knepley PetscFunctionBegin; 47534f37162bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 47544f37162bSMatthew G. Knepley PetscValidPointer(sf, 2); 47554f37162bSMatthew G. Knepley *sf = dm->sfNatural; 47564f37162bSMatthew G. Knepley PetscFunctionReturn(0); 47574f37162bSMatthew G. Knepley } 47584f37162bSMatthew G. Knepley 47594f37162bSMatthew G. Knepley /*@ 47604f37162bSMatthew G. Knepley DMSetNaturalSF - Set the PetscSF encoding the map back to the original mesh ordering 47614f37162bSMatthew G. Knepley 47624f37162bSMatthew G. Knepley Input Parameters: 47634f37162bSMatthew G. Knepley + dm - The DM 47644f37162bSMatthew G. Knepley - sf - The PetscSF 47654f37162bSMatthew G. Knepley 47664f37162bSMatthew G. Knepley Level: intermediate 47674f37162bSMatthew G. Knepley 47684f37162bSMatthew G. Knepley .seealso: DMGetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute() 47694f37162bSMatthew G. Knepley @*/ 47704f37162bSMatthew G. Knepley PetscErrorCode DMSetNaturalSF(DM dm, PetscSF sf) 47714f37162bSMatthew G. Knepley { 47724f37162bSMatthew G. Knepley PetscErrorCode ierr; 47734f37162bSMatthew G. Knepley 47744f37162bSMatthew G. Knepley PetscFunctionBegin; 47754f37162bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 47764f37162bSMatthew G. Knepley if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 47774f37162bSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 47784f37162bSMatthew G. Knepley ierr = PetscSFDestroy(&dm->sfNatural);CHKERRQ(ierr); 47794f37162bSMatthew G. Knepley dm->sfNatural = sf; 47804f37162bSMatthew G. Knepley PetscFunctionReturn(0); 47814f37162bSMatthew G. Knepley } 47824f37162bSMatthew G. Knepley 478334aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc) 478434aa8a36SMatthew G. Knepley { 478534aa8a36SMatthew G. Knepley PetscClassId id; 478634aa8a36SMatthew G. Knepley PetscErrorCode ierr; 478734aa8a36SMatthew G. Knepley 478834aa8a36SMatthew G. Knepley PetscFunctionBegin; 478934aa8a36SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 479034aa8a36SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 479134aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 479234aa8a36SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 479334aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr); 479417c1d62eSMatthew G. Knepley } else { 479517c1d62eSMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 479634aa8a36SMatthew G. Knepley } 479734aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 479834aa8a36SMatthew G. Knepley } 479934aa8a36SMatthew G. Knepley 480044a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew) 480144a7f3ddSMatthew G. Knepley { 480244a7f3ddSMatthew G. Knepley RegionField *tmpr; 480344a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf, f; 480444a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 480544a7f3ddSMatthew G. Knepley 480644a7f3ddSMatthew G. Knepley PetscFunctionBegin; 480744a7f3ddSMatthew G. Knepley if (Nf >= NfNew) PetscFunctionReturn(0); 480844a7f3ddSMatthew G. Knepley ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr); 480944a7f3ddSMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f]; 4810e0b68406SMatthew Knepley for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;} 481144a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 481244a7f3ddSMatthew G. Knepley dm->Nf = NfNew; 481344a7f3ddSMatthew G. Knepley dm->fields = tmpr; 481444a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 481544a7f3ddSMatthew G. Knepley } 481644a7f3ddSMatthew G. Knepley 481744a7f3ddSMatthew G. Knepley /*@ 481844a7f3ddSMatthew G. Knepley DMClearFields - Remove all fields from the DM 481944a7f3ddSMatthew G. Knepley 4820d083f849SBarry Smith Logically collective on dm 482144a7f3ddSMatthew G. Knepley 482244a7f3ddSMatthew G. Knepley Input Parameter: 482344a7f3ddSMatthew G. Knepley . dm - The DM 482444a7f3ddSMatthew G. Knepley 482544a7f3ddSMatthew G. Knepley Level: intermediate 482644a7f3ddSMatthew G. Knepley 482744a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField() 482844a7f3ddSMatthew G. Knepley @*/ 482944a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm) 483044a7f3ddSMatthew G. Knepley { 483144a7f3ddSMatthew G. Knepley PetscInt f; 483244a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 483344a7f3ddSMatthew G. Knepley 483444a7f3ddSMatthew G. Knepley PetscFunctionBegin; 483544a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 483644a7f3ddSMatthew G. Knepley for (f = 0; f < dm->Nf; ++f) { 483744a7f3ddSMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 483844a7f3ddSMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 483944a7f3ddSMatthew G. Knepley } 484044a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 484144a7f3ddSMatthew G. Knepley dm->fields = NULL; 484244a7f3ddSMatthew G. Knepley dm->Nf = 0; 484344a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 484444a7f3ddSMatthew G. Knepley } 484544a7f3ddSMatthew G. Knepley 4846689b5837SMatthew G. Knepley /*@ 4847689b5837SMatthew G. Knepley DMGetNumFields - Get the number of fields in the DM 4848689b5837SMatthew G. Knepley 4849689b5837SMatthew G. Knepley Not collective 4850689b5837SMatthew G. Knepley 4851689b5837SMatthew G. Knepley Input Parameter: 4852689b5837SMatthew G. Knepley . dm - The DM 4853689b5837SMatthew G. Knepley 4854689b5837SMatthew G. Knepley Output Parameter: 4855689b5837SMatthew G. Knepley . Nf - The number of fields 4856689b5837SMatthew G. Knepley 4857689b5837SMatthew G. Knepley Level: intermediate 4858689b5837SMatthew G. Knepley 4859689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField() 4860689b5837SMatthew G. Knepley @*/ 48610f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields) 48620f21e855SMatthew G. Knepley { 48630f21e855SMatthew G. Knepley PetscFunctionBegin; 48640f21e855SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4865534a8f05SLisandro Dalcin PetscValidIntPointer(numFields, 2); 486644a7f3ddSMatthew G. Knepley *numFields = dm->Nf; 4867af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4868af122d2aSMatthew G Knepley } 4869af122d2aSMatthew G Knepley 4870689b5837SMatthew G. Knepley /*@ 4871689b5837SMatthew G. Knepley DMSetNumFields - Set the number of fields in the DM 4872689b5837SMatthew G. Knepley 4873d083f849SBarry Smith Logically collective on dm 4874689b5837SMatthew G. Knepley 4875689b5837SMatthew G. Knepley Input Parameters: 4876689b5837SMatthew G. Knepley + dm - The DM 4877689b5837SMatthew G. Knepley - Nf - The number of fields 4878689b5837SMatthew G. Knepley 4879689b5837SMatthew G. Knepley Level: intermediate 4880689b5837SMatthew G. Knepley 4881689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField() 4882689b5837SMatthew G. Knepley @*/ 4883af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields) 4884af122d2aSMatthew G Knepley { 48850f21e855SMatthew G. Knepley PetscInt Nf, f; 4886af122d2aSMatthew G Knepley PetscErrorCode ierr; 4887af122d2aSMatthew G Knepley 4888af122d2aSMatthew G Knepley PetscFunctionBegin; 4889af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 489044a7f3ddSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 48910f21e855SMatthew G. Knepley for (f = Nf; f < numFields; ++f) { 48920f21e855SMatthew G. Knepley PetscContainer obj; 48930f21e855SMatthew G. Knepley 48940f21e855SMatthew G. Knepley ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr); 489544a7f3ddSMatthew G. Knepley ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr); 48960f21e855SMatthew G. Knepley ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr); 4897af122d2aSMatthew G Knepley } 4898af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4899af122d2aSMatthew G Knepley } 4900af122d2aSMatthew G Knepley 4901c1929be8SMatthew G. Knepley /*@ 4902c1929be8SMatthew G. Knepley DMGetField - Return the discretization object for a given DM field 4903c1929be8SMatthew G. Knepley 4904c1929be8SMatthew G. Knepley Not collective 4905c1929be8SMatthew G. Knepley 4906c1929be8SMatthew G. Knepley Input Parameters: 4907c1929be8SMatthew G. Knepley + dm - The DM 4908c1929be8SMatthew G. Knepley - f - The field number 4909c1929be8SMatthew G. Knepley 491044a7f3ddSMatthew G. Knepley Output Parameters: 491144a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh 491244a7f3ddSMatthew G. Knepley - field - The discretization object 4913c1929be8SMatthew G. Knepley 491444a7f3ddSMatthew G. Knepley Level: intermediate 4915c1929be8SMatthew G. Knepley 491644a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField() 4917c1929be8SMatthew G. Knepley @*/ 491844a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field) 4919af122d2aSMatthew G Knepley { 4920af122d2aSMatthew G Knepley PetscFunctionBegin; 4921af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4922064a246eSJacob Faibussowitsch PetscValidPointer(field, 4); 492344a7f3ddSMatthew G. Knepley if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf); 492444a7f3ddSMatthew G. Knepley if (label) *label = dm->fields[f].label; 492544a7f3ddSMatthew G. Knepley if (field) *field = dm->fields[f].disc; 4926decb47aaSMatthew G. Knepley PetscFunctionReturn(0); 4927decb47aaSMatthew G. Knepley } 4928decb47aaSMatthew G. Knepley 4929083401c6SMatthew G. Knepley /* Does not clear the DS */ 4930083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field) 4931083401c6SMatthew G. Knepley { 4932083401c6SMatthew G. Knepley PetscErrorCode ierr; 4933083401c6SMatthew G. Knepley 4934083401c6SMatthew G. Knepley PetscFunctionBegin; 4935083401c6SMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr); 4936083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 4937083401c6SMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 4938083401c6SMatthew G. Knepley dm->fields[f].label = label; 4939083401c6SMatthew G. Knepley dm->fields[f].disc = field; 4940083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 4941083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 4942083401c6SMatthew G. Knepley PetscFunctionReturn(0); 4943083401c6SMatthew G. Knepley } 4944083401c6SMatthew G. Knepley 4945c1929be8SMatthew G. Knepley /*@ 4946c1929be8SMatthew G. Knepley DMSetField - Set the discretization object for a given DM field 4947c1929be8SMatthew G. Knepley 4948d083f849SBarry Smith Logically collective on dm 4949c1929be8SMatthew G. Knepley 4950c1929be8SMatthew G. Knepley Input Parameters: 4951c1929be8SMatthew G. Knepley + dm - The DM 4952c1929be8SMatthew G. Knepley . f - The field number 495344a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 4954c1929be8SMatthew G. Knepley - field - The discretization object 4955c1929be8SMatthew G. Knepley 495644a7f3ddSMatthew G. Knepley Level: intermediate 4957c1929be8SMatthew G. Knepley 495844a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField() 4959c1929be8SMatthew G. Knepley @*/ 496044a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field) 4961decb47aaSMatthew G. Knepley { 4962decb47aaSMatthew G. Knepley PetscErrorCode ierr; 4963decb47aaSMatthew G. Knepley 4964decb47aaSMatthew G. Knepley PetscFunctionBegin; 4965decb47aaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4966e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3); 496744a7f3ddSMatthew G. Knepley PetscValidHeader(field, 4); 4968e5e52638SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 4969083401c6SMatthew G. Knepley ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr); 497034aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr); 49712df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 497244a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 497344a7f3ddSMatthew G. Knepley } 497444a7f3ddSMatthew G. Knepley 497544a7f3ddSMatthew G. Knepley /*@ 497644a7f3ddSMatthew G. Knepley DMAddField - Add the discretization object for the given DM field 497744a7f3ddSMatthew G. Knepley 4978d083f849SBarry Smith Logically collective on dm 497944a7f3ddSMatthew G. Knepley 498044a7f3ddSMatthew G. Knepley Input Parameters: 498144a7f3ddSMatthew G. Knepley + dm - The DM 498244a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 498344a7f3ddSMatthew G. Knepley - field - The discretization object 498444a7f3ddSMatthew G. Knepley 498544a7f3ddSMatthew G. Knepley Level: intermediate 498644a7f3ddSMatthew G. Knepley 498744a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField() 498844a7f3ddSMatthew G. Knepley @*/ 498944a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field) 499044a7f3ddSMatthew G. Knepley { 499144a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf; 499244a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 499344a7f3ddSMatthew G. Knepley 499444a7f3ddSMatthew G. Knepley PetscFunctionBegin; 499544a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4996064a246eSJacob Faibussowitsch if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 499744a7f3ddSMatthew G. Knepley PetscValidHeader(field, 3); 499844a7f3ddSMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr); 499944a7f3ddSMatthew G. Knepley dm->fields[Nf].label = label; 500044a7f3ddSMatthew G. Knepley dm->fields[Nf].disc = field; 500144a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 500244a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 500334aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr); 50042df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 5005af122d2aSMatthew G Knepley PetscFunctionReturn(0); 5006af122d2aSMatthew G Knepley } 50076636e97aSMatthew G Knepley 5008e5e52638SMatthew G. Knepley /*@ 5009e0b68406SMatthew Knepley DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells 5010e0b68406SMatthew Knepley 5011e0b68406SMatthew Knepley Logically collective on dm 5012e0b68406SMatthew Knepley 5013e0b68406SMatthew Knepley Input Parameters: 5014e0b68406SMatthew Knepley + dm - The DM 5015e0b68406SMatthew Knepley . f - The field index 5016e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells 5017e0b68406SMatthew Knepley 5018e0b68406SMatthew Knepley Level: intermediate 5019e0b68406SMatthew Knepley 5020e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField() 5021e0b68406SMatthew Knepley @*/ 5022e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor) 5023e0b68406SMatthew Knepley { 5024e0b68406SMatthew Knepley PetscFunctionBegin; 5025e0b68406SMatthew Knepley if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf); 5026e0b68406SMatthew Knepley dm->fields[f].avoidTensor = avoidTensor; 5027e0b68406SMatthew Knepley PetscFunctionReturn(0); 5028e0b68406SMatthew Knepley } 5029e0b68406SMatthew Knepley 5030e0b68406SMatthew Knepley /*@ 5031e0b68406SMatthew Knepley DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells 5032e0b68406SMatthew Knepley 5033e0b68406SMatthew Knepley Logically collective on dm 5034e0b68406SMatthew Knepley 5035e0b68406SMatthew Knepley Input Parameters: 5036e0b68406SMatthew Knepley + dm - The DM 5037e0b68406SMatthew Knepley - f - The field index 5038e0b68406SMatthew Knepley 5039e0b68406SMatthew Knepley Output Parameter: 5040e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells 5041e0b68406SMatthew Knepley 5042e0b68406SMatthew Knepley Level: intermediate 5043e0b68406SMatthew Knepley 5044e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField() 5045e0b68406SMatthew Knepley @*/ 5046e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor) 5047e0b68406SMatthew Knepley { 5048e0b68406SMatthew Knepley PetscFunctionBegin; 5049e0b68406SMatthew Knepley if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf); 5050e0b68406SMatthew Knepley *avoidTensor = dm->fields[f].avoidTensor; 5051e0b68406SMatthew Knepley PetscFunctionReturn(0); 5052e0b68406SMatthew Knepley } 5053e0b68406SMatthew Knepley 5054e0b68406SMatthew Knepley /*@ 5055e5e52638SMatthew G. Knepley DMCopyFields - Copy the discretizations for the DM into another DM 5056e5e52638SMatthew G. Knepley 5057d083f849SBarry Smith Collective on dm 5058e5e52638SMatthew G. Knepley 5059e5e52638SMatthew G. Knepley Input Parameter: 5060e5e52638SMatthew G. Knepley . dm - The DM 5061e5e52638SMatthew G. Knepley 5062e5e52638SMatthew G. Knepley Output Parameter: 5063e5e52638SMatthew G. Knepley . newdm - The DM 5064e5e52638SMatthew G. Knepley 5065e5e52638SMatthew G. Knepley Level: advanced 5066e5e52638SMatthew G. Knepley 5067e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS() 5068e5e52638SMatthew G. Knepley @*/ 5069e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm) 5070e5e52638SMatthew G. Knepley { 5071e5e52638SMatthew G. Knepley PetscInt Nf, f; 5072e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5073e5e52638SMatthew G. Knepley 5074e5e52638SMatthew G. Knepley PetscFunctionBegin; 5075e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 5076e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5077e5e52638SMatthew G. Knepley ierr = DMClearFields(newdm);CHKERRQ(ierr); 5078e5e52638SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5079e5e52638SMatthew G. Knepley DMLabel label; 5080e5e52638SMatthew G. Knepley PetscObject field; 508134aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 5082e5e52638SMatthew G. Knepley 5083e5e52638SMatthew G. Knepley ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr); 5084e5e52638SMatthew G. Knepley ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr); 508534aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr); 508634aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr); 508734aa8a36SMatthew G. Knepley } 508834aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 508934aa8a36SMatthew G. Knepley } 509034aa8a36SMatthew G. Knepley 509134aa8a36SMatthew G. Knepley /*@ 509234aa8a36SMatthew G. Knepley DMGetAdjacency - Returns the flags for determining variable influence 509334aa8a36SMatthew G. Knepley 509434aa8a36SMatthew G. Knepley Not collective 509534aa8a36SMatthew G. Knepley 509634aa8a36SMatthew G. Knepley Input Parameters: 509734aa8a36SMatthew G. Knepley + dm - The DM object 509834aa8a36SMatthew G. Knepley - f - The field number, or PETSC_DEFAULT for the default adjacency 509934aa8a36SMatthew G. Knepley 5100d8d19677SJose E. Roman Output Parameters: 510134aa8a36SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 510234aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 510334aa8a36SMatthew G. Knepley 510434aa8a36SMatthew G. Knepley Notes: 510534aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 510634aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 510734aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5108979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 510934aa8a36SMatthew G. Knepley 511034aa8a36SMatthew G. Knepley Level: developer 511134aa8a36SMatthew G. Knepley 511234aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField() 511334aa8a36SMatthew G. Knepley @*/ 511434aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure) 511534aa8a36SMatthew G. Knepley { 511634aa8a36SMatthew G. Knepley PetscFunctionBegin; 511734aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5118534a8f05SLisandro Dalcin if (useCone) PetscValidBoolPointer(useCone, 3); 5119534a8f05SLisandro Dalcin if (useClosure) PetscValidBoolPointer(useClosure, 4); 512034aa8a36SMatthew G. Knepley if (f < 0) { 512134aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->adjacency[0]; 512234aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->adjacency[1]; 512334aa8a36SMatthew G. Knepley } else { 512434aa8a36SMatthew G. Knepley PetscInt Nf; 512534aa8a36SMatthew G. Knepley PetscErrorCode ierr; 512634aa8a36SMatthew G. Knepley 512734aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 512834aa8a36SMatthew G. Knepley if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 512934aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->fields[f].adjacency[0]; 513034aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->fields[f].adjacency[1]; 513134aa8a36SMatthew G. Knepley } 513234aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 513334aa8a36SMatthew G. Knepley } 513434aa8a36SMatthew G. Knepley 513534aa8a36SMatthew G. Knepley /*@ 513634aa8a36SMatthew G. Knepley DMSetAdjacency - Set the flags for determining variable influence 513734aa8a36SMatthew G. Knepley 513834aa8a36SMatthew G. Knepley Not collective 513934aa8a36SMatthew G. Knepley 514034aa8a36SMatthew G. Knepley Input Parameters: 514134aa8a36SMatthew G. Knepley + dm - The DM object 514234aa8a36SMatthew G. Knepley . f - The field number 514334aa8a36SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 514434aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 514534aa8a36SMatthew G. Knepley 514634aa8a36SMatthew G. Knepley Notes: 514734aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 514834aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 514934aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5150979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 515134aa8a36SMatthew G. Knepley 515234aa8a36SMatthew G. Knepley Level: developer 515334aa8a36SMatthew G. Knepley 515434aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField() 515534aa8a36SMatthew G. Knepley @*/ 515634aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure) 515734aa8a36SMatthew G. Knepley { 515834aa8a36SMatthew G. Knepley PetscFunctionBegin; 515934aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 516034aa8a36SMatthew G. Knepley if (f < 0) { 516134aa8a36SMatthew G. Knepley dm->adjacency[0] = useCone; 516234aa8a36SMatthew G. Knepley dm->adjacency[1] = useClosure; 516334aa8a36SMatthew G. Knepley } else { 516434aa8a36SMatthew G. Knepley PetscInt Nf; 516534aa8a36SMatthew G. Knepley PetscErrorCode ierr; 516634aa8a36SMatthew G. Knepley 516734aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 516834aa8a36SMatthew G. Knepley if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 516934aa8a36SMatthew G. Knepley dm->fields[f].adjacency[0] = useCone; 517034aa8a36SMatthew G. Knepley dm->fields[f].adjacency[1] = useClosure; 5171e5e52638SMatthew G. Knepley } 5172e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5173e5e52638SMatthew G. Knepley } 5174e5e52638SMatthew G. Knepley 5175b0441da4SMatthew G. Knepley /*@ 5176b0441da4SMatthew G. Knepley DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined 5177b0441da4SMatthew G. Knepley 5178b0441da4SMatthew G. Knepley Not collective 5179b0441da4SMatthew G. Knepley 5180f899ff85SJose E. Roman Input Parameter: 5181b0441da4SMatthew G. Knepley . dm - The DM object 5182b0441da4SMatthew G. Knepley 5183d8d19677SJose E. Roman Output Parameters: 5184b0441da4SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 5185b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 5186b0441da4SMatthew G. Knepley 5187b0441da4SMatthew G. Knepley Notes: 5188b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 5189b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 5190b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5191b0441da4SMatthew G. Knepley 5192b0441da4SMatthew G. Knepley Level: developer 5193b0441da4SMatthew G. Knepley 5194b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField() 5195b0441da4SMatthew G. Knepley @*/ 5196b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure) 5197b0441da4SMatthew G. Knepley { 5198b0441da4SMatthew G. Knepley PetscInt Nf; 5199b0441da4SMatthew G. Knepley PetscErrorCode ierr; 5200b0441da4SMatthew G. Knepley 5201b0441da4SMatthew G. Knepley PetscFunctionBegin; 5202b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5203064a246eSJacob Faibussowitsch if (useCone) PetscValidBoolPointer(useCone, 2); 5204064a246eSJacob Faibussowitsch if (useClosure) PetscValidBoolPointer(useClosure, 3); 5205b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5206b0441da4SMatthew G. Knepley if (!Nf) { 5207b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 5208b0441da4SMatthew G. Knepley } else { 5209b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 5210b0441da4SMatthew G. Knepley } 5211b0441da4SMatthew G. Knepley PetscFunctionReturn(0); 5212b0441da4SMatthew G. Knepley } 5213b0441da4SMatthew G. Knepley 5214b0441da4SMatthew G. Knepley /*@ 5215b0441da4SMatthew G. Knepley DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined 5216b0441da4SMatthew G. Knepley 5217b0441da4SMatthew G. Knepley Not collective 5218b0441da4SMatthew G. Knepley 5219b0441da4SMatthew G. Knepley Input Parameters: 5220b0441da4SMatthew G. Knepley + dm - The DM object 5221b0441da4SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 5222b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 5223b0441da4SMatthew G. Knepley 5224b0441da4SMatthew G. Knepley Notes: 5225b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 5226b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 5227b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5228b0441da4SMatthew G. Knepley 5229b0441da4SMatthew G. Knepley Level: developer 5230b0441da4SMatthew G. Knepley 5231b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField() 5232b0441da4SMatthew G. Knepley @*/ 5233b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure) 5234b0441da4SMatthew G. Knepley { 5235b0441da4SMatthew G. Knepley PetscInt Nf; 5236b0441da4SMatthew G. Knepley PetscErrorCode ierr; 5237b0441da4SMatthew G. Knepley 5238b0441da4SMatthew G. Knepley PetscFunctionBegin; 5239b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5240b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5241b0441da4SMatthew G. Knepley if (!Nf) { 5242b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 5243b0441da4SMatthew G. Knepley } else { 5244b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 5245e5e52638SMatthew G. Knepley } 5246e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5247e5e52638SMatthew G. Knepley } 5248e5e52638SMatthew G. Knepley 5249783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */ 525045480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label) 5251783e2ec8SMatthew G. Knepley { 5252783e2ec8SMatthew G. Knepley PetscObject obj; 5253783e2ec8SMatthew G. Knepley PetscClassId id; 5254783e2ec8SMatthew G. Knepley PetscInt Nbd, bd; 5255783e2ec8SMatthew G. Knepley PetscBool isFE = PETSC_FALSE; 5256783e2ec8SMatthew G. Knepley PetscBool duplicate = PETSC_FALSE; 5257783e2ec8SMatthew G. Knepley PetscErrorCode ierr; 5258783e2ec8SMatthew G. Knepley 5259783e2ec8SMatthew G. Knepley PetscFunctionBegin; 5260783e2ec8SMatthew G. Knepley ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr); 5261783e2ec8SMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 5262783e2ec8SMatthew G. Knepley if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE; 5263783e2ec8SMatthew G. Knepley if (isFE && label) { 5264783e2ec8SMatthew G. Knepley /* Only want to modify label once */ 5265783e2ec8SMatthew G. Knepley ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr); 5266783e2ec8SMatthew G. Knepley for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) { 526745480ffeSMatthew G. Knepley DMLabel l; 5268783e2ec8SMatthew G. Knepley 526945480ffeSMatthew G. Knepley ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 527045480ffeSMatthew G. Knepley duplicate = l == label ? PETSC_TRUE : PETSC_FALSE; 5271783e2ec8SMatthew G. Knepley if (duplicate) break; 5272783e2ec8SMatthew G. Knepley } 5273783e2ec8SMatthew G. Knepley if (!duplicate) { 5274783e2ec8SMatthew G. Knepley DM plex; 5275783e2ec8SMatthew G. Knepley 5276783e2ec8SMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 5277783e2ec8SMatthew G. Knepley if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);} 5278783e2ec8SMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 5279783e2ec8SMatthew G. Knepley } 5280783e2ec8SMatthew G. Knepley } 5281783e2ec8SMatthew G. Knepley PetscFunctionReturn(0); 5282783e2ec8SMatthew G. Knepley } 5283783e2ec8SMatthew G. Knepley 5284e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew) 5285e5e52638SMatthew G. Knepley { 5286e5e52638SMatthew G. Knepley DMSpace *tmpd; 5287e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5288e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5289e5e52638SMatthew G. Knepley 5290e5e52638SMatthew G. Knepley PetscFunctionBegin; 5291e5e52638SMatthew G. Knepley if (Nds >= NdsNew) PetscFunctionReturn(0); 5292e5e52638SMatthew G. Knepley ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr); 5293e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s]; 5294b3cf3223SMatthew G. Knepley for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;} 5295e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 5296e5e52638SMatthew G. Knepley dm->Nds = NdsNew; 5297e5e52638SMatthew G. Knepley dm->probs = tmpd; 5298e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5299e5e52638SMatthew G. Knepley } 5300e5e52638SMatthew G. Knepley 5301e5e52638SMatthew G. Knepley /*@ 5302e5e52638SMatthew G. Knepley DMGetNumDS - Get the number of discrete systems in the DM 5303e5e52638SMatthew G. Knepley 5304e5e52638SMatthew G. Knepley Not collective 5305e5e52638SMatthew G. Knepley 5306e5e52638SMatthew G. Knepley Input Parameter: 5307e5e52638SMatthew G. Knepley . dm - The DM 5308e5e52638SMatthew G. Knepley 5309e5e52638SMatthew G. Knepley Output Parameter: 5310e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects 5311e5e52638SMatthew G. Knepley 5312e5e52638SMatthew G. Knepley Level: intermediate 5313e5e52638SMatthew G. Knepley 5314e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS() 5315e5e52638SMatthew G. Knepley @*/ 5316e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds) 5317e5e52638SMatthew G. Knepley { 5318e5e52638SMatthew G. Knepley PetscFunctionBegin; 5319e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5320534a8f05SLisandro Dalcin PetscValidIntPointer(Nds, 2); 5321e5e52638SMatthew G. Knepley *Nds = dm->Nds; 5322e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5323e5e52638SMatthew G. Knepley } 5324e5e52638SMatthew G. Knepley 5325e5e52638SMatthew G. Knepley /*@ 5326e5e52638SMatthew G. Knepley DMClearDS - Remove all discrete systems from the DM 5327e5e52638SMatthew G. Knepley 5328d083f849SBarry Smith Logically collective on dm 5329e5e52638SMatthew G. Knepley 5330e5e52638SMatthew G. Knepley Input Parameter: 5331e5e52638SMatthew G. Knepley . dm - The DM 5332e5e52638SMatthew G. Knepley 5333e5e52638SMatthew G. Knepley Level: intermediate 5334e5e52638SMatthew G. Knepley 5335e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField() 5336e5e52638SMatthew G. Knepley @*/ 5337e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm) 5338e5e52638SMatthew G. Knepley { 5339e5e52638SMatthew G. Knepley PetscInt s; 5340e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5341e5e52638SMatthew G. Knepley 5342e5e52638SMatthew G. Knepley PetscFunctionBegin; 5343e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5344e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5345e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5346e5e52638SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr); 5347b3cf3223SMatthew G. Knepley ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr); 5348e5e52638SMatthew G. Knepley } 5349e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 5350e5e52638SMatthew G. Knepley dm->probs = NULL; 5351e5e52638SMatthew G. Knepley dm->Nds = 0; 5352e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5353e5e52638SMatthew G. Knepley } 5354e5e52638SMatthew G. Knepley 5355e5e52638SMatthew G. Knepley /*@ 5356e5e52638SMatthew G. Knepley DMGetDS - Get the default PetscDS 5357e5e52638SMatthew G. Knepley 5358e5e52638SMatthew G. Knepley Not collective 5359e5e52638SMatthew G. Knepley 5360e5e52638SMatthew G. Knepley Input Parameter: 5361e5e52638SMatthew G. Knepley . dm - The DM 5362e5e52638SMatthew G. Knepley 5363e5e52638SMatthew G. Knepley Output Parameter: 5364e5e52638SMatthew G. Knepley . prob - The default PetscDS 5365e5e52638SMatthew G. Knepley 5366e5e52638SMatthew G. Knepley Level: intermediate 5367e5e52638SMatthew G. Knepley 5368e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS() 5369e5e52638SMatthew G. Knepley @*/ 5370e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob) 5371e5e52638SMatthew G. Knepley { 5372b0143b4dSMatthew G. Knepley PetscErrorCode ierr; 5373b0143b4dSMatthew G. Knepley 5374e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5375e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5376e5e52638SMatthew G. Knepley PetscValidPointer(prob, 2); 5377b0143b4dSMatthew G. Knepley if (dm->Nds <= 0) { 5378b0143b4dSMatthew G. Knepley PetscDS ds; 5379b0143b4dSMatthew G. Knepley 538045480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 5381b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr); 5382b0143b4dSMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 5383b0143b4dSMatthew G. Knepley } 5384b0143b4dSMatthew G. Knepley *prob = dm->probs[0].ds; 5385e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5386e5e52638SMatthew G. Knepley } 5387e5e52638SMatthew G. Knepley 5388e5e52638SMatthew G. Knepley /*@ 5389e5e52638SMatthew G. Knepley DMGetCellDS - Get the PetscDS defined on a given cell 5390e5e52638SMatthew G. Knepley 5391e5e52638SMatthew G. Knepley Not collective 5392e5e52638SMatthew G. Knepley 5393e5e52638SMatthew G. Knepley Input Parameters: 5394e5e52638SMatthew G. Knepley + dm - The DM 5395e5e52638SMatthew G. Knepley - point - Cell for the DS 5396e5e52638SMatthew G. Knepley 5397e5e52638SMatthew G. Knepley Output Parameter: 5398e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell 5399e5e52638SMatthew G. Knepley 5400e5e52638SMatthew G. Knepley Level: developer 5401e5e52638SMatthew G. Knepley 5402b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS() 5403e5e52638SMatthew G. Knepley @*/ 5404e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob) 5405e5e52638SMatthew G. Knepley { 5406e5e52638SMatthew G. Knepley PetscDS probDef = NULL; 5407e5e52638SMatthew G. Knepley PetscInt s; 5408e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5409e5e52638SMatthew G. Knepley 5410e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5411e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5412e5e52638SMatthew G. Knepley PetscValidPointer(prob, 3); 5413360cf244SMatthew G. Knepley if (point < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point); 5414e5e52638SMatthew G. Knepley *prob = NULL; 5415e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5416e5e52638SMatthew G. Knepley PetscInt val; 5417e5e52638SMatthew G. Knepley 5418e5e52638SMatthew G. Knepley if (!dm->probs[s].label) {probDef = dm->probs[s].ds;} 5419e5e52638SMatthew G. Knepley else { 5420e5e52638SMatthew G. Knepley ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr); 5421e5e52638SMatthew G. Knepley if (val >= 0) {*prob = dm->probs[s].ds; break;} 5422e5e52638SMatthew G. Knepley } 5423e5e52638SMatthew G. Knepley } 5424e5e52638SMatthew G. Knepley if (!*prob) *prob = probDef; 5425e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5426e5e52638SMatthew G. Knepley } 5427e5e52638SMatthew G. Knepley 5428e5e52638SMatthew G. Knepley /*@ 5429e5e52638SMatthew G. Knepley DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel 5430e5e52638SMatthew G. Knepley 5431e5e52638SMatthew G. Knepley Not collective 5432e5e52638SMatthew G. Knepley 5433e5e52638SMatthew G. Knepley Input Parameters: 5434e5e52638SMatthew G. Knepley + dm - The DM 5435e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh 5436e5e52638SMatthew G. Knepley 5437b3cf3223SMatthew G. Knepley Output Parameters: 5438b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5439b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL 5440e5e52638SMatthew G. Knepley 5441e5e52638SMatthew G. Knepley Note: If the label is missing, this function returns an error 5442e5e52638SMatthew G. Knepley 5443e5e52638SMatthew G. Knepley Level: advanced 5444e5e52638SMatthew G. Knepley 5445e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5446e5e52638SMatthew G. Knepley @*/ 5447b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds) 5448e5e52638SMatthew G. Knepley { 5449e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5450e5e52638SMatthew G. Knepley 5451e5e52638SMatthew G. Knepley PetscFunctionBegin; 5452e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5453e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5454b3cf3223SMatthew G. Knepley if (fields) {PetscValidPointer(fields, 3); *fields = NULL;} 5455b3cf3223SMatthew G. Knepley if (ds) {PetscValidPointer(ds, 4); *ds = NULL;} 5456e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5457b3cf3223SMatthew G. Knepley if (dm->probs[s].label == label) { 5458b3cf3223SMatthew G. Knepley if (fields) *fields = dm->probs[s].fields; 5459b3cf3223SMatthew G. Knepley if (ds) *ds = dm->probs[s].ds; 5460b3cf3223SMatthew G. Knepley PetscFunctionReturn(0); 5461b3cf3223SMatthew G. Knepley } 5462e5e52638SMatthew G. Knepley } 54632df9ee95SMatthew G. Knepley PetscFunctionReturn(0); 5464e5e52638SMatthew G. Knepley } 5465e5e52638SMatthew G. Knepley 5466e5e52638SMatthew G. Knepley /*@ 5467083401c6SMatthew G. Knepley DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel 5468083401c6SMatthew G. Knepley 5469083401c6SMatthew G. Knepley Collective on dm 5470083401c6SMatthew G. Knepley 5471083401c6SMatthew G. Knepley Input Parameters: 5472083401c6SMatthew G. Knepley + dm - The DM 5473083401c6SMatthew G. Knepley . label - The DMLabel defining the mesh region, or NULL for the entire mesh 5474083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields 5475083401c6SMatthew G. Knepley - prob - The PetscDS defined on the given cell 5476083401c6SMatthew G. Knepley 5477083401c6SMatthew G. Knepley Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. If DS is replaced, 5478083401c6SMatthew G. Knepley the fields argument is ignored. 5479083401c6SMatthew G. Knepley 5480083401c6SMatthew G. Knepley Level: advanced 5481083401c6SMatthew G. Knepley 5482083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS() 5483083401c6SMatthew G. Knepley @*/ 5484083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds) 5485083401c6SMatthew G. Knepley { 5486083401c6SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5487083401c6SMatthew G. Knepley PetscErrorCode ierr; 5488083401c6SMatthew G. Knepley 5489083401c6SMatthew G. Knepley PetscFunctionBegin; 5490083401c6SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5491083401c6SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5492064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4); 5493083401c6SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5494083401c6SMatthew G. Knepley if (dm->probs[s].label == label) { 5495083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5496083401c6SMatthew G. Knepley dm->probs[s].ds = ds; 5497083401c6SMatthew G. Knepley PetscFunctionReturn(0); 5498083401c6SMatthew G. Knepley } 5499083401c6SMatthew G. Knepley } 5500083401c6SMatthew G. Knepley ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr); 5501083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5502083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5503083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5504083401c6SMatthew G. Knepley if (!label) { 5505083401c6SMatthew G. Knepley /* Put the NULL label at the front, so it is returned as the default */ 5506083401c6SMatthew G. Knepley for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s]; 5507083401c6SMatthew G. Knepley Nds = 0; 5508083401c6SMatthew G. Knepley } 5509083401c6SMatthew G. Knepley dm->probs[Nds].label = label; 5510083401c6SMatthew G. Knepley dm->probs[Nds].fields = fields; 5511083401c6SMatthew G. Knepley dm->probs[Nds].ds = ds; 5512083401c6SMatthew G. Knepley PetscFunctionReturn(0); 5513083401c6SMatthew G. Knepley } 5514083401c6SMatthew G. Knepley 5515083401c6SMatthew G. Knepley /*@ 5516e5e52638SMatthew G. Knepley DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number 5517e5e52638SMatthew G. Knepley 5518e5e52638SMatthew G. Knepley Not collective 5519e5e52638SMatthew G. Knepley 5520e5e52638SMatthew G. Knepley Input Parameters: 5521e5e52638SMatthew G. Knepley + dm - The DM 5522e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds) 5523e5e52638SMatthew G. Knepley 5524e5e52638SMatthew G. Knepley Output Parameters: 5525b3cf3223SMatthew G. Knepley + label - The region label, or NULL 5526b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5527083401c6SMatthew G. Knepley - ds - The PetscDS defined on the given region, or NULL 5528e5e52638SMatthew G. Knepley 5529e5e52638SMatthew G. Knepley Level: advanced 5530e5e52638SMatthew G. Knepley 5531e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5532e5e52638SMatthew G. Knepley @*/ 5533b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds) 5534e5e52638SMatthew G. Knepley { 5535e5e52638SMatthew G. Knepley PetscInt Nds; 5536e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5537e5e52638SMatthew G. Knepley 5538e5e52638SMatthew G. Knepley PetscFunctionBegin; 5539e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5540e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 5541e5e52638SMatthew G. Knepley if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5542e5e52638SMatthew G. Knepley if (label) { 5543e5e52638SMatthew G. Knepley PetscValidPointer(label, 3); 5544e5e52638SMatthew G. Knepley *label = dm->probs[num].label; 5545e5e52638SMatthew G. Knepley } 5546b3cf3223SMatthew G. Knepley if (fields) { 5547b3cf3223SMatthew G. Knepley PetscValidPointer(fields, 4); 5548b3cf3223SMatthew G. Knepley *fields = dm->probs[num].fields; 5549b3cf3223SMatthew G. Knepley } 5550e5e52638SMatthew G. Knepley if (ds) { 5551b3cf3223SMatthew G. Knepley PetscValidPointer(ds, 5); 5552e5e52638SMatthew G. Knepley *ds = dm->probs[num].ds; 5553e5e52638SMatthew G. Knepley } 5554e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5555e5e52638SMatthew G. Knepley } 5556e5e52638SMatthew G. Knepley 5557e5e52638SMatthew G. Knepley /*@ 5558083401c6SMatthew G. Knepley DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number 5559e5e52638SMatthew G. Knepley 5560083401c6SMatthew G. Knepley Not collective 5561e5e52638SMatthew G. Knepley 5562e5e52638SMatthew G. Knepley Input Parameters: 5563e5e52638SMatthew G. Knepley + dm - The DM 5564083401c6SMatthew G. Knepley . num - The region number, in [0, Nds) 5565083401c6SMatthew G. Knepley . label - The region label, or NULL 5566083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting 5567083401c6SMatthew G. Knepley - ds - The PetscDS defined on the given region, or NULL to prevent setting 5568e5e52638SMatthew G. Knepley 5569e5e52638SMatthew G. Knepley Level: advanced 5570e5e52638SMatthew G. Knepley 5571083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5572e5e52638SMatthew G. Knepley @*/ 5573083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds) 5574e5e52638SMatthew G. Knepley { 5575083401c6SMatthew G. Knepley PetscInt Nds; 5576e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5577e5e52638SMatthew G. Knepley 5578e5e52638SMatthew G. Knepley PetscFunctionBegin; 5579e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5580083401c6SMatthew G. Knepley if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);} 5581083401c6SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 5582083401c6SMatthew G. Knepley if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5583e5e52638SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5584083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr); 5585083401c6SMatthew G. Knepley dm->probs[num].label = label; 5586083401c6SMatthew G. Knepley if (fields) { 5587083401c6SMatthew G. Knepley PetscValidHeaderSpecific(fields, IS_CLASSID, 4); 5588b3cf3223SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5589083401c6SMatthew G. Knepley ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr); 5590083401c6SMatthew G. Knepley dm->probs[num].fields = fields; 5591e5e52638SMatthew G. Knepley } 5592083401c6SMatthew G. Knepley if (ds) { 5593083401c6SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5); 5594083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5595083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr); 5596083401c6SMatthew G. Knepley dm->probs[num].ds = ds; 5597083401c6SMatthew G. Knepley } 5598e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5599e5e52638SMatthew G. Knepley } 5600e5e52638SMatthew G. Knepley 5601e5e52638SMatthew G. Knepley /*@ 56021d3af9e0SMatthew G. Knepley DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found. 56031d3af9e0SMatthew G. Knepley 56041d3af9e0SMatthew G. Knepley Not collective 56051d3af9e0SMatthew G. Knepley 56061d3af9e0SMatthew G. Knepley Input Parameters: 56071d3af9e0SMatthew G. Knepley + dm - The DM 56081d3af9e0SMatthew G. Knepley - ds - The PetscDS defined on the given region 56091d3af9e0SMatthew G. Knepley 56101d3af9e0SMatthew G. Knepley Output Parameter: 56111d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found 56121d3af9e0SMatthew G. Knepley 56131d3af9e0SMatthew G. Knepley Level: advanced 56141d3af9e0SMatthew G. Knepley 56151d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 56161d3af9e0SMatthew G. Knepley @*/ 56171d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num) 56181d3af9e0SMatthew G. Knepley { 56191d3af9e0SMatthew G. Knepley PetscInt Nds, n; 56201d3af9e0SMatthew G. Knepley PetscErrorCode ierr; 56211d3af9e0SMatthew G. Knepley 56221d3af9e0SMatthew G. Knepley PetscFunctionBegin; 56231d3af9e0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 56241d3af9e0SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2); 56251d3af9e0SMatthew G. Knepley PetscValidPointer(num, 3); 56261d3af9e0SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 56271d3af9e0SMatthew G. Knepley for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break; 56281d3af9e0SMatthew G. Knepley if (n >= Nds) *num = -1; 56291d3af9e0SMatthew G. Knepley else *num = n; 56301d3af9e0SMatthew G. Knepley PetscFunctionReturn(0); 56311d3af9e0SMatthew G. Knepley } 56321d3af9e0SMatthew G. Knepley 56331d3af9e0SMatthew G. Knepley /*@ 5634e5e52638SMatthew G. Knepley DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM 5635e5e52638SMatthew G. Knepley 5636d083f849SBarry Smith Collective on dm 5637e5e52638SMatthew G. Knepley 5638e5e52638SMatthew G. Knepley Input Parameter: 5639e5e52638SMatthew G. Knepley . dm - The DM 5640e5e52638SMatthew G. Knepley 564145480ffeSMatthew G. Knepley Options Database Keys: 564245480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM 564345480ffeSMatthew G. Knepley 5644e5e52638SMatthew G. Knepley Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. 5645e5e52638SMatthew G. Knepley 5646e5e52638SMatthew G. Knepley Level: intermediate 5647e5e52638SMatthew G. Knepley 5648e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 5649e5e52638SMatthew G. Knepley @*/ 5650e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm) 5651e5e52638SMatthew G. Knepley { 5652e5e52638SMatthew G. Knepley MPI_Comm comm; 5653083401c6SMatthew G. Knepley PetscDS dsDef; 5654083401c6SMatthew G. Knepley DMLabel *labelSet; 5655f9244615SMatthew G. Knepley PetscInt dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k; 5656f9244615SMatthew G. Knepley PetscBool doSetup = PETSC_TRUE, flg; 5657e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5658e5e52638SMatthew G. Knepley 5659e5e52638SMatthew G. Knepley PetscFunctionBegin; 5660e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5661e5e52638SMatthew G. Knepley if (!dm->fields) PetscFunctionReturn(0); 5662e5e52638SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr); 5663083401c6SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr); 5664083401c6SMatthew G. Knepley /* Determine how many regions we have */ 5665083401c6SMatthew G. Knepley ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr); 5666083401c6SMatthew G. Knepley Nl = 0; 5667083401c6SMatthew G. Knepley Ndef = 0; 5668083401c6SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5669083401c6SMatthew G. Knepley DMLabel label = dm->fields[f].label; 5670083401c6SMatthew G. Knepley PetscInt l; 5671083401c6SMatthew G. Knepley 5672f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 5673f918ec44SMatthew G. Knepley /* Move CEED context to discretizations */ 5674f918ec44SMatthew G. Knepley { 5675f918ec44SMatthew G. Knepley PetscClassId id; 5676f918ec44SMatthew G. Knepley 5677f918ec44SMatthew G. Knepley ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr); 5678f918ec44SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 5679f918ec44SMatthew G. Knepley Ceed ceed; 5680f918ec44SMatthew G. Knepley 5681f918ec44SMatthew G. Knepley ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr); 5682f918ec44SMatthew G. Knepley ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr); 5683f918ec44SMatthew G. Knepley } 5684f918ec44SMatthew G. Knepley } 5685f918ec44SMatthew G. Knepley #endif 5686083401c6SMatthew G. Knepley if (!label) {++Ndef; continue;} 5687083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break; 5688083401c6SMatthew G. Knepley if (l < Nl) continue; 5689083401c6SMatthew G. Knepley labelSet[Nl++] = label; 5690083401c6SMatthew G. Knepley } 5691083401c6SMatthew G. Knepley /* Create default DS if there are no labels to intersect with */ 5692083401c6SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr); 5693083401c6SMatthew G. Knepley if (!dsDef && Ndef && !Nl) { 5694b3cf3223SMatthew G. Knepley IS fields; 5695b3cf3223SMatthew G. Knepley PetscInt *fld, nf; 5696b3cf3223SMatthew G. Knepley 5697b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf; 5698*5fedec97SMatthew G. Knepley if (!nf) SETERRQ(comm, PETSC_ERR_PLIB, "All fields have labels, but we are trying to create a default DS"); 5699b3cf3223SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5700b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f; 570188f0c812SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 570288f0c812SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 570388f0c812SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 570488f0c812SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 570588f0c812SMatthew G. Knepley 570645480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr); 5707083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr); 5708083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr); 5709b3cf3223SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 57102df9ee95SMatthew G. Knepley } 5711083401c6SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr); 5712083401c6SMatthew G. Knepley if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);} 5713083401c6SMatthew G. Knepley /* Intersect labels with default fields */ 5714083401c6SMatthew G. Knepley if (Ndef && Nl) { 57150122748bSMatthew G. Knepley DM plex; 5716083401c6SMatthew G. Knepley DMLabel cellLabel; 5717083401c6SMatthew G. Knepley IS fieldIS, allcellIS, defcellIS = NULL; 5718083401c6SMatthew G. Knepley PetscInt *fields; 5719083401c6SMatthew G. Knepley const PetscInt *cells; 5720083401c6SMatthew G. Knepley PetscInt depth, nf = 0, n, c; 57210122748bSMatthew G. Knepley 57220122748bSMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 57230122748bSMatthew G. Knepley ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr); 5724083401c6SMatthew G. Knepley ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr); 5725083401c6SMatthew G. Knepley if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);} 5726*5fedec97SMatthew G. Knepley /* TODO This looks like it only works for one label */ 5727083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) { 5728083401c6SMatthew G. Knepley DMLabel label = labelSet[l]; 5729083401c6SMatthew G. Knepley IS pointIS; 5730083401c6SMatthew G. Knepley 5731083401c6SMatthew G. Knepley ierr = ISDestroy(&defcellIS);CHKERRQ(ierr); 5732083401c6SMatthew G. Knepley ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr); 5733083401c6SMatthew G. Knepley ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr); 5734083401c6SMatthew G. Knepley ierr = ISDestroy(&pointIS);CHKERRQ(ierr); 5735083401c6SMatthew G. Knepley } 5736083401c6SMatthew G. Knepley ierr = ISDestroy(&allcellIS);CHKERRQ(ierr); 5737083401c6SMatthew G. Knepley 5738083401c6SMatthew G. Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr); 5739083401c6SMatthew G. Knepley ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr); 5740083401c6SMatthew G. Knepley ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr); 5741083401c6SMatthew G. Knepley for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);} 5742083401c6SMatthew G. Knepley ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr); 5743083401c6SMatthew G. Knepley ierr = ISDestroy(&defcellIS);CHKERRQ(ierr); 5744083401c6SMatthew G. Knepley ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr); 5745083401c6SMatthew G. Knepley 5746083401c6SMatthew G. Knepley ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr); 5747083401c6SMatthew G. Knepley for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f; 5748083401c6SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr); 5749083401c6SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr); 5750083401c6SMatthew G. Knepley ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr); 5751083401c6SMatthew G. Knepley ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr); 5752083401c6SMatthew G. Knepley 575345480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr); 5754083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr); 5755083401c6SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr); 5756*5fedec97SMatthew G. Knepley ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr); 5757083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr); 5758083401c6SMatthew G. Knepley ierr = ISDestroy(&fieldIS);CHKERRQ(ierr); 57590122748bSMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 5760083401c6SMatthew G. Knepley } 5761083401c6SMatthew G. Knepley /* Create label DSes 5762083401c6SMatthew G. Knepley - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS 5763083401c6SMatthew G. Knepley */ 5764083401c6SMatthew G. Knepley /* TODO Should check that labels are disjoint */ 5765083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) { 5766083401c6SMatthew G. Knepley DMLabel label = labelSet[l]; 5767083401c6SMatthew G. Knepley PetscDS ds; 5768083401c6SMatthew G. Knepley IS fields; 5769083401c6SMatthew G. Knepley PetscInt *fld, nf; 5770083401c6SMatthew G. Knepley 577145480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 5772083401c6SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf; 5773083401c6SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5774083401c6SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f; 5775083401c6SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 5776083401c6SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 5777083401c6SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 5778083401c6SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 5779083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr); 5780083401c6SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 5781083401c6SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr); 5782083401c6SMatthew G. Knepley { 5783083401c6SMatthew G. Knepley DMPolytopeType ct; 5784083401c6SMatthew G. Knepley PetscInt lStart, lEnd; 5785*5fedec97SMatthew G. Knepley PetscBool isCohesiveLocal = PETSC_FALSE, isCohesive; 57860122748bSMatthew G. Knepley 5787e5e52638SMatthew G. Knepley ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr); 5788665f567fSMatthew G. Knepley if (lStart >= 0) { 5789412e9a14SMatthew G. Knepley ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr); 5790412e9a14SMatthew G. Knepley switch (ct) { 5791412e9a14SMatthew G. Knepley case DM_POLYTOPE_POINT_PRISM_TENSOR: 5792412e9a14SMatthew G. Knepley case DM_POLYTOPE_SEG_PRISM_TENSOR: 5793412e9a14SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM_TENSOR: 5794412e9a14SMatthew G. Knepley case DM_POLYTOPE_QUAD_PRISM_TENSOR: 5795*5fedec97SMatthew G. Knepley isCohesiveLocal = PETSC_TRUE;break; 5796083401c6SMatthew G. Knepley default: break; 5797412e9a14SMatthew G. Knepley } 5798665f567fSMatthew G. Knepley } 5799*5fedec97SMatthew G. Knepley ierr = MPI_Allreduce(&isCohesiveLocal, &isCohesive, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr); 5800*5fedec97SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) { 5801*5fedec97SMatthew G. Knepley if (label == dm->fields[f].label || !dm->fields[f].label) { 5802*5fedec97SMatthew G. Knepley if (label == dm->fields[f].label) { 5803*5fedec97SMatthew G. Knepley ierr = PetscDSSetDiscretization(ds, nf, NULL);CHKERRQ(ierr); 5804*5fedec97SMatthew G. Knepley ierr = PetscDSSetCohesive(ds, nf, isCohesive);CHKERRQ(ierr); 5805*5fedec97SMatthew G. Knepley } 5806*5fedec97SMatthew G. Knepley ++nf; 5807*5fedec97SMatthew G. Knepley } 5808*5fedec97SMatthew G. Knepley } 5809e5e52638SMatthew G. Knepley } 5810083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 5811e5e52638SMatthew G. Knepley } 5812083401c6SMatthew G. Knepley ierr = PetscFree(labelSet);CHKERRQ(ierr); 5813e5e52638SMatthew G. Knepley /* Set fields in DSes */ 5814083401c6SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5815083401c6SMatthew G. Knepley PetscDS ds = dm->probs[s].ds; 5816083401c6SMatthew G. Knepley IS fields = dm->probs[s].fields; 5817083401c6SMatthew G. Knepley const PetscInt *fld; 5818*5fedec97SMatthew G. Knepley PetscInt nf, dsnf; 5819*5fedec97SMatthew G. Knepley PetscBool isCohesive; 5820e5e52638SMatthew G. Knepley 5821*5fedec97SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsnf);CHKERRQ(ierr); 5822*5fedec97SMatthew G. Knepley ierr = PetscDSIsCohesive(ds, &isCohesive);CHKERRQ(ierr); 5823083401c6SMatthew G. Knepley ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr); 5824083401c6SMatthew G. Knepley ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr); 5825083401c6SMatthew G. Knepley for (f = 0; f < nf; ++f) { 5826083401c6SMatthew G. Knepley PetscObject disc = dm->fields[fld[f]].disc; 5827*5fedec97SMatthew G. Knepley PetscBool isCohesiveField; 5828e5e52638SMatthew G. Knepley PetscClassId id; 5829e5e52638SMatthew G. Knepley 5830*5fedec97SMatthew G. Knepley /* Handle DS with no fields */ 5831*5fedec97SMatthew G. Knepley if (dsnf) {ierr = PetscDSGetCohesive(ds, f, &isCohesiveField);CHKERRQ(ierr);} 5832*5fedec97SMatthew G. Knepley /* If this is a cohesive cell, then regular fields need the lower dimensional discretization */ 5833*5fedec97SMatthew G. Knepley if (isCohesive && !isCohesiveField) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);} 5834083401c6SMatthew G. Knepley ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr); 5835083401c6SMatthew G. Knepley /* We allow people to have placeholder fields and construct the Section by hand */ 5836e5e52638SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 5837e5e52638SMatthew G. Knepley if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE; 5838e5e52638SMatthew G. Knepley } 5839083401c6SMatthew G. Knepley ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr); 5840e5e52638SMatthew G. Knepley } 5841f9244615SMatthew G. Knepley /* Allow k-jet tabulation */ 5842f9244615SMatthew G. Knepley ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr); 5843f9244615SMatthew G. Knepley if (flg) { 58443b4aee56SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 58453b4aee56SMatthew G. Knepley PetscDS ds = dm->probs[s].ds; 58463b4aee56SMatthew G. Knepley PetscInt Nf, f; 58473b4aee56SMatthew G. Knepley 58483b4aee56SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr); 58493b4aee56SMatthew G. Knepley for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);} 58503b4aee56SMatthew G. Knepley } 5851f9244615SMatthew G. Knepley } 5852e5e52638SMatthew G. Knepley /* Setup DSes */ 5853e5e52638SMatthew G. Knepley if (doSetup) { 5854e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);} 5855e5e52638SMatthew G. Knepley } 5856e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5857e5e52638SMatthew G. Knepley } 5858e5e52638SMatthew G. Knepley 5859e5e52638SMatthew G. Knepley /*@ 58607f96f943SMatthew G. Knepley DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information. 58617f96f943SMatthew G. Knepley 5862f2cacb80SMatthew G. Knepley Collective on DM 5863f2cacb80SMatthew G. Knepley 58647f96f943SMatthew G. Knepley Input Parameters: 58657f96f943SMatthew G. Knepley + dm - The DM 58667f96f943SMatthew G. Knepley - time - The time 58677f96f943SMatthew G. Knepley 58687f96f943SMatthew G. Knepley Output Parameters: 5869f2cacb80SMatthew G. Knepley + u - The vector will be filled with exact solution values, or NULL 5870f2cacb80SMatthew G. Knepley - u_t - The vector will be filled with the time derivative of exact solution values, or NULL 58717f96f943SMatthew G. Knepley 58727f96f943SMatthew G. Knepley Note: The user must call PetscDSSetExactSolution() beforehand 58737f96f943SMatthew G. Knepley 58747f96f943SMatthew G. Knepley Level: developer 58757f96f943SMatthew G. Knepley 58767f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution() 58777f96f943SMatthew G. Knepley @*/ 5878f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t) 58797f96f943SMatthew G. Knepley { 58807f96f943SMatthew G. Knepley PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx); 58817f96f943SMatthew G. Knepley void **ectxs; 58827f96f943SMatthew G. Knepley PetscInt Nf, Nds, s; 58837f96f943SMatthew G. Knepley PetscErrorCode ierr; 58847f96f943SMatthew G. Knepley 58857f96f943SMatthew G. Knepley PetscFunctionBegin; 5886f2cacb80SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5887f2cacb80SMatthew G. Knepley if (u) PetscValidHeaderSpecific(u, VEC_CLASSID, 3); 5888f2cacb80SMatthew G. Knepley if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4); 58897f96f943SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 58907f96f943SMatthew G. Knepley ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr); 58917f96f943SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 58927f96f943SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 58937f96f943SMatthew G. Knepley PetscDS ds; 58947f96f943SMatthew G. Knepley DMLabel label; 58957f96f943SMatthew G. Knepley IS fieldIS; 58967f96f943SMatthew G. Knepley const PetscInt *fields, id = 1; 58977f96f943SMatthew G. Knepley PetscInt dsNf, f; 58987f96f943SMatthew G. Knepley 58997f96f943SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr); 59007f96f943SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr); 59017f96f943SMatthew G. Knepley ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr); 59027f96f943SMatthew G. Knepley ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr); 59037f96f943SMatthew G. Knepley ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr); 5904f2cacb80SMatthew G. Knepley if (u) { 59057f96f943SMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 59067f96f943SMatthew G. Knepley const PetscInt field = fields[f]; 59077f96f943SMatthew G. Knepley ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr); 59087f96f943SMatthew G. Knepley } 59097f96f943SMatthew G. Knepley ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr); 59107f96f943SMatthew G. Knepley if (label) { 59117f96f943SMatthew G. Knepley ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr); 59127f96f943SMatthew G. Knepley } else { 59137f96f943SMatthew G. Knepley ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr); 59147f96f943SMatthew G. Knepley } 59157f96f943SMatthew G. Knepley } 5916f2cacb80SMatthew G. Knepley if (u_t) { 5917f2cacb80SMatthew G. Knepley ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr); 5918f2cacb80SMatthew G. Knepley ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr); 5919f2cacb80SMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 5920f2cacb80SMatthew G. Knepley const PetscInt field = fields[f]; 5921f2cacb80SMatthew G. Knepley ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr); 5922f2cacb80SMatthew G. Knepley } 5923f2cacb80SMatthew G. Knepley ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr); 5924f2cacb80SMatthew G. Knepley if (label) { 5925f2cacb80SMatthew G. Knepley ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr); 5926f2cacb80SMatthew G. Knepley } else { 5927f2cacb80SMatthew G. Knepley ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr); 5928f2cacb80SMatthew G. Knepley } 5929f2cacb80SMatthew G. Knepley } 5930f2cacb80SMatthew G. Knepley } 5931f2cacb80SMatthew G. Knepley if (u) { 59327f96f943SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr); 59337f96f943SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr); 5934f2cacb80SMatthew G. Knepley } 5935f2cacb80SMatthew G. Knepley if (u_t) { 5936f2cacb80SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr); 5937f2cacb80SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr); 5938f2cacb80SMatthew G. Knepley } 59397f96f943SMatthew G. Knepley ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr); 59407f96f943SMatthew G. Knepley PetscFunctionReturn(0); 59417f96f943SMatthew G. Knepley } 59427f96f943SMatthew G. Knepley 594345480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds) 594445480ffeSMatthew G. Knepley { 594545480ffeSMatthew G. Knepley PetscDS dsNew; 594645480ffeSMatthew G. Knepley DSBoundary b; 594745480ffeSMatthew G. Knepley PetscInt cdim, Nf, f; 5948*5fedec97SMatthew G. Knepley PetscBool isCohesive; 594945480ffeSMatthew G. Knepley void *ctx; 595045480ffeSMatthew G. Knepley PetscErrorCode ierr; 595145480ffeSMatthew G. Knepley 595245480ffeSMatthew G. Knepley PetscFunctionBegin; 595345480ffeSMatthew G. Knepley ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr); 595445480ffeSMatthew G. Knepley ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr); 595545480ffeSMatthew G. Knepley ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr); 595645480ffeSMatthew G. Knepley ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr); 595745480ffeSMatthew G. Knepley ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr); 595845480ffeSMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr); 595945480ffeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 596045480ffeSMatthew G. Knepley ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr); 596145480ffeSMatthew G. Knepley ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr); 5962*5fedec97SMatthew G. Knepley ierr = PetscDSGetCohesive(ds, f, &isCohesive);CHKERRQ(ierr); 5963*5fedec97SMatthew G. Knepley ierr = PetscDSSetCohesive(dsNew, f, isCohesive);CHKERRQ(ierr); 596445480ffeSMatthew G. Knepley } 596545480ffeSMatthew G. Knepley if (Nf) { 596645480ffeSMatthew G. Knepley ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr); 596745480ffeSMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr); 596845480ffeSMatthew G. Knepley } 596945480ffeSMatthew G. Knepley ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr); 597045480ffeSMatthew G. Knepley for (b = dsNew->boundary; b; b = b->next) { 597145480ffeSMatthew G. Knepley ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr); 597245480ffeSMatthew G. Knepley /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */ 597345480ffeSMatthew G. Knepley //if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name); 597445480ffeSMatthew G. Knepley } 597545480ffeSMatthew G. Knepley 597645480ffeSMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr); 597745480ffeSMatthew G. Knepley ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr); 597845480ffeSMatthew G. Knepley PetscFunctionReturn(0); 597945480ffeSMatthew G. Knepley } 598045480ffeSMatthew G. Knepley 59817f96f943SMatthew G. Knepley /*@ 5982e5e52638SMatthew G. Knepley DMCopyDS - Copy the discrete systems for the DM into another DM 5983e5e52638SMatthew G. Knepley 5984d083f849SBarry Smith Collective on dm 5985e5e52638SMatthew G. Knepley 5986e5e52638SMatthew G. Knepley Input Parameter: 5987e5e52638SMatthew G. Knepley . dm - The DM 5988e5e52638SMatthew G. Knepley 5989e5e52638SMatthew G. Knepley Output Parameter: 5990e5e52638SMatthew G. Knepley . newdm - The DM 5991e5e52638SMatthew G. Knepley 5992e5e52638SMatthew G. Knepley Level: advanced 5993e5e52638SMatthew G. Knepley 5994e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 5995e5e52638SMatthew G. Knepley @*/ 5996e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm) 5997e5e52638SMatthew G. Knepley { 5998e5e52638SMatthew G. Knepley PetscInt Nds, s; 5999e5e52638SMatthew G. Knepley PetscErrorCode ierr; 6000e5e52638SMatthew G. Knepley 6001e5e52638SMatthew G. Knepley PetscFunctionBegin; 6002e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 6003e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 6004e5e52638SMatthew G. Knepley ierr = DMClearDS(newdm);CHKERRQ(ierr); 6005e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 6006e5e52638SMatthew G. Knepley DMLabel label; 6007b3cf3223SMatthew G. Knepley IS fields; 600845480ffeSMatthew G. Knepley PetscDS ds, newds; 6009783e2ec8SMatthew G. Knepley PetscInt Nbd, bd; 6010e5e52638SMatthew G. Knepley 6011b3cf3223SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr); 6012b8025e53SMatthew G. Knepley /* TODO: We need to change all keys from labels in the old DM to labels in the new DM */ 601345480ffeSMatthew G. Knepley ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr); 601445480ffeSMatthew G. Knepley /* Commplete new labels in the new DS */ 601545480ffeSMatthew G. Knepley ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr); 601645480ffeSMatthew G. Knepley ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr); 6017783e2ec8SMatthew G. Knepley for (bd = 0; bd < Nbd; ++bd) { 6018b8025e53SMatthew G. Knepley PetscWeakForm wf; 601945480ffeSMatthew G. Knepley DMLabel label; 6020783e2ec8SMatthew G. Knepley PetscInt field; 6021783e2ec8SMatthew G. Knepley 6022b8025e53SMatthew G. Knepley ierr = PetscDSGetBoundary(newds, bd, &wf, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 602345480ffeSMatthew G. Knepley ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr); 6024b8025e53SMatthew G. Knepley ierr = PetscWeakFormReplaceLabel(wf, label);CHKERRQ(ierr); 6025783e2ec8SMatthew G. Knepley } 6026e5e52638SMatthew G. Knepley } 6027e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 6028e5e52638SMatthew G. Knepley } 6029e5e52638SMatthew G. Knepley 6030e5e52638SMatthew G. Knepley /*@ 6031e5e52638SMatthew G. Knepley DMCopyDisc - Copy the fields and discrete systems for the DM into another DM 6032e5e52638SMatthew G. Knepley 6033d083f849SBarry Smith Collective on dm 6034e5e52638SMatthew G. Knepley 6035e5e52638SMatthew G. Knepley Input Parameter: 6036e5e52638SMatthew G. Knepley . dm - The DM 6037e5e52638SMatthew G. Knepley 6038e5e52638SMatthew G. Knepley Output Parameter: 6039e5e52638SMatthew G. Knepley . newdm - The DM 6040e5e52638SMatthew G. Knepley 6041e5e52638SMatthew G. Knepley Level: advanced 6042e5e52638SMatthew G. Knepley 6043e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS() 6044e5e52638SMatthew G. Knepley @*/ 6045e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm) 6046e5e52638SMatthew G. Knepley { 6047e5e52638SMatthew G. Knepley PetscErrorCode ierr; 6048e5e52638SMatthew G. Knepley 6049e5e52638SMatthew G. Knepley PetscFunctionBegin; 6050e5e52638SMatthew G. Knepley ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr); 6051e5e52638SMatthew G. Knepley ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr); 6052e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 6053e5e52638SMatthew G. Knepley } 6054e5e52638SMatthew G. Knepley 6055b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx) 6056b64e0483SPeter Brune { 6057b64e0483SPeter Brune DM dm_coord,dmc_coord; 6058b64e0483SPeter Brune PetscErrorCode ierr; 6059b64e0483SPeter Brune Vec coords,ccoords; 60606dbf9973SLawrence Mitchell Mat inject; 6061b64e0483SPeter Brune PetscFunctionBegin; 6062b64e0483SPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 6063b64e0483SPeter Brune ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr); 6064b64e0483SPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 6065b64e0483SPeter Brune ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr); 6066b64e0483SPeter Brune if (coords && !ccoords) { 6067b64e0483SPeter Brune ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr); 60686668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 60696dbf9973SLawrence Mitchell ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr); 60702adcf181SLawrence Mitchell ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr); 60716dbf9973SLawrence Mitchell ierr = MatDestroy(&inject);CHKERRQ(ierr); 6072b64e0483SPeter Brune ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr); 6073b64e0483SPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 6074b64e0483SPeter Brune } 6075b64e0483SPeter Brune PetscFunctionReturn(0); 6076b64e0483SPeter Brune } 6077b64e0483SPeter Brune 607803dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx) 607903dadc2fSPeter Brune { 608003dadc2fSPeter Brune DM dm_coord,subdm_coord; 608103dadc2fSPeter Brune PetscErrorCode ierr; 608203dadc2fSPeter Brune Vec coords,ccoords,clcoords; 608303dadc2fSPeter Brune VecScatter *scat_i,*scat_g; 608403dadc2fSPeter Brune PetscFunctionBegin; 608503dadc2fSPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 608603dadc2fSPeter Brune ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr); 608703dadc2fSPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 608803dadc2fSPeter Brune ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr); 608903dadc2fSPeter Brune if (coords && !ccoords) { 609003dadc2fSPeter Brune ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr); 60916668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 609203dadc2fSPeter Brune ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr); 609324640c55SToby Isaac ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr); 609403dadc2fSPeter Brune ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr); 609503dadc2fSPeter Brune ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 609603dadc2fSPeter Brune ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 60971ed9ada7SJunchao Zhang ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 609803dadc2fSPeter Brune ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 609903dadc2fSPeter Brune ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr); 610003dadc2fSPeter Brune ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr); 610103dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr); 610203dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr); 610303dadc2fSPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 610403dadc2fSPeter Brune ierr = VecDestroy(&clcoords);CHKERRQ(ierr); 610503dadc2fSPeter Brune ierr = PetscFree(scat_i);CHKERRQ(ierr); 610603dadc2fSPeter Brune ierr = PetscFree(scat_g);CHKERRQ(ierr); 610703dadc2fSPeter Brune } 610803dadc2fSPeter Brune PetscFunctionReturn(0); 610903dadc2fSPeter Brune } 611003dadc2fSPeter Brune 6111c73cfb54SMatthew G. Knepley /*@ 6112c73cfb54SMatthew G. Knepley DMGetDimension - Return the topological dimension of the DM 6113c73cfb54SMatthew G. Knepley 6114c73cfb54SMatthew G. Knepley Not collective 6115c73cfb54SMatthew G. Knepley 6116c73cfb54SMatthew G. Knepley Input Parameter: 6117c73cfb54SMatthew G. Knepley . dm - The DM 6118c73cfb54SMatthew G. Knepley 6119c73cfb54SMatthew G. Knepley Output Parameter: 6120c73cfb54SMatthew G. Knepley . dim - The topological dimension 6121c73cfb54SMatthew G. Knepley 6122c73cfb54SMatthew G. Knepley Level: beginner 6123c73cfb54SMatthew G. Knepley 6124c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate() 6125c73cfb54SMatthew G. Knepley @*/ 6126c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim) 6127c73cfb54SMatthew G. Knepley { 6128c73cfb54SMatthew G. Knepley PetscFunctionBegin; 6129c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6130534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 6131c73cfb54SMatthew G. Knepley *dim = dm->dim; 6132c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 6133c73cfb54SMatthew G. Knepley } 6134c73cfb54SMatthew G. Knepley 6135c73cfb54SMatthew G. Knepley /*@ 6136c73cfb54SMatthew G. Knepley DMSetDimension - Set the topological dimension of the DM 6137c73cfb54SMatthew G. Knepley 6138c73cfb54SMatthew G. Knepley Collective on dm 6139c73cfb54SMatthew G. Knepley 6140c73cfb54SMatthew G. Knepley Input Parameters: 6141c73cfb54SMatthew G. Knepley + dm - The DM 6142c73cfb54SMatthew G. Knepley - dim - The topological dimension 6143c73cfb54SMatthew G. Knepley 6144c73cfb54SMatthew G. Knepley Level: beginner 6145c73cfb54SMatthew G. Knepley 6146c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate() 6147c73cfb54SMatthew G. Knepley @*/ 6148c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim) 6149c73cfb54SMatthew G. Knepley { 6150e5e52638SMatthew G. Knepley PetscDS ds; 615145480ffeSMatthew G. Knepley PetscInt Nds, n; 6152f17e8794SMatthew G. Knepley PetscErrorCode ierr; 6153f17e8794SMatthew G. Knepley 6154c73cfb54SMatthew G. Knepley PetscFunctionBegin; 6155c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6156c73cfb54SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, dim, 2); 6157c73cfb54SMatthew G. Knepley dm->dim = dim; 6158d17bd122SMatthew G. Knepley if (dm->dim >= 0) { 615945480ffeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 616045480ffeSMatthew G. Knepley for (n = 0; n < Nds; ++n) { 616145480ffeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr); 616245480ffeSMatthew G. Knepley if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);} 616345480ffeSMatthew G. Knepley } 6164d17bd122SMatthew G. Knepley } 6165c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 6166c73cfb54SMatthew G. Knepley } 6167c73cfb54SMatthew G. Knepley 6168793f3fe5SMatthew G. Knepley /*@ 6169793f3fe5SMatthew G. Knepley DMGetDimPoints - Get the half-open interval for all points of a given dimension 6170793f3fe5SMatthew G. Knepley 6171d083f849SBarry Smith Collective on dm 6172793f3fe5SMatthew G. Knepley 6173793f3fe5SMatthew G. Knepley Input Parameters: 6174793f3fe5SMatthew G. Knepley + dm - the DM 6175793f3fe5SMatthew G. Knepley - dim - the dimension 6176793f3fe5SMatthew G. Knepley 6177793f3fe5SMatthew G. Knepley Output Parameters: 6178793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension 6179aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension 6180793f3fe5SMatthew G. Knepley 6181793f3fe5SMatthew G. Knepley Note: 6182793f3fe5SMatthew G. Knepley The points are vertices in the Hasse diagram encoding the topology. This is explained in 6183a8d69d7bSBarry Smith https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme, 6184793f3fe5SMatthew G. Knepley then the interval is empty. 6185793f3fe5SMatthew G. Knepley 6186793f3fe5SMatthew G. Knepley Level: intermediate 6187793f3fe5SMatthew G. Knepley 6188793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum() 6189793f3fe5SMatthew G. Knepley @*/ 6190793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd) 6191793f3fe5SMatthew G. Knepley { 6192793f3fe5SMatthew G. Knepley PetscInt d; 6193793f3fe5SMatthew G. Knepley PetscErrorCode ierr; 6194793f3fe5SMatthew G. Knepley 6195793f3fe5SMatthew G. Knepley PetscFunctionBegin; 6196793f3fe5SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6197793f3fe5SMatthew G. Knepley ierr = DMGetDimension(dm, &d);CHKERRQ(ierr); 6198793f3fe5SMatthew G. Knepley if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d); 6199b9d85ea2SLisandro Dalcin if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name); 6200793f3fe5SMatthew G. Knepley ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr); 6201793f3fe5SMatthew G. Knepley PetscFunctionReturn(0); 6202793f3fe5SMatthew G. Knepley } 6203793f3fe5SMatthew G. Knepley 62046636e97aSMatthew G Knepley /*@ 62056636e97aSMatthew G Knepley DMSetCoordinates - Sets into the DM a global vector that holds the coordinates 62066636e97aSMatthew G Knepley 6207d083f849SBarry Smith Collective on dm 62086636e97aSMatthew G Knepley 62096636e97aSMatthew G Knepley Input Parameters: 62106636e97aSMatthew G Knepley + dm - the DM 62116636e97aSMatthew G Knepley - c - coordinate vector 62126636e97aSMatthew G Knepley 62132dd40e9bSPatrick Sanan Notes: 62142dd40e9bSPatrick Sanan The coordinates do include those for ghost points, which are in the local vector. 62152dd40e9bSPatrick Sanan 62162dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 62176636e97aSMatthew G Knepley 62186636e97aSMatthew G Knepley Level: intermediate 62196636e97aSMatthew G Knepley 622060c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates() 62216636e97aSMatthew G Knepley @*/ 62226636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c) 62236636e97aSMatthew G Knepley { 62246636e97aSMatthew G Knepley PetscErrorCode ierr; 62256636e97aSMatthew G Knepley 62266636e97aSMatthew G Knepley PetscFunctionBegin; 62276636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 62286636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 62296636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 62306636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 62316636e97aSMatthew G Knepley dm->coordinates = c; 62326636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 6233b64e0483SPeter Brune ierr = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 623403dadc2fSPeter Brune ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 62356636e97aSMatthew G Knepley PetscFunctionReturn(0); 62366636e97aSMatthew G Knepley } 62376636e97aSMatthew G Knepley 62386636e97aSMatthew G Knepley /*@ 62396636e97aSMatthew G Knepley DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates 62406636e97aSMatthew G Knepley 62417058e716SVaclav Hapla Not collective 62426636e97aSMatthew G Knepley 62436636e97aSMatthew G Knepley Input Parameters: 62446636e97aSMatthew G Knepley + dm - the DM 62456636e97aSMatthew G Knepley - c - coordinate vector 62466636e97aSMatthew G Knepley 62472dd40e9bSPatrick Sanan Notes: 62486636e97aSMatthew G Knepley The coordinates of ghost points can be set using DMSetCoordinates() 62496636e97aSMatthew G Knepley followed by DMGetCoordinatesLocal(). This is intended to enable the 62506636e97aSMatthew G Knepley setting of ghost coordinates outside of the domain. 62516636e97aSMatthew G Knepley 62522dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 62532dd40e9bSPatrick Sanan 62546636e97aSMatthew G Knepley Level: intermediate 62556636e97aSMatthew G Knepley 62566636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM() 62576636e97aSMatthew G Knepley @*/ 62586636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c) 62596636e97aSMatthew G Knepley { 62606636e97aSMatthew G Knepley PetscErrorCode ierr; 62616636e97aSMatthew G Knepley 62626636e97aSMatthew G Knepley PetscFunctionBegin; 62636636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 62646636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 62656636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 62666636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 62678865f1eaSKarl Rupp 62686636e97aSMatthew G Knepley dm->coordinatesLocal = c; 62698865f1eaSKarl Rupp 62706636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 62716636e97aSMatthew G Knepley PetscFunctionReturn(0); 62726636e97aSMatthew G Knepley } 62736636e97aSMatthew G Knepley 62746636e97aSMatthew G Knepley /*@ 62756636e97aSMatthew G Knepley DMGetCoordinates - Gets a global vector with the coordinates associated with the DM. 62766636e97aSMatthew G Knepley 6277d083f849SBarry Smith Collective on dm 62786636e97aSMatthew G Knepley 62796636e97aSMatthew G Knepley Input Parameter: 62806636e97aSMatthew G Knepley . dm - the DM 62816636e97aSMatthew G Knepley 62826636e97aSMatthew G Knepley Output Parameter: 62836636e97aSMatthew G Knepley . c - global coordinate vector 62846636e97aSMatthew G Knepley 62856636e97aSMatthew G Knepley Note: 628660c22052SBarry Smith This is a borrowed reference, so the user should NOT destroy this vector. When the DM is 628760c22052SBarry Smith destroyed the array will no longer be valid. 62886636e97aSMatthew G Knepley 6289959c7569SPatrick Sanan Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates). 62906636e97aSMatthew G Knepley 62916636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 62926636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 62936636e97aSMatthew G Knepley 62946636e97aSMatthew G Knepley Level: intermediate 62956636e97aSMatthew G Knepley 629660c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates() 62976636e97aSMatthew G Knepley @*/ 62986636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c) 62996636e97aSMatthew G Knepley { 63006636e97aSMatthew G Knepley PetscErrorCode ierr; 63016636e97aSMatthew G Knepley 63026636e97aSMatthew G Knepley PetscFunctionBegin; 63036636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 63046636e97aSMatthew G Knepley PetscValidPointer(c,2); 63051f588964SMatthew G Knepley if (!dm->coordinates && dm->coordinatesLocal) { 63060298fd71SBarry Smith DM cdm = NULL; 63071970a576SMatthew G. Knepley PetscBool localized; 63086636e97aSMatthew G Knepley 63096636e97aSMatthew G Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 63106636e97aSMatthew G Knepley ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr); 63111970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 63121970a576SMatthew G. Knepley /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */ 63131970a576SMatthew G. Knepley if (localized) { 63141970a576SMatthew G. Knepley PetscInt cdim; 63151970a576SMatthew G. Knepley 63161970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 63171970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 63181970a576SMatthew G. Knepley } 63196636e97aSMatthew G Knepley ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr); 63206636e97aSMatthew G Knepley ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 63216636e97aSMatthew G Knepley ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 63226636e97aSMatthew G Knepley } 63236636e97aSMatthew G Knepley *c = dm->coordinates; 63246636e97aSMatthew G Knepley PetscFunctionReturn(0); 63256636e97aSMatthew G Knepley } 63266636e97aSMatthew G Knepley 63276636e97aSMatthew G Knepley /*@ 632881e9a530SVaclav Hapla DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards. 632981e9a530SVaclav Hapla 6330d083f849SBarry Smith Collective on dm 633181e9a530SVaclav Hapla 633281e9a530SVaclav Hapla Input Parameter: 633381e9a530SVaclav Hapla . dm - the DM 633481e9a530SVaclav Hapla 633581e9a530SVaclav Hapla Level: advanced 633681e9a530SVaclav Hapla 633781e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective() 633881e9a530SVaclav Hapla @*/ 633981e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm) 634081e9a530SVaclav Hapla { 634181e9a530SVaclav Hapla PetscErrorCode ierr; 634281e9a530SVaclav Hapla 634381e9a530SVaclav Hapla PetscFunctionBegin; 634481e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 634581e9a530SVaclav Hapla if (!dm->coordinatesLocal && dm->coordinates) { 63461970a576SMatthew G. Knepley DM cdm = NULL; 63471970a576SMatthew G. Knepley PetscBool localized; 63481970a576SMatthew G. Knepley 634981e9a530SVaclav Hapla ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 635081e9a530SVaclav Hapla ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr); 63511970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 63521970a576SMatthew G. Knepley /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */ 63531970a576SMatthew G. Knepley if (localized) { 63541970a576SMatthew G. Knepley PetscInt cdim; 63551970a576SMatthew G. Knepley 63561970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 63571970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 63581970a576SMatthew G. Knepley } 635981e9a530SVaclav Hapla ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr); 636081e9a530SVaclav Hapla ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 636181e9a530SVaclav Hapla ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 636281e9a530SVaclav Hapla } 636381e9a530SVaclav Hapla PetscFunctionReturn(0); 636481e9a530SVaclav Hapla } 636581e9a530SVaclav Hapla 636681e9a530SVaclav Hapla /*@ 63676636e97aSMatthew G Knepley DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM. 63686636e97aSMatthew G Knepley 6369d083f849SBarry Smith Collective on dm 63706636e97aSMatthew G Knepley 63716636e97aSMatthew G Knepley Input Parameter: 63726636e97aSMatthew G Knepley . dm - the DM 63736636e97aSMatthew G Knepley 63746636e97aSMatthew G Knepley Output Parameter: 63756636e97aSMatthew G Knepley . c - coordinate vector 63766636e97aSMatthew G Knepley 63776636e97aSMatthew G Knepley Note: 63786636e97aSMatthew G Knepley This is a borrowed reference, so the user should NOT destroy this vector 63796636e97aSMatthew G Knepley 63806636e97aSMatthew G Knepley Each process has the local and ghost coordinates 63816636e97aSMatthew G Knepley 63826636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 63836636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 63846636e97aSMatthew G Knepley 63856636e97aSMatthew G Knepley Level: intermediate 63866636e97aSMatthew G Knepley 638781e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective() 63886636e97aSMatthew G Knepley @*/ 63896636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c) 63906636e97aSMatthew G Knepley { 63916636e97aSMatthew G Knepley PetscErrorCode ierr; 63926636e97aSMatthew G Knepley 63936636e97aSMatthew G Knepley PetscFunctionBegin; 63946636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 63956636e97aSMatthew G Knepley PetscValidPointer(c,2); 639681e9a530SVaclav Hapla ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr); 63976636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 63986636e97aSMatthew G Knepley PetscFunctionReturn(0); 63996636e97aSMatthew G Knepley } 64006636e97aSMatthew G Knepley 640181e9a530SVaclav Hapla /*@ 640281e9a530SVaclav Hapla DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called. 640381e9a530SVaclav Hapla 640481e9a530SVaclav Hapla Not collective 640581e9a530SVaclav Hapla 640681e9a530SVaclav Hapla Input Parameter: 640781e9a530SVaclav Hapla . dm - the DM 640881e9a530SVaclav Hapla 640981e9a530SVaclav Hapla Output Parameter: 641081e9a530SVaclav Hapla . c - coordinate vector 641181e9a530SVaclav Hapla 641281e9a530SVaclav Hapla Level: advanced 641381e9a530SVaclav Hapla 641481e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 641581e9a530SVaclav Hapla @*/ 641681e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c) 641781e9a530SVaclav Hapla { 641881e9a530SVaclav Hapla PetscFunctionBegin; 641981e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 642081e9a530SVaclav Hapla PetscValidPointer(c,2); 642181e9a530SVaclav Hapla if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called"); 64226636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 64236636e97aSMatthew G Knepley PetscFunctionReturn(0); 64246636e97aSMatthew G Knepley } 64256636e97aSMatthew G Knepley 64262db98f8dSVaclav Hapla /*@ 64272db98f8dSVaclav Hapla DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout. 64282db98f8dSVaclav Hapla 64292db98f8dSVaclav Hapla Not collective 64302db98f8dSVaclav Hapla 6431d8d19677SJose E. Roman Input Parameters: 64322db98f8dSVaclav Hapla + dm - the DM 64332db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned 64342db98f8dSVaclav Hapla 6435d8d19677SJose E. Roman Output Parameters: 64362db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates 64372db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p 64382db98f8dSVaclav Hapla 64392db98f8dSVaclav Hapla Note: 64402db98f8dSVaclav Hapla DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective. 64412db98f8dSVaclav Hapla 64422db98f8dSVaclav Hapla This creates a new vector, so the user SHOULD destroy this vector 64432db98f8dSVaclav Hapla 64442db98f8dSVaclav Hapla Each process has the local and ghost coordinates 64452db98f8dSVaclav Hapla 64462db98f8dSVaclav Hapla For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 64472db98f8dSVaclav Hapla and (x_0,y_0,z_0,x_1,y_1,z_1...) 64482db98f8dSVaclav Hapla 64492db98f8dSVaclav Hapla Level: advanced 64502db98f8dSVaclav Hapla 64512db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 64522db98f8dSVaclav Hapla @*/ 64532db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord) 64542db98f8dSVaclav Hapla { 64552db98f8dSVaclav Hapla PetscSection cs, newcs; 64562db98f8dSVaclav Hapla Vec coords; 64572db98f8dSVaclav Hapla const PetscScalar *arr; 64582db98f8dSVaclav Hapla PetscScalar *newarr=NULL; 64592db98f8dSVaclav Hapla PetscInt n; 64602db98f8dSVaclav Hapla PetscErrorCode ierr; 64612db98f8dSVaclav Hapla 64622db98f8dSVaclav Hapla PetscFunctionBegin; 64632db98f8dSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 64642db98f8dSVaclav Hapla PetscValidHeaderSpecific(p, IS_CLASSID, 2); 64652db98f8dSVaclav Hapla if (pCoordSection) PetscValidPointer(pCoordSection, 3); 64662db98f8dSVaclav Hapla if (pCoord) PetscValidPointer(pCoord, 4); 64672db98f8dSVaclav Hapla if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set"); 64681bb6d2a8SBarry Smith if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported"); 64691bb6d2a8SBarry Smith cs = dm->coordinateDM->localSection; 64702db98f8dSVaclav Hapla coords = dm->coordinatesLocal; 64712db98f8dSVaclav Hapla ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr); 64722db98f8dSVaclav Hapla ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr); 64732db98f8dSVaclav Hapla ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr); 64742db98f8dSVaclav Hapla if (pCoord) { 64752db98f8dSVaclav Hapla ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr); 64762db98f8dSVaclav Hapla /* set array in two steps to mimic PETSC_OWN_POINTER */ 64772db98f8dSVaclav Hapla ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr); 64782db98f8dSVaclav Hapla ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr); 6479ad9ac99dSVaclav Hapla } else { 6480ad9ac99dSVaclav Hapla ierr = PetscFree(newarr);CHKERRQ(ierr); 64812db98f8dSVaclav Hapla } 6482ad9ac99dSVaclav Hapla if (pCoordSection) {*pCoordSection = newcs;} 6483ad9ac99dSVaclav Hapla else {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);} 64842db98f8dSVaclav Hapla PetscFunctionReturn(0); 64852db98f8dSVaclav Hapla } 64862db98f8dSVaclav Hapla 6487f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field) 6488f19dbd58SToby Isaac { 6489f19dbd58SToby Isaac PetscErrorCode ierr; 6490f19dbd58SToby Isaac 6491f19dbd58SToby Isaac PetscFunctionBegin; 6492f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6493f19dbd58SToby Isaac PetscValidPointer(field,2); 6494f19dbd58SToby Isaac if (!dm->coordinateField) { 6495f19dbd58SToby Isaac if (dm->ops->createcoordinatefield) { 6496f19dbd58SToby Isaac ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr); 6497f19dbd58SToby Isaac } 6498f19dbd58SToby Isaac } 6499f19dbd58SToby Isaac *field = dm->coordinateField; 6500f19dbd58SToby Isaac PetscFunctionReturn(0); 6501f19dbd58SToby Isaac } 6502f19dbd58SToby Isaac 6503f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field) 6504f19dbd58SToby Isaac { 6505f19dbd58SToby Isaac PetscErrorCode ierr; 6506f19dbd58SToby Isaac 6507f19dbd58SToby Isaac PetscFunctionBegin; 6508f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6509f19dbd58SToby Isaac if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2); 6510c4e6da2cSBarry Smith ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr); 6511f19dbd58SToby Isaac ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr); 6512f19dbd58SToby Isaac dm->coordinateField = field; 6513f19dbd58SToby Isaac PetscFunctionReturn(0); 6514f19dbd58SToby Isaac } 6515f19dbd58SToby Isaac 65166636e97aSMatthew G Knepley /*@ 65171cfe2091SMatthew G. Knepley DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates 65186636e97aSMatthew G Knepley 6519d083f849SBarry Smith Collective on dm 65206636e97aSMatthew G Knepley 65216636e97aSMatthew G Knepley Input Parameter: 65226636e97aSMatthew G Knepley . dm - the DM 65236636e97aSMatthew G Knepley 65246636e97aSMatthew G Knepley Output Parameter: 65256636e97aSMatthew G Knepley . cdm - coordinate DM 65266636e97aSMatthew G Knepley 65276636e97aSMatthew G Knepley Level: intermediate 65286636e97aSMatthew G Knepley 65291cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 65306636e97aSMatthew G Knepley @*/ 65316636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm) 65326636e97aSMatthew G Knepley { 65336636e97aSMatthew G Knepley PetscErrorCode ierr; 65346636e97aSMatthew G Knepley 65356636e97aSMatthew G Knepley PetscFunctionBegin; 65366636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 65376636e97aSMatthew G Knepley PetscValidPointer(cdm,2); 65386636e97aSMatthew G Knepley if (!dm->coordinateDM) { 6539308f8a94SToby Isaac DM cdm; 6540308f8a94SToby Isaac 654182f516ccSBarry Smith if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM"); 6542308f8a94SToby Isaac ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr); 6543c9ad657eSksagiyam ierr = PetscObjectSetName((PetscObject)cdm, "coordinateDM");CHKERRQ(ierr); 6544308f8a94SToby Isaac /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup 6545308f8a94SToby Isaac * until the call to CreateCoordinateDM) */ 6546308f8a94SToby Isaac ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 6547308f8a94SToby Isaac dm->coordinateDM = cdm; 65486636e97aSMatthew G Knepley } 65496636e97aSMatthew G Knepley *cdm = dm->coordinateDM; 65506636e97aSMatthew G Knepley PetscFunctionReturn(0); 65516636e97aSMatthew G Knepley } 6552e87bb0d3SMatthew G Knepley 65531cfe2091SMatthew G. Knepley /*@ 65541cfe2091SMatthew G. Knepley DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates 65551cfe2091SMatthew G. Knepley 6556d083f849SBarry Smith Logically Collective on dm 65571cfe2091SMatthew G. Knepley 65581cfe2091SMatthew G. Knepley Input Parameters: 65591cfe2091SMatthew G. Knepley + dm - the DM 65601cfe2091SMatthew G. Knepley - cdm - coordinate DM 65611cfe2091SMatthew G. Knepley 65621cfe2091SMatthew G. Knepley Level: intermediate 65631cfe2091SMatthew G. Knepley 65641cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 65651cfe2091SMatthew G. Knepley @*/ 65661cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm) 65671cfe2091SMatthew G. Knepley { 65681cfe2091SMatthew G. Knepley PetscErrorCode ierr; 65691cfe2091SMatthew G. Knepley 65701cfe2091SMatthew G. Knepley PetscFunctionBegin; 65711cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 65721cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(cdm,DM_CLASSID,2); 6573f26b38b9SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 65741cfe2091SMatthew G. Knepley ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 65751cfe2091SMatthew G. Knepley dm->coordinateDM = cdm; 65761cfe2091SMatthew G. Knepley PetscFunctionReturn(0); 65771cfe2091SMatthew G. Knepley } 65781cfe2091SMatthew G. Knepley 657946e270d4SMatthew G. Knepley /*@ 658046e270d4SMatthew G. Knepley DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values. 658146e270d4SMatthew G. Knepley 658246e270d4SMatthew G. Knepley Not Collective 658346e270d4SMatthew G. Knepley 658446e270d4SMatthew G. Knepley Input Parameter: 658546e270d4SMatthew G. Knepley . dm - The DM object 658646e270d4SMatthew G. Knepley 658746e270d4SMatthew G. Knepley Output Parameter: 658846e270d4SMatthew G. Knepley . dim - The embedding dimension 658946e270d4SMatthew G. Knepley 659046e270d4SMatthew G. Knepley Level: intermediate 659146e270d4SMatthew G. Knepley 659292fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 659346e270d4SMatthew G. Knepley @*/ 659446e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim) 659546e270d4SMatthew G. Knepley { 659646e270d4SMatthew G. Knepley PetscFunctionBegin; 659746e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6598534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 65999a9a41abSToby Isaac if (dm->dimEmbed == PETSC_DEFAULT) { 66009a9a41abSToby Isaac dm->dimEmbed = dm->dim; 66019a9a41abSToby Isaac } 660246e270d4SMatthew G. Knepley *dim = dm->dimEmbed; 660346e270d4SMatthew G. Knepley PetscFunctionReturn(0); 660446e270d4SMatthew G. Knepley } 660546e270d4SMatthew G. Knepley 660646e270d4SMatthew G. Knepley /*@ 660746e270d4SMatthew G. Knepley DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values. 660846e270d4SMatthew G. Knepley 660946e270d4SMatthew G. Knepley Not Collective 661046e270d4SMatthew G. Knepley 661146e270d4SMatthew G. Knepley Input Parameters: 661246e270d4SMatthew G. Knepley + dm - The DM object 661346e270d4SMatthew G. Knepley - dim - The embedding dimension 661446e270d4SMatthew G. Knepley 661546e270d4SMatthew G. Knepley Level: intermediate 661646e270d4SMatthew G. Knepley 661792fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 661846e270d4SMatthew G. Knepley @*/ 661946e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim) 662046e270d4SMatthew G. Knepley { 6621e5e52638SMatthew G. Knepley PetscDS ds; 662245480ffeSMatthew G. Knepley PetscInt Nds, n; 6623f17e8794SMatthew G. Knepley PetscErrorCode ierr; 6624f17e8794SMatthew G. Knepley 662546e270d4SMatthew G. Knepley PetscFunctionBegin; 662646e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 662746e270d4SMatthew G. Knepley dm->dimEmbed = dim; 6628d17bd122SMatthew G. Knepley if (dm->dim >= 0) { 662945480ffeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 663045480ffeSMatthew G. Knepley for (n = 0; n < Nds; ++n) { 663145480ffeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr); 6632e5e52638SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr); 663345480ffeSMatthew G. Knepley } 6634d17bd122SMatthew G. Knepley } 663546e270d4SMatthew G. Knepley PetscFunctionReturn(0); 663646e270d4SMatthew G. Knepley } 663746e270d4SMatthew G. Knepley 6638e8abe2deSMatthew G. Knepley /*@ 6639e8abe2deSMatthew G. Knepley DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh. 6640e8abe2deSMatthew G. Knepley 6641d083f849SBarry Smith Collective on dm 6642e8abe2deSMatthew G. Knepley 6643e8abe2deSMatthew G. Knepley Input Parameter: 6644e8abe2deSMatthew G. Knepley . dm - The DM object 6645e8abe2deSMatthew G. Knepley 6646e8abe2deSMatthew G. Knepley Output Parameter: 6647e8abe2deSMatthew G. Knepley . section - The PetscSection object 6648e8abe2deSMatthew G. Knepley 6649e8abe2deSMatthew G. Knepley Level: intermediate 6650e8abe2deSMatthew G. Knepley 665192fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 6652e8abe2deSMatthew G. Knepley @*/ 6653e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section) 6654e8abe2deSMatthew G. Knepley { 6655e8abe2deSMatthew G. Knepley DM cdm; 6656e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 6657e8abe2deSMatthew G. Knepley 6658e8abe2deSMatthew G. Knepley PetscFunctionBegin; 6659e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6660e8abe2deSMatthew G. Knepley PetscValidPointer(section, 2); 6661e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 666292fd8e1eSJed Brown ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr); 6663e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 6664e8abe2deSMatthew G. Knepley } 6665e8abe2deSMatthew G. Knepley 6666e8abe2deSMatthew G. Knepley /*@ 6667e8abe2deSMatthew G. Knepley DMSetCoordinateSection - Set the layout of coordinate values over the mesh. 6668e8abe2deSMatthew G. Knepley 6669e8abe2deSMatthew G. Knepley Not Collective 6670e8abe2deSMatthew G. Knepley 6671e8abe2deSMatthew G. Knepley Input Parameters: 6672e8abe2deSMatthew G. Knepley + dm - The DM object 667346e270d4SMatthew G. Knepley . dim - The embedding dimension, or PETSC_DETERMINE 6674e8abe2deSMatthew G. Knepley - section - The PetscSection object 6675e8abe2deSMatthew G. Knepley 6676e8abe2deSMatthew G. Knepley Level: intermediate 6677e8abe2deSMatthew G. Knepley 667892fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 6679e8abe2deSMatthew G. Knepley @*/ 668046e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section) 6681e8abe2deSMatthew G. Knepley { 6682e8abe2deSMatthew G. Knepley DM cdm; 6683e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 6684e8abe2deSMatthew G. Knepley 6685e8abe2deSMatthew G. Knepley PetscFunctionBegin; 6686e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 668746e270d4SMatthew G. Knepley PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3); 6688e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 668992fd8e1eSJed Brown ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr); 669046e270d4SMatthew G. Knepley if (dim == PETSC_DETERMINE) { 66914c1069a6SMatthew G. Knepley PetscInt d = PETSC_DEFAULT; 669246e270d4SMatthew G. Knepley PetscInt pStart, pEnd, vStart, vEnd, v, dd; 669346e270d4SMatthew G. Knepley 669446e270d4SMatthew G. Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 669546e270d4SMatthew G. Knepley ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr); 669646e270d4SMatthew G. Knepley pStart = PetscMax(vStart, pStart); 669746e270d4SMatthew G. Knepley pEnd = PetscMin(vEnd, pEnd); 669846e270d4SMatthew G. Knepley for (v = pStart; v < pEnd; ++v) { 669946e270d4SMatthew G. Knepley ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr); 670046e270d4SMatthew G. Knepley if (dd) {d = dd; break;} 670146e270d4SMatthew G. Knepley } 6702ebfe4b0dSMatthew G. Knepley if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);} 670346e270d4SMatthew G. Knepley } 6704e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 6705e8abe2deSMatthew G. Knepley } 6706e8abe2deSMatthew G. Knepley 6707d864a3eaSLisandro Dalcin /*@ 6708d864a3eaSLisandro Dalcin DMProjectCoordinates - Project coordinates to a different space 6709d864a3eaSLisandro Dalcin 6710d864a3eaSLisandro Dalcin Input Parameters: 6711d864a3eaSLisandro Dalcin + dm - The DM object 6712d864a3eaSLisandro Dalcin - disc - The new coordinate discretization 6713d864a3eaSLisandro Dalcin 6714d864a3eaSLisandro Dalcin Level: intermediate 6715d864a3eaSLisandro Dalcin 6716d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField() 6717d864a3eaSLisandro Dalcin @*/ 6718d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc) 6719d864a3eaSLisandro Dalcin { 6720d864a3eaSLisandro Dalcin PetscObject discOld; 6721d864a3eaSLisandro Dalcin PetscClassId classid; 6722d864a3eaSLisandro Dalcin DM cdmOld,cdmNew; 6723d864a3eaSLisandro Dalcin Vec coordsOld,coordsNew; 6724d864a3eaSLisandro Dalcin Mat matInterp; 6725d864a3eaSLisandro Dalcin PetscErrorCode ierr; 6726d864a3eaSLisandro Dalcin 6727d864a3eaSLisandro Dalcin PetscFunctionBegin; 6728d864a3eaSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6729d864a3eaSLisandro Dalcin PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2); 6730d864a3eaSLisandro Dalcin 6731d864a3eaSLisandro Dalcin ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr); 6732d864a3eaSLisandro Dalcin /* Check current discretization is compatible */ 6733d864a3eaSLisandro Dalcin ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr); 6734d864a3eaSLisandro Dalcin ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr); 673529ad44c5SMatthew G. Knepley if (classid != PETSCFE_CLASSID) { 673629ad44c5SMatthew G. Knepley if (classid == PETSC_CONTAINER_CLASSID) { 673729ad44c5SMatthew G. Knepley PetscFE feLinear; 673829ad44c5SMatthew G. Knepley DMPolytopeType ct; 673929ad44c5SMatthew G. Knepley PetscInt dim, dE, cStart; 674029ad44c5SMatthew G. Knepley PetscBool simplex; 674129ad44c5SMatthew G. Knepley 674229ad44c5SMatthew G. Knepley /* Assume linear vertex coordinates */ 674329ad44c5SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 674429ad44c5SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr); 674529ad44c5SMatthew G. Knepley ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr); 674629ad44c5SMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 674729ad44c5SMatthew G. Knepley switch (ct) { 674829ad44c5SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM: 674929ad44c5SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM_TENSOR: 675029ad44c5SMatthew G. Knepley SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms"); 675129ad44c5SMatthew G. Knepley default: break; 675229ad44c5SMatthew G. Knepley } 675329ad44c5SMatthew G. Knepley simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE; 675429ad44c5SMatthew G. Knepley ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr); 675529ad44c5SMatthew G. Knepley ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr); 675629ad44c5SMatthew G. Knepley ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr); 675729ad44c5SMatthew G. Knepley ierr = DMCreateDS(cdmOld);CHKERRQ(ierr); 675829ad44c5SMatthew G. Knepley } else { 675929ad44c5SMatthew G. Knepley const char *discname; 676029ad44c5SMatthew G. Knepley 676129ad44c5SMatthew G. Knepley ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr); 676229ad44c5SMatthew G. Knepley SETERRQ1(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname); 676329ad44c5SMatthew G. Knepley } 676429ad44c5SMatthew G. Knepley } 6765d864a3eaSLisandro Dalcin /* Make a fresh clone of the coordinate DM */ 6766d864a3eaSLisandro Dalcin ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr); 6767d864a3eaSLisandro Dalcin ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr); 6768d864a3eaSLisandro Dalcin ierr = DMCreateDS(cdmNew);CHKERRQ(ierr); 6769d864a3eaSLisandro Dalcin /* Project the coordinate vector from old to new space */ 6770d864a3eaSLisandro Dalcin ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr); 6771d864a3eaSLisandro Dalcin ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr); 6772d864a3eaSLisandro Dalcin ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr); 6773d864a3eaSLisandro Dalcin ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr); 6774d864a3eaSLisandro Dalcin ierr = MatDestroy(&matInterp);CHKERRQ(ierr); 6775d864a3eaSLisandro Dalcin /* Set new coordinate structures */ 6776d864a3eaSLisandro Dalcin ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr); 6777d864a3eaSLisandro Dalcin ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr); 6778d864a3eaSLisandro Dalcin ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr); 6779d864a3eaSLisandro Dalcin ierr = VecDestroy(&coordsNew);CHKERRQ(ierr); 6780d864a3eaSLisandro Dalcin ierr = DMDestroy(&cdmNew);CHKERRQ(ierr); 6781d864a3eaSLisandro Dalcin PetscFunctionReturn(0); 6782d864a3eaSLisandro Dalcin } 6783d864a3eaSLisandro Dalcin 67845dc8c3f7SMatthew G. Knepley /*@C 678590b157c4SStefano Zampini DMGetPeriodicity - Get the description of mesh periodicity 67865dc8c3f7SMatthew G. Knepley 6787f899ff85SJose E. Roman Input Parameter: 678890b157c4SStefano Zampini . dm - The DM object 678990b157c4SStefano Zampini 679090b157c4SStefano Zampini Output Parameters: 679190b157c4SStefano Zampini + per - Whether the DM is periodic or not 67925dc8c3f7SMatthew 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 67935dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 67945dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 67955dc8c3f7SMatthew G. Knepley 67965dc8c3f7SMatthew G. Knepley Level: developer 67975dc8c3f7SMatthew G. Knepley 67985dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 67995dc8c3f7SMatthew G. Knepley @*/ 680090b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd) 6801c6b900c6SMatthew G. Knepley { 6802c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6803c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 680490b157c4SStefano Zampini if (per) *per = dm->periodic; 6805c6b900c6SMatthew G. Knepley if (L) *L = dm->L; 6806c6b900c6SMatthew G. Knepley if (maxCell) *maxCell = dm->maxCell; 68075dc8c3f7SMatthew G. Knepley if (bd) *bd = dm->bdtype; 6808c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6809c6b900c6SMatthew G. Knepley } 6810c6b900c6SMatthew G. Knepley 68115dc8c3f7SMatthew G. Knepley /*@C 68125dc8c3f7SMatthew G. Knepley DMSetPeriodicity - Set the description of mesh periodicity 68135dc8c3f7SMatthew G. Knepley 68145dc8c3f7SMatthew G. Knepley Input Parameters: 68155dc8c3f7SMatthew G. Knepley + dm - The DM object 6816db2bf62eSStefano Zampini . per - Whether the DM is periodic or not. 6817db2bf62eSStefano Zampini . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates. Pass NULL to remove such information. 68185dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 68195dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 68205dc8c3f7SMatthew G. Knepley 6821db2bf62eSStefano Zampini Notes: If per is PETSC_TRUE and maxCell is not provided, coordinates need to be already localized, or must be localized by hand by the user. 6822db2bf62eSStefano Zampini 68235dc8c3f7SMatthew G. Knepley Level: developer 68245dc8c3f7SMatthew G. Knepley 68255dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 68265dc8c3f7SMatthew G. Knepley @*/ 682790b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[]) 6828c6b900c6SMatthew G. Knepley { 6829c6b900c6SMatthew G. Knepley PetscInt dim, d; 6830c6b900c6SMatthew G. Knepley PetscErrorCode ierr; 6831c6b900c6SMatthew G. Knepley 6832c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6833c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 683490b157c4SStefano Zampini PetscValidLogicalCollectiveBool(dm,per,2); 6835412e9a14SMatthew G. Knepley if (maxCell) {PetscValidRealPointer(maxCell,3);} 6836412e9a14SMatthew G. Knepley if (L) {PetscValidRealPointer(L,4);} 6837412e9a14SMatthew G. Knepley if (bd) {PetscValidPointer(bd,5);} 68385dc8c3f7SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 683990b157c4SStefano Zampini if (maxCell) { 6840412e9a14SMatthew G. Knepley if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);} 6841412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d]; 6842db2bf62eSStefano Zampini } else { /* remove maxCell information to disable automatic computation of localized vertices */ 6843db2bf62eSStefano Zampini ierr = PetscFree(dm->maxCell);CHKERRQ(ierr); 6844412e9a14SMatthew G. Knepley } 6845db2bf62eSStefano Zampini 6846412e9a14SMatthew G. Knepley if (L) { 6847412e9a14SMatthew G. Knepley if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);} 6848412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->L[d] = L[d]; 6849412e9a14SMatthew G. Knepley } 6850412e9a14SMatthew G. Knepley if (bd) { 6851412e9a14SMatthew G. Knepley if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);} 6852412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d]; 685390b157c4SStefano Zampini } 6854072d7d67SStefano Zampini dm->periodic = per; 6855c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6856c6b900c6SMatthew G. Knepley } 6857c6b900c6SMatthew G. Knepley 68582e17dfb7SMatthew G. Knepley /*@ 68592e17dfb7SMatthew 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. 68602e17dfb7SMatthew G. Knepley 68612e17dfb7SMatthew G. Knepley Input Parameters: 68622e17dfb7SMatthew G. Knepley + dm - The DM 686365da65dcSMatthew G. Knepley . in - The input coordinate point (dim numbers) 686465da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i 68652e17dfb7SMatthew G. Knepley 68662e17dfb7SMatthew G. Knepley Output Parameter: 68672e17dfb7SMatthew G. Knepley . out - The localized coordinate point 68682e17dfb7SMatthew G. Knepley 68692e17dfb7SMatthew G. Knepley Level: developer 68702e17dfb7SMatthew G. Knepley 68712e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 68722e17dfb7SMatthew G. Knepley @*/ 687365da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[]) 68742e17dfb7SMatthew G. Knepley { 68752e17dfb7SMatthew G. Knepley PetscInt dim, d; 68762e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 68772e17dfb7SMatthew G. Knepley 68782e17dfb7SMatthew G. Knepley PetscFunctionBegin; 68792e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr); 68802e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 68812e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 68822e17dfb7SMatthew G. Knepley } else { 688365da65dcSMatthew G. Knepley if (endpoint) { 688465da65dcSMatthew G. Knepley for (d = 0; d < dim; ++d) { 6885da3333bfSMatthew 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)) { 6886da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1); 688765da65dcSMatthew G. Knepley } else { 6888da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 688965da65dcSMatthew G. Knepley } 689065da65dcSMatthew G. Knepley } 689165da65dcSMatthew G. Knepley } else { 68922e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 68931118d4bcSLisandro Dalcin out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 68942e17dfb7SMatthew G. Knepley } 68952e17dfb7SMatthew G. Knepley } 689665da65dcSMatthew G. Knepley } 68972e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 68982e17dfb7SMatthew G. Knepley } 68992e17dfb7SMatthew G. Knepley 69002e17dfb7SMatthew G. Knepley /* 69012e17dfb7SMatthew 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. 69022e17dfb7SMatthew G. Knepley 69032e17dfb7SMatthew G. Knepley Input Parameters: 69042e17dfb7SMatthew G. Knepley + dm - The DM 69052e17dfb7SMatthew G. Knepley . dim - The spatial dimension 69062e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 69072e17dfb7SMatthew G. Knepley - in - The input coordinate point (dim numbers) 69082e17dfb7SMatthew G. Knepley 69092e17dfb7SMatthew G. Knepley Output Parameter: 69102e17dfb7SMatthew G. Knepley . out - The localized coordinate point 69112e17dfb7SMatthew G. Knepley 69122e17dfb7SMatthew G. Knepley Level: developer 69132e17dfb7SMatthew G. Knepley 69142e17dfb7SMatthew 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 69152e17dfb7SMatthew G. Knepley 69162e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 69172e17dfb7SMatthew G. Knepley */ 69182e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 69192e17dfb7SMatthew G. Knepley { 69202e17dfb7SMatthew G. Knepley PetscInt d; 69212e17dfb7SMatthew G. Knepley 69222e17dfb7SMatthew G. Knepley PetscFunctionBegin; 69232e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 69242e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 69252e17dfb7SMatthew G. Knepley } else { 69262e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6927908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) { 69282e17dfb7SMatthew G. Knepley out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 69292e17dfb7SMatthew G. Knepley } else { 69302e17dfb7SMatthew G. Knepley out[d] = in[d]; 69312e17dfb7SMatthew G. Knepley } 69322e17dfb7SMatthew G. Knepley } 69332e17dfb7SMatthew G. Knepley } 69342e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 69352e17dfb7SMatthew G. Knepley } 6936a5801f52SStefano Zampini 69372e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[]) 69382e17dfb7SMatthew G. Knepley { 69392e17dfb7SMatthew G. Knepley PetscInt d; 69402e17dfb7SMatthew G. Knepley 69412e17dfb7SMatthew G. Knepley PetscFunctionBegin; 69422e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 69432e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 69442e17dfb7SMatthew G. Knepley } else { 69452e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6946908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) { 69472e17dfb7SMatthew G. Knepley out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d]; 69482e17dfb7SMatthew G. Knepley } else { 69492e17dfb7SMatthew G. Knepley out[d] = in[d]; 69502e17dfb7SMatthew G. Knepley } 69512e17dfb7SMatthew G. Knepley } 69522e17dfb7SMatthew G. Knepley } 69532e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 69542e17dfb7SMatthew G. Knepley } 69552e17dfb7SMatthew G. Knepley 69562e17dfb7SMatthew G. Knepley /* 69572e17dfb7SMatthew 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. 69582e17dfb7SMatthew G. Knepley 69592e17dfb7SMatthew G. Knepley Input Parameters: 69602e17dfb7SMatthew G. Knepley + dm - The DM 69612e17dfb7SMatthew G. Knepley . dim - The spatial dimension 69622e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 69632e17dfb7SMatthew G. Knepley . in - The input coordinate delta (dim numbers) 69642e17dfb7SMatthew G. Knepley - out - The input coordinate point (dim numbers) 69652e17dfb7SMatthew G. Knepley 69662e17dfb7SMatthew G. Knepley Output Parameter: 69672e17dfb7SMatthew G. Knepley . out - The localized coordinate in + out 69682e17dfb7SMatthew G. Knepley 69692e17dfb7SMatthew G. Knepley Level: developer 69702e17dfb7SMatthew G. Knepley 69712e17dfb7SMatthew 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 69722e17dfb7SMatthew G. Knepley 69732e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate() 69742e17dfb7SMatthew G. Knepley */ 69752e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 69762e17dfb7SMatthew G. Knepley { 69772e17dfb7SMatthew G. Knepley PetscInt d; 69782e17dfb7SMatthew G. Knepley 69792e17dfb7SMatthew G. Knepley PetscFunctionBegin; 69802e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 69812e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] += in[d]; 69822e17dfb7SMatthew G. Knepley } else { 69832e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6984412e9a14SMatthew G. Knepley const PetscReal maxC = dm->maxCell[d]; 6985412e9a14SMatthew G. Knepley 6986412e9a14SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) { 6987412e9a14SMatthew G. Knepley const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 6988412e9a14SMatthew G. Knepley 6989412e9a14SMatthew G. Knepley if (PetscAbsScalar(newCoord - anchor[d]) > maxC) 6990412e9a14SMatthew G. Knepley SETERRQ4(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%D-Coordinate %g more than %g away from anchor %g", d, (double) PetscRealPart(in[d]), (double) maxC, (double) PetscRealPart(anchor[d])); 6991412e9a14SMatthew G. Knepley out[d] += newCoord; 69922e17dfb7SMatthew G. Knepley } else { 69932e17dfb7SMatthew G. Knepley out[d] += in[d]; 69942e17dfb7SMatthew G. Knepley } 69952e17dfb7SMatthew G. Knepley } 69962e17dfb7SMatthew G. Knepley } 69972e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 69982e17dfb7SMatthew G. Knepley } 69992e17dfb7SMatthew G. Knepley 700036447a5eSToby Isaac /*@ 70018f700142SStefano Zampini DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process 70028f700142SStefano Zampini 70038f700142SStefano Zampini Not collective 700436447a5eSToby Isaac 700536447a5eSToby Isaac Input Parameter: 700636447a5eSToby Isaac . dm - The DM 700736447a5eSToby Isaac 700836447a5eSToby Isaac Output Parameter: 700936447a5eSToby Isaac areLocalized - True if localized 701036447a5eSToby Isaac 701136447a5eSToby Isaac Level: developer 701236447a5eSToby Isaac 70138f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity() 701436447a5eSToby Isaac @*/ 70158f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized) 701636447a5eSToby Isaac { 701736447a5eSToby Isaac DM cdm; 701836447a5eSToby Isaac PetscSection coordSection; 70192ccac677SMatthew G. Knepley PetscInt depth, cStart, cEnd, sStart, sEnd, c, dof; 702046a3a80fSLisandro Dalcin PetscBool isPlex, alreadyLocalized; 702136447a5eSToby Isaac PetscErrorCode ierr; 702236447a5eSToby Isaac 702336447a5eSToby Isaac PetscFunctionBegin; 702436447a5eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7025534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 70268b09590cSToby Isaac *areLocalized = PETSC_FALSE; 702746a3a80fSLisandro Dalcin 702836447a5eSToby Isaac /* We need some generic way of refering to cells/vertices */ 702936447a5eSToby Isaac ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 703046a3a80fSLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr); 70319f7230bfSMatthew G. Knepley if (!isPlex) PetscFunctionReturn(0); 70322ccac677SMatthew G. Knepley ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr); 70332ccac677SMatthew G. Knepley if (!depth) PetscFunctionReturn(0); 703446a3a80fSLisandro Dalcin 70359f7230bfSMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 703646a3a80fSLisandro Dalcin ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr); 703736447a5eSToby Isaac ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr); 703836447a5eSToby Isaac alreadyLocalized = PETSC_FALSE; 703946a3a80fSLisandro Dalcin for (c = cStart; c < cEnd; ++c) { 704046a3a80fSLisandro Dalcin if (c < sStart || c >= sEnd) continue; 704136447a5eSToby Isaac ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr); 704246a3a80fSLisandro Dalcin if (dof) { alreadyLocalized = PETSC_TRUE; break; } 704336447a5eSToby Isaac } 70448f700142SStefano Zampini *areLocalized = alreadyLocalized; 704536447a5eSToby Isaac PetscFunctionReturn(0); 704636447a5eSToby Isaac } 704736447a5eSToby Isaac 70488f700142SStefano Zampini /*@ 70498f700142SStefano Zampini DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells 70508f700142SStefano Zampini 70518f700142SStefano Zampini Collective on dm 70528f700142SStefano Zampini 70538f700142SStefano Zampini Input Parameter: 70548f700142SStefano Zampini . dm - The DM 70558f700142SStefano Zampini 70568f700142SStefano Zampini Output Parameter: 70578f700142SStefano Zampini areLocalized - True if localized 70588f700142SStefano Zampini 70598f700142SStefano Zampini Level: developer 70608f700142SStefano Zampini 70618f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal() 70628f700142SStefano Zampini @*/ 70638f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized) 70648f700142SStefano Zampini { 70658f700142SStefano Zampini PetscBool localized; 70668f700142SStefano Zampini PetscErrorCode ierr; 70678f700142SStefano Zampini 70688f700142SStefano Zampini PetscFunctionBegin; 70698f700142SStefano Zampini PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7070534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 70718f700142SStefano Zampini ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr); 7072820f2d46SBarry Smith ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 70738f700142SStefano Zampini PetscFunctionReturn(0); 70748f700142SStefano Zampini } 707536447a5eSToby Isaac 70762e17dfb7SMatthew G. Knepley /*@ 7077492b8470SStefano Zampini DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces 70782e17dfb7SMatthew G. Knepley 70798f700142SStefano Zampini Collective on dm 70808f700142SStefano Zampini 70812e17dfb7SMatthew G. Knepley Input Parameter: 70822e17dfb7SMatthew G. Knepley . dm - The DM 70832e17dfb7SMatthew G. Knepley 70842e17dfb7SMatthew G. Knepley Level: developer 70852e17dfb7SMatthew G. Knepley 70868f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate() 70872e17dfb7SMatthew G. Knepley @*/ 70882e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm) 70892e17dfb7SMatthew G. Knepley { 70902e17dfb7SMatthew G. Knepley DM cdm; 70912e17dfb7SMatthew G. Knepley PetscSection coordSection, cSection; 70922e17dfb7SMatthew G. Knepley Vec coordinates, cVec; 70933e922f36SToby Isaac PetscScalar *coords, *coords2, *anchor, *localized; 70943e922f36SToby Isaac PetscInt Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize; 7095e0ae35bbSToby Isaac PetscBool alreadyLocalized, alreadyLocalizedGlobal; 70963e922f36SToby Isaac PetscInt maxHeight = 0, h; 70973e922f36SToby Isaac PetscInt *pStart = NULL, *pEnd = NULL; 70982e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 70992e17dfb7SMatthew G. Knepley 71002e17dfb7SMatthew G. Knepley PetscFunctionBegin; 71012e17dfb7SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 710292c9c85fSStefano Zampini if (!dm->periodic) PetscFunctionReturn(0); 7103f7cbd40bSStefano Zampini ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr); 7104f7cbd40bSStefano Zampini if (alreadyLocalized) PetscFunctionReturn(0); 7105f7cbd40bSStefano Zampini 71062e17dfb7SMatthew G. Knepley /* We need some generic way of refering to cells/vertices */ 71072e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 71082e17dfb7SMatthew G. Knepley { 71092e17dfb7SMatthew G. Knepley PetscBool isplex; 71102e17dfb7SMatthew G. Knepley 71112e17dfb7SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr); 71122e17dfb7SMatthew G. Knepley if (isplex) { 71132e17dfb7SMatthew G. Knepley ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr); 71143e922f36SToby Isaac ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr); 711569291d52SBarry Smith ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 71163e922f36SToby Isaac pEnd = &pStart[maxHeight + 1]; 71173e922f36SToby Isaac newStart = vStart; 71183e922f36SToby Isaac newEnd = vEnd; 71193e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 71203e922f36SToby Isaac ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr); 71213e922f36SToby Isaac newStart = PetscMin(newStart,pStart[h]); 71223e922f36SToby Isaac newEnd = PetscMax(newEnd,pEnd[h]); 71233e922f36SToby Isaac } 71242e17dfb7SMatthew G. Knepley } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM"); 71252e17dfb7SMatthew G. Knepley } 71262e17dfb7SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr); 712743eeeb2dSStefano Zampini if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector"); 71282e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 71293e922f36SToby Isaac ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr); 7130e0ae35bbSToby Isaac ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr); 71313e922f36SToby Isaac 71322e17dfb7SMatthew G. Knepley ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr); 71332e17dfb7SMatthew G. Knepley ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr); 71342e17dfb7SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr); 71352e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr); 71363e922f36SToby Isaac ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr); 71373e922f36SToby Isaac 713869291d52SBarry Smith ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 71393e922f36SToby Isaac localized = &anchor[bs]; 71403e922f36SToby Isaac alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE; 71413e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 71423e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 71433e922f36SToby Isaac 71443e922f36SToby Isaac for (c = cStart; c < cEnd; ++c) { 71453e922f36SToby Isaac PetscScalar *cellCoords = NULL; 71463e922f36SToby Isaac PetscInt b; 71473e922f36SToby Isaac 71483e922f36SToby Isaac if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE; 71493e922f36SToby Isaac ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 71503e922f36SToby Isaac for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 71513e922f36SToby Isaac for (d = 0; d < dof/bs; ++d) { 71523e922f36SToby Isaac ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr); 71533e922f36SToby Isaac for (b = 0; b < bs; b++) { 71543e922f36SToby Isaac if (cellCoords[d*bs + b] != localized[b]) break; 71553e922f36SToby Isaac } 71563e922f36SToby Isaac if (b < bs) break; 71573e922f36SToby Isaac } 71583e922f36SToby Isaac if (d < dof/bs) { 71593e922f36SToby Isaac if (c >= sStart && c < sEnd) { 71603e922f36SToby Isaac PetscInt cdof; 71613e922f36SToby Isaac 71623e922f36SToby Isaac ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr); 71633e922f36SToby Isaac if (cdof != dof) alreadyLocalized = PETSC_FALSE; 71643e922f36SToby Isaac } 71653e922f36SToby Isaac ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr); 71663e922f36SToby Isaac ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr); 71673e922f36SToby Isaac } 71683e922f36SToby Isaac ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 71693e922f36SToby Isaac } 71703e922f36SToby Isaac } 7171ffc4695bSBarry Smith ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 71723e922f36SToby Isaac if (alreadyLocalizedGlobal) { 717369291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 71743e922f36SToby Isaac ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 717569291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 71763e922f36SToby Isaac PetscFunctionReturn(0); 71773e922f36SToby Isaac } 71782e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 71792e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 71802e17dfb7SMatthew G. Knepley ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr); 71812e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr); 71822e17dfb7SMatthew G. Knepley } 71832e17dfb7SMatthew G. Knepley ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr); 71842e17dfb7SMatthew G. Knepley ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr); 7185c2be7e5eSLisandro Dalcin ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr); 71862e17dfb7SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr); 71872e17dfb7SMatthew G. Knepley ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr); 71882e17dfb7SMatthew G. Knepley ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr); 71892e17dfb7SMatthew G. Knepley ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr); 7190c2be7e5eSLisandro Dalcin ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 71912e17dfb7SMatthew G. Knepley ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr); 71922e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 71932e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 71942e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr); 71952e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, v, &off2);CHKERRQ(ierr); 71962e17dfb7SMatthew G. Knepley for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d]; 71972e17dfb7SMatthew G. Knepley } 71983e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 71993e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 72003e922f36SToby Isaac 72012e17dfb7SMatthew G. Knepley for (c = cStart; c < cEnd; ++c) { 72022e17dfb7SMatthew G. Knepley PetscScalar *cellCoords = NULL; 72033e922f36SToby Isaac PetscInt b, cdof; 72042e17dfb7SMatthew G. Knepley 72053e922f36SToby Isaac ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr); 72063e922f36SToby Isaac if (!cdof) continue; 72072e17dfb7SMatthew G. Knepley ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 72082e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr); 72092e17dfb7SMatthew G. Knepley for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 72102e17dfb7SMatthew G. Knepley for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);} 72112e17dfb7SMatthew G. Knepley ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 72122e17dfb7SMatthew G. Knepley } 72133e922f36SToby Isaac } 721469291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 721569291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 7216c2be7e5eSLisandro Dalcin ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 72172e17dfb7SMatthew G. Knepley ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr); 72182e17dfb7SMatthew G. Knepley ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr); 72192e17dfb7SMatthew G. Knepley ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr); 72202e17dfb7SMatthew G. Knepley ierr = VecDestroy(&cVec);CHKERRQ(ierr); 72212e17dfb7SMatthew G. Knepley ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 72222e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 72232e17dfb7SMatthew G. Knepley } 72242e17dfb7SMatthew G. Knepley 7225e87bb0d3SMatthew G Knepley /*@ 72263a93e3b7SToby Isaac DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells 7227e87bb0d3SMatthew G Knepley 7228d083f849SBarry Smith Collective on v (see explanation below) 7229e87bb0d3SMatthew G Knepley 7230e87bb0d3SMatthew G Knepley Input Parameters: 7231e87bb0d3SMatthew G Knepley + dm - The DM 72326b867d5aSJose E. Roman - ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST 7233e87bb0d3SMatthew G Knepley 72346b867d5aSJose E. Roman Input/Output Parameters: 72356b867d5aSJose E. Roman + v - The Vec of points, on output contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used 72366b867d5aSJose E. Roman - cellSF - Points to either NULL, or a PetscSF with guesses for which cells contain each point; 72376b867d5aSJose E. Roman on output, the PetscSF containing the ranks and local indices of the containing points 72383a93e3b7SToby Isaac 7239e87bb0d3SMatthew G Knepley Level: developer 724061e3bb9bSMatthew G Knepley 724162a38674SMatthew G. Knepley Notes: 72423a93e3b7SToby Isaac To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator. 724362a38674SMatthew G. Knepley To do a search of all the cells in the distributed mesh, v should have the same communicator as dm. 72443a93e3b7SToby Isaac 72453a93e3b7SToby Isaac If *cellSF is NULL on input, a PetscSF will be created. 724662a38674SMatthew G. Knepley If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses. 72473a93e3b7SToby Isaac 72483a93e3b7SToby Isaac An array that maps each point to its containing cell can be obtained with 72493a93e3b7SToby Isaac 725062a38674SMatthew G. Knepley $ const PetscSFNode *cells; 725162a38674SMatthew G. Knepley $ PetscInt nFound; 7252a6216909SToby Isaac $ const PetscInt *found; 725362a38674SMatthew G. Knepley $ 7254a6216909SToby Isaac $ PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells); 72553a93e3b7SToby Isaac 72563a93e3b7SToby 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 72573a93e3b7SToby Isaac the index of the cell in its rank's local numbering. 72583a93e3b7SToby Isaac 725962a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType 726061e3bb9bSMatthew G Knepley @*/ 726162a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF) 7262e87bb0d3SMatthew G Knepley { 7263735aa83eSMatthew G Knepley PetscErrorCode ierr; 7264735aa83eSMatthew G Knepley 7265e87bb0d3SMatthew G Knepley PetscFunctionBegin; 7266e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7267e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,2); 7268e0fc9d1bSMatthew G. Knepley PetscValidPointer(cellSF,4); 72693a93e3b7SToby Isaac if (*cellSF) { 72703a93e3b7SToby Isaac PetscMPIInt result; 72713a93e3b7SToby Isaac 7272e0fc9d1bSMatthew G. Knepley PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4); 7273ffc4695bSBarry Smith ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr); 72743a93e3b7SToby 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"); 7275e0fc9d1bSMatthew G. Knepley } else { 72763a93e3b7SToby Isaac ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr); 72773a93e3b7SToby Isaac } 7278b9d85ea2SLisandro Dalcin if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM"); 727947a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 728062a38674SMatthew G. Knepley ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr); 728147a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 7282e87bb0d3SMatthew G Knepley PetscFunctionReturn(0); 7283e87bb0d3SMatthew G Knepley } 728414f150ffSMatthew G. Knepley 7285f4d763aaSMatthew G. Knepley /*@ 7286f4d763aaSMatthew G. Knepley DMGetOutputDM - Retrieve the DM associated with the layout for output 7287f4d763aaSMatthew G. Knepley 72888f700142SStefano Zampini Collective on dm 72898f700142SStefano Zampini 7290f4d763aaSMatthew G. Knepley Input Parameter: 7291f4d763aaSMatthew G. Knepley . dm - The original DM 7292f4d763aaSMatthew G. Knepley 7293f4d763aaSMatthew G. Knepley Output Parameter: 7294f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output 7295f4d763aaSMatthew G. Knepley 7296f4d763aaSMatthew G. Knepley Level: intermediate 7297f4d763aaSMatthew G. Knepley 7298e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection() 7299f4d763aaSMatthew G. Knepley @*/ 730014f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm) 730114f150ffSMatthew G. Knepley { 7302c26acbdeSMatthew G. Knepley PetscSection section; 73032d4e4a49SMatthew G. Knepley PetscBool hasConstraints, ghasConstraints; 730414f150ffSMatthew G. Knepley PetscErrorCode ierr; 730514f150ffSMatthew G. Knepley 730614f150ffSMatthew G. Knepley PetscFunctionBegin; 730714f150ffSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 730814f150ffSMatthew G. Knepley PetscValidPointer(odm,2); 730992fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 7310c26acbdeSMatthew G. Knepley ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr); 7311ffc4695bSBarry Smith ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr); 73122d4e4a49SMatthew G. Knepley if (!ghasConstraints) { 7313c26acbdeSMatthew G. Knepley *odm = dm; 7314c26acbdeSMatthew G. Knepley PetscFunctionReturn(0); 7315c26acbdeSMatthew G. Knepley } 731614f150ffSMatthew G. Knepley if (!dm->dmBC) { 7317c26acbdeSMatthew G. Knepley PetscSection newSection, gsection; 731814f150ffSMatthew G. Knepley PetscSF sf; 731914f150ffSMatthew G. Knepley 732014f150ffSMatthew G. Knepley ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr); 7321e5e52638SMatthew G. Knepley ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr); 732214f150ffSMatthew G. Knepley ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr); 732392fd8e1eSJed Brown ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr); 732414f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr); 732514f150ffSMatthew G. Knepley ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr); 732615b58121SMatthew G. Knepley ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr); 7327e87a4003SBarry Smith ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr); 732814f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr); 732914f150ffSMatthew G. Knepley } 733014f150ffSMatthew G. Knepley *odm = dm->dmBC; 733114f150ffSMatthew G. Knepley PetscFunctionReturn(0); 733214f150ffSMatthew G. Knepley } 7333f4d763aaSMatthew G. Knepley 7334f4d763aaSMatthew G. Knepley /*@ 7335cdb7a50dSMatthew G. Knepley DMGetOutputSequenceNumber - Retrieve the sequence number/value for output 7336f4d763aaSMatthew G. Knepley 7337f4d763aaSMatthew G. Knepley Input Parameter: 7338f4d763aaSMatthew G. Knepley . dm - The original DM 7339f4d763aaSMatthew G. Knepley 7340cdb7a50dSMatthew G. Knepley Output Parameters: 7341cdb7a50dSMatthew G. Knepley + num - The output sequence number 7342cdb7a50dSMatthew G. Knepley - val - The output sequence value 7343f4d763aaSMatthew G. Knepley 7344f4d763aaSMatthew G. Knepley Level: intermediate 7345f4d763aaSMatthew G. Knepley 7346f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7347f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7348f4d763aaSMatthew G. Knepley 7349f4d763aaSMatthew G. Knepley .seealso: VecView() 7350f4d763aaSMatthew G. Knepley @*/ 7351cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val) 7352f4d763aaSMatthew G. Knepley { 7353f4d763aaSMatthew G. Knepley PetscFunctionBegin; 7354f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7355534a8f05SLisandro Dalcin if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;} 7356534a8f05SLisandro Dalcin if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;} 7357f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 7358f4d763aaSMatthew G. Knepley } 7359f4d763aaSMatthew G. Knepley 7360f4d763aaSMatthew G. Knepley /*@ 7361cdb7a50dSMatthew G. Knepley DMSetOutputSequenceNumber - Set the sequence number/value for output 7362f4d763aaSMatthew G. Knepley 7363f4d763aaSMatthew G. Knepley Input Parameters: 7364f4d763aaSMatthew G. Knepley + dm - The original DM 7365cdb7a50dSMatthew G. Knepley . num - The output sequence number 7366cdb7a50dSMatthew G. Knepley - val - The output sequence value 7367f4d763aaSMatthew G. Knepley 7368f4d763aaSMatthew G. Knepley Level: intermediate 7369f4d763aaSMatthew G. Knepley 7370f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7371f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7372f4d763aaSMatthew G. Knepley 7373f4d763aaSMatthew G. Knepley .seealso: VecView() 7374f4d763aaSMatthew G. Knepley @*/ 7375cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val) 7376f4d763aaSMatthew G. Knepley { 7377f4d763aaSMatthew G. Knepley PetscFunctionBegin; 7378f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7379f4d763aaSMatthew G. Knepley dm->outputSequenceNum = num; 7380cdb7a50dSMatthew G. Knepley dm->outputSequenceVal = val; 7381cdb7a50dSMatthew G. Knepley PetscFunctionReturn(0); 7382cdb7a50dSMatthew G. Knepley } 7383cdb7a50dSMatthew G. Knepley 7384cdb7a50dSMatthew G. Knepley /*@C 7385cdb7a50dSMatthew G. Knepley DMOutputSequenceLoad - Retrieve the sequence value from a Viewer 7386cdb7a50dSMatthew G. Knepley 7387cdb7a50dSMatthew G. Knepley Input Parameters: 7388cdb7a50dSMatthew G. Knepley + dm - The original DM 7389cdb7a50dSMatthew G. Knepley . name - The sequence name 7390cdb7a50dSMatthew G. Knepley - num - The output sequence number 7391cdb7a50dSMatthew G. Knepley 7392cdb7a50dSMatthew G. Knepley Output Parameter: 7393cdb7a50dSMatthew G. Knepley . val - The output sequence value 7394cdb7a50dSMatthew G. Knepley 7395cdb7a50dSMatthew G. Knepley Level: intermediate 7396cdb7a50dSMatthew G. Knepley 7397cdb7a50dSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7398cdb7a50dSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7399cdb7a50dSMatthew G. Knepley 7400cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView() 7401cdb7a50dSMatthew G. Knepley @*/ 7402cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val) 7403cdb7a50dSMatthew G. Knepley { 7404cdb7a50dSMatthew G. Knepley PetscBool ishdf5; 7405cdb7a50dSMatthew G. Knepley PetscErrorCode ierr; 7406cdb7a50dSMatthew G. Knepley 7407cdb7a50dSMatthew G. Knepley PetscFunctionBegin; 7408cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7409cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 7410064a246eSJacob Faibussowitsch PetscValidRealPointer(val,5); 7411cdb7a50dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr); 7412cdb7a50dSMatthew G. Knepley if (ishdf5) { 7413cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5) 7414cdb7a50dSMatthew G. Knepley PetscScalar value; 7415cdb7a50dSMatthew G. Knepley 741639d25373SMatthew G. Knepley ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr); 74174aeb217fSMatthew G. Knepley *val = PetscRealPart(value); 7418cdb7a50dSMatthew G. Knepley #endif 7419cdb7a50dSMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()"); 7420f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 7421f4d763aaSMatthew G. Knepley } 74228e4ac7eaSMatthew G. Knepley 74238e4ac7eaSMatthew G. Knepley /*@ 74248e4ac7eaSMatthew G. Knepley DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution 74258e4ac7eaSMatthew G. Knepley 74268e4ac7eaSMatthew G. Knepley Not collective 74278e4ac7eaSMatthew G. Knepley 74288e4ac7eaSMatthew G. Knepley Input Parameter: 74298e4ac7eaSMatthew G. Knepley . dm - The DM 74308e4ac7eaSMatthew G. Knepley 74318e4ac7eaSMatthew G. Knepley Output Parameter: 74328e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution 74338e4ac7eaSMatthew G. Knepley 74348e4ac7eaSMatthew G. Knepley Level: beginner 74358e4ac7eaSMatthew G. Knepley 74368e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate() 74378e4ac7eaSMatthew G. Knepley @*/ 74388e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural) 74398e4ac7eaSMatthew G. Knepley { 74408e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 74418e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7442534a8f05SLisandro Dalcin PetscValidBoolPointer(useNatural, 2); 74438e4ac7eaSMatthew G. Knepley *useNatural = dm->useNatural; 74448e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 74458e4ac7eaSMatthew G. Knepley } 74468e4ac7eaSMatthew G. Knepley 74478e4ac7eaSMatthew G. Knepley /*@ 74485d3b26e6SMatthew G. Knepley DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution 74498e4ac7eaSMatthew G. Knepley 74508e4ac7eaSMatthew G. Knepley Collective on dm 74518e4ac7eaSMatthew G. Knepley 74528e4ac7eaSMatthew G. Knepley Input Parameters: 74538e4ac7eaSMatthew G. Knepley + dm - The DM 74548e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution 74558e4ac7eaSMatthew G. Knepley 74565d3b26e6SMatthew G. Knepley Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM() 74575d3b26e6SMatthew G. Knepley 74588e4ac7eaSMatthew G. Knepley Level: beginner 74598e4ac7eaSMatthew G. Knepley 74605d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM() 74618e4ac7eaSMatthew G. Knepley @*/ 74628e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural) 74638e4ac7eaSMatthew G. Knepley { 74648e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 74658e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 74668833efb5SBlaise Bourdin PetscValidLogicalCollectiveBool(dm, useNatural, 2); 74678e4ac7eaSMatthew G. Knepley dm->useNatural = useNatural; 74688e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 74698e4ac7eaSMatthew G. Knepley } 7470c58f1c22SToby Isaac 7471c58f1c22SToby Isaac /*@C 7472c58f1c22SToby Isaac DMCreateLabel - Create a label of the given name if it does not already exist 7473c58f1c22SToby Isaac 7474c58f1c22SToby Isaac Not Collective 7475c58f1c22SToby Isaac 7476c58f1c22SToby Isaac Input Parameters: 7477c58f1c22SToby Isaac + dm - The DM object 7478c58f1c22SToby Isaac - name - The label name 7479c58f1c22SToby Isaac 7480c58f1c22SToby Isaac Level: intermediate 7481c58f1c22SToby Isaac 7482c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7483c58f1c22SToby Isaac @*/ 7484c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[]) 7485c58f1c22SToby Isaac { 74865d80c0bfSVaclav Hapla PetscBool flg; 74875d80c0bfSVaclav Hapla DMLabel label; 7488c58f1c22SToby Isaac PetscErrorCode ierr; 7489c58f1c22SToby Isaac 7490c58f1c22SToby Isaac PetscFunctionBegin; 7491c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7492c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 74935d80c0bfSVaclav Hapla ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 7494c58f1c22SToby Isaac if (!flg) { 74955d80c0bfSVaclav Hapla ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 74965d80c0bfSVaclav Hapla ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 74975d80c0bfSVaclav Hapla ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 7498c58f1c22SToby Isaac } 7499c58f1c22SToby Isaac PetscFunctionReturn(0); 7500c58f1c22SToby Isaac } 7501c58f1c22SToby Isaac 7502c58f1c22SToby Isaac /*@C 75030fdc7489SMatthew Knepley DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index. 75040fdc7489SMatthew Knepley 75050fdc7489SMatthew Knepley Not Collective 75060fdc7489SMatthew Knepley 75070fdc7489SMatthew Knepley Input Parameters: 75080fdc7489SMatthew Knepley + dm - The DM object 75090fdc7489SMatthew Knepley . l - The index for the label 75100fdc7489SMatthew Knepley - name - The label name 75110fdc7489SMatthew Knepley 75120fdc7489SMatthew Knepley Level: intermediate 75130fdc7489SMatthew Knepley 75140fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 75150fdc7489SMatthew Knepley @*/ 75160fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[]) 75170fdc7489SMatthew Knepley { 75180fdc7489SMatthew Knepley DMLabelLink orig, prev = NULL; 75190fdc7489SMatthew Knepley DMLabel label; 75200fdc7489SMatthew Knepley PetscInt Nl, m; 75210fdc7489SMatthew Knepley PetscBool flg, match; 75220fdc7489SMatthew Knepley const char *lname; 75230fdc7489SMatthew Knepley PetscErrorCode ierr; 75240fdc7489SMatthew Knepley 75250fdc7489SMatthew Knepley PetscFunctionBegin; 75260fdc7489SMatthew Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7527064a246eSJacob Faibussowitsch PetscValidCharPointer(name, 3); 75280fdc7489SMatthew Knepley ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 75290fdc7489SMatthew Knepley if (!flg) { 75300fdc7489SMatthew Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 75310fdc7489SMatthew Knepley ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 75320fdc7489SMatthew Knepley ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 75330fdc7489SMatthew Knepley } 75340fdc7489SMatthew Knepley ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr); 75350fdc7489SMatthew Knepley if (l >= Nl) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl); 75360fdc7489SMatthew Knepley for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) { 75370fdc7489SMatthew Knepley ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr); 75380fdc7489SMatthew Knepley ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr); 75390fdc7489SMatthew Knepley if (match) break; 75400fdc7489SMatthew Knepley } 75410fdc7489SMatthew Knepley if (m == l) PetscFunctionReturn(0); 75420fdc7489SMatthew Knepley if (!m) dm->labels = orig->next; 75430fdc7489SMatthew Knepley else prev->next = orig->next; 75440fdc7489SMatthew Knepley if (!l) { 75450fdc7489SMatthew Knepley orig->next = dm->labels; 75460fdc7489SMatthew Knepley dm->labels = orig; 75470fdc7489SMatthew Knepley } else { 75480fdc7489SMatthew Knepley for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next); 75490fdc7489SMatthew Knepley orig->next = prev->next; 75500fdc7489SMatthew Knepley prev->next = orig; 75510fdc7489SMatthew Knepley } 75520fdc7489SMatthew Knepley PetscFunctionReturn(0); 75530fdc7489SMatthew Knepley } 75540fdc7489SMatthew Knepley 75550fdc7489SMatthew Knepley /*@C 7556c58f1c22SToby Isaac DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default 7557c58f1c22SToby Isaac 7558c58f1c22SToby Isaac Not Collective 7559c58f1c22SToby Isaac 7560c58f1c22SToby Isaac Input Parameters: 7561c58f1c22SToby Isaac + dm - The DM object 7562c58f1c22SToby Isaac . name - The label name 7563c58f1c22SToby Isaac - point - The mesh point 7564c58f1c22SToby Isaac 7565c58f1c22SToby Isaac Output Parameter: 7566c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label 7567c58f1c22SToby Isaac 7568c58f1c22SToby Isaac Level: beginner 7569c58f1c22SToby Isaac 7570c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS() 7571c58f1c22SToby Isaac @*/ 7572c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value) 7573c58f1c22SToby Isaac { 7574c58f1c22SToby Isaac DMLabel label; 7575c58f1c22SToby Isaac PetscErrorCode ierr; 7576c58f1c22SToby Isaac 7577c58f1c22SToby Isaac PetscFunctionBegin; 7578c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7579c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7580c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 758113903a91SSatish Balay if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name); 7582c58f1c22SToby Isaac ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr); 7583c58f1c22SToby Isaac PetscFunctionReturn(0); 7584c58f1c22SToby Isaac } 7585c58f1c22SToby Isaac 7586c58f1c22SToby Isaac /*@C 7587c58f1c22SToby Isaac DMSetLabelValue - Add a point to a Sieve Label with given value 7588c58f1c22SToby Isaac 7589c58f1c22SToby Isaac Not Collective 7590c58f1c22SToby Isaac 7591c58f1c22SToby Isaac Input Parameters: 7592c58f1c22SToby Isaac + dm - The DM object 7593c58f1c22SToby Isaac . name - The label name 7594c58f1c22SToby Isaac . point - The mesh point 7595c58f1c22SToby Isaac - value - The label value for this point 7596c58f1c22SToby Isaac 7597c58f1c22SToby Isaac Output Parameter: 7598c58f1c22SToby Isaac 7599c58f1c22SToby Isaac Level: beginner 7600c58f1c22SToby Isaac 7601c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue() 7602c58f1c22SToby Isaac @*/ 7603c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 7604c58f1c22SToby Isaac { 7605c58f1c22SToby Isaac DMLabel label; 7606c58f1c22SToby Isaac PetscErrorCode ierr; 7607c58f1c22SToby Isaac 7608c58f1c22SToby Isaac PetscFunctionBegin; 7609c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7610c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7611c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7612c58f1c22SToby Isaac if (!label) { 7613c58f1c22SToby Isaac ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 7614c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7615c58f1c22SToby Isaac } 7616c58f1c22SToby Isaac ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr); 7617c58f1c22SToby Isaac PetscFunctionReturn(0); 7618c58f1c22SToby Isaac } 7619c58f1c22SToby Isaac 7620c58f1c22SToby Isaac /*@C 7621c58f1c22SToby Isaac DMClearLabelValue - Remove a point from a Sieve Label with given value 7622c58f1c22SToby Isaac 7623c58f1c22SToby Isaac Not Collective 7624c58f1c22SToby Isaac 7625c58f1c22SToby Isaac Input Parameters: 7626c58f1c22SToby Isaac + dm - The DM object 7627c58f1c22SToby Isaac . name - The label name 7628c58f1c22SToby Isaac . point - The mesh point 7629c58f1c22SToby Isaac - value - The label value for this point 7630c58f1c22SToby Isaac 7631c58f1c22SToby Isaac Output Parameter: 7632c58f1c22SToby Isaac 7633c58f1c22SToby Isaac Level: beginner 7634c58f1c22SToby Isaac 7635c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS() 7636c58f1c22SToby Isaac @*/ 7637c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 7638c58f1c22SToby Isaac { 7639c58f1c22SToby Isaac DMLabel label; 7640c58f1c22SToby Isaac PetscErrorCode ierr; 7641c58f1c22SToby Isaac 7642c58f1c22SToby Isaac PetscFunctionBegin; 7643c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7644c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7645c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7646c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7647c58f1c22SToby Isaac ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr); 7648c58f1c22SToby Isaac PetscFunctionReturn(0); 7649c58f1c22SToby Isaac } 7650c58f1c22SToby Isaac 7651c58f1c22SToby Isaac /*@C 7652c58f1c22SToby Isaac DMGetLabelSize - Get the number of different integer ids in a Label 7653c58f1c22SToby Isaac 7654c58f1c22SToby Isaac Not Collective 7655c58f1c22SToby Isaac 7656c58f1c22SToby Isaac Input Parameters: 7657c58f1c22SToby Isaac + dm - The DM object 7658c58f1c22SToby Isaac - name - The label name 7659c58f1c22SToby Isaac 7660c58f1c22SToby Isaac Output Parameter: 7661c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist 7662c58f1c22SToby Isaac 7663c58f1c22SToby Isaac Level: beginner 7664c58f1c22SToby Isaac 7665df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue() 7666c58f1c22SToby Isaac @*/ 7667c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size) 7668c58f1c22SToby Isaac { 7669c58f1c22SToby Isaac DMLabel label; 7670c58f1c22SToby Isaac PetscErrorCode ierr; 7671c58f1c22SToby Isaac 7672c58f1c22SToby Isaac PetscFunctionBegin; 7673c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7674c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7675534a8f05SLisandro Dalcin PetscValidIntPointer(size, 3); 7676c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7677c58f1c22SToby Isaac *size = 0; 7678c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7679c58f1c22SToby Isaac ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr); 7680c58f1c22SToby Isaac PetscFunctionReturn(0); 7681c58f1c22SToby Isaac } 7682c58f1c22SToby Isaac 7683c58f1c22SToby Isaac /*@C 7684c58f1c22SToby Isaac DMGetLabelIdIS - Get the integer ids in a label 7685c58f1c22SToby Isaac 7686c58f1c22SToby Isaac Not Collective 7687c58f1c22SToby Isaac 7688c58f1c22SToby Isaac Input Parameters: 7689c58f1c22SToby Isaac + mesh - The DM object 7690c58f1c22SToby Isaac - name - The label name 7691c58f1c22SToby Isaac 7692c58f1c22SToby Isaac Output Parameter: 7693c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist 7694c58f1c22SToby Isaac 7695c58f1c22SToby Isaac Level: beginner 7696c58f1c22SToby Isaac 7697c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize() 7698c58f1c22SToby Isaac @*/ 7699c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids) 7700c58f1c22SToby Isaac { 7701c58f1c22SToby Isaac DMLabel label; 7702c58f1c22SToby Isaac PetscErrorCode ierr; 7703c58f1c22SToby Isaac 7704c58f1c22SToby Isaac PetscFunctionBegin; 7705c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7706c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7707c58f1c22SToby Isaac PetscValidPointer(ids, 3); 7708c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7709c58f1c22SToby Isaac *ids = NULL; 7710dab2e251SBlaise Bourdin if (label) { 7711c58f1c22SToby Isaac ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr); 7712dab2e251SBlaise Bourdin } else { 7713dab2e251SBlaise Bourdin /* returning an empty IS */ 7714dab2e251SBlaise Bourdin ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr); 7715dab2e251SBlaise Bourdin } 7716c58f1c22SToby Isaac PetscFunctionReturn(0); 7717c58f1c22SToby Isaac } 7718c58f1c22SToby Isaac 7719c58f1c22SToby Isaac /*@C 7720c58f1c22SToby Isaac DMGetStratumSize - Get the number of points in a label stratum 7721c58f1c22SToby Isaac 7722c58f1c22SToby Isaac Not Collective 7723c58f1c22SToby Isaac 7724c58f1c22SToby Isaac Input Parameters: 7725c58f1c22SToby Isaac + dm - The DM object 7726c58f1c22SToby Isaac . name - The label name 7727c58f1c22SToby Isaac - value - The stratum value 7728c58f1c22SToby Isaac 7729c58f1c22SToby Isaac Output Parameter: 7730c58f1c22SToby Isaac . size - The stratum size 7731c58f1c22SToby Isaac 7732c58f1c22SToby Isaac Level: beginner 7733c58f1c22SToby Isaac 7734c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds() 7735c58f1c22SToby Isaac @*/ 7736c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size) 7737c58f1c22SToby Isaac { 7738c58f1c22SToby Isaac DMLabel label; 7739c58f1c22SToby Isaac PetscErrorCode ierr; 7740c58f1c22SToby Isaac 7741c58f1c22SToby Isaac PetscFunctionBegin; 7742c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7743c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7744534a8f05SLisandro Dalcin PetscValidIntPointer(size, 4); 7745c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7746c58f1c22SToby Isaac *size = 0; 7747c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7748c58f1c22SToby Isaac ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr); 7749c58f1c22SToby Isaac PetscFunctionReturn(0); 7750c58f1c22SToby Isaac } 7751c58f1c22SToby Isaac 7752c58f1c22SToby Isaac /*@C 7753c58f1c22SToby Isaac DMGetStratumIS - Get the points in a label stratum 7754c58f1c22SToby Isaac 7755c58f1c22SToby Isaac Not Collective 7756c58f1c22SToby Isaac 7757c58f1c22SToby Isaac Input Parameters: 7758c58f1c22SToby Isaac + dm - The DM object 7759c58f1c22SToby Isaac . name - The label name 7760c58f1c22SToby Isaac - value - The stratum value 7761c58f1c22SToby Isaac 7762c58f1c22SToby Isaac Output Parameter: 7763c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value 7764c58f1c22SToby Isaac 7765c58f1c22SToby Isaac Level: beginner 7766c58f1c22SToby Isaac 7767c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize() 7768c58f1c22SToby Isaac @*/ 7769c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points) 7770c58f1c22SToby Isaac { 7771c58f1c22SToby Isaac DMLabel label; 7772c58f1c22SToby Isaac PetscErrorCode ierr; 7773c58f1c22SToby Isaac 7774c58f1c22SToby Isaac PetscFunctionBegin; 7775c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7776c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7777c58f1c22SToby Isaac PetscValidPointer(points, 4); 7778c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7779c58f1c22SToby Isaac *points = NULL; 7780c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7781c58f1c22SToby Isaac ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr); 7782c58f1c22SToby Isaac PetscFunctionReturn(0); 7783c58f1c22SToby Isaac } 7784c58f1c22SToby Isaac 77854de306b1SToby Isaac /*@C 77869044fa66SMatthew G. Knepley DMSetStratumIS - Set the points in a label stratum 77874de306b1SToby Isaac 77884de306b1SToby Isaac Not Collective 77894de306b1SToby Isaac 77904de306b1SToby Isaac Input Parameters: 77914de306b1SToby Isaac + dm - The DM object 77924de306b1SToby Isaac . name - The label name 77934de306b1SToby Isaac . value - The stratum value 77944de306b1SToby Isaac - points - The stratum points 77954de306b1SToby Isaac 77964de306b1SToby Isaac Level: beginner 77974de306b1SToby Isaac 77984de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize() 77994de306b1SToby Isaac @*/ 78004de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points) 78014de306b1SToby Isaac { 78024de306b1SToby Isaac DMLabel label; 78034de306b1SToby Isaac PetscErrorCode ierr; 78044de306b1SToby Isaac 78054de306b1SToby Isaac PetscFunctionBegin; 78064de306b1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 78074de306b1SToby Isaac PetscValidCharPointer(name, 2); 78084de306b1SToby Isaac PetscValidPointer(points, 4); 78094de306b1SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 78104de306b1SToby Isaac if (!label) PetscFunctionReturn(0); 78114de306b1SToby Isaac ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr); 78124de306b1SToby Isaac PetscFunctionReturn(0); 78134de306b1SToby Isaac } 78144de306b1SToby Isaac 7815c58f1c22SToby Isaac /*@C 7816c58f1c22SToby Isaac DMClearLabelStratum - Remove all points from a stratum from a Sieve Label 7817c58f1c22SToby Isaac 7818c58f1c22SToby Isaac Not Collective 7819c58f1c22SToby Isaac 7820c58f1c22SToby Isaac Input Parameters: 7821c58f1c22SToby Isaac + dm - The DM object 7822c58f1c22SToby Isaac . name - The label name 7823c58f1c22SToby Isaac - value - The label value for this point 7824c58f1c22SToby Isaac 7825c58f1c22SToby Isaac Output Parameter: 7826c58f1c22SToby Isaac 7827c58f1c22SToby Isaac Level: beginner 7828c58f1c22SToby Isaac 7829c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue() 7830c58f1c22SToby Isaac @*/ 7831c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value) 7832c58f1c22SToby Isaac { 7833c58f1c22SToby Isaac DMLabel label; 7834c58f1c22SToby Isaac PetscErrorCode ierr; 7835c58f1c22SToby Isaac 7836c58f1c22SToby Isaac PetscFunctionBegin; 7837c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7838c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7839c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7840c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7841c58f1c22SToby Isaac ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr); 7842c58f1c22SToby Isaac PetscFunctionReturn(0); 7843c58f1c22SToby Isaac } 7844c58f1c22SToby Isaac 7845c58f1c22SToby Isaac /*@ 7846c58f1c22SToby Isaac DMGetNumLabels - Return the number of labels defined by the mesh 7847c58f1c22SToby Isaac 7848c58f1c22SToby Isaac Not Collective 7849c58f1c22SToby Isaac 7850c58f1c22SToby Isaac Input Parameter: 7851c58f1c22SToby Isaac . dm - The DM object 7852c58f1c22SToby Isaac 7853c58f1c22SToby Isaac Output Parameter: 7854c58f1c22SToby Isaac . numLabels - the number of Labels 7855c58f1c22SToby Isaac 7856c58f1c22SToby Isaac Level: intermediate 7857c58f1c22SToby Isaac 7858c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7859c58f1c22SToby Isaac @*/ 7860c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels) 7861c58f1c22SToby Isaac { 78625d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7863c58f1c22SToby Isaac PetscInt n = 0; 7864c58f1c22SToby Isaac 7865c58f1c22SToby Isaac PetscFunctionBegin; 7866c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7867534a8f05SLisandro Dalcin PetscValidIntPointer(numLabels, 2); 7868c58f1c22SToby Isaac while (next) {++n; next = next->next;} 7869c58f1c22SToby Isaac *numLabels = n; 7870c58f1c22SToby Isaac PetscFunctionReturn(0); 7871c58f1c22SToby Isaac } 7872c58f1c22SToby Isaac 7873c58f1c22SToby Isaac /*@C 7874c58f1c22SToby Isaac DMGetLabelName - Return the name of nth label 7875c58f1c22SToby Isaac 7876c58f1c22SToby Isaac Not Collective 7877c58f1c22SToby Isaac 7878c58f1c22SToby Isaac Input Parameters: 7879c58f1c22SToby Isaac + dm - The DM object 7880c58f1c22SToby Isaac - n - the label number 7881c58f1c22SToby Isaac 7882c58f1c22SToby Isaac Output Parameter: 7883c58f1c22SToby Isaac . name - the label name 7884c58f1c22SToby Isaac 7885c58f1c22SToby Isaac Level: intermediate 7886c58f1c22SToby Isaac 7887c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7888c58f1c22SToby Isaac @*/ 7889c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name) 7890c58f1c22SToby Isaac { 78915d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7892c58f1c22SToby Isaac PetscInt l = 0; 7893d67d17b1SMatthew G. Knepley PetscErrorCode ierr; 7894c58f1c22SToby Isaac 7895c58f1c22SToby Isaac PetscFunctionBegin; 7896c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7897c58f1c22SToby Isaac PetscValidPointer(name, 3); 7898c58f1c22SToby Isaac while (next) { 7899c58f1c22SToby Isaac if (l == n) { 7900d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr); 7901c58f1c22SToby Isaac PetscFunctionReturn(0); 7902c58f1c22SToby Isaac } 7903c58f1c22SToby Isaac ++l; 7904c58f1c22SToby Isaac next = next->next; 7905c58f1c22SToby Isaac } 7906c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 7907c58f1c22SToby Isaac } 7908c58f1c22SToby Isaac 7909c58f1c22SToby Isaac /*@C 7910c58f1c22SToby Isaac DMHasLabel - Determine whether the mesh has a label of a given name 7911c58f1c22SToby Isaac 7912c58f1c22SToby Isaac Not Collective 7913c58f1c22SToby Isaac 7914c58f1c22SToby Isaac Input Parameters: 7915c58f1c22SToby Isaac + dm - The DM object 7916c58f1c22SToby Isaac - name - The label name 7917c58f1c22SToby Isaac 7918c58f1c22SToby Isaac Output Parameter: 7919c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present 7920c58f1c22SToby Isaac 7921c58f1c22SToby Isaac Level: intermediate 7922c58f1c22SToby Isaac 7923c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7924c58f1c22SToby Isaac @*/ 7925c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel) 7926c58f1c22SToby Isaac { 79275d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7928d67d17b1SMatthew G. Knepley const char *lname; 7929c58f1c22SToby Isaac PetscErrorCode ierr; 7930c58f1c22SToby Isaac 7931c58f1c22SToby Isaac PetscFunctionBegin; 7932c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7933c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7934534a8f05SLisandro Dalcin PetscValidBoolPointer(hasLabel, 3); 7935c58f1c22SToby Isaac *hasLabel = PETSC_FALSE; 7936c58f1c22SToby Isaac while (next) { 7937d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 7938d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr); 7939c58f1c22SToby Isaac if (*hasLabel) break; 7940c58f1c22SToby Isaac next = next->next; 7941c58f1c22SToby Isaac } 7942c58f1c22SToby Isaac PetscFunctionReturn(0); 7943c58f1c22SToby Isaac } 7944c58f1c22SToby Isaac 7945c58f1c22SToby Isaac /*@C 7946c58f1c22SToby Isaac DMGetLabel - Return the label of a given name, or NULL 7947c58f1c22SToby Isaac 7948c58f1c22SToby Isaac Not Collective 7949c58f1c22SToby Isaac 7950c58f1c22SToby Isaac Input Parameters: 7951c58f1c22SToby Isaac + dm - The DM object 7952c58f1c22SToby Isaac - name - The label name 7953c58f1c22SToby Isaac 7954c58f1c22SToby Isaac Output Parameter: 7955c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 7956c58f1c22SToby Isaac 79576d7c9049SMatthew G. Knepley Note: Some of the default labels in a DMPlex will be 79586d7c9049SMatthew G. Knepley $ "depth" - Holds the depth (co-dimension) of each mesh point 79596d7c9049SMatthew G. Knepley $ "celltype" - Holds the topological type of each cell 79606d7c9049SMatthew G. Knepley $ "ghost" - If the DM is distributed with overlap, this marks the cells and faces in the overlap 79616d7c9049SMatthew G. Knepley $ "Cell Sets" - Mirrors the cell sets defined by GMsh and ExodusII 79626d7c9049SMatthew G. Knepley $ "Face Sets" - Mirrors the face sets defined by GMsh and ExodusII 79636d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh 79646d7c9049SMatthew G. Knepley 7965c58f1c22SToby Isaac Level: intermediate 7966c58f1c22SToby Isaac 79676d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType() 7968c58f1c22SToby Isaac @*/ 7969c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label) 7970c58f1c22SToby Isaac { 79715d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7972c58f1c22SToby Isaac PetscBool hasLabel; 7973d67d17b1SMatthew G. Knepley const char *lname; 7974c58f1c22SToby Isaac PetscErrorCode ierr; 7975c58f1c22SToby Isaac 7976c58f1c22SToby Isaac PetscFunctionBegin; 7977c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7978c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7979c58f1c22SToby Isaac PetscValidPointer(label, 3); 7980c58f1c22SToby Isaac *label = NULL; 7981c58f1c22SToby Isaac while (next) { 7982d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 7983d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 7984c58f1c22SToby Isaac if (hasLabel) { 7985c58f1c22SToby Isaac *label = next->label; 7986c58f1c22SToby Isaac break; 7987c58f1c22SToby Isaac } 7988c58f1c22SToby Isaac next = next->next; 7989c58f1c22SToby Isaac } 7990c58f1c22SToby Isaac PetscFunctionReturn(0); 7991c58f1c22SToby Isaac } 7992c58f1c22SToby Isaac 7993c58f1c22SToby Isaac /*@C 7994c58f1c22SToby Isaac DMGetLabelByNum - Return the nth label 7995c58f1c22SToby Isaac 7996c58f1c22SToby Isaac Not Collective 7997c58f1c22SToby Isaac 7998c58f1c22SToby Isaac Input Parameters: 7999c58f1c22SToby Isaac + dm - The DM object 8000c58f1c22SToby Isaac - n - the label number 8001c58f1c22SToby Isaac 8002c58f1c22SToby Isaac Output Parameter: 8003c58f1c22SToby Isaac . label - the label 8004c58f1c22SToby Isaac 8005c58f1c22SToby Isaac Level: intermediate 8006c58f1c22SToby Isaac 8007c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8008c58f1c22SToby Isaac @*/ 8009c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label) 8010c58f1c22SToby Isaac { 80115d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8012c58f1c22SToby Isaac PetscInt l = 0; 8013c58f1c22SToby Isaac 8014c58f1c22SToby Isaac PetscFunctionBegin; 8015c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8016c58f1c22SToby Isaac PetscValidPointer(label, 3); 8017c58f1c22SToby Isaac while (next) { 8018c58f1c22SToby Isaac if (l == n) { 8019c58f1c22SToby Isaac *label = next->label; 8020c58f1c22SToby Isaac PetscFunctionReturn(0); 8021c58f1c22SToby Isaac } 8022c58f1c22SToby Isaac ++l; 8023c58f1c22SToby Isaac next = next->next; 8024c58f1c22SToby Isaac } 8025c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 8026c58f1c22SToby Isaac } 8027c58f1c22SToby Isaac 8028c58f1c22SToby Isaac /*@C 8029c58f1c22SToby Isaac DMAddLabel - Add the label to this mesh 8030c58f1c22SToby Isaac 8031c58f1c22SToby Isaac Not Collective 8032c58f1c22SToby Isaac 8033c58f1c22SToby Isaac Input Parameters: 8034c58f1c22SToby Isaac + dm - The DM object 8035c58f1c22SToby Isaac - label - The DMLabel 8036c58f1c22SToby Isaac 8037c58f1c22SToby Isaac Level: developer 8038c58f1c22SToby Isaac 8039c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8040c58f1c22SToby Isaac @*/ 8041c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label) 8042c58f1c22SToby Isaac { 80435d80c0bfSVaclav Hapla DMLabelLink l, *p, tmpLabel; 8044c58f1c22SToby Isaac PetscBool hasLabel; 8045d67d17b1SMatthew G. Knepley const char *lname; 80465d80c0bfSVaclav Hapla PetscBool flg; 8047c58f1c22SToby Isaac PetscErrorCode ierr; 8048c58f1c22SToby Isaac 8049c58f1c22SToby Isaac PetscFunctionBegin; 8050c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8051d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr); 8052d67d17b1SMatthew G. Knepley ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr); 8053d67d17b1SMatthew G. Knepley if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname); 8054c58f1c22SToby Isaac ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr); 8055c58f1c22SToby Isaac tmpLabel->label = label; 8056c58f1c22SToby Isaac tmpLabel->output = PETSC_TRUE; 80575d80c0bfSVaclav Hapla for (p=&dm->labels; (l=*p); p=&l->next) {} 80585d80c0bfSVaclav Hapla *p = tmpLabel; 805908f633c4SVaclav Hapla ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr); 80605d80c0bfSVaclav Hapla ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 80615d80c0bfSVaclav Hapla if (flg) dm->depthLabel = label; 8062ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr); 8063ba2698f1SMatthew G. Knepley if (flg) dm->celltypeLabel = label; 8064c58f1c22SToby Isaac PetscFunctionReturn(0); 8065c58f1c22SToby Isaac } 8066c58f1c22SToby Isaac 8067c58f1c22SToby Isaac /*@C 80684a7ee7d0SMatthew G. Knepley DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present 80694a7ee7d0SMatthew G. Knepley 80704a7ee7d0SMatthew G. Knepley Not Collective 80714a7ee7d0SMatthew G. Knepley 80724a7ee7d0SMatthew G. Knepley Input Parameters: 80734a7ee7d0SMatthew G. Knepley + dm - The DM object 80744a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute 80754a7ee7d0SMatthew G. Knepley 80764a7ee7d0SMatthew G. Knepley Note: Some of the default labels in a DMPlex will be 80774a7ee7d0SMatthew G. Knepley $ "depth" - Holds the depth (co-dimension) of each mesh point 80784a7ee7d0SMatthew G. Knepley $ "celltype" - Holds the topological type of each cell 80794a7ee7d0SMatthew G. Knepley $ "ghost" - If the DM is distributed with overlap, this marks the cells and faces in the overlap 80804a7ee7d0SMatthew G. Knepley $ "Cell Sets" - Mirrors the cell sets defined by GMsh and ExodusII 80814a7ee7d0SMatthew G. Knepley $ "Face Sets" - Mirrors the face sets defined by GMsh and ExodusII 80824a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh 80834a7ee7d0SMatthew G. Knepley 80844a7ee7d0SMatthew G. Knepley Level: intermediate 80854a7ee7d0SMatthew G. Knepley 80864a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType() 80874a7ee7d0SMatthew G. Knepley @*/ 80884a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label) 80894a7ee7d0SMatthew G. Knepley { 80904a7ee7d0SMatthew G. Knepley DMLabelLink next = dm->labels; 80914a7ee7d0SMatthew G. Knepley PetscBool hasLabel, flg; 80924a7ee7d0SMatthew G. Knepley const char *name, *lname; 80934a7ee7d0SMatthew G. Knepley PetscErrorCode ierr; 80944a7ee7d0SMatthew G. Knepley 80954a7ee7d0SMatthew G. Knepley PetscFunctionBegin; 80964a7ee7d0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 80974a7ee7d0SMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 80984a7ee7d0SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr); 80994a7ee7d0SMatthew G. Knepley while (next) { 81004a7ee7d0SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 81014a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 81024a7ee7d0SMatthew G. Knepley if (hasLabel) { 81034a7ee7d0SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 81044a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 81054a7ee7d0SMatthew G. Knepley if (flg) dm->depthLabel = label; 81064a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr); 81074a7ee7d0SMatthew G. Knepley if (flg) dm->celltypeLabel = label; 81084a7ee7d0SMatthew G. Knepley ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 81094a7ee7d0SMatthew G. Knepley next->label = label; 81104a7ee7d0SMatthew G. Knepley break; 81114a7ee7d0SMatthew G. Knepley } 81124a7ee7d0SMatthew G. Knepley next = next->next; 81134a7ee7d0SMatthew G. Knepley } 81144a7ee7d0SMatthew G. Knepley PetscFunctionReturn(0); 81154a7ee7d0SMatthew G. Knepley } 81164a7ee7d0SMatthew G. Knepley 81174a7ee7d0SMatthew G. Knepley /*@C 8118e5472504SVaclav Hapla DMRemoveLabel - Remove the label given by name from this mesh 8119c58f1c22SToby Isaac 8120c58f1c22SToby Isaac Not Collective 8121c58f1c22SToby Isaac 8122c58f1c22SToby Isaac Input Parameters: 8123c58f1c22SToby Isaac + dm - The DM object 8124c58f1c22SToby Isaac - name - The label name 8125c58f1c22SToby Isaac 8126c58f1c22SToby Isaac Output Parameter: 8127c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 8128c58f1c22SToby Isaac 8129c58f1c22SToby Isaac Level: developer 8130c58f1c22SToby Isaac 8131e5472504SVaclav Hapla Notes: 8132e5472504SVaclav Hapla DMRemoveLabel(dm,name,NULL) removes the label from dm and calls 8133e5472504SVaclav Hapla DMLabelDestroy() on the label. 8134e5472504SVaclav Hapla 8135e5472504SVaclav Hapla DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT 8136e5472504SVaclav Hapla call DMLabelDestroy(). Instead, the label is returned and the user is 8137e5472504SVaclav Hapla responsible of calling DMLabelDestroy() at some point. 8138e5472504SVaclav Hapla 8139e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf() 8140c58f1c22SToby Isaac @*/ 8141c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label) 8142c58f1c22SToby Isaac { 814395d578d6SVaclav Hapla DMLabelLink link, *pnext; 8144c58f1c22SToby Isaac PetscBool hasLabel; 8145d67d17b1SMatthew G. Knepley const char *lname; 8146c58f1c22SToby Isaac PetscErrorCode ierr; 8147c58f1c22SToby Isaac 8148c58f1c22SToby Isaac PetscFunctionBegin; 8149c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8150e5472504SVaclav Hapla PetscValidCharPointer(name, 2); 8151e5472504SVaclav Hapla if (label) { 8152e5472504SVaclav Hapla PetscValidPointer(label, 3); 8153c58f1c22SToby Isaac *label = NULL; 8154e5472504SVaclav Hapla } 81555d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 815695d578d6SVaclav Hapla ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr); 8157d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 8158c58f1c22SToby Isaac if (hasLabel) { 815995d578d6SVaclav Hapla *pnext = link->next; /* Remove from list */ 8160c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr); 816195d578d6SVaclav Hapla if (hasLabel) dm->depthLabel = NULL; 8162ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr); 8163ba2698f1SMatthew G. Knepley if (hasLabel) dm->celltypeLabel = NULL; 816495d578d6SVaclav Hapla if (label) *label = link->label; 816595d578d6SVaclav Hapla else {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);} 816695d578d6SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 8167c58f1c22SToby Isaac break; 8168c58f1c22SToby Isaac } 8169c58f1c22SToby Isaac } 8170c58f1c22SToby Isaac PetscFunctionReturn(0); 8171c58f1c22SToby Isaac } 8172c58f1c22SToby Isaac 8173306894acSVaclav Hapla /*@ 8174306894acSVaclav Hapla DMRemoveLabelBySelf - Remove the label from this mesh 8175306894acSVaclav Hapla 8176306894acSVaclav Hapla Not Collective 8177306894acSVaclav Hapla 8178306894acSVaclav Hapla Input Parameters: 8179306894acSVaclav Hapla + dm - The DM object 8180876aa926SVaclav Hapla . label - The DMLabel to be removed from the DM 8181306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM? 8182306894acSVaclav Hapla 8183306894acSVaclav Hapla Level: developer 8184306894acSVaclav Hapla 8185306894acSVaclav Hapla Notes: 8186306894acSVaclav Hapla Only exactly the same instance is removed if found, name match is ignored. 8187306894acSVaclav Hapla If the DM has an exclusive reference to the label, it gets destroyed and 8188306894acSVaclav Hapla *label nullified. 8189306894acSVaclav Hapla 8190306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel() 8191306894acSVaclav Hapla @*/ 8192306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound) 8193306894acSVaclav Hapla { 819443e45a93SVaclav Hapla DMLabelLink link, *pnext; 8195306894acSVaclav Hapla PetscBool hasLabel = PETSC_FALSE; 8196306894acSVaclav Hapla PetscErrorCode ierr; 8197306894acSVaclav Hapla 8198306894acSVaclav Hapla PetscFunctionBegin; 8199306894acSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8200306894acSVaclav Hapla PetscValidPointer(label, 2); 8201f39a9ae0SVaclav Hapla if (!*label && !failNotFound) PetscFunctionReturn(0); 8202306894acSVaclav Hapla PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2); 8203306894acSVaclav Hapla PetscValidLogicalCollectiveBool(dm,failNotFound,3); 82045d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 820543e45a93SVaclav Hapla if (*label == link->label) { 8206306894acSVaclav Hapla hasLabel = PETSC_TRUE; 820743e45a93SVaclav Hapla *pnext = link->next; /* Remove from list */ 8208306894acSVaclav Hapla if (*label == dm->depthLabel) dm->depthLabel = NULL; 8209ba2698f1SMatthew G. Knepley if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL; 821043e45a93SVaclav Hapla if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */ 821143e45a93SVaclav Hapla ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr); 821243e45a93SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 8213306894acSVaclav Hapla break; 8214306894acSVaclav Hapla } 8215306894acSVaclav Hapla } 8216306894acSVaclav Hapla if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM"); 8217306894acSVaclav Hapla PetscFunctionReturn(0); 8218306894acSVaclav Hapla } 8219306894acSVaclav Hapla 8220c58f1c22SToby Isaac /*@C 8221c58f1c22SToby Isaac DMGetLabelOutput - Get the output flag for a given label 8222c58f1c22SToby Isaac 8223c58f1c22SToby Isaac Not Collective 8224c58f1c22SToby Isaac 8225c58f1c22SToby Isaac Input Parameters: 8226c58f1c22SToby Isaac + dm - The DM object 8227c58f1c22SToby Isaac - name - The label name 8228c58f1c22SToby Isaac 8229c58f1c22SToby Isaac Output Parameter: 8230c58f1c22SToby Isaac . output - The flag for output 8231c58f1c22SToby Isaac 8232c58f1c22SToby Isaac Level: developer 8233c58f1c22SToby Isaac 8234c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8235c58f1c22SToby Isaac @*/ 8236c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output) 8237c58f1c22SToby Isaac { 82385d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8239d67d17b1SMatthew G. Knepley const char *lname; 8240c58f1c22SToby Isaac PetscErrorCode ierr; 8241c58f1c22SToby Isaac 8242c58f1c22SToby Isaac PetscFunctionBegin; 8243c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8244c58f1c22SToby Isaac PetscValidPointer(name, 2); 8245c58f1c22SToby Isaac PetscValidPointer(output, 3); 8246c58f1c22SToby Isaac while (next) { 8247c58f1c22SToby Isaac PetscBool flg; 8248c58f1c22SToby Isaac 8249d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8250d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 8251c58f1c22SToby Isaac if (flg) {*output = next->output; PetscFunctionReturn(0);} 8252c58f1c22SToby Isaac next = next->next; 8253c58f1c22SToby Isaac } 8254c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 8255c58f1c22SToby Isaac } 8256c58f1c22SToby Isaac 8257c58f1c22SToby Isaac /*@C 8258c58f1c22SToby Isaac DMSetLabelOutput - Set the output flag for a given label 8259c58f1c22SToby Isaac 8260c58f1c22SToby Isaac Not Collective 8261c58f1c22SToby Isaac 8262c58f1c22SToby Isaac Input Parameters: 8263c58f1c22SToby Isaac + dm - The DM object 8264c58f1c22SToby Isaac . name - The label name 8265c58f1c22SToby Isaac - output - The flag for output 8266c58f1c22SToby Isaac 8267c58f1c22SToby Isaac Level: developer 8268c58f1c22SToby Isaac 8269c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8270c58f1c22SToby Isaac @*/ 8271c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output) 8272c58f1c22SToby Isaac { 82735d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8274d67d17b1SMatthew G. Knepley const char *lname; 8275c58f1c22SToby Isaac PetscErrorCode ierr; 8276c58f1c22SToby Isaac 8277c58f1c22SToby Isaac PetscFunctionBegin; 8278c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8279534a8f05SLisandro Dalcin PetscValidCharPointer(name, 2); 8280c58f1c22SToby Isaac while (next) { 8281c58f1c22SToby Isaac PetscBool flg; 8282c58f1c22SToby Isaac 8283d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8284d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 8285c58f1c22SToby Isaac if (flg) {next->output = output; PetscFunctionReturn(0);} 8286c58f1c22SToby Isaac next = next->next; 8287c58f1c22SToby Isaac } 8288c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 8289c58f1c22SToby Isaac } 8290c58f1c22SToby Isaac 8291c58f1c22SToby Isaac /*@ 8292c58f1c22SToby Isaac DMCopyLabels - Copy labels from one mesh to another with a superset of the points 8293c58f1c22SToby Isaac 8294d083f849SBarry Smith Collective on dmA 8295c58f1c22SToby Isaac 8296d8d19677SJose E. Roman Input Parameters: 82975d80c0bfSVaclav Hapla + dmA - The DM object with initial labels 82982cbb9b06SVaclav Hapla . dmB - The DM object to which labels are copied 82995d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES) 83002cbb9b06SVaclav Hapla . all - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE) 83012cbb9b06SVaclav Hapla - emode - How to behave when a DMLabel in the source and destination DMs with the same name is encountered (see DMCopyLabelsMode) 8302c58f1c22SToby Isaac 8303c58f1c22SToby Isaac Level: intermediate 8304c58f1c22SToby Isaac 83052cbb9b06SVaclav Hapla Notes: 83062cbb9b06SVaclav Hapla This is typically used when interpolating or otherwise adding to a mesh, or testing. 8307c58f1c22SToby Isaac 83082cbb9b06SVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode 8309c58f1c22SToby Isaac @*/ 83102cbb9b06SVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all, DMCopyLabelsMode emode) 8311c58f1c22SToby Isaac { 83122cbb9b06SVaclav Hapla DMLabel label, labelNew, labelOld; 8313c58f1c22SToby Isaac const char *name; 8314c58f1c22SToby Isaac PetscBool flg; 83155d80c0bfSVaclav Hapla DMLabelLink link; 83165d80c0bfSVaclav Hapla PetscErrorCode ierr; 8317c58f1c22SToby Isaac 83185d80c0bfSVaclav Hapla PetscFunctionBegin; 83195d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmA, DM_CLASSID, 1); 83205d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmB, DM_CLASSID, 2); 83215d80c0bfSVaclav Hapla PetscValidLogicalCollectiveEnum(dmA, mode,3); 83225d80c0bfSVaclav Hapla PetscValidLogicalCollectiveBool(dmA, all, 4); 83235d80c0bfSVaclav Hapla if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects"); 83245d80c0bfSVaclav Hapla if (dmA == dmB) PetscFunctionReturn(0); 83255d80c0bfSVaclav Hapla for (link=dmA->labels; link; link=link->next) { 83265d80c0bfSVaclav Hapla label=link->label; 83275d80c0bfSVaclav Hapla ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr); 83285d80c0bfSVaclav Hapla if (!all) { 8329c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr); 8330c58f1c22SToby Isaac if (flg) continue; 83317d5acc75SStefano Zampini ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr); 83327d5acc75SStefano Zampini if (flg) continue; 8333ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr); 8334ba2698f1SMatthew G. Knepley if (flg) continue; 83355d80c0bfSVaclav Hapla } 83362cbb9b06SVaclav Hapla ierr = DMGetLabel(dmB, name, &labelOld);CHKERRQ(ierr); 83372cbb9b06SVaclav Hapla if (labelOld) { 83382cbb9b06SVaclav Hapla switch (emode) { 83392cbb9b06SVaclav Hapla case DM_COPY_LABELS_KEEP: 83402cbb9b06SVaclav Hapla continue; 83412cbb9b06SVaclav Hapla case DM_COPY_LABELS_REPLACE: 83422cbb9b06SVaclav Hapla ierr = DMRemoveLabelBySelf(dmB, &labelOld, PETSC_TRUE);CHKERRQ(ierr); 83432cbb9b06SVaclav Hapla break; 83442cbb9b06SVaclav Hapla case DM_COPY_LABELS_FAIL: 83452cbb9b06SVaclav Hapla SETERRQ1(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in destination DM", name); 83462cbb9b06SVaclav Hapla default: 83472cbb9b06SVaclav Hapla SETERRQ1(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Unhandled DMCopyLabelsMode %d", emode); 83482cbb9b06SVaclav Hapla } 83492cbb9b06SVaclav Hapla } 83505d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) { 8351c58f1c22SToby Isaac ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr); 83525d80c0bfSVaclav Hapla } else { 83535d80c0bfSVaclav Hapla labelNew = label; 83545d80c0bfSVaclav Hapla } 8355c58f1c22SToby Isaac ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr); 83565d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);} 8357c58f1c22SToby Isaac } 8358c58f1c22SToby Isaac PetscFunctionReturn(0); 8359c58f1c22SToby Isaac } 8360461a15a0SLisandro Dalcin 8361609dae6eSVaclav Hapla /*@C 8362609dae6eSVaclav Hapla DMCompareLabels - Compare labels of two DMPlex meshes 8363609dae6eSVaclav Hapla 8364609dae6eSVaclav Hapla Collective on dmA 8365609dae6eSVaclav Hapla 8366609dae6eSVaclav Hapla Input Parameters: 8367609dae6eSVaclav Hapla + dm0 - First DM object 8368609dae6eSVaclav Hapla - dm1 - Second DM object 8369609dae6eSVaclav Hapla 8370609dae6eSVaclav Hapla Output Parameters 8371609dae6eSVaclav Hapla + same - (Optional) Flag whether labels of dm0 and dm1 are the same 8372609dae6eSVaclav Hapla - message - (Optional) Message describing the difference, or NULL if there is no difference 8373609dae6eSVaclav Hapla 8374609dae6eSVaclav Hapla Level: intermediate 8375609dae6eSVaclav Hapla 8376609dae6eSVaclav Hapla Notes: 8377609dae6eSVaclav Hapla If both same and message is passed as NULL, and difference is found, an error is thrown with a message describing the difference. 8378609dae6eSVaclav Hapla 8379609dae6eSVaclav Hapla Message must be freed by user. 8380609dae6eSVaclav Hapla 8381609dae6eSVaclav Hapla Labels are matched by name. If the number of labels and their names are equal, 8382609dae6eSVaclav Hapla DMLabelCompare() is used to compare each pair of labels with the same name. 8383609dae6eSVaclav Hapla 8384609dae6eSVaclav Hapla Fortran Notes: 8385609dae6eSVaclav Hapla This function is currently not available from Fortran. 8386609dae6eSVaclav Hapla 8387609dae6eSVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode, DMLabelCompare() 8388609dae6eSVaclav Hapla @*/ 8389609dae6eSVaclav Hapla PetscErrorCode DMCompareLabels(DM dm0, DM dm1, PetscBool *same, char **message) 8390609dae6eSVaclav Hapla { 8391609dae6eSVaclav Hapla PetscInt n0, n1, i; 8392609dae6eSVaclav Hapla char msg[PETSC_MAX_PATH_LEN] = ""; 8393609dae6eSVaclav Hapla MPI_Comm comm; 8394609dae6eSVaclav Hapla PetscErrorCode ierr; 8395609dae6eSVaclav Hapla 8396609dae6eSVaclav Hapla PetscFunctionBegin; 8397609dae6eSVaclav Hapla PetscValidHeaderSpecific(dm0,DM_CLASSID,1); 8398609dae6eSVaclav Hapla PetscValidHeaderSpecific(dm1,DM_CLASSID,2); 8399609dae6eSVaclav Hapla PetscCheckSameComm(dm0,1,dm1,2); 8400609dae6eSVaclav Hapla if (same) PetscValidBoolPointer(same,3); 8401609dae6eSVaclav Hapla if (message) PetscValidPointer(message, 4); 8402609dae6eSVaclav Hapla ierr = PetscObjectGetComm((PetscObject)dm0, &comm);CHKERRQ(ierr); 8403609dae6eSVaclav Hapla ierr = DMGetNumLabels(dm0, &n0);CHKERRQ(ierr); 8404609dae6eSVaclav Hapla ierr = DMGetNumLabels(dm1, &n1);CHKERRQ(ierr); 8405609dae6eSVaclav Hapla if (n0 != n1) { 8406609dae6eSVaclav Hapla ierr = PetscSNPrintf(msg, sizeof(msg), "Number of labels in dm0 = %D != %D = Number of labels in dm1", n0, n1);CHKERRQ(ierr); 8407609dae6eSVaclav Hapla goto finish; 8408609dae6eSVaclav Hapla } 8409609dae6eSVaclav Hapla for (i=0; i<n0; i++) { 8410609dae6eSVaclav Hapla DMLabel l0, l1; 8411609dae6eSVaclav Hapla const char *name; 8412609dae6eSVaclav Hapla char *msgInner; 8413609dae6eSVaclav Hapla 8414609dae6eSVaclav Hapla /* Ignore label order */ 8415609dae6eSVaclav Hapla ierr = DMGetLabelByNum(dm0, i, &l0);CHKERRQ(ierr); 8416609dae6eSVaclav Hapla ierr = PetscObjectGetName((PetscObject)l0, &name);CHKERRQ(ierr); 8417609dae6eSVaclav Hapla ierr = DMGetLabel(dm1, name, &l1);CHKERRQ(ierr); 8418609dae6eSVaclav Hapla if (!l1) { 8419609dae6eSVaclav Hapla ierr = PetscSNPrintf(msg, sizeof(msg), "Label \"%s\" (#%D in dm0) not found in dm1", name, i);CHKERRQ(ierr); 8420609dae6eSVaclav Hapla goto finish; 8421609dae6eSVaclav Hapla } 8422609dae6eSVaclav Hapla ierr = DMLabelCompare(l0, l1, NULL, &msgInner);CHKERRQ(ierr); 8423609dae6eSVaclav Hapla ierr = PetscStrncpy(msg, msgInner, sizeof(msg));CHKERRQ(ierr); 8424609dae6eSVaclav Hapla ierr = PetscFree(msgInner);CHKERRQ(ierr); 8425609dae6eSVaclav Hapla if (msg[0]) goto finish; 8426609dae6eSVaclav Hapla } 8427609dae6eSVaclav Hapla finish: 8428609dae6eSVaclav Hapla if (msg[0] && !same && !message) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, msg); 8429609dae6eSVaclav Hapla if (same) *same = (PetscBool) !msg[0]; 8430609dae6eSVaclav Hapla if (message) { 8431609dae6eSVaclav Hapla *message = NULL; 8432609dae6eSVaclav Hapla if (msg[0]) { 8433609dae6eSVaclav Hapla ierr = PetscStrallocpy(msg, message);CHKERRQ(ierr); 8434609dae6eSVaclav Hapla } 8435609dae6eSVaclav Hapla } 8436609dae6eSVaclav Hapla PetscFunctionReturn(0); 8437609dae6eSVaclav Hapla } 8438609dae6eSVaclav Hapla 8439461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value) 8440461a15a0SLisandro Dalcin { 8441461a15a0SLisandro Dalcin PetscErrorCode ierr; 8442609dae6eSVaclav Hapla 8443461a15a0SLisandro Dalcin PetscFunctionBegin; 8444461a15a0SLisandro Dalcin PetscValidPointer(label,2); 8445461a15a0SLisandro Dalcin if (!*label) { 8446461a15a0SLisandro Dalcin ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 8447461a15a0SLisandro Dalcin ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr); 8448461a15a0SLisandro Dalcin } 8449461a15a0SLisandro Dalcin ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr); 8450461a15a0SLisandro Dalcin PetscFunctionReturn(0); 8451461a15a0SLisandro Dalcin } 8452461a15a0SLisandro Dalcin 84530fdc7489SMatthew Knepley /* 84540fdc7489SMatthew Knepley Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would 84550fdc7489SMatthew Knepley like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every 84560fdc7489SMatthew Knepley (label, id) pair in the DM. 84570fdc7489SMatthew Knepley 84580fdc7489SMatthew Knepley However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to 84590fdc7489SMatthew Knepley each label. 84600fdc7489SMatthew Knepley */ 84610fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal) 84620fdc7489SMatthew Knepley { 84630fdc7489SMatthew Knepley DMUniversalLabel ul; 84640fdc7489SMatthew Knepley PetscBool *active; 84650fdc7489SMatthew Knepley PetscInt pStart, pEnd, p, Nl, l, m; 84660fdc7489SMatthew Knepley PetscErrorCode ierr; 84670fdc7489SMatthew Knepley 84680fdc7489SMatthew Knepley PetscFunctionBegin; 84690fdc7489SMatthew Knepley ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr); 84700fdc7489SMatthew Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr); 84710fdc7489SMatthew Knepley ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr); 84720fdc7489SMatthew Knepley ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr); 84730fdc7489SMatthew Knepley ul->Nl = 0; 84740fdc7489SMatthew Knepley for (l = 0; l < Nl; ++l) { 84750fdc7489SMatthew Knepley PetscBool isdepth, iscelltype; 84760fdc7489SMatthew Knepley const char *name; 84770fdc7489SMatthew Knepley 84780fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr); 84790fdc7489SMatthew Knepley ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr); 84800fdc7489SMatthew Knepley ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr); 84810fdc7489SMatthew Knepley active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE; 84820fdc7489SMatthew Knepley if (active[l]) ++ul->Nl; 84830fdc7489SMatthew Knepley } 84840fdc7489SMatthew Knepley ierr = PetscCalloc5(ul->Nl, &ul->names, ul->Nl, &ul->indices, ul->Nl+1, &ul->offsets, ul->Nl+1, &ul->bits, ul->Nl, &ul->masks);CHKERRQ(ierr); 84850fdc7489SMatthew Knepley ul->Nv = 0; 84860fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 84870fdc7489SMatthew Knepley DMLabel label; 84880fdc7489SMatthew Knepley PetscInt nv; 84890fdc7489SMatthew Knepley const char *name; 84900fdc7489SMatthew Knepley 84910fdc7489SMatthew Knepley if (!active[l]) continue; 84920fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr); 84930fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 84940fdc7489SMatthew Knepley ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr); 84950fdc7489SMatthew Knepley ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr); 84960fdc7489SMatthew Knepley ul->indices[m] = l; 84970fdc7489SMatthew Knepley ul->Nv += nv; 84980fdc7489SMatthew Knepley ul->offsets[m+1] = nv; 84990fdc7489SMatthew Knepley ul->bits[m+1] = PetscCeilReal(PetscLog2Real(nv+1)); 85000fdc7489SMatthew Knepley ++m; 85010fdc7489SMatthew Knepley } 85020fdc7489SMatthew Knepley for (l = 1; l <= ul->Nl; ++l) { 85030fdc7489SMatthew Knepley ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l]; 85040fdc7489SMatthew Knepley ul->bits[l] = ul->bits[l-1] + ul->bits[l]; 85050fdc7489SMatthew Knepley } 85060fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 85070fdc7489SMatthew Knepley PetscInt b; 85080fdc7489SMatthew Knepley 85090fdc7489SMatthew Knepley ul->masks[l] = 0; 85100fdc7489SMatthew Knepley for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b; 85110fdc7489SMatthew Knepley } 85120fdc7489SMatthew Knepley ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr); 85130fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 85140fdc7489SMatthew Knepley DMLabel label; 85150fdc7489SMatthew Knepley IS valueIS; 85160fdc7489SMatthew Knepley const PetscInt *varr; 85170fdc7489SMatthew Knepley PetscInt nv, v; 85180fdc7489SMatthew Knepley 85190fdc7489SMatthew Knepley if (!active[l]) continue; 85200fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 85210fdc7489SMatthew Knepley ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr); 85220fdc7489SMatthew Knepley ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr); 85230fdc7489SMatthew Knepley ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr); 85240fdc7489SMatthew Knepley for (v = 0; v < nv; ++v) { 85250fdc7489SMatthew Knepley ul->values[ul->offsets[m]+v] = varr[v]; 85260fdc7489SMatthew Knepley } 85270fdc7489SMatthew Knepley ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr); 85280fdc7489SMatthew Knepley ierr = ISDestroy(&valueIS);CHKERRQ(ierr); 85290fdc7489SMatthew Knepley ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr); 85300fdc7489SMatthew Knepley ++m; 85310fdc7489SMatthew Knepley } 85320fdc7489SMatthew Knepley ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr); 85330fdc7489SMatthew Knepley for (p = pStart; p < pEnd; ++p) { 85340fdc7489SMatthew Knepley PetscInt uval = 0; 85350fdc7489SMatthew Knepley PetscBool marked = PETSC_FALSE; 85360fdc7489SMatthew Knepley 85370fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 85380fdc7489SMatthew Knepley DMLabel label; 85390649b39aSStefano Zampini PetscInt val, defval, loc, nv; 85400fdc7489SMatthew Knepley 85410fdc7489SMatthew Knepley if (!active[l]) continue; 85420fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 85430fdc7489SMatthew Knepley ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr); 85440fdc7489SMatthew Knepley ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr); 85450fdc7489SMatthew Knepley if (val == defval) {++m; continue;} 85460649b39aSStefano Zampini nv = ul->offsets[m+1]-ul->offsets[m]; 85470fdc7489SMatthew Knepley marked = PETSC_TRUE; 85480fdc7489SMatthew Knepley ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr); 85490fdc7489SMatthew Knepley if (loc < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val); 85500fdc7489SMatthew Knepley uval += (loc+1) << ul->bits[m]; 85510fdc7489SMatthew Knepley ++m; 85520fdc7489SMatthew Knepley } 85530fdc7489SMatthew Knepley if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);} 85540fdc7489SMatthew Knepley } 85550fdc7489SMatthew Knepley ierr = PetscFree(active);CHKERRQ(ierr); 85560fdc7489SMatthew Knepley *universal = ul; 85570fdc7489SMatthew Knepley PetscFunctionReturn(0); 85580fdc7489SMatthew Knepley } 85590fdc7489SMatthew Knepley 85600fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal) 85610fdc7489SMatthew Knepley { 85620fdc7489SMatthew Knepley PetscInt l; 85630fdc7489SMatthew Knepley PetscErrorCode ierr; 85640fdc7489SMatthew Knepley 85650fdc7489SMatthew Knepley PetscFunctionBegin; 85660fdc7489SMatthew Knepley for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);} 85670fdc7489SMatthew Knepley ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr); 85680fdc7489SMatthew Knepley ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr); 85690fdc7489SMatthew Knepley ierr = PetscFree((*universal)->values);CHKERRQ(ierr); 85700fdc7489SMatthew Knepley ierr = PetscFree(*universal);CHKERRQ(ierr); 85710fdc7489SMatthew Knepley *universal = NULL; 85720fdc7489SMatthew Knepley PetscFunctionReturn(0); 85730fdc7489SMatthew Knepley } 85740fdc7489SMatthew Knepley 85750fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel) 85760fdc7489SMatthew Knepley { 85770fdc7489SMatthew Knepley PetscFunctionBegin; 85780fdc7489SMatthew Knepley PetscValidPointer(ulabel, 2); 85790fdc7489SMatthew Knepley *ulabel = ul->label; 85800fdc7489SMatthew Knepley PetscFunctionReturn(0); 85810fdc7489SMatthew Knepley } 85820fdc7489SMatthew Knepley 85830fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm) 85840fdc7489SMatthew Knepley { 85850fdc7489SMatthew Knepley PetscInt Nl = ul->Nl, l; 85860fdc7489SMatthew Knepley PetscErrorCode ierr; 85870fdc7489SMatthew Knepley 85880fdc7489SMatthew Knepley PetscFunctionBegin; 8589064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(dm, DM_CLASSID, 3); 85900fdc7489SMatthew Knepley for (l = 0; l < Nl; ++l) { 85910fdc7489SMatthew Knepley if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);} 85920fdc7489SMatthew Knepley else {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);} 85930fdc7489SMatthew Knepley } 85940fdc7489SMatthew Knepley if (preserveOrder) { 85950fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 85960fdc7489SMatthew Knepley const char *name; 85970fdc7489SMatthew Knepley PetscBool match; 85980fdc7489SMatthew Knepley 85990fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr); 86000fdc7489SMatthew Knepley ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr); 86010fdc7489SMatthew Knepley if (!match) SETERRQ3(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]); 86020fdc7489SMatthew Knepley } 86030fdc7489SMatthew Knepley } 86040fdc7489SMatthew Knepley PetscFunctionReturn(0); 86050fdc7489SMatthew Knepley } 86060fdc7489SMatthew Knepley 86070fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value) 86080fdc7489SMatthew Knepley { 86090fdc7489SMatthew Knepley PetscInt l; 86100fdc7489SMatthew Knepley PetscErrorCode ierr; 86110fdc7489SMatthew Knepley 86120fdc7489SMatthew Knepley PetscFunctionBegin; 86130fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 86140fdc7489SMatthew Knepley DMLabel label; 86150fdc7489SMatthew Knepley PetscInt lval = (value & ul->masks[l]) >> ul->bits[l]; 86160fdc7489SMatthew Knepley 86170fdc7489SMatthew Knepley if (lval) { 86180fdc7489SMatthew Knepley if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);} 86190fdc7489SMatthew Knepley else {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);} 86200fdc7489SMatthew Knepley ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr); 86210fdc7489SMatthew Knepley } 86220fdc7489SMatthew Knepley } 86230fdc7489SMatthew Knepley PetscFunctionReturn(0); 86240fdc7489SMatthew Knepley } 8625a8fb8f29SToby Isaac 8626a8fb8f29SToby Isaac /*@ 8627a8fb8f29SToby Isaac DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement 8628a8fb8f29SToby Isaac 8629a8fb8f29SToby Isaac Input Parameter: 8630a8fb8f29SToby Isaac . dm - The DM object 8631a8fb8f29SToby Isaac 8632a8fb8f29SToby Isaac Output Parameter: 8633a8fb8f29SToby Isaac . cdm - The coarse DM 8634a8fb8f29SToby Isaac 8635a8fb8f29SToby Isaac Level: intermediate 8636a8fb8f29SToby Isaac 8637a8fb8f29SToby Isaac .seealso: DMSetCoarseDM() 8638a8fb8f29SToby Isaac @*/ 8639a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm) 8640a8fb8f29SToby Isaac { 8641a8fb8f29SToby Isaac PetscFunctionBegin; 8642a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8643a8fb8f29SToby Isaac PetscValidPointer(cdm, 2); 8644a8fb8f29SToby Isaac *cdm = dm->coarseMesh; 8645a8fb8f29SToby Isaac PetscFunctionReturn(0); 8646a8fb8f29SToby Isaac } 8647a8fb8f29SToby Isaac 8648a8fb8f29SToby Isaac /*@ 8649a8fb8f29SToby Isaac DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement 8650a8fb8f29SToby Isaac 8651a8fb8f29SToby Isaac Input Parameters: 8652a8fb8f29SToby Isaac + dm - The DM object 8653a8fb8f29SToby Isaac - cdm - The coarse DM 8654a8fb8f29SToby Isaac 8655a8fb8f29SToby Isaac Level: intermediate 8656a8fb8f29SToby Isaac 8657a8fb8f29SToby Isaac .seealso: DMGetCoarseDM() 8658a8fb8f29SToby Isaac @*/ 8659a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm) 8660a8fb8f29SToby Isaac { 8661a8fb8f29SToby Isaac PetscErrorCode ierr; 8662a8fb8f29SToby Isaac 8663a8fb8f29SToby Isaac PetscFunctionBegin; 8664a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8665a8fb8f29SToby Isaac if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2); 8666a8fb8f29SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 8667a8fb8f29SToby Isaac ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr); 8668a8fb8f29SToby Isaac dm->coarseMesh = cdm; 8669a8fb8f29SToby Isaac PetscFunctionReturn(0); 8670a8fb8f29SToby Isaac } 8671a8fb8f29SToby Isaac 867288bdff64SToby Isaac /*@ 867388bdff64SToby Isaac DMGetFineDM - Get the fine mesh from which this was obtained by refinement 867488bdff64SToby Isaac 867588bdff64SToby Isaac Input Parameter: 867688bdff64SToby Isaac . dm - The DM object 867788bdff64SToby Isaac 867888bdff64SToby Isaac Output Parameter: 867988bdff64SToby Isaac . fdm - The fine DM 868088bdff64SToby Isaac 868188bdff64SToby Isaac Level: intermediate 868288bdff64SToby Isaac 868388bdff64SToby Isaac .seealso: DMSetFineDM() 868488bdff64SToby Isaac @*/ 868588bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm) 868688bdff64SToby Isaac { 868788bdff64SToby Isaac PetscFunctionBegin; 868888bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 868988bdff64SToby Isaac PetscValidPointer(fdm, 2); 869088bdff64SToby Isaac *fdm = dm->fineMesh; 869188bdff64SToby Isaac PetscFunctionReturn(0); 869288bdff64SToby Isaac } 869388bdff64SToby Isaac 869488bdff64SToby Isaac /*@ 869588bdff64SToby Isaac DMSetFineDM - Set the fine mesh from which this was obtained by refinement 869688bdff64SToby Isaac 869788bdff64SToby Isaac Input Parameters: 869888bdff64SToby Isaac + dm - The DM object 869988bdff64SToby Isaac - fdm - The fine DM 870088bdff64SToby Isaac 870188bdff64SToby Isaac Level: intermediate 870288bdff64SToby Isaac 870388bdff64SToby Isaac .seealso: DMGetFineDM() 870488bdff64SToby Isaac @*/ 870588bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm) 870688bdff64SToby Isaac { 870788bdff64SToby Isaac PetscErrorCode ierr; 870888bdff64SToby Isaac 870988bdff64SToby Isaac PetscFunctionBegin; 871088bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 871188bdff64SToby Isaac if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2); 871288bdff64SToby Isaac ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr); 871388bdff64SToby Isaac ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr); 871488bdff64SToby Isaac dm->fineMesh = fdm; 871588bdff64SToby Isaac PetscFunctionReturn(0); 871688bdff64SToby Isaac } 871788bdff64SToby Isaac 8718a6ba4734SToby Isaac /*=== DMBoundary code ===*/ 8719a6ba4734SToby Isaac 8720a6ba4734SToby Isaac /*@C 8721a6ba4734SToby Isaac DMAddBoundary - Add a boundary condition to the model 8722a6ba4734SToby Isaac 8723783e2ec8SMatthew G. Knepley Collective on dm 8724783e2ec8SMatthew G. Knepley 8725a6ba4734SToby Isaac Input Parameters: 87264c258f51SMatthew G. Knepley + dm - The DM, with a PetscDS that matches the problem being constrained 8727f971fd6bSMatthew G. Knepley . type - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 8728a6ba4734SToby Isaac . name - The BC name 872945480ffeSMatthew G. Knepley . label - The label defining constrained points 873045480ffeSMatthew G. Knepley . Nv - The number of DMLabel values for constrained points 873145480ffeSMatthew G. Knepley . values - An array of values for constrained points 8732a6ba4734SToby Isaac . field - The field to constrain 873345480ffeSMatthew G. Knepley . Nc - The number of constrained field components (0 will constrain all fields) 8734a6ba4734SToby Isaac . comps - An array of constrained component numbers 8735a6ba4734SToby Isaac . bcFunc - A pointwise function giving boundary values 873656cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL 8737a6ba4734SToby Isaac - ctx - An optional user context for bcFunc 8738a6ba4734SToby Isaac 873945480ffeSMatthew G. Knepley Output Parameter: 874045480ffeSMatthew G. Knepley . bd - (Optional) Boundary number 874145480ffeSMatthew G. Knepley 8742a6ba4734SToby Isaac Options Database Keys: 8743a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 8744a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 8745a6ba4734SToby Isaac 874656cf3b9cSMatthew G. Knepley Note: 874756cf3b9cSMatthew G. Knepley Both bcFunc abd bcFunc_t will depend on the boundary condition type. If the type if DM_BC_ESSENTIAL, Then the calling sequence is: 874856cf3b9cSMatthew G. Knepley 874956cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[]) 875056cf3b9cSMatthew G. Knepley 875156cf3b9cSMatthew G. Knepley If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is: 875256cf3b9cSMatthew G. Knepley 875356cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux, 875456cf3b9cSMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 875556cf3b9cSMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 875656cf3b9cSMatthew G. Knepley $ PetscReal time, const PetscReal x[], PetscScalar bcval[]) 875756cf3b9cSMatthew G. Knepley 875856cf3b9cSMatthew G. Knepley + dim - the spatial dimension 875956cf3b9cSMatthew G. Knepley . Nf - the number of fields 876056cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 876156cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 876256cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point 876356cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 876456cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 876556cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 876656cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 876756cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point 876856cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 876956cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 877056cf3b9cSMatthew G. Knepley . t - current time 877156cf3b9cSMatthew G. Knepley . x - coordinates of the current point 877256cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters 877356cf3b9cSMatthew G. Knepley . constants - constant parameters 877456cf3b9cSMatthew G. Knepley - bcval - output values at the current point 877556cf3b9cSMatthew G. Knepley 8776a6ba4734SToby Isaac Level: developer 8777a6ba4734SToby Isaac 877845480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary() 8779a6ba4734SToby Isaac @*/ 878045480ffeSMatthew G. Knepley PetscErrorCode DMAddBoundary(DM dm, DMBoundaryConditionType type, const char name[], DMLabel label, PetscInt Nv, const PetscInt values[], PetscInt field, PetscInt Nc, const PetscInt comps[], void (*bcFunc)(void), void (*bcFunc_t)(void), void *ctx, PetscInt *bd) 8781a6ba4734SToby Isaac { 8782e5e52638SMatthew G. Knepley PetscDS ds; 8783a6ba4734SToby Isaac PetscErrorCode ierr; 8784a6ba4734SToby Isaac 8785a6ba4734SToby Isaac PetscFunctionBegin; 8786a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8787783e2ec8SMatthew G. Knepley PetscValidLogicalCollectiveEnum(dm, type, 2); 878845480ffeSMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4); 878945480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nv, 5); 879045480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, field, 7); 879145480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nc, 8); 8792e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 879345480ffeSMatthew G. Knepley ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr); 879445480ffeSMatthew G. Knepley ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr); 8795a6ba4734SToby Isaac PetscFunctionReturn(0); 8796a6ba4734SToby Isaac } 8797a6ba4734SToby Isaac 879845480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */ 8799e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm) 8800e6f8dbb6SToby Isaac { 8801e5e52638SMatthew G. Knepley PetscDS ds; 8802dff059c6SToby Isaac DMBoundary *lastnext; 8803e6f8dbb6SToby Isaac DSBoundary dsbound; 8804e6f8dbb6SToby Isaac PetscErrorCode ierr; 8805e6f8dbb6SToby Isaac 8806e6f8dbb6SToby Isaac PetscFunctionBegin; 8807e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 8808e5e52638SMatthew G. Knepley dsbound = ds->boundary; 880947a1f5adSToby Isaac if (dm->boundary) { 881047a1f5adSToby Isaac DMBoundary next = dm->boundary; 881147a1f5adSToby Isaac 881247a1f5adSToby Isaac /* quick check to see if the PetscDS has changed */ 881347a1f5adSToby Isaac if (next->dsboundary == dsbound) PetscFunctionReturn(0); 881447a1f5adSToby Isaac /* the PetscDS has changed: tear down and rebuild */ 881547a1f5adSToby Isaac while (next) { 881647a1f5adSToby Isaac DMBoundary b = next; 881747a1f5adSToby Isaac 881847a1f5adSToby Isaac next = b->next; 881947a1f5adSToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 8820a6ba4734SToby Isaac } 882147a1f5adSToby Isaac dm->boundary = NULL; 8822a6ba4734SToby Isaac } 882347a1f5adSToby Isaac 8824dff059c6SToby Isaac lastnext = &(dm->boundary); 8825e6f8dbb6SToby Isaac while (dsbound) { 8826e6f8dbb6SToby Isaac DMBoundary dmbound; 8827e6f8dbb6SToby Isaac 8828e6f8dbb6SToby Isaac ierr = PetscNew(&dmbound);CHKERRQ(ierr); 8829e6f8dbb6SToby Isaac dmbound->dsboundary = dsbound; 883045480ffeSMatthew G. Knepley dmbound->label = dsbound->label; 883147a1f5adSToby Isaac /* push on the back instead of the front so that it is in the same order as in the PetscDS */ 8832dff059c6SToby Isaac *lastnext = dmbound; 8833dff059c6SToby Isaac lastnext = &(dmbound->next); 8834dff059c6SToby Isaac dsbound = dsbound->next; 8835a6ba4734SToby Isaac } 8836a6ba4734SToby Isaac PetscFunctionReturn(0); 8837a6ba4734SToby Isaac } 8838a6ba4734SToby Isaac 8839a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd) 8840a6ba4734SToby Isaac { 8841b95f2879SToby Isaac DMBoundary b; 8842a6ba4734SToby Isaac PetscErrorCode ierr; 8843a6ba4734SToby Isaac 8844a6ba4734SToby Isaac PetscFunctionBegin; 8845a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8846534a8f05SLisandro Dalcin PetscValidBoolPointer(isBd, 3); 8847a6ba4734SToby Isaac *isBd = PETSC_FALSE; 8848e6f8dbb6SToby Isaac ierr = DMPopulateBoundary(dm);CHKERRQ(ierr); 8849b95f2879SToby Isaac b = dm->boundary; 8850a6ba4734SToby Isaac while (b && !(*isBd)) { 8851e6f8dbb6SToby Isaac DMLabel label = b->label; 8852e6f8dbb6SToby Isaac DSBoundary dsb = b->dsboundary; 8853a6ba4734SToby Isaac PetscInt i; 8854a6ba4734SToby Isaac 885545480ffeSMatthew G. Knepley if (label) { 885645480ffeSMatthew G. Knepley for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);} 8857a6ba4734SToby Isaac } 8858a6ba4734SToby Isaac b = b->next; 8859a6ba4734SToby Isaac } 8860a6ba4734SToby Isaac PetscFunctionReturn(0); 8861a6ba4734SToby Isaac } 88624d6f44ffSToby Isaac 88634d6f44ffSToby Isaac /*@C 8864a6e0b375SMatthew G. Knepley DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector. 8865a6e0b375SMatthew G. Knepley 8866a6e0b375SMatthew G. Knepley Collective on DM 88674d6f44ffSToby Isaac 88684d6f44ffSToby Isaac Input Parameters: 88694d6f44ffSToby Isaac + dm - The DM 88700709b2feSToby Isaac . time - The time 88714d6f44ffSToby Isaac . funcs - The coordinate functions to evaluate, one per field 88724d6f44ffSToby Isaac . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 88734d6f44ffSToby Isaac - mode - The insertion mode for values 88744d6f44ffSToby Isaac 88754d6f44ffSToby Isaac Output Parameter: 88764d6f44ffSToby Isaac . X - vector 88774d6f44ffSToby Isaac 88784d6f44ffSToby Isaac Calling sequence of func: 887977b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 88804d6f44ffSToby Isaac 88814d6f44ffSToby Isaac + dim - The spatial dimension 88828ec8862eSJed Brown . time - The time at which to sample 88834d6f44ffSToby Isaac . x - The coordinates 888477b739a6SMatthew Knepley . Nc - The number of components 88854d6f44ffSToby Isaac . u - The output field values 88864d6f44ffSToby Isaac - ctx - optional user-defined function context 88874d6f44ffSToby Isaac 88884d6f44ffSToby Isaac Level: developer 88894d6f44ffSToby Isaac 8890a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff() 88914d6f44ffSToby Isaac @*/ 88920709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X) 88934d6f44ffSToby Isaac { 88944d6f44ffSToby Isaac Vec localX; 88954d6f44ffSToby Isaac PetscErrorCode ierr; 88964d6f44ffSToby Isaac 88974d6f44ffSToby Isaac PetscFunctionBegin; 88984d6f44ffSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 88994d6f44ffSToby Isaac ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 89000709b2feSToby Isaac ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 89014d6f44ffSToby Isaac ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 89024d6f44ffSToby Isaac ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 89034d6f44ffSToby Isaac ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 89044d6f44ffSToby Isaac PetscFunctionReturn(0); 89054d6f44ffSToby Isaac } 89064d6f44ffSToby Isaac 8907a6e0b375SMatthew G. Knepley /*@C 8908a6e0b375SMatthew G. Knepley DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector. 8909a6e0b375SMatthew G. Knepley 8910a6e0b375SMatthew G. Knepley Not collective 8911a6e0b375SMatthew G. Knepley 8912a6e0b375SMatthew G. Knepley Input Parameters: 8913a6e0b375SMatthew G. Knepley + dm - The DM 8914a6e0b375SMatthew G. Knepley . time - The time 8915a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 8916a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 8917a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 8918a6e0b375SMatthew G. Knepley 8919a6e0b375SMatthew G. Knepley Output Parameter: 8920a6e0b375SMatthew G. Knepley . localX - vector 8921a6e0b375SMatthew G. Knepley 8922a6e0b375SMatthew G. Knepley Calling sequence of func: 892377b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 8924a6e0b375SMatthew G. Knepley 8925a6e0b375SMatthew G. Knepley + dim - The spatial dimension 8926a6e0b375SMatthew G. Knepley . x - The coordinates 892777b739a6SMatthew Knepley . Nc - The number of components 8928a6e0b375SMatthew G. Knepley . u - The output field values 8929a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 8930a6e0b375SMatthew G. Knepley 8931a6e0b375SMatthew G. Knepley Level: developer 8932a6e0b375SMatthew G. Knepley 8933a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff() 8934a6e0b375SMatthew G. Knepley @*/ 89350709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 89364d6f44ffSToby Isaac { 89374d6f44ffSToby Isaac PetscErrorCode ierr; 89384d6f44ffSToby Isaac 89394d6f44ffSToby Isaac PetscFunctionBegin; 89404d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8941064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 89420918c465SMatthew G. Knepley if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name); 89430709b2feSToby Isaac ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 89444d6f44ffSToby Isaac PetscFunctionReturn(0); 89454d6f44ffSToby Isaac } 89464d6f44ffSToby Isaac 8947a6e0b375SMatthew G. Knepley /*@C 8948a6e0b375SMatthew G. Knepley DMProjectFunctionLabel - This projects the given function into the function space provided, putting the coefficients in a global vector, setting values only for points in the given label. 8949a6e0b375SMatthew G. Knepley 8950a6e0b375SMatthew G. Knepley Collective on DM 8951a6e0b375SMatthew G. Knepley 8952a6e0b375SMatthew G. Knepley Input Parameters: 8953a6e0b375SMatthew G. Knepley + dm - The DM 8954a6e0b375SMatthew G. Knepley . time - The time 8955a6e0b375SMatthew G. Knepley . label - The DMLabel selecting the portion of the mesh for projection 8956a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 8957a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 8958a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 8959a6e0b375SMatthew G. Knepley 8960a6e0b375SMatthew G. Knepley Output Parameter: 8961a6e0b375SMatthew G. Knepley . X - vector 8962a6e0b375SMatthew G. Knepley 8963a6e0b375SMatthew G. Knepley Calling sequence of func: 896477b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 8965a6e0b375SMatthew G. Knepley 8966a6e0b375SMatthew G. Knepley + dim - The spatial dimension 8967a6e0b375SMatthew G. Knepley . x - The coordinates 896877b739a6SMatthew Knepley . Nc - The number of components 8969a6e0b375SMatthew G. Knepley . u - The output field values 8970a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 8971a6e0b375SMatthew G. Knepley 8972a6e0b375SMatthew G. Knepley Level: developer 8973a6e0b375SMatthew G. Knepley 8974a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff() 8975a6e0b375SMatthew G. Knepley @*/ 89762c53366bSMatthew G. Knepley PetscErrorCode DMProjectFunctionLabel(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X) 89772c53366bSMatthew G. Knepley { 89782c53366bSMatthew G. Knepley Vec localX; 89792c53366bSMatthew G. Knepley PetscErrorCode ierr; 89802c53366bSMatthew G. Knepley 89812c53366bSMatthew G. Knepley PetscFunctionBegin; 89822c53366bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 89832c53366bSMatthew G. Knepley ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 89842c53366bSMatthew G. Knepley ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 89852c53366bSMatthew G. Knepley ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 89862c53366bSMatthew G. Knepley ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 89872c53366bSMatthew G. Knepley ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 89882c53366bSMatthew G. Knepley PetscFunctionReturn(0); 89892c53366bSMatthew G. Knepley } 89902c53366bSMatthew G. Knepley 8991a6e0b375SMatthew G. Knepley /*@C 8992a6e0b375SMatthew G. Knepley DMProjectFunctionLabelLocal - This projects the given function into the function space provided, putting the coefficients in a local vector, setting values only for points in the given label. 8993a6e0b375SMatthew G. Knepley 8994a6e0b375SMatthew G. Knepley Not collective 8995a6e0b375SMatthew G. Knepley 8996a6e0b375SMatthew G. Knepley Input Parameters: 8997a6e0b375SMatthew G. Knepley + dm - The DM 8998a6e0b375SMatthew G. Knepley . time - The time 8999a6e0b375SMatthew G. Knepley . label - The DMLabel selecting the portion of the mesh for projection 9000a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 9001a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 9002a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9003a6e0b375SMatthew G. Knepley 9004a6e0b375SMatthew G. Knepley Output Parameter: 9005a6e0b375SMatthew G. Knepley . localX - vector 9006a6e0b375SMatthew G. Knepley 9007a6e0b375SMatthew G. Knepley Calling sequence of func: 900877b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 9009a6e0b375SMatthew G. Knepley 9010a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9011a6e0b375SMatthew G. Knepley . x - The coordinates 901277b739a6SMatthew Knepley . Nc - The number of components 9013a6e0b375SMatthew G. Knepley . u - The output field values 9014a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 9015a6e0b375SMatthew G. Knepley 9016a6e0b375SMatthew G. Knepley Level: developer 9017a6e0b375SMatthew G. Knepley 9018a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff() 9019a6e0b375SMatthew G. Knepley @*/ 90201c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFunctionLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 90214d6f44ffSToby Isaac { 90224d6f44ffSToby Isaac PetscErrorCode ierr; 90234d6f44ffSToby Isaac 90244d6f44ffSToby Isaac PetscFunctionBegin; 90254d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9026064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 90270918c465SMatthew G. Knepley if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name); 90281c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 90294d6f44ffSToby Isaac PetscFunctionReturn(0); 90304d6f44ffSToby Isaac } 90312716604bSToby Isaac 9032a6e0b375SMatthew G. Knepley /*@C 9033a6e0b375SMatthew G. Knepley DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector. 9034a6e0b375SMatthew G. Knepley 9035a6e0b375SMatthew G. Knepley Not collective 9036a6e0b375SMatthew G. Knepley 9037a6e0b375SMatthew G. Knepley Input Parameters: 9038a6e0b375SMatthew G. Knepley + dm - The DM 9039a6e0b375SMatthew G. Knepley . time - The time 9040a6e0b375SMatthew G. Knepley . localU - The input field vector 9041a6e0b375SMatthew G. Knepley . funcs - The functions to evaluate, one per field 9042a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9043a6e0b375SMatthew G. Knepley 9044a6e0b375SMatthew G. Knepley Output Parameter: 9045a6e0b375SMatthew G. Knepley . localX - The output vector 9046a6e0b375SMatthew G. Knepley 9047a6e0b375SMatthew G. Knepley Calling sequence of func: 9048a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9049a6e0b375SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9050a6e0b375SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9051a6e0b375SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9052a6e0b375SMatthew G. Knepley 9053a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9054a6e0b375SMatthew G. Knepley . Nf - The number of input fields 9055a6e0b375SMatthew G. Knepley . NfAux - The number of input auxiliary fields 9056a6e0b375SMatthew G. Knepley . uOff - The offset of each field in u[] 9057a6e0b375SMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9058a6e0b375SMatthew G. Knepley . u - The field values at this point in space 9059a6e0b375SMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9060a6e0b375SMatthew G. Knepley . u_x - The field derivatives at this point in space 9061a6e0b375SMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9062a6e0b375SMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9063a6e0b375SMatthew G. Knepley . a - The auxiliary field values at this point in space 9064a6e0b375SMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9065a6e0b375SMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9066a6e0b375SMatthew G. Knepley . t - The current time 9067a6e0b375SMatthew G. Knepley . x - The coordinates of this point 9068a6e0b375SMatthew G. Knepley . numConstants - The number of constants 9069a6e0b375SMatthew G. Knepley . constants - The value of each constant 9070a6e0b375SMatthew G. Knepley - f - The value of the function at this point in space 9071a6e0b375SMatthew G. Knepley 9072a6e0b375SMatthew G. Knepley Note: There are three different DMs that potentially interact in this function. The output DM, dm, specifies the layout of the values calculates by funcs. 9073a6e0b375SMatthew G. Knepley The input DM, attached to U, may be different. For example, you can input the solution over the full domain, but output over a piece of the boundary, or 9074a6e0b375SMatthew G. Knepley a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the 9075a6e0b375SMatthew G. Knepley auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations. 9076a6e0b375SMatthew G. Knepley 9077a6e0b375SMatthew G. Knepley Level: intermediate 9078a6e0b375SMatthew G. Knepley 9079a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9080a6e0b375SMatthew G. Knepley @*/ 90818c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU, 90828c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 90838c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 90848c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9085191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 90868c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 90878c6c5593SMatthew G. Knepley { 90888c6c5593SMatthew G. Knepley PetscErrorCode ierr; 90898c6c5593SMatthew G. Knepley 90908c6c5593SMatthew G. Knepley PetscFunctionBegin; 90918c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 90928c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localU,VEC_CLASSID,3); 90938c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 90940918c465SMatthew G. Knepley if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name); 90958c6c5593SMatthew G. Knepley ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr); 90968c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 90978c6c5593SMatthew G. Knepley } 90988c6c5593SMatthew G. Knepley 9099a6e0b375SMatthew G. Knepley /*@C 9100a6e0b375SMatthew G. Knepley DMProjectFieldLabelLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector, calculating only over the portion of the domain specified by the label. 9101a6e0b375SMatthew G. Knepley 9102a6e0b375SMatthew G. Knepley Not collective 9103a6e0b375SMatthew G. Knepley 9104a6e0b375SMatthew G. Knepley Input Parameters: 9105a6e0b375SMatthew G. Knepley + dm - The DM 9106a6e0b375SMatthew G. Knepley . time - The time 9107a6e0b375SMatthew G. Knepley . label - The DMLabel marking the portion of the domain to output 9108a6e0b375SMatthew G. Knepley . numIds - The number of label ids to use 9109a6e0b375SMatthew G. Knepley . ids - The label ids to use for marking 9110a6e0b375SMatthew G. Knepley . Nc - The number of components to set in the output, or PETSC_DETERMINE for all components 9111a6e0b375SMatthew G. Knepley . comps - The components to set in the output, or NULL for all components 9112a6e0b375SMatthew G. Knepley . localU - The input field vector 9113a6e0b375SMatthew G. Knepley . funcs - The functions to evaluate, one per field 9114a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9115a6e0b375SMatthew G. Knepley 9116a6e0b375SMatthew G. Knepley Output Parameter: 9117a6e0b375SMatthew G. Knepley . localX - The output vector 9118a6e0b375SMatthew G. Knepley 9119a6e0b375SMatthew G. Knepley Calling sequence of func: 9120a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9121a6e0b375SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9122a6e0b375SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9123a6e0b375SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9124a6e0b375SMatthew G. Knepley 9125a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9126a6e0b375SMatthew G. Knepley . Nf - The number of input fields 9127a6e0b375SMatthew G. Knepley . NfAux - The number of input auxiliary fields 9128a6e0b375SMatthew G. Knepley . uOff - The offset of each field in u[] 9129a6e0b375SMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9130a6e0b375SMatthew G. Knepley . u - The field values at this point in space 9131a6e0b375SMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9132a6e0b375SMatthew G. Knepley . u_x - The field derivatives at this point in space 9133a6e0b375SMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9134a6e0b375SMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9135a6e0b375SMatthew G. Knepley . a - The auxiliary field values at this point in space 9136a6e0b375SMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9137a6e0b375SMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9138a6e0b375SMatthew G. Knepley . t - The current time 9139a6e0b375SMatthew G. Knepley . x - The coordinates of this point 9140a6e0b375SMatthew G. Knepley . numConstants - The number of constants 9141a6e0b375SMatthew G. Knepley . constants - The value of each constant 9142a6e0b375SMatthew G. Knepley - f - The value of the function at this point in space 9143a6e0b375SMatthew G. Knepley 9144a6e0b375SMatthew G. Knepley Note: There are three different DMs that potentially interact in this function. The output DM, dm, specifies the layout of the values calculates by funcs. 9145a6e0b375SMatthew G. Knepley The input DM, attached to U, may be different. For example, you can input the solution over the full domain, but output over a piece of the boundary, or 9146a6e0b375SMatthew G. Knepley a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the 9147a6e0b375SMatthew G. Knepley auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations. 9148a6e0b375SMatthew G. Knepley 9149a6e0b375SMatthew G. Knepley Level: intermediate 9150a6e0b375SMatthew G. Knepley 9151a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9152a6e0b375SMatthew G. Knepley @*/ 91531c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 91548c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 91558c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 91568c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9157191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 91588c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 91598c6c5593SMatthew G. Knepley { 91608c6c5593SMatthew G. Knepley PetscErrorCode ierr; 91618c6c5593SMatthew G. Knepley 91628c6c5593SMatthew G. Knepley PetscFunctionBegin; 91638c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9164064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localU,VEC_CLASSID,8); 9165064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 9166ece3a9fcSMatthew G. Knepley if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name); 91671c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 91688c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 91698c6c5593SMatthew G. Knepley } 91708c6c5593SMatthew G. Knepley 91712716604bSToby Isaac /*@C 9172ece3a9fcSMatthew G. Knepley DMProjectBdFieldLabelLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector, calculating only over the portion of the domain boundary specified by the label. 9173ece3a9fcSMatthew G. Knepley 9174ece3a9fcSMatthew G. Knepley Not collective 9175ece3a9fcSMatthew G. Knepley 9176ece3a9fcSMatthew G. Knepley Input Parameters: 9177ece3a9fcSMatthew G. Knepley + dm - The DM 9178ece3a9fcSMatthew G. Knepley . time - The time 9179ece3a9fcSMatthew G. Knepley . label - The DMLabel marking the portion of the domain boundary to output 9180ece3a9fcSMatthew G. Knepley . numIds - The number of label ids to use 9181ece3a9fcSMatthew G. Knepley . ids - The label ids to use for marking 9182ece3a9fcSMatthew G. Knepley . Nc - The number of components to set in the output, or PETSC_DETERMINE for all components 9183ece3a9fcSMatthew G. Knepley . comps - The components to set in the output, or NULL for all components 9184ece3a9fcSMatthew G. Knepley . localU - The input field vector 9185ece3a9fcSMatthew G. Knepley . funcs - The functions to evaluate, one per field 9186ece3a9fcSMatthew G. Knepley - mode - The insertion mode for values 9187ece3a9fcSMatthew G. Knepley 9188ece3a9fcSMatthew G. Knepley Output Parameter: 9189ece3a9fcSMatthew G. Knepley . localX - The output vector 9190ece3a9fcSMatthew G. Knepley 9191ece3a9fcSMatthew G. Knepley Calling sequence of func: 9192ece3a9fcSMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9193ece3a9fcSMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9194ece3a9fcSMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9195ece3a9fcSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9196ece3a9fcSMatthew G. Knepley 9197ece3a9fcSMatthew G. Knepley + dim - The spatial dimension 9198ece3a9fcSMatthew G. Knepley . Nf - The number of input fields 9199ece3a9fcSMatthew G. Knepley . NfAux - The number of input auxiliary fields 9200ece3a9fcSMatthew G. Knepley . uOff - The offset of each field in u[] 9201ece3a9fcSMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9202ece3a9fcSMatthew G. Knepley . u - The field values at this point in space 9203ece3a9fcSMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9204ece3a9fcSMatthew G. Knepley . u_x - The field derivatives at this point in space 9205ece3a9fcSMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9206ece3a9fcSMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9207ece3a9fcSMatthew G. Knepley . a - The auxiliary field values at this point in space 9208ece3a9fcSMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9209ece3a9fcSMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9210ece3a9fcSMatthew G. Knepley . t - The current time 9211ece3a9fcSMatthew G. Knepley . x - The coordinates of this point 9212ece3a9fcSMatthew G. Knepley . n - The face normal 9213ece3a9fcSMatthew G. Knepley . numConstants - The number of constants 9214ece3a9fcSMatthew G. Knepley . constants - The value of each constant 9215ece3a9fcSMatthew G. Knepley - f - The value of the function at this point in space 9216ece3a9fcSMatthew G. Knepley 9217ece3a9fcSMatthew G. Knepley Note: 9218ece3a9fcSMatthew G. Knepley There are three different DMs that potentially interact in this function. The output DM, dm, specifies the layout of the values calculates by funcs. 9219ece3a9fcSMatthew G. Knepley The input DM, attached to U, may be different. For example, you can input the solution over the full domain, but output over a piece of the boundary, or 9220ece3a9fcSMatthew G. Knepley a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the 9221ece3a9fcSMatthew G. Knepley auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations. 9222ece3a9fcSMatthew G. Knepley 9223ece3a9fcSMatthew G. Knepley Level: intermediate 9224ece3a9fcSMatthew G. Knepley 9225ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9226ece3a9fcSMatthew G. Knepley @*/ 9227ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 9228ece3a9fcSMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 9229ece3a9fcSMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9230ece3a9fcSMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9231ece3a9fcSMatthew G. Knepley PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 9232ece3a9fcSMatthew G. Knepley InsertMode mode, Vec localX) 9233ece3a9fcSMatthew G. Knepley { 9234ece3a9fcSMatthew G. Knepley PetscErrorCode ierr; 9235ece3a9fcSMatthew G. Knepley 9236ece3a9fcSMatthew G. Knepley PetscFunctionBegin; 9237ece3a9fcSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9238064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localU,VEC_CLASSID,8); 9239064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 9240ece3a9fcSMatthew G. Knepley if (!dm->ops->projectbdfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name); 9241ece3a9fcSMatthew G. Knepley ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 9242ece3a9fcSMatthew G. Knepley PetscFunctionReturn(0); 9243ece3a9fcSMatthew G. Knepley } 9244ece3a9fcSMatthew G. Knepley 9245ece3a9fcSMatthew G. Knepley /*@C 92462716604bSToby Isaac DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h. 92472716604bSToby Isaac 92482716604bSToby Isaac Input Parameters: 92492716604bSToby Isaac + dm - The DM 92500709b2feSToby Isaac . time - The time 92512716604bSToby Isaac . funcs - The functions to evaluate for each field component 92522716604bSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9253574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 92542716604bSToby Isaac 92552716604bSToby Isaac Output Parameter: 92562716604bSToby Isaac . diff - The diff ||u - u_h||_2 92572716604bSToby Isaac 92582716604bSToby Isaac Level: developer 92592716604bSToby Isaac 92601189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 92612716604bSToby Isaac @*/ 92620709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff) 92632716604bSToby Isaac { 92642716604bSToby Isaac PetscErrorCode ierr; 92652716604bSToby Isaac 92662716604bSToby Isaac PetscFunctionBegin; 92672716604bSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9268b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 92690918c465SMatthew G. Knepley if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name); 92700709b2feSToby Isaac ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 92712716604bSToby Isaac PetscFunctionReturn(0); 92722716604bSToby Isaac } 9273b698f381SToby Isaac 9274b698f381SToby Isaac /*@C 9275b698f381SToby Isaac DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h. 9276b698f381SToby Isaac 9277d083f849SBarry Smith Collective on dm 9278d083f849SBarry Smith 9279b698f381SToby Isaac Input Parameters: 9280b698f381SToby Isaac + dm - The DM 9281b698f381SToby Isaac , time - The time 9282b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component 9283b698f381SToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9284574a98acSMatthew G. Knepley . X - The coefficient vector u_h, a global vector 9285b698f381SToby Isaac - n - The vector to project along 9286b698f381SToby Isaac 9287b698f381SToby Isaac Output Parameter: 9288b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2 9289b698f381SToby Isaac 9290b698f381SToby Isaac Level: developer 9291b698f381SToby Isaac 9292b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff() 9293b698f381SToby Isaac @*/ 9294b698f381SToby 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) 9295b698f381SToby Isaac { 9296b698f381SToby Isaac PetscErrorCode ierr; 9297b698f381SToby Isaac 9298b698f381SToby Isaac PetscFunctionBegin; 9299b698f381SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9300b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 9301b698f381SToby Isaac if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name); 9302b698f381SToby Isaac ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr); 9303b698f381SToby Isaac PetscFunctionReturn(0); 9304b698f381SToby Isaac } 9305b698f381SToby Isaac 93062a16baeaSToby Isaac /*@C 93072a16baeaSToby Isaac DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components. 93082a16baeaSToby Isaac 9309d083f849SBarry Smith Collective on dm 9310d083f849SBarry Smith 93112a16baeaSToby Isaac Input Parameters: 93122a16baeaSToby Isaac + dm - The DM 93132a16baeaSToby Isaac . time - The time 93142a16baeaSToby Isaac . funcs - The functions to evaluate for each field component 93152a16baeaSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9316574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 93172a16baeaSToby Isaac 93182a16baeaSToby Isaac Output Parameter: 93192a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2 93202a16baeaSToby Isaac 93212a16baeaSToby Isaac Level: developer 93222a16baeaSToby Isaac 93231189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 93242a16baeaSToby Isaac @*/ 93251189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[]) 93262a16baeaSToby Isaac { 93272a16baeaSToby Isaac PetscErrorCode ierr; 93282a16baeaSToby Isaac 93292a16baeaSToby Isaac PetscFunctionBegin; 93302a16baeaSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 93312a16baeaSToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 93320918c465SMatthew G. Knepley if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name); 93332a16baeaSToby Isaac ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 93342a16baeaSToby Isaac PetscFunctionReturn(0); 93352a16baeaSToby Isaac } 93362a16baeaSToby Isaac 9337df0b854cSToby Isaac /*@C 9338502a2867SDave May DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors 9339502a2867SDave May 9340502a2867SDave May Not Collective 9341502a2867SDave May 9342502a2867SDave May Input Parameter: 9343502a2867SDave May . dm - The DM 9344502a2867SDave May 93450a19bb7dSprj- Output Parameters: 93460a19bb7dSprj- + nranks - the number of neighbours 93470a19bb7dSprj- - ranks - the neighbors ranks 9348502a2867SDave May 9349502a2867SDave May Notes: 9350502a2867SDave May Do not free the array, it is freed when the DM is destroyed. 9351502a2867SDave May 9352502a2867SDave May Level: beginner 9353502a2867SDave May 9354dec1416fSJunchao Zhang .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks() 9355502a2867SDave May @*/ 9356502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[]) 9357502a2867SDave May { 9358502a2867SDave May PetscErrorCode ierr; 9359502a2867SDave May 9360502a2867SDave May PetscFunctionBegin; 9361502a2867SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 93620918c465SMatthew G. Knepley if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name); 9363502a2867SDave May ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr); 9364502a2867SDave May PetscFunctionReturn(0); 9365502a2867SDave May } 9366502a2867SDave May 9367531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */ 9368531c7667SBarry Smith 9369531c7667SBarry Smith /* 9370531c7667SBarry Smith Converts the input vector to a ghosted vector and then calls the standard coloring code. 9371531c7667SBarry Smith This has be a different function because it requires DM which is not defined in the Mat library 9372531c7667SBarry Smith */ 9373531c7667SBarry Smith PetscErrorCode MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx) 9374531c7667SBarry Smith { 9375531c7667SBarry Smith PetscErrorCode ierr; 9376531c7667SBarry Smith 9377531c7667SBarry Smith PetscFunctionBegin; 9378531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 9379531c7667SBarry Smith Vec x1local; 9380531c7667SBarry Smith DM dm; 9381531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 9382531c7667SBarry Smith if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM"); 9383531c7667SBarry Smith ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr); 9384531c7667SBarry Smith ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 9385531c7667SBarry Smith ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 9386531c7667SBarry Smith x1 = x1local; 9387531c7667SBarry Smith } 9388531c7667SBarry Smith ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr); 9389531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 9390531c7667SBarry Smith DM dm; 9391531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 9392531c7667SBarry Smith ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr); 9393531c7667SBarry Smith } 9394531c7667SBarry Smith PetscFunctionReturn(0); 9395531c7667SBarry Smith } 9396531c7667SBarry Smith 9397531c7667SBarry Smith /*@ 9398531c7667SBarry Smith MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring 9399531c7667SBarry Smith 9400531c7667SBarry Smith Input Parameter: 9401531c7667SBarry Smith . coloring - the MatFDColoring object 9402531c7667SBarry Smith 940395452b02SPatrick Sanan Developer Notes: 940495452b02SPatrick Sanan this routine exists because the PETSc Mat library does not know about the DM objects 9405531c7667SBarry Smith 94061b266c99SBarry Smith Level: advanced 94071b266c99SBarry Smith 9408531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType 9409531c7667SBarry Smith @*/ 9410531c7667SBarry Smith PetscErrorCode MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring) 9411531c7667SBarry Smith { 9412531c7667SBarry Smith PetscFunctionBegin; 9413531c7667SBarry Smith coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM; 9414531c7667SBarry Smith PetscFunctionReturn(0); 9415531c7667SBarry Smith } 94168320bc6fSPatrick Sanan 94178320bc6fSPatrick Sanan /*@ 94188320bc6fSPatrick Sanan DMGetCompatibility - determine if two DMs are compatible 94198320bc6fSPatrick Sanan 94208320bc6fSPatrick Sanan Collective 94218320bc6fSPatrick Sanan 94228320bc6fSPatrick Sanan Input Parameters: 9423a5bc1bf3SBarry Smith + dm1 - the first DM 94248320bc6fSPatrick Sanan - dm2 - the second DM 94258320bc6fSPatrick Sanan 94268320bc6fSPatrick Sanan Output Parameters: 94278320bc6fSPatrick Sanan + compatible - whether or not the two DMs are compatible 94288320bc6fSPatrick Sanan - set - whether or not the compatible value was set 94298320bc6fSPatrick Sanan 94308320bc6fSPatrick Sanan Notes: 94318320bc6fSPatrick Sanan Two DMs are deemed compatible if they represent the same parallel decomposition 94323d862458SPatrick Sanan of the same topology. This implies that the section (field data) on one 94338320bc6fSPatrick Sanan "makes sense" with respect to the topology and parallel decomposition of the other. 94343d862458SPatrick Sanan Loosely speaking, compatible DMs represent the same domain and parallel 94353d862458SPatrick Sanan decomposition, but hold different data. 94368320bc6fSPatrick Sanan 94378320bc6fSPatrick Sanan Typically, one would confirm compatibility if intending to simultaneously iterate 94388320bc6fSPatrick Sanan over a pair of vectors obtained from different DMs. 94398320bc6fSPatrick Sanan 94408320bc6fSPatrick Sanan For example, two DMDA objects are compatible if they have the same local 94418320bc6fSPatrick Sanan and global sizes and the same stencil width. They can have different numbers 94428320bc6fSPatrick Sanan of degrees of freedom per node. Thus, one could use the node numbering from 94438320bc6fSPatrick Sanan either DM in bounds for a loop over vectors derived from either DM. 94448320bc6fSPatrick Sanan 94458320bc6fSPatrick Sanan Consider the operation of summing data living on a 2-dof DMDA to data living 94468320bc6fSPatrick Sanan on a 1-dof DMDA, which should be compatible, as in the following snippet. 94478320bc6fSPatrick Sanan .vb 94488320bc6fSPatrick Sanan ... 94498320bc6fSPatrick Sanan ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr); 94508320bc6fSPatrick Sanan if (set && compatible) { 94518320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 94528320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 94533d862458SPatrick Sanan ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr); 94548320bc6fSPatrick Sanan for (j=y; j<y+n; ++j) { 94558320bc6fSPatrick Sanan for (i=x; i<x+m, ++i) { 94568320bc6fSPatrick Sanan arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1]; 94578320bc6fSPatrick Sanan } 94588320bc6fSPatrick Sanan } 94598320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 94608320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 94618320bc6fSPatrick Sanan } else { 94628320bc6fSPatrick Sanan SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible"); 94638320bc6fSPatrick Sanan } 94648320bc6fSPatrick Sanan ... 94658320bc6fSPatrick Sanan .ve 94668320bc6fSPatrick Sanan 94678320bc6fSPatrick Sanan Checking compatibility might be expensive for a given implementation of DM, 94688320bc6fSPatrick Sanan or might be impossible to unambiguously confirm or deny. For this reason, 94698320bc6fSPatrick Sanan this function may decline to determine compatibility, and hence users should 94708320bc6fSPatrick Sanan always check the "set" output parameter. 94718320bc6fSPatrick Sanan 94728320bc6fSPatrick Sanan A DM is always compatible with itself. 94738320bc6fSPatrick Sanan 94748320bc6fSPatrick Sanan In the current implementation, DMs which live on "unequal" communicators 94758320bc6fSPatrick Sanan (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed 94768320bc6fSPatrick Sanan incompatible. 94778320bc6fSPatrick Sanan 94788320bc6fSPatrick Sanan This function is labeled "Collective," as information about all subdomains 94798320bc6fSPatrick Sanan is required on each rank. However, in DM implementations which store all this 94808320bc6fSPatrick Sanan information locally, this function may be merely "Logically Collective". 94818320bc6fSPatrick Sanan 94828320bc6fSPatrick Sanan Developer Notes: 94833d862458SPatrick Sanan Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B 94843d862458SPatrick Sanan iff B is compatible with A. Thus, this function checks the implementations 9485a5bc1bf3SBarry Smith of both dm and dmc (if they are of different types), attempting to determine 94868320bc6fSPatrick Sanan compatibility. It is left to DM implementers to ensure that symmetry is 94878320bc6fSPatrick Sanan preserved. The simplest way to do this is, when implementing type-specific 94883d862458SPatrick Sanan logic for this function, is to check for existing logic in the implementation 94893d862458SPatrick Sanan of other DM types and let *set = PETSC_FALSE if found. 94908320bc6fSPatrick Sanan 94918320bc6fSPatrick Sanan Level: advanced 94928320bc6fSPatrick Sanan 94933d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag() 94948320bc6fSPatrick Sanan @*/ 94958320bc6fSPatrick Sanan 9496a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set) 94978320bc6fSPatrick Sanan { 94988320bc6fSPatrick Sanan PetscErrorCode ierr; 94998320bc6fSPatrick Sanan PetscMPIInt compareResult; 95008320bc6fSPatrick Sanan DMType type,type2; 95018320bc6fSPatrick Sanan PetscBool sameType; 95028320bc6fSPatrick Sanan 95038320bc6fSPatrick Sanan PetscFunctionBegin; 9504a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 95058320bc6fSPatrick Sanan PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 95068320bc6fSPatrick Sanan 95078320bc6fSPatrick Sanan /* Declare a DM compatible with itself */ 9508a5bc1bf3SBarry Smith if (dm1 == dm2) { 95098320bc6fSPatrick Sanan *set = PETSC_TRUE; 95108320bc6fSPatrick Sanan *compatible = PETSC_TRUE; 95118320bc6fSPatrick Sanan PetscFunctionReturn(0); 95128320bc6fSPatrick Sanan } 95138320bc6fSPatrick Sanan 95148320bc6fSPatrick Sanan /* Declare a DM incompatible with a DM that lives on an "unequal" 95158320bc6fSPatrick Sanan communicator. Note that this does not preclude compatibility with 95168320bc6fSPatrick Sanan DMs living on "congruent" or "similar" communicators, but this must be 95178320bc6fSPatrick Sanan determined by the implementation-specific logic */ 9518ffc4695bSBarry Smith ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr); 95198320bc6fSPatrick Sanan if (compareResult == MPI_UNEQUAL) { 95208320bc6fSPatrick Sanan *set = PETSC_TRUE; 95218320bc6fSPatrick Sanan *compatible = PETSC_FALSE; 95228320bc6fSPatrick Sanan PetscFunctionReturn(0); 95238320bc6fSPatrick Sanan } 95248320bc6fSPatrick Sanan 95258320bc6fSPatrick Sanan /* Pass to the implementation-specific routine, if one exists. */ 9526a5bc1bf3SBarry Smith if (dm1->ops->getcompatibility) { 9527a5bc1bf3SBarry Smith ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr); 9528b9d85ea2SLisandro Dalcin if (*set) PetscFunctionReturn(0); 95298320bc6fSPatrick Sanan } 95308320bc6fSPatrick Sanan 9531a5bc1bf3SBarry Smith /* If dm1 and dm2 are of different types, then attempt to check compatibility 95328320bc6fSPatrick Sanan with an implementation of this function from dm2 */ 9533a5bc1bf3SBarry Smith ierr = DMGetType(dm1,&type);CHKERRQ(ierr); 95348320bc6fSPatrick Sanan ierr = DMGetType(dm2,&type2);CHKERRQ(ierr); 95358320bc6fSPatrick Sanan ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr); 95368320bc6fSPatrick Sanan if (!sameType && dm2->ops->getcompatibility) { 9537a5bc1bf3SBarry Smith ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */ 95388320bc6fSPatrick Sanan } else { 95398320bc6fSPatrick Sanan *set = PETSC_FALSE; 95408320bc6fSPatrick Sanan } 95418320bc6fSPatrick Sanan PetscFunctionReturn(0); 95428320bc6fSPatrick Sanan } 9543c0f0dcc3SMatthew G. Knepley 9544c0f0dcc3SMatthew G. Knepley /*@C 9545c0f0dcc3SMatthew G. Knepley DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance. 9546c0f0dcc3SMatthew G. Knepley 9547c0f0dcc3SMatthew G. Knepley Logically Collective on DM 9548c0f0dcc3SMatthew G. Knepley 9549c0f0dcc3SMatthew G. Knepley Input Parameters: 9550c0f0dcc3SMatthew G. Knepley + DM - the DM 9551c0f0dcc3SMatthew G. Knepley . f - the monitor function 9552c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired) 9553c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL) 9554c0f0dcc3SMatthew G. Knepley 9555c0f0dcc3SMatthew G. Knepley Options Database Keys: 9556c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but 9557c0f0dcc3SMatthew G. Knepley does not cancel those set via the options database. 9558c0f0dcc3SMatthew G. Knepley 9559c0f0dcc3SMatthew G. Knepley Notes: 9560c0f0dcc3SMatthew G. Knepley Several different monitoring routines may be set by calling 9561c0f0dcc3SMatthew G. Knepley DMMonitorSet() multiple times; all will be called in the 9562c0f0dcc3SMatthew G. Knepley order in which they were set. 9563c0f0dcc3SMatthew G. Knepley 9564c0f0dcc3SMatthew G. Knepley Fortran Notes: 9565c0f0dcc3SMatthew G. Knepley Only a single monitor function can be set for each DM object 9566c0f0dcc3SMatthew G. Knepley 9567c0f0dcc3SMatthew G. Knepley Level: intermediate 9568c0f0dcc3SMatthew G. Knepley 9569c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel() 9570c0f0dcc3SMatthew G. Knepley @*/ 9571c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**)) 9572c0f0dcc3SMatthew G. Knepley { 9573c0f0dcc3SMatthew G. Knepley PetscInt m; 9574c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9575c0f0dcc3SMatthew G. Knepley 9576c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9577c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9578c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9579c0f0dcc3SMatthew G. Knepley PetscBool identical; 9580c0f0dcc3SMatthew G. Knepley 9581c0f0dcc3SMatthew G. Knepley ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr); 9582c0f0dcc3SMatthew G. Knepley if (identical) PetscFunctionReturn(0); 9583c0f0dcc3SMatthew G. Knepley } 9584c0f0dcc3SMatthew G. Knepley if (dm->numbermonitors >= MAXDMMONITORS) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set"); 9585c0f0dcc3SMatthew G. Knepley dm->monitor[dm->numbermonitors] = f; 9586c0f0dcc3SMatthew G. Knepley dm->monitordestroy[dm->numbermonitors] = monitordestroy; 9587c0f0dcc3SMatthew G. Knepley dm->monitorcontext[dm->numbermonitors++] = (void *) mctx; 9588c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9589c0f0dcc3SMatthew G. Knepley } 9590c0f0dcc3SMatthew G. Knepley 9591c0f0dcc3SMatthew G. Knepley /*@ 9592c0f0dcc3SMatthew G. Knepley DMMonitorCancel - Clears all the monitor functions for a DM object. 9593c0f0dcc3SMatthew G. Knepley 9594c0f0dcc3SMatthew G. Knepley Logically Collective on DM 9595c0f0dcc3SMatthew G. Knepley 9596c0f0dcc3SMatthew G. Knepley Input Parameter: 9597c0f0dcc3SMatthew G. Knepley . dm - the DM 9598c0f0dcc3SMatthew G. Knepley 9599c0f0dcc3SMatthew G. Knepley Options Database Key: 9600c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired 9601c0f0dcc3SMatthew G. Knepley into a code by calls to DMonitorSet(), but does not cancel those 9602c0f0dcc3SMatthew G. Knepley set via the options database 9603c0f0dcc3SMatthew G. Knepley 9604c0f0dcc3SMatthew G. Knepley Notes: 9605c0f0dcc3SMatthew G. Knepley There is no way to clear one specific monitor from a DM object. 9606c0f0dcc3SMatthew G. Knepley 9607c0f0dcc3SMatthew G. Knepley Level: intermediate 9608c0f0dcc3SMatthew G. Knepley 9609c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet() 9610c0f0dcc3SMatthew G. Knepley @*/ 9611c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm) 9612c0f0dcc3SMatthew G. Knepley { 9613c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9614c0f0dcc3SMatthew G. Knepley PetscInt m; 9615c0f0dcc3SMatthew G. Knepley 9616c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9617c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9618c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9619c0f0dcc3SMatthew G. Knepley if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);} 9620c0f0dcc3SMatthew G. Knepley } 9621c0f0dcc3SMatthew G. Knepley dm->numbermonitors = 0; 9622c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9623c0f0dcc3SMatthew G. Knepley } 9624c0f0dcc3SMatthew G. Knepley 9625c0f0dcc3SMatthew G. Knepley /*@C 9626c0f0dcc3SMatthew G. Knepley DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 9627c0f0dcc3SMatthew G. Knepley 9628c0f0dcc3SMatthew G. Knepley Collective on DM 9629c0f0dcc3SMatthew G. Knepley 9630c0f0dcc3SMatthew G. Knepley Input Parameters: 9631c0f0dcc3SMatthew G. Knepley + dm - DM object you wish to monitor 9632c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking 9633c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done 9634c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor 9635c0f0dcc3SMatthew G. Knepley . monitor - the monitor function 9636c0f0dcc3SMatthew G. Knepley - monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the DM or PetscViewer objects 9637c0f0dcc3SMatthew G. Knepley 9638c0f0dcc3SMatthew G. Knepley Output Parameter: 9639c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created 9640c0f0dcc3SMatthew G. Knepley 9641c0f0dcc3SMatthew G. Knepley Level: developer 9642c0f0dcc3SMatthew G. Knepley 9643c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 9644c0f0dcc3SMatthew G. Knepley PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 9645c0f0dcc3SMatthew G. Knepley PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 9646c0f0dcc3SMatthew G. Knepley PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 9647c0f0dcc3SMatthew G. Knepley PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 9648c0f0dcc3SMatthew G. Knepley PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 9649c0f0dcc3SMatthew G. Knepley PetscOptionsFList(), PetscOptionsEList() 9650c0f0dcc3SMatthew G. Knepley @*/ 9651c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSetFromOptions(DM dm, const char name[], const char help[], const char manual[], PetscErrorCode (*monitor)(DM, void *), PetscErrorCode (*monitorsetup)(DM, PetscViewerAndFormat *), PetscBool *flg) 9652c0f0dcc3SMatthew G. Knepley { 9653c0f0dcc3SMatthew G. Knepley PetscViewer viewer; 9654c0f0dcc3SMatthew G. Knepley PetscViewerFormat format; 9655c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9656c0f0dcc3SMatthew G. Knepley 9657c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9658c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9659c0f0dcc3SMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr); 9660c0f0dcc3SMatthew G. Knepley if (*flg) { 9661c0f0dcc3SMatthew G. Knepley PetscViewerAndFormat *vf; 9662c0f0dcc3SMatthew G. Knepley 9663c0f0dcc3SMatthew G. Knepley ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr); 9664c0f0dcc3SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr); 9665c0f0dcc3SMatthew G. Knepley if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);} 9666c0f0dcc3SMatthew G. Knepley ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr); 9667c0f0dcc3SMatthew G. Knepley } 9668c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9669c0f0dcc3SMatthew G. Knepley } 9670c0f0dcc3SMatthew G. Knepley 9671c0f0dcc3SMatthew G. Knepley /*@ 9672c0f0dcc3SMatthew G. Knepley DMMonitor - runs the user provided monitor routines, if they exist 9673c0f0dcc3SMatthew G. Knepley 9674c0f0dcc3SMatthew G. Knepley Collective on DM 9675c0f0dcc3SMatthew G. Knepley 9676c0f0dcc3SMatthew G. Knepley Input Parameters: 9677c0f0dcc3SMatthew G. Knepley . dm - The DM 9678c0f0dcc3SMatthew G. Knepley 9679c0f0dcc3SMatthew G. Knepley Level: developer 9680c0f0dcc3SMatthew G. Knepley 9681c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet() 9682c0f0dcc3SMatthew G. Knepley @*/ 9683c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm) 9684c0f0dcc3SMatthew G. Knepley { 9685c0f0dcc3SMatthew G. Knepley PetscInt m; 9686c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9687c0f0dcc3SMatthew G. Knepley 9688c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9689c0f0dcc3SMatthew G. Knepley if (!dm) PetscFunctionReturn(0); 9690c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9691c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9692c0f0dcc3SMatthew G. Knepley ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr); 9693c0f0dcc3SMatthew G. Knepley } 9694c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9695c0f0dcc3SMatthew G. Knepley } 96962e4af2aeSMatthew G. Knepley 96972e4af2aeSMatthew G. Knepley /*@ 96982e4af2aeSMatthew G. Knepley DMComputeError - Computes the error assuming the user has given exact solution functions 96992e4af2aeSMatthew G. Knepley 97002e4af2aeSMatthew G. Knepley Collective on DM 97012e4af2aeSMatthew G. Knepley 97022e4af2aeSMatthew G. Knepley Input Parameters: 97032e4af2aeSMatthew G. Knepley + dm - The DM 97046b867d5aSJose E. Roman - sol - The solution vector 97052e4af2aeSMatthew G. Knepley 97066b867d5aSJose E. Roman Input/Output Parameter: 97076b867d5aSJose E. Roman . errors - An array of length Nf, the number of fields, or NULL for no output; on output 97086b867d5aSJose E. Roman contains the error in each field 97096b867d5aSJose E. Roman 97106b867d5aSJose E. Roman Output Parameter: 97116b867d5aSJose E. Roman . errorVec - A vector to hold the cellwise error (may be NULL) 97122e4af2aeSMatthew G. Knepley 97132e4af2aeSMatthew G. Knepley Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber(). 97142e4af2aeSMatthew G. Knepley 97152e4af2aeSMatthew G. Knepley Level: developer 97162e4af2aeSMatthew G. Knepley 97172e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber() 97182e4af2aeSMatthew G. Knepley @*/ 97192e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec) 97202e4af2aeSMatthew G. Knepley { 97212e4af2aeSMatthew G. Knepley PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *); 97222e4af2aeSMatthew G. Knepley void **ctxs; 97232e4af2aeSMatthew G. Knepley PetscReal time; 97242e4af2aeSMatthew G. Knepley PetscInt Nf, f, Nds, s; 97252e4af2aeSMatthew G. Knepley PetscErrorCode ierr; 97262e4af2aeSMatthew G. Knepley 97272e4af2aeSMatthew G. Knepley PetscFunctionBegin; 97282e4af2aeSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 97292e4af2aeSMatthew G. Knepley ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr); 97302e4af2aeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 97312e4af2aeSMatthew G. Knepley for (s = 0; s < Nds; ++s) { 97322e4af2aeSMatthew G. Knepley PetscDS ds; 97332e4af2aeSMatthew G. Knepley DMLabel label; 97342e4af2aeSMatthew G. Knepley IS fieldIS; 97352e4af2aeSMatthew G. Knepley const PetscInt *fields; 97362e4af2aeSMatthew G. Knepley PetscInt dsNf; 97372e4af2aeSMatthew G. Knepley 97382e4af2aeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr); 97392e4af2aeSMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr); 97402e4af2aeSMatthew G. Knepley if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);} 97412e4af2aeSMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 97422e4af2aeSMatthew G. Knepley const PetscInt field = fields[f]; 97432e4af2aeSMatthew G. Knepley ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr); 97442e4af2aeSMatthew G. Knepley } 97452e4af2aeSMatthew G. Knepley if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);} 97462e4af2aeSMatthew G. Knepley } 97472e4af2aeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 97482e4af2aeSMatthew G. Knepley if (!exactSol[f]) SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "DS must contain exact solution functions in order to calculate error, missing for field %D", f); 97492e4af2aeSMatthew G. Knepley } 97502e4af2aeSMatthew G. Knepley ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr); 97512e4af2aeSMatthew G. Knepley if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);} 97522e4af2aeSMatthew G. Knepley if (errorVec) { 97532e4af2aeSMatthew G. Knepley DM edm; 97542e4af2aeSMatthew G. Knepley DMPolytopeType ct; 97552e4af2aeSMatthew G. Knepley PetscBool simplex; 97562e4af2aeSMatthew G. Knepley PetscInt dim, cStart, Nf; 97572e4af2aeSMatthew G. Knepley 97582e4af2aeSMatthew G. Knepley ierr = DMClone(dm, &edm);CHKERRQ(ierr); 97592e4af2aeSMatthew G. Knepley ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr); 97602e4af2aeSMatthew G. Knepley ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr); 97612e4af2aeSMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 97622e4af2aeSMatthew G. Knepley simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE; 97632e4af2aeSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 97642e4af2aeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 97652e4af2aeSMatthew G. Knepley PetscFE fe, efe; 97662e4af2aeSMatthew G. Knepley PetscQuadrature q; 97672e4af2aeSMatthew G. Knepley const char *name; 97682e4af2aeSMatthew G. Knepley 97692e4af2aeSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr); 97702e4af2aeSMatthew G. Knepley ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr); 97712e4af2aeSMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr); 97722e4af2aeSMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr); 97732e4af2aeSMatthew G. Knepley ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr); 97742e4af2aeSMatthew G. Knepley ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr); 97752e4af2aeSMatthew G. Knepley ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr); 97762e4af2aeSMatthew G. Knepley ierr = PetscFEDestroy(&efe);CHKERRQ(ierr); 97772e4af2aeSMatthew G. Knepley } 97782e4af2aeSMatthew G. Knepley ierr = DMCreateDS(edm);CHKERRQ(ierr); 97792e4af2aeSMatthew G. Knepley 97801e1ea65dSPierre Jolivet ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr); 97812e4af2aeSMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr); 97822e4af2aeSMatthew G. Knepley ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr); 97832e4af2aeSMatthew G. Knepley ierr = DMDestroy(&edm);CHKERRQ(ierr); 97842e4af2aeSMatthew G. Knepley } 97852e4af2aeSMatthew G. Knepley ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr); 97862e4af2aeSMatthew G. Knepley PetscFunctionReturn(0); 97872e4af2aeSMatthew G. Knepley } 97889a2a23afSMatthew G. Knepley 97899a2a23afSMatthew G. Knepley /*@ 97909a2a23afSMatthew G. Knepley DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM 97919a2a23afSMatthew G. Knepley 97929a2a23afSMatthew G. Knepley Not collective 97939a2a23afSMatthew G. Knepley 97949a2a23afSMatthew G. Knepley Input Parameter: 97959a2a23afSMatthew G. Knepley . dm - The DM 97969a2a23afSMatthew G. Knepley 97979a2a23afSMatthew G. Knepley Output Parameter: 9798a5b23f4aSJose E. Roman . numAux - The number of auxiliary data vectors 97999a2a23afSMatthew G. Knepley 98009a2a23afSMatthew G. Knepley Level: advanced 98019a2a23afSMatthew G. Knepley 98029a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 98039a2a23afSMatthew G. Knepley @*/ 98049a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux) 98059a2a23afSMatthew G. Knepley { 98069a2a23afSMatthew G. Knepley PetscErrorCode ierr; 98079a2a23afSMatthew G. Knepley 98089a2a23afSMatthew G. Knepley PetscFunctionBegin; 98099a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 98109a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr); 98119a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 98129a2a23afSMatthew G. Knepley } 98139a2a23afSMatthew G. Knepley 98149a2a23afSMatthew G. Knepley /*@ 98159a2a23afSMatthew G. Knepley DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value 98169a2a23afSMatthew G. Knepley 98179a2a23afSMatthew G. Knepley Not collective 98189a2a23afSMatthew G. Knepley 98199a2a23afSMatthew G. Knepley Input Parameters: 98209a2a23afSMatthew G. Knepley + dm - The DM 98219a2a23afSMatthew G. Knepley . label - The DMLabel 98229a2a23afSMatthew G. Knepley - value - The label value indicating the region 98239a2a23afSMatthew G. Knepley 98249a2a23afSMatthew G. Knepley Output Parameter: 98259a2a23afSMatthew G. Knepley . aux - The Vec holding auxiliary field data 98269a2a23afSMatthew G. Knepley 982704c51a94SMatthew G. Knepley Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well. 982804c51a94SMatthew G. Knepley 98299a2a23afSMatthew G. Knepley Level: advanced 98309a2a23afSMatthew G. Knepley 98319a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec() 98329a2a23afSMatthew G. Knepley @*/ 98339a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux) 98349a2a23afSMatthew G. Knepley { 983504c51a94SMatthew G. Knepley PetscHashAuxKey key, wild = {NULL, 0}; 983604c51a94SMatthew G. Knepley PetscBool has; 98379a2a23afSMatthew G. Knepley PetscErrorCode ierr; 98389a2a23afSMatthew G. Knepley 98399a2a23afSMatthew G. Knepley PetscFunctionBegin; 98409a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 98419a2a23afSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 98429a2a23afSMatthew G. Knepley key.label = label; 98439a2a23afSMatthew G. Knepley key.value = value; 984404c51a94SMatthew G. Knepley ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr); 984504c51a94SMatthew G. Knepley if (has) {ierr = PetscHMapAuxGet(dm->auxData, key, aux);CHKERRQ(ierr);} 984604c51a94SMatthew G. Knepley else {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);} 98479a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 98489a2a23afSMatthew G. Knepley } 98499a2a23afSMatthew G. Knepley 98509a2a23afSMatthew G. Knepley /*@ 98519a2a23afSMatthew G. Knepley DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value 98529a2a23afSMatthew G. Knepley 98539a2a23afSMatthew G. Knepley Not collective 98549a2a23afSMatthew G. Knepley 98559a2a23afSMatthew G. Knepley Input Parameters: 98569a2a23afSMatthew G. Knepley + dm - The DM 98579a2a23afSMatthew G. Knepley . label - The DMLabel 98589a2a23afSMatthew G. Knepley . value - The label value indicating the region 98599a2a23afSMatthew G. Knepley - aux - The Vec holding auxiliary field data 98609a2a23afSMatthew G. Knepley 98619a2a23afSMatthew G. Knepley Level: advanced 98629a2a23afSMatthew G. Knepley 98639a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec() 98649a2a23afSMatthew G. Knepley @*/ 98659a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux) 98669a2a23afSMatthew G. Knepley { 98679a2a23afSMatthew G. Knepley Vec old; 98689a2a23afSMatthew G. Knepley PetscHashAuxKey key; 98699a2a23afSMatthew G. Knepley PetscErrorCode ierr; 98709a2a23afSMatthew G. Knepley 98719a2a23afSMatthew G. Knepley PetscFunctionBegin; 98729a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 98739a2a23afSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 98749a2a23afSMatthew G. Knepley key.label = label; 98759a2a23afSMatthew G. Knepley key.value = value; 98769a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr); 98779a2a23afSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr); 98789a2a23afSMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr); 98799a2a23afSMatthew G. Knepley if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);} 98809a2a23afSMatthew G. Knepley else {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);} 98819a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 98829a2a23afSMatthew G. Knepley } 98839a2a23afSMatthew G. Knepley 98849a2a23afSMatthew G. Knepley /*@C 98859a2a23afSMatthew G. Knepley DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM 98869a2a23afSMatthew G. Knepley 98879a2a23afSMatthew G. Knepley Not collective 98889a2a23afSMatthew G. Knepley 98899a2a23afSMatthew G. Knepley Input Parameter: 98909a2a23afSMatthew G. Knepley . dm - The DM 98919a2a23afSMatthew G. Knepley 98929a2a23afSMatthew G. Knepley Output Parameters: 98939a2a23afSMatthew G. Knepley + labels - The DMLabels for each Vec 98949a2a23afSMatthew G. Knepley - values - The label values for each Vec 98959a2a23afSMatthew G. Knepley 98969a2a23afSMatthew G. Knepley Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec(). 98979a2a23afSMatthew G. Knepley 98989a2a23afSMatthew G. Knepley Level: advanced 98999a2a23afSMatthew G. Knepley 99009a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 99019a2a23afSMatthew G. Knepley @*/ 99029a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[]) 99039a2a23afSMatthew G. Knepley { 99049a2a23afSMatthew G. Knepley PetscHashAuxKey *keys; 99059a2a23afSMatthew G. Knepley PetscInt n, i, off = 0; 99069a2a23afSMatthew G. Knepley PetscErrorCode ierr; 99079a2a23afSMatthew G. Knepley 99089a2a23afSMatthew G. Knepley PetscFunctionBegin; 99099a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 99109a2a23afSMatthew G. Knepley PetscValidPointer(labels, 2); 99119a2a23afSMatthew G. Knepley PetscValidPointer(values, 3); 99129a2a23afSMatthew G. Knepley ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr); 99139a2a23afSMatthew G. Knepley ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr); 99149a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr); 99159a2a23afSMatthew G. Knepley for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;} 99169a2a23afSMatthew G. Knepley ierr = PetscFree(keys);CHKERRQ(ierr); 99179a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 99189a2a23afSMatthew G. Knepley } 99199a2a23afSMatthew G. Knepley 99209a2a23afSMatthew G. Knepley /*@ 99219a2a23afSMatthew G. Knepley DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM 99229a2a23afSMatthew G. Knepley 99239a2a23afSMatthew G. Knepley Not collective 99249a2a23afSMatthew G. Knepley 99259a2a23afSMatthew G. Knepley Input Parameter: 99269a2a23afSMatthew G. Knepley . dm - The DM 99279a2a23afSMatthew G. Knepley 99289a2a23afSMatthew G. Knepley Output Parameter: 99299a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data 99309a2a23afSMatthew G. Knepley 99319a2a23afSMatthew G. Knepley Level: advanced 99329a2a23afSMatthew G. Knepley 99339a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 99349a2a23afSMatthew G. Knepley @*/ 99359a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew) 99369a2a23afSMatthew G. Knepley { 99379a2a23afSMatthew G. Knepley PetscErrorCode ierr; 99389a2a23afSMatthew G. Knepley 99399a2a23afSMatthew G. Knepley PetscFunctionBegin; 99409a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 99419a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr); 99429a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr); 99439a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 99449a2a23afSMatthew G. Knepley } 9945b5a892a1SMatthew G. Knepley 9946b5a892a1SMatthew G. Knepley /*@C 9947b5a892a1SMatthew G. Knepley DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement 9948b5a892a1SMatthew G. Knepley 9949b5a892a1SMatthew G. Knepley Not collective 9950b5a892a1SMatthew G. Knepley 9951b5a892a1SMatthew G. Knepley Input Parameters: 9952b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 9953b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces 9954b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces 9955b5a892a1SMatthew G. Knepley 9956b5a892a1SMatthew G. Knepley Output Parameters: 9957b5a892a1SMatthew G. Knepley + ornt - The orientation which will take the source arrangement to the target arrangement 9958b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found 9959b5a892a1SMatthew G. Knepley 9960b5a892a1SMatthew G. Knepley Level: advanced 9961b5a892a1SMatthew G. Knepley 9962b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation() 9963b5a892a1SMatthew G. Knepley @*/ 9964b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found) 9965b5a892a1SMatthew G. Knepley { 9966b5a892a1SMatthew G. Knepley const PetscInt cS = DMPolytopeTypeGetConeSize(ct); 9967b5a892a1SMatthew G. Knepley const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2; 9968b5a892a1SMatthew G. Knepley PetscInt o, c; 9969b5a892a1SMatthew G. Knepley 9970b5a892a1SMatthew G. Knepley PetscFunctionBegin; 9971b5a892a1SMatthew G. Knepley if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);} 9972b5a892a1SMatthew G. Knepley for (o = -nO; o < nO; ++o) { 9973b5a892a1SMatthew G. Knepley const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o); 9974b5a892a1SMatthew G. Knepley 9975b5a892a1SMatthew G. Knepley for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break; 9976b5a892a1SMatthew G. Knepley if (c == cS) {*ornt = o; break;} 9977b5a892a1SMatthew G. Knepley } 9978b5a892a1SMatthew G. Knepley *found = o == nO ? PETSC_FALSE : PETSC_TRUE; 9979b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 9980b5a892a1SMatthew G. Knepley } 9981b5a892a1SMatthew G. Knepley 9982b5a892a1SMatthew G. Knepley /*@C 9983b5a892a1SMatthew G. Knepley DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement 9984b5a892a1SMatthew G. Knepley 9985b5a892a1SMatthew G. Knepley Not collective 9986b5a892a1SMatthew G. Knepley 9987b5a892a1SMatthew G. Knepley Input Parameters: 9988b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 9989b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces 9990b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces 9991b5a892a1SMatthew G. Knepley 9992b5a892a1SMatthew G. Knepley Output Parameters: 9993b5a892a1SMatthew G. Knepley . ornt - The orientation which will take the source arrangement to the target arrangement 9994b5a892a1SMatthew G. Knepley 9995b5a892a1SMatthew G. Knepley Note: This function will fail if no suitable orientation can be found. 9996b5a892a1SMatthew G. Knepley 9997b5a892a1SMatthew G. Knepley Level: advanced 9998b5a892a1SMatthew G. Knepley 9999b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation() 10000b5a892a1SMatthew G. Knepley @*/ 10001b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt) 10002b5a892a1SMatthew G. Knepley { 10003b5a892a1SMatthew G. Knepley PetscBool found; 10004b5a892a1SMatthew G. Knepley PetscErrorCode ierr; 10005b5a892a1SMatthew G. Knepley 10006b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10007b5a892a1SMatthew G. Knepley ierr = DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr); 10008b5a892a1SMatthew G. Knepley if (!found) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]); 10009b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10010b5a892a1SMatthew G. Knepley } 10011b5a892a1SMatthew G. Knepley 10012b5a892a1SMatthew G. Knepley /*@C 10013b5a892a1SMatthew G. Knepley DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement 10014b5a892a1SMatthew G. Knepley 10015b5a892a1SMatthew G. Knepley Not collective 10016b5a892a1SMatthew G. Knepley 10017b5a892a1SMatthew G. Knepley Input Parameters: 10018b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10019b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices 10020b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices 10021b5a892a1SMatthew G. Knepley 10022b5a892a1SMatthew G. Knepley Output Parameters: 10023b5a892a1SMatthew G. Knepley + ornt - The orientation which will take the source arrangement to the target arrangement 10024b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found 10025b5a892a1SMatthew G. Knepley 10026b5a892a1SMatthew G. Knepley Level: advanced 10027b5a892a1SMatthew G. Knepley 10028b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation() 10029b5a892a1SMatthew G. Knepley @*/ 10030b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found) 10031b5a892a1SMatthew G. Knepley { 10032b5a892a1SMatthew G. Knepley const PetscInt cS = DMPolytopeTypeGetNumVertices(ct); 10033b5a892a1SMatthew G. Knepley const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2; 10034b5a892a1SMatthew G. Knepley PetscInt o, c; 10035b5a892a1SMatthew G. Knepley 10036b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10037b5a892a1SMatthew G. Knepley if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);} 10038b5a892a1SMatthew G. Knepley for (o = -nO; o < nO; ++o) { 10039b5a892a1SMatthew G. Knepley const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o); 10040b5a892a1SMatthew G. Knepley 10041b5a892a1SMatthew G. Knepley for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break; 10042b5a892a1SMatthew G. Knepley if (c == cS) {*ornt = o; break;} 10043b5a892a1SMatthew G. Knepley } 10044b5a892a1SMatthew G. Knepley *found = o == nO ? PETSC_FALSE : PETSC_TRUE; 10045b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10046b5a892a1SMatthew G. Knepley } 10047b5a892a1SMatthew G. Knepley 10048b5a892a1SMatthew G. Knepley /*@C 10049b5a892a1SMatthew G. Knepley DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement 10050b5a892a1SMatthew G. Knepley 10051b5a892a1SMatthew G. Knepley Not collective 10052b5a892a1SMatthew G. Knepley 10053b5a892a1SMatthew G. Knepley Input Parameters: 10054b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10055b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices 10056b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices 10057b5a892a1SMatthew G. Knepley 10058b5a892a1SMatthew G. Knepley Output Parameters: 10059b5a892a1SMatthew G. Knepley . ornt - The orientation which will take the source arrangement to the target arrangement 10060b5a892a1SMatthew G. Knepley 10061b5a892a1SMatthew G. Knepley Note: This function will fail if no suitable orientation can be found. 10062b5a892a1SMatthew G. Knepley 10063b5a892a1SMatthew G. Knepley Level: advanced 10064b5a892a1SMatthew G. Knepley 10065b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation() 10066b5a892a1SMatthew G. Knepley @*/ 10067b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt) 10068b5a892a1SMatthew G. Knepley { 10069b5a892a1SMatthew G. Knepley PetscBool found; 10070b5a892a1SMatthew G. Knepley PetscErrorCode ierr; 10071b5a892a1SMatthew G. Knepley 10072b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10073b5a892a1SMatthew G. Knepley ierr = DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr); 10074b5a892a1SMatthew G. Knepley if (!found) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]); 10075b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10076b5a892a1SMatthew G. Knepley } 10077012bc364SMatthew G. Knepley 10078012bc364SMatthew G. Knepley /*@C 10079012bc364SMatthew G. Knepley DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type 10080012bc364SMatthew G. Knepley 10081012bc364SMatthew G. Knepley Not collective 10082012bc364SMatthew G. Knepley 10083012bc364SMatthew G. Knepley Input Parameters: 10084012bc364SMatthew G. Knepley + ct - The DMPolytopeType 10085012bc364SMatthew G. Knepley - point - Coordinates of the point 10086012bc364SMatthew G. Knepley 10087012bc364SMatthew G. Knepley Output Parameters: 10088012bc364SMatthew G. Knepley . inside - Flag indicating whether the point is inside the reference cell of given type 10089012bc364SMatthew G. Knepley 10090012bc364SMatthew G. Knepley Level: advanced 10091012bc364SMatthew G. Knepley 10092012bc364SMatthew G. Knepley .seealso: DMLocatePoints() 10093012bc364SMatthew G. Knepley @*/ 10094012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside) 10095012bc364SMatthew G. Knepley { 10096012bc364SMatthew G. Knepley PetscReal sum = 0.0; 10097012bc364SMatthew G. Knepley PetscInt d; 10098012bc364SMatthew G. Knepley 10099012bc364SMatthew G. Knepley PetscFunctionBegin; 10100012bc364SMatthew G. Knepley *inside = PETSC_TRUE; 10101012bc364SMatthew G. Knepley switch (ct) { 10102012bc364SMatthew G. Knepley case DM_POLYTOPE_TRIANGLE: 10103012bc364SMatthew G. Knepley case DM_POLYTOPE_TETRAHEDRON: 10104012bc364SMatthew G. Knepley for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) { 10105012bc364SMatthew G. Knepley if (point[d] < -1.0) {*inside = PETSC_FALSE; break;} 10106012bc364SMatthew G. Knepley sum += point[d]; 10107012bc364SMatthew G. Knepley } 10108012bc364SMatthew G. Knepley if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;} 10109012bc364SMatthew G. Knepley break; 10110012bc364SMatthew G. Knepley case DM_POLYTOPE_QUADRILATERAL: 10111012bc364SMatthew G. Knepley case DM_POLYTOPE_HEXAHEDRON: 10112012bc364SMatthew G. Knepley for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) 10113012bc364SMatthew G. Knepley if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;} 10114012bc364SMatthew G. Knepley break; 10115012bc364SMatthew G. Knepley default: 10116012bc364SMatthew G. Knepley SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]); 10117012bc364SMatthew G. Knepley } 10118012bc364SMatthew G. Knepley PetscFunctionReturn(0); 10119012bc364SMatthew G. Knepley } 10120