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; 6372c71b3e2SJacob Faibussowitsch PetscCheckFalse(nlink->status != DMVEC_STATUS_IN,((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; 6462c71b3e2SJacob Faibussowitsch PetscCheckFalse(nlink->status != DMVEC_STATUS_IN,((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; 6962c71b3e2SJacob Faibussowitsch PetscCheckFalse((*dm)->workout,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 785a2c9b50fSJeremy L Thompson ierr = CeedElemRestrictionDestroy(&(*dm)->ceedERestrict);CHKERRQ_CEED(ierr); 786a2c9b50fSJeremy L Thompson ierr = CeedDestroy(&(*dm)->ceed);CHKERRQ_CEED(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); 10262c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createglobalvector,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); 10322c71b3e2SJacob Faibussowitsch PetscCheckFalse(!vdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector",((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); 10602c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createlocalvector,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); 10662c71b3e2SJacob Faibussowitsch PetscCheckFalse(!vdm,PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector",((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) { 1112e6befd46SJed Brown PetscInt bdof, cdof, dof, off, c, cind; 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 } 1125e6befd46SJed Brown for (c = 0, cind = 0; c < dof; ++c, ++l) { 1126e6befd46SJed Brown if ((cind < cdof) && (c == cdofs[cind])) { 1127e6befd46SJed Brown ltog[l] = off < 0 ? off-c : -(off+c+1); 1128e6befd46SJed Brown cind++; 1129e6befd46SJed Brown } else { 1130e6befd46SJed Brown ltog[l] = (off < 0 ? -(off+1) : off) + c; 1131e6befd46SJed Brown } 113237d0c07bSMatthew G Knepley } 113337d0c07bSMatthew G Knepley } 1134bff27382SMatthew G. Knepley /* Must have same blocksize on all procs (some might have no points) */ 11350be3e97aSMatthew G. Knepley bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs; 11360be3e97aSMatthew G. Knepley ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr); 11370be3e97aSMatthew G. Knepley if (bsMinMax[0] != bsMinMax[1]) {bs = 1;} 11380be3e97aSMatthew G. Knepley else {bs = bsMinMax[0];} 11397591dbb2SMatthew G. Knepley bs = bs < 0 ? 1 : bs; 11407591dbb2SMatthew G. Knepley /* Must reduce indices by blocksize */ 1141ccf3bd66SMatthew G. Knepley if (bs > 1) { 1142ca469d19SJed Brown for (l = 0, k = 0; l < n; l += bs, ++k) { 1143ca469d19SJed Brown // Integer division of negative values truncates toward zero(!), not toward negative infinity 1144ca469d19SJed Brown ltog[k] = ltog[l] >= 0 ? ltog[l]/bs : -(-(ltog[l]+1)/bs + 1); 1145ca469d19SJed Brown } 1146ccf3bd66SMatthew G. Knepley n /= bs; 1147ccf3bd66SMatthew G. Knepley } 1148ccf3bd66SMatthew G. Knepley ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr); 11493bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr); 115037d0c07bSMatthew G Knepley } else { 11512c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->getlocaltoglobalmapping,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name); 1152184d77edSJed Brown ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr); 11531411c6eeSJed Brown } 115437d0c07bSMatthew G Knepley } 11551411c6eeSJed Brown *ltog = dm->ltogmap; 11561411c6eeSJed Brown PetscFunctionReturn(0); 11571411c6eeSJed Brown } 11581411c6eeSJed Brown 11591411c6eeSJed Brown /*@ 11601411c6eeSJed Brown DMGetBlockSize - Gets the inherent block size associated with a DM 11611411c6eeSJed Brown 11621411c6eeSJed Brown Not Collective 11631411c6eeSJed Brown 11641411c6eeSJed Brown Input Parameter: 11651411c6eeSJed Brown . dm - the DM with block structure 11661411c6eeSJed Brown 11671411c6eeSJed Brown Output Parameter: 11681411c6eeSJed Brown . bs - the block size, 1 implies no exploitable block structure 11691411c6eeSJed Brown 11701411c6eeSJed Brown Level: intermediate 11711411c6eeSJed Brown 1172fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping() 11731411c6eeSJed Brown @*/ 11747087cfbeSBarry Smith PetscErrorCode DMGetBlockSize(DM dm,PetscInt *bs) 11751411c6eeSJed Brown { 11761411c6eeSJed Brown PetscFunctionBegin; 11771411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1178534a8f05SLisandro Dalcin PetscValidIntPointer(bs,2); 11792c71b3e2SJacob Faibussowitsch PetscCheckFalse(dm->bs < 1,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet"); 11801411c6eeSJed Brown *bs = dm->bs; 11811411c6eeSJed Brown PetscFunctionReturn(0); 11821411c6eeSJed Brown } 11831411c6eeSJed Brown 118448eeb7c8SBarry Smith /*@C 11858472ad0fSDave May DMCreateInterpolation - Gets interpolation matrix between two DM objects 118647c6ae99SBarry Smith 1187a5bc1bf3SBarry Smith Collective on dmc 118847c6ae99SBarry Smith 1189d8d19677SJose E. Roman Input Parameters: 1190a5bc1bf3SBarry Smith + dmc - the DM object 1191a5bc1bf3SBarry Smith - dmf - the second, finer DM object 119247c6ae99SBarry Smith 1193d8d19677SJose E. Roman Output Parameters: 119447c6ae99SBarry Smith + mat - the interpolation 119547c6ae99SBarry Smith - vec - the scaling (optional) 119647c6ae99SBarry Smith 119747c6ae99SBarry Smith Level: developer 119847c6ae99SBarry Smith 119995452b02SPatrick Sanan Notes: 120095452b02SPatrick 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 120185afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 1202d52bd9f3SBarry Smith 12031f588964SMatthew G Knepley For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors 1204d52bd9f3SBarry Smith EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic. 120585afcc9aSBarry Smith 12062ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale() 120747c6ae99SBarry Smith 120847c6ae99SBarry Smith @*/ 1209a5bc1bf3SBarry Smith PetscErrorCode DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec) 121047c6ae99SBarry Smith { 121147c6ae99SBarry Smith PetscErrorCode ierr; 121247c6ae99SBarry Smith 121347c6ae99SBarry Smith PetscFunctionBegin; 1214a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 1215a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 1216c7d20fa0SStefano Zampini PetscValidPointer(mat,3); 12172c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dmc->ops->createinterpolation,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name); 1218a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr); 1219a5bc1bf3SBarry Smith ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr); 1220a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr); 122147c6ae99SBarry Smith PetscFunctionReturn(0); 122247c6ae99SBarry Smith } 122347c6ae99SBarry Smith 12243ad4599aSBarry Smith /*@ 1225d3e313eaSPatrick Sanan DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction. 12262ed6491fSPatrick Sanan 12272ed6491fSPatrick Sanan Input Parameters: 12282ed6491fSPatrick Sanan + dac - DM that defines a coarse mesh 12292ed6491fSPatrick Sanan . daf - DM that defines a fine mesh 12302ed6491fSPatrick Sanan - mat - the restriction (or interpolation operator) from fine to coarse 12312ed6491fSPatrick Sanan 12322ed6491fSPatrick Sanan Output Parameter: 12332ed6491fSPatrick Sanan . scale - the scaled vector 12342ed6491fSPatrick Sanan 12352ed6491fSPatrick Sanan Level: developer 12362ed6491fSPatrick Sanan 1237e9c74fd6SRichard Tran Mills Developer Notes: 1238e9c74fd6SRichard Tran Mills If the fine-scale DMDA has the -dm_bind_below option set to true, then DMCreateInterpolationScale() calls MatSetBindingPropagates() 1239e9c74fd6SRichard Tran Mills on the restriction/interpolation operator to set the bindingpropagates flag to true. 1240e9c74fd6SRichard Tran Mills 12412ed6491fSPatrick Sanan .seealso: DMCreateInterpolation() 12422ed6491fSPatrick Sanan 12432ed6491fSPatrick Sanan @*/ 12442ed6491fSPatrick Sanan PetscErrorCode DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale) 12452ed6491fSPatrick Sanan { 12462ed6491fSPatrick Sanan PetscErrorCode ierr; 12472ed6491fSPatrick Sanan Vec fine; 12482ed6491fSPatrick Sanan PetscScalar one = 1.0; 12499704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA) 1250e9c74fd6SRichard Tran Mills PetscBool bindingpropagates,isbound; 12519704db99SRichard Tran Mills #endif 12522ed6491fSPatrick Sanan 12532ed6491fSPatrick Sanan PetscFunctionBegin; 12542ed6491fSPatrick Sanan ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr); 12552ed6491fSPatrick Sanan ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr); 12562ed6491fSPatrick Sanan ierr = VecSet(fine,one);CHKERRQ(ierr); 12579704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA) 12589704db99SRichard Tran Mills /* If the 'fine' Vec is bound to the CPU, it makes sense to bind 'mat' as well. 12599704db99SRichard Tran Mills * Note that we only do this for the CUDA case, right now, but if we add support for MatMultTranspose() via ViennaCL, 12609704db99SRichard Tran Mills * we'll need to do it for that case, too.*/ 1261e9c74fd6SRichard Tran Mills ierr = VecGetBindingPropagates(fine,&bindingpropagates);CHKERRQ(ierr); 1262e9c74fd6SRichard Tran Mills if (bindingpropagates) { 1263b1538989SRichard Tran Mills ierr = MatSetBindingPropagates(mat,PETSC_TRUE);CHKERRQ(ierr); 1264e9c74fd6SRichard Tran Mills ierr = VecBoundToCPU(fine,&isbound);CHKERRQ(ierr); 1265e9c74fd6SRichard Tran Mills ierr = MatBindToCPU(mat,isbound);CHKERRQ(ierr); 126683aa49f4SRichard Tran Mills } 12679704db99SRichard Tran Mills #endif 12682ed6491fSPatrick Sanan ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr); 12692ed6491fSPatrick Sanan ierr = VecDestroy(&fine);CHKERRQ(ierr); 12702ed6491fSPatrick Sanan ierr = VecReciprocal(*scale);CHKERRQ(ierr); 12712ed6491fSPatrick Sanan PetscFunctionReturn(0); 12722ed6491fSPatrick Sanan } 12732ed6491fSPatrick Sanan 12742ed6491fSPatrick Sanan /*@ 12753ad4599aSBarry Smith DMCreateRestriction - Gets restriction matrix between two DM objects 12763ad4599aSBarry Smith 1277a5bc1bf3SBarry Smith Collective on dmc 12783ad4599aSBarry Smith 1279d8d19677SJose E. Roman Input Parameters: 1280a5bc1bf3SBarry Smith + dmc - the DM object 1281a5bc1bf3SBarry Smith - dmf - the second, finer DM object 12823ad4599aSBarry Smith 12833ad4599aSBarry Smith Output Parameter: 12843ad4599aSBarry Smith . mat - the restriction 12853ad4599aSBarry Smith 12863ad4599aSBarry Smith Level: developer 12873ad4599aSBarry Smith 128895452b02SPatrick Sanan Notes: 128995452b02SPatrick 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 12903ad4599aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 12913ad4599aSBarry Smith 12923ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation() 12933ad4599aSBarry Smith 12943ad4599aSBarry Smith @*/ 1295a5bc1bf3SBarry Smith PetscErrorCode DMCreateRestriction(DM dmc,DM dmf,Mat *mat) 12963ad4599aSBarry Smith { 12973ad4599aSBarry Smith PetscErrorCode ierr; 12983ad4599aSBarry Smith 12993ad4599aSBarry Smith PetscFunctionBegin; 1300a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 1301a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 13025a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 13032c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dmc->ops->createrestriction,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name); 1304a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr); 1305a5bc1bf3SBarry Smith ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr); 1306a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr); 13073ad4599aSBarry Smith PetscFunctionReturn(0); 13083ad4599aSBarry Smith } 13093ad4599aSBarry Smith 131047c6ae99SBarry Smith /*@ 13118472ad0fSDave May DMCreateInjection - Gets injection matrix between two DM objects 131247c6ae99SBarry Smith 1313a5bc1bf3SBarry Smith Collective on dac 131447c6ae99SBarry Smith 1315d8d19677SJose E. Roman Input Parameters: 1316a5bc1bf3SBarry Smith + dac - the DM object 1317a5bc1bf3SBarry Smith - daf - the second, finer DM object 131847c6ae99SBarry Smith 131947c6ae99SBarry Smith Output Parameter: 13206dbf9973SLawrence Mitchell . mat - the injection 132147c6ae99SBarry Smith 132247c6ae99SBarry Smith Level: developer 132347c6ae99SBarry Smith 132495452b02SPatrick Sanan Notes: 132595452b02SPatrick 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 132685afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection. 132785afcc9aSBarry Smith 1328e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation() 132947c6ae99SBarry Smith 133047c6ae99SBarry Smith @*/ 1331a5bc1bf3SBarry Smith PetscErrorCode DMCreateInjection(DM dac,DM daf,Mat *mat) 133247c6ae99SBarry Smith { 133347c6ae99SBarry Smith PetscErrorCode ierr; 133447c6ae99SBarry Smith 133547c6ae99SBarry Smith PetscFunctionBegin; 1336a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dac,DM_CLASSID,1); 1337a5bc1bf3SBarry Smith PetscValidHeaderSpecific(daf,DM_CLASSID,2); 13385a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 13392c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dac->ops->createinjection,PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name); 1340a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr); 1341a5bc1bf3SBarry Smith ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr); 1342a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr); 134347c6ae99SBarry Smith PetscFunctionReturn(0); 134447c6ae99SBarry Smith } 134547c6ae99SBarry Smith 1346b412c318SBarry Smith /*@ 1347bd041c0cSMatthew G. Knepley DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j 1348bd041c0cSMatthew G. Knepley 1349a5bc1bf3SBarry Smith Collective on dac 1350bd041c0cSMatthew G. Knepley 1351d8d19677SJose E. Roman Input Parameters: 1352b4937a87SMatthew G. Knepley + dmc - the target DM object 1353b4937a87SMatthew G. Knepley - dmf - the source DM object 1354bd041c0cSMatthew G. Knepley 1355bd041c0cSMatthew G. Knepley Output Parameter: 1356b4937a87SMatthew G. Knepley . mat - the mass matrix 1357bd041c0cSMatthew G. Knepley 1358bd041c0cSMatthew G. Knepley Level: developer 1359bd041c0cSMatthew G. Knepley 1360b4937a87SMatthew G. Knepley .seealso DMCreateMassMatrixLumped(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection() 1361bd041c0cSMatthew G. Knepley @*/ 1362b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrix(DM dmc, DM dmf, Mat *mat) 1363bd041c0cSMatthew G. Knepley { 1364bd041c0cSMatthew G. Knepley PetscErrorCode ierr; 1365bd041c0cSMatthew G. Knepley 1366bd041c0cSMatthew G. Knepley PetscFunctionBegin; 1367b4937a87SMatthew G. Knepley PetscValidHeaderSpecific(dmc, DM_CLASSID, 1); 1368b4937a87SMatthew G. Knepley PetscValidHeaderSpecific(dmf, DM_CLASSID, 2); 13695a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 13702c71b3e2SJacob Faibussowitsch PetscCheck(dmc->ops->createmassmatrix,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dmc)->type_name); 1371b4937a87SMatthew G. Knepley ierr = (*dmc->ops->createmassmatrix)(dmc, dmf, mat);CHKERRQ(ierr); 1372b4937a87SMatthew G. Knepley PetscFunctionReturn(0); 1373b4937a87SMatthew G. Knepley } 1374b4937a87SMatthew G. Knepley 1375b4937a87SMatthew G. Knepley /*@ 1376b4937a87SMatthew G. Knepley DMCreateMassMatrixLumped - Gets the lumped mass matrix for a given DM 1377b4937a87SMatthew G. Knepley 1378b4937a87SMatthew G. Knepley Collective on dm 1379b4937a87SMatthew G. Knepley 1380b4937a87SMatthew G. Knepley Input Parameter: 1381b4937a87SMatthew G. Knepley . dm - the DM object 1382b4937a87SMatthew G. Knepley 1383b4937a87SMatthew G. Knepley Output Parameter: 1384b4937a87SMatthew G. Knepley . lm - the lumped mass matrix 1385b4937a87SMatthew G. Knepley 1386b4937a87SMatthew G. Knepley Level: developer 1387b4937a87SMatthew G. Knepley 1388b4937a87SMatthew G. Knepley .seealso DMCreateMassMatrix(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection() 1389b4937a87SMatthew G. Knepley @*/ 1390b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrixLumped(DM dm, Vec *lm) 1391b4937a87SMatthew G. Knepley { 1392b4937a87SMatthew G. Knepley PetscErrorCode ierr; 1393b4937a87SMatthew G. Knepley 1394b4937a87SMatthew G. Knepley PetscFunctionBegin; 1395b4937a87SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1396b4937a87SMatthew G. Knepley PetscValidPointer(lm,2); 13972c71b3e2SJacob Faibussowitsch PetscCheck(dm->ops->createmassmatrixlumped,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrixLumped",((PetscObject)dm)->type_name); 1398b4937a87SMatthew G. Knepley ierr = (*dm->ops->createmassmatrixlumped)(dm, lm);CHKERRQ(ierr); 1399bd041c0cSMatthew G. Knepley PetscFunctionReturn(0); 1400bd041c0cSMatthew G. Knepley } 1401bd041c0cSMatthew G. Knepley 1402bd041c0cSMatthew G. Knepley /*@ 1403b412c318SBarry Smith DMCreateColoring - Gets coloring for a DM 140447c6ae99SBarry Smith 1405d083f849SBarry Smith Collective on dm 140647c6ae99SBarry Smith 1407d8d19677SJose E. Roman Input Parameters: 140847c6ae99SBarry Smith + dm - the DM object 14095bdb020cSBarry Smith - ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL 141047c6ae99SBarry Smith 141147c6ae99SBarry Smith Output Parameter: 141247c6ae99SBarry Smith . coloring - the coloring 141347c6ae99SBarry Smith 1414ec5066bdSBarry Smith Notes: 1415ec5066bdSBarry 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 1416ec5066bdSBarry Smith matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors). 1417ec5066bdSBarry Smith 1418ec5066bdSBarry Smith This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate() 1419ec5066bdSBarry Smith 142047c6ae99SBarry Smith Level: developer 142147c6ae99SBarry Smith 1422ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate() 142347c6ae99SBarry Smith 1424aab9d709SJed Brown @*/ 1425b412c318SBarry Smith PetscErrorCode DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring) 142647c6ae99SBarry Smith { 142747c6ae99SBarry Smith PetscErrorCode ierr; 142847c6ae99SBarry Smith 142947c6ae99SBarry Smith PetscFunctionBegin; 1430171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 14315a84ad33SLisandro Dalcin PetscValidPointer(coloring,3); 14322c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->getcoloring,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name); 1433b412c318SBarry Smith ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr); 143447c6ae99SBarry Smith PetscFunctionReturn(0); 143547c6ae99SBarry Smith } 143647c6ae99SBarry Smith 1437b412c318SBarry Smith /*@ 14388472ad0fSDave May DMCreateMatrix - Gets empty Jacobian for a DM 143947c6ae99SBarry Smith 1440d083f849SBarry Smith Collective on dm 144147c6ae99SBarry Smith 144247c6ae99SBarry Smith Input Parameter: 1443b412c318SBarry Smith . dm - the DM object 144447c6ae99SBarry Smith 144547c6ae99SBarry Smith Output Parameter: 144647c6ae99SBarry Smith . mat - the empty Jacobian 144747c6ae99SBarry Smith 1448073dac72SJed Brown Level: beginner 144947c6ae99SBarry Smith 1450f27dd7c6SMatthew G. Knepley Options Database Keys: 1451f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 1452f27dd7c6SMatthew G. Knepley 145395452b02SPatrick Sanan Notes: 145495452b02SPatrick Sanan This properly preallocates the number of nonzeros in the sparse matrix so you 145594013140SBarry Smith do not need to do it yourself. 145694013140SBarry Smith 145794013140SBarry Smith By default it also sets the nonzero structure and puts in the zero entries. To prevent setting 14587889ec69SBarry Smith the nonzero pattern call DMSetMatrixPreallocateOnly() 145994013140SBarry Smith 146094013140SBarry 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 146194013140SBarry Smith internally by PETSc. 146294013140SBarry Smith 146394013140SBarry Smith For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires 1464aa219208SBarry Smith the indices for the global numbering for DMDAs which is complicated. 146594013140SBarry Smith 1466b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType() 146747c6ae99SBarry Smith 1468aab9d709SJed Brown @*/ 1469b412c318SBarry Smith PetscErrorCode DMCreateMatrix(DM dm,Mat *mat) 147047c6ae99SBarry Smith { 147147c6ae99SBarry Smith PetscErrorCode ierr; 147247c6ae99SBarry Smith 147347c6ae99SBarry Smith PetscFunctionBegin; 1474171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1475064a246eSJacob Faibussowitsch PetscValidPointer(mat,2); 14762c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->creatematrix,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name); 14775a84ad33SLisandro Dalcin ierr = MatInitializePackage();CHKERRQ(ierr); 1478fdc842d1SBarry Smith ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 1479b412c318SBarry Smith ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr); 148076bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1481c6b011d8SStefano Zampini DM mdm; 1482c6b011d8SStefano Zampini 1483c6b011d8SStefano Zampini ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr); 14842c71b3e2SJacob Faibussowitsch PetscCheckFalse(!mdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix",((PetscObject)dm)->type_name); 1485c6b011d8SStefano Zampini } 1486e571a35bSMatthew G. Knepley /* Handle nullspace and near nullspace */ 1487e5e52638SMatthew G. Knepley if (dm->Nf) { 1488e571a35bSMatthew G. Knepley MatNullSpace nullSpace; 1489649ef022SMatthew Knepley PetscInt Nf, f; 1490e571a35bSMatthew G. Knepley 1491e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 1492649ef022SMatthew Knepley for (f = 0; f < Nf; ++f) { 1493649ef022SMatthew Knepley if (dm->nullspaceConstructors[f]) { 1494649ef022SMatthew Knepley ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr); 1495e571a35bSMatthew G. Knepley ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1496e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1497649ef022SMatthew Knepley break; 1498e571a35bSMatthew G. Knepley } 1499649ef022SMatthew Knepley } 1500649ef022SMatthew Knepley for (f = 0; f < Nf; ++f) { 1501649ef022SMatthew Knepley if (dm->nearnullspaceConstructors[f]) { 1502649ef022SMatthew Knepley ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr); 1503e571a35bSMatthew G. Knepley ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1504e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1505e571a35bSMatthew G. Knepley } 1506e571a35bSMatthew G. Knepley } 1507e571a35bSMatthew G. Knepley } 1508fdc842d1SBarry Smith ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 150947c6ae99SBarry Smith PetscFunctionReturn(0); 151047c6ae99SBarry Smith } 151147c6ae99SBarry Smith 1512732e2eb9SMatthew G Knepley /*@ 1513950540a4SJed Brown DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly 1514732e2eb9SMatthew G Knepley preallocated but the nonzero structure and zero values will not be set. 1515732e2eb9SMatthew G Knepley 1516d083f849SBarry Smith Logically Collective on dm 1517732e2eb9SMatthew G Knepley 1518d8d19677SJose E. Roman Input Parameters: 1519732e2eb9SMatthew G Knepley + dm - the DM 1520732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation 1521732e2eb9SMatthew G Knepley 1522732e2eb9SMatthew G Knepley Level: developer 1523f27dd7c6SMatthew G. Knepley 1524f27dd7c6SMatthew G. Knepley Options Database Keys: 1525f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 1526f27dd7c6SMatthew G. Knepley 1527b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly() 1528732e2eb9SMatthew G Knepley @*/ 1529732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only) 1530732e2eb9SMatthew G Knepley { 1531732e2eb9SMatthew G Knepley PetscFunctionBegin; 1532732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1533732e2eb9SMatthew G Knepley dm->prealloc_only = only; 1534732e2eb9SMatthew G Knepley PetscFunctionReturn(0); 1535732e2eb9SMatthew G Knepley } 1536732e2eb9SMatthew G Knepley 1537b06ff27eSHong Zhang /*@ 1538b06ff27eSHong Zhang DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created 1539b06ff27eSHong Zhang but the array for values will not be allocated. 1540b06ff27eSHong Zhang 1541d083f849SBarry Smith Logically Collective on dm 1542b06ff27eSHong Zhang 1543d8d19677SJose E. Roman Input Parameters: 1544b06ff27eSHong Zhang + dm - the DM 1545b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture 1546b06ff27eSHong Zhang 1547b06ff27eSHong Zhang Level: developer 1548b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly() 1549b06ff27eSHong Zhang @*/ 1550b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only) 1551b06ff27eSHong Zhang { 1552b06ff27eSHong Zhang PetscFunctionBegin; 1553b06ff27eSHong Zhang PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1554b06ff27eSHong Zhang dm->structure_only = only; 1555b06ff27eSHong Zhang PetscFunctionReturn(0); 1556b06ff27eSHong Zhang } 1557b06ff27eSHong Zhang 1558a89ea682SMatthew G Knepley /*@C 1559aa1993deSMatthew G Knepley DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1560a89ea682SMatthew G Knepley 1561a89ea682SMatthew G Knepley Not Collective 1562a89ea682SMatthew G Knepley 1563a89ea682SMatthew G Knepley Input Parameters: 1564a89ea682SMatthew G Knepley + dm - the DM object 1565a5b23f4aSJose E. Roman . count - The minimum size 156669291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT) 1567a89ea682SMatthew G Knepley 1568a89ea682SMatthew G Knepley Output Parameter: 1569a89ea682SMatthew G Knepley . array - the work array 1570a89ea682SMatthew G Knepley 1571a89ea682SMatthew G Knepley Level: developer 1572a89ea682SMatthew G Knepley 1573a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate() 1574a89ea682SMatthew G Knepley @*/ 157569291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1576a89ea682SMatthew G Knepley { 1577a89ea682SMatthew G Knepley PetscErrorCode ierr; 1578aa1993deSMatthew G Knepley DMWorkLink link; 157969291d52SBarry Smith PetscMPIInt dsize; 1580a89ea682SMatthew G Knepley 1581a89ea682SMatthew G Knepley PetscFunctionBegin; 1582a89ea682SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1583aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1584aa1993deSMatthew G Knepley if (dm->workin) { 1585aa1993deSMatthew G Knepley link = dm->workin; 1586aa1993deSMatthew G Knepley dm->workin = dm->workin->next; 1587aa1993deSMatthew G Knepley } else { 1588b00a9115SJed Brown ierr = PetscNewLog(dm,&link);CHKERRQ(ierr); 1589a89ea682SMatthew G Knepley } 1590ffc4695bSBarry Smith ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr); 15915056fcd2SBarry Smith if (((size_t)dsize*count) > link->bytes) { 1592aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 1593854ce69bSBarry Smith ierr = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr); 1594854ce69bSBarry Smith link->bytes = dsize*count; 1595aa1993deSMatthew G Knepley } 1596aa1993deSMatthew G Knepley link->next = dm->workout; 1597aa1993deSMatthew G Knepley dm->workout = link; 159800d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND) 159900d952a4SJed Brown VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count); 160000d952a4SJed Brown VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count); 160100d952a4SJed Brown #endif 1602aa1993deSMatthew G Knepley *(void**)mem = link->mem; 1603a89ea682SMatthew G Knepley PetscFunctionReturn(0); 1604a89ea682SMatthew G Knepley } 1605a89ea682SMatthew G Knepley 1606aa1993deSMatthew G Knepley /*@C 1607aa1993deSMatthew G Knepley DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1608aa1993deSMatthew G Knepley 1609aa1993deSMatthew G Knepley Not Collective 1610aa1993deSMatthew G Knepley 1611aa1993deSMatthew G Knepley Input Parameters: 1612aa1993deSMatthew G Knepley + dm - the DM object 1613a5b23f4aSJose E. Roman . count - The minimum size 161469291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT 1615aa1993deSMatthew G Knepley 1616aa1993deSMatthew G Knepley Output Parameter: 1617aa1993deSMatthew G Knepley . array - the work array 1618aa1993deSMatthew G Knepley 1619aa1993deSMatthew G Knepley Level: developer 1620aa1993deSMatthew G Knepley 162195452b02SPatrick Sanan Developer Notes: 162295452b02SPatrick Sanan count and dtype are ignored, they are only needed for DMGetWorkArray() 1623aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate() 1624aa1993deSMatthew G Knepley @*/ 162569291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1626aa1993deSMatthew G Knepley { 1627aa1993deSMatthew G Knepley DMWorkLink *p,link; 1628aa1993deSMatthew G Knepley 1629aa1993deSMatthew G Knepley PetscFunctionBegin; 1630aa1993deSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1631aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1632aa1993deSMatthew G Knepley for (p=&dm->workout; (link=*p); p=&link->next) { 1633aa1993deSMatthew G Knepley if (link->mem == *(void**)mem) { 1634aa1993deSMatthew G Knepley *p = link->next; 1635aa1993deSMatthew G Knepley link->next = dm->workin; 1636aa1993deSMatthew G Knepley dm->workin = link; 16370298fd71SBarry Smith *(void**)mem = NULL; 1638aa1993deSMatthew G Knepley PetscFunctionReturn(0); 1639aa1993deSMatthew G Knepley } 1640aa1993deSMatthew G Knepley } 1641aa1993deSMatthew G Knepley SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out"); 1642aa1993deSMatthew G Knepley } 1643e7c4fc90SDmitry Karpeev 16448cda7954SMatthew G. Knepley /*@C 16458cda7954SMatthew G. Knepley DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field 16468cda7954SMatthew G. Knepley 16478cda7954SMatthew G. Knepley Logically collective on DM 16488cda7954SMatthew G. Knepley 16498cda7954SMatthew G. Knepley Input Parameters: 16508cda7954SMatthew G. Knepley + dm - The DM 16518cda7954SMatthew G. Knepley . field - The field number for the nullspace 16528cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace 16538cda7954SMatthew G. Knepley 16548cda7954SMatthew G. Knepley Notes: 16558cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 16568cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 16578cda7954SMatthew G. Knepley $ dm - The present DM 16588cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 16598cda7954SMatthew G. Knepley $ field - The field number in dm 16608cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 16618cda7954SMatthew G. Knepley 16628cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16638cda7954SMatthew G. Knepley 16648cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 16658cda7954SMatthew G. Knepley */ 16668cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1667435a35e8SMatthew G Knepley { 1668435a35e8SMatthew G Knepley PetscFunctionBegin; 1669435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 16702c71b3e2SJacob Faibussowitsch PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1671435a35e8SMatthew G Knepley dm->nullspaceConstructors[field] = nullsp; 1672435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1673435a35e8SMatthew G Knepley } 1674435a35e8SMatthew G Knepley 16758cda7954SMatthew G. Knepley /*@C 16768cda7954SMatthew G. Knepley DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL 16778cda7954SMatthew G. Knepley 16788cda7954SMatthew G. Knepley Not collective 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 16848cda7954SMatthew G. Knepley Output Parameter: 16858cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace 16868cda7954SMatthew G. Knepley 16878cda7954SMatthew G. Knepley Notes: 16888cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 16898cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 16908cda7954SMatthew G. Knepley $ dm - The present DM 16918cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 16928cda7954SMatthew G. Knepley $ field - The field number in dm 16938cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 16948cda7954SMatthew G. Knepley 16958cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16968cda7954SMatthew G. Knepley 16978cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 16988cda7954SMatthew G. Knepley */ 16998cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 17000a50eb56SMatthew G. Knepley { 17010a50eb56SMatthew G. Knepley PetscFunctionBegin; 17020a50eb56SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1703f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 17042c71b3e2SJacob Faibussowitsch PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 17050a50eb56SMatthew G. Knepley *nullsp = dm->nullspaceConstructors[field]; 17060a50eb56SMatthew G. Knepley PetscFunctionReturn(0); 17070a50eb56SMatthew G. Knepley } 17080a50eb56SMatthew G. Knepley 17098cda7954SMatthew G. Knepley /*@C 17108cda7954SMatthew G. Knepley DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field 17118cda7954SMatthew G. Knepley 17128cda7954SMatthew G. Knepley Logically collective on DM 17138cda7954SMatthew G. Knepley 17148cda7954SMatthew G. Knepley Input Parameters: 17158cda7954SMatthew G. Knepley + dm - The DM 17168cda7954SMatthew G. Knepley . field - The field number for the nullspace 17178cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace 17188cda7954SMatthew G. Knepley 17198cda7954SMatthew G. Knepley Notes: 17208cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 17218cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 17228cda7954SMatthew G. Knepley $ dm - The present DM 17238cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 17248cda7954SMatthew G. Knepley $ field - The field number in dm 17258cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 17268cda7954SMatthew G. Knepley 17278cda7954SMatthew G. Knepley This function is currently not available from Fortran. 17288cda7954SMatthew G. Knepley 17298cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 17308cda7954SMatthew G. Knepley */ 17318cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1732f9d4088aSMatthew G. Knepley { 1733f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1734f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 17352c71b3e2SJacob Faibussowitsch PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1736f9d4088aSMatthew G. Knepley dm->nearnullspaceConstructors[field] = nullsp; 1737f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1738f9d4088aSMatthew G. Knepley } 1739f9d4088aSMatthew G. Knepley 17408cda7954SMatthew G. Knepley /*@C 17418cda7954SMatthew G. Knepley DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL 17428cda7954SMatthew G. Knepley 17438cda7954SMatthew G. Knepley Not collective 17448cda7954SMatthew G. Knepley 17458cda7954SMatthew G. Knepley Input Parameters: 17468cda7954SMatthew G. Knepley + dm - The DM 17478cda7954SMatthew G. Knepley - field - The field number for the nullspace 17488cda7954SMatthew G. Knepley 17498cda7954SMatthew G. Knepley Output Parameter: 17508cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace 17518cda7954SMatthew G. Knepley 17528cda7954SMatthew G. Knepley Notes: 17538cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 17548cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 17558cda7954SMatthew G. Knepley $ dm - The present DM 17568cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 17578cda7954SMatthew G. Knepley $ field - The field number in dm 17588cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 17598cda7954SMatthew G. Knepley 17608cda7954SMatthew G. Knepley This function is currently not available from Fortran. 17618cda7954SMatthew G. Knepley 17628cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 17638cda7954SMatthew G. Knepley */ 17648cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1765f9d4088aSMatthew G. Knepley { 1766f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1767f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1768f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 17692c71b3e2SJacob Faibussowitsch PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1770f9d4088aSMatthew G. Knepley *nullsp = dm->nearnullspaceConstructors[field]; 1771f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1772f9d4088aSMatthew G. Knepley } 1773f9d4088aSMatthew G. Knepley 17744f3b5142SJed Brown /*@C 17754d343eeaSMatthew G Knepley DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field 17764d343eeaSMatthew G Knepley 17774d343eeaSMatthew G Knepley Not collective 17784d343eeaSMatthew G Knepley 17794d343eeaSMatthew G Knepley Input Parameter: 17804d343eeaSMatthew G Knepley . dm - the DM object 17814d343eeaSMatthew G Knepley 17824d343eeaSMatthew G Knepley Output Parameters: 17830298fd71SBarry Smith + numFields - The number of fields (or NULL if not requested) 17840298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested) 17850298fd71SBarry Smith - fields - The global indices for each field (or NULL if not requested) 17864d343eeaSMatthew G Knepley 17874d343eeaSMatthew G Knepley Level: intermediate 17884d343eeaSMatthew G Knepley 178921c9b008SJed Brown Notes: 179021c9b008SJed Brown The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 179121c9b008SJed Brown PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with 179221c9b008SJed Brown PetscFree(). 179321c9b008SJed Brown 17944d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 17954d343eeaSMatthew G Knepley @*/ 179637d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields) 17974d343eeaSMatthew G Knepley { 179837d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 17994d343eeaSMatthew G Knepley PetscErrorCode ierr; 18004d343eeaSMatthew G Knepley 18014d343eeaSMatthew G Knepley PetscFunctionBegin; 18024d343eeaSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 180369ca1f37SDmitry Karpeev if (numFields) { 1804534a8f05SLisandro Dalcin PetscValidIntPointer(numFields,2); 180569ca1f37SDmitry Karpeev *numFields = 0; 180669ca1f37SDmitry Karpeev } 180737d0c07bSMatthew G Knepley if (fieldNames) { 180837d0c07bSMatthew G Knepley PetscValidPointer(fieldNames,3); 18090298fd71SBarry Smith *fieldNames = NULL; 181069ca1f37SDmitry Karpeev } 181169ca1f37SDmitry Karpeev if (fields) { 181269ca1f37SDmitry Karpeev PetscValidPointer(fields,4); 18130298fd71SBarry Smith *fields = NULL; 181469ca1f37SDmitry Karpeev } 181592fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 181637d0c07bSMatthew G Knepley if (section) { 18173a544194SStefano Zampini PetscInt *fieldSizes, *fieldNc, **fieldIndices; 181837d0c07bSMatthew G Knepley PetscInt nF, f, pStart, pEnd, p; 181937d0c07bSMatthew G Knepley 1820e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 182137d0c07bSMatthew G Knepley ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr); 18223a544194SStefano Zampini ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr); 182337d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr); 182437d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 182537d0c07bSMatthew G Knepley fieldSizes[f] = 0; 18263a544194SStefano Zampini ierr = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr); 182737d0c07bSMatthew G Knepley } 182837d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 182937d0c07bSMatthew G Knepley PetscInt gdof; 183037d0c07bSMatthew G Knepley 183137d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 183237d0c07bSMatthew G Knepley if (gdof > 0) { 183337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 18343a544194SStefano Zampini PetscInt fdof, fcdof, fpdof; 183537d0c07bSMatthew G Knepley 183637d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 183737d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 18383a544194SStefano Zampini fpdof = fdof-fcdof; 18393a544194SStefano Zampini if (fpdof && fpdof != fieldNc[f]) { 18403a544194SStefano Zampini /* Layout does not admit a pointwise block size */ 18413a544194SStefano Zampini fieldNc[f] = 1; 18423a544194SStefano Zampini } 18433a544194SStefano Zampini fieldSizes[f] += fpdof; 184437d0c07bSMatthew G Knepley } 184537d0c07bSMatthew G Knepley } 184637d0c07bSMatthew G Knepley } 184737d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 1848785e854fSJed Brown ierr = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr); 184937d0c07bSMatthew G Knepley fieldSizes[f] = 0; 185037d0c07bSMatthew G Knepley } 185137d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 185237d0c07bSMatthew G Knepley PetscInt gdof, goff; 185337d0c07bSMatthew G Knepley 185437d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 185537d0c07bSMatthew G Knepley if (gdof > 0) { 185637d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr); 185737d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 185837d0c07bSMatthew G Knepley PetscInt fdof, fcdof, fc; 185937d0c07bSMatthew G Knepley 186037d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 186137d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 186237d0c07bSMatthew G Knepley for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) { 186337d0c07bSMatthew G Knepley fieldIndices[f][fieldSizes[f]] = goff++; 186437d0c07bSMatthew G Knepley } 186537d0c07bSMatthew G Knepley } 186637d0c07bSMatthew G Knepley } 186737d0c07bSMatthew G Knepley } 18688865f1eaSKarl Rupp if (numFields) *numFields = nF; 186937d0c07bSMatthew G Knepley if (fieldNames) { 1870785e854fSJed Brown ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr); 187137d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 187237d0c07bSMatthew G Knepley const char *fieldName; 187337d0c07bSMatthew G Knepley 187437d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 187537d0c07bSMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr); 187637d0c07bSMatthew G Knepley } 187737d0c07bSMatthew G Knepley } 187837d0c07bSMatthew G Knepley if (fields) { 1879785e854fSJed Brown ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr); 188037d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 18813a544194SStefano Zampini PetscInt bs, in[2], out[2]; 18823a544194SStefano Zampini 188382f516ccSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr); 18843a544194SStefano Zampini in[0] = -fieldNc[f]; 18853a544194SStefano Zampini in[1] = fieldNc[f]; 1886820f2d46SBarry Smith ierr = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 18873a544194SStefano Zampini bs = (-out[0] == out[1]) ? out[1] : 1; 18883a544194SStefano Zampini ierr = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr); 188937d0c07bSMatthew G Knepley } 189037d0c07bSMatthew G Knepley } 18913a544194SStefano Zampini ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr); 18928865f1eaSKarl Rupp } else if (dm->ops->createfieldis) { 18938865f1eaSKarl Rupp ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr); 189469ca1f37SDmitry Karpeev } 18954d343eeaSMatthew G Knepley PetscFunctionReturn(0); 18964d343eeaSMatthew G Knepley } 18974d343eeaSMatthew G Knepley 189816621825SDmitry Karpeev /*@C 189916621825SDmitry Karpeev DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems 190016621825SDmitry Karpeev corresponding to different fields: each IS contains the global indices of the dofs of the 190116621825SDmitry Karpeev corresponding field. The optional list of DMs define the DM for each subproblem. 1902e7c4fc90SDmitry Karpeev Generalizes DMCreateFieldIS(). 1903e7c4fc90SDmitry Karpeev 1904e7c4fc90SDmitry Karpeev Not collective 1905e7c4fc90SDmitry Karpeev 1906e7c4fc90SDmitry Karpeev Input Parameter: 1907e7c4fc90SDmitry Karpeev . dm - the DM object 1908e7c4fc90SDmitry Karpeev 1909e7c4fc90SDmitry Karpeev Output Parameters: 19100298fd71SBarry Smith + len - The number of subproblems in the field decomposition (or NULL if not requested) 19110298fd71SBarry Smith . namelist - The name for each field (or NULL if not requested) 19120298fd71SBarry Smith . islist - The global indices for each field (or NULL if not requested) 19130298fd71SBarry Smith - dmlist - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 1914e7c4fc90SDmitry Karpeev 1915e7c4fc90SDmitry Karpeev Level: intermediate 1916e7c4fc90SDmitry Karpeev 1917e7c4fc90SDmitry Karpeev Notes: 1918e7c4fc90SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 1919e7c4fc90SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 1920e7c4fc90SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 1921e7c4fc90SDmitry Karpeev 1922e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1923e7c4fc90SDmitry Karpeev @*/ 192416621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist) 1925e7c4fc90SDmitry Karpeev { 1926e7c4fc90SDmitry Karpeev PetscErrorCode ierr; 1927e7c4fc90SDmitry Karpeev 1928e7c4fc90SDmitry Karpeev PetscFunctionBegin; 1929e7c4fc90SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 19308865f1eaSKarl Rupp if (len) { 1931534a8f05SLisandro Dalcin PetscValidIntPointer(len,2); 19328865f1eaSKarl Rupp *len = 0; 19338865f1eaSKarl Rupp } 19348865f1eaSKarl Rupp if (namelist) { 19358865f1eaSKarl Rupp PetscValidPointer(namelist,3); 1936ea78f98cSLisandro Dalcin *namelist = NULL; 19378865f1eaSKarl Rupp } 19388865f1eaSKarl Rupp if (islist) { 19398865f1eaSKarl Rupp PetscValidPointer(islist,4); 1940ea78f98cSLisandro Dalcin *islist = NULL; 19418865f1eaSKarl Rupp } 19428865f1eaSKarl Rupp if (dmlist) { 19438865f1eaSKarl Rupp PetscValidPointer(dmlist,5); 1944ea78f98cSLisandro Dalcin *dmlist = NULL; 19458865f1eaSKarl Rupp } 1946f3f0edfdSDmitry Karpeev /* 1947f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 1948f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 1949f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 1950f3f0edfdSDmitry Karpeev */ 19512c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 195216621825SDmitry Karpeev if (!dm->ops->createfielddecomposition) { 1953435a35e8SMatthew G Knepley PetscSection section; 1954435a35e8SMatthew G Knepley PetscInt numFields, f; 1955435a35e8SMatthew G Knepley 195692fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 1957435a35e8SMatthew G Knepley if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);} 1958435a35e8SMatthew G Knepley if (section && numFields && dm->ops->createsubdm) { 1959f25d98f1SMatthew G. Knepley if (len) *len = numFields; 196003dc3394SMatthew G. Knepley if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);} 196103dc3394SMatthew G. Knepley if (islist) {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);} 196203dc3394SMatthew G. Knepley if (dmlist) {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);} 1963435a35e8SMatthew G Knepley for (f = 0; f < numFields; ++f) { 1964435a35e8SMatthew G Knepley const char *fieldName; 1965435a35e8SMatthew G Knepley 196603dc3394SMatthew G. Knepley ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr); 196703dc3394SMatthew G. Knepley if (namelist) { 1968435a35e8SMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 1969435a35e8SMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr); 1970435a35e8SMatthew G Knepley } 197103dc3394SMatthew G. Knepley } 1972435a35e8SMatthew G Knepley } else { 197369ca1f37SDmitry Karpeev ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr); 1974e7c4fc90SDmitry Karpeev /* By default there are no DMs associated with subproblems. */ 19750298fd71SBarry Smith if (dmlist) *dmlist = NULL; 1976e7c4fc90SDmitry Karpeev } 19778865f1eaSKarl Rupp } else { 197816621825SDmitry Karpeev ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr); 197916621825SDmitry Karpeev } 198016621825SDmitry Karpeev PetscFunctionReturn(0); 198116621825SDmitry Karpeev } 198216621825SDmitry Karpeev 1983564cec59SMatthew G. Knepley /*@ 1984435a35e8SMatthew G Knepley DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in. 1985435a35e8SMatthew G Knepley The fields are defined by DMCreateFieldIS(). 1986435a35e8SMatthew G Knepley 1987435a35e8SMatthew G Knepley Not collective 1988435a35e8SMatthew G Knepley 1989435a35e8SMatthew G Knepley Input Parameters: 19902adcc780SMatthew G. Knepley + dm - The DM object 19912adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem 19922adcc780SMatthew G. Knepley - fields - The field numbers of the selected fields 1993435a35e8SMatthew G Knepley 1994435a35e8SMatthew G Knepley Output Parameters: 19952adcc780SMatthew G. Knepley + is - The global indices for the subproblem 19962adcc780SMatthew G. Knepley - subdm - The DM for the subproblem 1997435a35e8SMatthew G Knepley 19985d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 19995d3b26e6SMatthew G. Knepley 2000435a35e8SMatthew G Knepley Level: intermediate 2001435a35e8SMatthew G Knepley 20025d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 2003435a35e8SMatthew G Knepley @*/ 200437bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm) 2005435a35e8SMatthew G Knepley { 2006435a35e8SMatthew G Knepley PetscErrorCode ierr; 2007435a35e8SMatthew G Knepley 2008435a35e8SMatthew G Knepley PetscFunctionBegin; 2009435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2010435a35e8SMatthew G Knepley PetscValidPointer(fields,3); 20118865f1eaSKarl Rupp if (is) PetscValidPointer(is,4); 20128865f1eaSKarl Rupp if (subdm) PetscValidPointer(subdm,5); 20132c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createsubdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name); 2014435a35e8SMatthew G Knepley ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr); 2015435a35e8SMatthew G Knepley PetscFunctionReturn(0); 2016435a35e8SMatthew G Knepley } 2017435a35e8SMatthew G Knepley 20182adcc780SMatthew G. Knepley /*@C 20192adcc780SMatthew G. Knepley DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in. 20202adcc780SMatthew G. Knepley 20212adcc780SMatthew G. Knepley Not collective 20222adcc780SMatthew G. Knepley 2023d8d19677SJose E. Roman Input Parameters: 20242adcc780SMatthew G. Knepley + dms - The DM objects 20252adcc780SMatthew G. Knepley - len - The number of DMs 20262adcc780SMatthew G. Knepley 20272adcc780SMatthew G. Knepley Output Parameters: 2028a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL 20292adcc780SMatthew G. Knepley - superdm - The DM for the superproblem 20302adcc780SMatthew G. Knepley 20315d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 20325d3b26e6SMatthew G. Knepley 20332adcc780SMatthew G. Knepley Level: intermediate 20342adcc780SMatthew G. Knepley 20355d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 20362adcc780SMatthew G. Knepley @*/ 20372adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm) 20382adcc780SMatthew G. Knepley { 20392adcc780SMatthew G. Knepley PetscInt i; 20402adcc780SMatthew G. Knepley PetscErrorCode ierr; 20412adcc780SMatthew G. Knepley 20422adcc780SMatthew G. Knepley PetscFunctionBegin; 20432adcc780SMatthew G. Knepley PetscValidPointer(dms,1); 20442adcc780SMatthew G. Knepley for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);} 20452adcc780SMatthew G. Knepley if (is) PetscValidPointer(is,3); 2046a42bd24dSMatthew G. Knepley PetscValidPointer(superdm,4); 20472c71b3e2SJacob Faibussowitsch PetscCheckFalse(len < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len); 20482adcc780SMatthew G. Knepley if (len) { 2049b9d85ea2SLisandro Dalcin DM dm = dms[0]; 20502c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createsuperdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name); 2051b9d85ea2SLisandro Dalcin ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr); 20522adcc780SMatthew G. Knepley } 20532adcc780SMatthew G. Knepley PetscFunctionReturn(0); 20542adcc780SMatthew G. Knepley } 20552adcc780SMatthew G. Knepley 205616621825SDmitry Karpeev /*@C 20578d4ac253SDmitry Karpeev DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems 20588d4ac253SDmitry Karpeev corresponding to restrictions to pairs nested subdomains: each IS contains the global 20598d4ac253SDmitry Karpeev indices of the dofs of the corresponding subdomains. The inner subdomains conceptually 20608d4ac253SDmitry Karpeev define a nonoverlapping covering, while outer subdomains can overlap. 20618d4ac253SDmitry Karpeev The optional list of DMs define the DM for each subproblem. 206216621825SDmitry Karpeev 206316621825SDmitry Karpeev Not collective 206416621825SDmitry Karpeev 206516621825SDmitry Karpeev Input Parameter: 206616621825SDmitry Karpeev . dm - the DM object 206716621825SDmitry Karpeev 206816621825SDmitry Karpeev Output Parameters: 20690298fd71SBarry Smith + len - The number of subproblems in the domain decomposition (or NULL if not requested) 20700298fd71SBarry Smith . namelist - The name for each subdomain (or NULL if not requested) 20710298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested) 20720298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested) 20730298fd71SBarry Smith - dmlist - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 207416621825SDmitry Karpeev 207516621825SDmitry Karpeev Level: intermediate 207616621825SDmitry Karpeev 207716621825SDmitry Karpeev Notes: 207816621825SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 207916621825SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 208016621825SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 208116621825SDmitry Karpeev 2082245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition() 208316621825SDmitry Karpeev @*/ 20848d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist) 208516621825SDmitry Karpeev { 208616621825SDmitry Karpeev PetscErrorCode ierr; 2087be081cd6SPeter Brune DMSubDomainHookLink link; 2088be081cd6SPeter Brune PetscInt i,l; 208916621825SDmitry Karpeev 209016621825SDmitry Karpeev PetscFunctionBegin; 209116621825SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 209214a18fd3SPeter Brune if (len) {PetscValidPointer(len,2); *len = 0;} 20930298fd71SBarry Smith if (namelist) {PetscValidPointer(namelist,3); *namelist = NULL;} 20940298fd71SBarry Smith if (innerislist) {PetscValidPointer(innerislist,4); *innerislist = NULL;} 20950298fd71SBarry Smith if (outerislist) {PetscValidPointer(outerislist,5); *outerislist = NULL;} 20960298fd71SBarry Smith if (dmlist) {PetscValidPointer(dmlist,6); *dmlist = NULL;} 2097f3f0edfdSDmitry Karpeev /* 2098f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 2099f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 2100f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 2101f3f0edfdSDmitry Karpeev */ 21022c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 210316621825SDmitry Karpeev if (dm->ops->createdomaindecomposition) { 2104be081cd6SPeter Brune ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr); 210514a18fd3SPeter Brune /* copy subdomain hooks and context over to the subdomain DMs */ 2106f891f5b9SPatrick Sanan if (dmlist && *dmlist) { 2107be081cd6SPeter Brune for (i = 0; i < l; i++) { 2108be081cd6SPeter Brune for (link=dm->subdomainhook; link; link=link->next) { 2109be081cd6SPeter Brune if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);} 2110be081cd6SPeter Brune } 2111648262bbSPatrick Sanan if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx; 2112e7c4fc90SDmitry Karpeev } 211314a18fd3SPeter Brune } 211414a18fd3SPeter Brune if (len) *len = l; 211514a18fd3SPeter Brune } 2116e30e807fSPeter Brune PetscFunctionReturn(0); 2117e30e807fSPeter Brune } 2118e30e807fSPeter Brune 2119e30e807fSPeter Brune /*@C 2120e30e807fSPeter Brune DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector 2121e30e807fSPeter Brune 2122e30e807fSPeter Brune Not collective 2123e30e807fSPeter Brune 2124e30e807fSPeter Brune Input Parameters: 2125e30e807fSPeter Brune + dm - the DM object 2126e30e807fSPeter Brune . n - the number of subdomain scatters 2127e30e807fSPeter Brune - subdms - the local subdomains 2128e30e807fSPeter Brune 2129e30e807fSPeter Brune Output Parameters: 21306b867d5aSJose E. Roman + iscat - scatter from global vector to nonoverlapping global vector entries on subdomain 2131e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain 2132e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts) 2133e30e807fSPeter Brune 213495452b02SPatrick Sanan Notes: 213595452b02SPatrick Sanan This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution 2136e30e807fSPeter Brune of general nonlinear problems with overlapping subdomain methods. While merely having index sets that enable subsets 2137e30e807fSPeter Brune of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of 2138e30e807fSPeter Brune solution and residual data. 2139e30e807fSPeter Brune 2140e30e807fSPeter Brune Level: developer 2141e30e807fSPeter Brune 2142e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 2143e30e807fSPeter Brune @*/ 2144e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat) 2145e30e807fSPeter Brune { 2146e30e807fSPeter Brune PetscErrorCode ierr; 2147e30e807fSPeter Brune 2148e30e807fSPeter Brune PetscFunctionBegin; 2149e30e807fSPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2150e30e807fSPeter Brune PetscValidPointer(subdms,3); 21512c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createddscatters,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name); 2152e30e807fSPeter Brune ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr); 2153e7c4fc90SDmitry Karpeev PetscFunctionReturn(0); 2154e7c4fc90SDmitry Karpeev } 2155e7c4fc90SDmitry Karpeev 215647c6ae99SBarry Smith /*@ 215747c6ae99SBarry Smith DMRefine - Refines a DM object 215847c6ae99SBarry Smith 2159d083f849SBarry Smith Collective on dm 216047c6ae99SBarry Smith 2161d8d19677SJose E. Roman Input Parameters: 216247c6ae99SBarry Smith + dm - the DM object 216391d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 216447c6ae99SBarry Smith 216547c6ae99SBarry Smith Output Parameter: 21660298fd71SBarry Smith . dmf - the refined DM, or NULL 2167ae0a1c52SMatthew G Knepley 2168f27dd7c6SMatthew G. Knepley Options Database Keys: 2169412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex 2170412e9a14SMatthew G. Knepley 21710298fd71SBarry Smith Note: If no refinement was done, the return value is NULL 217247c6ae99SBarry Smith 217347c6ae99SBarry Smith Level: developer 217447c6ae99SBarry Smith 2175e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 217647c6ae99SBarry Smith @*/ 21777087cfbeSBarry Smith PetscErrorCode DMRefine(DM dm,MPI_Comm comm,DM *dmf) 217847c6ae99SBarry Smith { 217947c6ae99SBarry Smith PetscErrorCode ierr; 2180c833c3b5SJed Brown DMRefineHookLink link; 218147c6ae99SBarry Smith 218247c6ae99SBarry Smith PetscFunctionBegin; 2183732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 21842c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->refine,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name); 21851ac00216SMatthew G. Knepley ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 218647c6ae99SBarry Smith ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr); 21874057135bSMatthew G Knepley if (*dmf) { 218843842a1eSJed Brown (*dmf)->ops->creatematrix = dm->ops->creatematrix; 21898865f1eaSKarl Rupp 21908cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr); 21918865f1eaSKarl Rupp 2192644e2e5bSBarry Smith (*dmf)->ctx = dm->ctx; 21930598a293SJed Brown (*dmf)->leveldown = dm->leveldown; 2194656b349aSBarry Smith (*dmf)->levelup = dm->levelup + 1; 21958865f1eaSKarl Rupp 2196e4b4b23bSJed Brown ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr); 2197c833c3b5SJed Brown for (link=dm->refinehook; link; link=link->next) { 21988865f1eaSKarl Rupp if (link->refinehook) { 21998865f1eaSKarl Rupp ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr); 22008865f1eaSKarl Rupp } 2201c833c3b5SJed Brown } 2202c833c3b5SJed Brown } 22031ac00216SMatthew G. Knepley ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 2204c833c3b5SJed Brown PetscFunctionReturn(0); 2205c833c3b5SJed Brown } 2206c833c3b5SJed Brown 2207bb9467b5SJed Brown /*@C 2208c833c3b5SJed Brown DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid 2209c833c3b5SJed Brown 2210c833c3b5SJed Brown Logically Collective 2211c833c3b5SJed Brown 22124165533cSJose E. Roman Input Parameters: 2213c833c3b5SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 2214c833c3b5SJed Brown . refinehook - function to run when setting up a coarser level 2215c833c3b5SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 22160298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2217c833c3b5SJed Brown 2218c833c3b5SJed Brown Calling sequence of refinehook: 2219c833c3b5SJed Brown $ refinehook(DM coarse,DM fine,void *ctx); 2220c833c3b5SJed Brown 2221c833c3b5SJed Brown + coarse - coarse level DM 2222c833c3b5SJed Brown . fine - fine level DM to interpolate problem to 2223c833c3b5SJed Brown - ctx - optional user-defined function context 2224c833c3b5SJed Brown 2225c833c3b5SJed Brown Calling sequence for interphook: 2226c833c3b5SJed Brown $ interphook(DM coarse,Mat interp,DM fine,void *ctx) 2227c833c3b5SJed Brown 2228c833c3b5SJed Brown + coarse - coarse level DM 2229c833c3b5SJed Brown . interp - matrix interpolating a coarse-level solution to the finer grid 2230c833c3b5SJed Brown . fine - fine level DM to update 2231c833c3b5SJed Brown - ctx - optional user-defined function context 2232c833c3b5SJed Brown 2233c833c3b5SJed Brown Level: advanced 2234c833c3b5SJed Brown 2235c833c3b5SJed Brown Notes: 2236c833c3b5SJed Brown This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing 2237c833c3b5SJed Brown 2238c833c3b5SJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 2239c833c3b5SJed Brown 2240bb9467b5SJed Brown This function is currently not available from Fortran. 2241bb9467b5SJed Brown 2242c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2243c833c3b5SJed Brown @*/ 2244c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 2245c833c3b5SJed Brown { 2246c833c3b5SJed Brown PetscErrorCode ierr; 2247c833c3b5SJed Brown DMRefineHookLink link,*p; 2248c833c3b5SJed Brown 2249c833c3b5SJed Brown PetscFunctionBegin; 2250c833c3b5SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 22513d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 22523d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0); 22533d8e3701SJed Brown } 225495dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2255c833c3b5SJed Brown link->refinehook = refinehook; 2256c833c3b5SJed Brown link->interphook = interphook; 2257c833c3b5SJed Brown link->ctx = ctx; 22580298fd71SBarry Smith link->next = NULL; 2259c833c3b5SJed Brown *p = link; 2260c833c3b5SJed Brown PetscFunctionReturn(0); 2261c833c3b5SJed Brown } 2262c833c3b5SJed Brown 22633d8e3701SJed Brown /*@C 22643d8e3701SJed Brown DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid 22653d8e3701SJed Brown 22663d8e3701SJed Brown Logically Collective 22673d8e3701SJed Brown 22684165533cSJose E. Roman Input Parameters: 22693d8e3701SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 22703d8e3701SJed Brown . refinehook - function to run when setting up a coarser level 22713d8e3701SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 22723d8e3701SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 22733d8e3701SJed Brown 22743d8e3701SJed Brown Level: advanced 22753d8e3701SJed Brown 22763d8e3701SJed Brown Notes: 22773d8e3701SJed Brown This function does nothing if the hook is not in the list. 22783d8e3701SJed Brown 22793d8e3701SJed Brown This function is currently not available from Fortran. 22803d8e3701SJed Brown 22813d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 22823d8e3701SJed Brown @*/ 22833d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 22843d8e3701SJed Brown { 22853d8e3701SJed Brown PetscErrorCode ierr; 22863d8e3701SJed Brown DMRefineHookLink link,*p; 22873d8e3701SJed Brown 22883d8e3701SJed Brown PetscFunctionBegin; 22893d8e3701SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 22903d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 22913d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) { 22923d8e3701SJed Brown link = *p; 22933d8e3701SJed Brown *p = link->next; 22943d8e3701SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 22953d8e3701SJed Brown break; 22963d8e3701SJed Brown } 22973d8e3701SJed Brown } 22983d8e3701SJed Brown PetscFunctionReturn(0); 22993d8e3701SJed Brown } 23003d8e3701SJed Brown 2301c833c3b5SJed Brown /*@ 2302c833c3b5SJed Brown DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd() 2303c833c3b5SJed Brown 2304c833c3b5SJed Brown Collective if any hooks are 2305c833c3b5SJed Brown 23064165533cSJose E. Roman Input Parameters: 2307c833c3b5SJed Brown + coarse - coarser DM to use as a base 2308e91eccc2SStefano Zampini . interp - interpolation matrix, apply using MatInterpolate() 2309c833c3b5SJed Brown - fine - finer DM to update 2310c833c3b5SJed Brown 2311c833c3b5SJed Brown Level: developer 2312c833c3b5SJed Brown 2313c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate() 2314c833c3b5SJed Brown @*/ 2315c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine) 2316c833c3b5SJed Brown { 2317c833c3b5SJed Brown PetscErrorCode ierr; 2318c833c3b5SJed Brown DMRefineHookLink link; 2319c833c3b5SJed Brown 2320c833c3b5SJed Brown PetscFunctionBegin; 2321c833c3b5SJed Brown for (link=fine->refinehook; link; link=link->next) { 23228865f1eaSKarl Rupp if (link->interphook) { 23238865f1eaSKarl Rupp ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr); 23248865f1eaSKarl Rupp } 23254057135bSMatthew G Knepley } 232647c6ae99SBarry Smith PetscFunctionReturn(0); 232747c6ae99SBarry Smith } 232847c6ae99SBarry Smith 2329eb3f98d2SBarry Smith /*@ 23301f3379b2SToby Isaac DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh. 23311f3379b2SToby Isaac 23321f3379b2SToby Isaac Collective on DM 23331f3379b2SToby Isaac 23344165533cSJose E. Roman Input Parameters: 23351f3379b2SToby Isaac + coarse - coarse DM 23361f3379b2SToby Isaac . fine - fine DM 23371f3379b2SToby Isaac . interp - (optional) the matrix computed by DMCreateInterpolation(). Implementations may not need this, but if it 23381f3379b2SToby Isaac is available it can avoid some recomputation. If it is provided, MatInterpolate() will be used if 23391f3379b2SToby Isaac the coarse DM does not have a specialized implementation. 23401f3379b2SToby Isaac - coarseSol - solution on the coarse mesh 23411f3379b2SToby Isaac 23424165533cSJose E. Roman Output Parameter: 23431f3379b2SToby Isaac . fineSol - the interpolation of coarseSol to the fine mesh 23441f3379b2SToby Isaac 23451f3379b2SToby Isaac Level: developer 23461f3379b2SToby Isaac 23471f3379b2SToby Isaac Note: This function exists because the interpolation of a solution vector between meshes is not always a linear 23481f3379b2SToby Isaac map. For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed 23491f3379b2SToby Isaac out of the solution vector. Or if interpolation is inherently a nonlinear operation, such as a method using 23501f3379b2SToby Isaac slope-limiting reconstruction. 23511f3379b2SToby Isaac 23521f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation() 23531f3379b2SToby Isaac @*/ 23541f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol) 23551f3379b2SToby Isaac { 23561f3379b2SToby Isaac PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL; 23571f3379b2SToby Isaac PetscErrorCode ierr; 23581f3379b2SToby Isaac 23591f3379b2SToby Isaac PetscFunctionBegin; 23601f3379b2SToby Isaac PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 23611f3379b2SToby Isaac if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3); 23621f3379b2SToby Isaac PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4); 23631f3379b2SToby Isaac PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5); 23641f3379b2SToby Isaac 23651f3379b2SToby Isaac ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr); 23661f3379b2SToby Isaac if (interpsol) { 23671f3379b2SToby Isaac ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr); 23681f3379b2SToby Isaac } else if (interp) { 23691f3379b2SToby Isaac ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr); 237098921bdaSJacob Faibussowitsch } else SETERRQ(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name); 23711f3379b2SToby Isaac PetscFunctionReturn(0); 23721f3379b2SToby Isaac } 23731f3379b2SToby Isaac 23741f3379b2SToby Isaac /*@ 2375aed49f88SRichard Tran Mills DMGetRefineLevel - Gets the number of refinements that have generated this DM. 2376eb3f98d2SBarry Smith 2377eb3f98d2SBarry Smith Not Collective 2378eb3f98d2SBarry Smith 2379eb3f98d2SBarry Smith Input Parameter: 2380eb3f98d2SBarry Smith . dm - the DM object 2381eb3f98d2SBarry Smith 2382eb3f98d2SBarry Smith Output Parameter: 2383eb3f98d2SBarry Smith . level - number of refinements 2384eb3f98d2SBarry Smith 2385eb3f98d2SBarry Smith Level: developer 2386eb3f98d2SBarry Smith 23876a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2388eb3f98d2SBarry Smith 2389eb3f98d2SBarry Smith @*/ 2390eb3f98d2SBarry Smith PetscErrorCode DMGetRefineLevel(DM dm,PetscInt *level) 2391eb3f98d2SBarry Smith { 2392eb3f98d2SBarry Smith PetscFunctionBegin; 2393eb3f98d2SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2394eb3f98d2SBarry Smith *level = dm->levelup; 2395eb3f98d2SBarry Smith PetscFunctionReturn(0); 2396eb3f98d2SBarry Smith } 2397eb3f98d2SBarry Smith 2398fef3a512SBarry Smith /*@ 2399aed49f88SRichard Tran Mills DMSetRefineLevel - Sets the number of refinements that have generated this DM. 2400fef3a512SBarry Smith 2401fef3a512SBarry Smith Not Collective 2402fef3a512SBarry Smith 2403d8d19677SJose E. Roman Input Parameters: 2404fef3a512SBarry Smith + dm - the DM object 2405fef3a512SBarry Smith - level - number of refinements 2406fef3a512SBarry Smith 2407fef3a512SBarry Smith Level: advanced 2408fef3a512SBarry Smith 240995452b02SPatrick Sanan Notes: 241095452b02SPatrick Sanan This value is used by PCMG to determine how many multigrid levels to use 2411fef3a512SBarry Smith 2412fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2413fef3a512SBarry Smith 2414fef3a512SBarry Smith @*/ 2415fef3a512SBarry Smith PetscErrorCode DMSetRefineLevel(DM dm,PetscInt level) 2416fef3a512SBarry Smith { 2417fef3a512SBarry Smith PetscFunctionBegin; 2418fef3a512SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2419fef3a512SBarry Smith dm->levelup = level; 2420fef3a512SBarry Smith PetscFunctionReturn(0); 2421fef3a512SBarry Smith } 2422fef3a512SBarry Smith 2423d410b0cfSMatthew G. Knepley /*@ 2424d410b0cfSMatthew G. Knepley DMExtrude - Extrude a DM object from a surface 2425d410b0cfSMatthew G. Knepley 2426d410b0cfSMatthew G. Knepley Collective on dm 2427d410b0cfSMatthew G. Knepley 2428d410b0cfSMatthew G. Knepley Input Parameter: 2429d410b0cfSMatthew G. Knepley + dm - the DM object 2430d410b0cfSMatthew G. Knepley - layers - the number of extruded cell layers 2431d410b0cfSMatthew G. Knepley 2432d410b0cfSMatthew G. Knepley Output Parameter: 2433d410b0cfSMatthew G. Knepley . dme - the extruded DM, or NULL 2434d410b0cfSMatthew G. Knepley 2435d410b0cfSMatthew G. Knepley Note: If no extrusion was done, the return value is NULL 2436d410b0cfSMatthew G. Knepley 2437d410b0cfSMatthew G. Knepley Level: developer 2438d410b0cfSMatthew G. Knepley 2439d410b0cfSMatthew G. Knepley .seealso DMRefine(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector() 2440d410b0cfSMatthew G. Knepley @*/ 2441d410b0cfSMatthew G. Knepley PetscErrorCode DMExtrude(DM dm, PetscInt layers, DM *dme) 2442d410b0cfSMatthew G. Knepley { 2443d410b0cfSMatthew G. Knepley PetscErrorCode ierr; 2444d410b0cfSMatthew G. Knepley 2445d410b0cfSMatthew G. Knepley PetscFunctionBegin; 2446d410b0cfSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 24472c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->extrude,PetscObjectComm((PetscObject) dm), PETSC_ERR_SUP, "DM type %s does not implement DMExtrude", ((PetscObject) dm)->type_name); 2448d410b0cfSMatthew G. Knepley ierr = (*dm->ops->extrude)(dm, layers, dme);CHKERRQ(ierr); 2449d410b0cfSMatthew G. Knepley if (*dme) { 2450d410b0cfSMatthew G. Knepley (*dme)->ops->creatematrix = dm->ops->creatematrix; 2451d410b0cfSMatthew G. Knepley ierr = PetscObjectCopyFortranFunctionPointers((PetscObject) dm, (PetscObject) *dme);CHKERRQ(ierr); 2452d410b0cfSMatthew G. Knepley (*dme)->ctx = dm->ctx; 2453d410b0cfSMatthew G. Knepley ierr = DMSetMatType(*dme, dm->mattype);CHKERRQ(ierr); 2454d410b0cfSMatthew G. Knepley } 2455d410b0cfSMatthew G. Knepley PetscFunctionReturn(0); 2456d410b0cfSMatthew G. Knepley } 2457d410b0cfSMatthew G. Knepley 2458ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm) 2459ca3d3a14SMatthew G. Knepley { 2460ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2461ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2462ca3d3a14SMatthew G. Knepley PetscValidPointer(tdm, 2); 2463ca3d3a14SMatthew G. Knepley *tdm = dm->transformDM; 2464ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2465ca3d3a14SMatthew G. Knepley } 2466ca3d3a14SMatthew G. Knepley 2467ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv) 2468ca3d3a14SMatthew G. Knepley { 2469ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2470ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2471ca3d3a14SMatthew G. Knepley PetscValidPointer(tv, 2); 2472ca3d3a14SMatthew G. Knepley *tv = dm->transform; 2473ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2474ca3d3a14SMatthew G. Knepley } 2475ca3d3a14SMatthew G. Knepley 2476ca3d3a14SMatthew G. Knepley /*@ 2477c0f8e1fdSMatthew G. Knepley DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors 2478ca3d3a14SMatthew G. Knepley 2479ca3d3a14SMatthew G. Knepley Input Parameter: 2480ca3d3a14SMatthew G. Knepley . dm - The DM 2481ca3d3a14SMatthew G. Knepley 2482ca3d3a14SMatthew G. Knepley Output Parameter: 2483ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done 2484ca3d3a14SMatthew G. Knepley 2485ca3d3a14SMatthew G. Knepley Level: developer 2486ca3d3a14SMatthew G. Knepley 2487436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation() 2488ca3d3a14SMatthew G. Knepley @*/ 2489ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg) 2490ca3d3a14SMatthew G. Knepley { 2491ca3d3a14SMatthew G. Knepley Vec tv; 2492ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2493ca3d3a14SMatthew G. Knepley 2494ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2495ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2496534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 2497ca3d3a14SMatthew G. Knepley ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr); 2498ca3d3a14SMatthew G. Knepley *flg = tv ? PETSC_TRUE : PETSC_FALSE; 2499ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2500ca3d3a14SMatthew G. Knepley } 2501ca3d3a14SMatthew G. Knepley 2502ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm) 2503ca3d3a14SMatthew G. Knepley { 2504ca3d3a14SMatthew G. Knepley PetscSection s, ts; 2505ca3d3a14SMatthew G. Knepley PetscScalar *ta; 2506ca3d3a14SMatthew G. Knepley PetscInt cdim, pStart, pEnd, p, Nf, f, Nc, dof; 2507ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2508ca3d3a14SMatthew G. Knepley 2509ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2510ca3d3a14SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 251192fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 2512ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 2513ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr); 2514ca3d3a14SMatthew G. Knepley ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr); 251592fd8e1eSJed Brown ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr); 2516ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr); 2517ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr); 2518ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2519ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr); 2520ca3d3a14SMatthew G. Knepley /* We could start to label fields by their transformation properties */ 2521ca3d3a14SMatthew G. Knepley if (Nc != cdim) continue; 2522ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2523ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr); 2524ca3d3a14SMatthew G. Knepley if (!dof) continue; 2525ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr); 2526ca3d3a14SMatthew G. Knepley ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr); 2527ca3d3a14SMatthew G. Knepley } 2528ca3d3a14SMatthew G. Knepley } 2529ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetUp(ts);CHKERRQ(ierr); 2530ca3d3a14SMatthew G. Knepley ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr); 2531ca3d3a14SMatthew G. Knepley ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr); 2532ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2533ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2534ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr); 2535ca3d3a14SMatthew G. Knepley if (dof) { 2536ca3d3a14SMatthew G. Knepley PetscReal x[3] = {0.0, 0.0, 0.0}; 2537ca3d3a14SMatthew G. Knepley PetscScalar *tva; 2538ca3d3a14SMatthew G. Knepley const PetscScalar *A; 2539ca3d3a14SMatthew G. Knepley 2540ca3d3a14SMatthew G. Knepley /* TODO Get quadrature point for this dual basis vector for coordinate */ 2541ca3d3a14SMatthew G. Knepley ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr); 2542ca3d3a14SMatthew G. Knepley ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr); 2543580bdb30SBarry Smith ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr); 2544ca3d3a14SMatthew G. Knepley } 2545ca3d3a14SMatthew G. Knepley } 2546ca3d3a14SMatthew G. Knepley } 2547ca3d3a14SMatthew G. Knepley ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr); 2548ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2549ca3d3a14SMatthew G. Knepley } 2550ca3d3a14SMatthew G. Knepley 2551ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm) 2552ca3d3a14SMatthew G. Knepley { 2553ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2554ca3d3a14SMatthew G. Knepley 2555ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2556ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2557ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(newdm, DM_CLASSID, 2); 2558ca3d3a14SMatthew G. Knepley newdm->transformCtx = dm->transformCtx; 2559ca3d3a14SMatthew G. Knepley newdm->transformSetUp = dm->transformSetUp; 2560ca3d3a14SMatthew G. Knepley newdm->transformDestroy = NULL; 2561ca3d3a14SMatthew G. Knepley newdm->transformGetMatrix = dm->transformGetMatrix; 2562ca3d3a14SMatthew G. Knepley if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);} 2563ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2564ca3d3a14SMatthew G. Knepley } 2565ca3d3a14SMatthew G. Knepley 2566bb9467b5SJed Brown /*@C 2567baf369e7SPeter Brune DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called 2568baf369e7SPeter Brune 2569baf369e7SPeter Brune Logically Collective 2570baf369e7SPeter Brune 25714165533cSJose E. Roman Input Parameters: 2572baf369e7SPeter Brune + dm - the DM 2573baf369e7SPeter Brune . beginhook - function to run at the beginning of DMGlobalToLocalBegin() 2574baf369e7SPeter Brune . endhook - function to run after DMGlobalToLocalEnd() has completed 25750298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2576baf369e7SPeter Brune 2577baf369e7SPeter Brune Calling sequence for beginhook: 2578baf369e7SPeter Brune $ beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2579baf369e7SPeter Brune 2580baf369e7SPeter Brune + dm - global DM 2581baf369e7SPeter Brune . g - global vector 2582baf369e7SPeter Brune . mode - mode 2583baf369e7SPeter Brune . l - local vector 2584baf369e7SPeter Brune - ctx - optional user-defined function context 2585baf369e7SPeter Brune 2586baf369e7SPeter Brune Calling sequence for endhook: 2587ec4806b8SPeter Brune $ endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2588baf369e7SPeter Brune 2589baf369e7SPeter Brune + global - global DM 2590baf369e7SPeter Brune - ctx - optional user-defined function context 2591baf369e7SPeter Brune 2592baf369e7SPeter Brune Level: advanced 2593baf369e7SPeter Brune 2594baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2595baf369e7SPeter Brune @*/ 2596baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2597baf369e7SPeter Brune { 2598baf369e7SPeter Brune PetscErrorCode ierr; 2599baf369e7SPeter Brune DMGlobalToLocalHookLink link,*p; 2600baf369e7SPeter Brune 2601baf369e7SPeter Brune PetscFunctionBegin; 2602baf369e7SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2603baf369e7SPeter Brune for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 260495dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2605baf369e7SPeter Brune link->beginhook = beginhook; 2606baf369e7SPeter Brune link->endhook = endhook; 2607baf369e7SPeter Brune link->ctx = ctx; 26080298fd71SBarry Smith link->next = NULL; 2609baf369e7SPeter Brune *p = link; 2610baf369e7SPeter Brune PetscFunctionReturn(0); 2611baf369e7SPeter Brune } 2612baf369e7SPeter Brune 26134c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx) 26144c274da1SToby Isaac { 26154c274da1SToby Isaac Mat cMat; 26164c274da1SToby Isaac Vec cVec; 26174c274da1SToby Isaac PetscSection section, cSec; 26184c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 26194c274da1SToby Isaac PetscErrorCode ierr; 26204c274da1SToby Isaac 26214c274da1SToby Isaac PetscFunctionBegin; 26224c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 26234c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 26244c274da1SToby Isaac if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) { 26255db9a05bSToby Isaac PetscInt nRows; 26265db9a05bSToby Isaac 26275db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 26285db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 262992fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 26307711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 26314c274da1SToby Isaac ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr); 26324c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 26334c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 26344c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 26354c274da1SToby Isaac if (dof) { 26364c274da1SToby Isaac PetscScalar *vals; 26374c274da1SToby Isaac ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr); 26384c274da1SToby Isaac ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr); 26394c274da1SToby Isaac } 26404c274da1SToby Isaac } 26414c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 26424c274da1SToby Isaac } 26434c274da1SToby Isaac PetscFunctionReturn(0); 26444c274da1SToby Isaac } 26454c274da1SToby Isaac 264647c6ae99SBarry Smith /*@ 264701729b5cSPatrick Sanan DMGlobalToLocal - update local vectors from global vector 264801729b5cSPatrick Sanan 2649d083f849SBarry Smith Neighbor-wise Collective on dm 265001729b5cSPatrick Sanan 265101729b5cSPatrick Sanan Input Parameters: 265201729b5cSPatrick Sanan + dm - the DM object 265301729b5cSPatrick Sanan . g - the global vector 265401729b5cSPatrick Sanan . mode - INSERT_VALUES or ADD_VALUES 265501729b5cSPatrick Sanan - l - the local vector 265601729b5cSPatrick Sanan 265701729b5cSPatrick Sanan Notes: 265801729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 265901729b5cSPatrick Sanan DMGlobalToLocalBegin() and DMGlobalToLocalEnd(). 266001729b5cSPatrick Sanan 266101729b5cSPatrick Sanan Level: beginner 266201729b5cSPatrick Sanan 266301729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 266401729b5cSPatrick Sanan 266501729b5cSPatrick Sanan @*/ 266601729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l) 266701729b5cSPatrick Sanan { 266801729b5cSPatrick Sanan PetscErrorCode ierr; 266901729b5cSPatrick Sanan 267001729b5cSPatrick Sanan PetscFunctionBegin; 267101729b5cSPatrick Sanan ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr); 267201729b5cSPatrick Sanan ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr); 267301729b5cSPatrick Sanan PetscFunctionReturn(0); 267401729b5cSPatrick Sanan } 267501729b5cSPatrick Sanan 267601729b5cSPatrick Sanan /*@ 267747c6ae99SBarry Smith DMGlobalToLocalBegin - Begins updating local vectors from global vector 267847c6ae99SBarry Smith 2679d083f849SBarry Smith Neighbor-wise Collective on dm 268047c6ae99SBarry Smith 268147c6ae99SBarry Smith Input Parameters: 268247c6ae99SBarry Smith + dm - the DM object 268347c6ae99SBarry Smith . g - the global vector 268447c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 268547c6ae99SBarry Smith - l - the local vector 268647c6ae99SBarry Smith 268701729b5cSPatrick Sanan Level: intermediate 268847c6ae99SBarry Smith 268901729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 269047c6ae99SBarry Smith 269147c6ae99SBarry Smith @*/ 26927087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 269347c6ae99SBarry Smith { 26947128ae9fSMatthew G Knepley PetscSF sf; 269547c6ae99SBarry Smith PetscErrorCode ierr; 2696baf369e7SPeter Brune DMGlobalToLocalHookLink link; 269747c6ae99SBarry Smith 269847c6ae99SBarry Smith PetscFunctionBegin; 2699171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2700baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 27018865f1eaSKarl Rupp if (link->beginhook) { 27028865f1eaSKarl Rupp ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr); 27038865f1eaSKarl Rupp } 2704baf369e7SPeter Brune } 27051bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 27067128ae9fSMatthew G Knepley if (sf) { 2707ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2708ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2709d0295fc0SJunchao Zhang PetscMemType lmtype,gmtype; 27107128ae9fSMatthew G Knepley 27112c71b3e2SJacob Faibussowitsch PetscCheckFalse(mode == ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 2712a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2713a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2714ad227feaSJunchao Zhang ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr); 2715a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr); 2716a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr); 27177128ae9fSMatthew G Knepley } else { 27182c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->globaltolocalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name); 2719843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 27207128ae9fSMatthew G Knepley } 272147c6ae99SBarry Smith PetscFunctionReturn(0); 272247c6ae99SBarry Smith } 272347c6ae99SBarry Smith 272447c6ae99SBarry Smith /*@ 272547c6ae99SBarry Smith DMGlobalToLocalEnd - Ends updating local vectors from global vector 272647c6ae99SBarry Smith 2727d083f849SBarry Smith Neighbor-wise Collective on dm 272847c6ae99SBarry Smith 272947c6ae99SBarry Smith Input Parameters: 273047c6ae99SBarry Smith + dm - the DM object 273147c6ae99SBarry Smith . g - the global vector 273247c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 273347c6ae99SBarry Smith - l - the local vector 273447c6ae99SBarry Smith 273501729b5cSPatrick Sanan Level: intermediate 273647c6ae99SBarry Smith 273701729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 273847c6ae99SBarry Smith 273947c6ae99SBarry Smith @*/ 27407087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 274147c6ae99SBarry Smith { 27427128ae9fSMatthew G Knepley PetscSF sf; 274347c6ae99SBarry Smith PetscErrorCode ierr; 2744ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2745ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2746ca3d3a14SMatthew G. Knepley PetscBool transform; 2747baf369e7SPeter Brune DMGlobalToLocalHookLink link; 2748d0295fc0SJunchao Zhang PetscMemType lmtype,gmtype; 274947c6ae99SBarry Smith 275047c6ae99SBarry Smith PetscFunctionBegin; 2751171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 27521bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 2753ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 27547128ae9fSMatthew G Knepley if (sf) { 27552c71b3e2SJacob Faibussowitsch PetscCheckFalse(mode == ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 27567128ae9fSMatthew G Knepley 2757a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2758a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2759ad227feaSJunchao Zhang ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr); 2760a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr); 2761a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr); 2762ca3d3a14SMatthew G. Knepley if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);} 27637128ae9fSMatthew G Knepley } else { 27642c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->globaltolocalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name); 2765843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 27667128ae9fSMatthew G Knepley } 27674c274da1SToby Isaac ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr); 2768baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 2769baf369e7SPeter Brune if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 2770baf369e7SPeter Brune } 277147c6ae99SBarry Smith PetscFunctionReturn(0); 277247c6ae99SBarry Smith } 277347c6ae99SBarry Smith 2774d4d07f1eSToby Isaac /*@C 2775d4d07f1eSToby Isaac DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called 2776d4d07f1eSToby Isaac 2777d4d07f1eSToby Isaac Logically Collective 2778d4d07f1eSToby Isaac 27794165533cSJose E. Roman Input Parameters: 2780d4d07f1eSToby Isaac + dm - the DM 2781d4d07f1eSToby Isaac . beginhook - function to run at the beginning of DMLocalToGlobalBegin() 2782d4d07f1eSToby Isaac . endhook - function to run after DMLocalToGlobalEnd() has completed 2783d4d07f1eSToby Isaac - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2784d4d07f1eSToby Isaac 2785d4d07f1eSToby Isaac Calling sequence for beginhook: 2786d4d07f1eSToby Isaac $ beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2787d4d07f1eSToby Isaac 2788d4d07f1eSToby Isaac + dm - global DM 2789d4d07f1eSToby Isaac . l - local vector 2790d4d07f1eSToby Isaac . mode - mode 2791d4d07f1eSToby Isaac . g - global vector 2792d4d07f1eSToby Isaac - ctx - optional user-defined function context 2793d4d07f1eSToby Isaac 2794d4d07f1eSToby Isaac Calling sequence for endhook: 2795d4d07f1eSToby Isaac $ endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2796d4d07f1eSToby Isaac 2797d4d07f1eSToby Isaac + global - global DM 2798d4d07f1eSToby Isaac . l - local vector 2799d4d07f1eSToby Isaac . mode - mode 2800d4d07f1eSToby Isaac . g - global vector 2801d4d07f1eSToby Isaac - ctx - optional user-defined function context 2802d4d07f1eSToby Isaac 2803d4d07f1eSToby Isaac Level: advanced 2804d4d07f1eSToby Isaac 2805d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2806d4d07f1eSToby Isaac @*/ 2807d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2808d4d07f1eSToby Isaac { 2809d4d07f1eSToby Isaac PetscErrorCode ierr; 2810d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,*p; 2811d4d07f1eSToby Isaac 2812d4d07f1eSToby Isaac PetscFunctionBegin; 2813d4d07f1eSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2814d4d07f1eSToby Isaac for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 281595dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2816d4d07f1eSToby Isaac link->beginhook = beginhook; 2817d4d07f1eSToby Isaac link->endhook = endhook; 2818d4d07f1eSToby Isaac link->ctx = ctx; 2819d4d07f1eSToby Isaac link->next = NULL; 2820d4d07f1eSToby Isaac *p = link; 2821d4d07f1eSToby Isaac PetscFunctionReturn(0); 2822d4d07f1eSToby Isaac } 2823d4d07f1eSToby Isaac 28244c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx) 28254c274da1SToby Isaac { 28264c274da1SToby Isaac Mat cMat; 28274c274da1SToby Isaac Vec cVec; 28284c274da1SToby Isaac PetscSection section, cSec; 28294c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 28304c274da1SToby Isaac PetscErrorCode ierr; 28314c274da1SToby Isaac 28324c274da1SToby Isaac PetscFunctionBegin; 28334c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 28344c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 28354c274da1SToby Isaac if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) { 28365db9a05bSToby Isaac PetscInt nRows; 28375db9a05bSToby Isaac 28385db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 28395db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 284092fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 28417711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 28424c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 28434c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 28444c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 28454c274da1SToby Isaac if (dof) { 28464c274da1SToby Isaac PetscInt d; 28474c274da1SToby Isaac PetscScalar *vals; 28484c274da1SToby Isaac ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr); 28494c274da1SToby Isaac ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr); 28504c274da1SToby Isaac /* for this to be the true transpose, we have to zero the values that 28514c274da1SToby Isaac * we just extracted */ 28524c274da1SToby Isaac for (d = 0; d < dof; d++) { 28534c274da1SToby Isaac vals[d] = 0.; 28544c274da1SToby Isaac } 28554c274da1SToby Isaac } 28564c274da1SToby Isaac } 28574c274da1SToby Isaac ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr); 28584c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 28594c274da1SToby Isaac } 28604c274da1SToby Isaac PetscFunctionReturn(0); 28614c274da1SToby Isaac } 286201729b5cSPatrick Sanan /*@ 286301729b5cSPatrick Sanan DMLocalToGlobal - updates global vectors from local vectors 286401729b5cSPatrick Sanan 2865d083f849SBarry Smith Neighbor-wise Collective on dm 286601729b5cSPatrick Sanan 286701729b5cSPatrick Sanan Input Parameters: 286801729b5cSPatrick Sanan + dm - the DM object 286901729b5cSPatrick Sanan . l - the local vector 287001729b5cSPatrick 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. 287101729b5cSPatrick Sanan - g - the global vector 287201729b5cSPatrick Sanan 287301729b5cSPatrick Sanan Notes: 287401729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 287501729b5cSPatrick Sanan DMLocalToGlobalBegin() and DMLocalToGlobalEnd(). 287601729b5cSPatrick Sanan 287701729b5cSPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 287801729b5cSPatrick 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. 287901729b5cSPatrick Sanan 288001729b5cSPatrick Sanan Level: beginner 288101729b5cSPatrick Sanan 288201729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 288301729b5cSPatrick Sanan 288401729b5cSPatrick Sanan @*/ 288501729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g) 288601729b5cSPatrick Sanan { 288701729b5cSPatrick Sanan PetscErrorCode ierr; 288801729b5cSPatrick Sanan 288901729b5cSPatrick Sanan PetscFunctionBegin; 289001729b5cSPatrick Sanan ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr); 289101729b5cSPatrick Sanan ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr); 289201729b5cSPatrick Sanan PetscFunctionReturn(0); 289301729b5cSPatrick Sanan } 28944c274da1SToby Isaac 289547c6ae99SBarry Smith /*@ 289601729b5cSPatrick Sanan DMLocalToGlobalBegin - begins updating global vectors from local vectors 28979a42bb27SBarry Smith 2898d083f849SBarry Smith Neighbor-wise Collective on dm 28999a42bb27SBarry Smith 29009a42bb27SBarry Smith Input Parameters: 29019a42bb27SBarry Smith + dm - the DM object 2902f6813fd5SJed Brown . l - the local vector 29031eb28f2eSBarry 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. 29041eb28f2eSBarry Smith - g - the global vector 29059a42bb27SBarry Smith 290695452b02SPatrick Sanan Notes: 290795452b02SPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 290884330215SMatthew 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. 29099a42bb27SBarry Smith 291001729b5cSPatrick Sanan Level: intermediate 29119a42bb27SBarry Smith 291201729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 29139a42bb27SBarry Smith 29149a42bb27SBarry Smith @*/ 29157087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g) 29169a42bb27SBarry Smith { 29177128ae9fSMatthew G Knepley PetscSF sf; 291884330215SMatthew G. Knepley PetscSection s, gs; 2919d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 2920ca3d3a14SMatthew G. Knepley Vec tmpl; 2921ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2922ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 2923fa88e482SJed Brown PetscBool isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE; 292484330215SMatthew G. Knepley PetscErrorCode ierr; 2925d0295fc0SJunchao Zhang PetscMemType lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST; 29269a42bb27SBarry Smith 29279a42bb27SBarry Smith PetscFunctionBegin; 2928171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2929d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2930d4d07f1eSToby Isaac if (link->beginhook) { 2931d4d07f1eSToby Isaac ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr); 2932d4d07f1eSToby Isaac } 2933d4d07f1eSToby Isaac } 29344c274da1SToby Isaac ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr); 29351bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 293692fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 29377128ae9fSMatthew G Knepley switch (mode) { 29387128ae9fSMatthew G Knepley case INSERT_VALUES: 29397128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 2940304ab55fSMatthew G. Knepley case INSERT_BC_VALUES: 294184330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 29427128ae9fSMatthew G Knepley case ADD_VALUES: 29437128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 2944304ab55fSMatthew G. Knepley case ADD_BC_VALUES: 294584330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 29467128ae9fSMatthew G Knepley default: 294798921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 29487128ae9fSMatthew G Knepley } 2949ca3d3a14SMatthew G. Knepley if ((sf && !isInsert) || (s && isInsert)) { 2950ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 2951ca3d3a14SMatthew G. Knepley if (transform) { 2952ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2953ca3d3a14SMatthew G. Knepley ierr = VecCopy(l, tmpl);CHKERRQ(ierr); 2954ca3d3a14SMatthew G. Knepley ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr); 2955ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2956fa88e482SJed Brown } else if (isInsert) { 2957ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 2958fa88e482SJed Brown } else { 2959a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2960fa88e482SJed Brown l_inplace = PETSC_TRUE; 2961ca3d3a14SMatthew G. Knepley } 2962fa88e482SJed Brown if (s && isInsert) { 29637128ae9fSMatthew G Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 2964fa88e482SJed Brown } else { 2965a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2966fa88e482SJed Brown g_inplace = PETSC_TRUE; 2967fa88e482SJed Brown } 2968ca3d3a14SMatthew G. Knepley if (sf && !isInsert) { 2969d0295fc0SJunchao Zhang ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr); 297084330215SMatthew G. Knepley } else if (s && isInsert) { 297184330215SMatthew G. Knepley PetscInt gStart, pStart, pEnd, p; 297284330215SMatthew G. Knepley 2973e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr); 297484330215SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 297584330215SMatthew G. Knepley ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr); 297684330215SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2977b3b16f48SMatthew G. Knepley PetscInt dof, gdof, cdof, gcdof, off, goff, d, e; 297884330215SMatthew G. Knepley 297984330215SMatthew G. Knepley ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr); 298003442857SMatthew G. Knepley ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr); 298184330215SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr); 2982b3b16f48SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr); 298384330215SMatthew G. Knepley ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr); 298484330215SMatthew G. Knepley ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr); 2985b3b16f48SMatthew G. Knepley /* Ignore off-process data and points with no global data */ 298603442857SMatthew G. Knepley if (!gdof || goff < 0) continue; 29872c71b3e2SJacob Faibussowitsch PetscCheckFalse(dof != gdof,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof); 2988b3b16f48SMatthew G. Knepley /* If no constraints are enforced in the global vector */ 2989b3b16f48SMatthew G. Knepley if (!gcdof) { 299084330215SMatthew G. Knepley for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d]; 2991b3b16f48SMatthew G. Knepley /* If constraints are enforced in the global vector */ 2992b3b16f48SMatthew G. Knepley } else if (cdof == gcdof) { 299384330215SMatthew G. Knepley const PetscInt *cdofs; 299484330215SMatthew G. Knepley PetscInt cind = 0; 299584330215SMatthew G. Knepley 299684330215SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr); 2997b3b16f48SMatthew G. Knepley for (d = 0, e = 0; d < dof; ++d) { 299884330215SMatthew G. Knepley if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;} 2999b3b16f48SMatthew G. Knepley gArray[goff-gStart+e++] = lArray[off+d]; 300084330215SMatthew G. Knepley } 300198921bdaSJacob Faibussowitsch } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof); 300284330215SMatthew G. Knepley } 3003ca3d3a14SMatthew G. Knepley } 3004fa88e482SJed Brown if (g_inplace) { 3005a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr); 3006fa88e482SJed Brown } else { 30077128ae9fSMatthew G Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 3008fa88e482SJed Brown } 3009ca3d3a14SMatthew G. Knepley if (transform) { 3010ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 3011ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 3012fa88e482SJed Brown } else if (l_inplace) { 3013a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr); 3014ca3d3a14SMatthew G. Knepley } else { 3015ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 3016ca3d3a14SMatthew G. Knepley } 30177128ae9fSMatthew G Knepley } else { 30182c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->localtoglobalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name); 3019843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 30207128ae9fSMatthew G Knepley } 30219a42bb27SBarry Smith PetscFunctionReturn(0); 30229a42bb27SBarry Smith } 30239a42bb27SBarry Smith 30249a42bb27SBarry Smith /*@ 30259a42bb27SBarry Smith DMLocalToGlobalEnd - updates global vectors from local vectors 302647c6ae99SBarry Smith 3027d083f849SBarry Smith Neighbor-wise Collective on dm 302847c6ae99SBarry Smith 302947c6ae99SBarry Smith Input Parameters: 303047c6ae99SBarry Smith + dm - the DM object 3031f6813fd5SJed Brown . l - the local vector 303247c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 3033f6813fd5SJed Brown - g - the global vector 303447c6ae99SBarry Smith 303501729b5cSPatrick Sanan Level: intermediate 303647c6ae99SBarry Smith 3037e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd() 303847c6ae99SBarry Smith 303947c6ae99SBarry Smith @*/ 30407087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g) 304147c6ae99SBarry Smith { 30427128ae9fSMatthew G Knepley PetscSF sf; 304384330215SMatthew G. Knepley PetscSection s; 3044d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 3045ca3d3a14SMatthew G. Knepley PetscBool isInsert, transform; 304684330215SMatthew G. Knepley PetscErrorCode ierr; 304747c6ae99SBarry Smith 304847c6ae99SBarry Smith PetscFunctionBegin; 3049171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 30501bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 305192fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 30527128ae9fSMatthew G Knepley switch (mode) { 30537128ae9fSMatthew G Knepley case INSERT_VALUES: 30547128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 305584330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 30567128ae9fSMatthew G Knepley case ADD_VALUES: 30577128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 305884330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 30597128ae9fSMatthew G Knepley default: 306098921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 30617128ae9fSMatthew G Knepley } 306284330215SMatthew G. Knepley if (sf && !isInsert) { 3063ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 3064ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 3065ca3d3a14SMatthew G. Knepley Vec tmpl; 306684330215SMatthew G. Knepley 3067ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 3068ca3d3a14SMatthew G. Knepley if (transform) { 3069ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 3070ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 3071ca3d3a14SMatthew G. Knepley } else { 3072a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr); 3073ca3d3a14SMatthew G. Knepley } 3074a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr); 3075a9b180a6SBarry Smith ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr); 3076ca3d3a14SMatthew G. Knepley if (transform) { 3077ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 3078ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 3079ca3d3a14SMatthew G. Knepley } else { 3080a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr); 3081ca3d3a14SMatthew G. Knepley } 3082a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr); 308384330215SMatthew G. Knepley } else if (s && isInsert) { 30847128ae9fSMatthew G Knepley } else { 30852c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->localtoglobalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name); 3086843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 30877128ae9fSMatthew G Knepley } 3088d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 3089d4d07f1eSToby Isaac if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 3090d4d07f1eSToby Isaac } 309147c6ae99SBarry Smith PetscFunctionReturn(0); 309247c6ae99SBarry Smith } 309347c6ae99SBarry Smith 3094f089877aSRichard Tran Mills /*@ 3095bc0a1609SRichard Tran Mills DMLocalToLocalBegin - Maps from a local vector (including ghost points 3096bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 3097d78e899eSRichard Tran Mills points in the second are set correctly. Must be followed by DMLocalToLocalEnd(). 3098f089877aSRichard Tran Mills 3099d083f849SBarry Smith Neighbor-wise Collective on dm 3100f089877aSRichard Tran Mills 3101f089877aSRichard Tran Mills Input Parameters: 3102f089877aSRichard Tran Mills + dm - the DM object 3103bc0a1609SRichard Tran Mills . g - the original local vector 3104bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 3105f089877aSRichard Tran Mills 3106bc0a1609SRichard Tran Mills Output Parameter: 3107bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 3108f089877aSRichard Tran Mills 3109f089877aSRichard Tran Mills Level: intermediate 3110f089877aSRichard Tran Mills 3111bc0a1609SRichard Tran Mills Notes: 3112bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 3113bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 3114bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 3115bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 3116bc0a1609SRichard Tran Mills 3117bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 3118f089877aSRichard Tran Mills 3119f089877aSRichard Tran Mills @*/ 3120f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 3121f089877aSRichard Tran Mills { 3122f089877aSRichard Tran Mills PetscErrorCode ierr; 3123f089877aSRichard Tran Mills 3124f089877aSRichard Tran Mills PetscFunctionBegin; 3125f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 31262c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->localtolocalbegin,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 3127f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 3128f089877aSRichard Tran Mills PetscFunctionReturn(0); 3129f089877aSRichard Tran Mills } 3130f089877aSRichard Tran Mills 3131f089877aSRichard Tran Mills /*@ 3132bc0a1609SRichard Tran Mills DMLocalToLocalEnd - Maps from a local vector (including ghost points 3133bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 3134d78e899eSRichard Tran Mills points in the second are set correctly. Must be preceded by DMLocalToLocalBegin(). 3135f089877aSRichard Tran Mills 3136d083f849SBarry Smith Neighbor-wise Collective on dm 3137f089877aSRichard Tran Mills 3138f089877aSRichard Tran Mills Input Parameters: 3139bc0a1609SRichard Tran Mills + da - the DM object 3140bc0a1609SRichard Tran Mills . g - the original local vector 3141bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 3142f089877aSRichard Tran Mills 3143bc0a1609SRichard Tran Mills Output Parameter: 3144bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 3145f089877aSRichard Tran Mills 3146f089877aSRichard Tran Mills Level: intermediate 3147f089877aSRichard Tran Mills 3148bc0a1609SRichard Tran Mills Notes: 3149bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 3150bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 3151bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 3152bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 3153bc0a1609SRichard Tran Mills 3154bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 3155f089877aSRichard Tran Mills 3156f089877aSRichard Tran Mills @*/ 3157f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 3158f089877aSRichard Tran Mills { 3159f089877aSRichard Tran Mills PetscErrorCode ierr; 3160f089877aSRichard Tran Mills 3161f089877aSRichard Tran Mills PetscFunctionBegin; 3162f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 31632c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->localtolocalend,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 3164f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 3165f089877aSRichard Tran Mills PetscFunctionReturn(0); 3166f089877aSRichard Tran Mills } 3167f089877aSRichard Tran Mills 316847c6ae99SBarry Smith /*@ 316947c6ae99SBarry Smith DMCoarsen - Coarsens a DM object 317047c6ae99SBarry Smith 3171d083f849SBarry Smith Collective on dm 317247c6ae99SBarry Smith 3173d8d19677SJose E. Roman Input Parameters: 317447c6ae99SBarry Smith + dm - the DM object 317591d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 317647c6ae99SBarry Smith 317747c6ae99SBarry Smith Output Parameter: 317847c6ae99SBarry Smith . dmc - the coarsened DM 317947c6ae99SBarry Smith 318047c6ae99SBarry Smith Level: developer 318147c6ae99SBarry Smith 3182e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 318347c6ae99SBarry Smith 318447c6ae99SBarry Smith @*/ 31857087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc) 318647c6ae99SBarry Smith { 318747c6ae99SBarry Smith PetscErrorCode ierr; 3188b17ce1afSJed Brown DMCoarsenHookLink link; 318947c6ae99SBarry Smith 319047c6ae99SBarry Smith PetscFunctionBegin; 3191171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 31922c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->coarsen,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name); 319347a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 319447c6ae99SBarry Smith ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr); 3195b9d85ea2SLisandro Dalcin if (*dmc) { 3196a3574896SRichard Tran Mills (*dmc)->bind_below = dm->bind_below; /* Propagate this from parent DM; otherwise -dm_bind_below will be useless for multigrid cases. */ 3197a8fb8f29SToby Isaac ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr); 319843842a1eSJed Brown (*dmc)->ops->creatematrix = dm->ops->creatematrix; 31998cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr); 3200644e2e5bSBarry Smith (*dmc)->ctx = dm->ctx; 32010598a293SJed Brown (*dmc)->levelup = dm->levelup; 3202656b349aSBarry Smith (*dmc)->leveldown = dm->leveldown + 1; 3203e4b4b23bSJed Brown ierr = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr); 3204b17ce1afSJed Brown for (link=dm->coarsenhook; link; link=link->next) { 3205b17ce1afSJed Brown if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);} 3206b17ce1afSJed Brown } 3207b9d85ea2SLisandro Dalcin } 320847a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 32092c71b3e2SJacob Faibussowitsch PetscCheckFalse(!(*dmc),PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced"); 3210b17ce1afSJed Brown PetscFunctionReturn(0); 3211b17ce1afSJed Brown } 3212b17ce1afSJed Brown 3213bb9467b5SJed Brown /*@C 3214b17ce1afSJed Brown DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid 3215b17ce1afSJed Brown 3216b17ce1afSJed Brown Logically Collective 3217b17ce1afSJed Brown 32184165533cSJose E. Roman Input Parameters: 3219b17ce1afSJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 3220b17ce1afSJed Brown . coarsenhook - function to run when setting up a coarser level 3221b17ce1afSJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 32220298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3223b17ce1afSJed Brown 3224b17ce1afSJed Brown Calling sequence of coarsenhook: 3225b17ce1afSJed Brown $ coarsenhook(DM fine,DM coarse,void *ctx); 3226b17ce1afSJed Brown 3227b17ce1afSJed Brown + fine - fine level DM 3228b17ce1afSJed Brown . coarse - coarse level DM to restrict problem to 3229b17ce1afSJed Brown - ctx - optional user-defined function context 3230b17ce1afSJed Brown 3231b17ce1afSJed Brown Calling sequence for restricthook: 3232c833c3b5SJed Brown $ restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx) 3233b17ce1afSJed Brown 3234b17ce1afSJed Brown + fine - fine level DM 3235b17ce1afSJed Brown . mrestrict - matrix restricting a fine-level solution to the coarse grid 3236c833c3b5SJed Brown . rscale - scaling vector for restriction 3237c833c3b5SJed Brown . inject - matrix restricting by injection 3238b17ce1afSJed Brown . coarse - coarse level DM to update 3239b17ce1afSJed Brown - ctx - optional user-defined function context 3240b17ce1afSJed Brown 3241b17ce1afSJed Brown Level: advanced 3242b17ce1afSJed Brown 3243b17ce1afSJed Brown Notes: 3244b17ce1afSJed Brown This function is only needed if auxiliary data needs to be set up on coarse grids. 3245b17ce1afSJed Brown 3246b17ce1afSJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 3247b17ce1afSJed Brown 3248b17ce1afSJed Brown In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3249b17ce1afSJed Brown extract the finest level information from its context (instead of from the SNES). 3250b17ce1afSJed Brown 3251bb9467b5SJed Brown This function is currently not available from Fortran. 3252bb9467b5SJed Brown 3253dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3254b17ce1afSJed Brown @*/ 3255b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 3256b17ce1afSJed Brown { 3257b17ce1afSJed Brown PetscErrorCode ierr; 3258b17ce1afSJed Brown DMCoarsenHookLink link,*p; 3259b17ce1afSJed Brown 3260b17ce1afSJed Brown PetscFunctionBegin; 3261b17ce1afSJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 32621e3d8eccSJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 32631e3d8eccSJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 32641e3d8eccSJed Brown } 326595dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 3266b17ce1afSJed Brown link->coarsenhook = coarsenhook; 3267b17ce1afSJed Brown link->restricthook = restricthook; 3268b17ce1afSJed Brown link->ctx = ctx; 32690298fd71SBarry Smith link->next = NULL; 3270b17ce1afSJed Brown *p = link; 3271b17ce1afSJed Brown PetscFunctionReturn(0); 3272b17ce1afSJed Brown } 3273b17ce1afSJed Brown 3274dc822a44SJed Brown /*@C 3275dc822a44SJed Brown DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid 3276dc822a44SJed Brown 3277dc822a44SJed Brown Logically Collective 3278dc822a44SJed Brown 32794165533cSJose E. Roman Input Parameters: 3280dc822a44SJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 3281dc822a44SJed Brown . coarsenhook - function to run when setting up a coarser level 3282dc822a44SJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 3283dc822a44SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3284dc822a44SJed Brown 3285dc822a44SJed Brown Level: advanced 3286dc822a44SJed Brown 3287dc822a44SJed Brown Notes: 3288dc822a44SJed Brown This function does nothing if the hook is not in the list. 3289dc822a44SJed Brown 3290dc822a44SJed Brown This function is currently not available from Fortran. 3291dc822a44SJed Brown 3292dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3293dc822a44SJed Brown @*/ 3294dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 3295dc822a44SJed Brown { 3296dc822a44SJed Brown PetscErrorCode ierr; 3297dc822a44SJed Brown DMCoarsenHookLink link,*p; 3298dc822a44SJed Brown 3299dc822a44SJed Brown PetscFunctionBegin; 3300dc822a44SJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 3301dc822a44SJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3302dc822a44SJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3303dc822a44SJed Brown link = *p; 3304dc822a44SJed Brown *p = link->next; 3305dc822a44SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3306dc822a44SJed Brown break; 3307dc822a44SJed Brown } 3308dc822a44SJed Brown } 3309dc822a44SJed Brown PetscFunctionReturn(0); 3310dc822a44SJed Brown } 3311dc822a44SJed Brown 3312b17ce1afSJed Brown /*@ 3313b17ce1afSJed Brown DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd() 3314b17ce1afSJed Brown 3315b17ce1afSJed Brown Collective if any hooks are 3316b17ce1afSJed Brown 33174165533cSJose E. Roman Input Parameters: 3318b17ce1afSJed Brown + fine - finer DM to use as a base 3319b17ce1afSJed Brown . restrct - restriction matrix, apply using MatRestrict() 3320e91eccc2SStefano Zampini . rscale - scaling vector for restriction 3321b17ce1afSJed Brown . inject - injection matrix, also use MatRestrict() 3322e91eccc2SStefano Zampini - coarse - coarser DM to update 3323b17ce1afSJed Brown 3324b17ce1afSJed Brown Level: developer 3325b17ce1afSJed Brown 3326b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict() 3327b17ce1afSJed Brown @*/ 3328b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse) 3329b17ce1afSJed Brown { 3330b17ce1afSJed Brown PetscErrorCode ierr; 3331b17ce1afSJed Brown DMCoarsenHookLink link; 3332b17ce1afSJed Brown 3333b17ce1afSJed Brown PetscFunctionBegin; 3334b17ce1afSJed Brown for (link=fine->coarsenhook; link; link=link->next) { 33358865f1eaSKarl Rupp if (link->restricthook) { 33368865f1eaSKarl Rupp ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr); 33378865f1eaSKarl Rupp } 3338b17ce1afSJed Brown } 333947c6ae99SBarry Smith PetscFunctionReturn(0); 334047c6ae99SBarry Smith } 334147c6ae99SBarry Smith 3342bb9467b5SJed Brown /*@C 3343be081cd6SPeter Brune DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid 33445dbd56e3SPeter Brune 3345d083f849SBarry Smith Logically Collective on global 33465dbd56e3SPeter Brune 33474165533cSJose E. Roman Input Parameters: 33485dbd56e3SPeter Brune + global - global DM 3349ec4806b8SPeter Brune . ddhook - function to run to pass data to the decomposition DM upon its creation 33505dbd56e3SPeter Brune . restricthook - function to run to update data on block solve (at the beginning of the block solve) 33510298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 33525dbd56e3SPeter Brune 3353ec4806b8SPeter Brune Calling sequence for ddhook: 3354ec4806b8SPeter Brune $ ddhook(DM global,DM block,void *ctx) 3355ec4806b8SPeter Brune 3356ec4806b8SPeter Brune + global - global DM 3357ec4806b8SPeter Brune . block - block DM 3358ec4806b8SPeter Brune - ctx - optional user-defined function context 3359ec4806b8SPeter Brune 33605dbd56e3SPeter Brune Calling sequence for restricthook: 3361ec4806b8SPeter Brune $ restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx) 33625dbd56e3SPeter Brune 33635dbd56e3SPeter Brune + global - global DM 33645dbd56e3SPeter Brune . out - scatter to the outer (with ghost and overlap points) block vector 33655dbd56e3SPeter Brune . in - scatter to block vector values only owned locally 3366ec4806b8SPeter Brune . block - block DM 33675dbd56e3SPeter Brune - ctx - optional user-defined function context 33685dbd56e3SPeter Brune 33695dbd56e3SPeter Brune Level: advanced 33705dbd56e3SPeter Brune 33715dbd56e3SPeter Brune Notes: 3372ec4806b8SPeter Brune This function is only needed if auxiliary data needs to be set up on subdomain DMs. 33735dbd56e3SPeter Brune 33745dbd56e3SPeter Brune If this function is called multiple times, the hooks will be run in the order they are added. 33755dbd56e3SPeter Brune 33765dbd56e3SPeter Brune In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3377ec4806b8SPeter Brune extract the global information from its context (instead of from the SNES). 33785dbd56e3SPeter Brune 3379bb9467b5SJed Brown This function is currently not available from Fortran. 3380bb9467b5SJed Brown 33815dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 33825dbd56e3SPeter Brune @*/ 3383be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 33845dbd56e3SPeter Brune { 33855dbd56e3SPeter Brune PetscErrorCode ierr; 3386be081cd6SPeter Brune DMSubDomainHookLink link,*p; 33875dbd56e3SPeter Brune 33885dbd56e3SPeter Brune PetscFunctionBegin; 33895dbd56e3SPeter Brune PetscValidHeaderSpecific(global,DM_CLASSID,1); 3390b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 3391b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 3392b3a6b972SJed Brown } 339395dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 33945dbd56e3SPeter Brune link->restricthook = restricthook; 3395be081cd6SPeter Brune link->ddhook = ddhook; 33965dbd56e3SPeter Brune link->ctx = ctx; 33970298fd71SBarry Smith link->next = NULL; 33985dbd56e3SPeter Brune *p = link; 33995dbd56e3SPeter Brune PetscFunctionReturn(0); 34005dbd56e3SPeter Brune } 34015dbd56e3SPeter Brune 3402b3a6b972SJed Brown /*@C 3403b3a6b972SJed Brown DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid 3404b3a6b972SJed Brown 3405b3a6b972SJed Brown Logically Collective 3406b3a6b972SJed Brown 34074165533cSJose E. Roman Input Parameters: 3408b3a6b972SJed Brown + global - global DM 3409b3a6b972SJed Brown . ddhook - function to run to pass data to the decomposition DM upon its creation 3410b3a6b972SJed Brown . restricthook - function to run to update data on block solve (at the beginning of the block solve) 3411b3a6b972SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3412b3a6b972SJed Brown 3413b3a6b972SJed Brown Level: advanced 3414b3a6b972SJed Brown 3415b3a6b972SJed Brown Notes: 3416b3a6b972SJed Brown 3417b3a6b972SJed Brown This function is currently not available from Fortran. 3418b3a6b972SJed Brown 3419b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3420b3a6b972SJed Brown @*/ 3421b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 3422b3a6b972SJed Brown { 3423b3a6b972SJed Brown PetscErrorCode ierr; 3424b3a6b972SJed Brown DMSubDomainHookLink link,*p; 3425b3a6b972SJed Brown 3426b3a6b972SJed Brown PetscFunctionBegin; 3427b3a6b972SJed Brown PetscValidHeaderSpecific(global,DM_CLASSID,1); 3428b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3429b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3430b3a6b972SJed Brown link = *p; 3431b3a6b972SJed Brown *p = link->next; 3432b3a6b972SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3433b3a6b972SJed Brown break; 3434b3a6b972SJed Brown } 3435b3a6b972SJed Brown } 3436b3a6b972SJed Brown PetscFunctionReturn(0); 3437b3a6b972SJed Brown } 3438b3a6b972SJed Brown 34395dbd56e3SPeter Brune /*@ 3440be081cd6SPeter Brune DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd() 34415dbd56e3SPeter Brune 34425dbd56e3SPeter Brune Collective if any hooks are 34435dbd56e3SPeter Brune 34444165533cSJose E. Roman Input Parameters: 34455dbd56e3SPeter Brune + fine - finer DM to use as a base 3446be081cd6SPeter Brune . oscatter - scatter from domain global vector filling subdomain global vector with overlap 3447be081cd6SPeter Brune . gscatter - scatter from domain global vector filling subdomain local vector with ghosts 34485dbd56e3SPeter Brune - coarse - coarer DM to update 34495dbd56e3SPeter Brune 34505dbd56e3SPeter Brune Level: developer 34515dbd56e3SPeter Brune 34525dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict() 34535dbd56e3SPeter Brune @*/ 3454be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm) 34555dbd56e3SPeter Brune { 34565dbd56e3SPeter Brune PetscErrorCode ierr; 3457be081cd6SPeter Brune DMSubDomainHookLink link; 34585dbd56e3SPeter Brune 34595dbd56e3SPeter Brune PetscFunctionBegin; 3460be081cd6SPeter Brune for (link=global->subdomainhook; link; link=link->next) { 34618865f1eaSKarl Rupp if (link->restricthook) { 34628865f1eaSKarl Rupp ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr); 34638865f1eaSKarl Rupp } 34645dbd56e3SPeter Brune } 34655dbd56e3SPeter Brune PetscFunctionReturn(0); 34665dbd56e3SPeter Brune } 34675dbd56e3SPeter Brune 34685fe1f584SPeter Brune /*@ 34696a7d9d85SPeter Brune DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM. 34705fe1f584SPeter Brune 34715fe1f584SPeter Brune Not Collective 34725fe1f584SPeter Brune 34735fe1f584SPeter Brune Input Parameter: 34745fe1f584SPeter Brune . dm - the DM object 34755fe1f584SPeter Brune 34765fe1f584SPeter Brune Output Parameter: 34776a7d9d85SPeter Brune . level - number of coarsenings 34785fe1f584SPeter Brune 34795fe1f584SPeter Brune Level: developer 34805fe1f584SPeter Brune 34816a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 34825fe1f584SPeter Brune 34835fe1f584SPeter Brune @*/ 34845fe1f584SPeter Brune PetscErrorCode DMGetCoarsenLevel(DM dm,PetscInt *level) 34855fe1f584SPeter Brune { 34865fe1f584SPeter Brune PetscFunctionBegin; 34875fe1f584SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3488b9d85ea2SLisandro Dalcin PetscValidIntPointer(level,2); 34895fe1f584SPeter Brune *level = dm->leveldown; 34905fe1f584SPeter Brune PetscFunctionReturn(0); 34915fe1f584SPeter Brune } 34925fe1f584SPeter Brune 34939a64c4a8SMatthew G. Knepley /*@ 34949a64c4a8SMatthew G. Knepley DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM. 34959a64c4a8SMatthew G. Knepley 34969a64c4a8SMatthew G. Knepley Not Collective 34979a64c4a8SMatthew G. Knepley 34989a64c4a8SMatthew G. Knepley Input Parameters: 34999a64c4a8SMatthew G. Knepley + dm - the DM object 35009a64c4a8SMatthew G. Knepley - level - number of coarsenings 35019a64c4a8SMatthew G. Knepley 35029a64c4a8SMatthew G. Knepley Level: developer 35039a64c4a8SMatthew G. Knepley 35049a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 35059a64c4a8SMatthew G. Knepley @*/ 35069a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level) 35079a64c4a8SMatthew G. Knepley { 35089a64c4a8SMatthew G. Knepley PetscFunctionBegin; 35099a64c4a8SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35109a64c4a8SMatthew G. Knepley dm->leveldown = level; 35119a64c4a8SMatthew G. Knepley PetscFunctionReturn(0); 35129a64c4a8SMatthew G. Knepley } 35139a64c4a8SMatthew G. Knepley 351447c6ae99SBarry Smith /*@C 351547c6ae99SBarry Smith DMRefineHierarchy - Refines a DM object, all levels at once 351647c6ae99SBarry Smith 3517d083f849SBarry Smith Collective on dm 351847c6ae99SBarry Smith 3519d8d19677SJose E. Roman Input Parameters: 352047c6ae99SBarry Smith + dm - the DM object 352147c6ae99SBarry Smith - nlevels - the number of levels of refinement 352247c6ae99SBarry Smith 352347c6ae99SBarry Smith Output Parameter: 352447c6ae99SBarry Smith . dmf - the refined DM hierarchy 352547c6ae99SBarry Smith 352647c6ae99SBarry Smith Level: developer 352747c6ae99SBarry Smith 3528e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 352947c6ae99SBarry Smith 353047c6ae99SBarry Smith @*/ 35317087cfbeSBarry Smith PetscErrorCode DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[]) 353247c6ae99SBarry Smith { 353347c6ae99SBarry Smith PetscErrorCode ierr; 353447c6ae99SBarry Smith 353547c6ae99SBarry Smith PetscFunctionBegin; 3536171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35372c71b3e2SJacob Faibussowitsch PetscCheckFalse(nlevels < 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 353847c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 3539b9d85ea2SLisandro Dalcin PetscValidPointer(dmf,3); 354047c6ae99SBarry Smith if (dm->ops->refinehierarchy) { 354147c6ae99SBarry Smith ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr); 354247c6ae99SBarry Smith } else if (dm->ops->refine) { 354347c6ae99SBarry Smith PetscInt i; 354447c6ae99SBarry Smith 3545ce94432eSBarry Smith ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr); 354647c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3547ce94432eSBarry Smith ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr); 354847c6ae99SBarry Smith } 3549ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet"); 355047c6ae99SBarry Smith PetscFunctionReturn(0); 355147c6ae99SBarry Smith } 355247c6ae99SBarry Smith 355347c6ae99SBarry Smith /*@C 355447c6ae99SBarry Smith DMCoarsenHierarchy - Coarsens a DM object, all levels at once 355547c6ae99SBarry Smith 3556d083f849SBarry Smith Collective on dm 355747c6ae99SBarry Smith 3558d8d19677SJose E. Roman Input Parameters: 355947c6ae99SBarry Smith + dm - the DM object 356047c6ae99SBarry Smith - nlevels - the number of levels of coarsening 356147c6ae99SBarry Smith 356247c6ae99SBarry Smith Output Parameter: 356347c6ae99SBarry Smith . dmc - the coarsened DM hierarchy 356447c6ae99SBarry Smith 356547c6ae99SBarry Smith Level: developer 356647c6ae99SBarry Smith 3567e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 356847c6ae99SBarry Smith 356947c6ae99SBarry Smith @*/ 35707087cfbeSBarry Smith PetscErrorCode DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[]) 357147c6ae99SBarry Smith { 357247c6ae99SBarry Smith PetscErrorCode ierr; 357347c6ae99SBarry Smith 357447c6ae99SBarry Smith PetscFunctionBegin; 3575171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35762c71b3e2SJacob Faibussowitsch PetscCheckFalse(nlevels < 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 357747c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 357847c6ae99SBarry Smith PetscValidPointer(dmc,3); 357947c6ae99SBarry Smith if (dm->ops->coarsenhierarchy) { 358047c6ae99SBarry Smith ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr); 358147c6ae99SBarry Smith } else if (dm->ops->coarsen) { 358247c6ae99SBarry Smith PetscInt i; 358347c6ae99SBarry Smith 3584ce94432eSBarry Smith ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr); 358547c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3586ce94432eSBarry Smith ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr); 358747c6ae99SBarry Smith } 3588ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet"); 358947c6ae99SBarry Smith PetscFunctionReturn(0); 359047c6ae99SBarry Smith } 359147c6ae99SBarry Smith 35921a266240SBarry Smith /*@C 35931a266240SBarry Smith DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed 35941a266240SBarry Smith 35951a266240SBarry Smith Not Collective 35961a266240SBarry Smith 35971a266240SBarry Smith Input Parameters: 35981a266240SBarry Smith + dm - the DM object 35991a266240SBarry Smith - destroy - the destroy function 36001a266240SBarry Smith 36011a266240SBarry Smith Level: intermediate 36021a266240SBarry Smith 3603e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 36041a266240SBarry Smith 3605f07f9ceaSJed Brown @*/ 36061a266240SBarry Smith PetscErrorCode DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**)) 36071a266240SBarry Smith { 36081a266240SBarry Smith PetscFunctionBegin; 3609171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 36101a266240SBarry Smith dm->ctxdestroy = destroy; 36111a266240SBarry Smith PetscFunctionReturn(0); 36121a266240SBarry Smith } 36131a266240SBarry Smith 3614b07ff414SBarry Smith /*@ 36151b2093e4SBarry Smith DMSetApplicationContext - Set a user context into a DM object 361647c6ae99SBarry Smith 361747c6ae99SBarry Smith Not Collective 361847c6ae99SBarry Smith 361947c6ae99SBarry Smith Input Parameters: 362047c6ae99SBarry Smith + dm - the DM object 362147c6ae99SBarry Smith - ctx - the user context 362247c6ae99SBarry Smith 362347c6ae99SBarry Smith Level: intermediate 362447c6ae99SBarry Smith 3625e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 362647c6ae99SBarry Smith 362747c6ae99SBarry Smith @*/ 36281b2093e4SBarry Smith PetscErrorCode DMSetApplicationContext(DM dm,void *ctx) 362947c6ae99SBarry Smith { 363047c6ae99SBarry Smith PetscFunctionBegin; 3631171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 363247c6ae99SBarry Smith dm->ctx = ctx; 363347c6ae99SBarry Smith PetscFunctionReturn(0); 363447c6ae99SBarry Smith } 363547c6ae99SBarry Smith 363647c6ae99SBarry Smith /*@ 36371b2093e4SBarry Smith DMGetApplicationContext - Gets a user context from a DM object 363847c6ae99SBarry Smith 363947c6ae99SBarry Smith Not Collective 364047c6ae99SBarry Smith 364147c6ae99SBarry Smith Input Parameter: 364247c6ae99SBarry Smith . dm - the DM object 364347c6ae99SBarry Smith 364447c6ae99SBarry Smith Output Parameter: 364547c6ae99SBarry Smith . ctx - the user context 364647c6ae99SBarry Smith 364747c6ae99SBarry Smith Level: intermediate 364847c6ae99SBarry Smith 3649e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 365047c6ae99SBarry Smith 365147c6ae99SBarry Smith @*/ 36521b2093e4SBarry Smith PetscErrorCode DMGetApplicationContext(DM dm,void *ctx) 365347c6ae99SBarry Smith { 365447c6ae99SBarry Smith PetscFunctionBegin; 3655171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 36561b2093e4SBarry Smith *(void**)ctx = dm->ctx; 365747c6ae99SBarry Smith PetscFunctionReturn(0); 365847c6ae99SBarry Smith } 365947c6ae99SBarry Smith 366008da532bSDmitry Karpeev /*@C 3661df3898eeSBarry Smith DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI. 366208da532bSDmitry Karpeev 3663d083f849SBarry Smith Logically Collective on dm 366408da532bSDmitry Karpeev 3665d8d19677SJose E. Roman Input Parameters: 366608da532bSDmitry Karpeev + dm - the DM object 36670298fd71SBarry Smith - f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set) 366808da532bSDmitry Karpeev 366908da532bSDmitry Karpeev Level: intermediate 367008da532bSDmitry Karpeev 3671835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(), 367208da532bSDmitry Karpeev DMSetJacobian() 367308da532bSDmitry Karpeev 367408da532bSDmitry Karpeev @*/ 367508da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec)) 367608da532bSDmitry Karpeev { 367708da532bSDmitry Karpeev PetscFunctionBegin; 36785a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 367908da532bSDmitry Karpeev dm->ops->computevariablebounds = f; 368008da532bSDmitry Karpeev PetscFunctionReturn(0); 368108da532bSDmitry Karpeev } 368208da532bSDmitry Karpeev 368308da532bSDmitry Karpeev /*@ 368408da532bSDmitry Karpeev DMHasVariableBounds - does the DM object have a variable bounds function? 368508da532bSDmitry Karpeev 368608da532bSDmitry Karpeev Not Collective 368708da532bSDmitry Karpeev 368808da532bSDmitry Karpeev Input Parameter: 368908da532bSDmitry Karpeev . dm - the DM object to destroy 369008da532bSDmitry Karpeev 369108da532bSDmitry Karpeev Output Parameter: 369208da532bSDmitry Karpeev . flg - PETSC_TRUE if the variable bounds function exists 369308da532bSDmitry Karpeev 369408da532bSDmitry Karpeev Level: developer 369508da532bSDmitry Karpeev 369674e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 369708da532bSDmitry Karpeev 369808da532bSDmitry Karpeev @*/ 369908da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg) 370008da532bSDmitry Karpeev { 370108da532bSDmitry Karpeev PetscFunctionBegin; 37025a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3703534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 370408da532bSDmitry Karpeev *flg = (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE; 370508da532bSDmitry Karpeev PetscFunctionReturn(0); 370608da532bSDmitry Karpeev } 370708da532bSDmitry Karpeev 370808da532bSDmitry Karpeev /*@C 370908da532bSDmitry Karpeev DMComputeVariableBounds - compute variable bounds used by SNESVI. 371008da532bSDmitry Karpeev 3711d083f849SBarry Smith Logically Collective on dm 371208da532bSDmitry Karpeev 3713f899ff85SJose E. Roman Input Parameter: 3714907376e6SBarry Smith . dm - the DM object 371508da532bSDmitry Karpeev 371608da532bSDmitry Karpeev Output parameters: 371708da532bSDmitry Karpeev + xl - lower bound 371808da532bSDmitry Karpeev - xu - upper bound 371908da532bSDmitry Karpeev 3720907376e6SBarry Smith Level: advanced 3721907376e6SBarry Smith 372295452b02SPatrick Sanan Notes: 372395452b02SPatrick Sanan This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds() 372408da532bSDmitry Karpeev 372574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 372608da532bSDmitry Karpeev 372708da532bSDmitry Karpeev @*/ 372808da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu) 372908da532bSDmitry Karpeev { 373008da532bSDmitry Karpeev PetscErrorCode ierr; 37315fd66863SKarl Rupp 373208da532bSDmitry Karpeev PetscFunctionBegin; 37335a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 373408da532bSDmitry Karpeev PetscValidHeaderSpecific(xl,VEC_CLASSID,2); 37355a84ad33SLisandro Dalcin PetscValidHeaderSpecific(xu,VEC_CLASSID,3); 37362c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->computevariablebounds,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name); 373708da532bSDmitry Karpeev ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr); 373808da532bSDmitry Karpeev PetscFunctionReturn(0); 373908da532bSDmitry Karpeev } 374008da532bSDmitry Karpeev 3741b0ae01b7SPeter Brune /*@ 3742b0ae01b7SPeter Brune DMHasColoring - does the DM object have a method of providing a coloring? 3743b0ae01b7SPeter Brune 3744b0ae01b7SPeter Brune Not Collective 3745b0ae01b7SPeter Brune 3746b0ae01b7SPeter Brune Input Parameter: 3747b0ae01b7SPeter Brune . dm - the DM object 3748b0ae01b7SPeter Brune 3749b0ae01b7SPeter Brune Output Parameter: 3750b0ae01b7SPeter Brune . flg - PETSC_TRUE if the DM has facilities for DMCreateColoring(). 3751b0ae01b7SPeter Brune 3752b0ae01b7SPeter Brune Level: developer 3753b0ae01b7SPeter Brune 37541565f0a7SPatrick Sanan .seealso DMCreateColoring() 3755b0ae01b7SPeter Brune 3756b0ae01b7SPeter Brune @*/ 3757b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg) 3758b0ae01b7SPeter Brune { 3759b0ae01b7SPeter Brune PetscFunctionBegin; 37605a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3761534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 3762b0ae01b7SPeter Brune *flg = (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE; 3763b0ae01b7SPeter Brune PetscFunctionReturn(0); 3764b0ae01b7SPeter Brune } 3765b0ae01b7SPeter Brune 37663ad4599aSBarry Smith /*@ 37673ad4599aSBarry Smith DMHasCreateRestriction - does the DM object have a method of providing a restriction? 37683ad4599aSBarry Smith 37693ad4599aSBarry Smith Not Collective 37703ad4599aSBarry Smith 37713ad4599aSBarry Smith Input Parameter: 37723ad4599aSBarry Smith . dm - the DM object 37733ad4599aSBarry Smith 37743ad4599aSBarry Smith Output Parameter: 37753ad4599aSBarry Smith . flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction(). 37763ad4599aSBarry Smith 37773ad4599aSBarry Smith Level: developer 37783ad4599aSBarry Smith 37791565f0a7SPatrick Sanan .seealso DMCreateRestriction() 37803ad4599aSBarry Smith 37813ad4599aSBarry Smith @*/ 37823ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg) 37833ad4599aSBarry Smith { 37843ad4599aSBarry Smith PetscFunctionBegin; 37855a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3786534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 37873ad4599aSBarry Smith *flg = (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE; 37883ad4599aSBarry Smith PetscFunctionReturn(0); 37893ad4599aSBarry Smith } 37903ad4599aSBarry Smith 3791a7058e45SLawrence Mitchell /*@ 3792a7058e45SLawrence Mitchell DMHasCreateInjection - does the DM object have a method of providing an injection? 3793a7058e45SLawrence Mitchell 3794a7058e45SLawrence Mitchell Not Collective 3795a7058e45SLawrence Mitchell 3796a7058e45SLawrence Mitchell Input Parameter: 3797a7058e45SLawrence Mitchell . dm - the DM object 3798a7058e45SLawrence Mitchell 3799a7058e45SLawrence Mitchell Output Parameter: 3800a7058e45SLawrence Mitchell . flg - PETSC_TRUE if the DM has facilities for DMCreateInjection(). 3801a7058e45SLawrence Mitchell 3802a7058e45SLawrence Mitchell Level: developer 3803a7058e45SLawrence Mitchell 38041565f0a7SPatrick Sanan .seealso DMCreateInjection() 3805a7058e45SLawrence Mitchell 3806a7058e45SLawrence Mitchell @*/ 3807a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg) 3808a7058e45SLawrence Mitchell { 38094a7a4c06SLawrence Mitchell PetscErrorCode ierr; 38105a84ad33SLisandro Dalcin 3811a7058e45SLawrence Mitchell PetscFunctionBegin; 38125a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3813534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 38145a84ad33SLisandro Dalcin if (dm->ops->hascreateinjection) { 38154a7a4c06SLawrence Mitchell ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr); 38165a84ad33SLisandro Dalcin } else { 38175a84ad33SLisandro Dalcin *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE; 38185a84ad33SLisandro Dalcin } 3819a7058e45SLawrence Mitchell PetscFunctionReturn(0); 3820a7058e45SLawrence Mitchell } 3821a7058e45SLawrence Mitchell 38220298fd71SBarry Smith PetscFunctionList DMList = NULL; 3823264ace61SBarry Smith PetscBool DMRegisterAllCalled = PETSC_FALSE; 3824264ace61SBarry Smith 3825264ace61SBarry Smith /*@C 3826264ace61SBarry Smith DMSetType - Builds a DM, for a particular DM implementation. 3827264ace61SBarry Smith 3828d083f849SBarry Smith Collective on dm 3829264ace61SBarry Smith 3830264ace61SBarry Smith Input Parameters: 3831264ace61SBarry Smith + dm - The DM object 3832264ace61SBarry Smith - method - The name of the DM type 3833264ace61SBarry Smith 3834264ace61SBarry Smith Options Database Key: 3835264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types 3836264ace61SBarry Smith 3837264ace61SBarry Smith Notes: 3838e1589f56SBarry Smith See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D). 3839264ace61SBarry Smith 3840264ace61SBarry Smith Level: intermediate 3841264ace61SBarry Smith 3842264ace61SBarry Smith .seealso: DMGetType(), DMCreate() 3843264ace61SBarry Smith @*/ 384419fd82e9SBarry Smith PetscErrorCode DMSetType(DM dm, DMType method) 3845264ace61SBarry Smith { 3846264ace61SBarry Smith PetscErrorCode (*r)(DM); 3847264ace61SBarry Smith PetscBool match; 3848264ace61SBarry Smith PetscErrorCode ierr; 3849264ace61SBarry Smith 3850264ace61SBarry Smith PetscFunctionBegin; 3851264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3852251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr); 3853264ace61SBarry Smith if (match) PetscFunctionReturn(0); 3854264ace61SBarry Smith 38550f51fdf8SToby Isaac ierr = DMRegisterAll();CHKERRQ(ierr); 38561c9cd337SJed Brown ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr); 38572c71b3e2SJacob Faibussowitsch PetscCheckFalse(!r,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method); 3858264ace61SBarry Smith 3859264ace61SBarry Smith if (dm->ops->destroy) { 3860264ace61SBarry Smith ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr); 3861264ace61SBarry Smith } 3862d57f96a3SLisandro Dalcin ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr); 3863264ace61SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr); 3864d57f96a3SLisandro Dalcin ierr = (*r)(dm);CHKERRQ(ierr); 3865264ace61SBarry Smith PetscFunctionReturn(0); 3866264ace61SBarry Smith } 3867264ace61SBarry Smith 3868264ace61SBarry Smith /*@C 3869264ace61SBarry Smith DMGetType - Gets the DM type name (as a string) from the DM. 3870264ace61SBarry Smith 3871264ace61SBarry Smith Not Collective 3872264ace61SBarry Smith 3873264ace61SBarry Smith Input Parameter: 3874264ace61SBarry Smith . dm - The DM 3875264ace61SBarry Smith 3876264ace61SBarry Smith Output Parameter: 3877264ace61SBarry Smith . type - The DM type name 3878264ace61SBarry Smith 3879264ace61SBarry Smith Level: intermediate 3880264ace61SBarry Smith 3881264ace61SBarry Smith .seealso: DMSetType(), DMCreate() 3882264ace61SBarry Smith @*/ 388319fd82e9SBarry Smith PetscErrorCode DMGetType(DM dm, DMType *type) 3884264ace61SBarry Smith { 3885264ace61SBarry Smith PetscErrorCode ierr; 3886264ace61SBarry Smith 3887264ace61SBarry Smith PetscFunctionBegin; 3888264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3889c959eef4SJed Brown PetscValidPointer(type,2); 3890607a6623SBarry Smith ierr = DMRegisterAll();CHKERRQ(ierr); 3891264ace61SBarry Smith *type = ((PetscObject)dm)->type_name; 3892264ace61SBarry Smith PetscFunctionReturn(0); 3893264ace61SBarry Smith } 3894264ace61SBarry Smith 389567a56275SMatthew G Knepley /*@C 389667a56275SMatthew G Knepley DMConvert - Converts a DM to another DM, either of the same or different type. 389767a56275SMatthew G Knepley 3898d083f849SBarry Smith Collective on dm 389967a56275SMatthew G Knepley 390067a56275SMatthew G Knepley Input Parameters: 390167a56275SMatthew G Knepley + dm - the DM 390267a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type) 390367a56275SMatthew G Knepley 390467a56275SMatthew G Knepley Output Parameter: 390567a56275SMatthew G Knepley . M - pointer to new DM 390667a56275SMatthew G Knepley 390767a56275SMatthew G Knepley Notes: 390867a56275SMatthew G Knepley Cannot be used to convert a sequential DM to parallel or parallel to sequential, 390967a56275SMatthew G Knepley the MPI communicator of the generated DM is always the same as the communicator 391067a56275SMatthew G Knepley of the input DM. 391167a56275SMatthew G Knepley 391267a56275SMatthew G Knepley Level: intermediate 391367a56275SMatthew G Knepley 391467a56275SMatthew G Knepley .seealso: DMCreate() 391567a56275SMatthew G Knepley @*/ 391619fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M) 391767a56275SMatthew G Knepley { 391867a56275SMatthew G Knepley DM B; 391967a56275SMatthew G Knepley char convname[256]; 3920c067b6caSMatthew G. Knepley PetscBool sametype/*, issame */; 392167a56275SMatthew G Knepley PetscErrorCode ierr; 392267a56275SMatthew G Knepley 392367a56275SMatthew G Knepley PetscFunctionBegin; 392467a56275SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 392567a56275SMatthew G Knepley PetscValidType(dm,1); 392667a56275SMatthew G Knepley PetscValidPointer(M,3); 3927251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr); 3928c067b6caSMatthew G. Knepley /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */ 3929c067b6caSMatthew G. Knepley if (sametype) { 3930c067b6caSMatthew G. Knepley *M = dm; 3931c067b6caSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr); 3932c067b6caSMatthew G. Knepley PetscFunctionReturn(0); 3933c067b6caSMatthew G. Knepley } else { 39340298fd71SBarry Smith PetscErrorCode (*conv)(DM, DMType, DM*) = NULL; 393567a56275SMatthew G Knepley 393667a56275SMatthew G Knepley /* 393767a56275SMatthew G Knepley Order of precedence: 393867a56275SMatthew G Knepley 1) See if a specialized converter is known to the current DM. 393967a56275SMatthew G Knepley 2) See if a specialized converter is known to the desired DM class. 394067a56275SMatthew G Knepley 3) See if a good general converter is registered for the desired class 394167a56275SMatthew G Knepley 4) See if a good general converter is known for the current matrix. 394267a56275SMatthew G Knepley 5) Use a really basic converter. 394367a56275SMatthew G Knepley */ 394467a56275SMatthew G Knepley 394567a56275SMatthew G Knepley /* 1) See if a specialized converter is known to the current DM and the desired class */ 3946a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3947a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3948a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3949a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3950a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 39510005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr); 395267a56275SMatthew G Knepley if (conv) goto foundconv; 395367a56275SMatthew G Knepley 395467a56275SMatthew G Knepley /* 2) See if a specialized converter is known to the desired DM class. */ 395582f516ccSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr); 395667a56275SMatthew G Knepley ierr = DMSetType(B, newtype);CHKERRQ(ierr); 3957a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3958a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3959a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3960a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3961a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 39620005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr); 396367a56275SMatthew G Knepley if (conv) { 3964fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 396567a56275SMatthew G Knepley goto foundconv; 396667a56275SMatthew G Knepley } 396767a56275SMatthew G Knepley 396867a56275SMatthew G Knepley #if 0 396967a56275SMatthew G Knepley /* 3) See if a good general converter is registered for the desired class */ 397067a56275SMatthew G Knepley conv = B->ops->convertfrom; 3971fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 397267a56275SMatthew G Knepley if (conv) goto foundconv; 397367a56275SMatthew G Knepley 397467a56275SMatthew G Knepley /* 4) See if a good general converter is known for the current matrix */ 397567a56275SMatthew G Knepley if (dm->ops->convert) { 397667a56275SMatthew G Knepley conv = dm->ops->convert; 397767a56275SMatthew G Knepley } 397867a56275SMatthew G Knepley if (conv) goto foundconv; 397967a56275SMatthew G Knepley #endif 398067a56275SMatthew G Knepley 398167a56275SMatthew G Knepley /* 5) Use a really basic converter. */ 398298921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype); 398367a56275SMatthew G Knepley 398467a56275SMatthew G Knepley foundconv: 398567a56275SMatthew G Knepley ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 398667a56275SMatthew G Knepley ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr); 398712fa691eSMatthew G. Knepley /* Things that are independent of DM type: We should consult DMClone() here */ 398890b157c4SStefano Zampini { 398990b157c4SStefano Zampini PetscBool isper; 399012fa691eSMatthew G. Knepley const PetscReal *maxCell, *L; 399112fa691eSMatthew G. Knepley const DMBoundaryType *bd; 399290b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 399390b157c4SStefano Zampini ierr = DMSetPeriodicity(*M, isper, maxCell, L, bd);CHKERRQ(ierr); 3994c8a6034eSMark (*M)->prealloc_only = dm->prealloc_only; 3995a587d139SMark ierr = PetscFree((*M)->vectype);CHKERRQ(ierr); 3996a587d139SMark ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr); 3997a587d139SMark ierr = PetscFree((*M)->mattype);CHKERRQ(ierr); 3998a587d139SMark ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr); 399912fa691eSMatthew G. Knepley } 400067a56275SMatthew G Knepley ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 400167a56275SMatthew G Knepley } 400267a56275SMatthew G Knepley ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr); 400367a56275SMatthew G Knepley PetscFunctionReturn(0); 400467a56275SMatthew G Knepley } 4005264ace61SBarry Smith 4006264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/ 4007264ace61SBarry Smith 4008264ace61SBarry Smith /*@C 40091c84c290SBarry Smith DMRegister - Adds a new DM component implementation 40101c84c290SBarry Smith 40111c84c290SBarry Smith Not Collective 40121c84c290SBarry Smith 40131c84c290SBarry Smith Input Parameters: 40141c84c290SBarry Smith + name - The name of a new user-defined creation routine 40151c84c290SBarry Smith - create_func - The creation routine itself 40161c84c290SBarry Smith 40171c84c290SBarry Smith Notes: 40181c84c290SBarry Smith DMRegister() may be called multiple times to add several user-defined DMs 40191c84c290SBarry Smith 40201c84c290SBarry Smith Sample usage: 40211c84c290SBarry Smith .vb 4022bdf89e91SBarry Smith DMRegister("my_da", MyDMCreate); 40231c84c290SBarry Smith .ve 40241c84c290SBarry Smith 40251c84c290SBarry Smith Then, your DM type can be chosen with the procedural interface via 40261c84c290SBarry Smith .vb 40271c84c290SBarry Smith DMCreate(MPI_Comm, DM *); 40281c84c290SBarry Smith DMSetType(DM,"my_da"); 40291c84c290SBarry Smith .ve 40301c84c290SBarry Smith or at runtime via the option 40311c84c290SBarry Smith .vb 40321c84c290SBarry Smith -da_type my_da 40331c84c290SBarry Smith .ve 4034264ace61SBarry Smith 4035264ace61SBarry Smith Level: advanced 40361c84c290SBarry Smith 4037bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy() 40381c84c290SBarry Smith 4039264ace61SBarry Smith @*/ 4040bdf89e91SBarry Smith PetscErrorCode DMRegister(const char sname[],PetscErrorCode (*function)(DM)) 4041264ace61SBarry Smith { 4042264ace61SBarry Smith PetscErrorCode ierr; 4043264ace61SBarry Smith 4044264ace61SBarry Smith PetscFunctionBegin; 40451d36bdfdSBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 4046a240a19fSJed Brown ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr); 4047264ace61SBarry Smith PetscFunctionReturn(0); 4048264ace61SBarry Smith } 4049264ace61SBarry Smith 4050b859378eSBarry Smith /*@C 405155849f57SBarry Smith DMLoad - Loads a DM that has been stored in binary with DMView(). 4052b859378eSBarry Smith 4053d083f849SBarry Smith Collective on viewer 4054b859378eSBarry Smith 4055b859378eSBarry Smith Input Parameters: 4056b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or 4057b859378eSBarry Smith some related function before a call to DMLoad(). 4058b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or 4059b859378eSBarry Smith HDF5 file viewer, obtained from PetscViewerHDF5Open() 4060b859378eSBarry Smith 4061b859378eSBarry Smith Level: intermediate 4062b859378eSBarry Smith 4063b859378eSBarry Smith Notes: 406455849f57SBarry Smith The type is determined by the data in the file, any type set into the DM before this call is ignored. 4065b859378eSBarry Smith 4066cd7e8a5eSksagiyam Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex 4067cd7e8a5eSksagiyam meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName() 4068cd7e8a5eSksagiyam before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object. 4069cd7e8a5eSksagiyam 4070b859378eSBarry Smith Notes for advanced users: 4071b859378eSBarry Smith Most users should not need to know the details of the binary storage 4072b859378eSBarry Smith format, since DMLoad() and DMView() completely hide these details. 4073b859378eSBarry Smith But for anyone who's interested, the standard binary matrix storage 4074b859378eSBarry Smith format is 4075b859378eSBarry Smith .vb 4076b859378eSBarry Smith has not yet been determined 4077b859378eSBarry Smith .ve 4078b859378eSBarry Smith 4079b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad() 4080b859378eSBarry Smith @*/ 4081b859378eSBarry Smith PetscErrorCode DMLoad(DM newdm, PetscViewer viewer) 4082b859378eSBarry Smith { 40839331c7a4SMatthew G. Knepley PetscBool isbinary, ishdf5; 4084b859378eSBarry Smith PetscErrorCode ierr; 4085b859378eSBarry Smith 4086b859378eSBarry Smith PetscFunctionBegin; 4087b859378eSBarry Smith PetscValidHeaderSpecific(newdm,DM_CLASSID,1); 4088b859378eSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 4089fb694a9eSVaclav Hapla ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr); 409032c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 40919331c7a4SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr); 409258cd63d5SVaclav Hapla ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr); 40939331c7a4SMatthew G. Knepley if (isbinary) { 40949331c7a4SMatthew G. Knepley PetscInt classid; 40959331c7a4SMatthew G. Knepley char type[256]; 4096b859378eSBarry Smith 4097060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 40982c71b3e2SJacob Faibussowitsch PetscCheckFalse(classid != DM_FILE_CLASSID,PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid); 4099060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 410032c0f0efSBarry Smith ierr = DMSetType(newdm, type);CHKERRQ(ierr); 41019331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 41029331c7a4SMatthew G. Knepley } else if (ishdf5) { 41039331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 41049331c7a4SMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()"); 410558cd63d5SVaclav Hapla ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr); 4106b859378eSBarry Smith PetscFunctionReturn(0); 4107b859378eSBarry Smith } 4108b859378eSBarry Smith 4109b2e4378dSMatthew G. Knepley /*@ 4110b2e4378dSMatthew G. Knepley DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process. 4111b2e4378dSMatthew G. Knepley 4112b2e4378dSMatthew G. Knepley Not collective 4113b2e4378dSMatthew G. Knepley 4114b2e4378dSMatthew G. Knepley Input Parameter: 4115b2e4378dSMatthew G. Knepley . dm - the DM 4116b2e4378dSMatthew G. Knepley 4117b2e4378dSMatthew G. Knepley Output Parameters: 4118b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional) 4119b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional) 4120b2e4378dSMatthew G. Knepley 4121b2e4378dSMatthew G. Knepley Level: beginner 4122b2e4378dSMatthew G. Knepley 4123b2e4378dSMatthew G. Knepley Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead. 4124b2e4378dSMatthew G. Knepley 4125b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox() 4126b2e4378dSMatthew G. Knepley @*/ 4127b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[]) 4128b2e4378dSMatthew G. Knepley { 4129b2e4378dSMatthew G. Knepley Vec coords = NULL; 4130b2e4378dSMatthew G. Knepley PetscReal min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL}; 4131b2e4378dSMatthew G. Knepley PetscReal max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL}; 4132b2e4378dSMatthew G. Knepley const PetscScalar *local_coords; 4133b2e4378dSMatthew G. Knepley PetscInt N, Ni; 4134b2e4378dSMatthew G. Knepley PetscInt cdim, i, j; 4135b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 4136b2e4378dSMatthew G. Knepley 4137b2e4378dSMatthew G. Knepley PetscFunctionBegin; 4138b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4139b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 4140b2e4378dSMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 4141b2e4378dSMatthew G. Knepley if (coords) { 4142b2e4378dSMatthew G. Knepley ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr); 4143b2e4378dSMatthew G. Knepley ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr); 4144b2e4378dSMatthew G. Knepley Ni = N/cdim; 4145b2e4378dSMatthew G. Knepley for (i = 0; i < Ni; ++i) { 4146b2e4378dSMatthew G. Knepley for (j = 0; j < 3; ++j) { 4147b2e4378dSMatthew G. Knepley min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 4148b2e4378dSMatthew G. Knepley max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 4149b2e4378dSMatthew G. Knepley } 4150b2e4378dSMatthew G. Knepley } 4151b2e4378dSMatthew G. Knepley ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr); 4152b2e4378dSMatthew G. Knepley } else { 4153b2e4378dSMatthew G. Knepley PetscBool isda; 4154b2e4378dSMatthew G. Knepley 4155b2e4378dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr); 4156b2e4378dSMatthew G. Knepley if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);} 4157b2e4378dSMatthew G. Knepley } 4158b2e4378dSMatthew G. Knepley if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);} 4159b2e4378dSMatthew G. Knepley if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);} 4160b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 4161b2e4378dSMatthew G. Knepley } 4162b2e4378dSMatthew G. Knepley 4163b2e4378dSMatthew G. Knepley /*@ 4164b2e4378dSMatthew G. Knepley DMGetBoundingBox - Returns the global bounding box for the DM. 4165b2e4378dSMatthew G. Knepley 4166b2e4378dSMatthew G. Knepley Collective 4167b2e4378dSMatthew G. Knepley 4168b2e4378dSMatthew G. Knepley Input Parameter: 4169b2e4378dSMatthew G. Knepley . dm - the DM 4170b2e4378dSMatthew G. Knepley 4171b2e4378dSMatthew G. Knepley Output Parameters: 4172b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional) 4173b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional) 4174b2e4378dSMatthew G. Knepley 4175b2e4378dSMatthew G. Knepley Level: beginner 4176b2e4378dSMatthew G. Knepley 4177b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal() 4178b2e4378dSMatthew G. Knepley @*/ 4179b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[]) 4180b2e4378dSMatthew G. Knepley { 4181b2e4378dSMatthew G. Knepley PetscReal lmin[3], lmax[3]; 41826ce308c4SMatthew G. Knepley PetscInt cdim; 41836ce308c4SMatthew G. Knepley PetscMPIInt count; 4184b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 4185b2e4378dSMatthew G. Knepley 4186b2e4378dSMatthew G. Knepley PetscFunctionBegin; 4187b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4188b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 4189b2e4378dSMatthew G. Knepley ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr); 4190b2e4378dSMatthew G. Knepley ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr); 4191820f2d46SBarry Smith if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);} 4192820f2d46SBarry Smith if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);} 4193b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 4194b2e4378dSMatthew G. Knepley } 4195b2e4378dSMatthew G. Knepley 41967da65231SMatthew G Knepley /******************************** FEM Support **********************************/ 41977da65231SMatthew G Knepley 4198a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[]) 4199a6dfd86eSKarl Rupp { 42001d47ebbbSSatish Balay PetscInt f; 42011b30c384SMatthew G Knepley PetscErrorCode ierr; 42021b30c384SMatthew G Knepley 42037da65231SMatthew G Knepley PetscFunctionBegin; 420474778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 42051d47ebbbSSatish Balay for (f = 0; f < len; ++f) { 420657622a8eSBarry Smith ierr = PetscPrintf(PETSC_COMM_SELF, " | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr); 42077da65231SMatthew G Knepley } 42087da65231SMatthew G Knepley PetscFunctionReturn(0); 42097da65231SMatthew G Knepley } 42107da65231SMatthew G Knepley 4211a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[]) 4212a6dfd86eSKarl Rupp { 42131b30c384SMatthew G Knepley PetscInt f, g; 42147da65231SMatthew G Knepley PetscErrorCode ierr; 42157da65231SMatthew G Knepley 42167da65231SMatthew G Knepley PetscFunctionBegin; 421774778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 42181d47ebbbSSatish Balay for (f = 0; f < rows; ++f) { 421974778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |");CHKERRQ(ierr); 42201d47ebbbSSatish Balay for (g = 0; g < cols; ++g) { 4221e3556bceSMatthew G. Knepley ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr); 42227da65231SMatthew G Knepley } 422374778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr); 42247da65231SMatthew G Knepley } 42257da65231SMatthew G Knepley PetscFunctionReturn(0); 42267da65231SMatthew G Knepley } 4227e7c4fc90SDmitry Karpeev 42286113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X) 4229e759306cSMatthew G. Knepley { 42300c5b8624SToby Isaac PetscInt localSize, bs; 42310c5b8624SToby Isaac PetscMPIInt size; 42320c5b8624SToby Isaac Vec x, xglob; 42330c5b8624SToby Isaac const PetscScalar *xarray; 4234e759306cSMatthew G. Knepley PetscErrorCode ierr; 4235e759306cSMatthew G. Knepley 4236e759306cSMatthew G. Knepley PetscFunctionBegin; 4237ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr); 4238e759306cSMatthew G. Knepley ierr = VecDuplicate(X, &x);CHKERRQ(ierr); 4239e759306cSMatthew G. Knepley ierr = VecCopy(X, x);CHKERRQ(ierr); 42406113b454SMatthew G. Knepley ierr = VecChop(x, tol);CHKERRQ(ierr); 42410c5b8624SToby Isaac ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr); 42420c5b8624SToby Isaac if (size > 1) { 42430c5b8624SToby Isaac ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr); 42440c5b8624SToby Isaac ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr); 42450c5b8624SToby Isaac ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 42460c5b8624SToby Isaac ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr); 42470c5b8624SToby Isaac } else { 42480c5b8624SToby Isaac xglob = x; 42490c5b8624SToby Isaac } 42500c5b8624SToby Isaac ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr); 42510c5b8624SToby Isaac if (size > 1) { 42520c5b8624SToby Isaac ierr = VecDestroy(&xglob);CHKERRQ(ierr); 42530c5b8624SToby Isaac ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr); 42540c5b8624SToby Isaac } 4255e759306cSMatthew G. Knepley ierr = VecDestroy(&x);CHKERRQ(ierr); 4256e759306cSMatthew G. Knepley PetscFunctionReturn(0); 4257e759306cSMatthew G. Knepley } 4258e759306cSMatthew G. Knepley 425988ed4aceSMatthew G Knepley /*@ 42601bb6d2a8SBarry Smith DMGetSection - Get the PetscSection encoding the local data layout for the DM. This is equivalent to DMGetLocalSection(). Deprecated in v3.12 4261061576a5SJed Brown 4262061576a5SJed Brown Input Parameter: 4263061576a5SJed Brown . dm - The DM 4264061576a5SJed Brown 4265061576a5SJed Brown Output Parameter: 4266061576a5SJed Brown . section - The PetscSection 4267061576a5SJed Brown 4268061576a5SJed Brown Options Database Keys: 4269061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM 4270061576a5SJed Brown 4271061576a5SJed Brown Level: advanced 4272061576a5SJed Brown 4273061576a5SJed Brown Notes: 4274061576a5SJed Brown Use DMGetLocalSection() in new code. 4275061576a5SJed Brown 4276061576a5SJed Brown This gets a borrowed reference, so the user should not destroy this PetscSection. 4277061576a5SJed Brown 4278061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection() 4279061576a5SJed Brown @*/ 4280061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section) 4281061576a5SJed Brown { 4282061576a5SJed Brown PetscErrorCode ierr; 4283061576a5SJed Brown 4284061576a5SJed Brown PetscFunctionBegin; 4285061576a5SJed Brown ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr); 4286061576a5SJed Brown PetscFunctionReturn(0); 4287061576a5SJed Brown } 4288061576a5SJed Brown 4289061576a5SJed Brown /*@ 4290061576a5SJed Brown DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM. 429188ed4aceSMatthew G Knepley 429288ed4aceSMatthew G Knepley Input Parameter: 429388ed4aceSMatthew G Knepley . dm - The DM 429488ed4aceSMatthew G Knepley 429588ed4aceSMatthew G Knepley Output Parameter: 429688ed4aceSMatthew G Knepley . section - The PetscSection 429788ed4aceSMatthew G Knepley 4298e5893cccSMatthew G. Knepley Options Database Keys: 4299e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM 4300e5893cccSMatthew G. Knepley 430188ed4aceSMatthew G Knepley Level: intermediate 430288ed4aceSMatthew G Knepley 430388ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 430488ed4aceSMatthew G Knepley 4305061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection() 430688ed4aceSMatthew G Knepley @*/ 4307061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section) 43080adebc6cSBarry Smith { 4309fd59a867SMatthew G. Knepley PetscErrorCode ierr; 4310fd59a867SMatthew G. Knepley 431188ed4aceSMatthew G Knepley PetscFunctionBegin; 431288ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 431388ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 43141bb6d2a8SBarry Smith if (!dm->localSection && dm->ops->createlocalsection) { 4315e5e52638SMatthew G. Knepley PetscInt d; 4316e5e52638SMatthew G. Knepley 431745480ffeSMatthew G. Knepley if (dm->setfromoptionscalled) { 431845480ffeSMatthew G. Knepley PetscObject obj = (PetscObject) dm; 431945480ffeSMatthew G. Knepley PetscViewer viewer; 432045480ffeSMatthew G. Knepley PetscViewerFormat format; 432145480ffeSMatthew G. Knepley PetscBool flg; 432245480ffeSMatthew G. Knepley 432345480ffeSMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr); 432445480ffeSMatthew G. Knepley if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);} 432545480ffeSMatthew G. Knepley for (d = 0; d < dm->Nds; ++d) { 432645480ffeSMatthew G. Knepley ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr); 432745480ffeSMatthew G. Knepley if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);} 432845480ffeSMatthew G. Knepley } 432945480ffeSMatthew G. Knepley if (flg) { 433045480ffeSMatthew G. Knepley ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 433145480ffeSMatthew G. Knepley ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 433245480ffeSMatthew G. Knepley ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 433345480ffeSMatthew G. Knepley } 433445480ffeSMatthew G. Knepley } 43351bb6d2a8SBarry Smith ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr); 43361bb6d2a8SBarry Smith if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);} 43372f0f8703SMatthew G. Knepley } 43381bb6d2a8SBarry Smith *section = dm->localSection; 433988ed4aceSMatthew G Knepley PetscFunctionReturn(0); 434088ed4aceSMatthew G Knepley } 434188ed4aceSMatthew G Knepley 434288ed4aceSMatthew G Knepley /*@ 43431bb6d2a8SBarry Smith DMSetSection - Set the PetscSection encoding the local data layout for the DM. This is equivalent to DMSetLocalSection(). Deprecated in v3.12 4344061576a5SJed Brown 4345061576a5SJed Brown Input Parameters: 4346061576a5SJed Brown + dm - The DM 4347061576a5SJed Brown - section - The PetscSection 4348061576a5SJed Brown 4349061576a5SJed Brown Level: advanced 4350061576a5SJed Brown 4351061576a5SJed Brown Notes: 4352061576a5SJed Brown Use DMSetLocalSection() in new code. 4353061576a5SJed Brown 4354061576a5SJed Brown Any existing Section will be destroyed 4355061576a5SJed Brown 4356061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection() 4357061576a5SJed Brown @*/ 4358061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section) 4359061576a5SJed Brown { 4360061576a5SJed Brown PetscErrorCode ierr; 4361061576a5SJed Brown 4362061576a5SJed Brown PetscFunctionBegin; 4363061576a5SJed Brown ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr); 4364061576a5SJed Brown PetscFunctionReturn(0); 4365061576a5SJed Brown } 4366061576a5SJed Brown 4367061576a5SJed Brown /*@ 4368061576a5SJed Brown DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM. 436988ed4aceSMatthew G Knepley 437088ed4aceSMatthew G Knepley Input Parameters: 437188ed4aceSMatthew G Knepley + dm - The DM 437288ed4aceSMatthew G Knepley - section - The PetscSection 437388ed4aceSMatthew G Knepley 437488ed4aceSMatthew G Knepley Level: intermediate 437588ed4aceSMatthew G Knepley 437688ed4aceSMatthew G Knepley Note: Any existing Section will be destroyed 437788ed4aceSMatthew G Knepley 4378061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection() 437988ed4aceSMatthew G Knepley @*/ 4380061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section) 43810adebc6cSBarry Smith { 4382c473ab19SMatthew G. Knepley PetscInt numFields = 0; 4383af122d2aSMatthew G Knepley PetscInt f; 438488ed4aceSMatthew G Knepley PetscErrorCode ierr; 438588ed4aceSMatthew G Knepley 438688ed4aceSMatthew G Knepley PetscFunctionBegin; 438788ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4388b9d85ea2SLisandro Dalcin if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 43891d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 43901bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr); 43911bb6d2a8SBarry Smith dm->localSection = section; 43921bb6d2a8SBarry Smith if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);} 4393af122d2aSMatthew G Knepley if (numFields) { 4394af122d2aSMatthew G Knepley ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr); 4395af122d2aSMatthew G Knepley for (f = 0; f < numFields; ++f) { 43960f21e855SMatthew G. Knepley PetscObject disc; 4397af122d2aSMatthew G Knepley const char *name; 4398af122d2aSMatthew G Knepley 43991bb6d2a8SBarry Smith ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr); 440044a7f3ddSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr); 44010f21e855SMatthew G. Knepley ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr); 4402af122d2aSMatthew G Knepley } 4403af122d2aSMatthew G Knepley } 4404e87a4003SBarry Smith /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */ 44051bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 440688ed4aceSMatthew G Knepley PetscFunctionReturn(0); 440788ed4aceSMatthew G Knepley } 440888ed4aceSMatthew G Knepley 44099435951eSToby Isaac /*@ 4410b7385021SStefano Zampini DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation. 44119435951eSToby Isaac 4412e228b242SToby Isaac not collective 4413e228b242SToby Isaac 44149435951eSToby Isaac Input Parameter: 44159435951eSToby Isaac . dm - The DM 44169435951eSToby Isaac 4417d8d19677SJose E. Roman Output Parameters: 44189435951eSToby 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. 44199435951eSToby 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. 44209435951eSToby Isaac 44219435951eSToby Isaac Level: advanced 44229435951eSToby Isaac 44239435951eSToby Isaac Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat. 44249435951eSToby Isaac 44259435951eSToby Isaac .seealso: DMSetDefaultConstraints() 44269435951eSToby Isaac @*/ 44279435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat) 44289435951eSToby Isaac { 44299435951eSToby Isaac PetscErrorCode ierr; 44309435951eSToby Isaac 44319435951eSToby Isaac PetscFunctionBegin; 44329435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 44339435951eSToby Isaac if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);} 443445a75d81SToby Isaac if (section) {*section = dm->defaultConstraintSection;} 443545a75d81SToby Isaac if (mat) {*mat = dm->defaultConstraintMat;} 44369435951eSToby Isaac PetscFunctionReturn(0); 44379435951eSToby Isaac } 44389435951eSToby Isaac 44399435951eSToby Isaac /*@ 4440b7385021SStefano Zampini DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation. 44419435951eSToby Isaac 44429435951eSToby 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(). 44439435951eSToby Isaac 44449435951eSToby 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. 44459435951eSToby Isaac 4446e228b242SToby Isaac collective on dm 4447e228b242SToby Isaac 44489435951eSToby Isaac Input Parameters: 44499435951eSToby Isaac + dm - The DM 4450e228b242SToby 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). 4451e228b242SToby 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). 44529435951eSToby Isaac 44539435951eSToby Isaac Level: advanced 44549435951eSToby Isaac 44559435951eSToby Isaac Note: This increments the references of the PetscSection and the Mat, so they user can destroy them 44569435951eSToby Isaac 44579435951eSToby Isaac .seealso: DMGetDefaultConstraints() 44589435951eSToby Isaac @*/ 44599435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat) 44609435951eSToby Isaac { 4461e228b242SToby Isaac PetscMPIInt result; 44629435951eSToby Isaac PetscErrorCode ierr; 44639435951eSToby Isaac 44649435951eSToby Isaac PetscFunctionBegin; 44659435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4466e228b242SToby Isaac if (section) { 4467e228b242SToby Isaac PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 4468ffc4695bSBarry Smith ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr); 44692c71b3e2SJacob Faibussowitsch PetscCheckFalse(result != MPI_CONGRUENT && result != MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator"); 4470e228b242SToby Isaac } 4471e228b242SToby Isaac if (mat) { 4472e228b242SToby Isaac PetscValidHeaderSpecific(mat,MAT_CLASSID,3); 4473ffc4695bSBarry Smith ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr); 44742c71b3e2SJacob Faibussowitsch PetscCheckFalse(result != MPI_CONGRUENT && result != MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator"); 4475e228b242SToby Isaac } 44769435951eSToby Isaac ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 44779435951eSToby Isaac ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr); 44789435951eSToby Isaac dm->defaultConstraintSection = section; 44799435951eSToby Isaac ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr); 44809435951eSToby Isaac ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr); 44819435951eSToby Isaac dm->defaultConstraintMat = mat; 44829435951eSToby Isaac PetscFunctionReturn(0); 44839435951eSToby Isaac } 44849435951eSToby Isaac 4485497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 4486507e4973SMatthew G. Knepley /* 4487507e4973SMatthew G. Knepley DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections. 4488507e4973SMatthew G. Knepley 4489507e4973SMatthew G. Knepley Input Parameters: 4490507e4973SMatthew G. Knepley + dm - The DM 4491507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout 4492507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout 4493507e4973SMatthew G. Knepley 4494507e4973SMatthew G. Knepley Level: intermediate 4495507e4973SMatthew G. Knepley 44961bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF() 4497507e4973SMatthew G. Knepley */ 4498f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection) 4499507e4973SMatthew G. Knepley { 4500507e4973SMatthew G. Knepley MPI_Comm comm; 4501507e4973SMatthew G. Knepley PetscLayout layout; 4502507e4973SMatthew G. Knepley const PetscInt *ranges; 4503507e4973SMatthew G. Knepley PetscInt pStart, pEnd, p, nroots; 4504507e4973SMatthew G. Knepley PetscMPIInt size, rank; 4505507e4973SMatthew G. Knepley PetscBool valid = PETSC_TRUE, gvalid; 4506507e4973SMatthew G. Knepley PetscErrorCode ierr; 4507507e4973SMatthew G. Knepley 4508507e4973SMatthew G. Knepley PetscFunctionBegin; 4509507e4973SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr); 4510507e4973SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4511ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 4512ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 4513507e4973SMatthew G. Knepley ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr); 4514507e4973SMatthew G. Knepley ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr); 4515507e4973SMatthew G. Knepley ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr); 4516507e4973SMatthew G. Knepley ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr); 4517507e4973SMatthew G. Knepley ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr); 4518507e4973SMatthew G. Knepley ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr); 4519507e4973SMatthew G. Knepley ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr); 4520507e4973SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 4521f741bcd2SMatthew G. Knepley PetscInt dof, cdof, off, gdof, gcdof, goff, gsize, d; 4522507e4973SMatthew G. Knepley 4523507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr); 4524507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr); 4525507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr); 4526507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 4527507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 4528507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr); 4529507e4973SMatthew G. Knepley if (!gdof) continue; /* Censored point */ 4530507e4973SMatthew 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;} 4531507e4973SMatthew 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;} 4532507e4973SMatthew G. Knepley if (gdof < 0) { 4533507e4973SMatthew G. Knepley gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 4534507e4973SMatthew G. Knepley for (d = 0; d < gsize; ++d) { 4535507e4973SMatthew G. Knepley PetscInt offset = -(goff+1) + d, r; 4536507e4973SMatthew G. Knepley 4537507e4973SMatthew G. Knepley ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr); 4538507e4973SMatthew G. Knepley if (r < 0) r = -(r+2); 4539507e4973SMatthew 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;} 4540507e4973SMatthew G. Knepley } 4541507e4973SMatthew G. Knepley } 4542507e4973SMatthew G. Knepley } 4543507e4973SMatthew G. Knepley ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr); 4544507e4973SMatthew G. Knepley ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr); 4545820f2d46SBarry Smith ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 4546507e4973SMatthew G. Knepley if (!gvalid) { 4547507e4973SMatthew G. Knepley ierr = DMView(dm, NULL);CHKERRQ(ierr); 4548507e4973SMatthew G. Knepley SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections"); 4549507e4973SMatthew G. Knepley } 4550507e4973SMatthew G. Knepley PetscFunctionReturn(0); 4551507e4973SMatthew G. Knepley } 4552f741bcd2SMatthew G. Knepley #endif 4553507e4973SMatthew G. Knepley 455488ed4aceSMatthew G Knepley /*@ 4555e87a4003SBarry Smith DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM. 455688ed4aceSMatthew G Knepley 4557d083f849SBarry Smith Collective on dm 45588b1ab98fSJed Brown 455988ed4aceSMatthew G Knepley Input Parameter: 456088ed4aceSMatthew G Knepley . dm - The DM 456188ed4aceSMatthew G Knepley 456288ed4aceSMatthew G Knepley Output Parameter: 456388ed4aceSMatthew G Knepley . section - The PetscSection 456488ed4aceSMatthew G Knepley 456588ed4aceSMatthew G Knepley Level: intermediate 456688ed4aceSMatthew G Knepley 456788ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 456888ed4aceSMatthew G Knepley 456992fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection() 457088ed4aceSMatthew G Knepley @*/ 4571e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section) 45720adebc6cSBarry Smith { 457388ed4aceSMatthew G Knepley PetscErrorCode ierr; 457488ed4aceSMatthew G Knepley 457588ed4aceSMatthew G Knepley PetscFunctionBegin; 457688ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 457788ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 45781bb6d2a8SBarry Smith if (!dm->globalSection) { 4579fd59a867SMatthew G. Knepley PetscSection s; 4580fd59a867SMatthew G. Knepley 458192fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 45822c71b3e2SJacob Faibussowitsch PetscCheckFalse(!s,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection"); 45832c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->sf,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection"); 45841bb6d2a8SBarry Smith ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr); 4585cf06b437SMatthew G. Knepley ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr); 45861bb6d2a8SBarry Smith ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr); 45871bb6d2a8SBarry Smith ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr); 458888ed4aceSMatthew G Knepley } 45891bb6d2a8SBarry Smith *section = dm->globalSection; 459088ed4aceSMatthew G Knepley PetscFunctionReturn(0); 459188ed4aceSMatthew G Knepley } 459288ed4aceSMatthew G Knepley 4593b21d0597SMatthew G Knepley /*@ 4594e87a4003SBarry Smith DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM. 4595b21d0597SMatthew G Knepley 4596b21d0597SMatthew G Knepley Input Parameters: 4597b21d0597SMatthew G Knepley + dm - The DM 45985080bbdbSMatthew G Knepley - section - The PetscSection, or NULL 4599b21d0597SMatthew G Knepley 4600b21d0597SMatthew G Knepley Level: intermediate 4601b21d0597SMatthew G Knepley 4602b21d0597SMatthew G Knepley Note: Any existing Section will be destroyed 4603b21d0597SMatthew G Knepley 460492fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection() 4605b21d0597SMatthew G Knepley @*/ 4606e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section) 46070adebc6cSBarry Smith { 4608b21d0597SMatthew G Knepley PetscErrorCode ierr; 4609b21d0597SMatthew G Knepley 4610b21d0597SMatthew G Knepley PetscFunctionBegin; 4611b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 46125080bbdbSMatthew G Knepley if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 46131d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 46141bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 46151bb6d2a8SBarry Smith dm->globalSection = section; 4616497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 46171bb6d2a8SBarry Smith if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);} 4618507e4973SMatthew G. Knepley #endif 4619b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4620b21d0597SMatthew G Knepley } 4621b21d0597SMatthew G Knepley 462288ed4aceSMatthew G Knepley /*@ 46231bb6d2a8SBarry Smith DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set, 462488ed4aceSMatthew G Knepley it is created from the default PetscSection layouts in the DM. 462588ed4aceSMatthew G Knepley 462688ed4aceSMatthew G Knepley Input Parameter: 462788ed4aceSMatthew G Knepley . dm - The DM 462888ed4aceSMatthew G Knepley 462988ed4aceSMatthew G Knepley Output Parameter: 463088ed4aceSMatthew G Knepley . sf - The PetscSF 463188ed4aceSMatthew G Knepley 463288ed4aceSMatthew G Knepley Level: intermediate 463388ed4aceSMatthew G Knepley 463488ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 463588ed4aceSMatthew G Knepley 46361bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF() 463788ed4aceSMatthew G Knepley @*/ 46381bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf) 46390adebc6cSBarry Smith { 464088ed4aceSMatthew G Knepley PetscInt nroots; 464188ed4aceSMatthew G Knepley PetscErrorCode ierr; 464288ed4aceSMatthew G Knepley 464388ed4aceSMatthew G Knepley PetscFunctionBegin; 464488ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 464588ed4aceSMatthew G Knepley PetscValidPointer(sf, 2); 46461bb6d2a8SBarry Smith if (!dm->sectionSF) { 46471bb6d2a8SBarry Smith ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr); 464833907cc2SStefano Zampini } 46491bb6d2a8SBarry Smith ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr); 465088ed4aceSMatthew G Knepley if (nroots < 0) { 465188ed4aceSMatthew G Knepley PetscSection section, gSection; 465288ed4aceSMatthew G Knepley 465392fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 465431ea6d37SMatthew G Knepley if (section) { 4655e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr); 46561bb6d2a8SBarry Smith ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr); 465731ea6d37SMatthew G Knepley } else { 46580298fd71SBarry Smith *sf = NULL; 465931ea6d37SMatthew G Knepley PetscFunctionReturn(0); 466031ea6d37SMatthew G Knepley } 466188ed4aceSMatthew G Knepley } 46621bb6d2a8SBarry Smith *sf = dm->sectionSF; 466388ed4aceSMatthew G Knepley PetscFunctionReturn(0); 466488ed4aceSMatthew G Knepley } 466588ed4aceSMatthew G Knepley 466688ed4aceSMatthew G Knepley /*@ 46671bb6d2a8SBarry Smith DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM 466888ed4aceSMatthew G Knepley 466988ed4aceSMatthew G Knepley Input Parameters: 467088ed4aceSMatthew G Knepley + dm - The DM 467188ed4aceSMatthew G Knepley - sf - The PetscSF 467288ed4aceSMatthew G Knepley 467388ed4aceSMatthew G Knepley Level: intermediate 467488ed4aceSMatthew G Knepley 467588ed4aceSMatthew G Knepley Note: Any previous SF is destroyed 467688ed4aceSMatthew G Knepley 46771bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF() 467888ed4aceSMatthew G Knepley @*/ 46791bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf) 46800adebc6cSBarry Smith { 468188ed4aceSMatthew G Knepley PetscErrorCode ierr; 468288ed4aceSMatthew G Knepley 468388ed4aceSMatthew G Knepley PetscFunctionBegin; 468488ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4685b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 468633907cc2SStefano Zampini ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 46871bb6d2a8SBarry Smith ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr); 46881bb6d2a8SBarry Smith dm->sectionSF = sf; 468988ed4aceSMatthew G Knepley PetscFunctionReturn(0); 469088ed4aceSMatthew G Knepley } 469188ed4aceSMatthew G Knepley 469288ed4aceSMatthew G Knepley /*@C 46931bb6d2a8SBarry Smith DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections 469488ed4aceSMatthew G Knepley describing the data layout. 469588ed4aceSMatthew G Knepley 469688ed4aceSMatthew G Knepley Input Parameters: 469788ed4aceSMatthew G Knepley + dm - The DM 469888ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout 469988ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout 470088ed4aceSMatthew G Knepley 47011bb6d2a8SBarry Smith Notes: One usually uses DMGetSectionSF() to obtain the PetscSF 470288ed4aceSMatthew G Knepley 47031bb6d2a8SBarry Smith Level: developer 47041bb6d2a8SBarry Smith 47051bb6d2a8SBarry Smith Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF 47061bb6d2a8SBarry Smith directly into the DM, perhaps this function should not take the local and global sections as 47071bb6d2a8SBarry Smith input and should just obtain them from the DM? 47081bb6d2a8SBarry Smith 47091bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection() 471088ed4aceSMatthew G Knepley @*/ 47111bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection) 471288ed4aceSMatthew G Knepley { 471388ed4aceSMatthew G Knepley PetscErrorCode ierr; 471488ed4aceSMatthew G Knepley 471588ed4aceSMatthew G Knepley PetscFunctionBegin; 471688ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4717b0c7db22SLisandro Dalcin ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr); 471888ed4aceSMatthew G Knepley PetscFunctionReturn(0); 471988ed4aceSMatthew G Knepley } 4720af122d2aSMatthew G Knepley 4721b21d0597SMatthew G Knepley /*@ 4722b21d0597SMatthew G Knepley DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM. 4723b21d0597SMatthew G Knepley 4724b21d0597SMatthew G Knepley Input Parameter: 4725b21d0597SMatthew G Knepley . dm - The DM 4726b21d0597SMatthew G Knepley 4727b21d0597SMatthew G Knepley Output Parameter: 4728b21d0597SMatthew G Knepley . sf - The PetscSF 4729b21d0597SMatthew G Knepley 4730b21d0597SMatthew G Knepley Level: intermediate 4731b21d0597SMatthew G Knepley 4732b21d0597SMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 4733b21d0597SMatthew G Knepley 47341bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4735b21d0597SMatthew G Knepley @*/ 47360adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf) 47370adebc6cSBarry Smith { 4738b21d0597SMatthew G Knepley PetscFunctionBegin; 4739b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4740b21d0597SMatthew G Knepley PetscValidPointer(sf, 2); 4741b21d0597SMatthew G Knepley *sf = dm->sf; 4742b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4743b21d0597SMatthew G Knepley } 4744b21d0597SMatthew G Knepley 4745057b4bcdSMatthew G Knepley /*@ 4746057b4bcdSMatthew G Knepley DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM. 4747057b4bcdSMatthew G Knepley 4748057b4bcdSMatthew G Knepley Input Parameters: 4749057b4bcdSMatthew G Knepley + dm - The DM 4750057b4bcdSMatthew G Knepley - sf - The PetscSF 4751057b4bcdSMatthew G Knepley 4752057b4bcdSMatthew G Knepley Level: intermediate 4753057b4bcdSMatthew G Knepley 47541bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4755057b4bcdSMatthew G Knepley @*/ 47560adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf) 47570adebc6cSBarry Smith { 4758057b4bcdSMatthew G Knepley PetscErrorCode ierr; 4759057b4bcdSMatthew G Knepley 4760057b4bcdSMatthew G Knepley PetscFunctionBegin; 4761057b4bcdSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4762b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 4763057b4bcdSMatthew G Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 476433907cc2SStefano Zampini ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr); 4765057b4bcdSMatthew G Knepley dm->sf = sf; 4766057b4bcdSMatthew G Knepley PetscFunctionReturn(0); 4767057b4bcdSMatthew G Knepley } 4768057b4bcdSMatthew G Knepley 47694f37162bSMatthew G. Knepley /*@ 47704f37162bSMatthew G. Knepley DMGetNaturalSF - Get the PetscSF encoding the map back to the original mesh ordering 47714f37162bSMatthew G. Knepley 47724f37162bSMatthew G. Knepley Input Parameter: 47734f37162bSMatthew G. Knepley . dm - The DM 47744f37162bSMatthew G. Knepley 47754f37162bSMatthew G. Knepley Output Parameter: 47764f37162bSMatthew G. Knepley . sf - The PetscSF 47774f37162bSMatthew G. Knepley 47784f37162bSMatthew G. Knepley Level: intermediate 47794f37162bSMatthew G. Knepley 47804f37162bSMatthew G. Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 47814f37162bSMatthew G. Knepley 47824f37162bSMatthew G. Knepley .seealso: DMSetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute() 47834f37162bSMatthew G. Knepley @*/ 47844f37162bSMatthew G. Knepley PetscErrorCode DMGetNaturalSF(DM dm, PetscSF *sf) 47854f37162bSMatthew G. Knepley { 47864f37162bSMatthew G. Knepley PetscFunctionBegin; 47874f37162bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 47884f37162bSMatthew G. Knepley PetscValidPointer(sf, 2); 47894f37162bSMatthew G. Knepley *sf = dm->sfNatural; 47904f37162bSMatthew G. Knepley PetscFunctionReturn(0); 47914f37162bSMatthew G. Knepley } 47924f37162bSMatthew G. Knepley 47934f37162bSMatthew G. Knepley /*@ 47944f37162bSMatthew G. Knepley DMSetNaturalSF - Set the PetscSF encoding the map back to the original mesh ordering 47954f37162bSMatthew G. Knepley 47964f37162bSMatthew G. Knepley Input Parameters: 47974f37162bSMatthew G. Knepley + dm - The DM 47984f37162bSMatthew G. Knepley - sf - The PetscSF 47994f37162bSMatthew G. Knepley 48004f37162bSMatthew G. Knepley Level: intermediate 48014f37162bSMatthew G. Knepley 48024f37162bSMatthew G. Knepley .seealso: DMGetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute() 48034f37162bSMatthew G. Knepley @*/ 48044f37162bSMatthew G. Knepley PetscErrorCode DMSetNaturalSF(DM dm, PetscSF sf) 48054f37162bSMatthew G. Knepley { 48064f37162bSMatthew G. Knepley PetscErrorCode ierr; 48074f37162bSMatthew G. Knepley 48084f37162bSMatthew G. Knepley PetscFunctionBegin; 48094f37162bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 48104f37162bSMatthew G. Knepley if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 48114f37162bSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 48124f37162bSMatthew G. Knepley ierr = PetscSFDestroy(&dm->sfNatural);CHKERRQ(ierr); 48134f37162bSMatthew G. Knepley dm->sfNatural = sf; 48144f37162bSMatthew G. Knepley PetscFunctionReturn(0); 48154f37162bSMatthew G. Knepley } 48164f37162bSMatthew G. Knepley 481734aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc) 481834aa8a36SMatthew G. Knepley { 481934aa8a36SMatthew G. Knepley PetscClassId id; 482034aa8a36SMatthew G. Knepley PetscErrorCode ierr; 482134aa8a36SMatthew G. Knepley 482234aa8a36SMatthew G. Knepley PetscFunctionBegin; 482334aa8a36SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 482434aa8a36SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 482534aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 482634aa8a36SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 482734aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr); 482817c1d62eSMatthew G. Knepley } else { 482917c1d62eSMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 483034aa8a36SMatthew G. Knepley } 483134aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 483234aa8a36SMatthew G. Knepley } 483334aa8a36SMatthew G. Knepley 483444a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew) 483544a7f3ddSMatthew G. Knepley { 483644a7f3ddSMatthew G. Knepley RegionField *tmpr; 483744a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf, f; 483844a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 483944a7f3ddSMatthew G. Knepley 484044a7f3ddSMatthew G. Knepley PetscFunctionBegin; 484144a7f3ddSMatthew G. Knepley if (Nf >= NfNew) PetscFunctionReturn(0); 484244a7f3ddSMatthew G. Knepley ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr); 484344a7f3ddSMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f]; 4844e0b68406SMatthew Knepley for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;} 484544a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 484644a7f3ddSMatthew G. Knepley dm->Nf = NfNew; 484744a7f3ddSMatthew G. Knepley dm->fields = tmpr; 484844a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 484944a7f3ddSMatthew G. Knepley } 485044a7f3ddSMatthew G. Knepley 485144a7f3ddSMatthew G. Knepley /*@ 485244a7f3ddSMatthew G. Knepley DMClearFields - Remove all fields from the DM 485344a7f3ddSMatthew G. Knepley 4854d083f849SBarry Smith Logically collective on dm 485544a7f3ddSMatthew G. Knepley 485644a7f3ddSMatthew G. Knepley Input Parameter: 485744a7f3ddSMatthew G. Knepley . dm - The DM 485844a7f3ddSMatthew G. Knepley 485944a7f3ddSMatthew G. Knepley Level: intermediate 486044a7f3ddSMatthew G. Knepley 486144a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField() 486244a7f3ddSMatthew G. Knepley @*/ 486344a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm) 486444a7f3ddSMatthew G. Knepley { 486544a7f3ddSMatthew G. Knepley PetscInt f; 486644a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 486744a7f3ddSMatthew G. Knepley 486844a7f3ddSMatthew G. Knepley PetscFunctionBegin; 486944a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 487044a7f3ddSMatthew G. Knepley for (f = 0; f < dm->Nf; ++f) { 487144a7f3ddSMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 487244a7f3ddSMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 487344a7f3ddSMatthew G. Knepley } 487444a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 487544a7f3ddSMatthew G. Knepley dm->fields = NULL; 487644a7f3ddSMatthew G. Knepley dm->Nf = 0; 487744a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 487844a7f3ddSMatthew G. Knepley } 487944a7f3ddSMatthew G. Knepley 4880689b5837SMatthew G. Knepley /*@ 4881689b5837SMatthew G. Knepley DMGetNumFields - Get the number of fields in the DM 4882689b5837SMatthew G. Knepley 4883689b5837SMatthew G. Knepley Not collective 4884689b5837SMatthew G. Knepley 4885689b5837SMatthew G. Knepley Input Parameter: 4886689b5837SMatthew G. Knepley . dm - The DM 4887689b5837SMatthew G. Knepley 4888689b5837SMatthew G. Knepley Output Parameter: 4889689b5837SMatthew G. Knepley . Nf - The number of fields 4890689b5837SMatthew G. Knepley 4891689b5837SMatthew G. Knepley Level: intermediate 4892689b5837SMatthew G. Knepley 4893689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField() 4894689b5837SMatthew G. Knepley @*/ 48950f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields) 48960f21e855SMatthew G. Knepley { 48970f21e855SMatthew G. Knepley PetscFunctionBegin; 48980f21e855SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4899534a8f05SLisandro Dalcin PetscValidIntPointer(numFields, 2); 490044a7f3ddSMatthew G. Knepley *numFields = dm->Nf; 4901af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4902af122d2aSMatthew G Knepley } 4903af122d2aSMatthew G Knepley 4904689b5837SMatthew G. Knepley /*@ 4905689b5837SMatthew G. Knepley DMSetNumFields - Set the number of fields in the DM 4906689b5837SMatthew G. Knepley 4907d083f849SBarry Smith Logically collective on dm 4908689b5837SMatthew G. Knepley 4909689b5837SMatthew G. Knepley Input Parameters: 4910689b5837SMatthew G. Knepley + dm - The DM 4911689b5837SMatthew G. Knepley - Nf - The number of fields 4912689b5837SMatthew G. Knepley 4913689b5837SMatthew G. Knepley Level: intermediate 4914689b5837SMatthew G. Knepley 4915689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField() 4916689b5837SMatthew G. Knepley @*/ 4917af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields) 4918af122d2aSMatthew G Knepley { 49190f21e855SMatthew G. Knepley PetscInt Nf, f; 4920af122d2aSMatthew G Knepley PetscErrorCode ierr; 4921af122d2aSMatthew G Knepley 4922af122d2aSMatthew G Knepley PetscFunctionBegin; 4923af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 492444a7f3ddSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 49250f21e855SMatthew G. Knepley for (f = Nf; f < numFields; ++f) { 49260f21e855SMatthew G. Knepley PetscContainer obj; 49270f21e855SMatthew G. Knepley 49280f21e855SMatthew G. Knepley ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr); 492944a7f3ddSMatthew G. Knepley ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr); 49300f21e855SMatthew G. Knepley ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr); 4931af122d2aSMatthew G Knepley } 4932af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4933af122d2aSMatthew G Knepley } 4934af122d2aSMatthew G Knepley 4935c1929be8SMatthew G. Knepley /*@ 4936c1929be8SMatthew G. Knepley DMGetField - Return the discretization object for a given DM field 4937c1929be8SMatthew G. Knepley 4938c1929be8SMatthew G. Knepley Not collective 4939c1929be8SMatthew G. Knepley 4940c1929be8SMatthew G. Knepley Input Parameters: 4941c1929be8SMatthew G. Knepley + dm - The DM 4942c1929be8SMatthew G. Knepley - f - The field number 4943c1929be8SMatthew G. Knepley 494444a7f3ddSMatthew G. Knepley Output Parameters: 494544a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh 494644a7f3ddSMatthew G. Knepley - field - The discretization object 4947c1929be8SMatthew G. Knepley 494844a7f3ddSMatthew G. Knepley Level: intermediate 4949c1929be8SMatthew G. Knepley 495044a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField() 4951c1929be8SMatthew G. Knepley @*/ 495244a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field) 4953af122d2aSMatthew G Knepley { 4954af122d2aSMatthew G Knepley PetscFunctionBegin; 4955af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4956064a246eSJacob Faibussowitsch PetscValidPointer(field, 4); 49572c71b3e2SJacob Faibussowitsch PetscCheckFalse((f < 0) || (f >= dm->Nf),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf); 495844a7f3ddSMatthew G. Knepley if (label) *label = dm->fields[f].label; 495944a7f3ddSMatthew G. Knepley if (field) *field = dm->fields[f].disc; 4960decb47aaSMatthew G. Knepley PetscFunctionReturn(0); 4961decb47aaSMatthew G. Knepley } 4962decb47aaSMatthew G. Knepley 4963083401c6SMatthew G. Knepley /* Does not clear the DS */ 4964083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field) 4965083401c6SMatthew G. Knepley { 4966083401c6SMatthew G. Knepley PetscErrorCode ierr; 4967083401c6SMatthew G. Knepley 4968083401c6SMatthew G. Knepley PetscFunctionBegin; 4969083401c6SMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr); 4970083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 4971083401c6SMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 4972083401c6SMatthew G. Knepley dm->fields[f].label = label; 4973083401c6SMatthew G. Knepley dm->fields[f].disc = field; 4974083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 4975083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 4976083401c6SMatthew G. Knepley PetscFunctionReturn(0); 4977083401c6SMatthew G. Knepley } 4978083401c6SMatthew G. Knepley 4979c1929be8SMatthew G. Knepley /*@ 4980c1929be8SMatthew G. Knepley DMSetField - Set the discretization object for a given DM field 4981c1929be8SMatthew G. Knepley 4982d083f849SBarry Smith Logically collective on dm 4983c1929be8SMatthew G. Knepley 4984c1929be8SMatthew G. Knepley Input Parameters: 4985c1929be8SMatthew G. Knepley + dm - The DM 4986c1929be8SMatthew G. Knepley . f - The field number 498744a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 4988c1929be8SMatthew G. Knepley - field - The discretization object 4989c1929be8SMatthew G. Knepley 499044a7f3ddSMatthew G. Knepley Level: intermediate 4991c1929be8SMatthew G. Knepley 499244a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField() 4993c1929be8SMatthew G. Knepley @*/ 499444a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field) 4995decb47aaSMatthew G. Knepley { 4996decb47aaSMatthew G. Knepley PetscErrorCode ierr; 4997decb47aaSMatthew G. Knepley 4998decb47aaSMatthew G. Knepley PetscFunctionBegin; 4999decb47aaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5000e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3); 500144a7f3ddSMatthew G. Knepley PetscValidHeader(field, 4); 50022c71b3e2SJacob Faibussowitsch PetscCheckFalse(f < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 5003083401c6SMatthew G. Knepley ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr); 500434aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr); 50052df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 500644a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 500744a7f3ddSMatthew G. Knepley } 500844a7f3ddSMatthew G. Knepley 500944a7f3ddSMatthew G. Knepley /*@ 501044a7f3ddSMatthew G. Knepley DMAddField - Add the discretization object for the given DM field 501144a7f3ddSMatthew G. Knepley 5012d083f849SBarry Smith Logically collective on dm 501344a7f3ddSMatthew G. Knepley 501444a7f3ddSMatthew G. Knepley Input Parameters: 501544a7f3ddSMatthew G. Knepley + dm - The DM 501644a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 501744a7f3ddSMatthew G. Knepley - field - The discretization object 501844a7f3ddSMatthew G. Knepley 501944a7f3ddSMatthew G. Knepley Level: intermediate 502044a7f3ddSMatthew G. Knepley 502144a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField() 502244a7f3ddSMatthew G. Knepley @*/ 502344a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field) 502444a7f3ddSMatthew G. Knepley { 502544a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf; 502644a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 502744a7f3ddSMatthew G. Knepley 502844a7f3ddSMatthew G. Knepley PetscFunctionBegin; 502944a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5030064a246eSJacob Faibussowitsch if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 503144a7f3ddSMatthew G. Knepley PetscValidHeader(field, 3); 503244a7f3ddSMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr); 503344a7f3ddSMatthew G. Knepley dm->fields[Nf].label = label; 503444a7f3ddSMatthew G. Knepley dm->fields[Nf].disc = field; 503544a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 503644a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 503734aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr); 50382df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 5039af122d2aSMatthew G Knepley PetscFunctionReturn(0); 5040af122d2aSMatthew G Knepley } 50416636e97aSMatthew G Knepley 5042e5e52638SMatthew G. Knepley /*@ 5043e0b68406SMatthew Knepley DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells 5044e0b68406SMatthew Knepley 5045e0b68406SMatthew Knepley Logically collective on dm 5046e0b68406SMatthew Knepley 5047e0b68406SMatthew Knepley Input Parameters: 5048e0b68406SMatthew Knepley + dm - The DM 5049e0b68406SMatthew Knepley . f - The field index 5050e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells 5051e0b68406SMatthew Knepley 5052e0b68406SMatthew Knepley Level: intermediate 5053e0b68406SMatthew Knepley 5054e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField() 5055e0b68406SMatthew Knepley @*/ 5056e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor) 5057e0b68406SMatthew Knepley { 5058e0b68406SMatthew Knepley PetscFunctionBegin; 50592c71b3e2SJacob Faibussowitsch PetscCheckFalse((f < 0) || (f >= dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf); 5060e0b68406SMatthew Knepley dm->fields[f].avoidTensor = avoidTensor; 5061e0b68406SMatthew Knepley PetscFunctionReturn(0); 5062e0b68406SMatthew Knepley } 5063e0b68406SMatthew Knepley 5064e0b68406SMatthew Knepley /*@ 5065e0b68406SMatthew Knepley DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells 5066e0b68406SMatthew Knepley 5067e0b68406SMatthew Knepley Logically collective on dm 5068e0b68406SMatthew Knepley 5069e0b68406SMatthew Knepley Input Parameters: 5070e0b68406SMatthew Knepley + dm - The DM 5071e0b68406SMatthew Knepley - f - The field index 5072e0b68406SMatthew Knepley 5073e0b68406SMatthew Knepley Output Parameter: 5074e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells 5075e0b68406SMatthew Knepley 5076e0b68406SMatthew Knepley Level: intermediate 5077e0b68406SMatthew Knepley 5078e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField() 5079e0b68406SMatthew Knepley @*/ 5080e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor) 5081e0b68406SMatthew Knepley { 5082e0b68406SMatthew Knepley PetscFunctionBegin; 50832c71b3e2SJacob Faibussowitsch PetscCheckFalse((f < 0) || (f >= dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf); 5084e0b68406SMatthew Knepley *avoidTensor = dm->fields[f].avoidTensor; 5085e0b68406SMatthew Knepley PetscFunctionReturn(0); 5086e0b68406SMatthew Knepley } 5087e0b68406SMatthew Knepley 5088e0b68406SMatthew Knepley /*@ 5089e5e52638SMatthew G. Knepley DMCopyFields - Copy the discretizations for the DM into another DM 5090e5e52638SMatthew G. Knepley 5091d083f849SBarry Smith Collective on dm 5092e5e52638SMatthew G. Knepley 5093e5e52638SMatthew G. Knepley Input Parameter: 5094e5e52638SMatthew G. Knepley . dm - The DM 5095e5e52638SMatthew G. Knepley 5096e5e52638SMatthew G. Knepley Output Parameter: 5097e5e52638SMatthew G. Knepley . newdm - The DM 5098e5e52638SMatthew G. Knepley 5099e5e52638SMatthew G. Knepley Level: advanced 5100e5e52638SMatthew G. Knepley 5101e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS() 5102e5e52638SMatthew G. Knepley @*/ 5103e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm) 5104e5e52638SMatthew G. Knepley { 5105e5e52638SMatthew G. Knepley PetscInt Nf, f; 5106e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5107e5e52638SMatthew G. Knepley 5108e5e52638SMatthew G. Knepley PetscFunctionBegin; 5109e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 5110e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5111e5e52638SMatthew G. Knepley ierr = DMClearFields(newdm);CHKERRQ(ierr); 5112e5e52638SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5113e5e52638SMatthew G. Knepley DMLabel label; 5114e5e52638SMatthew G. Knepley PetscObject field; 511534aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 5116e5e52638SMatthew G. Knepley 5117e5e52638SMatthew G. Knepley ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr); 5118e5e52638SMatthew G. Knepley ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr); 511934aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr); 512034aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr); 512134aa8a36SMatthew G. Knepley } 512234aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 512334aa8a36SMatthew G. Knepley } 512434aa8a36SMatthew G. Knepley 512534aa8a36SMatthew G. Knepley /*@ 512634aa8a36SMatthew G. Knepley DMGetAdjacency - Returns the flags for determining variable influence 512734aa8a36SMatthew G. Knepley 512834aa8a36SMatthew G. Knepley Not collective 512934aa8a36SMatthew G. Knepley 513034aa8a36SMatthew G. Knepley Input Parameters: 513134aa8a36SMatthew G. Knepley + dm - The DM object 513234aa8a36SMatthew G. Knepley - f - The field number, or PETSC_DEFAULT for the default adjacency 513334aa8a36SMatthew G. Knepley 5134d8d19677SJose E. Roman Output Parameters: 513534aa8a36SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 513634aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 513734aa8a36SMatthew G. Knepley 513834aa8a36SMatthew G. Knepley Notes: 513934aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 514034aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 514134aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5142979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 514334aa8a36SMatthew G. Knepley 514434aa8a36SMatthew G. Knepley Level: developer 514534aa8a36SMatthew G. Knepley 514634aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField() 514734aa8a36SMatthew G. Knepley @*/ 514834aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure) 514934aa8a36SMatthew G. Knepley { 515034aa8a36SMatthew G. Knepley PetscFunctionBegin; 515134aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5152534a8f05SLisandro Dalcin if (useCone) PetscValidBoolPointer(useCone, 3); 5153534a8f05SLisandro Dalcin if (useClosure) PetscValidBoolPointer(useClosure, 4); 515434aa8a36SMatthew G. Knepley if (f < 0) { 515534aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->adjacency[0]; 515634aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->adjacency[1]; 515734aa8a36SMatthew G. Knepley } else { 515834aa8a36SMatthew G. Knepley PetscInt Nf; 515934aa8a36SMatthew G. Knepley PetscErrorCode ierr; 516034aa8a36SMatthew G. Knepley 516134aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 51622c71b3e2SJacob Faibussowitsch PetscCheckFalse(f >= Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 516334aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->fields[f].adjacency[0]; 516434aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->fields[f].adjacency[1]; 516534aa8a36SMatthew G. Knepley } 516634aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 516734aa8a36SMatthew G. Knepley } 516834aa8a36SMatthew G. Knepley 516934aa8a36SMatthew G. Knepley /*@ 517034aa8a36SMatthew G. Knepley DMSetAdjacency - Set the flags for determining variable influence 517134aa8a36SMatthew G. Knepley 517234aa8a36SMatthew G. Knepley Not collective 517334aa8a36SMatthew G. Knepley 517434aa8a36SMatthew G. Knepley Input Parameters: 517534aa8a36SMatthew G. Knepley + dm - The DM object 517634aa8a36SMatthew G. Knepley . f - The field number 517734aa8a36SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 517834aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 517934aa8a36SMatthew G. Knepley 518034aa8a36SMatthew G. Knepley Notes: 518134aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 518234aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 518334aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5184979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 518534aa8a36SMatthew G. Knepley 518634aa8a36SMatthew G. Knepley Level: developer 518734aa8a36SMatthew G. Knepley 518834aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField() 518934aa8a36SMatthew G. Knepley @*/ 519034aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure) 519134aa8a36SMatthew G. Knepley { 519234aa8a36SMatthew G. Knepley PetscFunctionBegin; 519334aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 519434aa8a36SMatthew G. Knepley if (f < 0) { 519534aa8a36SMatthew G. Knepley dm->adjacency[0] = useCone; 519634aa8a36SMatthew G. Knepley dm->adjacency[1] = useClosure; 519734aa8a36SMatthew G. Knepley } else { 519834aa8a36SMatthew G. Knepley PetscInt Nf; 519934aa8a36SMatthew G. Knepley PetscErrorCode ierr; 520034aa8a36SMatthew G. Knepley 520134aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 52022c71b3e2SJacob Faibussowitsch PetscCheckFalse(f >= Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 520334aa8a36SMatthew G. Knepley dm->fields[f].adjacency[0] = useCone; 520434aa8a36SMatthew G. Knepley dm->fields[f].adjacency[1] = useClosure; 5205e5e52638SMatthew G. Knepley } 5206e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5207e5e52638SMatthew G. Knepley } 5208e5e52638SMatthew G. Knepley 5209b0441da4SMatthew G. Knepley /*@ 5210b0441da4SMatthew G. Knepley DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined 5211b0441da4SMatthew G. Knepley 5212b0441da4SMatthew G. Knepley Not collective 5213b0441da4SMatthew G. Knepley 5214f899ff85SJose E. Roman Input Parameter: 5215b0441da4SMatthew G. Knepley . dm - The DM object 5216b0441da4SMatthew G. Knepley 5217d8d19677SJose E. Roman Output Parameters: 5218b0441da4SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 5219b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 5220b0441da4SMatthew G. Knepley 5221b0441da4SMatthew G. Knepley Notes: 5222b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 5223b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 5224b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5225b0441da4SMatthew G. Knepley 5226b0441da4SMatthew G. Knepley Level: developer 5227b0441da4SMatthew G. Knepley 5228b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField() 5229b0441da4SMatthew G. Knepley @*/ 5230b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure) 5231b0441da4SMatthew G. Knepley { 5232b0441da4SMatthew G. Knepley PetscInt Nf; 5233b0441da4SMatthew G. Knepley PetscErrorCode ierr; 5234b0441da4SMatthew G. Knepley 5235b0441da4SMatthew G. Knepley PetscFunctionBegin; 5236b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5237064a246eSJacob Faibussowitsch if (useCone) PetscValidBoolPointer(useCone, 2); 5238064a246eSJacob Faibussowitsch if (useClosure) PetscValidBoolPointer(useClosure, 3); 5239b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5240b0441da4SMatthew G. Knepley if (!Nf) { 5241b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 5242b0441da4SMatthew G. Knepley } else { 5243b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 5244b0441da4SMatthew G. Knepley } 5245b0441da4SMatthew G. Knepley PetscFunctionReturn(0); 5246b0441da4SMatthew G. Knepley } 5247b0441da4SMatthew G. Knepley 5248b0441da4SMatthew G. Knepley /*@ 5249b0441da4SMatthew G. Knepley DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined 5250b0441da4SMatthew G. Knepley 5251b0441da4SMatthew G. Knepley Not collective 5252b0441da4SMatthew G. Knepley 5253b0441da4SMatthew G. Knepley Input Parameters: 5254b0441da4SMatthew G. Knepley + dm - The DM object 5255b0441da4SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 5256b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 5257b0441da4SMatthew G. Knepley 5258b0441da4SMatthew G. Knepley Notes: 5259b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 5260b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 5261b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5262b0441da4SMatthew G. Knepley 5263b0441da4SMatthew G. Knepley Level: developer 5264b0441da4SMatthew G. Knepley 5265b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField() 5266b0441da4SMatthew G. Knepley @*/ 5267b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure) 5268b0441da4SMatthew G. Knepley { 5269b0441da4SMatthew G. Knepley PetscInt Nf; 5270b0441da4SMatthew G. Knepley PetscErrorCode ierr; 5271b0441da4SMatthew G. Knepley 5272b0441da4SMatthew G. Knepley PetscFunctionBegin; 5273b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5274b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5275b0441da4SMatthew G. Knepley if (!Nf) { 5276b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 5277b0441da4SMatthew G. Knepley } else { 5278b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 5279e5e52638SMatthew G. Knepley } 5280e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5281e5e52638SMatthew G. Knepley } 5282e5e52638SMatthew G. Knepley 5283783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */ 528445480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label) 5285783e2ec8SMatthew G. Knepley { 5286783e2ec8SMatthew G. Knepley PetscObject obj; 5287783e2ec8SMatthew G. Knepley PetscClassId id; 5288783e2ec8SMatthew G. Knepley PetscInt Nbd, bd; 5289783e2ec8SMatthew G. Knepley PetscBool isFE = PETSC_FALSE; 5290783e2ec8SMatthew G. Knepley PetscBool duplicate = PETSC_FALSE; 5291783e2ec8SMatthew G. Knepley PetscErrorCode ierr; 5292783e2ec8SMatthew G. Knepley 5293783e2ec8SMatthew G. Knepley PetscFunctionBegin; 5294783e2ec8SMatthew G. Knepley ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr); 5295783e2ec8SMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 5296783e2ec8SMatthew G. Knepley if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE; 5297783e2ec8SMatthew G. Knepley if (isFE && label) { 5298783e2ec8SMatthew G. Knepley /* Only want to modify label once */ 5299783e2ec8SMatthew G. Knepley ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr); 5300783e2ec8SMatthew G. Knepley for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) { 530145480ffeSMatthew G. Knepley DMLabel l; 5302783e2ec8SMatthew G. Knepley 530345480ffeSMatthew G. Knepley ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 530445480ffeSMatthew G. Knepley duplicate = l == label ? PETSC_TRUE : PETSC_FALSE; 5305783e2ec8SMatthew G. Knepley if (duplicate) break; 5306783e2ec8SMatthew G. Knepley } 5307783e2ec8SMatthew G. Knepley if (!duplicate) { 5308783e2ec8SMatthew G. Knepley DM plex; 5309783e2ec8SMatthew G. Knepley 5310783e2ec8SMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 5311783e2ec8SMatthew G. Knepley if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);} 5312783e2ec8SMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 5313783e2ec8SMatthew G. Knepley } 5314783e2ec8SMatthew G. Knepley } 5315783e2ec8SMatthew G. Knepley PetscFunctionReturn(0); 5316783e2ec8SMatthew G. Knepley } 5317783e2ec8SMatthew G. Knepley 5318e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew) 5319e5e52638SMatthew G. Knepley { 5320e5e52638SMatthew G. Knepley DMSpace *tmpd; 5321e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5322e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5323e5e52638SMatthew G. Knepley 5324e5e52638SMatthew G. Knepley PetscFunctionBegin; 5325e5e52638SMatthew G. Knepley if (Nds >= NdsNew) PetscFunctionReturn(0); 5326e5e52638SMatthew G. Knepley ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr); 5327e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s]; 5328b3cf3223SMatthew G. Knepley for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;} 5329e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 5330e5e52638SMatthew G. Knepley dm->Nds = NdsNew; 5331e5e52638SMatthew G. Knepley dm->probs = tmpd; 5332e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5333e5e52638SMatthew G. Knepley } 5334e5e52638SMatthew G. Knepley 5335e5e52638SMatthew G. Knepley /*@ 5336e5e52638SMatthew G. Knepley DMGetNumDS - Get the number of discrete systems in the DM 5337e5e52638SMatthew G. Knepley 5338e5e52638SMatthew G. Knepley Not collective 5339e5e52638SMatthew G. Knepley 5340e5e52638SMatthew G. Knepley Input Parameter: 5341e5e52638SMatthew G. Knepley . dm - The DM 5342e5e52638SMatthew G. Knepley 5343e5e52638SMatthew G. Knepley Output Parameter: 5344e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects 5345e5e52638SMatthew G. Knepley 5346e5e52638SMatthew G. Knepley Level: intermediate 5347e5e52638SMatthew G. Knepley 5348e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS() 5349e5e52638SMatthew G. Knepley @*/ 5350e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds) 5351e5e52638SMatthew G. Knepley { 5352e5e52638SMatthew G. Knepley PetscFunctionBegin; 5353e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5354534a8f05SLisandro Dalcin PetscValidIntPointer(Nds, 2); 5355e5e52638SMatthew G. Knepley *Nds = dm->Nds; 5356e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5357e5e52638SMatthew G. Knepley } 5358e5e52638SMatthew G. Knepley 5359e5e52638SMatthew G. Knepley /*@ 5360e5e52638SMatthew G. Knepley DMClearDS - Remove all discrete systems from the DM 5361e5e52638SMatthew G. Knepley 5362d083f849SBarry Smith Logically collective on dm 5363e5e52638SMatthew G. Knepley 5364e5e52638SMatthew G. Knepley Input Parameter: 5365e5e52638SMatthew G. Knepley . dm - The DM 5366e5e52638SMatthew G. Knepley 5367e5e52638SMatthew G. Knepley Level: intermediate 5368e5e52638SMatthew G. Knepley 5369e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField() 5370e5e52638SMatthew G. Knepley @*/ 5371e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm) 5372e5e52638SMatthew G. Knepley { 5373e5e52638SMatthew G. Knepley PetscInt s; 5374e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5375e5e52638SMatthew G. Knepley 5376e5e52638SMatthew G. Knepley PetscFunctionBegin; 5377e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5378e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5379e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5380e5e52638SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr); 5381b3cf3223SMatthew G. Knepley ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr); 5382e5e52638SMatthew G. Knepley } 5383e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 5384e5e52638SMatthew G. Knepley dm->probs = NULL; 5385e5e52638SMatthew G. Knepley dm->Nds = 0; 5386e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5387e5e52638SMatthew G. Knepley } 5388e5e52638SMatthew G. Knepley 5389e5e52638SMatthew G. Knepley /*@ 5390e5e52638SMatthew G. Knepley DMGetDS - Get the default PetscDS 5391e5e52638SMatthew G. Knepley 5392e5e52638SMatthew G. Knepley Not collective 5393e5e52638SMatthew G. Knepley 5394e5e52638SMatthew G. Knepley Input Parameter: 5395e5e52638SMatthew G. Knepley . dm - The DM 5396e5e52638SMatthew G. Knepley 5397e5e52638SMatthew G. Knepley Output Parameter: 5398e5e52638SMatthew G. Knepley . prob - The default PetscDS 5399e5e52638SMatthew G. Knepley 5400e5e52638SMatthew G. Knepley Level: intermediate 5401e5e52638SMatthew G. Knepley 5402e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS() 5403e5e52638SMatthew G. Knepley @*/ 5404e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob) 5405e5e52638SMatthew G. Knepley { 5406b0143b4dSMatthew G. Knepley PetscErrorCode ierr; 5407b0143b4dSMatthew G. Knepley 5408e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5409e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5410e5e52638SMatthew G. Knepley PetscValidPointer(prob, 2); 5411b0143b4dSMatthew G. Knepley if (dm->Nds <= 0) { 5412b0143b4dSMatthew G. Knepley PetscDS ds; 5413b0143b4dSMatthew G. Knepley 541445480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 5415b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr); 5416b0143b4dSMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 5417b0143b4dSMatthew G. Knepley } 5418b0143b4dSMatthew G. Knepley *prob = dm->probs[0].ds; 5419e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5420e5e52638SMatthew G. Knepley } 5421e5e52638SMatthew G. Knepley 5422e5e52638SMatthew G. Knepley /*@ 5423e5e52638SMatthew G. Knepley DMGetCellDS - Get the PetscDS defined on a given cell 5424e5e52638SMatthew G. Knepley 5425e5e52638SMatthew G. Knepley Not collective 5426e5e52638SMatthew G. Knepley 5427e5e52638SMatthew G. Knepley Input Parameters: 5428e5e52638SMatthew G. Knepley + dm - The DM 5429e5e52638SMatthew G. Knepley - point - Cell for the DS 5430e5e52638SMatthew G. Knepley 5431e5e52638SMatthew G. Knepley Output Parameter: 5432e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell 5433e5e52638SMatthew G. Knepley 5434e5e52638SMatthew G. Knepley Level: developer 5435e5e52638SMatthew G. Knepley 5436b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS() 5437e5e52638SMatthew G. Knepley @*/ 5438e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob) 5439e5e52638SMatthew G. Knepley { 5440e5e52638SMatthew G. Knepley PetscDS probDef = NULL; 5441e5e52638SMatthew G. Knepley PetscInt s; 5442e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5443e5e52638SMatthew G. Knepley 5444e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5445e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5446e5e52638SMatthew G. Knepley PetscValidPointer(prob, 3); 54472c71b3e2SJacob Faibussowitsch PetscCheckFalse(point < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point); 5448e5e52638SMatthew G. Knepley *prob = NULL; 5449e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5450e5e52638SMatthew G. Knepley PetscInt val; 5451e5e52638SMatthew G. Knepley 5452e5e52638SMatthew G. Knepley if (!dm->probs[s].label) {probDef = dm->probs[s].ds;} 5453e5e52638SMatthew G. Knepley else { 5454e5e52638SMatthew G. Knepley ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr); 5455e5e52638SMatthew G. Knepley if (val >= 0) {*prob = dm->probs[s].ds; break;} 5456e5e52638SMatthew G. Knepley } 5457e5e52638SMatthew G. Knepley } 5458e5e52638SMatthew G. Knepley if (!*prob) *prob = probDef; 5459e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5460e5e52638SMatthew G. Knepley } 5461e5e52638SMatthew G. Knepley 5462e5e52638SMatthew G. Knepley /*@ 5463e5e52638SMatthew G. Knepley DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel 5464e5e52638SMatthew G. Knepley 5465e5e52638SMatthew G. Knepley Not collective 5466e5e52638SMatthew G. Knepley 5467e5e52638SMatthew G. Knepley Input Parameters: 5468e5e52638SMatthew G. Knepley + dm - The DM 5469e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh 5470e5e52638SMatthew G. Knepley 5471b3cf3223SMatthew G. Knepley Output Parameters: 5472b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5473b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL 5474e5e52638SMatthew G. Knepley 5475154ca461SJed Brown Note: 5476154ca461SJed Brown If a non-NULL label is given, but there is no PetscDS on that specific label, 5477154ca461SJed Brown the PetscDS for the full domain (if present) is returned. Returns with 5478154ca461SJed Brown fields=NULL and prob=NULL if there is no PetscDS for the full domain. 5479e5e52638SMatthew G. Knepley 5480e5e52638SMatthew G. Knepley Level: advanced 5481e5e52638SMatthew G. Knepley 5482e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5483e5e52638SMatthew G. Knepley @*/ 5484b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds) 5485e5e52638SMatthew G. Knepley { 5486e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5487e5e52638SMatthew G. Knepley 5488e5e52638SMatthew G. Knepley PetscFunctionBegin; 5489e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5490e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5491b3cf3223SMatthew G. Knepley if (fields) {PetscValidPointer(fields, 3); *fields = NULL;} 5492b3cf3223SMatthew G. Knepley if (ds) {PetscValidPointer(ds, 4); *ds = NULL;} 5493e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5494154ca461SJed Brown if (dm->probs[s].label == label || !dm->probs[s].label) { 5495b3cf3223SMatthew G. Knepley if (fields) *fields = dm->probs[s].fields; 5496b3cf3223SMatthew G. Knepley if (ds) *ds = dm->probs[s].ds; 5497154ca461SJed Brown if (dm->probs[s].label) PetscFunctionReturn(0); 5498b3cf3223SMatthew G. Knepley } 5499e5e52638SMatthew G. Knepley } 55002df9ee95SMatthew G. Knepley PetscFunctionReturn(0); 5501e5e52638SMatthew G. Knepley } 5502e5e52638SMatthew G. Knepley 5503e5e52638SMatthew G. Knepley /*@ 5504083401c6SMatthew G. Knepley DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel 5505083401c6SMatthew G. Knepley 5506083401c6SMatthew G. Knepley Collective on dm 5507083401c6SMatthew G. Knepley 5508083401c6SMatthew G. Knepley Input Parameters: 5509083401c6SMatthew G. Knepley + dm - The DM 5510083401c6SMatthew G. Knepley . label - The DMLabel defining the mesh region, or NULL for the entire mesh 5511083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields 5512083401c6SMatthew G. Knepley - prob - The PetscDS defined on the given cell 5513083401c6SMatthew G. Knepley 5514083401c6SMatthew 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, 5515083401c6SMatthew G. Knepley the fields argument is ignored. 5516083401c6SMatthew G. Knepley 5517083401c6SMatthew G. Knepley Level: advanced 5518083401c6SMatthew G. Knepley 5519083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS() 5520083401c6SMatthew G. Knepley @*/ 5521083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds) 5522083401c6SMatthew G. Knepley { 5523083401c6SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5524083401c6SMatthew G. Knepley PetscErrorCode ierr; 5525083401c6SMatthew G. Knepley 5526083401c6SMatthew G. Knepley PetscFunctionBegin; 5527083401c6SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5528083401c6SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5529064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4); 5530083401c6SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5531083401c6SMatthew G. Knepley if (dm->probs[s].label == label) { 5532083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5533083401c6SMatthew G. Knepley dm->probs[s].ds = ds; 5534083401c6SMatthew G. Knepley PetscFunctionReturn(0); 5535083401c6SMatthew G. Knepley } 5536083401c6SMatthew G. Knepley } 5537083401c6SMatthew G. Knepley ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr); 5538083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5539083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5540083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5541083401c6SMatthew G. Knepley if (!label) { 5542083401c6SMatthew G. Knepley /* Put the NULL label at the front, so it is returned as the default */ 5543083401c6SMatthew G. Knepley for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s]; 5544083401c6SMatthew G. Knepley Nds = 0; 5545083401c6SMatthew G. Knepley } 5546083401c6SMatthew G. Knepley dm->probs[Nds].label = label; 5547083401c6SMatthew G. Knepley dm->probs[Nds].fields = fields; 5548083401c6SMatthew G. Knepley dm->probs[Nds].ds = ds; 5549083401c6SMatthew G. Knepley PetscFunctionReturn(0); 5550083401c6SMatthew G. Knepley } 5551083401c6SMatthew G. Knepley 5552083401c6SMatthew G. Knepley /*@ 5553e5e52638SMatthew G. Knepley DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number 5554e5e52638SMatthew G. Knepley 5555e5e52638SMatthew G. Knepley Not collective 5556e5e52638SMatthew G. Knepley 5557e5e52638SMatthew G. Knepley Input Parameters: 5558e5e52638SMatthew G. Knepley + dm - The DM 5559e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds) 5560e5e52638SMatthew G. Knepley 5561e5e52638SMatthew G. Knepley Output Parameters: 5562b3cf3223SMatthew G. Knepley + label - The region label, or NULL 5563b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5564083401c6SMatthew G. Knepley - ds - The PetscDS defined on the given region, or NULL 5565e5e52638SMatthew G. Knepley 5566e5e52638SMatthew G. Knepley Level: advanced 5567e5e52638SMatthew G. Knepley 5568e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5569e5e52638SMatthew G. Knepley @*/ 5570b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds) 5571e5e52638SMatthew G. Knepley { 5572e5e52638SMatthew G. Knepley PetscInt Nds; 5573e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5574e5e52638SMatthew G. Knepley 5575e5e52638SMatthew G. Knepley PetscFunctionBegin; 5576e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5577e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 55782c71b3e2SJacob Faibussowitsch PetscCheckFalse((num < 0) || (num >= Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5579e5e52638SMatthew G. Knepley if (label) { 5580e5e52638SMatthew G. Knepley PetscValidPointer(label, 3); 5581e5e52638SMatthew G. Knepley *label = dm->probs[num].label; 5582e5e52638SMatthew G. Knepley } 5583b3cf3223SMatthew G. Knepley if (fields) { 5584b3cf3223SMatthew G. Knepley PetscValidPointer(fields, 4); 5585b3cf3223SMatthew G. Knepley *fields = dm->probs[num].fields; 5586b3cf3223SMatthew G. Knepley } 5587e5e52638SMatthew G. Knepley if (ds) { 5588b3cf3223SMatthew G. Knepley PetscValidPointer(ds, 5); 5589e5e52638SMatthew G. Knepley *ds = dm->probs[num].ds; 5590e5e52638SMatthew G. Knepley } 5591e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5592e5e52638SMatthew G. Knepley } 5593e5e52638SMatthew G. Knepley 5594e5e52638SMatthew G. Knepley /*@ 5595083401c6SMatthew G. Knepley DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number 5596e5e52638SMatthew G. Knepley 5597083401c6SMatthew G. Knepley Not collective 5598e5e52638SMatthew G. Knepley 5599e5e52638SMatthew G. Knepley Input Parameters: 5600e5e52638SMatthew G. Knepley + dm - The DM 5601083401c6SMatthew G. Knepley . num - The region number, in [0, Nds) 5602083401c6SMatthew G. Knepley . label - The region label, or NULL 5603083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting 5604083401c6SMatthew G. Knepley - ds - The PetscDS defined on the given region, or NULL to prevent setting 5605e5e52638SMatthew G. Knepley 5606e5e52638SMatthew G. Knepley Level: advanced 5607e5e52638SMatthew G. Knepley 5608083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5609e5e52638SMatthew G. Knepley @*/ 5610083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds) 5611e5e52638SMatthew G. Knepley { 5612083401c6SMatthew G. Knepley PetscInt Nds; 5613e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5614e5e52638SMatthew G. Knepley 5615e5e52638SMatthew G. Knepley PetscFunctionBegin; 5616e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5617083401c6SMatthew G. Knepley if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);} 5618083401c6SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 56192c71b3e2SJacob Faibussowitsch PetscCheckFalse((num < 0) || (num >= Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5620e5e52638SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5621083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr); 5622083401c6SMatthew G. Knepley dm->probs[num].label = label; 5623083401c6SMatthew G. Knepley if (fields) { 5624083401c6SMatthew G. Knepley PetscValidHeaderSpecific(fields, IS_CLASSID, 4); 5625b3cf3223SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5626083401c6SMatthew G. Knepley ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr); 5627083401c6SMatthew G. Knepley dm->probs[num].fields = fields; 5628e5e52638SMatthew G. Knepley } 5629083401c6SMatthew G. Knepley if (ds) { 5630083401c6SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5); 5631083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5632083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr); 5633083401c6SMatthew G. Knepley dm->probs[num].ds = ds; 5634083401c6SMatthew G. Knepley } 5635e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5636e5e52638SMatthew G. Knepley } 5637e5e52638SMatthew G. Knepley 5638e5e52638SMatthew G. Knepley /*@ 56391d3af9e0SMatthew G. Knepley DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found. 56401d3af9e0SMatthew G. Knepley 56411d3af9e0SMatthew G. Knepley Not collective 56421d3af9e0SMatthew G. Knepley 56431d3af9e0SMatthew G. Knepley Input Parameters: 56441d3af9e0SMatthew G. Knepley + dm - The DM 56451d3af9e0SMatthew G. Knepley - ds - The PetscDS defined on the given region 56461d3af9e0SMatthew G. Knepley 56471d3af9e0SMatthew G. Knepley Output Parameter: 56481d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found 56491d3af9e0SMatthew G. Knepley 56501d3af9e0SMatthew G. Knepley Level: advanced 56511d3af9e0SMatthew G. Knepley 56521d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 56531d3af9e0SMatthew G. Knepley @*/ 56541d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num) 56551d3af9e0SMatthew G. Knepley { 56561d3af9e0SMatthew G. Knepley PetscInt Nds, n; 56571d3af9e0SMatthew G. Knepley PetscErrorCode ierr; 56581d3af9e0SMatthew G. Knepley 56591d3af9e0SMatthew G. Knepley PetscFunctionBegin; 56601d3af9e0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 56611d3af9e0SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2); 56621d3af9e0SMatthew G. Knepley PetscValidPointer(num, 3); 56631d3af9e0SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 56641d3af9e0SMatthew G. Knepley for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break; 56651d3af9e0SMatthew G. Knepley if (n >= Nds) *num = -1; 56661d3af9e0SMatthew G. Knepley else *num = n; 56671d3af9e0SMatthew G. Knepley PetscFunctionReturn(0); 56681d3af9e0SMatthew G. Knepley } 56691d3af9e0SMatthew G. Knepley 5670*2df84da0SMatthew G. Knepley /*@C 5671*2df84da0SMatthew G. Knepley DMCreateFEDefault - Create a PetscFE based on the celltype for the mesh 5672*2df84da0SMatthew G. Knepley 5673*2df84da0SMatthew G. Knepley Not collective 5674*2df84da0SMatthew G. Knepley 5675*2df84da0SMatthew G. Knepley Input Parameter: 5676*2df84da0SMatthew G. Knepley + dm - The DM 5677*2df84da0SMatthew G. Knepley . Nc - The number of components for the field 5678*2df84da0SMatthew G. Knepley . prefix - The options prefix for the output PetscFE, or NULL 5679*2df84da0SMatthew G. Knepley - qorder - The quadrature order or PETSC_DETERMINE to use PetscSpace polynomial degree 5680*2df84da0SMatthew G. Knepley 5681*2df84da0SMatthew G. Knepley Output Parameter: 5682*2df84da0SMatthew G. Knepley . fem - The PetscFE 5683*2df84da0SMatthew G. Knepley 5684*2df84da0SMatthew G. Knepley Note: This is a convenience method that just calls PetscFECreateByCell() underneath. 5685*2df84da0SMatthew G. Knepley 5686*2df84da0SMatthew G. Knepley Level: intermediate 5687*2df84da0SMatthew G. Knepley 5688*2df84da0SMatthew G. Knepley .seealso: PetscFECreateByCell(), DMAddField(), DMCreateDS(), DMGetCellDS(), DMGetRegionDS() 5689*2df84da0SMatthew G. Knepley @*/ 5690*2df84da0SMatthew G. Knepley PetscErrorCode DMCreateFEDefault(DM dm, PetscInt Nc, const char prefix[], PetscInt qorder, PetscFE *fem) 5691*2df84da0SMatthew G. Knepley { 5692*2df84da0SMatthew G. Knepley DMPolytopeType ct; 5693*2df84da0SMatthew G. Knepley PetscInt dim, cStart; 5694*2df84da0SMatthew G. Knepley PetscErrorCode ierr; 5695*2df84da0SMatthew G. Knepley 5696*2df84da0SMatthew G. Knepley PetscFunctionBegin; 5697*2df84da0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5698*2df84da0SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nc, 2); 5699*2df84da0SMatthew G. Knepley if (prefix) PetscValidCharPointer(prefix, 3); 5700*2df84da0SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, qorder, 4); 5701*2df84da0SMatthew G. Knepley PetscValidPointer(fem, 5); 5702*2df84da0SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 5703*2df84da0SMatthew G. Knepley ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr); 5704*2df84da0SMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 5705*2df84da0SMatthew G. Knepley ierr = PetscFECreateByCell(PETSC_COMM_SELF, dim, Nc, ct, prefix, qorder, fem);CHKERRQ(ierr); 5706*2df84da0SMatthew G. Knepley PetscFunctionReturn(0); 5707*2df84da0SMatthew G. Knepley } 5708*2df84da0SMatthew G. Knepley 57091d3af9e0SMatthew G. Knepley /*@ 5710e5e52638SMatthew G. Knepley DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM 5711e5e52638SMatthew G. Knepley 5712d083f849SBarry Smith Collective on dm 5713e5e52638SMatthew G. Knepley 5714e5e52638SMatthew G. Knepley Input Parameter: 5715e5e52638SMatthew G. Knepley . dm - The DM 5716e5e52638SMatthew G. Knepley 571745480ffeSMatthew G. Knepley Options Database Keys: 571845480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM 571945480ffeSMatthew G. Knepley 5720e5e52638SMatthew G. Knepley Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. 5721e5e52638SMatthew G. Knepley 5722e5e52638SMatthew G. Knepley Level: intermediate 5723e5e52638SMatthew G. Knepley 5724e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 5725e5e52638SMatthew G. Knepley @*/ 5726e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm) 5727e5e52638SMatthew G. Knepley { 5728e5e52638SMatthew G. Knepley MPI_Comm comm; 5729083401c6SMatthew G. Knepley PetscDS dsDef; 5730083401c6SMatthew G. Knepley DMLabel *labelSet; 5731f9244615SMatthew G. Knepley PetscInt dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k; 5732f9244615SMatthew G. Knepley PetscBool doSetup = PETSC_TRUE, flg; 5733e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5734e5e52638SMatthew G. Knepley 5735e5e52638SMatthew G. Knepley PetscFunctionBegin; 5736e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5737e5e52638SMatthew G. Knepley if (!dm->fields) PetscFunctionReturn(0); 5738e5e52638SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr); 5739083401c6SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr); 5740083401c6SMatthew G. Knepley /* Determine how many regions we have */ 5741083401c6SMatthew G. Knepley ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr); 5742083401c6SMatthew G. Knepley Nl = 0; 5743083401c6SMatthew G. Knepley Ndef = 0; 5744083401c6SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5745083401c6SMatthew G. Knepley DMLabel label = dm->fields[f].label; 5746083401c6SMatthew G. Knepley PetscInt l; 5747083401c6SMatthew G. Knepley 5748f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 5749f918ec44SMatthew G. Knepley /* Move CEED context to discretizations */ 5750f918ec44SMatthew G. Knepley { 5751f918ec44SMatthew G. Knepley PetscClassId id; 5752f918ec44SMatthew G. Knepley 5753f918ec44SMatthew G. Knepley ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr); 5754f918ec44SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 5755f918ec44SMatthew G. Knepley Ceed ceed; 5756f918ec44SMatthew G. Knepley 5757f918ec44SMatthew G. Knepley ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr); 5758f918ec44SMatthew G. Knepley ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr); 5759f918ec44SMatthew G. Knepley } 5760f918ec44SMatthew G. Knepley } 5761f918ec44SMatthew G. Knepley #endif 5762083401c6SMatthew G. Knepley if (!label) {++Ndef; continue;} 5763083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break; 5764083401c6SMatthew G. Knepley if (l < Nl) continue; 5765083401c6SMatthew G. Knepley labelSet[Nl++] = label; 5766083401c6SMatthew G. Knepley } 5767083401c6SMatthew G. Knepley /* Create default DS if there are no labels to intersect with */ 5768083401c6SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr); 5769083401c6SMatthew G. Knepley if (!dsDef && Ndef && !Nl) { 5770b3cf3223SMatthew G. Knepley IS fields; 5771b3cf3223SMatthew G. Knepley PetscInt *fld, nf; 5772b3cf3223SMatthew G. Knepley 5773b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf; 57742c71b3e2SJacob Faibussowitsch PetscCheckFalse(!nf,comm, PETSC_ERR_PLIB, "All fields have labels, but we are trying to create a default DS"); 5775b3cf3223SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5776b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f; 577788f0c812SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 577888f0c812SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 577988f0c812SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 578088f0c812SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 578188f0c812SMatthew G. Knepley 578245480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr); 5783083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr); 5784083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr); 5785b3cf3223SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 57862df9ee95SMatthew G. Knepley } 5787083401c6SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr); 5788083401c6SMatthew G. Knepley if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);} 5789083401c6SMatthew G. Knepley /* Intersect labels with default fields */ 5790083401c6SMatthew G. Knepley if (Ndef && Nl) { 57910122748bSMatthew G. Knepley DM plex; 5792083401c6SMatthew G. Knepley DMLabel cellLabel; 5793083401c6SMatthew G. Knepley IS fieldIS, allcellIS, defcellIS = NULL; 5794083401c6SMatthew G. Knepley PetscInt *fields; 5795083401c6SMatthew G. Knepley const PetscInt *cells; 5796083401c6SMatthew G. Knepley PetscInt depth, nf = 0, n, c; 57970122748bSMatthew G. Knepley 57980122748bSMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 57990122748bSMatthew G. Knepley ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr); 5800083401c6SMatthew G. Knepley ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr); 5801083401c6SMatthew G. Knepley if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);} 58025fedec97SMatthew G. Knepley /* TODO This looks like it only works for one label */ 5803083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) { 5804083401c6SMatthew G. Knepley DMLabel label = labelSet[l]; 5805083401c6SMatthew G. Knepley IS pointIS; 5806083401c6SMatthew G. Knepley 5807083401c6SMatthew G. Knepley ierr = ISDestroy(&defcellIS);CHKERRQ(ierr); 5808083401c6SMatthew G. Knepley ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr); 5809083401c6SMatthew G. Knepley ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr); 5810083401c6SMatthew G. Knepley ierr = ISDestroy(&pointIS);CHKERRQ(ierr); 5811083401c6SMatthew G. Knepley } 5812083401c6SMatthew G. Knepley ierr = ISDestroy(&allcellIS);CHKERRQ(ierr); 5813083401c6SMatthew G. Knepley 5814083401c6SMatthew G. Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr); 5815083401c6SMatthew G. Knepley ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr); 5816083401c6SMatthew G. Knepley ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr); 5817083401c6SMatthew G. Knepley for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);} 5818083401c6SMatthew G. Knepley ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr); 5819083401c6SMatthew G. Knepley ierr = ISDestroy(&defcellIS);CHKERRQ(ierr); 5820083401c6SMatthew G. Knepley ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr); 5821083401c6SMatthew G. Knepley 5822083401c6SMatthew G. Knepley ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr); 5823083401c6SMatthew G. Knepley for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f; 5824083401c6SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr); 5825083401c6SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr); 5826083401c6SMatthew G. Knepley ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr); 5827083401c6SMatthew G. Knepley ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr); 5828083401c6SMatthew G. Knepley 582945480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr); 5830083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr); 5831083401c6SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr); 58325fedec97SMatthew G. Knepley ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr); 5833083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr); 5834083401c6SMatthew G. Knepley ierr = ISDestroy(&fieldIS);CHKERRQ(ierr); 58350122748bSMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 5836083401c6SMatthew G. Knepley } 5837083401c6SMatthew G. Knepley /* Create label DSes 5838083401c6SMatthew G. Knepley - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS 5839083401c6SMatthew G. Knepley */ 5840083401c6SMatthew G. Knepley /* TODO Should check that labels are disjoint */ 5841083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) { 5842083401c6SMatthew G. Knepley DMLabel label = labelSet[l]; 5843083401c6SMatthew G. Knepley PetscDS ds; 5844083401c6SMatthew G. Knepley IS fields; 5845083401c6SMatthew G. Knepley PetscInt *fld, nf; 5846083401c6SMatthew G. Knepley 584745480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 5848083401c6SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf; 5849083401c6SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5850083401c6SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f; 5851083401c6SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 5852083401c6SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 5853083401c6SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 5854083401c6SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 5855083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr); 5856083401c6SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 5857083401c6SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr); 5858083401c6SMatthew G. Knepley { 5859083401c6SMatthew G. Knepley DMPolytopeType ct; 5860083401c6SMatthew G. Knepley PetscInt lStart, lEnd; 58615fedec97SMatthew G. Knepley PetscBool isCohesiveLocal = PETSC_FALSE, isCohesive; 58620122748bSMatthew G. Knepley 5863e5e52638SMatthew G. Knepley ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr); 5864665f567fSMatthew G. Knepley if (lStart >= 0) { 5865412e9a14SMatthew G. Knepley ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr); 5866412e9a14SMatthew G. Knepley switch (ct) { 5867412e9a14SMatthew G. Knepley case DM_POLYTOPE_POINT_PRISM_TENSOR: 5868412e9a14SMatthew G. Knepley case DM_POLYTOPE_SEG_PRISM_TENSOR: 5869412e9a14SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM_TENSOR: 5870412e9a14SMatthew G. Knepley case DM_POLYTOPE_QUAD_PRISM_TENSOR: 58715fedec97SMatthew G. Knepley isCohesiveLocal = PETSC_TRUE;break; 5872083401c6SMatthew G. Knepley default: break; 5873412e9a14SMatthew G. Knepley } 5874665f567fSMatthew G. Knepley } 58755fedec97SMatthew G. Knepley ierr = MPI_Allreduce(&isCohesiveLocal, &isCohesive, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr); 58765fedec97SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) { 58775fedec97SMatthew G. Knepley if (label == dm->fields[f].label || !dm->fields[f].label) { 58785fedec97SMatthew G. Knepley if (label == dm->fields[f].label) { 58795fedec97SMatthew G. Knepley ierr = PetscDSSetDiscretization(ds, nf, NULL);CHKERRQ(ierr); 58805fedec97SMatthew G. Knepley ierr = PetscDSSetCohesive(ds, nf, isCohesive);CHKERRQ(ierr); 58815fedec97SMatthew G. Knepley } 58825fedec97SMatthew G. Knepley ++nf; 58835fedec97SMatthew G. Knepley } 58845fedec97SMatthew G. Knepley } 5885e5e52638SMatthew G. Knepley } 5886083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 5887e5e52638SMatthew G. Knepley } 5888083401c6SMatthew G. Knepley ierr = PetscFree(labelSet);CHKERRQ(ierr); 5889e5e52638SMatthew G. Knepley /* Set fields in DSes */ 5890083401c6SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5891083401c6SMatthew G. Knepley PetscDS ds = dm->probs[s].ds; 5892083401c6SMatthew G. Knepley IS fields = dm->probs[s].fields; 5893083401c6SMatthew G. Knepley const PetscInt *fld; 58945fedec97SMatthew G. Knepley PetscInt nf, dsnf; 58955fedec97SMatthew G. Knepley PetscBool isCohesive; 5896e5e52638SMatthew G. Knepley 58975fedec97SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsnf);CHKERRQ(ierr); 58985fedec97SMatthew G. Knepley ierr = PetscDSIsCohesive(ds, &isCohesive);CHKERRQ(ierr); 5899083401c6SMatthew G. Knepley ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr); 5900083401c6SMatthew G. Knepley ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr); 5901083401c6SMatthew G. Knepley for (f = 0; f < nf; ++f) { 5902083401c6SMatthew G. Knepley PetscObject disc = dm->fields[fld[f]].disc; 59035fedec97SMatthew G. Knepley PetscBool isCohesiveField; 5904e5e52638SMatthew G. Knepley PetscClassId id; 5905e5e52638SMatthew G. Knepley 59065fedec97SMatthew G. Knepley /* Handle DS with no fields */ 59075fedec97SMatthew G. Knepley if (dsnf) {ierr = PetscDSGetCohesive(ds, f, &isCohesiveField);CHKERRQ(ierr);} 59085fedec97SMatthew G. Knepley /* If this is a cohesive cell, then regular fields need the lower dimensional discretization */ 59095fedec97SMatthew G. Knepley if (isCohesive && !isCohesiveField) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);} 5910083401c6SMatthew G. Knepley ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr); 5911083401c6SMatthew G. Knepley /* We allow people to have placeholder fields and construct the Section by hand */ 5912e5e52638SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 5913e5e52638SMatthew G. Knepley if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE; 5914e5e52638SMatthew G. Knepley } 5915083401c6SMatthew G. Knepley ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr); 5916e5e52638SMatthew G. Knepley } 5917f9244615SMatthew G. Knepley /* Allow k-jet tabulation */ 5918f9244615SMatthew G. Knepley ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr); 5919f9244615SMatthew G. Knepley if (flg) { 59203b4aee56SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 59213b4aee56SMatthew G. Knepley PetscDS ds = dm->probs[s].ds; 59223b4aee56SMatthew G. Knepley PetscInt Nf, f; 59233b4aee56SMatthew G. Knepley 59243b4aee56SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr); 59253b4aee56SMatthew G. Knepley for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);} 59263b4aee56SMatthew G. Knepley } 5927f9244615SMatthew G. Knepley } 5928e5e52638SMatthew G. Knepley /* Setup DSes */ 5929e5e52638SMatthew G. Knepley if (doSetup) { 5930e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);} 5931e5e52638SMatthew G. Knepley } 5932e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5933e5e52638SMatthew G. Knepley } 5934e5e52638SMatthew G. Knepley 5935e5e52638SMatthew G. Knepley /*@ 59367f96f943SMatthew G. Knepley DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information. 59377f96f943SMatthew G. Knepley 5938f2cacb80SMatthew G. Knepley Collective on DM 5939f2cacb80SMatthew G. Knepley 59407f96f943SMatthew G. Knepley Input Parameters: 59417f96f943SMatthew G. Knepley + dm - The DM 59427f96f943SMatthew G. Knepley - time - The time 59437f96f943SMatthew G. Knepley 59447f96f943SMatthew G. Knepley Output Parameters: 5945f2cacb80SMatthew G. Knepley + u - The vector will be filled with exact solution values, or NULL 5946f2cacb80SMatthew G. Knepley - u_t - The vector will be filled with the time derivative of exact solution values, or NULL 59477f96f943SMatthew G. Knepley 59487f96f943SMatthew G. Knepley Note: The user must call PetscDSSetExactSolution() beforehand 59497f96f943SMatthew G. Knepley 59507f96f943SMatthew G. Knepley Level: developer 59517f96f943SMatthew G. Knepley 59527f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution() 59537f96f943SMatthew G. Knepley @*/ 5954f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t) 59557f96f943SMatthew G. Knepley { 59567f96f943SMatthew G. Knepley PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx); 59577f96f943SMatthew G. Knepley void **ectxs; 59587f96f943SMatthew G. Knepley PetscInt Nf, Nds, s; 59597f96f943SMatthew G. Knepley PetscErrorCode ierr; 59607f96f943SMatthew G. Knepley 59617f96f943SMatthew G. Knepley PetscFunctionBegin; 5962f2cacb80SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5963f2cacb80SMatthew G. Knepley if (u) PetscValidHeaderSpecific(u, VEC_CLASSID, 3); 5964f2cacb80SMatthew G. Knepley if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4); 59657f96f943SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 59667f96f943SMatthew G. Knepley ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr); 59677f96f943SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 59687f96f943SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 59697f96f943SMatthew G. Knepley PetscDS ds; 59707f96f943SMatthew G. Knepley DMLabel label; 59717f96f943SMatthew G. Knepley IS fieldIS; 59727f96f943SMatthew G. Knepley const PetscInt *fields, id = 1; 59737f96f943SMatthew G. Knepley PetscInt dsNf, f; 59747f96f943SMatthew G. Knepley 59757f96f943SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr); 59767f96f943SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr); 59777f96f943SMatthew G. Knepley ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr); 59787f96f943SMatthew G. Knepley ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr); 59797f96f943SMatthew G. Knepley ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr); 5980f2cacb80SMatthew G. Knepley if (u) { 59817f96f943SMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 59827f96f943SMatthew G. Knepley const PetscInt field = fields[f]; 59837f96f943SMatthew G. Knepley ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr); 59847f96f943SMatthew G. Knepley } 59857f96f943SMatthew G. Knepley ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr); 59867f96f943SMatthew G. Knepley if (label) { 59877f96f943SMatthew G. Knepley ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr); 59887f96f943SMatthew G. Knepley } else { 59897f96f943SMatthew G. Knepley ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr); 59907f96f943SMatthew G. Knepley } 59917f96f943SMatthew G. Knepley } 5992f2cacb80SMatthew G. Knepley if (u_t) { 5993f2cacb80SMatthew G. Knepley ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr); 5994f2cacb80SMatthew G. Knepley ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr); 5995f2cacb80SMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 5996f2cacb80SMatthew G. Knepley const PetscInt field = fields[f]; 5997f2cacb80SMatthew G. Knepley ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr); 5998f2cacb80SMatthew G. Knepley } 5999f2cacb80SMatthew G. Knepley ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr); 6000f2cacb80SMatthew G. Knepley if (label) { 6001f2cacb80SMatthew G. Knepley ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr); 6002f2cacb80SMatthew G. Knepley } else { 6003f2cacb80SMatthew G. Knepley ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr); 6004f2cacb80SMatthew G. Knepley } 6005f2cacb80SMatthew G. Knepley } 6006f2cacb80SMatthew G. Knepley } 6007f2cacb80SMatthew G. Knepley if (u) { 60087f96f943SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr); 60097f96f943SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr); 6010f2cacb80SMatthew G. Knepley } 6011f2cacb80SMatthew G. Knepley if (u_t) { 6012f2cacb80SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr); 6013f2cacb80SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr); 6014f2cacb80SMatthew G. Knepley } 60157f96f943SMatthew G. Knepley ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr); 60167f96f943SMatthew G. Knepley PetscFunctionReturn(0); 60177f96f943SMatthew G. Knepley } 60187f96f943SMatthew G. Knepley 601945480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds) 602045480ffeSMatthew G. Knepley { 602145480ffeSMatthew G. Knepley PetscDS dsNew; 602245480ffeSMatthew G. Knepley DSBoundary b; 602345480ffeSMatthew G. Knepley PetscInt cdim, Nf, f; 60245fedec97SMatthew G. Knepley PetscBool isCohesive; 602545480ffeSMatthew G. Knepley void *ctx; 602645480ffeSMatthew G. Knepley PetscErrorCode ierr; 602745480ffeSMatthew G. Knepley 602845480ffeSMatthew G. Knepley PetscFunctionBegin; 602945480ffeSMatthew G. Knepley ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr); 603045480ffeSMatthew G. Knepley ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr); 603145480ffeSMatthew G. Knepley ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr); 603245480ffeSMatthew G. Knepley ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr); 603345480ffeSMatthew G. Knepley ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr); 603445480ffeSMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr); 603545480ffeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 603645480ffeSMatthew G. Knepley ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr); 603745480ffeSMatthew G. Knepley ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr); 60385fedec97SMatthew G. Knepley ierr = PetscDSGetCohesive(ds, f, &isCohesive);CHKERRQ(ierr); 60395fedec97SMatthew G. Knepley ierr = PetscDSSetCohesive(dsNew, f, isCohesive);CHKERRQ(ierr); 604045480ffeSMatthew G. Knepley } 604145480ffeSMatthew G. Knepley if (Nf) { 604245480ffeSMatthew G. Knepley ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr); 604345480ffeSMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr); 604445480ffeSMatthew G. Knepley } 604545480ffeSMatthew G. Knepley ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr); 604645480ffeSMatthew G. Knepley for (b = dsNew->boundary; b; b = b->next) { 604745480ffeSMatthew G. Knepley ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr); 604845480ffeSMatthew G. Knepley /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */ 60492c71b3e2SJacob Faibussowitsch //PetscCheckFalse(!b->label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name); 605045480ffeSMatthew G. Knepley } 605145480ffeSMatthew G. Knepley 605245480ffeSMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr); 605345480ffeSMatthew G. Knepley ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr); 605445480ffeSMatthew G. Knepley PetscFunctionReturn(0); 605545480ffeSMatthew G. Knepley } 605645480ffeSMatthew G. Knepley 60577f96f943SMatthew G. Knepley /*@ 6058e5e52638SMatthew G. Knepley DMCopyDS - Copy the discrete systems for the DM into another DM 6059e5e52638SMatthew G. Knepley 6060d083f849SBarry Smith Collective on dm 6061e5e52638SMatthew G. Knepley 6062e5e52638SMatthew G. Knepley Input Parameter: 6063e5e52638SMatthew G. Knepley . dm - The DM 6064e5e52638SMatthew G. Knepley 6065e5e52638SMatthew G. Knepley Output Parameter: 6066e5e52638SMatthew G. Knepley . newdm - The DM 6067e5e52638SMatthew G. Knepley 6068e5e52638SMatthew G. Knepley Level: advanced 6069e5e52638SMatthew G. Knepley 6070e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 6071e5e52638SMatthew G. Knepley @*/ 6072e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm) 6073e5e52638SMatthew G. Knepley { 6074e5e52638SMatthew G. Knepley PetscInt Nds, s; 6075e5e52638SMatthew G. Knepley PetscErrorCode ierr; 6076e5e52638SMatthew G. Knepley 6077e5e52638SMatthew G. Knepley PetscFunctionBegin; 6078e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 6079e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 6080e5e52638SMatthew G. Knepley ierr = DMClearDS(newdm);CHKERRQ(ierr); 6081e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 6082e5e52638SMatthew G. Knepley DMLabel label; 6083b3cf3223SMatthew G. Knepley IS fields; 608445480ffeSMatthew G. Knepley PetscDS ds, newds; 6085783e2ec8SMatthew G. Knepley PetscInt Nbd, bd; 6086e5e52638SMatthew G. Knepley 6087b3cf3223SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr); 6088b8025e53SMatthew G. Knepley /* TODO: We need to change all keys from labels in the old DM to labels in the new DM */ 608945480ffeSMatthew G. Knepley ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr); 609045480ffeSMatthew G. Knepley /* Commplete new labels in the new DS */ 609145480ffeSMatthew G. Knepley ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr); 609245480ffeSMatthew G. Knepley ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr); 6093783e2ec8SMatthew G. Knepley for (bd = 0; bd < Nbd; ++bd) { 6094b8025e53SMatthew G. Knepley PetscWeakForm wf; 609545480ffeSMatthew G. Knepley DMLabel label; 6096783e2ec8SMatthew G. Knepley PetscInt field; 6097783e2ec8SMatthew G. Knepley 6098b8025e53SMatthew G. Knepley ierr = PetscDSGetBoundary(newds, bd, &wf, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 609945480ffeSMatthew G. Knepley ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr); 6100b8025e53SMatthew G. Knepley ierr = PetscWeakFormReplaceLabel(wf, label);CHKERRQ(ierr); 6101783e2ec8SMatthew G. Knepley } 6102e5e52638SMatthew G. Knepley } 6103e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 6104e5e52638SMatthew G. Knepley } 6105e5e52638SMatthew G. Knepley 6106e5e52638SMatthew G. Knepley /*@ 6107e5e52638SMatthew G. Knepley DMCopyDisc - Copy the fields and discrete systems for the DM into another DM 6108e5e52638SMatthew G. Knepley 6109d083f849SBarry Smith Collective on dm 6110e5e52638SMatthew G. Knepley 6111e5e52638SMatthew G. Knepley Input Parameter: 6112e5e52638SMatthew G. Knepley . dm - The DM 6113e5e52638SMatthew G. Knepley 6114e5e52638SMatthew G. Knepley Output Parameter: 6115e5e52638SMatthew G. Knepley . newdm - The DM 6116e5e52638SMatthew G. Knepley 6117e5e52638SMatthew G. Knepley Level: advanced 6118e5e52638SMatthew G. Knepley 6119e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS() 6120e5e52638SMatthew G. Knepley @*/ 6121e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm) 6122e5e52638SMatthew G. Knepley { 6123e5e52638SMatthew G. Knepley PetscErrorCode ierr; 6124e5e52638SMatthew G. Knepley 6125e5e52638SMatthew G. Knepley PetscFunctionBegin; 6126e5e52638SMatthew G. Knepley ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr); 6127e5e52638SMatthew G. Knepley ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr); 6128e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 6129e5e52638SMatthew G. Knepley } 6130e5e52638SMatthew G. Knepley 6131b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx) 6132b64e0483SPeter Brune { 6133b64e0483SPeter Brune DM dm_coord,dmc_coord; 6134b64e0483SPeter Brune PetscErrorCode ierr; 6135b64e0483SPeter Brune Vec coords,ccoords; 61366dbf9973SLawrence Mitchell Mat inject; 6137b64e0483SPeter Brune PetscFunctionBegin; 6138b64e0483SPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 6139b64e0483SPeter Brune ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr); 6140b64e0483SPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 6141b64e0483SPeter Brune ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr); 6142b64e0483SPeter Brune if (coords && !ccoords) { 6143b64e0483SPeter Brune ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr); 61446668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 61456dbf9973SLawrence Mitchell ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr); 61462adcf181SLawrence Mitchell ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr); 61476dbf9973SLawrence Mitchell ierr = MatDestroy(&inject);CHKERRQ(ierr); 6148b64e0483SPeter Brune ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr); 6149b64e0483SPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 6150b64e0483SPeter Brune } 6151b64e0483SPeter Brune PetscFunctionReturn(0); 6152b64e0483SPeter Brune } 6153b64e0483SPeter Brune 615403dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx) 615503dadc2fSPeter Brune { 615603dadc2fSPeter Brune DM dm_coord,subdm_coord; 615703dadc2fSPeter Brune PetscErrorCode ierr; 615803dadc2fSPeter Brune Vec coords,ccoords,clcoords; 615903dadc2fSPeter Brune VecScatter *scat_i,*scat_g; 616003dadc2fSPeter Brune PetscFunctionBegin; 616103dadc2fSPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 616203dadc2fSPeter Brune ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr); 616303dadc2fSPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 616403dadc2fSPeter Brune ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr); 616503dadc2fSPeter Brune if (coords && !ccoords) { 616603dadc2fSPeter Brune ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr); 61676668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 616803dadc2fSPeter Brune ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr); 616924640c55SToby Isaac ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr); 617003dadc2fSPeter Brune ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr); 617103dadc2fSPeter Brune ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 617203dadc2fSPeter Brune ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 61731ed9ada7SJunchao Zhang ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 617403dadc2fSPeter Brune ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 617503dadc2fSPeter Brune ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr); 617603dadc2fSPeter Brune ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr); 617703dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr); 617803dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr); 617903dadc2fSPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 618003dadc2fSPeter Brune ierr = VecDestroy(&clcoords);CHKERRQ(ierr); 618103dadc2fSPeter Brune ierr = PetscFree(scat_i);CHKERRQ(ierr); 618203dadc2fSPeter Brune ierr = PetscFree(scat_g);CHKERRQ(ierr); 618303dadc2fSPeter Brune } 618403dadc2fSPeter Brune PetscFunctionReturn(0); 618503dadc2fSPeter Brune } 618603dadc2fSPeter Brune 6187c73cfb54SMatthew G. Knepley /*@ 6188c73cfb54SMatthew G. Knepley DMGetDimension - Return the topological dimension of the DM 6189c73cfb54SMatthew G. Knepley 6190c73cfb54SMatthew G. Knepley Not collective 6191c73cfb54SMatthew G. Knepley 6192c73cfb54SMatthew G. Knepley Input Parameter: 6193c73cfb54SMatthew G. Knepley . dm - The DM 6194c73cfb54SMatthew G. Knepley 6195c73cfb54SMatthew G. Knepley Output Parameter: 6196c73cfb54SMatthew G. Knepley . dim - The topological dimension 6197c73cfb54SMatthew G. Knepley 6198c73cfb54SMatthew G. Knepley Level: beginner 6199c73cfb54SMatthew G. Knepley 6200c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate() 6201c73cfb54SMatthew G. Knepley @*/ 6202c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim) 6203c73cfb54SMatthew G. Knepley { 6204c73cfb54SMatthew G. Knepley PetscFunctionBegin; 6205c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6206534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 6207c73cfb54SMatthew G. Knepley *dim = dm->dim; 6208c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 6209c73cfb54SMatthew G. Knepley } 6210c73cfb54SMatthew G. Knepley 6211c73cfb54SMatthew G. Knepley /*@ 6212c73cfb54SMatthew G. Knepley DMSetDimension - Set the topological dimension of the DM 6213c73cfb54SMatthew G. Knepley 6214c73cfb54SMatthew G. Knepley Collective on dm 6215c73cfb54SMatthew G. Knepley 6216c73cfb54SMatthew G. Knepley Input Parameters: 6217c73cfb54SMatthew G. Knepley + dm - The DM 6218c73cfb54SMatthew G. Knepley - dim - The topological dimension 6219c73cfb54SMatthew G. Knepley 6220c73cfb54SMatthew G. Knepley Level: beginner 6221c73cfb54SMatthew G. Knepley 6222c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate() 6223c73cfb54SMatthew G. Knepley @*/ 6224c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim) 6225c73cfb54SMatthew G. Knepley { 6226e5e52638SMatthew G. Knepley PetscDS ds; 622745480ffeSMatthew G. Knepley PetscInt Nds, n; 6228f17e8794SMatthew G. Knepley PetscErrorCode ierr; 6229f17e8794SMatthew G. Knepley 6230c73cfb54SMatthew G. Knepley PetscFunctionBegin; 6231c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6232c73cfb54SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, dim, 2); 6233c73cfb54SMatthew G. Knepley dm->dim = dim; 6234d17bd122SMatthew G. Knepley if (dm->dim >= 0) { 623545480ffeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 623645480ffeSMatthew G. Knepley for (n = 0; n < Nds; ++n) { 623745480ffeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr); 623845480ffeSMatthew G. Knepley if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);} 623945480ffeSMatthew G. Knepley } 6240d17bd122SMatthew G. Knepley } 6241c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 6242c73cfb54SMatthew G. Knepley } 6243c73cfb54SMatthew G. Knepley 6244793f3fe5SMatthew G. Knepley /*@ 6245793f3fe5SMatthew G. Knepley DMGetDimPoints - Get the half-open interval for all points of a given dimension 6246793f3fe5SMatthew G. Knepley 6247d083f849SBarry Smith Collective on dm 6248793f3fe5SMatthew G. Knepley 6249793f3fe5SMatthew G. Knepley Input Parameters: 6250793f3fe5SMatthew G. Knepley + dm - the DM 6251793f3fe5SMatthew G. Knepley - dim - the dimension 6252793f3fe5SMatthew G. Knepley 6253793f3fe5SMatthew G. Knepley Output Parameters: 6254793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension 6255aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension 6256793f3fe5SMatthew G. Knepley 6257793f3fe5SMatthew G. Knepley Note: 6258793f3fe5SMatthew G. Knepley The points are vertices in the Hasse diagram encoding the topology. This is explained in 6259a8d69d7bSBarry Smith https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme, 6260793f3fe5SMatthew G. Knepley then the interval is empty. 6261793f3fe5SMatthew G. Knepley 6262793f3fe5SMatthew G. Knepley Level: intermediate 6263793f3fe5SMatthew G. Knepley 6264793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum() 6265793f3fe5SMatthew G. Knepley @*/ 6266793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd) 6267793f3fe5SMatthew G. Knepley { 6268793f3fe5SMatthew G. Knepley PetscInt d; 6269793f3fe5SMatthew G. Knepley PetscErrorCode ierr; 6270793f3fe5SMatthew G. Knepley 6271793f3fe5SMatthew G. Knepley PetscFunctionBegin; 6272793f3fe5SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6273793f3fe5SMatthew G. Knepley ierr = DMGetDimension(dm, &d);CHKERRQ(ierr); 62742c71b3e2SJacob Faibussowitsch PetscCheckFalse((dim < 0) || (dim > d),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d); 62752c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->getdimpoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name); 6276793f3fe5SMatthew G. Knepley ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr); 6277793f3fe5SMatthew G. Knepley PetscFunctionReturn(0); 6278793f3fe5SMatthew G. Knepley } 6279793f3fe5SMatthew G. Knepley 62806636e97aSMatthew G Knepley /*@ 62816636e97aSMatthew G Knepley DMSetCoordinates - Sets into the DM a global vector that holds the coordinates 62826636e97aSMatthew G Knepley 6283d083f849SBarry Smith Collective on dm 62846636e97aSMatthew G Knepley 62856636e97aSMatthew G Knepley Input Parameters: 62866636e97aSMatthew G Knepley + dm - the DM 62876636e97aSMatthew G Knepley - c - coordinate vector 62886636e97aSMatthew G Knepley 62892dd40e9bSPatrick Sanan Notes: 62902dd40e9bSPatrick Sanan The coordinates do include those for ghost points, which are in the local vector. 62912dd40e9bSPatrick Sanan 62922dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 62936636e97aSMatthew G Knepley 62946636e97aSMatthew G Knepley Level: intermediate 62956636e97aSMatthew G Knepley 629660c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates() 62976636e97aSMatthew G Knepley @*/ 62986636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(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 PetscValidHeaderSpecific(c,VEC_CLASSID,2); 63056636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 63066636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 63076636e97aSMatthew G Knepley dm->coordinates = c; 63086636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 6309b64e0483SPeter Brune ierr = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 631003dadc2fSPeter Brune ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 63116636e97aSMatthew G Knepley PetscFunctionReturn(0); 63126636e97aSMatthew G Knepley } 63136636e97aSMatthew G Knepley 63146636e97aSMatthew G Knepley /*@ 63156636e97aSMatthew G Knepley DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates 63166636e97aSMatthew G Knepley 63177058e716SVaclav Hapla Not collective 63186636e97aSMatthew G Knepley 63196636e97aSMatthew G Knepley Input Parameters: 63206636e97aSMatthew G Knepley + dm - the DM 63216636e97aSMatthew G Knepley - c - coordinate vector 63226636e97aSMatthew G Knepley 63232dd40e9bSPatrick Sanan Notes: 63246636e97aSMatthew G Knepley The coordinates of ghost points can be set using DMSetCoordinates() 63256636e97aSMatthew G Knepley followed by DMGetCoordinatesLocal(). This is intended to enable the 63266636e97aSMatthew G Knepley setting of ghost coordinates outside of the domain. 63276636e97aSMatthew G Knepley 63282dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 63292dd40e9bSPatrick Sanan 63306636e97aSMatthew G Knepley Level: intermediate 63316636e97aSMatthew G Knepley 63326636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM() 63336636e97aSMatthew G Knepley @*/ 63346636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c) 63356636e97aSMatthew G Knepley { 63366636e97aSMatthew G Knepley PetscErrorCode ierr; 63376636e97aSMatthew G Knepley 63386636e97aSMatthew G Knepley PetscFunctionBegin; 63396636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6340b7f5c055SJed Brown if (c) PetscValidHeaderSpecific(c,VEC_CLASSID,2); 63416636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 63426636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 63438865f1eaSKarl Rupp 63446636e97aSMatthew G Knepley dm->coordinatesLocal = c; 63458865f1eaSKarl Rupp 63466636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 63476636e97aSMatthew G Knepley PetscFunctionReturn(0); 63486636e97aSMatthew G Knepley } 63496636e97aSMatthew G Knepley 63506636e97aSMatthew G Knepley /*@ 63516636e97aSMatthew G Knepley DMGetCoordinates - Gets a global vector with the coordinates associated with the DM. 63526636e97aSMatthew G Knepley 6353d083f849SBarry Smith Collective on dm 63546636e97aSMatthew G Knepley 63556636e97aSMatthew G Knepley Input Parameter: 63566636e97aSMatthew G Knepley . dm - the DM 63576636e97aSMatthew G Knepley 63586636e97aSMatthew G Knepley Output Parameter: 63596636e97aSMatthew G Knepley . c - global coordinate vector 63606636e97aSMatthew G Knepley 63616636e97aSMatthew G Knepley Note: 636260c22052SBarry Smith This is a borrowed reference, so the user should NOT destroy this vector. When the DM is 636360c22052SBarry Smith destroyed the array will no longer be valid. 63646636e97aSMatthew G Knepley 6365959c7569SPatrick Sanan Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates). 63666636e97aSMatthew G Knepley 63676636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 63686636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 63696636e97aSMatthew G Knepley 63706636e97aSMatthew G Knepley Level: intermediate 63716636e97aSMatthew G Knepley 637260c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates() 63736636e97aSMatthew G Knepley @*/ 63746636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c) 63756636e97aSMatthew G Knepley { 63766636e97aSMatthew G Knepley PetscErrorCode ierr; 63776636e97aSMatthew G Knepley 63786636e97aSMatthew G Knepley PetscFunctionBegin; 63796636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 63806636e97aSMatthew G Knepley PetscValidPointer(c,2); 63811f588964SMatthew G Knepley if (!dm->coordinates && dm->coordinatesLocal) { 63820298fd71SBarry Smith DM cdm = NULL; 63831970a576SMatthew G. Knepley PetscBool localized; 63846636e97aSMatthew G Knepley 63856636e97aSMatthew G Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 63866636e97aSMatthew G Knepley ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr); 63871970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 63881970a576SMatthew G. Knepley /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */ 63891970a576SMatthew G. Knepley if (localized) { 63901970a576SMatthew G. Knepley PetscInt cdim; 63911970a576SMatthew G. Knepley 63921970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 63931970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 63941970a576SMatthew G. Knepley } 63956636e97aSMatthew G Knepley ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr); 63966636e97aSMatthew G Knepley ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 63976636e97aSMatthew G Knepley ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 63986636e97aSMatthew G Knepley } 63996636e97aSMatthew G Knepley *c = dm->coordinates; 64006636e97aSMatthew G Knepley PetscFunctionReturn(0); 64016636e97aSMatthew G Knepley } 64026636e97aSMatthew G Knepley 64036636e97aSMatthew G Knepley /*@ 640481e9a530SVaclav Hapla DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards. 640581e9a530SVaclav Hapla 6406d083f849SBarry Smith Collective on dm 640781e9a530SVaclav Hapla 640881e9a530SVaclav Hapla Input Parameter: 640981e9a530SVaclav Hapla . dm - the DM 641081e9a530SVaclav Hapla 641181e9a530SVaclav Hapla Level: advanced 641281e9a530SVaclav Hapla 641381e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective() 641481e9a530SVaclav Hapla @*/ 641581e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm) 641681e9a530SVaclav Hapla { 641781e9a530SVaclav Hapla PetscErrorCode ierr; 641881e9a530SVaclav Hapla 641981e9a530SVaclav Hapla PetscFunctionBegin; 642081e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 642181e9a530SVaclav Hapla if (!dm->coordinatesLocal && dm->coordinates) { 64221970a576SMatthew G. Knepley DM cdm = NULL; 64231970a576SMatthew G. Knepley PetscBool localized; 64241970a576SMatthew G. Knepley 642581e9a530SVaclav Hapla ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 642681e9a530SVaclav Hapla ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr); 64271970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 64281970a576SMatthew G. Knepley /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */ 64291970a576SMatthew G. Knepley if (localized) { 64301970a576SMatthew G. Knepley PetscInt cdim; 64311970a576SMatthew G. Knepley 64321970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 64331970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 64341970a576SMatthew G. Knepley } 643581e9a530SVaclav Hapla ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr); 643681e9a530SVaclav Hapla ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 643781e9a530SVaclav Hapla ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 643881e9a530SVaclav Hapla } 643981e9a530SVaclav Hapla PetscFunctionReturn(0); 644081e9a530SVaclav Hapla } 644181e9a530SVaclav Hapla 644281e9a530SVaclav Hapla /*@ 64436636e97aSMatthew G Knepley DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM. 64446636e97aSMatthew G Knepley 6445d083f849SBarry Smith Collective on dm 64466636e97aSMatthew G Knepley 64476636e97aSMatthew G Knepley Input Parameter: 64486636e97aSMatthew G Knepley . dm - the DM 64496636e97aSMatthew G Knepley 64506636e97aSMatthew G Knepley Output Parameter: 64516636e97aSMatthew G Knepley . c - coordinate vector 64526636e97aSMatthew G Knepley 64536636e97aSMatthew G Knepley Note: 64546636e97aSMatthew G Knepley This is a borrowed reference, so the user should NOT destroy this vector 64556636e97aSMatthew G Knepley 64566636e97aSMatthew G Knepley Each process has the local and ghost coordinates 64576636e97aSMatthew G Knepley 64586636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 64596636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 64606636e97aSMatthew G Knepley 64616636e97aSMatthew G Knepley Level: intermediate 64626636e97aSMatthew G Knepley 646381e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective() 64646636e97aSMatthew G Knepley @*/ 64656636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c) 64666636e97aSMatthew G Knepley { 64676636e97aSMatthew G Knepley PetscErrorCode ierr; 64686636e97aSMatthew G Knepley 64696636e97aSMatthew G Knepley PetscFunctionBegin; 64706636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 64716636e97aSMatthew G Knepley PetscValidPointer(c,2); 647281e9a530SVaclav Hapla ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr); 64736636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 64746636e97aSMatthew G Knepley PetscFunctionReturn(0); 64756636e97aSMatthew G Knepley } 64766636e97aSMatthew G Knepley 647781e9a530SVaclav Hapla /*@ 647881e9a530SVaclav Hapla DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called. 647981e9a530SVaclav Hapla 648081e9a530SVaclav Hapla Not collective 648181e9a530SVaclav Hapla 648281e9a530SVaclav Hapla Input Parameter: 648381e9a530SVaclav Hapla . dm - the DM 648481e9a530SVaclav Hapla 648581e9a530SVaclav Hapla Output Parameter: 648681e9a530SVaclav Hapla . c - coordinate vector 648781e9a530SVaclav Hapla 648881e9a530SVaclav Hapla Level: advanced 648981e9a530SVaclav Hapla 649081e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 649181e9a530SVaclav Hapla @*/ 649281e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c) 649381e9a530SVaclav Hapla { 649481e9a530SVaclav Hapla PetscFunctionBegin; 649581e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 649681e9a530SVaclav Hapla PetscValidPointer(c,2); 64972c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->coordinatesLocal && dm->coordinates,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called"); 64986636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 64996636e97aSMatthew G Knepley PetscFunctionReturn(0); 65006636e97aSMatthew G Knepley } 65016636e97aSMatthew G Knepley 65022db98f8dSVaclav Hapla /*@ 65032db98f8dSVaclav Hapla DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout. 65042db98f8dSVaclav Hapla 65052db98f8dSVaclav Hapla Not collective 65062db98f8dSVaclav Hapla 6507d8d19677SJose E. Roman Input Parameters: 65082db98f8dSVaclav Hapla + dm - the DM 65092db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned 65102db98f8dSVaclav Hapla 6511d8d19677SJose E. Roman Output Parameters: 65122db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates 65132db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p 65142db98f8dSVaclav Hapla 65152db98f8dSVaclav Hapla Note: 65162db98f8dSVaclav Hapla DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective. 65172db98f8dSVaclav Hapla 65182db98f8dSVaclav Hapla This creates a new vector, so the user SHOULD destroy this vector 65192db98f8dSVaclav Hapla 65202db98f8dSVaclav Hapla Each process has the local and ghost coordinates 65212db98f8dSVaclav Hapla 65222db98f8dSVaclav Hapla For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 65232db98f8dSVaclav Hapla and (x_0,y_0,z_0,x_1,y_1,z_1...) 65242db98f8dSVaclav Hapla 65252db98f8dSVaclav Hapla Level: advanced 65262db98f8dSVaclav Hapla 65272db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 65282db98f8dSVaclav Hapla @*/ 65292db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord) 65302db98f8dSVaclav Hapla { 65312db98f8dSVaclav Hapla PetscSection cs, newcs; 65322db98f8dSVaclav Hapla Vec coords; 65332db98f8dSVaclav Hapla const PetscScalar *arr; 65342db98f8dSVaclav Hapla PetscScalar *newarr=NULL; 65352db98f8dSVaclav Hapla PetscInt n; 65362db98f8dSVaclav Hapla PetscErrorCode ierr; 65372db98f8dSVaclav Hapla 65382db98f8dSVaclav Hapla PetscFunctionBegin; 65392db98f8dSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 65402db98f8dSVaclav Hapla PetscValidHeaderSpecific(p, IS_CLASSID, 2); 65412db98f8dSVaclav Hapla if (pCoordSection) PetscValidPointer(pCoordSection, 3); 65422db98f8dSVaclav Hapla if (pCoord) PetscValidPointer(pCoord, 4); 65432c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->coordinatesLocal,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set"); 65442c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->coordinateDM || !dm->coordinateDM->localSection,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported"); 65451bb6d2a8SBarry Smith cs = dm->coordinateDM->localSection; 65462db98f8dSVaclav Hapla coords = dm->coordinatesLocal; 65472db98f8dSVaclav Hapla ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr); 65482db98f8dSVaclav Hapla ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr); 65492db98f8dSVaclav Hapla ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr); 65502db98f8dSVaclav Hapla if (pCoord) { 65512db98f8dSVaclav Hapla ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr); 65522db98f8dSVaclav Hapla /* set array in two steps to mimic PETSC_OWN_POINTER */ 65532db98f8dSVaclav Hapla ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr); 65542db98f8dSVaclav Hapla ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr); 6555ad9ac99dSVaclav Hapla } else { 6556ad9ac99dSVaclav Hapla ierr = PetscFree(newarr);CHKERRQ(ierr); 65572db98f8dSVaclav Hapla } 6558ad9ac99dSVaclav Hapla if (pCoordSection) {*pCoordSection = newcs;} 6559ad9ac99dSVaclav Hapla else {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);} 65602db98f8dSVaclav Hapla PetscFunctionReturn(0); 65612db98f8dSVaclav Hapla } 65622db98f8dSVaclav Hapla 6563f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field) 6564f19dbd58SToby Isaac { 6565f19dbd58SToby Isaac PetscErrorCode ierr; 6566f19dbd58SToby Isaac 6567f19dbd58SToby Isaac PetscFunctionBegin; 6568f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6569f19dbd58SToby Isaac PetscValidPointer(field,2); 6570f19dbd58SToby Isaac if (!dm->coordinateField) { 6571f19dbd58SToby Isaac if (dm->ops->createcoordinatefield) { 6572f19dbd58SToby Isaac ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr); 6573f19dbd58SToby Isaac } 6574f19dbd58SToby Isaac } 6575f19dbd58SToby Isaac *field = dm->coordinateField; 6576f19dbd58SToby Isaac PetscFunctionReturn(0); 6577f19dbd58SToby Isaac } 6578f19dbd58SToby Isaac 6579f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field) 6580f19dbd58SToby Isaac { 6581f19dbd58SToby Isaac PetscErrorCode ierr; 6582f19dbd58SToby Isaac 6583f19dbd58SToby Isaac PetscFunctionBegin; 6584f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6585f19dbd58SToby Isaac if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2); 6586c4e6da2cSBarry Smith ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr); 6587f19dbd58SToby Isaac ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr); 6588f19dbd58SToby Isaac dm->coordinateField = field; 6589f19dbd58SToby Isaac PetscFunctionReturn(0); 6590f19dbd58SToby Isaac } 6591f19dbd58SToby Isaac 65926636e97aSMatthew G Knepley /*@ 65931cfe2091SMatthew G. Knepley DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates 65946636e97aSMatthew G Knepley 6595d083f849SBarry Smith Collective on dm 65966636e97aSMatthew G Knepley 65976636e97aSMatthew G Knepley Input Parameter: 65986636e97aSMatthew G Knepley . dm - the DM 65996636e97aSMatthew G Knepley 66006636e97aSMatthew G Knepley Output Parameter: 66016636e97aSMatthew G Knepley . cdm - coordinate DM 66026636e97aSMatthew G Knepley 66036636e97aSMatthew G Knepley Level: intermediate 66046636e97aSMatthew G Knepley 66051cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 66066636e97aSMatthew G Knepley @*/ 66076636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm) 66086636e97aSMatthew G Knepley { 66096636e97aSMatthew G Knepley PetscErrorCode ierr; 66106636e97aSMatthew G Knepley 66116636e97aSMatthew G Knepley PetscFunctionBegin; 66126636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 66136636e97aSMatthew G Knepley PetscValidPointer(cdm,2); 66146636e97aSMatthew G Knepley if (!dm->coordinateDM) { 6615308f8a94SToby Isaac DM cdm; 6616308f8a94SToby Isaac 66172c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createcoordinatedm,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM"); 6618308f8a94SToby Isaac ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr); 6619c9ad657eSksagiyam ierr = PetscObjectSetName((PetscObject)cdm, "coordinateDM");CHKERRQ(ierr); 6620308f8a94SToby Isaac /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup 6621308f8a94SToby Isaac * until the call to CreateCoordinateDM) */ 6622308f8a94SToby Isaac ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 6623308f8a94SToby Isaac dm->coordinateDM = cdm; 66246636e97aSMatthew G Knepley } 66256636e97aSMatthew G Knepley *cdm = dm->coordinateDM; 66266636e97aSMatthew G Knepley PetscFunctionReturn(0); 66276636e97aSMatthew G Knepley } 6628e87bb0d3SMatthew G Knepley 66291cfe2091SMatthew G. Knepley /*@ 66301cfe2091SMatthew G. Knepley DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates 66311cfe2091SMatthew G. Knepley 6632d083f849SBarry Smith Logically Collective on dm 66331cfe2091SMatthew G. Knepley 66341cfe2091SMatthew G. Knepley Input Parameters: 66351cfe2091SMatthew G. Knepley + dm - the DM 66361cfe2091SMatthew G. Knepley - cdm - coordinate DM 66371cfe2091SMatthew G. Knepley 66381cfe2091SMatthew G. Knepley Level: intermediate 66391cfe2091SMatthew G. Knepley 66401cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 66411cfe2091SMatthew G. Knepley @*/ 66421cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm) 66431cfe2091SMatthew G. Knepley { 66441cfe2091SMatthew G. Knepley PetscErrorCode ierr; 66451cfe2091SMatthew G. Knepley 66461cfe2091SMatthew G. Knepley PetscFunctionBegin; 66471cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 66481cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(cdm,DM_CLASSID,2); 6649f26b38b9SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 66501cfe2091SMatthew G. Knepley ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 66511cfe2091SMatthew G. Knepley dm->coordinateDM = cdm; 66521cfe2091SMatthew G. Knepley PetscFunctionReturn(0); 66531cfe2091SMatthew G. Knepley } 66541cfe2091SMatthew G. Knepley 665546e270d4SMatthew G. Knepley /*@ 665646e270d4SMatthew G. Knepley DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values. 665746e270d4SMatthew G. Knepley 665846e270d4SMatthew G. Knepley Not Collective 665946e270d4SMatthew G. Knepley 666046e270d4SMatthew G. Knepley Input Parameter: 666146e270d4SMatthew G. Knepley . dm - The DM object 666246e270d4SMatthew G. Knepley 666346e270d4SMatthew G. Knepley Output Parameter: 666446e270d4SMatthew G. Knepley . dim - The embedding dimension 666546e270d4SMatthew G. Knepley 666646e270d4SMatthew G. Knepley Level: intermediate 666746e270d4SMatthew G. Knepley 666892fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 666946e270d4SMatthew G. Knepley @*/ 667046e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim) 667146e270d4SMatthew G. Knepley { 667246e270d4SMatthew G. Knepley PetscFunctionBegin; 667346e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6674534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 66759a9a41abSToby Isaac if (dm->dimEmbed == PETSC_DEFAULT) { 66769a9a41abSToby Isaac dm->dimEmbed = dm->dim; 66779a9a41abSToby Isaac } 667846e270d4SMatthew G. Knepley *dim = dm->dimEmbed; 667946e270d4SMatthew G. Knepley PetscFunctionReturn(0); 668046e270d4SMatthew G. Knepley } 668146e270d4SMatthew G. Knepley 668246e270d4SMatthew G. Knepley /*@ 668346e270d4SMatthew G. Knepley DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values. 668446e270d4SMatthew G. Knepley 668546e270d4SMatthew G. Knepley Not Collective 668646e270d4SMatthew G. Knepley 668746e270d4SMatthew G. Knepley Input Parameters: 668846e270d4SMatthew G. Knepley + dm - The DM object 668946e270d4SMatthew G. Knepley - dim - The embedding dimension 669046e270d4SMatthew G. Knepley 669146e270d4SMatthew G. Knepley Level: intermediate 669246e270d4SMatthew G. Knepley 669392fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 669446e270d4SMatthew G. Knepley @*/ 669546e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim) 669646e270d4SMatthew G. Knepley { 6697e5e52638SMatthew G. Knepley PetscDS ds; 669845480ffeSMatthew G. Knepley PetscInt Nds, n; 6699f17e8794SMatthew G. Knepley PetscErrorCode ierr; 6700f17e8794SMatthew G. Knepley 670146e270d4SMatthew G. Knepley PetscFunctionBegin; 670246e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 670346e270d4SMatthew G. Knepley dm->dimEmbed = dim; 6704d17bd122SMatthew G. Knepley if (dm->dim >= 0) { 670545480ffeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 670645480ffeSMatthew G. Knepley for (n = 0; n < Nds; ++n) { 670745480ffeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr); 6708e5e52638SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr); 670945480ffeSMatthew G. Knepley } 6710d17bd122SMatthew G. Knepley } 671146e270d4SMatthew G. Knepley PetscFunctionReturn(0); 671246e270d4SMatthew G. Knepley } 671346e270d4SMatthew G. Knepley 6714e8abe2deSMatthew G. Knepley /*@ 6715e8abe2deSMatthew G. Knepley DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh. 6716e8abe2deSMatthew G. Knepley 6717d083f849SBarry Smith Collective on dm 6718e8abe2deSMatthew G. Knepley 6719e8abe2deSMatthew G. Knepley Input Parameter: 6720e8abe2deSMatthew G. Knepley . dm - The DM object 6721e8abe2deSMatthew G. Knepley 6722e8abe2deSMatthew G. Knepley Output Parameter: 6723e8abe2deSMatthew G. Knepley . section - The PetscSection object 6724e8abe2deSMatthew G. Knepley 6725e8abe2deSMatthew G. Knepley Level: intermediate 6726e8abe2deSMatthew G. Knepley 672792fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 6728e8abe2deSMatthew G. Knepley @*/ 6729e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section) 6730e8abe2deSMatthew G. Knepley { 6731e8abe2deSMatthew G. Knepley DM cdm; 6732e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 6733e8abe2deSMatthew G. Knepley 6734e8abe2deSMatthew G. Knepley PetscFunctionBegin; 6735e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6736e8abe2deSMatthew G. Knepley PetscValidPointer(section, 2); 6737e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 673892fd8e1eSJed Brown ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr); 6739e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 6740e8abe2deSMatthew G. Knepley } 6741e8abe2deSMatthew G. Knepley 6742e8abe2deSMatthew G. Knepley /*@ 6743e8abe2deSMatthew G. Knepley DMSetCoordinateSection - Set the layout of coordinate values over the mesh. 6744e8abe2deSMatthew G. Knepley 6745e8abe2deSMatthew G. Knepley Not Collective 6746e8abe2deSMatthew G. Knepley 6747e8abe2deSMatthew G. Knepley Input Parameters: 6748e8abe2deSMatthew G. Knepley + dm - The DM object 674946e270d4SMatthew G. Knepley . dim - The embedding dimension, or PETSC_DETERMINE 6750e8abe2deSMatthew G. Knepley - section - The PetscSection object 6751e8abe2deSMatthew G. Knepley 6752e8abe2deSMatthew G. Knepley Level: intermediate 6753e8abe2deSMatthew G. Knepley 675492fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 6755e8abe2deSMatthew G. Knepley @*/ 675646e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section) 6757e8abe2deSMatthew G. Knepley { 6758e8abe2deSMatthew G. Knepley DM cdm; 6759e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 6760e8abe2deSMatthew G. Knepley 6761e8abe2deSMatthew G. Knepley PetscFunctionBegin; 6762e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 676346e270d4SMatthew G. Knepley PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3); 6764e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 676592fd8e1eSJed Brown ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr); 676646e270d4SMatthew G. Knepley if (dim == PETSC_DETERMINE) { 67674c1069a6SMatthew G. Knepley PetscInt d = PETSC_DEFAULT; 676846e270d4SMatthew G. Knepley PetscInt pStart, pEnd, vStart, vEnd, v, dd; 676946e270d4SMatthew G. Knepley 677046e270d4SMatthew G. Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 677146e270d4SMatthew G. Knepley ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr); 677246e270d4SMatthew G. Knepley pStart = PetscMax(vStart, pStart); 677346e270d4SMatthew G. Knepley pEnd = PetscMin(vEnd, pEnd); 677446e270d4SMatthew G. Knepley for (v = pStart; v < pEnd; ++v) { 677546e270d4SMatthew G. Knepley ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr); 677646e270d4SMatthew G. Knepley if (dd) {d = dd; break;} 677746e270d4SMatthew G. Knepley } 6778ebfe4b0dSMatthew G. Knepley if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);} 677946e270d4SMatthew G. Knepley } 6780e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 6781e8abe2deSMatthew G. Knepley } 6782e8abe2deSMatthew G. Knepley 6783d864a3eaSLisandro Dalcin /*@ 6784d864a3eaSLisandro Dalcin DMProjectCoordinates - Project coordinates to a different space 6785d864a3eaSLisandro Dalcin 6786d864a3eaSLisandro Dalcin Input Parameters: 6787d864a3eaSLisandro Dalcin + dm - The DM object 6788d864a3eaSLisandro Dalcin - disc - The new coordinate discretization 6789d864a3eaSLisandro Dalcin 6790d864a3eaSLisandro Dalcin Level: intermediate 6791d864a3eaSLisandro Dalcin 6792d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField() 6793d864a3eaSLisandro Dalcin @*/ 6794d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc) 6795d864a3eaSLisandro Dalcin { 6796d864a3eaSLisandro Dalcin PetscObject discOld; 6797d864a3eaSLisandro Dalcin PetscClassId classid; 6798d864a3eaSLisandro Dalcin DM cdmOld,cdmNew; 6799d864a3eaSLisandro Dalcin Vec coordsOld,coordsNew; 6800d864a3eaSLisandro Dalcin Mat matInterp; 6801d864a3eaSLisandro Dalcin PetscErrorCode ierr; 6802d864a3eaSLisandro Dalcin 6803d864a3eaSLisandro Dalcin PetscFunctionBegin; 6804d864a3eaSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6805d864a3eaSLisandro Dalcin PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2); 6806d864a3eaSLisandro Dalcin 6807d864a3eaSLisandro Dalcin ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr); 6808d864a3eaSLisandro Dalcin /* Check current discretization is compatible */ 6809d864a3eaSLisandro Dalcin ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr); 6810d864a3eaSLisandro Dalcin ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr); 681129ad44c5SMatthew G. Knepley if (classid != PETSCFE_CLASSID) { 681229ad44c5SMatthew G. Knepley if (classid == PETSC_CONTAINER_CLASSID) { 681329ad44c5SMatthew G. Knepley PetscFE feLinear; 681429ad44c5SMatthew G. Knepley DMPolytopeType ct; 681529ad44c5SMatthew G. Knepley PetscInt dim, dE, cStart; 681629ad44c5SMatthew G. Knepley PetscBool simplex; 681729ad44c5SMatthew G. Knepley 681829ad44c5SMatthew G. Knepley /* Assume linear vertex coordinates */ 681929ad44c5SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 682029ad44c5SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr); 682129ad44c5SMatthew G. Knepley ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr); 682229ad44c5SMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 682329ad44c5SMatthew G. Knepley switch (ct) { 682429ad44c5SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM: 682529ad44c5SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM_TENSOR: 682629ad44c5SMatthew G. Knepley SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms"); 682729ad44c5SMatthew G. Knepley default: break; 682829ad44c5SMatthew G. Knepley } 682929ad44c5SMatthew G. Knepley simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE; 683029ad44c5SMatthew G. Knepley ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr); 683129ad44c5SMatthew G. Knepley ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr); 683229ad44c5SMatthew G. Knepley ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr); 683329ad44c5SMatthew G. Knepley ierr = DMCreateDS(cdmOld);CHKERRQ(ierr); 683429ad44c5SMatthew G. Knepley } else { 683529ad44c5SMatthew G. Knepley const char *discname; 683629ad44c5SMatthew G. Knepley 683729ad44c5SMatthew G. Knepley ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr); 683898921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname); 683929ad44c5SMatthew G. Knepley } 684029ad44c5SMatthew G. Knepley } 6841d864a3eaSLisandro Dalcin /* Make a fresh clone of the coordinate DM */ 6842d864a3eaSLisandro Dalcin ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr); 6843d864a3eaSLisandro Dalcin ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr); 6844d864a3eaSLisandro Dalcin ierr = DMCreateDS(cdmNew);CHKERRQ(ierr); 6845d864a3eaSLisandro Dalcin /* Project the coordinate vector from old to new space */ 6846d864a3eaSLisandro Dalcin ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr); 6847d864a3eaSLisandro Dalcin ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr); 6848d864a3eaSLisandro Dalcin ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr); 6849d864a3eaSLisandro Dalcin ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr); 6850d864a3eaSLisandro Dalcin ierr = MatDestroy(&matInterp);CHKERRQ(ierr); 6851d864a3eaSLisandro Dalcin /* Set new coordinate structures */ 6852d864a3eaSLisandro Dalcin ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr); 6853d864a3eaSLisandro Dalcin ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr); 6854d864a3eaSLisandro Dalcin ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr); 6855d864a3eaSLisandro Dalcin ierr = VecDestroy(&coordsNew);CHKERRQ(ierr); 6856d864a3eaSLisandro Dalcin ierr = DMDestroy(&cdmNew);CHKERRQ(ierr); 6857d864a3eaSLisandro Dalcin PetscFunctionReturn(0); 6858d864a3eaSLisandro Dalcin } 6859d864a3eaSLisandro Dalcin 68605dc8c3f7SMatthew G. Knepley /*@C 686190b157c4SStefano Zampini DMGetPeriodicity - Get the description of mesh periodicity 68625dc8c3f7SMatthew G. Knepley 6863f899ff85SJose E. Roman Input Parameter: 686490b157c4SStefano Zampini . dm - The DM object 686590b157c4SStefano Zampini 686690b157c4SStefano Zampini Output Parameters: 686790b157c4SStefano Zampini + per - Whether the DM is periodic or not 68685dc8c3f7SMatthew 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 68695dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 68705dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 68715dc8c3f7SMatthew G. Knepley 68725dc8c3f7SMatthew G. Knepley Level: developer 68735dc8c3f7SMatthew G. Knepley 68745dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 68755dc8c3f7SMatthew G. Knepley @*/ 687690b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd) 6877c6b900c6SMatthew G. Knepley { 6878c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6879c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 688090b157c4SStefano Zampini if (per) *per = dm->periodic; 6881c6b900c6SMatthew G. Knepley if (L) *L = dm->L; 6882c6b900c6SMatthew G. Knepley if (maxCell) *maxCell = dm->maxCell; 68835dc8c3f7SMatthew G. Knepley if (bd) *bd = dm->bdtype; 6884c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6885c6b900c6SMatthew G. Knepley } 6886c6b900c6SMatthew G. Knepley 68875dc8c3f7SMatthew G. Knepley /*@C 68885dc8c3f7SMatthew G. Knepley DMSetPeriodicity - Set the description of mesh periodicity 68895dc8c3f7SMatthew G. Knepley 68905dc8c3f7SMatthew G. Knepley Input Parameters: 68915dc8c3f7SMatthew G. Knepley + dm - The DM object 6892db2bf62eSStefano Zampini . per - Whether the DM is periodic or not. 6893db2bf62eSStefano 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. 68945dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 68955dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 68965dc8c3f7SMatthew G. Knepley 6897db2bf62eSStefano 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. 6898db2bf62eSStefano Zampini 68995dc8c3f7SMatthew G. Knepley Level: developer 69005dc8c3f7SMatthew G. Knepley 69015dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 69025dc8c3f7SMatthew G. Knepley @*/ 690390b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[]) 6904c6b900c6SMatthew G. Knepley { 6905c6b900c6SMatthew G. Knepley PetscInt dim, d; 6906c6b900c6SMatthew G. Knepley PetscErrorCode ierr; 6907c6b900c6SMatthew G. Knepley 6908c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6909c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 691090b157c4SStefano Zampini PetscValidLogicalCollectiveBool(dm,per,2); 6911412e9a14SMatthew G. Knepley if (maxCell) {PetscValidRealPointer(maxCell,3);} 6912412e9a14SMatthew G. Knepley if (L) {PetscValidRealPointer(L,4);} 6913412e9a14SMatthew G. Knepley if (bd) {PetscValidPointer(bd,5);} 69145dc8c3f7SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 691590b157c4SStefano Zampini if (maxCell) { 6916412e9a14SMatthew G. Knepley if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);} 6917412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d]; 6918db2bf62eSStefano Zampini } else { /* remove maxCell information to disable automatic computation of localized vertices */ 6919db2bf62eSStefano Zampini ierr = PetscFree(dm->maxCell);CHKERRQ(ierr); 6920412e9a14SMatthew G. Knepley } 6921db2bf62eSStefano Zampini 6922412e9a14SMatthew G. Knepley if (L) { 6923412e9a14SMatthew G. Knepley if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);} 6924412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->L[d] = L[d]; 6925412e9a14SMatthew G. Knepley } 6926412e9a14SMatthew G. Knepley if (bd) { 6927412e9a14SMatthew G. Knepley if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);} 6928412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d]; 692990b157c4SStefano Zampini } 6930072d7d67SStefano Zampini dm->periodic = per; 6931c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6932c6b900c6SMatthew G. Knepley } 6933c6b900c6SMatthew G. Knepley 69342e17dfb7SMatthew G. Knepley /*@ 69352e17dfb7SMatthew 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. 69362e17dfb7SMatthew G. Knepley 69372e17dfb7SMatthew G. Knepley Input Parameters: 69382e17dfb7SMatthew G. Knepley + dm - The DM 693965da65dcSMatthew G. Knepley . in - The input coordinate point (dim numbers) 694065da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i 69412e17dfb7SMatthew G. Knepley 69422e17dfb7SMatthew G. Knepley Output Parameter: 69432e17dfb7SMatthew G. Knepley . out - The localized coordinate point 69442e17dfb7SMatthew G. Knepley 69452e17dfb7SMatthew G. Knepley Level: developer 69462e17dfb7SMatthew G. Knepley 69472e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 69482e17dfb7SMatthew G. Knepley @*/ 694965da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[]) 69502e17dfb7SMatthew G. Knepley { 69512e17dfb7SMatthew G. Knepley PetscInt dim, d; 69522e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 69532e17dfb7SMatthew G. Knepley 69542e17dfb7SMatthew G. Knepley PetscFunctionBegin; 69552e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr); 69562e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 69572e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 69582e17dfb7SMatthew G. Knepley } else { 695965da65dcSMatthew G. Knepley if (endpoint) { 696065da65dcSMatthew G. Knepley for (d = 0; d < dim; ++d) { 6961da3333bfSMatthew 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)) { 6962da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1); 696365da65dcSMatthew G. Knepley } else { 6964da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 696565da65dcSMatthew G. Knepley } 696665da65dcSMatthew G. Knepley } 696765da65dcSMatthew G. Knepley } else { 69682e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 69691118d4bcSLisandro Dalcin out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 69702e17dfb7SMatthew G. Knepley } 69712e17dfb7SMatthew G. Knepley } 697265da65dcSMatthew G. Knepley } 69732e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 69742e17dfb7SMatthew G. Knepley } 69752e17dfb7SMatthew G. Knepley 69762e17dfb7SMatthew G. Knepley /* 69772e17dfb7SMatthew 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. 69782e17dfb7SMatthew G. Knepley 69792e17dfb7SMatthew G. Knepley Input Parameters: 69802e17dfb7SMatthew G. Knepley + dm - The DM 69812e17dfb7SMatthew G. Knepley . dim - The spatial dimension 69822e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 69832e17dfb7SMatthew G. Knepley - in - The input coordinate point (dim numbers) 69842e17dfb7SMatthew G. Knepley 69852e17dfb7SMatthew G. Knepley Output Parameter: 69862e17dfb7SMatthew G. Knepley . out - The localized coordinate point 69872e17dfb7SMatthew G. Knepley 69882e17dfb7SMatthew G. Knepley Level: developer 69892e17dfb7SMatthew G. Knepley 69902e17dfb7SMatthew 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 69912e17dfb7SMatthew G. Knepley 69922e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 69932e17dfb7SMatthew G. Knepley */ 69942e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 69952e17dfb7SMatthew G. Knepley { 69962e17dfb7SMatthew G. Knepley PetscInt d; 69972e17dfb7SMatthew G. Knepley 69982e17dfb7SMatthew G. Knepley PetscFunctionBegin; 69992e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 70002e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 70012e17dfb7SMatthew G. Knepley } else { 70022e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 7003908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) { 70042e17dfb7SMatthew G. Knepley out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 70052e17dfb7SMatthew G. Knepley } else { 70062e17dfb7SMatthew G. Knepley out[d] = in[d]; 70072e17dfb7SMatthew G. Knepley } 70082e17dfb7SMatthew G. Knepley } 70092e17dfb7SMatthew G. Knepley } 70102e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 70112e17dfb7SMatthew G. Knepley } 7012a5801f52SStefano Zampini 70132e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[]) 70142e17dfb7SMatthew G. Knepley { 70152e17dfb7SMatthew G. Knepley PetscInt d; 70162e17dfb7SMatthew G. Knepley 70172e17dfb7SMatthew G. Knepley PetscFunctionBegin; 70182e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 70192e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 70202e17dfb7SMatthew G. Knepley } else { 70212e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 7022908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) { 70232e17dfb7SMatthew G. Knepley out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d]; 70242e17dfb7SMatthew G. Knepley } else { 70252e17dfb7SMatthew G. Knepley out[d] = in[d]; 70262e17dfb7SMatthew G. Knepley } 70272e17dfb7SMatthew G. Knepley } 70282e17dfb7SMatthew G. Knepley } 70292e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 70302e17dfb7SMatthew G. Knepley } 70312e17dfb7SMatthew G. Knepley 70322e17dfb7SMatthew G. Knepley /* 70332e17dfb7SMatthew 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. 70342e17dfb7SMatthew G. Knepley 70352e17dfb7SMatthew G. Knepley Input Parameters: 70362e17dfb7SMatthew G. Knepley + dm - The DM 70372e17dfb7SMatthew G. Knepley . dim - The spatial dimension 70382e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 70392e17dfb7SMatthew G. Knepley . in - The input coordinate delta (dim numbers) 70402e17dfb7SMatthew G. Knepley - out - The input coordinate point (dim numbers) 70412e17dfb7SMatthew G. Knepley 70422e17dfb7SMatthew G. Knepley Output Parameter: 70432e17dfb7SMatthew G. Knepley . out - The localized coordinate in + out 70442e17dfb7SMatthew G. Knepley 70452e17dfb7SMatthew G. Knepley Level: developer 70462e17dfb7SMatthew G. Knepley 70472e17dfb7SMatthew 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 70482e17dfb7SMatthew G. Knepley 70492e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate() 70502e17dfb7SMatthew G. Knepley */ 70512e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 70522e17dfb7SMatthew G. Knepley { 70532e17dfb7SMatthew G. Knepley PetscInt d; 70542e17dfb7SMatthew G. Knepley 70552e17dfb7SMatthew G. Knepley PetscFunctionBegin; 70562e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 70572e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] += in[d]; 70582e17dfb7SMatthew G. Knepley } else { 70592e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 7060412e9a14SMatthew G. Knepley const PetscReal maxC = dm->maxCell[d]; 7061412e9a14SMatthew G. Knepley 7062412e9a14SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) { 7063412e9a14SMatthew G. Knepley const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 7064412e9a14SMatthew G. Knepley 7065412e9a14SMatthew G. Knepley if (PetscAbsScalar(newCoord - anchor[d]) > maxC) 706698921bdaSJacob Faibussowitsch SETERRQ(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])); 7067412e9a14SMatthew G. Knepley out[d] += newCoord; 70682e17dfb7SMatthew G. Knepley } else { 70692e17dfb7SMatthew G. Knepley out[d] += in[d]; 70702e17dfb7SMatthew G. Knepley } 70712e17dfb7SMatthew G. Knepley } 70722e17dfb7SMatthew G. Knepley } 70732e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 70742e17dfb7SMatthew G. Knepley } 70752e17dfb7SMatthew G. Knepley 707636447a5eSToby Isaac /*@ 70778f700142SStefano Zampini DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process 70788f700142SStefano Zampini 70798f700142SStefano Zampini Not collective 708036447a5eSToby Isaac 708136447a5eSToby Isaac Input Parameter: 708236447a5eSToby Isaac . dm - The DM 708336447a5eSToby Isaac 708436447a5eSToby Isaac Output Parameter: 708536447a5eSToby Isaac areLocalized - True if localized 708636447a5eSToby Isaac 708736447a5eSToby Isaac Level: developer 708836447a5eSToby Isaac 70898f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity() 709036447a5eSToby Isaac @*/ 70918f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized) 709236447a5eSToby Isaac { 709336447a5eSToby Isaac DM cdm; 709436447a5eSToby Isaac PetscSection coordSection; 70952ccac677SMatthew G. Knepley PetscInt depth, cStart, cEnd, sStart, sEnd, c, dof; 709646a3a80fSLisandro Dalcin PetscBool isPlex, alreadyLocalized; 709736447a5eSToby Isaac PetscErrorCode ierr; 709836447a5eSToby Isaac 709936447a5eSToby Isaac PetscFunctionBegin; 710036447a5eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7101534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 71028b09590cSToby Isaac *areLocalized = PETSC_FALSE; 710346a3a80fSLisandro Dalcin 710436447a5eSToby Isaac /* We need some generic way of refering to cells/vertices */ 710536447a5eSToby Isaac ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 710646a3a80fSLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr); 71079f7230bfSMatthew G. Knepley if (!isPlex) PetscFunctionReturn(0); 71082ccac677SMatthew G. Knepley ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr); 71092ccac677SMatthew G. Knepley if (!depth) PetscFunctionReturn(0); 711046a3a80fSLisandro Dalcin 71119f7230bfSMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 711246a3a80fSLisandro Dalcin ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr); 711336447a5eSToby Isaac ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr); 711436447a5eSToby Isaac alreadyLocalized = PETSC_FALSE; 711546a3a80fSLisandro Dalcin for (c = cStart; c < cEnd; ++c) { 711646a3a80fSLisandro Dalcin if (c < sStart || c >= sEnd) continue; 711736447a5eSToby Isaac ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr); 711846a3a80fSLisandro Dalcin if (dof) { alreadyLocalized = PETSC_TRUE; break; } 711936447a5eSToby Isaac } 71208f700142SStefano Zampini *areLocalized = alreadyLocalized; 712136447a5eSToby Isaac PetscFunctionReturn(0); 712236447a5eSToby Isaac } 712336447a5eSToby Isaac 71248f700142SStefano Zampini /*@ 71258f700142SStefano Zampini DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells 71268f700142SStefano Zampini 71278f700142SStefano Zampini Collective on dm 71288f700142SStefano Zampini 71298f700142SStefano Zampini Input Parameter: 71308f700142SStefano Zampini . dm - The DM 71318f700142SStefano Zampini 71328f700142SStefano Zampini Output Parameter: 71338f700142SStefano Zampini areLocalized - True if localized 71348f700142SStefano Zampini 71358f700142SStefano Zampini Level: developer 71368f700142SStefano Zampini 71378f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal() 71388f700142SStefano Zampini @*/ 71398f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized) 71408f700142SStefano Zampini { 71418f700142SStefano Zampini PetscBool localized; 71428f700142SStefano Zampini PetscErrorCode ierr; 71438f700142SStefano Zampini 71448f700142SStefano Zampini PetscFunctionBegin; 71458f700142SStefano Zampini PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7146534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 71478f700142SStefano Zampini ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr); 7148820f2d46SBarry Smith ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 71498f700142SStefano Zampini PetscFunctionReturn(0); 71508f700142SStefano Zampini } 715136447a5eSToby Isaac 71522e17dfb7SMatthew G. Knepley /*@ 7153492b8470SStefano Zampini DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces 71542e17dfb7SMatthew G. Knepley 71558f700142SStefano Zampini Collective on dm 71568f700142SStefano Zampini 71572e17dfb7SMatthew G. Knepley Input Parameter: 71582e17dfb7SMatthew G. Knepley . dm - The DM 71592e17dfb7SMatthew G. Knepley 71602e17dfb7SMatthew G. Knepley Level: developer 71612e17dfb7SMatthew G. Knepley 71628f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate() 71632e17dfb7SMatthew G. Knepley @*/ 71642e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm) 71652e17dfb7SMatthew G. Knepley { 71662e17dfb7SMatthew G. Knepley DM cdm; 71672e17dfb7SMatthew G. Knepley PetscSection coordSection, cSection; 71682e17dfb7SMatthew G. Knepley Vec coordinates, cVec; 71693e922f36SToby Isaac PetscScalar *coords, *coords2, *anchor, *localized; 71703e922f36SToby Isaac PetscInt Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize; 7171e0ae35bbSToby Isaac PetscBool alreadyLocalized, alreadyLocalizedGlobal; 71723e922f36SToby Isaac PetscInt maxHeight = 0, h; 71733e922f36SToby Isaac PetscInt *pStart = NULL, *pEnd = NULL; 71742e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 71752e17dfb7SMatthew G. Knepley 71762e17dfb7SMatthew G. Knepley PetscFunctionBegin; 71772e17dfb7SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 717892c9c85fSStefano Zampini if (!dm->periodic) PetscFunctionReturn(0); 7179f7cbd40bSStefano Zampini ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr); 7180f7cbd40bSStefano Zampini if (alreadyLocalized) PetscFunctionReturn(0); 7181f7cbd40bSStefano Zampini 71822e17dfb7SMatthew G. Knepley /* We need some generic way of refering to cells/vertices */ 71832e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 71842e17dfb7SMatthew G. Knepley { 71852e17dfb7SMatthew G. Knepley PetscBool isplex; 71862e17dfb7SMatthew G. Knepley 71872e17dfb7SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr); 71882e17dfb7SMatthew G. Knepley if (isplex) { 71892e17dfb7SMatthew G. Knepley ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr); 71903e922f36SToby Isaac ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr); 719169291d52SBarry Smith ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 71923e922f36SToby Isaac pEnd = &pStart[maxHeight + 1]; 71933e922f36SToby Isaac newStart = vStart; 71943e922f36SToby Isaac newEnd = vEnd; 71953e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 71963e922f36SToby Isaac ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr); 71973e922f36SToby Isaac newStart = PetscMin(newStart,pStart[h]); 71983e922f36SToby Isaac newEnd = PetscMax(newEnd,pEnd[h]); 71993e922f36SToby Isaac } 72002e17dfb7SMatthew G. Knepley } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM"); 72012e17dfb7SMatthew G. Knepley } 72022e17dfb7SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr); 72032c71b3e2SJacob Faibussowitsch PetscCheckFalse(!coordinates,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector"); 72042e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 72053e922f36SToby Isaac ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr); 7206e0ae35bbSToby Isaac ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr); 72073e922f36SToby Isaac 72082e17dfb7SMatthew G. Knepley ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr); 72092e17dfb7SMatthew G. Knepley ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr); 72102e17dfb7SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr); 72112e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr); 72123e922f36SToby Isaac ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr); 72133e922f36SToby Isaac 721469291d52SBarry Smith ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 72153e922f36SToby Isaac localized = &anchor[bs]; 72163e922f36SToby Isaac alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE; 72173e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 72183e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 72193e922f36SToby Isaac 72203e922f36SToby Isaac for (c = cStart; c < cEnd; ++c) { 72213e922f36SToby Isaac PetscScalar *cellCoords = NULL; 72223e922f36SToby Isaac PetscInt b; 72233e922f36SToby Isaac 72243e922f36SToby Isaac if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE; 72253e922f36SToby Isaac ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 72263e922f36SToby Isaac for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 72273e922f36SToby Isaac for (d = 0; d < dof/bs; ++d) { 72283e922f36SToby Isaac ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr); 72293e922f36SToby Isaac for (b = 0; b < bs; b++) { 72303e922f36SToby Isaac if (cellCoords[d*bs + b] != localized[b]) break; 72313e922f36SToby Isaac } 72323e922f36SToby Isaac if (b < bs) break; 72333e922f36SToby Isaac } 72343e922f36SToby Isaac if (d < dof/bs) { 72353e922f36SToby Isaac if (c >= sStart && c < sEnd) { 72363e922f36SToby Isaac PetscInt cdof; 72373e922f36SToby Isaac 72383e922f36SToby Isaac ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr); 72393e922f36SToby Isaac if (cdof != dof) alreadyLocalized = PETSC_FALSE; 72403e922f36SToby Isaac } 72413e922f36SToby Isaac ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr); 72423e922f36SToby Isaac ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr); 72433e922f36SToby Isaac } 72443e922f36SToby Isaac ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 72453e922f36SToby Isaac } 72463e922f36SToby Isaac } 7247ffc4695bSBarry Smith ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 72483e922f36SToby Isaac if (alreadyLocalizedGlobal) { 724969291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 72503e922f36SToby Isaac ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 725169291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 72523e922f36SToby Isaac PetscFunctionReturn(0); 72533e922f36SToby Isaac } 72542e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 72552e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 72562e17dfb7SMatthew G. Knepley ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr); 72572e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr); 72582e17dfb7SMatthew G. Knepley } 72592e17dfb7SMatthew G. Knepley ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr); 72602e17dfb7SMatthew G. Knepley ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr); 7261c2be7e5eSLisandro Dalcin ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr); 72622e17dfb7SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr); 72632e17dfb7SMatthew G. Knepley ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr); 72642e17dfb7SMatthew G. Knepley ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr); 72652e17dfb7SMatthew G. Knepley ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr); 7266c2be7e5eSLisandro Dalcin ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 72672e17dfb7SMatthew G. Knepley ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr); 72682e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 72692e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 72702e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr); 72712e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, v, &off2);CHKERRQ(ierr); 72722e17dfb7SMatthew G. Knepley for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d]; 72732e17dfb7SMatthew G. Knepley } 72743e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 72753e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 72763e922f36SToby Isaac 72772e17dfb7SMatthew G. Knepley for (c = cStart; c < cEnd; ++c) { 72782e17dfb7SMatthew G. Knepley PetscScalar *cellCoords = NULL; 72793e922f36SToby Isaac PetscInt b, cdof; 72802e17dfb7SMatthew G. Knepley 72813e922f36SToby Isaac ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr); 72823e922f36SToby Isaac if (!cdof) continue; 72832e17dfb7SMatthew G. Knepley ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 72842e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr); 72852e17dfb7SMatthew G. Knepley for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 72862e17dfb7SMatthew G. Knepley for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);} 72872e17dfb7SMatthew G. Knepley ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 72882e17dfb7SMatthew G. Knepley } 72893e922f36SToby Isaac } 729069291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 729169291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 7292c2be7e5eSLisandro Dalcin ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 72932e17dfb7SMatthew G. Knepley ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr); 72942e17dfb7SMatthew G. Knepley ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr); 72952e17dfb7SMatthew G. Knepley ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr); 72962e17dfb7SMatthew G. Knepley ierr = VecDestroy(&cVec);CHKERRQ(ierr); 72972e17dfb7SMatthew G. Knepley ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 72982e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 72992e17dfb7SMatthew G. Knepley } 73002e17dfb7SMatthew G. Knepley 7301e87bb0d3SMatthew G Knepley /*@ 73023a93e3b7SToby Isaac DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells 7303e87bb0d3SMatthew G Knepley 7304d083f849SBarry Smith Collective on v (see explanation below) 7305e87bb0d3SMatthew G Knepley 7306e87bb0d3SMatthew G Knepley Input Parameters: 7307e87bb0d3SMatthew G Knepley + dm - The DM 73086b867d5aSJose E. Roman - ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST 7309e87bb0d3SMatthew G Knepley 73106b867d5aSJose E. Roman Input/Output Parameters: 73116b867d5aSJose E. Roman + v - The Vec of points, on output contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used 73126b867d5aSJose E. Roman - cellSF - Points to either NULL, or a PetscSF with guesses for which cells contain each point; 73136b867d5aSJose E. Roman on output, the PetscSF containing the ranks and local indices of the containing points 73143a93e3b7SToby Isaac 7315e87bb0d3SMatthew G Knepley Level: developer 731661e3bb9bSMatthew G Knepley 731762a38674SMatthew G. Knepley Notes: 73183a93e3b7SToby Isaac To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator. 731962a38674SMatthew G. Knepley To do a search of all the cells in the distributed mesh, v should have the same communicator as dm. 73203a93e3b7SToby Isaac 73213a93e3b7SToby Isaac If *cellSF is NULL on input, a PetscSF will be created. 732262a38674SMatthew G. Knepley If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses. 73233a93e3b7SToby Isaac 73243a93e3b7SToby Isaac An array that maps each point to its containing cell can be obtained with 73253a93e3b7SToby Isaac 732662a38674SMatthew G. Knepley $ const PetscSFNode *cells; 732762a38674SMatthew G. Knepley $ PetscInt nFound; 7328a6216909SToby Isaac $ const PetscInt *found; 732962a38674SMatthew G. Knepley $ 7330a6216909SToby Isaac $ PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells); 73313a93e3b7SToby Isaac 73323a93e3b7SToby 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 73333a93e3b7SToby Isaac the index of the cell in its rank's local numbering. 73343a93e3b7SToby Isaac 733562a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType 733661e3bb9bSMatthew G Knepley @*/ 733762a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF) 7338e87bb0d3SMatthew G Knepley { 7339735aa83eSMatthew G Knepley PetscErrorCode ierr; 7340735aa83eSMatthew G Knepley 7341e87bb0d3SMatthew G Knepley PetscFunctionBegin; 7342e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7343e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,2); 7344e0fc9d1bSMatthew G. Knepley PetscValidPointer(cellSF,4); 73453a93e3b7SToby Isaac if (*cellSF) { 73463a93e3b7SToby Isaac PetscMPIInt result; 73473a93e3b7SToby Isaac 7348e0fc9d1bSMatthew G. Knepley PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4); 7349ffc4695bSBarry Smith ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr); 73502c71b3e2SJacob Faibussowitsch PetscCheckFalse(result != MPI_IDENT && result != MPI_CONGRUENT,PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's"); 7351e0fc9d1bSMatthew G. Knepley } else { 73523a93e3b7SToby Isaac ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr); 73533a93e3b7SToby Isaac } 73542c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->locatepoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM"); 735547a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 735662a38674SMatthew G. Knepley ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr); 735747a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 7358e87bb0d3SMatthew G Knepley PetscFunctionReturn(0); 7359e87bb0d3SMatthew G Knepley } 736014f150ffSMatthew G. Knepley 7361f4d763aaSMatthew G. Knepley /*@ 7362f4d763aaSMatthew G. Knepley DMGetOutputDM - Retrieve the DM associated with the layout for output 7363f4d763aaSMatthew G. Knepley 73648f700142SStefano Zampini Collective on dm 73658f700142SStefano Zampini 7366f4d763aaSMatthew G. Knepley Input Parameter: 7367f4d763aaSMatthew G. Knepley . dm - The original DM 7368f4d763aaSMatthew G. Knepley 7369f4d763aaSMatthew G. Knepley Output Parameter: 7370f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output 7371f4d763aaSMatthew G. Knepley 7372f4d763aaSMatthew G. Knepley Level: intermediate 7373f4d763aaSMatthew G. Knepley 7374e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection() 7375f4d763aaSMatthew G. Knepley @*/ 737614f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm) 737714f150ffSMatthew G. Knepley { 7378c26acbdeSMatthew G. Knepley PetscSection section; 73792d4e4a49SMatthew G. Knepley PetscBool hasConstraints, ghasConstraints; 738014f150ffSMatthew G. Knepley PetscErrorCode ierr; 738114f150ffSMatthew G. Knepley 738214f150ffSMatthew G. Knepley PetscFunctionBegin; 738314f150ffSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 738414f150ffSMatthew G. Knepley PetscValidPointer(odm,2); 738592fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 7386c26acbdeSMatthew G. Knepley ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr); 7387ffc4695bSBarry Smith ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr); 73882d4e4a49SMatthew G. Knepley if (!ghasConstraints) { 7389c26acbdeSMatthew G. Knepley *odm = dm; 7390c26acbdeSMatthew G. Knepley PetscFunctionReturn(0); 7391c26acbdeSMatthew G. Knepley } 739214f150ffSMatthew G. Knepley if (!dm->dmBC) { 7393c26acbdeSMatthew G. Knepley PetscSection newSection, gsection; 739414f150ffSMatthew G. Knepley PetscSF sf; 739514f150ffSMatthew G. Knepley 739614f150ffSMatthew G. Knepley ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr); 7397e5e52638SMatthew G. Knepley ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr); 739814f150ffSMatthew G. Knepley ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr); 739992fd8e1eSJed Brown ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr); 740014f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr); 740114f150ffSMatthew G. Knepley ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr); 740215b58121SMatthew G. Knepley ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr); 7403e87a4003SBarry Smith ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr); 740414f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr); 740514f150ffSMatthew G. Knepley } 740614f150ffSMatthew G. Knepley *odm = dm->dmBC; 740714f150ffSMatthew G. Knepley PetscFunctionReturn(0); 740814f150ffSMatthew G. Knepley } 7409f4d763aaSMatthew G. Knepley 7410f4d763aaSMatthew G. Knepley /*@ 7411cdb7a50dSMatthew G. Knepley DMGetOutputSequenceNumber - Retrieve the sequence number/value for output 7412f4d763aaSMatthew G. Knepley 7413f4d763aaSMatthew G. Knepley Input Parameter: 7414f4d763aaSMatthew G. Knepley . dm - The original DM 7415f4d763aaSMatthew G. Knepley 7416cdb7a50dSMatthew G. Knepley Output Parameters: 7417cdb7a50dSMatthew G. Knepley + num - The output sequence number 7418cdb7a50dSMatthew G. Knepley - val - The output sequence value 7419f4d763aaSMatthew G. Knepley 7420f4d763aaSMatthew G. Knepley Level: intermediate 7421f4d763aaSMatthew G. Knepley 7422f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7423f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7424f4d763aaSMatthew G. Knepley 7425f4d763aaSMatthew G. Knepley .seealso: VecView() 7426f4d763aaSMatthew G. Knepley @*/ 7427cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val) 7428f4d763aaSMatthew G. Knepley { 7429f4d763aaSMatthew G. Knepley PetscFunctionBegin; 7430f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7431534a8f05SLisandro Dalcin if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;} 7432534a8f05SLisandro Dalcin if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;} 7433f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 7434f4d763aaSMatthew G. Knepley } 7435f4d763aaSMatthew G. Knepley 7436f4d763aaSMatthew G. Knepley /*@ 7437cdb7a50dSMatthew G. Knepley DMSetOutputSequenceNumber - Set the sequence number/value for output 7438f4d763aaSMatthew G. Knepley 7439f4d763aaSMatthew G. Knepley Input Parameters: 7440f4d763aaSMatthew G. Knepley + dm - The original DM 7441cdb7a50dSMatthew G. Knepley . num - The output sequence number 7442cdb7a50dSMatthew G. Knepley - val - The output sequence value 7443f4d763aaSMatthew G. Knepley 7444f4d763aaSMatthew G. Knepley Level: intermediate 7445f4d763aaSMatthew G. Knepley 7446f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7447f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7448f4d763aaSMatthew G. Knepley 7449f4d763aaSMatthew G. Knepley .seealso: VecView() 7450f4d763aaSMatthew G. Knepley @*/ 7451cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val) 7452f4d763aaSMatthew G. Knepley { 7453f4d763aaSMatthew G. Knepley PetscFunctionBegin; 7454f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7455f4d763aaSMatthew G. Knepley dm->outputSequenceNum = num; 7456cdb7a50dSMatthew G. Knepley dm->outputSequenceVal = val; 7457cdb7a50dSMatthew G. Knepley PetscFunctionReturn(0); 7458cdb7a50dSMatthew G. Knepley } 7459cdb7a50dSMatthew G. Knepley 7460cdb7a50dSMatthew G. Knepley /*@C 7461cdb7a50dSMatthew G. Knepley DMOutputSequenceLoad - Retrieve the sequence value from a Viewer 7462cdb7a50dSMatthew G. Knepley 7463cdb7a50dSMatthew G. Knepley Input Parameters: 7464cdb7a50dSMatthew G. Knepley + dm - The original DM 7465cdb7a50dSMatthew G. Knepley . name - The sequence name 7466cdb7a50dSMatthew G. Knepley - num - The output sequence number 7467cdb7a50dSMatthew G. Knepley 7468cdb7a50dSMatthew G. Knepley Output Parameter: 7469cdb7a50dSMatthew G. Knepley . val - The output sequence value 7470cdb7a50dSMatthew G. Knepley 7471cdb7a50dSMatthew G. Knepley Level: intermediate 7472cdb7a50dSMatthew G. Knepley 7473cdb7a50dSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7474cdb7a50dSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7475cdb7a50dSMatthew G. Knepley 7476cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView() 7477cdb7a50dSMatthew G. Knepley @*/ 7478cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val) 7479cdb7a50dSMatthew G. Knepley { 7480cdb7a50dSMatthew G. Knepley PetscBool ishdf5; 7481cdb7a50dSMatthew G. Knepley PetscErrorCode ierr; 7482cdb7a50dSMatthew G. Knepley 7483cdb7a50dSMatthew G. Knepley PetscFunctionBegin; 7484cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7485cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 7486064a246eSJacob Faibussowitsch PetscValidRealPointer(val,5); 7487cdb7a50dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr); 7488cdb7a50dSMatthew G. Knepley if (ishdf5) { 7489cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5) 7490cdb7a50dSMatthew G. Knepley PetscScalar value; 7491cdb7a50dSMatthew G. Knepley 749239d25373SMatthew G. Knepley ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr); 74934aeb217fSMatthew G. Knepley *val = PetscRealPart(value); 7494cdb7a50dSMatthew G. Knepley #endif 7495cdb7a50dSMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()"); 7496f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 7497f4d763aaSMatthew G. Knepley } 74988e4ac7eaSMatthew G. Knepley 74998e4ac7eaSMatthew G. Knepley /*@ 75008e4ac7eaSMatthew G. Knepley DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution 75018e4ac7eaSMatthew G. Knepley 75028e4ac7eaSMatthew G. Knepley Not collective 75038e4ac7eaSMatthew G. Knepley 75048e4ac7eaSMatthew G. Knepley Input Parameter: 75058e4ac7eaSMatthew G. Knepley . dm - The DM 75068e4ac7eaSMatthew G. Knepley 75078e4ac7eaSMatthew G. Knepley Output Parameter: 75088e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution 75098e4ac7eaSMatthew G. Knepley 75108e4ac7eaSMatthew G. Knepley Level: beginner 75118e4ac7eaSMatthew G. Knepley 75128e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate() 75138e4ac7eaSMatthew G. Knepley @*/ 75148e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural) 75158e4ac7eaSMatthew G. Knepley { 75168e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 75178e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7518534a8f05SLisandro Dalcin PetscValidBoolPointer(useNatural, 2); 75198e4ac7eaSMatthew G. Knepley *useNatural = dm->useNatural; 75208e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 75218e4ac7eaSMatthew G. Knepley } 75228e4ac7eaSMatthew G. Knepley 75238e4ac7eaSMatthew G. Knepley /*@ 75245d3b26e6SMatthew G. Knepley DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution 75258e4ac7eaSMatthew G. Knepley 75268e4ac7eaSMatthew G. Knepley Collective on dm 75278e4ac7eaSMatthew G. Knepley 75288e4ac7eaSMatthew G. Knepley Input Parameters: 75298e4ac7eaSMatthew G. Knepley + dm - The DM 75308e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution 75318e4ac7eaSMatthew G. Knepley 75325d3b26e6SMatthew G. Knepley Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM() 75335d3b26e6SMatthew G. Knepley 75348e4ac7eaSMatthew G. Knepley Level: beginner 75358e4ac7eaSMatthew G. Knepley 75365d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM() 75378e4ac7eaSMatthew G. Knepley @*/ 75388e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural) 75398e4ac7eaSMatthew G. Knepley { 75408e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 75418e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 75428833efb5SBlaise Bourdin PetscValidLogicalCollectiveBool(dm, useNatural, 2); 75438e4ac7eaSMatthew G. Knepley dm->useNatural = useNatural; 75448e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 75458e4ac7eaSMatthew G. Knepley } 7546c58f1c22SToby Isaac 7547c58f1c22SToby Isaac /*@C 7548c58f1c22SToby Isaac DMCreateLabel - Create a label of the given name if it does not already exist 7549c58f1c22SToby Isaac 7550c58f1c22SToby Isaac Not Collective 7551c58f1c22SToby Isaac 7552c58f1c22SToby Isaac Input Parameters: 7553c58f1c22SToby Isaac + dm - The DM object 7554c58f1c22SToby Isaac - name - The label name 7555c58f1c22SToby Isaac 7556c58f1c22SToby Isaac Level: intermediate 7557c58f1c22SToby Isaac 7558c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7559c58f1c22SToby Isaac @*/ 7560c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[]) 7561c58f1c22SToby Isaac { 75625d80c0bfSVaclav Hapla PetscBool flg; 75635d80c0bfSVaclav Hapla DMLabel label; 7564c58f1c22SToby Isaac PetscErrorCode ierr; 7565c58f1c22SToby Isaac 7566c58f1c22SToby Isaac PetscFunctionBegin; 7567c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7568c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 75695d80c0bfSVaclav Hapla ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 7570c58f1c22SToby Isaac if (!flg) { 75715d80c0bfSVaclav Hapla ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 75725d80c0bfSVaclav Hapla ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 75735d80c0bfSVaclav Hapla ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 7574c58f1c22SToby Isaac } 7575c58f1c22SToby Isaac PetscFunctionReturn(0); 7576c58f1c22SToby Isaac } 7577c58f1c22SToby Isaac 7578c58f1c22SToby Isaac /*@C 75790fdc7489SMatthew Knepley DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index. 75800fdc7489SMatthew Knepley 75810fdc7489SMatthew Knepley Not Collective 75820fdc7489SMatthew Knepley 75830fdc7489SMatthew Knepley Input Parameters: 75840fdc7489SMatthew Knepley + dm - The DM object 75850fdc7489SMatthew Knepley . l - The index for the label 75860fdc7489SMatthew Knepley - name - The label name 75870fdc7489SMatthew Knepley 75880fdc7489SMatthew Knepley Level: intermediate 75890fdc7489SMatthew Knepley 75900fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 75910fdc7489SMatthew Knepley @*/ 75920fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[]) 75930fdc7489SMatthew Knepley { 75940fdc7489SMatthew Knepley DMLabelLink orig, prev = NULL; 75950fdc7489SMatthew Knepley DMLabel label; 75960fdc7489SMatthew Knepley PetscInt Nl, m; 75970fdc7489SMatthew Knepley PetscBool flg, match; 75980fdc7489SMatthew Knepley const char *lname; 75990fdc7489SMatthew Knepley PetscErrorCode ierr; 76000fdc7489SMatthew Knepley 76010fdc7489SMatthew Knepley PetscFunctionBegin; 76020fdc7489SMatthew Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7603064a246eSJacob Faibussowitsch PetscValidCharPointer(name, 3); 76040fdc7489SMatthew Knepley ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 76050fdc7489SMatthew Knepley if (!flg) { 76060fdc7489SMatthew Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 76070fdc7489SMatthew Knepley ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 76080fdc7489SMatthew Knepley ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 76090fdc7489SMatthew Knepley } 76100fdc7489SMatthew Knepley ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr); 76112c71b3e2SJacob Faibussowitsch PetscCheckFalse(l >= Nl,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl); 76120fdc7489SMatthew Knepley for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) { 76130fdc7489SMatthew Knepley ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr); 76140fdc7489SMatthew Knepley ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr); 76150fdc7489SMatthew Knepley if (match) break; 76160fdc7489SMatthew Knepley } 76170fdc7489SMatthew Knepley if (m == l) PetscFunctionReturn(0); 76180fdc7489SMatthew Knepley if (!m) dm->labels = orig->next; 76190fdc7489SMatthew Knepley else prev->next = orig->next; 76200fdc7489SMatthew Knepley if (!l) { 76210fdc7489SMatthew Knepley orig->next = dm->labels; 76220fdc7489SMatthew Knepley dm->labels = orig; 76230fdc7489SMatthew Knepley } else { 76240fdc7489SMatthew Knepley for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next); 76250fdc7489SMatthew Knepley orig->next = prev->next; 76260fdc7489SMatthew Knepley prev->next = orig; 76270fdc7489SMatthew Knepley } 76280fdc7489SMatthew Knepley PetscFunctionReturn(0); 76290fdc7489SMatthew Knepley } 76300fdc7489SMatthew Knepley 76310fdc7489SMatthew Knepley /*@C 7632c58f1c22SToby Isaac DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default 7633c58f1c22SToby Isaac 7634c58f1c22SToby Isaac Not Collective 7635c58f1c22SToby Isaac 7636c58f1c22SToby Isaac Input Parameters: 7637c58f1c22SToby Isaac + dm - The DM object 7638c58f1c22SToby Isaac . name - The label name 7639c58f1c22SToby Isaac - point - The mesh point 7640c58f1c22SToby Isaac 7641c58f1c22SToby Isaac Output Parameter: 7642c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label 7643c58f1c22SToby Isaac 7644c58f1c22SToby Isaac Level: beginner 7645c58f1c22SToby Isaac 7646c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS() 7647c58f1c22SToby Isaac @*/ 7648c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value) 7649c58f1c22SToby Isaac { 7650c58f1c22SToby Isaac DMLabel label; 7651c58f1c22SToby Isaac PetscErrorCode ierr; 7652c58f1c22SToby Isaac 7653c58f1c22SToby Isaac PetscFunctionBegin; 7654c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7655c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7656c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 76572c71b3e2SJacob Faibussowitsch PetscCheckFalse(!label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name); 7658c58f1c22SToby Isaac ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr); 7659c58f1c22SToby Isaac PetscFunctionReturn(0); 7660c58f1c22SToby Isaac } 7661c58f1c22SToby Isaac 7662c58f1c22SToby Isaac /*@C 7663c58f1c22SToby Isaac DMSetLabelValue - Add a point to a Sieve Label with given value 7664c58f1c22SToby Isaac 7665c58f1c22SToby Isaac Not Collective 7666c58f1c22SToby Isaac 7667c58f1c22SToby Isaac Input Parameters: 7668c58f1c22SToby Isaac + dm - The DM object 7669c58f1c22SToby Isaac . name - The label name 7670c58f1c22SToby Isaac . point - The mesh point 7671c58f1c22SToby Isaac - value - The label value for this point 7672c58f1c22SToby Isaac 7673c58f1c22SToby Isaac Output Parameter: 7674c58f1c22SToby Isaac 7675c58f1c22SToby Isaac Level: beginner 7676c58f1c22SToby Isaac 7677c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue() 7678c58f1c22SToby Isaac @*/ 7679c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 7680c58f1c22SToby Isaac { 7681c58f1c22SToby Isaac DMLabel label; 7682c58f1c22SToby Isaac PetscErrorCode ierr; 7683c58f1c22SToby Isaac 7684c58f1c22SToby Isaac PetscFunctionBegin; 7685c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7686c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7687c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7688c58f1c22SToby Isaac if (!label) { 7689c58f1c22SToby Isaac ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 7690c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7691c58f1c22SToby Isaac } 7692c58f1c22SToby Isaac ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr); 7693c58f1c22SToby Isaac PetscFunctionReturn(0); 7694c58f1c22SToby Isaac } 7695c58f1c22SToby Isaac 7696c58f1c22SToby Isaac /*@C 7697c58f1c22SToby Isaac DMClearLabelValue - Remove a point from a Sieve Label with given value 7698c58f1c22SToby Isaac 7699c58f1c22SToby Isaac Not Collective 7700c58f1c22SToby Isaac 7701c58f1c22SToby Isaac Input Parameters: 7702c58f1c22SToby Isaac + dm - The DM object 7703c58f1c22SToby Isaac . name - The label name 7704c58f1c22SToby Isaac . point - The mesh point 7705c58f1c22SToby Isaac - value - The label value for this point 7706c58f1c22SToby Isaac 7707c58f1c22SToby Isaac Output Parameter: 7708c58f1c22SToby Isaac 7709c58f1c22SToby Isaac Level: beginner 7710c58f1c22SToby Isaac 7711c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS() 7712c58f1c22SToby Isaac @*/ 7713c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 7714c58f1c22SToby Isaac { 7715c58f1c22SToby Isaac DMLabel label; 7716c58f1c22SToby Isaac PetscErrorCode ierr; 7717c58f1c22SToby Isaac 7718c58f1c22SToby Isaac PetscFunctionBegin; 7719c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7720c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7721c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7722c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7723c58f1c22SToby Isaac ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr); 7724c58f1c22SToby Isaac PetscFunctionReturn(0); 7725c58f1c22SToby Isaac } 7726c58f1c22SToby Isaac 7727c58f1c22SToby Isaac /*@C 7728c58f1c22SToby Isaac DMGetLabelSize - Get the number of different integer ids in a Label 7729c58f1c22SToby Isaac 7730c58f1c22SToby Isaac Not Collective 7731c58f1c22SToby Isaac 7732c58f1c22SToby Isaac Input Parameters: 7733c58f1c22SToby Isaac + dm - The DM object 7734c58f1c22SToby Isaac - name - The label name 7735c58f1c22SToby Isaac 7736c58f1c22SToby Isaac Output Parameter: 7737c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist 7738c58f1c22SToby Isaac 7739c58f1c22SToby Isaac Level: beginner 7740c58f1c22SToby Isaac 7741df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue() 7742c58f1c22SToby Isaac @*/ 7743c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size) 7744c58f1c22SToby Isaac { 7745c58f1c22SToby Isaac DMLabel label; 7746c58f1c22SToby Isaac PetscErrorCode ierr; 7747c58f1c22SToby Isaac 7748c58f1c22SToby Isaac PetscFunctionBegin; 7749c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7750c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7751534a8f05SLisandro Dalcin PetscValidIntPointer(size, 3); 7752c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7753c58f1c22SToby Isaac *size = 0; 7754c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7755c58f1c22SToby Isaac ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr); 7756c58f1c22SToby Isaac PetscFunctionReturn(0); 7757c58f1c22SToby Isaac } 7758c58f1c22SToby Isaac 7759c58f1c22SToby Isaac /*@C 7760c58f1c22SToby Isaac DMGetLabelIdIS - Get the integer ids in a label 7761c58f1c22SToby Isaac 7762c58f1c22SToby Isaac Not Collective 7763c58f1c22SToby Isaac 7764c58f1c22SToby Isaac Input Parameters: 7765c58f1c22SToby Isaac + mesh - The DM object 7766c58f1c22SToby Isaac - name - The label name 7767c58f1c22SToby Isaac 7768c58f1c22SToby Isaac Output Parameter: 7769c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist 7770c58f1c22SToby Isaac 7771c58f1c22SToby Isaac Level: beginner 7772c58f1c22SToby Isaac 7773c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize() 7774c58f1c22SToby Isaac @*/ 7775c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids) 7776c58f1c22SToby Isaac { 7777c58f1c22SToby Isaac DMLabel label; 7778c58f1c22SToby Isaac PetscErrorCode ierr; 7779c58f1c22SToby Isaac 7780c58f1c22SToby Isaac PetscFunctionBegin; 7781c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7782c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7783c58f1c22SToby Isaac PetscValidPointer(ids, 3); 7784c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7785c58f1c22SToby Isaac *ids = NULL; 7786dab2e251SBlaise Bourdin if (label) { 7787c58f1c22SToby Isaac ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr); 7788dab2e251SBlaise Bourdin } else { 7789dab2e251SBlaise Bourdin /* returning an empty IS */ 7790dab2e251SBlaise Bourdin ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr); 7791dab2e251SBlaise Bourdin } 7792c58f1c22SToby Isaac PetscFunctionReturn(0); 7793c58f1c22SToby Isaac } 7794c58f1c22SToby Isaac 7795c58f1c22SToby Isaac /*@C 7796c58f1c22SToby Isaac DMGetStratumSize - Get the number of points in a label stratum 7797c58f1c22SToby Isaac 7798c58f1c22SToby Isaac Not Collective 7799c58f1c22SToby Isaac 7800c58f1c22SToby Isaac Input Parameters: 7801c58f1c22SToby Isaac + dm - The DM object 7802c58f1c22SToby Isaac . name - The label name 7803c58f1c22SToby Isaac - value - The stratum value 7804c58f1c22SToby Isaac 7805c58f1c22SToby Isaac Output Parameter: 7806c58f1c22SToby Isaac . size - The stratum size 7807c58f1c22SToby Isaac 7808c58f1c22SToby Isaac Level: beginner 7809c58f1c22SToby Isaac 7810c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds() 7811c58f1c22SToby Isaac @*/ 7812c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size) 7813c58f1c22SToby Isaac { 7814c58f1c22SToby Isaac DMLabel label; 7815c58f1c22SToby Isaac PetscErrorCode ierr; 7816c58f1c22SToby Isaac 7817c58f1c22SToby Isaac PetscFunctionBegin; 7818c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7819c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7820534a8f05SLisandro Dalcin PetscValidIntPointer(size, 4); 7821c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7822c58f1c22SToby Isaac *size = 0; 7823c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7824c58f1c22SToby Isaac ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr); 7825c58f1c22SToby Isaac PetscFunctionReturn(0); 7826c58f1c22SToby Isaac } 7827c58f1c22SToby Isaac 7828c58f1c22SToby Isaac /*@C 7829c58f1c22SToby Isaac DMGetStratumIS - Get the points in a label stratum 7830c58f1c22SToby Isaac 7831c58f1c22SToby Isaac Not Collective 7832c58f1c22SToby Isaac 7833c58f1c22SToby Isaac Input Parameters: 7834c58f1c22SToby Isaac + dm - The DM object 7835c58f1c22SToby Isaac . name - The label name 7836c58f1c22SToby Isaac - value - The stratum value 7837c58f1c22SToby Isaac 7838c58f1c22SToby Isaac Output Parameter: 7839c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value 7840c58f1c22SToby Isaac 7841c58f1c22SToby Isaac Level: beginner 7842c58f1c22SToby Isaac 7843c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize() 7844c58f1c22SToby Isaac @*/ 7845c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points) 7846c58f1c22SToby Isaac { 7847c58f1c22SToby Isaac DMLabel label; 7848c58f1c22SToby Isaac PetscErrorCode ierr; 7849c58f1c22SToby Isaac 7850c58f1c22SToby Isaac PetscFunctionBegin; 7851c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7852c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7853c58f1c22SToby Isaac PetscValidPointer(points, 4); 7854c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7855c58f1c22SToby Isaac *points = NULL; 7856c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7857c58f1c22SToby Isaac ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr); 7858c58f1c22SToby Isaac PetscFunctionReturn(0); 7859c58f1c22SToby Isaac } 7860c58f1c22SToby Isaac 78614de306b1SToby Isaac /*@C 78629044fa66SMatthew G. Knepley DMSetStratumIS - Set the points in a label stratum 78634de306b1SToby Isaac 78644de306b1SToby Isaac Not Collective 78654de306b1SToby Isaac 78664de306b1SToby Isaac Input Parameters: 78674de306b1SToby Isaac + dm - The DM object 78684de306b1SToby Isaac . name - The label name 78694de306b1SToby Isaac . value - The stratum value 78704de306b1SToby Isaac - points - The stratum points 78714de306b1SToby Isaac 78724de306b1SToby Isaac Level: beginner 78734de306b1SToby Isaac 78744de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize() 78754de306b1SToby Isaac @*/ 78764de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points) 78774de306b1SToby Isaac { 78784de306b1SToby Isaac DMLabel label; 78794de306b1SToby Isaac PetscErrorCode ierr; 78804de306b1SToby Isaac 78814de306b1SToby Isaac PetscFunctionBegin; 78824de306b1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 78834de306b1SToby Isaac PetscValidCharPointer(name, 2); 78844de306b1SToby Isaac PetscValidPointer(points, 4); 78854de306b1SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 78864de306b1SToby Isaac if (!label) PetscFunctionReturn(0); 78874de306b1SToby Isaac ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr); 78884de306b1SToby Isaac PetscFunctionReturn(0); 78894de306b1SToby Isaac } 78904de306b1SToby Isaac 7891c58f1c22SToby Isaac /*@C 7892c58f1c22SToby Isaac DMClearLabelStratum - Remove all points from a stratum from a Sieve Label 7893c58f1c22SToby Isaac 7894c58f1c22SToby Isaac Not Collective 7895c58f1c22SToby Isaac 7896c58f1c22SToby Isaac Input Parameters: 7897c58f1c22SToby Isaac + dm - The DM object 7898c58f1c22SToby Isaac . name - The label name 7899c58f1c22SToby Isaac - value - The label value for this point 7900c58f1c22SToby Isaac 7901c58f1c22SToby Isaac Output Parameter: 7902c58f1c22SToby Isaac 7903c58f1c22SToby Isaac Level: beginner 7904c58f1c22SToby Isaac 7905c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue() 7906c58f1c22SToby Isaac @*/ 7907c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value) 7908c58f1c22SToby Isaac { 7909c58f1c22SToby Isaac DMLabel label; 7910c58f1c22SToby Isaac PetscErrorCode ierr; 7911c58f1c22SToby Isaac 7912c58f1c22SToby Isaac PetscFunctionBegin; 7913c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7914c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7915c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7916c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7917c58f1c22SToby Isaac ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr); 7918c58f1c22SToby Isaac PetscFunctionReturn(0); 7919c58f1c22SToby Isaac } 7920c58f1c22SToby Isaac 7921c58f1c22SToby Isaac /*@ 7922c58f1c22SToby Isaac DMGetNumLabels - Return the number of labels defined by the mesh 7923c58f1c22SToby Isaac 7924c58f1c22SToby Isaac Not Collective 7925c58f1c22SToby Isaac 7926c58f1c22SToby Isaac Input Parameter: 7927c58f1c22SToby Isaac . dm - The DM object 7928c58f1c22SToby Isaac 7929c58f1c22SToby Isaac Output Parameter: 7930c58f1c22SToby Isaac . numLabels - the number of Labels 7931c58f1c22SToby Isaac 7932c58f1c22SToby Isaac Level: intermediate 7933c58f1c22SToby Isaac 7934c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7935c58f1c22SToby Isaac @*/ 7936c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels) 7937c58f1c22SToby Isaac { 79385d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7939c58f1c22SToby Isaac PetscInt n = 0; 7940c58f1c22SToby Isaac 7941c58f1c22SToby Isaac PetscFunctionBegin; 7942c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7943534a8f05SLisandro Dalcin PetscValidIntPointer(numLabels, 2); 7944c58f1c22SToby Isaac while (next) {++n; next = next->next;} 7945c58f1c22SToby Isaac *numLabels = n; 7946c58f1c22SToby Isaac PetscFunctionReturn(0); 7947c58f1c22SToby Isaac } 7948c58f1c22SToby Isaac 7949c58f1c22SToby Isaac /*@C 7950c58f1c22SToby Isaac DMGetLabelName - Return the name of nth label 7951c58f1c22SToby Isaac 7952c58f1c22SToby Isaac Not Collective 7953c58f1c22SToby Isaac 7954c58f1c22SToby Isaac Input Parameters: 7955c58f1c22SToby Isaac + dm - The DM object 7956c58f1c22SToby Isaac - n - the label number 7957c58f1c22SToby Isaac 7958c58f1c22SToby Isaac Output Parameter: 7959c58f1c22SToby Isaac . name - the label name 7960c58f1c22SToby Isaac 7961c58f1c22SToby Isaac Level: intermediate 7962c58f1c22SToby Isaac 7963c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7964c58f1c22SToby Isaac @*/ 7965c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name) 7966c58f1c22SToby Isaac { 79675d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7968c58f1c22SToby Isaac PetscInt l = 0; 7969d67d17b1SMatthew G. Knepley PetscErrorCode ierr; 7970c58f1c22SToby Isaac 7971c58f1c22SToby Isaac PetscFunctionBegin; 7972c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7973c58f1c22SToby Isaac PetscValidPointer(name, 3); 7974c58f1c22SToby Isaac while (next) { 7975c58f1c22SToby Isaac if (l == n) { 7976d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr); 7977c58f1c22SToby Isaac PetscFunctionReturn(0); 7978c58f1c22SToby Isaac } 7979c58f1c22SToby Isaac ++l; 7980c58f1c22SToby Isaac next = next->next; 7981c58f1c22SToby Isaac } 798298921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 7983c58f1c22SToby Isaac } 7984c58f1c22SToby Isaac 7985c58f1c22SToby Isaac /*@C 7986c58f1c22SToby Isaac DMHasLabel - Determine whether the mesh has a label of a given name 7987c58f1c22SToby Isaac 7988c58f1c22SToby Isaac Not Collective 7989c58f1c22SToby Isaac 7990c58f1c22SToby Isaac Input Parameters: 7991c58f1c22SToby Isaac + dm - The DM object 7992c58f1c22SToby Isaac - name - The label name 7993c58f1c22SToby Isaac 7994c58f1c22SToby Isaac Output Parameter: 7995c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present 7996c58f1c22SToby Isaac 7997c58f1c22SToby Isaac Level: intermediate 7998c58f1c22SToby Isaac 7999c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8000c58f1c22SToby Isaac @*/ 8001c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel) 8002c58f1c22SToby Isaac { 80035d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8004d67d17b1SMatthew G. Knepley const char *lname; 8005c58f1c22SToby Isaac PetscErrorCode ierr; 8006c58f1c22SToby Isaac 8007c58f1c22SToby Isaac PetscFunctionBegin; 8008c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8009c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 8010534a8f05SLisandro Dalcin PetscValidBoolPointer(hasLabel, 3); 8011c58f1c22SToby Isaac *hasLabel = PETSC_FALSE; 8012c58f1c22SToby Isaac while (next) { 8013d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8014d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr); 8015c58f1c22SToby Isaac if (*hasLabel) break; 8016c58f1c22SToby Isaac next = next->next; 8017c58f1c22SToby Isaac } 8018c58f1c22SToby Isaac PetscFunctionReturn(0); 8019c58f1c22SToby Isaac } 8020c58f1c22SToby Isaac 8021c58f1c22SToby Isaac /*@C 8022c58f1c22SToby Isaac DMGetLabel - Return the label of a given name, or NULL 8023c58f1c22SToby Isaac 8024c58f1c22SToby Isaac Not Collective 8025c58f1c22SToby Isaac 8026c58f1c22SToby Isaac Input Parameters: 8027c58f1c22SToby Isaac + dm - The DM object 8028c58f1c22SToby Isaac - name - The label name 8029c58f1c22SToby Isaac 8030c58f1c22SToby Isaac Output Parameter: 8031c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 8032c58f1c22SToby Isaac 80336d7c9049SMatthew G. Knepley Note: Some of the default labels in a DMPlex will be 80346d7c9049SMatthew G. Knepley $ "depth" - Holds the depth (co-dimension) of each mesh point 80356d7c9049SMatthew G. Knepley $ "celltype" - Holds the topological type of each cell 80366d7c9049SMatthew G. Knepley $ "ghost" - If the DM is distributed with overlap, this marks the cells and faces in the overlap 80376d7c9049SMatthew G. Knepley $ "Cell Sets" - Mirrors the cell sets defined by GMsh and ExodusII 80386d7c9049SMatthew G. Knepley $ "Face Sets" - Mirrors the face sets defined by GMsh and ExodusII 80396d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh 80406d7c9049SMatthew G. Knepley 8041c58f1c22SToby Isaac Level: intermediate 8042c58f1c22SToby Isaac 80436d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType() 8044c58f1c22SToby Isaac @*/ 8045c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label) 8046c58f1c22SToby Isaac { 80475d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8048c58f1c22SToby Isaac PetscBool hasLabel; 8049d67d17b1SMatthew G. Knepley const char *lname; 8050c58f1c22SToby Isaac PetscErrorCode ierr; 8051c58f1c22SToby Isaac 8052c58f1c22SToby Isaac PetscFunctionBegin; 8053c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8054c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 8055c58f1c22SToby Isaac PetscValidPointer(label, 3); 8056c58f1c22SToby Isaac *label = NULL; 8057c58f1c22SToby Isaac while (next) { 8058d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8059d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 8060c58f1c22SToby Isaac if (hasLabel) { 8061c58f1c22SToby Isaac *label = next->label; 8062c58f1c22SToby Isaac break; 8063c58f1c22SToby Isaac } 8064c58f1c22SToby Isaac next = next->next; 8065c58f1c22SToby Isaac } 8066c58f1c22SToby Isaac PetscFunctionReturn(0); 8067c58f1c22SToby Isaac } 8068c58f1c22SToby Isaac 8069c58f1c22SToby Isaac /*@C 8070c58f1c22SToby Isaac DMGetLabelByNum - Return the nth label 8071c58f1c22SToby Isaac 8072c58f1c22SToby Isaac Not Collective 8073c58f1c22SToby Isaac 8074c58f1c22SToby Isaac Input Parameters: 8075c58f1c22SToby Isaac + dm - The DM object 8076c58f1c22SToby Isaac - n - the label number 8077c58f1c22SToby Isaac 8078c58f1c22SToby Isaac Output Parameter: 8079c58f1c22SToby Isaac . label - the label 8080c58f1c22SToby Isaac 8081c58f1c22SToby Isaac Level: intermediate 8082c58f1c22SToby Isaac 8083c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8084c58f1c22SToby Isaac @*/ 8085c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label) 8086c58f1c22SToby Isaac { 80875d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8088c58f1c22SToby Isaac PetscInt l = 0; 8089c58f1c22SToby Isaac 8090c58f1c22SToby Isaac PetscFunctionBegin; 8091c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8092c58f1c22SToby Isaac PetscValidPointer(label, 3); 8093c58f1c22SToby Isaac while (next) { 8094c58f1c22SToby Isaac if (l == n) { 8095c58f1c22SToby Isaac *label = next->label; 8096c58f1c22SToby Isaac PetscFunctionReturn(0); 8097c58f1c22SToby Isaac } 8098c58f1c22SToby Isaac ++l; 8099c58f1c22SToby Isaac next = next->next; 8100c58f1c22SToby Isaac } 810198921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 8102c58f1c22SToby Isaac } 8103c58f1c22SToby Isaac 8104c58f1c22SToby Isaac /*@C 8105c58f1c22SToby Isaac DMAddLabel - Add the label to this mesh 8106c58f1c22SToby Isaac 8107c58f1c22SToby Isaac Not Collective 8108c58f1c22SToby Isaac 8109c58f1c22SToby Isaac Input Parameters: 8110c58f1c22SToby Isaac + dm - The DM object 8111c58f1c22SToby Isaac - label - The DMLabel 8112c58f1c22SToby Isaac 8113c58f1c22SToby Isaac Level: developer 8114c58f1c22SToby Isaac 8115c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8116c58f1c22SToby Isaac @*/ 8117c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label) 8118c58f1c22SToby Isaac { 81195d80c0bfSVaclav Hapla DMLabelLink l, *p, tmpLabel; 8120c58f1c22SToby Isaac PetscBool hasLabel; 8121d67d17b1SMatthew G. Knepley const char *lname; 81225d80c0bfSVaclav Hapla PetscBool flg; 8123c58f1c22SToby Isaac PetscErrorCode ierr; 8124c58f1c22SToby Isaac 8125c58f1c22SToby Isaac PetscFunctionBegin; 8126c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8127d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr); 8128d67d17b1SMatthew G. Knepley ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr); 81292c71b3e2SJacob Faibussowitsch PetscCheckFalse(hasLabel,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname); 8130c58f1c22SToby Isaac ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr); 8131c58f1c22SToby Isaac tmpLabel->label = label; 8132c58f1c22SToby Isaac tmpLabel->output = PETSC_TRUE; 81335d80c0bfSVaclav Hapla for (p=&dm->labels; (l=*p); p=&l->next) {} 81345d80c0bfSVaclav Hapla *p = tmpLabel; 813508f633c4SVaclav Hapla ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr); 81365d80c0bfSVaclav Hapla ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 81375d80c0bfSVaclav Hapla if (flg) dm->depthLabel = label; 8138ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr); 8139ba2698f1SMatthew G. Knepley if (flg) dm->celltypeLabel = label; 8140c58f1c22SToby Isaac PetscFunctionReturn(0); 8141c58f1c22SToby Isaac } 8142c58f1c22SToby Isaac 8143c58f1c22SToby Isaac /*@C 81444a7ee7d0SMatthew G. Knepley DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present 81454a7ee7d0SMatthew G. Knepley 81464a7ee7d0SMatthew G. Knepley Not Collective 81474a7ee7d0SMatthew G. Knepley 81484a7ee7d0SMatthew G. Knepley Input Parameters: 81494a7ee7d0SMatthew G. Knepley + dm - The DM object 81504a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute 81514a7ee7d0SMatthew G. Knepley 81524a7ee7d0SMatthew G. Knepley Note: Some of the default labels in a DMPlex will be 81534a7ee7d0SMatthew G. Knepley $ "depth" - Holds the depth (co-dimension) of each mesh point 81544a7ee7d0SMatthew G. Knepley $ "celltype" - Holds the topological type of each cell 81554a7ee7d0SMatthew G. Knepley $ "ghost" - If the DM is distributed with overlap, this marks the cells and faces in the overlap 81564a7ee7d0SMatthew G. Knepley $ "Cell Sets" - Mirrors the cell sets defined by GMsh and ExodusII 81574a7ee7d0SMatthew G. Knepley $ "Face Sets" - Mirrors the face sets defined by GMsh and ExodusII 81584a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh 81594a7ee7d0SMatthew G. Knepley 81604a7ee7d0SMatthew G. Knepley Level: intermediate 81614a7ee7d0SMatthew G. Knepley 81624a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType() 81634a7ee7d0SMatthew G. Knepley @*/ 81644a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label) 81654a7ee7d0SMatthew G. Knepley { 81664a7ee7d0SMatthew G. Knepley DMLabelLink next = dm->labels; 81674a7ee7d0SMatthew G. Knepley PetscBool hasLabel, flg; 81684a7ee7d0SMatthew G. Knepley const char *name, *lname; 81694a7ee7d0SMatthew G. Knepley PetscErrorCode ierr; 81704a7ee7d0SMatthew G. Knepley 81714a7ee7d0SMatthew G. Knepley PetscFunctionBegin; 81724a7ee7d0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 81734a7ee7d0SMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 81744a7ee7d0SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr); 81754a7ee7d0SMatthew G. Knepley while (next) { 81764a7ee7d0SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 81774a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 81784a7ee7d0SMatthew G. Knepley if (hasLabel) { 81794a7ee7d0SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 81804a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 81814a7ee7d0SMatthew G. Knepley if (flg) dm->depthLabel = label; 81824a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr); 81834a7ee7d0SMatthew G. Knepley if (flg) dm->celltypeLabel = label; 81844a7ee7d0SMatthew G. Knepley ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 81854a7ee7d0SMatthew G. Knepley next->label = label; 81864a7ee7d0SMatthew G. Knepley break; 81874a7ee7d0SMatthew G. Knepley } 81884a7ee7d0SMatthew G. Knepley next = next->next; 81894a7ee7d0SMatthew G. Knepley } 81904a7ee7d0SMatthew G. Knepley PetscFunctionReturn(0); 81914a7ee7d0SMatthew G. Knepley } 81924a7ee7d0SMatthew G. Knepley 81934a7ee7d0SMatthew G. Knepley /*@C 8194e5472504SVaclav Hapla DMRemoveLabel - Remove the label given by name from this mesh 8195c58f1c22SToby Isaac 8196c58f1c22SToby Isaac Not Collective 8197c58f1c22SToby Isaac 8198c58f1c22SToby Isaac Input Parameters: 8199c58f1c22SToby Isaac + dm - The DM object 8200c58f1c22SToby Isaac - name - The label name 8201c58f1c22SToby Isaac 8202c58f1c22SToby Isaac Output Parameter: 8203c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 8204c58f1c22SToby Isaac 8205c58f1c22SToby Isaac Level: developer 8206c58f1c22SToby Isaac 8207e5472504SVaclav Hapla Notes: 8208e5472504SVaclav Hapla DMRemoveLabel(dm,name,NULL) removes the label from dm and calls 8209e5472504SVaclav Hapla DMLabelDestroy() on the label. 8210e5472504SVaclav Hapla 8211e5472504SVaclav Hapla DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT 8212e5472504SVaclav Hapla call DMLabelDestroy(). Instead, the label is returned and the user is 8213e5472504SVaclav Hapla responsible of calling DMLabelDestroy() at some point. 8214e5472504SVaclav Hapla 8215e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf() 8216c58f1c22SToby Isaac @*/ 8217c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label) 8218c58f1c22SToby Isaac { 821995d578d6SVaclav Hapla DMLabelLink link, *pnext; 8220c58f1c22SToby Isaac PetscBool hasLabel; 8221d67d17b1SMatthew G. Knepley const char *lname; 8222c58f1c22SToby Isaac PetscErrorCode ierr; 8223c58f1c22SToby Isaac 8224c58f1c22SToby Isaac PetscFunctionBegin; 8225c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8226e5472504SVaclav Hapla PetscValidCharPointer(name, 2); 8227e5472504SVaclav Hapla if (label) { 8228e5472504SVaclav Hapla PetscValidPointer(label, 3); 8229c58f1c22SToby Isaac *label = NULL; 8230e5472504SVaclav Hapla } 82315d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 823295d578d6SVaclav Hapla ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr); 8233d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 8234c58f1c22SToby Isaac if (hasLabel) { 823595d578d6SVaclav Hapla *pnext = link->next; /* Remove from list */ 8236c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr); 823795d578d6SVaclav Hapla if (hasLabel) dm->depthLabel = NULL; 8238ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr); 8239ba2698f1SMatthew G. Knepley if (hasLabel) dm->celltypeLabel = NULL; 824095d578d6SVaclav Hapla if (label) *label = link->label; 824195d578d6SVaclav Hapla else {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);} 824295d578d6SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 8243c58f1c22SToby Isaac break; 8244c58f1c22SToby Isaac } 8245c58f1c22SToby Isaac } 8246c58f1c22SToby Isaac PetscFunctionReturn(0); 8247c58f1c22SToby Isaac } 8248c58f1c22SToby Isaac 8249306894acSVaclav Hapla /*@ 8250306894acSVaclav Hapla DMRemoveLabelBySelf - Remove the label from this mesh 8251306894acSVaclav Hapla 8252306894acSVaclav Hapla Not Collective 8253306894acSVaclav Hapla 8254306894acSVaclav Hapla Input Parameters: 8255306894acSVaclav Hapla + dm - The DM object 8256876aa926SVaclav Hapla . label - The DMLabel to be removed from the DM 8257306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM? 8258306894acSVaclav Hapla 8259306894acSVaclav Hapla Level: developer 8260306894acSVaclav Hapla 8261306894acSVaclav Hapla Notes: 8262306894acSVaclav Hapla Only exactly the same instance is removed if found, name match is ignored. 8263306894acSVaclav Hapla If the DM has an exclusive reference to the label, it gets destroyed and 8264306894acSVaclav Hapla *label nullified. 8265306894acSVaclav Hapla 8266306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel() 8267306894acSVaclav Hapla @*/ 8268306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound) 8269306894acSVaclav Hapla { 827043e45a93SVaclav Hapla DMLabelLink link, *pnext; 8271306894acSVaclav Hapla PetscBool hasLabel = PETSC_FALSE; 8272306894acSVaclav Hapla PetscErrorCode ierr; 8273306894acSVaclav Hapla 8274306894acSVaclav Hapla PetscFunctionBegin; 8275306894acSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8276306894acSVaclav Hapla PetscValidPointer(label, 2); 8277f39a9ae0SVaclav Hapla if (!*label && !failNotFound) PetscFunctionReturn(0); 8278306894acSVaclav Hapla PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2); 8279306894acSVaclav Hapla PetscValidLogicalCollectiveBool(dm,failNotFound,3); 82805d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 828143e45a93SVaclav Hapla if (*label == link->label) { 8282306894acSVaclav Hapla hasLabel = PETSC_TRUE; 828343e45a93SVaclav Hapla *pnext = link->next; /* Remove from list */ 8284306894acSVaclav Hapla if (*label == dm->depthLabel) dm->depthLabel = NULL; 8285ba2698f1SMatthew G. Knepley if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL; 828643e45a93SVaclav Hapla if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */ 828743e45a93SVaclav Hapla ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr); 828843e45a93SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 8289306894acSVaclav Hapla break; 8290306894acSVaclav Hapla } 8291306894acSVaclav Hapla } 82922c71b3e2SJacob Faibussowitsch PetscCheckFalse(!hasLabel && failNotFound,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM"); 8293306894acSVaclav Hapla PetscFunctionReturn(0); 8294306894acSVaclav Hapla } 8295306894acSVaclav Hapla 8296c58f1c22SToby Isaac /*@C 8297c58f1c22SToby Isaac DMGetLabelOutput - Get the output flag for a given label 8298c58f1c22SToby Isaac 8299c58f1c22SToby Isaac Not Collective 8300c58f1c22SToby Isaac 8301c58f1c22SToby Isaac Input Parameters: 8302c58f1c22SToby Isaac + dm - The DM object 8303c58f1c22SToby Isaac - name - The label name 8304c58f1c22SToby Isaac 8305c58f1c22SToby Isaac Output Parameter: 8306c58f1c22SToby Isaac . output - The flag for output 8307c58f1c22SToby Isaac 8308c58f1c22SToby Isaac Level: developer 8309c58f1c22SToby Isaac 8310c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8311c58f1c22SToby Isaac @*/ 8312c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output) 8313c58f1c22SToby Isaac { 83145d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8315d67d17b1SMatthew G. Knepley const char *lname; 8316c58f1c22SToby Isaac PetscErrorCode ierr; 8317c58f1c22SToby Isaac 8318c58f1c22SToby Isaac PetscFunctionBegin; 8319c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8320c58f1c22SToby Isaac PetscValidPointer(name, 2); 8321c58f1c22SToby Isaac PetscValidPointer(output, 3); 8322c58f1c22SToby Isaac while (next) { 8323c58f1c22SToby Isaac PetscBool flg; 8324c58f1c22SToby Isaac 8325d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8326d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 8327c58f1c22SToby Isaac if (flg) {*output = next->output; PetscFunctionReturn(0);} 8328c58f1c22SToby Isaac next = next->next; 8329c58f1c22SToby Isaac } 833098921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 8331c58f1c22SToby Isaac } 8332c58f1c22SToby Isaac 8333c58f1c22SToby Isaac /*@C 8334c58f1c22SToby Isaac DMSetLabelOutput - Set the output flag for a given label 8335c58f1c22SToby Isaac 8336c58f1c22SToby Isaac Not Collective 8337c58f1c22SToby Isaac 8338c58f1c22SToby Isaac Input Parameters: 8339c58f1c22SToby Isaac + dm - The DM object 8340c58f1c22SToby Isaac . name - The label name 8341c58f1c22SToby Isaac - output - The flag for output 8342c58f1c22SToby Isaac 8343c58f1c22SToby Isaac Level: developer 8344c58f1c22SToby Isaac 8345c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8346c58f1c22SToby Isaac @*/ 8347c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output) 8348c58f1c22SToby Isaac { 83495d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8350d67d17b1SMatthew G. Knepley const char *lname; 8351c58f1c22SToby Isaac PetscErrorCode ierr; 8352c58f1c22SToby Isaac 8353c58f1c22SToby Isaac PetscFunctionBegin; 8354c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8355534a8f05SLisandro Dalcin PetscValidCharPointer(name, 2); 8356c58f1c22SToby Isaac while (next) { 8357c58f1c22SToby Isaac PetscBool flg; 8358c58f1c22SToby Isaac 8359d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8360d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 8361c58f1c22SToby Isaac if (flg) {next->output = output; PetscFunctionReturn(0);} 8362c58f1c22SToby Isaac next = next->next; 8363c58f1c22SToby Isaac } 836498921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 8365c58f1c22SToby Isaac } 8366c58f1c22SToby Isaac 8367c58f1c22SToby Isaac /*@ 8368c58f1c22SToby Isaac DMCopyLabels - Copy labels from one mesh to another with a superset of the points 8369c58f1c22SToby Isaac 8370d083f849SBarry Smith Collective on dmA 8371c58f1c22SToby Isaac 8372d8d19677SJose E. Roman Input Parameters: 83735d80c0bfSVaclav Hapla + dmA - The DM object with initial labels 83742cbb9b06SVaclav Hapla . dmB - The DM object to which labels are copied 83755d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES) 83762cbb9b06SVaclav Hapla . all - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE) 83772cbb9b06SVaclav Hapla - emode - How to behave when a DMLabel in the source and destination DMs with the same name is encountered (see DMCopyLabelsMode) 8378c58f1c22SToby Isaac 8379c58f1c22SToby Isaac Level: intermediate 8380c58f1c22SToby Isaac 83812cbb9b06SVaclav Hapla Notes: 83822cbb9b06SVaclav Hapla This is typically used when interpolating or otherwise adding to a mesh, or testing. 8383c58f1c22SToby Isaac 83842cbb9b06SVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode 8385c58f1c22SToby Isaac @*/ 83862cbb9b06SVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all, DMCopyLabelsMode emode) 8387c58f1c22SToby Isaac { 83882cbb9b06SVaclav Hapla DMLabel label, labelNew, labelOld; 8389c58f1c22SToby Isaac const char *name; 8390c58f1c22SToby Isaac PetscBool flg; 83915d80c0bfSVaclav Hapla DMLabelLink link; 83925d80c0bfSVaclav Hapla PetscErrorCode ierr; 8393c58f1c22SToby Isaac 83945d80c0bfSVaclav Hapla PetscFunctionBegin; 83955d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmA, DM_CLASSID, 1); 83965d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmB, DM_CLASSID, 2); 83975d80c0bfSVaclav Hapla PetscValidLogicalCollectiveEnum(dmA, mode,3); 83985d80c0bfSVaclav Hapla PetscValidLogicalCollectiveBool(dmA, all, 4); 83992c71b3e2SJacob Faibussowitsch PetscCheckFalse(mode==PETSC_USE_POINTER,PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects"); 84005d80c0bfSVaclav Hapla if (dmA == dmB) PetscFunctionReturn(0); 84015d80c0bfSVaclav Hapla for (link=dmA->labels; link; link=link->next) { 84025d80c0bfSVaclav Hapla label=link->label; 84035d80c0bfSVaclav Hapla ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr); 84045d80c0bfSVaclav Hapla if (!all) { 8405c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr); 8406c58f1c22SToby Isaac if (flg) continue; 84077d5acc75SStefano Zampini ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr); 84087d5acc75SStefano Zampini if (flg) continue; 8409ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr); 8410ba2698f1SMatthew G. Knepley if (flg) continue; 84115d80c0bfSVaclav Hapla } 84122cbb9b06SVaclav Hapla ierr = DMGetLabel(dmB, name, &labelOld);CHKERRQ(ierr); 84132cbb9b06SVaclav Hapla if (labelOld) { 84142cbb9b06SVaclav Hapla switch (emode) { 84152cbb9b06SVaclav Hapla case DM_COPY_LABELS_KEEP: 84162cbb9b06SVaclav Hapla continue; 84172cbb9b06SVaclav Hapla case DM_COPY_LABELS_REPLACE: 84182cbb9b06SVaclav Hapla ierr = DMRemoveLabelBySelf(dmB, &labelOld, PETSC_TRUE);CHKERRQ(ierr); 84192cbb9b06SVaclav Hapla break; 84202cbb9b06SVaclav Hapla case DM_COPY_LABELS_FAIL: 842198921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in destination DM", name); 84222cbb9b06SVaclav Hapla default: 842398921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Unhandled DMCopyLabelsMode %d", emode); 84242cbb9b06SVaclav Hapla } 84252cbb9b06SVaclav Hapla } 84265d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) { 8427c58f1c22SToby Isaac ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr); 84285d80c0bfSVaclav Hapla } else { 84295d80c0bfSVaclav Hapla labelNew = label; 84305d80c0bfSVaclav Hapla } 8431c58f1c22SToby Isaac ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr); 84325d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);} 8433c58f1c22SToby Isaac } 8434c58f1c22SToby Isaac PetscFunctionReturn(0); 8435c58f1c22SToby Isaac } 8436461a15a0SLisandro Dalcin 8437609dae6eSVaclav Hapla /*@C 8438609dae6eSVaclav Hapla DMCompareLabels - Compare labels of two DMPlex meshes 8439609dae6eSVaclav Hapla 84405efe38ccSVaclav Hapla Collective 8441609dae6eSVaclav Hapla 8442609dae6eSVaclav Hapla Input Parameters: 8443609dae6eSVaclav Hapla + dm0 - First DM object 8444609dae6eSVaclav Hapla - dm1 - Second DM object 8445609dae6eSVaclav Hapla 8446609dae6eSVaclav Hapla Output Parameters 84475efe38ccSVaclav Hapla + equal - (Optional) Flag whether labels of dm0 and dm1 are the same 8448609dae6eSVaclav Hapla - message - (Optional) Message describing the difference, or NULL if there is no difference 8449609dae6eSVaclav Hapla 8450609dae6eSVaclav Hapla Level: intermediate 8451609dae6eSVaclav Hapla 8452609dae6eSVaclav Hapla Notes: 84535efe38ccSVaclav Hapla The output flag equal is the same on all processes. 84545efe38ccSVaclav Hapla If it is passed as NULL and difference is found, an error is thrown on all processes. 84555efe38ccSVaclav Hapla Make sure to pass NULL on all processes. 8456609dae6eSVaclav Hapla 84575efe38ccSVaclav Hapla The output message is set independently on each rank. 84585efe38ccSVaclav Hapla It is set to NULL if no difference was found on the current rank. It must be freed by user. 84595efe38ccSVaclav Hapla If message is passed as NULL and difference is found, the difference description is printed to stderr in synchronized manner. 84605efe38ccSVaclav Hapla Make sure to pass NULL on all processes. 8461609dae6eSVaclav Hapla 8462609dae6eSVaclav Hapla Labels are matched by name. If the number of labels and their names are equal, 8463609dae6eSVaclav Hapla DMLabelCompare() is used to compare each pair of labels with the same name. 8464609dae6eSVaclav Hapla 8465609dae6eSVaclav Hapla Fortran Notes: 8466609dae6eSVaclav Hapla This function is currently not available from Fortran. 8467609dae6eSVaclav Hapla 8468609dae6eSVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode, DMLabelCompare() 8469609dae6eSVaclav Hapla @*/ 84705efe38ccSVaclav Hapla PetscErrorCode DMCompareLabels(DM dm0, DM dm1, PetscBool *equal, char **message) 8471609dae6eSVaclav Hapla { 84725efe38ccSVaclav Hapla PetscInt n, i; 8473609dae6eSVaclav Hapla char msg[PETSC_MAX_PATH_LEN] = ""; 84745efe38ccSVaclav Hapla PetscBool eq; 8475609dae6eSVaclav Hapla MPI_Comm comm; 84765efe38ccSVaclav Hapla PetscMPIInt rank; 8477609dae6eSVaclav Hapla PetscErrorCode ierr; 8478609dae6eSVaclav Hapla 8479609dae6eSVaclav Hapla PetscFunctionBegin; 8480609dae6eSVaclav Hapla PetscValidHeaderSpecific(dm0,DM_CLASSID,1); 8481609dae6eSVaclav Hapla PetscValidHeaderSpecific(dm1,DM_CLASSID,2); 8482609dae6eSVaclav Hapla PetscCheckSameComm(dm0,1,dm1,2); 84835efe38ccSVaclav Hapla if (equal) PetscValidBoolPointer(equal,3); 8484609dae6eSVaclav Hapla if (message) PetscValidPointer(message, 4); 8485609dae6eSVaclav Hapla ierr = PetscObjectGetComm((PetscObject)dm0, &comm);CHKERRQ(ierr); 84865efe38ccSVaclav Hapla ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 84875efe38ccSVaclav Hapla { 84885efe38ccSVaclav Hapla PetscInt n1; 84895efe38ccSVaclav Hapla 84905efe38ccSVaclav Hapla ierr = DMGetNumLabels(dm0, &n);CHKERRQ(ierr); 8491609dae6eSVaclav Hapla ierr = DMGetNumLabels(dm1, &n1);CHKERRQ(ierr); 84925efe38ccSVaclav Hapla eq = (PetscBool) (n == n1); 84935efe38ccSVaclav Hapla if (!eq) { 84945efe38ccSVaclav Hapla ierr = PetscSNPrintf(msg, sizeof(msg), "Number of labels in dm0 = %D != %D = Number of labels in dm1", n, n1);CHKERRQ(ierr); 8495609dae6eSVaclav Hapla } 84965efe38ccSVaclav Hapla ierr = MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 84975efe38ccSVaclav Hapla if (!eq) goto finish; 84985efe38ccSVaclav Hapla } 84995efe38ccSVaclav Hapla for (i=0; i<n; i++) { 8500609dae6eSVaclav Hapla DMLabel l0, l1; 8501609dae6eSVaclav Hapla const char *name; 8502609dae6eSVaclav Hapla char *msgInner; 8503609dae6eSVaclav Hapla 8504609dae6eSVaclav Hapla /* Ignore label order */ 8505609dae6eSVaclav Hapla ierr = DMGetLabelByNum(dm0, i, &l0);CHKERRQ(ierr); 8506609dae6eSVaclav Hapla ierr = PetscObjectGetName((PetscObject)l0, &name);CHKERRQ(ierr); 8507609dae6eSVaclav Hapla ierr = DMGetLabel(dm1, name, &l1);CHKERRQ(ierr); 8508609dae6eSVaclav Hapla if (!l1) { 8509609dae6eSVaclav Hapla ierr = PetscSNPrintf(msg, sizeof(msg), "Label \"%s\" (#%D in dm0) not found in dm1", name, i);CHKERRQ(ierr); 85105efe38ccSVaclav Hapla eq = PETSC_FALSE; 85115efe38ccSVaclav Hapla break; 8512609dae6eSVaclav Hapla } 85135efe38ccSVaclav Hapla ierr = DMLabelCompare(comm, l0, l1, &eq, &msgInner);CHKERRQ(ierr); 8514609dae6eSVaclav Hapla ierr = PetscStrncpy(msg, msgInner, sizeof(msg));CHKERRQ(ierr); 8515609dae6eSVaclav Hapla ierr = PetscFree(msgInner);CHKERRQ(ierr); 85165efe38ccSVaclav Hapla if (!eq) break; 8517609dae6eSVaclav Hapla } 85185efe38ccSVaclav Hapla ierr = MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 8519609dae6eSVaclav Hapla finish: 85205efe38ccSVaclav Hapla /* If message output arg not set, print to stderr */ 8521609dae6eSVaclav Hapla if (message) { 8522609dae6eSVaclav Hapla *message = NULL; 8523609dae6eSVaclav Hapla if (msg[0]) { 8524609dae6eSVaclav Hapla ierr = PetscStrallocpy(msg, message);CHKERRQ(ierr); 8525609dae6eSVaclav Hapla } 85265efe38ccSVaclav Hapla } else { 85275efe38ccSVaclav Hapla if (msg[0]) { 85285efe38ccSVaclav Hapla ierr = PetscSynchronizedFPrintf(comm, PETSC_STDERR, "[%d] %s\n", rank, msg);CHKERRQ(ierr); 8529609dae6eSVaclav Hapla } 85305efe38ccSVaclav Hapla ierr = PetscSynchronizedFlush(comm, PETSC_STDERR);CHKERRQ(ierr); 85315efe38ccSVaclav Hapla } 85325efe38ccSVaclav Hapla /* If same output arg not ser and labels are not equal, throw error */ 85335efe38ccSVaclav Hapla if (equal) *equal = eq; 85342c71b3e2SJacob Faibussowitsch else PetscCheckFalse(!eq,comm, PETSC_ERR_ARG_INCOMP, "DMLabels are not the same in dm0 and dm1"); 8535609dae6eSVaclav Hapla PetscFunctionReturn(0); 8536609dae6eSVaclav Hapla } 8537609dae6eSVaclav Hapla 8538461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value) 8539461a15a0SLisandro Dalcin { 8540461a15a0SLisandro Dalcin PetscErrorCode ierr; 8541609dae6eSVaclav Hapla 8542461a15a0SLisandro Dalcin PetscFunctionBegin; 8543461a15a0SLisandro Dalcin PetscValidPointer(label,2); 8544461a15a0SLisandro Dalcin if (!*label) { 8545461a15a0SLisandro Dalcin ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 8546461a15a0SLisandro Dalcin ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr); 8547461a15a0SLisandro Dalcin } 8548461a15a0SLisandro Dalcin ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr); 8549461a15a0SLisandro Dalcin PetscFunctionReturn(0); 8550461a15a0SLisandro Dalcin } 8551461a15a0SLisandro Dalcin 85520fdc7489SMatthew Knepley /* 85530fdc7489SMatthew Knepley Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would 85540fdc7489SMatthew Knepley like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every 85550fdc7489SMatthew Knepley (label, id) pair in the DM. 85560fdc7489SMatthew Knepley 85570fdc7489SMatthew Knepley However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to 85580fdc7489SMatthew Knepley each label. 85590fdc7489SMatthew Knepley */ 85600fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal) 85610fdc7489SMatthew Knepley { 85620fdc7489SMatthew Knepley DMUniversalLabel ul; 85630fdc7489SMatthew Knepley PetscBool *active; 85640fdc7489SMatthew Knepley PetscInt pStart, pEnd, p, Nl, l, m; 85650fdc7489SMatthew Knepley PetscErrorCode ierr; 85660fdc7489SMatthew Knepley 85670fdc7489SMatthew Knepley PetscFunctionBegin; 85680fdc7489SMatthew Knepley ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr); 85690fdc7489SMatthew Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr); 85700fdc7489SMatthew Knepley ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr); 85710fdc7489SMatthew Knepley ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr); 85720fdc7489SMatthew Knepley ul->Nl = 0; 85730fdc7489SMatthew Knepley for (l = 0; l < Nl; ++l) { 85740fdc7489SMatthew Knepley PetscBool isdepth, iscelltype; 85750fdc7489SMatthew Knepley const char *name; 85760fdc7489SMatthew Knepley 85770fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr); 85780fdc7489SMatthew Knepley ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr); 85790fdc7489SMatthew Knepley ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr); 85800fdc7489SMatthew Knepley active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE; 85810fdc7489SMatthew Knepley if (active[l]) ++ul->Nl; 85820fdc7489SMatthew Knepley } 85830fdc7489SMatthew 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); 85840fdc7489SMatthew Knepley ul->Nv = 0; 85850fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 85860fdc7489SMatthew Knepley DMLabel label; 85870fdc7489SMatthew Knepley PetscInt nv; 85880fdc7489SMatthew Knepley const char *name; 85890fdc7489SMatthew Knepley 85900fdc7489SMatthew Knepley if (!active[l]) continue; 85910fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr); 85920fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 85930fdc7489SMatthew Knepley ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr); 85940fdc7489SMatthew Knepley ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr); 85950fdc7489SMatthew Knepley ul->indices[m] = l; 85960fdc7489SMatthew Knepley ul->Nv += nv; 85970fdc7489SMatthew Knepley ul->offsets[m+1] = nv; 85980fdc7489SMatthew Knepley ul->bits[m+1] = PetscCeilReal(PetscLog2Real(nv+1)); 85990fdc7489SMatthew Knepley ++m; 86000fdc7489SMatthew Knepley } 86010fdc7489SMatthew Knepley for (l = 1; l <= ul->Nl; ++l) { 86020fdc7489SMatthew Knepley ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l]; 86030fdc7489SMatthew Knepley ul->bits[l] = ul->bits[l-1] + ul->bits[l]; 86040fdc7489SMatthew Knepley } 86050fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 86060fdc7489SMatthew Knepley PetscInt b; 86070fdc7489SMatthew Knepley 86080fdc7489SMatthew Knepley ul->masks[l] = 0; 86090fdc7489SMatthew Knepley for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b; 86100fdc7489SMatthew Knepley } 86110fdc7489SMatthew Knepley ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr); 86120fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 86130fdc7489SMatthew Knepley DMLabel label; 86140fdc7489SMatthew Knepley IS valueIS; 86150fdc7489SMatthew Knepley const PetscInt *varr; 86160fdc7489SMatthew Knepley PetscInt nv, v; 86170fdc7489SMatthew Knepley 86180fdc7489SMatthew Knepley if (!active[l]) continue; 86190fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 86200fdc7489SMatthew Knepley ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr); 86210fdc7489SMatthew Knepley ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr); 86220fdc7489SMatthew Knepley ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr); 86230fdc7489SMatthew Knepley for (v = 0; v < nv; ++v) { 86240fdc7489SMatthew Knepley ul->values[ul->offsets[m]+v] = varr[v]; 86250fdc7489SMatthew Knepley } 86260fdc7489SMatthew Knepley ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr); 86270fdc7489SMatthew Knepley ierr = ISDestroy(&valueIS);CHKERRQ(ierr); 86280fdc7489SMatthew Knepley ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr); 86290fdc7489SMatthew Knepley ++m; 86300fdc7489SMatthew Knepley } 86310fdc7489SMatthew Knepley ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr); 86320fdc7489SMatthew Knepley for (p = pStart; p < pEnd; ++p) { 86330fdc7489SMatthew Knepley PetscInt uval = 0; 86340fdc7489SMatthew Knepley PetscBool marked = PETSC_FALSE; 86350fdc7489SMatthew Knepley 86360fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 86370fdc7489SMatthew Knepley DMLabel label; 86380649b39aSStefano Zampini PetscInt val, defval, loc, nv; 86390fdc7489SMatthew Knepley 86400fdc7489SMatthew Knepley if (!active[l]) continue; 86410fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 86420fdc7489SMatthew Knepley ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr); 86430fdc7489SMatthew Knepley ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr); 86440fdc7489SMatthew Knepley if (val == defval) {++m; continue;} 86450649b39aSStefano Zampini nv = ul->offsets[m+1]-ul->offsets[m]; 86460fdc7489SMatthew Knepley marked = PETSC_TRUE; 86470fdc7489SMatthew Knepley ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr); 86482c71b3e2SJacob Faibussowitsch PetscCheckFalse(loc < 0,PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val); 86490fdc7489SMatthew Knepley uval += (loc+1) << ul->bits[m]; 86500fdc7489SMatthew Knepley ++m; 86510fdc7489SMatthew Knepley } 86520fdc7489SMatthew Knepley if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);} 86530fdc7489SMatthew Knepley } 86540fdc7489SMatthew Knepley ierr = PetscFree(active);CHKERRQ(ierr); 86550fdc7489SMatthew Knepley *universal = ul; 86560fdc7489SMatthew Knepley PetscFunctionReturn(0); 86570fdc7489SMatthew Knepley } 86580fdc7489SMatthew Knepley 86590fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal) 86600fdc7489SMatthew Knepley { 86610fdc7489SMatthew Knepley PetscInt l; 86620fdc7489SMatthew Knepley PetscErrorCode ierr; 86630fdc7489SMatthew Knepley 86640fdc7489SMatthew Knepley PetscFunctionBegin; 86650fdc7489SMatthew Knepley for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);} 86660fdc7489SMatthew Knepley ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr); 86670fdc7489SMatthew Knepley ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr); 86680fdc7489SMatthew Knepley ierr = PetscFree((*universal)->values);CHKERRQ(ierr); 86690fdc7489SMatthew Knepley ierr = PetscFree(*universal);CHKERRQ(ierr); 86700fdc7489SMatthew Knepley *universal = NULL; 86710fdc7489SMatthew Knepley PetscFunctionReturn(0); 86720fdc7489SMatthew Knepley } 86730fdc7489SMatthew Knepley 86740fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel) 86750fdc7489SMatthew Knepley { 86760fdc7489SMatthew Knepley PetscFunctionBegin; 86770fdc7489SMatthew Knepley PetscValidPointer(ulabel, 2); 86780fdc7489SMatthew Knepley *ulabel = ul->label; 86790fdc7489SMatthew Knepley PetscFunctionReturn(0); 86800fdc7489SMatthew Knepley } 86810fdc7489SMatthew Knepley 86820fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm) 86830fdc7489SMatthew Knepley { 86840fdc7489SMatthew Knepley PetscInt Nl = ul->Nl, l; 86850fdc7489SMatthew Knepley PetscErrorCode ierr; 86860fdc7489SMatthew Knepley 86870fdc7489SMatthew Knepley PetscFunctionBegin; 8688064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(dm, DM_CLASSID, 3); 86890fdc7489SMatthew Knepley for (l = 0; l < Nl; ++l) { 86900fdc7489SMatthew Knepley if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);} 86910fdc7489SMatthew Knepley else {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);} 86920fdc7489SMatthew Knepley } 86930fdc7489SMatthew Knepley if (preserveOrder) { 86940fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 86950fdc7489SMatthew Knepley const char *name; 86960fdc7489SMatthew Knepley PetscBool match; 86970fdc7489SMatthew Knepley 86980fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr); 86990fdc7489SMatthew Knepley ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr); 87002c71b3e2SJacob Faibussowitsch PetscCheckFalse(!match,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]); 87010fdc7489SMatthew Knepley } 87020fdc7489SMatthew Knepley } 87030fdc7489SMatthew Knepley PetscFunctionReturn(0); 87040fdc7489SMatthew Knepley } 87050fdc7489SMatthew Knepley 87060fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value) 87070fdc7489SMatthew Knepley { 87080fdc7489SMatthew Knepley PetscInt l; 87090fdc7489SMatthew Knepley PetscErrorCode ierr; 87100fdc7489SMatthew Knepley 87110fdc7489SMatthew Knepley PetscFunctionBegin; 87120fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 87130fdc7489SMatthew Knepley DMLabel label; 87140fdc7489SMatthew Knepley PetscInt lval = (value & ul->masks[l]) >> ul->bits[l]; 87150fdc7489SMatthew Knepley 87160fdc7489SMatthew Knepley if (lval) { 87170fdc7489SMatthew Knepley if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);} 87180fdc7489SMatthew Knepley else {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);} 87190fdc7489SMatthew Knepley ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr); 87200fdc7489SMatthew Knepley } 87210fdc7489SMatthew Knepley } 87220fdc7489SMatthew Knepley PetscFunctionReturn(0); 87230fdc7489SMatthew Knepley } 8724a8fb8f29SToby Isaac 8725a8fb8f29SToby Isaac /*@ 8726a8fb8f29SToby Isaac DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement 8727a8fb8f29SToby Isaac 8728a8fb8f29SToby Isaac Input Parameter: 8729a8fb8f29SToby Isaac . dm - The DM object 8730a8fb8f29SToby Isaac 8731a8fb8f29SToby Isaac Output Parameter: 8732a8fb8f29SToby Isaac . cdm - The coarse DM 8733a8fb8f29SToby Isaac 8734a8fb8f29SToby Isaac Level: intermediate 8735a8fb8f29SToby Isaac 8736a8fb8f29SToby Isaac .seealso: DMSetCoarseDM() 8737a8fb8f29SToby Isaac @*/ 8738a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm) 8739a8fb8f29SToby Isaac { 8740a8fb8f29SToby Isaac PetscFunctionBegin; 8741a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8742a8fb8f29SToby Isaac PetscValidPointer(cdm, 2); 8743a8fb8f29SToby Isaac *cdm = dm->coarseMesh; 8744a8fb8f29SToby Isaac PetscFunctionReturn(0); 8745a8fb8f29SToby Isaac } 8746a8fb8f29SToby Isaac 8747a8fb8f29SToby Isaac /*@ 8748a8fb8f29SToby Isaac DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement 8749a8fb8f29SToby Isaac 8750a8fb8f29SToby Isaac Input Parameters: 8751a8fb8f29SToby Isaac + dm - The DM object 8752a8fb8f29SToby Isaac - cdm - The coarse DM 8753a8fb8f29SToby Isaac 8754a8fb8f29SToby Isaac Level: intermediate 8755a8fb8f29SToby Isaac 8756a8fb8f29SToby Isaac .seealso: DMGetCoarseDM() 8757a8fb8f29SToby Isaac @*/ 8758a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm) 8759a8fb8f29SToby Isaac { 8760a8fb8f29SToby Isaac PetscErrorCode ierr; 8761a8fb8f29SToby Isaac 8762a8fb8f29SToby Isaac PetscFunctionBegin; 8763a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8764a8fb8f29SToby Isaac if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2); 8765a8fb8f29SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 8766a8fb8f29SToby Isaac ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr); 8767a8fb8f29SToby Isaac dm->coarseMesh = cdm; 8768a8fb8f29SToby Isaac PetscFunctionReturn(0); 8769a8fb8f29SToby Isaac } 8770a8fb8f29SToby Isaac 877188bdff64SToby Isaac /*@ 877288bdff64SToby Isaac DMGetFineDM - Get the fine mesh from which this was obtained by refinement 877388bdff64SToby Isaac 877488bdff64SToby Isaac Input Parameter: 877588bdff64SToby Isaac . dm - The DM object 877688bdff64SToby Isaac 877788bdff64SToby Isaac Output Parameter: 877888bdff64SToby Isaac . fdm - The fine DM 877988bdff64SToby Isaac 878088bdff64SToby Isaac Level: intermediate 878188bdff64SToby Isaac 878288bdff64SToby Isaac .seealso: DMSetFineDM() 878388bdff64SToby Isaac @*/ 878488bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm) 878588bdff64SToby Isaac { 878688bdff64SToby Isaac PetscFunctionBegin; 878788bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 878888bdff64SToby Isaac PetscValidPointer(fdm, 2); 878988bdff64SToby Isaac *fdm = dm->fineMesh; 879088bdff64SToby Isaac PetscFunctionReturn(0); 879188bdff64SToby Isaac } 879288bdff64SToby Isaac 879388bdff64SToby Isaac /*@ 879488bdff64SToby Isaac DMSetFineDM - Set the fine mesh from which this was obtained by refinement 879588bdff64SToby Isaac 879688bdff64SToby Isaac Input Parameters: 879788bdff64SToby Isaac + dm - The DM object 879888bdff64SToby Isaac - fdm - The fine DM 879988bdff64SToby Isaac 880088bdff64SToby Isaac Level: intermediate 880188bdff64SToby Isaac 880288bdff64SToby Isaac .seealso: DMGetFineDM() 880388bdff64SToby Isaac @*/ 880488bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm) 880588bdff64SToby Isaac { 880688bdff64SToby Isaac PetscErrorCode ierr; 880788bdff64SToby Isaac 880888bdff64SToby Isaac PetscFunctionBegin; 880988bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 881088bdff64SToby Isaac if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2); 881188bdff64SToby Isaac ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr); 881288bdff64SToby Isaac ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr); 881388bdff64SToby Isaac dm->fineMesh = fdm; 881488bdff64SToby Isaac PetscFunctionReturn(0); 881588bdff64SToby Isaac } 881688bdff64SToby Isaac 8817a6ba4734SToby Isaac /*=== DMBoundary code ===*/ 8818a6ba4734SToby Isaac 8819a6ba4734SToby Isaac /*@C 8820a6ba4734SToby Isaac DMAddBoundary - Add a boundary condition to the model 8821a6ba4734SToby Isaac 8822783e2ec8SMatthew G. Knepley Collective on dm 8823783e2ec8SMatthew G. Knepley 8824a6ba4734SToby Isaac Input Parameters: 88254c258f51SMatthew G. Knepley + dm - The DM, with a PetscDS that matches the problem being constrained 8826f971fd6bSMatthew G. Knepley . type - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 8827a6ba4734SToby Isaac . name - The BC name 882845480ffeSMatthew G. Knepley . label - The label defining constrained points 882945480ffeSMatthew G. Knepley . Nv - The number of DMLabel values for constrained points 883045480ffeSMatthew G. Knepley . values - An array of values for constrained points 8831a6ba4734SToby Isaac . field - The field to constrain 883245480ffeSMatthew G. Knepley . Nc - The number of constrained field components (0 will constrain all fields) 8833a6ba4734SToby Isaac . comps - An array of constrained component numbers 8834a6ba4734SToby Isaac . bcFunc - A pointwise function giving boundary values 883556cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL 8836a6ba4734SToby Isaac - ctx - An optional user context for bcFunc 8837a6ba4734SToby Isaac 883845480ffeSMatthew G. Knepley Output Parameter: 883945480ffeSMatthew G. Knepley . bd - (Optional) Boundary number 884045480ffeSMatthew G. Knepley 8841a6ba4734SToby Isaac Options Database Keys: 8842a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 8843a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 8844a6ba4734SToby Isaac 884556cf3b9cSMatthew G. Knepley Note: 884656cf3b9cSMatthew 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: 884756cf3b9cSMatthew G. Knepley 884856cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[]) 884956cf3b9cSMatthew G. Knepley 885056cf3b9cSMatthew G. Knepley If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is: 885156cf3b9cSMatthew G. Knepley 885256cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux, 885356cf3b9cSMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 885456cf3b9cSMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 885556cf3b9cSMatthew G. Knepley $ PetscReal time, const PetscReal x[], PetscScalar bcval[]) 885656cf3b9cSMatthew G. Knepley 885756cf3b9cSMatthew G. Knepley + dim - the spatial dimension 885856cf3b9cSMatthew G. Knepley . Nf - the number of fields 885956cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 886056cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 886156cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point 886256cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 886356cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 886456cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 886556cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 886656cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point 886756cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 886856cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 886956cf3b9cSMatthew G. Knepley . t - current time 887056cf3b9cSMatthew G. Knepley . x - coordinates of the current point 887156cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters 887256cf3b9cSMatthew G. Knepley . constants - constant parameters 887356cf3b9cSMatthew G. Knepley - bcval - output values at the current point 887456cf3b9cSMatthew G. Knepley 8875a6ba4734SToby Isaac Level: developer 8876a6ba4734SToby Isaac 887745480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary() 8878a6ba4734SToby Isaac @*/ 887945480ffeSMatthew 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) 8880a6ba4734SToby Isaac { 8881e5e52638SMatthew G. Knepley PetscDS ds; 8882a6ba4734SToby Isaac PetscErrorCode ierr; 8883a6ba4734SToby Isaac 8884a6ba4734SToby Isaac PetscFunctionBegin; 8885a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8886783e2ec8SMatthew G. Knepley PetscValidLogicalCollectiveEnum(dm, type, 2); 888745480ffeSMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4); 888845480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nv, 5); 888945480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, field, 7); 889045480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nc, 8); 8891e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 889245480ffeSMatthew G. Knepley ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr); 889345480ffeSMatthew G. Knepley ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr); 8894a6ba4734SToby Isaac PetscFunctionReturn(0); 8895a6ba4734SToby Isaac } 8896a6ba4734SToby Isaac 889745480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */ 8898e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm) 8899e6f8dbb6SToby Isaac { 8900e5e52638SMatthew G. Knepley PetscDS ds; 8901dff059c6SToby Isaac DMBoundary *lastnext; 8902e6f8dbb6SToby Isaac DSBoundary dsbound; 8903e6f8dbb6SToby Isaac PetscErrorCode ierr; 8904e6f8dbb6SToby Isaac 8905e6f8dbb6SToby Isaac PetscFunctionBegin; 8906e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 8907e5e52638SMatthew G. Knepley dsbound = ds->boundary; 890847a1f5adSToby Isaac if (dm->boundary) { 890947a1f5adSToby Isaac DMBoundary next = dm->boundary; 891047a1f5adSToby Isaac 891147a1f5adSToby Isaac /* quick check to see if the PetscDS has changed */ 891247a1f5adSToby Isaac if (next->dsboundary == dsbound) PetscFunctionReturn(0); 891347a1f5adSToby Isaac /* the PetscDS has changed: tear down and rebuild */ 891447a1f5adSToby Isaac while (next) { 891547a1f5adSToby Isaac DMBoundary b = next; 891647a1f5adSToby Isaac 891747a1f5adSToby Isaac next = b->next; 891847a1f5adSToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 8919a6ba4734SToby Isaac } 892047a1f5adSToby Isaac dm->boundary = NULL; 8921a6ba4734SToby Isaac } 892247a1f5adSToby Isaac 8923dff059c6SToby Isaac lastnext = &(dm->boundary); 8924e6f8dbb6SToby Isaac while (dsbound) { 8925e6f8dbb6SToby Isaac DMBoundary dmbound; 8926e6f8dbb6SToby Isaac 8927e6f8dbb6SToby Isaac ierr = PetscNew(&dmbound);CHKERRQ(ierr); 8928e6f8dbb6SToby Isaac dmbound->dsboundary = dsbound; 892945480ffeSMatthew G. Knepley dmbound->label = dsbound->label; 893047a1f5adSToby Isaac /* push on the back instead of the front so that it is in the same order as in the PetscDS */ 8931dff059c6SToby Isaac *lastnext = dmbound; 8932dff059c6SToby Isaac lastnext = &(dmbound->next); 8933dff059c6SToby Isaac dsbound = dsbound->next; 8934a6ba4734SToby Isaac } 8935a6ba4734SToby Isaac PetscFunctionReturn(0); 8936a6ba4734SToby Isaac } 8937a6ba4734SToby Isaac 8938a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd) 8939a6ba4734SToby Isaac { 8940b95f2879SToby Isaac DMBoundary b; 8941a6ba4734SToby Isaac PetscErrorCode ierr; 8942a6ba4734SToby Isaac 8943a6ba4734SToby Isaac PetscFunctionBegin; 8944a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8945534a8f05SLisandro Dalcin PetscValidBoolPointer(isBd, 3); 8946a6ba4734SToby Isaac *isBd = PETSC_FALSE; 8947e6f8dbb6SToby Isaac ierr = DMPopulateBoundary(dm);CHKERRQ(ierr); 8948b95f2879SToby Isaac b = dm->boundary; 8949a6ba4734SToby Isaac while (b && !(*isBd)) { 8950e6f8dbb6SToby Isaac DMLabel label = b->label; 8951e6f8dbb6SToby Isaac DSBoundary dsb = b->dsboundary; 8952a6ba4734SToby Isaac PetscInt i; 8953a6ba4734SToby Isaac 895445480ffeSMatthew G. Knepley if (label) { 895545480ffeSMatthew G. Knepley for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);} 8956a6ba4734SToby Isaac } 8957a6ba4734SToby Isaac b = b->next; 8958a6ba4734SToby Isaac } 8959a6ba4734SToby Isaac PetscFunctionReturn(0); 8960a6ba4734SToby Isaac } 89614d6f44ffSToby Isaac 89624d6f44ffSToby Isaac /*@C 8963a6e0b375SMatthew G. Knepley DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector. 8964a6e0b375SMatthew G. Knepley 8965a6e0b375SMatthew G. Knepley Collective on DM 89664d6f44ffSToby Isaac 89674d6f44ffSToby Isaac Input Parameters: 89684d6f44ffSToby Isaac + dm - The DM 89690709b2feSToby Isaac . time - The time 89704d6f44ffSToby Isaac . funcs - The coordinate functions to evaluate, one per field 89714d6f44ffSToby Isaac . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 89724d6f44ffSToby Isaac - mode - The insertion mode for values 89734d6f44ffSToby Isaac 89744d6f44ffSToby Isaac Output Parameter: 89754d6f44ffSToby Isaac . X - vector 89764d6f44ffSToby Isaac 89774d6f44ffSToby Isaac Calling sequence of func: 897877b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 89794d6f44ffSToby Isaac 89804d6f44ffSToby Isaac + dim - The spatial dimension 89818ec8862eSJed Brown . time - The time at which to sample 89824d6f44ffSToby Isaac . x - The coordinates 898377b739a6SMatthew Knepley . Nc - The number of components 89844d6f44ffSToby Isaac . u - The output field values 89854d6f44ffSToby Isaac - ctx - optional user-defined function context 89864d6f44ffSToby Isaac 89874d6f44ffSToby Isaac Level: developer 89884d6f44ffSToby Isaac 8989a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff() 89904d6f44ffSToby Isaac @*/ 89910709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X) 89924d6f44ffSToby Isaac { 89934d6f44ffSToby Isaac Vec localX; 89944d6f44ffSToby Isaac PetscErrorCode ierr; 89954d6f44ffSToby Isaac 89964d6f44ffSToby Isaac PetscFunctionBegin; 89974d6f44ffSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 89984d6f44ffSToby Isaac ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 89990709b2feSToby Isaac ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 90004d6f44ffSToby Isaac ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 90014d6f44ffSToby Isaac ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 90024d6f44ffSToby Isaac ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 90034d6f44ffSToby Isaac PetscFunctionReturn(0); 90044d6f44ffSToby Isaac } 90054d6f44ffSToby Isaac 9006a6e0b375SMatthew G. Knepley /*@C 9007a6e0b375SMatthew G. Knepley DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector. 9008a6e0b375SMatthew G. Knepley 9009a6e0b375SMatthew G. Knepley Not collective 9010a6e0b375SMatthew G. Knepley 9011a6e0b375SMatthew G. Knepley Input Parameters: 9012a6e0b375SMatthew G. Knepley + dm - The DM 9013a6e0b375SMatthew G. Knepley . time - The time 9014a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 9015a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 9016a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9017a6e0b375SMatthew G. Knepley 9018a6e0b375SMatthew G. Knepley Output Parameter: 9019a6e0b375SMatthew G. Knepley . localX - vector 9020a6e0b375SMatthew G. Knepley 9021a6e0b375SMatthew G. Knepley Calling sequence of func: 902277b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 9023a6e0b375SMatthew G. Knepley 9024a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9025a6e0b375SMatthew G. Knepley . x - The coordinates 902677b739a6SMatthew Knepley . Nc - The number of components 9027a6e0b375SMatthew G. Knepley . u - The output field values 9028a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 9029a6e0b375SMatthew G. Knepley 9030a6e0b375SMatthew G. Knepley Level: developer 9031a6e0b375SMatthew G. Knepley 9032a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff() 9033a6e0b375SMatthew G. Knepley @*/ 90340709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 90354d6f44ffSToby Isaac { 90364d6f44ffSToby Isaac PetscErrorCode ierr; 90374d6f44ffSToby Isaac 90384d6f44ffSToby Isaac PetscFunctionBegin; 90394d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9040064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 90412c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectfunctionlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name); 90420709b2feSToby Isaac ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 90434d6f44ffSToby Isaac PetscFunctionReturn(0); 90444d6f44ffSToby Isaac } 90454d6f44ffSToby Isaac 9046a6e0b375SMatthew G. Knepley /*@C 9047a6e0b375SMatthew 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. 9048a6e0b375SMatthew G. Knepley 9049a6e0b375SMatthew G. Knepley Collective on DM 9050a6e0b375SMatthew G. Knepley 9051a6e0b375SMatthew G. Knepley Input Parameters: 9052a6e0b375SMatthew G. Knepley + dm - The DM 9053a6e0b375SMatthew G. Knepley . time - The time 9054a6e0b375SMatthew G. Knepley . label - The DMLabel selecting the portion of the mesh for projection 9055a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 9056a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 9057a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9058a6e0b375SMatthew G. Knepley 9059a6e0b375SMatthew G. Knepley Output Parameter: 9060a6e0b375SMatthew G. Knepley . X - vector 9061a6e0b375SMatthew G. Knepley 9062a6e0b375SMatthew G. Knepley Calling sequence of func: 906377b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 9064a6e0b375SMatthew G. Knepley 9065a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9066a6e0b375SMatthew G. Knepley . x - The coordinates 906777b739a6SMatthew Knepley . Nc - The number of components 9068a6e0b375SMatthew G. Knepley . u - The output field values 9069a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 9070a6e0b375SMatthew G. Knepley 9071a6e0b375SMatthew G. Knepley Level: developer 9072a6e0b375SMatthew G. Knepley 9073a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff() 9074a6e0b375SMatthew G. Knepley @*/ 90752c53366bSMatthew 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) 90762c53366bSMatthew G. Knepley { 90772c53366bSMatthew G. Knepley Vec localX; 90782c53366bSMatthew G. Knepley PetscErrorCode ierr; 90792c53366bSMatthew G. Knepley 90802c53366bSMatthew G. Knepley PetscFunctionBegin; 90812c53366bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 90822c53366bSMatthew G. Knepley ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 90832c53366bSMatthew G. Knepley ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 90842c53366bSMatthew G. Knepley ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 90852c53366bSMatthew G. Knepley ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 90862c53366bSMatthew G. Knepley ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 90872c53366bSMatthew G. Knepley PetscFunctionReturn(0); 90882c53366bSMatthew G. Knepley } 90892c53366bSMatthew G. Knepley 9090a6e0b375SMatthew G. Knepley /*@C 9091a6e0b375SMatthew 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. 9092a6e0b375SMatthew G. Knepley 9093a6e0b375SMatthew G. Knepley Not collective 9094a6e0b375SMatthew G. Knepley 9095a6e0b375SMatthew G. Knepley Input Parameters: 9096a6e0b375SMatthew G. Knepley + dm - The DM 9097a6e0b375SMatthew G. Knepley . time - The time 9098a6e0b375SMatthew G. Knepley . label - The DMLabel selecting the portion of the mesh for projection 9099a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 9100a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 9101a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9102a6e0b375SMatthew G. Knepley 9103a6e0b375SMatthew G. Knepley Output Parameter: 9104a6e0b375SMatthew G. Knepley . localX - vector 9105a6e0b375SMatthew G. Knepley 9106a6e0b375SMatthew G. Knepley Calling sequence of func: 910777b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 9108a6e0b375SMatthew G. Knepley 9109a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9110a6e0b375SMatthew G. Knepley . x - The coordinates 911177b739a6SMatthew Knepley . Nc - The number of components 9112a6e0b375SMatthew G. Knepley . u - The output field values 9113a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 9114a6e0b375SMatthew G. Knepley 9115a6e0b375SMatthew G. Knepley Level: developer 9116a6e0b375SMatthew G. Knepley 9117a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff() 9118a6e0b375SMatthew G. Knepley @*/ 91191c531cf8SMatthew 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) 91204d6f44ffSToby Isaac { 91214d6f44ffSToby Isaac PetscErrorCode ierr; 91224d6f44ffSToby Isaac 91234d6f44ffSToby Isaac PetscFunctionBegin; 91244d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9125064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 91262c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectfunctionlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name); 91271c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 91284d6f44ffSToby Isaac PetscFunctionReturn(0); 91294d6f44ffSToby Isaac } 91302716604bSToby Isaac 9131a6e0b375SMatthew G. Knepley /*@C 9132a6e0b375SMatthew G. Knepley DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector. 9133a6e0b375SMatthew G. Knepley 9134a6e0b375SMatthew G. Knepley Not collective 9135a6e0b375SMatthew G. Knepley 9136a6e0b375SMatthew G. Knepley Input Parameters: 9137a6e0b375SMatthew G. Knepley + dm - The DM 9138a6e0b375SMatthew G. Knepley . time - The time 9139a6e0b375SMatthew G. Knepley . localU - The input field vector 9140a6e0b375SMatthew G. Knepley . funcs - The functions to evaluate, one per field 9141a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9142a6e0b375SMatthew G. Knepley 9143a6e0b375SMatthew G. Knepley Output Parameter: 9144a6e0b375SMatthew G. Knepley . localX - The output vector 9145a6e0b375SMatthew G. Knepley 9146a6e0b375SMatthew G. Knepley Calling sequence of func: 9147a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9148a6e0b375SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9149a6e0b375SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9150a6e0b375SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9151a6e0b375SMatthew G. Knepley 9152a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9153a6e0b375SMatthew G. Knepley . Nf - The number of input fields 9154a6e0b375SMatthew G. Knepley . NfAux - The number of input auxiliary fields 9155a6e0b375SMatthew G. Knepley . uOff - The offset of each field in u[] 9156a6e0b375SMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9157a6e0b375SMatthew G. Knepley . u - The field values at this point in space 9158a6e0b375SMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9159a6e0b375SMatthew G. Knepley . u_x - The field derivatives at this point in space 9160a6e0b375SMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9161a6e0b375SMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9162a6e0b375SMatthew G. Knepley . a - The auxiliary field values at this point in space 9163a6e0b375SMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9164a6e0b375SMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9165a6e0b375SMatthew G. Knepley . t - The current time 9166a6e0b375SMatthew G. Knepley . x - The coordinates of this point 9167a6e0b375SMatthew G. Knepley . numConstants - The number of constants 9168a6e0b375SMatthew G. Knepley . constants - The value of each constant 9169a6e0b375SMatthew G. Knepley - f - The value of the function at this point in space 9170a6e0b375SMatthew G. Knepley 9171a6e0b375SMatthew 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. 9172a6e0b375SMatthew 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 9173a6e0b375SMatthew 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 9174a6e0b375SMatthew 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. 9175a6e0b375SMatthew G. Knepley 9176a6e0b375SMatthew G. Knepley Level: intermediate 9177a6e0b375SMatthew G. Knepley 9178a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9179a6e0b375SMatthew G. Knepley @*/ 91808c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU, 91818c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 91828c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 91838c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9184191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 91858c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 91868c6c5593SMatthew G. Knepley { 91878c6c5593SMatthew G. Knepley PetscErrorCode ierr; 91888c6c5593SMatthew G. Knepley 91898c6c5593SMatthew G. Knepley PetscFunctionBegin; 91908c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 91918c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localU,VEC_CLASSID,3); 91928c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 91932c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectfieldlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name); 91948c6c5593SMatthew G. Knepley ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr); 91958c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 91968c6c5593SMatthew G. Knepley } 91978c6c5593SMatthew G. Knepley 9198a6e0b375SMatthew G. Knepley /*@C 9199a6e0b375SMatthew 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. 9200a6e0b375SMatthew G. Knepley 9201a6e0b375SMatthew G. Knepley Not collective 9202a6e0b375SMatthew G. Knepley 9203a6e0b375SMatthew G. Knepley Input Parameters: 9204a6e0b375SMatthew G. Knepley + dm - The DM 9205a6e0b375SMatthew G. Knepley . time - The time 9206a6e0b375SMatthew G. Knepley . label - The DMLabel marking the portion of the domain to output 9207a6e0b375SMatthew G. Knepley . numIds - The number of label ids to use 9208a6e0b375SMatthew G. Knepley . ids - The label ids to use for marking 9209a6e0b375SMatthew G. Knepley . Nc - The number of components to set in the output, or PETSC_DETERMINE for all components 9210a6e0b375SMatthew G. Knepley . comps - The components to set in the output, or NULL for all components 9211a6e0b375SMatthew G. Knepley . localU - The input field vector 9212a6e0b375SMatthew G. Knepley . funcs - The functions to evaluate, one per field 9213a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9214a6e0b375SMatthew G. Knepley 9215a6e0b375SMatthew G. Knepley Output Parameter: 9216a6e0b375SMatthew G. Knepley . localX - The output vector 9217a6e0b375SMatthew G. Knepley 9218a6e0b375SMatthew G. Knepley Calling sequence of func: 9219a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9220a6e0b375SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9221a6e0b375SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9222a6e0b375SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9223a6e0b375SMatthew G. Knepley 9224a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9225a6e0b375SMatthew G. Knepley . Nf - The number of input fields 9226a6e0b375SMatthew G. Knepley . NfAux - The number of input auxiliary fields 9227a6e0b375SMatthew G. Knepley . uOff - The offset of each field in u[] 9228a6e0b375SMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9229a6e0b375SMatthew G. Knepley . u - The field values at this point in space 9230a6e0b375SMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9231a6e0b375SMatthew G. Knepley . u_x - The field derivatives at this point in space 9232a6e0b375SMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9233a6e0b375SMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9234a6e0b375SMatthew G. Knepley . a - The auxiliary field values at this point in space 9235a6e0b375SMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9236a6e0b375SMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9237a6e0b375SMatthew G. Knepley . t - The current time 9238a6e0b375SMatthew G. Knepley . x - The coordinates of this point 9239a6e0b375SMatthew G. Knepley . numConstants - The number of constants 9240a6e0b375SMatthew G. Knepley . constants - The value of each constant 9241a6e0b375SMatthew G. Knepley - f - The value of the function at this point in space 9242a6e0b375SMatthew G. Knepley 9243a6e0b375SMatthew 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. 9244a6e0b375SMatthew 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 9245a6e0b375SMatthew 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 9246a6e0b375SMatthew 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. 9247a6e0b375SMatthew G. Knepley 9248a6e0b375SMatthew G. Knepley Level: intermediate 9249a6e0b375SMatthew G. Knepley 9250a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9251a6e0b375SMatthew G. Knepley @*/ 92521c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 92538c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 92548c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 92558c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9256191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 92578c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 92588c6c5593SMatthew G. Knepley { 92598c6c5593SMatthew G. Knepley PetscErrorCode ierr; 92608c6c5593SMatthew G. Knepley 92618c6c5593SMatthew G. Knepley PetscFunctionBegin; 92628c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9263064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localU,VEC_CLASSID,8); 9264064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 92652c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name); 92661c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 92678c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 92688c6c5593SMatthew G. Knepley } 92698c6c5593SMatthew G. Knepley 92702716604bSToby Isaac /*@C 9271ece3a9fcSMatthew 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. 9272ece3a9fcSMatthew G. Knepley 9273ece3a9fcSMatthew G. Knepley Not collective 9274ece3a9fcSMatthew G. Knepley 9275ece3a9fcSMatthew G. Knepley Input Parameters: 9276ece3a9fcSMatthew G. Knepley + dm - The DM 9277ece3a9fcSMatthew G. Knepley . time - The time 9278ece3a9fcSMatthew G. Knepley . label - The DMLabel marking the portion of the domain boundary to output 9279ece3a9fcSMatthew G. Knepley . numIds - The number of label ids to use 9280ece3a9fcSMatthew G. Knepley . ids - The label ids to use for marking 9281ece3a9fcSMatthew G. Knepley . Nc - The number of components to set in the output, or PETSC_DETERMINE for all components 9282ece3a9fcSMatthew G. Knepley . comps - The components to set in the output, or NULL for all components 9283ece3a9fcSMatthew G. Knepley . localU - The input field vector 9284ece3a9fcSMatthew G. Knepley . funcs - The functions to evaluate, one per field 9285ece3a9fcSMatthew G. Knepley - mode - The insertion mode for values 9286ece3a9fcSMatthew G. Knepley 9287ece3a9fcSMatthew G. Knepley Output Parameter: 9288ece3a9fcSMatthew G. Knepley . localX - The output vector 9289ece3a9fcSMatthew G. Knepley 9290ece3a9fcSMatthew G. Knepley Calling sequence of func: 9291ece3a9fcSMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9292ece3a9fcSMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9293ece3a9fcSMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9294ece3a9fcSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9295ece3a9fcSMatthew G. Knepley 9296ece3a9fcSMatthew G. Knepley + dim - The spatial dimension 9297ece3a9fcSMatthew G. Knepley . Nf - The number of input fields 9298ece3a9fcSMatthew G. Knepley . NfAux - The number of input auxiliary fields 9299ece3a9fcSMatthew G. Knepley . uOff - The offset of each field in u[] 9300ece3a9fcSMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9301ece3a9fcSMatthew G. Knepley . u - The field values at this point in space 9302ece3a9fcSMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9303ece3a9fcSMatthew G. Knepley . u_x - The field derivatives at this point in space 9304ece3a9fcSMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9305ece3a9fcSMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9306ece3a9fcSMatthew G. Knepley . a - The auxiliary field values at this point in space 9307ece3a9fcSMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9308ece3a9fcSMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9309ece3a9fcSMatthew G. Knepley . t - The current time 9310ece3a9fcSMatthew G. Knepley . x - The coordinates of this point 9311ece3a9fcSMatthew G. Knepley . n - The face normal 9312ece3a9fcSMatthew G. Knepley . numConstants - The number of constants 9313ece3a9fcSMatthew G. Knepley . constants - The value of each constant 9314ece3a9fcSMatthew G. Knepley - f - The value of the function at this point in space 9315ece3a9fcSMatthew G. Knepley 9316ece3a9fcSMatthew G. Knepley Note: 9317ece3a9fcSMatthew 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. 9318ece3a9fcSMatthew 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 9319ece3a9fcSMatthew 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 9320ece3a9fcSMatthew 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. 9321ece3a9fcSMatthew G. Knepley 9322ece3a9fcSMatthew G. Knepley Level: intermediate 9323ece3a9fcSMatthew G. Knepley 9324ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9325ece3a9fcSMatthew G. Knepley @*/ 9326ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 9327ece3a9fcSMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 9328ece3a9fcSMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9329ece3a9fcSMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9330ece3a9fcSMatthew G. Knepley PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 9331ece3a9fcSMatthew G. Knepley InsertMode mode, Vec localX) 9332ece3a9fcSMatthew G. Knepley { 9333ece3a9fcSMatthew G. Knepley PetscErrorCode ierr; 9334ece3a9fcSMatthew G. Knepley 9335ece3a9fcSMatthew G. Knepley PetscFunctionBegin; 9336ece3a9fcSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9337064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localU,VEC_CLASSID,8); 9338064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 93392c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectbdfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name); 9340ece3a9fcSMatthew G. Knepley ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 9341ece3a9fcSMatthew G. Knepley PetscFunctionReturn(0); 9342ece3a9fcSMatthew G. Knepley } 9343ece3a9fcSMatthew G. Knepley 9344ece3a9fcSMatthew G. Knepley /*@C 93452716604bSToby Isaac DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h. 93462716604bSToby Isaac 93472716604bSToby Isaac Input Parameters: 93482716604bSToby Isaac + dm - The DM 93490709b2feSToby Isaac . time - The time 93502716604bSToby Isaac . funcs - The functions to evaluate for each field component 93512716604bSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9352574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 93532716604bSToby Isaac 93542716604bSToby Isaac Output Parameter: 93552716604bSToby Isaac . diff - The diff ||u - u_h||_2 93562716604bSToby Isaac 93572716604bSToby Isaac Level: developer 93582716604bSToby Isaac 93591189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 93602716604bSToby Isaac @*/ 93610709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff) 93622716604bSToby Isaac { 93632716604bSToby Isaac PetscErrorCode ierr; 93642716604bSToby Isaac 93652716604bSToby Isaac PetscFunctionBegin; 93662716604bSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9367b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 93682c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->computel2diff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name); 93690709b2feSToby Isaac ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 93702716604bSToby Isaac PetscFunctionReturn(0); 93712716604bSToby Isaac } 9372b698f381SToby Isaac 9373b698f381SToby Isaac /*@C 9374b698f381SToby Isaac DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h. 9375b698f381SToby Isaac 9376d083f849SBarry Smith Collective on dm 9377d083f849SBarry Smith 9378b698f381SToby Isaac Input Parameters: 9379b698f381SToby Isaac + dm - The DM 9380b698f381SToby Isaac , time - The time 9381b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component 9382b698f381SToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9383574a98acSMatthew G. Knepley . X - The coefficient vector u_h, a global vector 9384b698f381SToby Isaac - n - The vector to project along 9385b698f381SToby Isaac 9386b698f381SToby Isaac Output Parameter: 9387b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2 9388b698f381SToby Isaac 9389b698f381SToby Isaac Level: developer 9390b698f381SToby Isaac 9391b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff() 9392b698f381SToby Isaac @*/ 9393b698f381SToby 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) 9394b698f381SToby Isaac { 9395b698f381SToby Isaac PetscErrorCode ierr; 9396b698f381SToby Isaac 9397b698f381SToby Isaac PetscFunctionBegin; 9398b698f381SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9399b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 94002c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->computel2gradientdiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name); 9401b698f381SToby Isaac ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr); 9402b698f381SToby Isaac PetscFunctionReturn(0); 9403b698f381SToby Isaac } 9404b698f381SToby Isaac 94052a16baeaSToby Isaac /*@C 94062a16baeaSToby Isaac DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components. 94072a16baeaSToby Isaac 9408d083f849SBarry Smith Collective on dm 9409d083f849SBarry Smith 94102a16baeaSToby Isaac Input Parameters: 94112a16baeaSToby Isaac + dm - The DM 94122a16baeaSToby Isaac . time - The time 94132a16baeaSToby Isaac . funcs - The functions to evaluate for each field component 94142a16baeaSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9415574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 94162a16baeaSToby Isaac 94172a16baeaSToby Isaac Output Parameter: 94182a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2 94192a16baeaSToby Isaac 94202a16baeaSToby Isaac Level: developer 94212a16baeaSToby Isaac 94221189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 94232a16baeaSToby Isaac @*/ 94241189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[]) 94252a16baeaSToby Isaac { 94262a16baeaSToby Isaac PetscErrorCode ierr; 94272a16baeaSToby Isaac 94282a16baeaSToby Isaac PetscFunctionBegin; 94292a16baeaSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 94302a16baeaSToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 94312c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->computel2fielddiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name); 94322a16baeaSToby Isaac ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 94332a16baeaSToby Isaac PetscFunctionReturn(0); 94342a16baeaSToby Isaac } 94352a16baeaSToby Isaac 9436df0b854cSToby Isaac /*@C 9437502a2867SDave May DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors 9438502a2867SDave May 9439502a2867SDave May Not Collective 9440502a2867SDave May 9441502a2867SDave May Input Parameter: 9442502a2867SDave May . dm - The DM 9443502a2867SDave May 94440a19bb7dSprj- Output Parameters: 94450a19bb7dSprj- + nranks - the number of neighbours 94460a19bb7dSprj- - ranks - the neighbors ranks 9447502a2867SDave May 9448502a2867SDave May Notes: 9449502a2867SDave May Do not free the array, it is freed when the DM is destroyed. 9450502a2867SDave May 9451502a2867SDave May Level: beginner 9452502a2867SDave May 9453dec1416fSJunchao Zhang .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks() 9454502a2867SDave May @*/ 9455502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[]) 9456502a2867SDave May { 9457502a2867SDave May PetscErrorCode ierr; 9458502a2867SDave May 9459502a2867SDave May PetscFunctionBegin; 9460502a2867SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 94612c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->getneighbors,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name); 9462502a2867SDave May ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr); 9463502a2867SDave May PetscFunctionReturn(0); 9464502a2867SDave May } 9465502a2867SDave May 9466531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */ 9467531c7667SBarry Smith 9468531c7667SBarry Smith /* 9469531c7667SBarry Smith Converts the input vector to a ghosted vector and then calls the standard coloring code. 9470531c7667SBarry Smith This has be a different function because it requires DM which is not defined in the Mat library 9471531c7667SBarry Smith */ 9472531c7667SBarry Smith PetscErrorCode MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx) 9473531c7667SBarry Smith { 9474531c7667SBarry Smith PetscErrorCode ierr; 9475531c7667SBarry Smith 9476531c7667SBarry Smith PetscFunctionBegin; 9477531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 9478531c7667SBarry Smith Vec x1local; 9479531c7667SBarry Smith DM dm; 9480531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 94812c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm,PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM"); 9482531c7667SBarry Smith ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr); 9483531c7667SBarry Smith ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 9484531c7667SBarry Smith ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 9485531c7667SBarry Smith x1 = x1local; 9486531c7667SBarry Smith } 9487531c7667SBarry Smith ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr); 9488531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 9489531c7667SBarry Smith DM dm; 9490531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 9491531c7667SBarry Smith ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr); 9492531c7667SBarry Smith } 9493531c7667SBarry Smith PetscFunctionReturn(0); 9494531c7667SBarry Smith } 9495531c7667SBarry Smith 9496531c7667SBarry Smith /*@ 9497531c7667SBarry Smith MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring 9498531c7667SBarry Smith 9499531c7667SBarry Smith Input Parameter: 9500531c7667SBarry Smith . coloring - the MatFDColoring object 9501531c7667SBarry Smith 950295452b02SPatrick Sanan Developer Notes: 950395452b02SPatrick Sanan this routine exists because the PETSc Mat library does not know about the DM objects 9504531c7667SBarry Smith 95051b266c99SBarry Smith Level: advanced 95061b266c99SBarry Smith 9507531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType 9508531c7667SBarry Smith @*/ 9509531c7667SBarry Smith PetscErrorCode MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring) 9510531c7667SBarry Smith { 9511531c7667SBarry Smith PetscFunctionBegin; 9512531c7667SBarry Smith coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM; 9513531c7667SBarry Smith PetscFunctionReturn(0); 9514531c7667SBarry Smith } 95158320bc6fSPatrick Sanan 95168320bc6fSPatrick Sanan /*@ 95178320bc6fSPatrick Sanan DMGetCompatibility - determine if two DMs are compatible 95188320bc6fSPatrick Sanan 95198320bc6fSPatrick Sanan Collective 95208320bc6fSPatrick Sanan 95218320bc6fSPatrick Sanan Input Parameters: 9522a5bc1bf3SBarry Smith + dm1 - the first DM 95238320bc6fSPatrick Sanan - dm2 - the second DM 95248320bc6fSPatrick Sanan 95258320bc6fSPatrick Sanan Output Parameters: 95268320bc6fSPatrick Sanan + compatible - whether or not the two DMs are compatible 95278320bc6fSPatrick Sanan - set - whether or not the compatible value was set 95288320bc6fSPatrick Sanan 95298320bc6fSPatrick Sanan Notes: 95308320bc6fSPatrick Sanan Two DMs are deemed compatible if they represent the same parallel decomposition 95313d862458SPatrick Sanan of the same topology. This implies that the section (field data) on one 95328320bc6fSPatrick Sanan "makes sense" with respect to the topology and parallel decomposition of the other. 95333d862458SPatrick Sanan Loosely speaking, compatible DMs represent the same domain and parallel 95343d862458SPatrick Sanan decomposition, but hold different data. 95358320bc6fSPatrick Sanan 95368320bc6fSPatrick Sanan Typically, one would confirm compatibility if intending to simultaneously iterate 95378320bc6fSPatrick Sanan over a pair of vectors obtained from different DMs. 95388320bc6fSPatrick Sanan 95398320bc6fSPatrick Sanan For example, two DMDA objects are compatible if they have the same local 95408320bc6fSPatrick Sanan and global sizes and the same stencil width. They can have different numbers 95418320bc6fSPatrick Sanan of degrees of freedom per node. Thus, one could use the node numbering from 95428320bc6fSPatrick Sanan either DM in bounds for a loop over vectors derived from either DM. 95438320bc6fSPatrick Sanan 95448320bc6fSPatrick Sanan Consider the operation of summing data living on a 2-dof DMDA to data living 95458320bc6fSPatrick Sanan on a 1-dof DMDA, which should be compatible, as in the following snippet. 95468320bc6fSPatrick Sanan .vb 95478320bc6fSPatrick Sanan ... 95488320bc6fSPatrick Sanan ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr); 95498320bc6fSPatrick Sanan if (set && compatible) { 95508320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 95518320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 95523d862458SPatrick Sanan ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr); 95538320bc6fSPatrick Sanan for (j=y; j<y+n; ++j) { 95548320bc6fSPatrick Sanan for (i=x; i<x+m, ++i) { 95558320bc6fSPatrick Sanan arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1]; 95568320bc6fSPatrick Sanan } 95578320bc6fSPatrick Sanan } 95588320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 95598320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 95608320bc6fSPatrick Sanan } else { 95618320bc6fSPatrick Sanan SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible"); 95628320bc6fSPatrick Sanan } 95638320bc6fSPatrick Sanan ... 95648320bc6fSPatrick Sanan .ve 95658320bc6fSPatrick Sanan 95668320bc6fSPatrick Sanan Checking compatibility might be expensive for a given implementation of DM, 95678320bc6fSPatrick Sanan or might be impossible to unambiguously confirm or deny. For this reason, 95688320bc6fSPatrick Sanan this function may decline to determine compatibility, and hence users should 95698320bc6fSPatrick Sanan always check the "set" output parameter. 95708320bc6fSPatrick Sanan 95718320bc6fSPatrick Sanan A DM is always compatible with itself. 95728320bc6fSPatrick Sanan 95738320bc6fSPatrick Sanan In the current implementation, DMs which live on "unequal" communicators 95748320bc6fSPatrick Sanan (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed 95758320bc6fSPatrick Sanan incompatible. 95768320bc6fSPatrick Sanan 95778320bc6fSPatrick Sanan This function is labeled "Collective," as information about all subdomains 95788320bc6fSPatrick Sanan is required on each rank. However, in DM implementations which store all this 95798320bc6fSPatrick Sanan information locally, this function may be merely "Logically Collective". 95808320bc6fSPatrick Sanan 95818320bc6fSPatrick Sanan Developer Notes: 95823d862458SPatrick Sanan Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B 95833d862458SPatrick Sanan iff B is compatible with A. Thus, this function checks the implementations 9584a5bc1bf3SBarry Smith of both dm and dmc (if they are of different types), attempting to determine 95858320bc6fSPatrick Sanan compatibility. It is left to DM implementers to ensure that symmetry is 95868320bc6fSPatrick Sanan preserved. The simplest way to do this is, when implementing type-specific 95873d862458SPatrick Sanan logic for this function, is to check for existing logic in the implementation 95883d862458SPatrick Sanan of other DM types and let *set = PETSC_FALSE if found. 95898320bc6fSPatrick Sanan 95908320bc6fSPatrick Sanan Level: advanced 95918320bc6fSPatrick Sanan 95923d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag() 95938320bc6fSPatrick Sanan @*/ 95948320bc6fSPatrick Sanan 9595a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set) 95968320bc6fSPatrick Sanan { 95978320bc6fSPatrick Sanan PetscErrorCode ierr; 95988320bc6fSPatrick Sanan PetscMPIInt compareResult; 95998320bc6fSPatrick Sanan DMType type,type2; 96008320bc6fSPatrick Sanan PetscBool sameType; 96018320bc6fSPatrick Sanan 96028320bc6fSPatrick Sanan PetscFunctionBegin; 9603a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 96048320bc6fSPatrick Sanan PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 96058320bc6fSPatrick Sanan 96068320bc6fSPatrick Sanan /* Declare a DM compatible with itself */ 9607a5bc1bf3SBarry Smith if (dm1 == dm2) { 96088320bc6fSPatrick Sanan *set = PETSC_TRUE; 96098320bc6fSPatrick Sanan *compatible = PETSC_TRUE; 96108320bc6fSPatrick Sanan PetscFunctionReturn(0); 96118320bc6fSPatrick Sanan } 96128320bc6fSPatrick Sanan 96138320bc6fSPatrick Sanan /* Declare a DM incompatible with a DM that lives on an "unequal" 96148320bc6fSPatrick Sanan communicator. Note that this does not preclude compatibility with 96158320bc6fSPatrick Sanan DMs living on "congruent" or "similar" communicators, but this must be 96168320bc6fSPatrick Sanan determined by the implementation-specific logic */ 9617ffc4695bSBarry Smith ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr); 96188320bc6fSPatrick Sanan if (compareResult == MPI_UNEQUAL) { 96198320bc6fSPatrick Sanan *set = PETSC_TRUE; 96208320bc6fSPatrick Sanan *compatible = PETSC_FALSE; 96218320bc6fSPatrick Sanan PetscFunctionReturn(0); 96228320bc6fSPatrick Sanan } 96238320bc6fSPatrick Sanan 96248320bc6fSPatrick Sanan /* Pass to the implementation-specific routine, if one exists. */ 9625a5bc1bf3SBarry Smith if (dm1->ops->getcompatibility) { 9626a5bc1bf3SBarry Smith ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr); 9627b9d85ea2SLisandro Dalcin if (*set) PetscFunctionReturn(0); 96288320bc6fSPatrick Sanan } 96298320bc6fSPatrick Sanan 9630a5bc1bf3SBarry Smith /* If dm1 and dm2 are of different types, then attempt to check compatibility 96318320bc6fSPatrick Sanan with an implementation of this function from dm2 */ 9632a5bc1bf3SBarry Smith ierr = DMGetType(dm1,&type);CHKERRQ(ierr); 96338320bc6fSPatrick Sanan ierr = DMGetType(dm2,&type2);CHKERRQ(ierr); 96348320bc6fSPatrick Sanan ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr); 96358320bc6fSPatrick Sanan if (!sameType && dm2->ops->getcompatibility) { 9636a5bc1bf3SBarry Smith ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */ 96378320bc6fSPatrick Sanan } else { 96388320bc6fSPatrick Sanan *set = PETSC_FALSE; 96398320bc6fSPatrick Sanan } 96408320bc6fSPatrick Sanan PetscFunctionReturn(0); 96418320bc6fSPatrick Sanan } 9642c0f0dcc3SMatthew G. Knepley 9643c0f0dcc3SMatthew G. Knepley /*@C 9644c0f0dcc3SMatthew G. Knepley DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance. 9645c0f0dcc3SMatthew G. Knepley 9646c0f0dcc3SMatthew G. Knepley Logically Collective on DM 9647c0f0dcc3SMatthew G. Knepley 9648c0f0dcc3SMatthew G. Knepley Input Parameters: 9649c0f0dcc3SMatthew G. Knepley + DM - the DM 9650c0f0dcc3SMatthew G. Knepley . f - the monitor function 9651c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired) 9652c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL) 9653c0f0dcc3SMatthew G. Knepley 9654c0f0dcc3SMatthew G. Knepley Options Database Keys: 9655c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but 9656c0f0dcc3SMatthew G. Knepley does not cancel those set via the options database. 9657c0f0dcc3SMatthew G. Knepley 9658c0f0dcc3SMatthew G. Knepley Notes: 9659c0f0dcc3SMatthew G. Knepley Several different monitoring routines may be set by calling 9660c0f0dcc3SMatthew G. Knepley DMMonitorSet() multiple times; all will be called in the 9661c0f0dcc3SMatthew G. Knepley order in which they were set. 9662c0f0dcc3SMatthew G. Knepley 9663c0f0dcc3SMatthew G. Knepley Fortran Notes: 9664c0f0dcc3SMatthew G. Knepley Only a single monitor function can be set for each DM object 9665c0f0dcc3SMatthew G. Knepley 9666c0f0dcc3SMatthew G. Knepley Level: intermediate 9667c0f0dcc3SMatthew G. Knepley 9668c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel() 9669c0f0dcc3SMatthew G. Knepley @*/ 9670c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**)) 9671c0f0dcc3SMatthew G. Knepley { 9672c0f0dcc3SMatthew G. Knepley PetscInt m; 9673c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9674c0f0dcc3SMatthew G. Knepley 9675c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9676c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9677c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9678c0f0dcc3SMatthew G. Knepley PetscBool identical; 9679c0f0dcc3SMatthew G. Knepley 9680c0f0dcc3SMatthew G. Knepley ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr); 9681c0f0dcc3SMatthew G. Knepley if (identical) PetscFunctionReturn(0); 9682c0f0dcc3SMatthew G. Knepley } 96832c71b3e2SJacob Faibussowitsch PetscCheckFalse(dm->numbermonitors >= MAXDMMONITORS,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set"); 9684c0f0dcc3SMatthew G. Knepley dm->monitor[dm->numbermonitors] = f; 9685c0f0dcc3SMatthew G. Knepley dm->monitordestroy[dm->numbermonitors] = monitordestroy; 9686c0f0dcc3SMatthew G. Knepley dm->monitorcontext[dm->numbermonitors++] = (void *) mctx; 9687c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9688c0f0dcc3SMatthew G. Knepley } 9689c0f0dcc3SMatthew G. Knepley 9690c0f0dcc3SMatthew G. Knepley /*@ 9691c0f0dcc3SMatthew G. Knepley DMMonitorCancel - Clears all the monitor functions for a DM object. 9692c0f0dcc3SMatthew G. Knepley 9693c0f0dcc3SMatthew G. Knepley Logically Collective on DM 9694c0f0dcc3SMatthew G. Knepley 9695c0f0dcc3SMatthew G. Knepley Input Parameter: 9696c0f0dcc3SMatthew G. Knepley . dm - the DM 9697c0f0dcc3SMatthew G. Knepley 9698c0f0dcc3SMatthew G. Knepley Options Database Key: 9699c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired 9700c0f0dcc3SMatthew G. Knepley into a code by calls to DMonitorSet(), but does not cancel those 9701c0f0dcc3SMatthew G. Knepley set via the options database 9702c0f0dcc3SMatthew G. Knepley 9703c0f0dcc3SMatthew G. Knepley Notes: 9704c0f0dcc3SMatthew G. Knepley There is no way to clear one specific monitor from a DM object. 9705c0f0dcc3SMatthew G. Knepley 9706c0f0dcc3SMatthew G. Knepley Level: intermediate 9707c0f0dcc3SMatthew G. Knepley 9708c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet() 9709c0f0dcc3SMatthew G. Knepley @*/ 9710c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm) 9711c0f0dcc3SMatthew G. Knepley { 9712c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9713c0f0dcc3SMatthew G. Knepley PetscInt m; 9714c0f0dcc3SMatthew G. Knepley 9715c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9716c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9717c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9718c0f0dcc3SMatthew G. Knepley if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);} 9719c0f0dcc3SMatthew G. Knepley } 9720c0f0dcc3SMatthew G. Knepley dm->numbermonitors = 0; 9721c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9722c0f0dcc3SMatthew G. Knepley } 9723c0f0dcc3SMatthew G. Knepley 9724c0f0dcc3SMatthew G. Knepley /*@C 9725c0f0dcc3SMatthew G. Knepley DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 9726c0f0dcc3SMatthew G. Knepley 9727c0f0dcc3SMatthew G. Knepley Collective on DM 9728c0f0dcc3SMatthew G. Knepley 9729c0f0dcc3SMatthew G. Knepley Input Parameters: 9730c0f0dcc3SMatthew G. Knepley + dm - DM object you wish to monitor 9731c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking 9732c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done 9733c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor 9734c0f0dcc3SMatthew G. Knepley . monitor - the monitor function 9735c0f0dcc3SMatthew 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 9736c0f0dcc3SMatthew G. Knepley 9737c0f0dcc3SMatthew G. Knepley Output Parameter: 9738c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created 9739c0f0dcc3SMatthew G. Knepley 9740c0f0dcc3SMatthew G. Knepley Level: developer 9741c0f0dcc3SMatthew G. Knepley 9742c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 9743c0f0dcc3SMatthew G. Knepley PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 9744c0f0dcc3SMatthew G. Knepley PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 9745c0f0dcc3SMatthew G. Knepley PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 9746c0f0dcc3SMatthew G. Knepley PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 9747c0f0dcc3SMatthew G. Knepley PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 9748c0f0dcc3SMatthew G. Knepley PetscOptionsFList(), PetscOptionsEList() 9749c0f0dcc3SMatthew G. Knepley @*/ 9750c0f0dcc3SMatthew 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) 9751c0f0dcc3SMatthew G. Knepley { 9752c0f0dcc3SMatthew G. Knepley PetscViewer viewer; 9753c0f0dcc3SMatthew G. Knepley PetscViewerFormat format; 9754c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9755c0f0dcc3SMatthew G. Knepley 9756c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9757c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9758c0f0dcc3SMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr); 9759c0f0dcc3SMatthew G. Knepley if (*flg) { 9760c0f0dcc3SMatthew G. Knepley PetscViewerAndFormat *vf; 9761c0f0dcc3SMatthew G. Knepley 9762c0f0dcc3SMatthew G. Knepley ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr); 9763c0f0dcc3SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr); 9764c0f0dcc3SMatthew G. Knepley if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);} 9765c0f0dcc3SMatthew G. Knepley ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr); 9766c0f0dcc3SMatthew G. Knepley } 9767c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9768c0f0dcc3SMatthew G. Knepley } 9769c0f0dcc3SMatthew G. Knepley 9770c0f0dcc3SMatthew G. Knepley /*@ 9771c0f0dcc3SMatthew G. Knepley DMMonitor - runs the user provided monitor routines, if they exist 9772c0f0dcc3SMatthew G. Knepley 9773c0f0dcc3SMatthew G. Knepley Collective on DM 9774c0f0dcc3SMatthew G. Knepley 9775c0f0dcc3SMatthew G. Knepley Input Parameters: 9776c0f0dcc3SMatthew G. Knepley . dm - The DM 9777c0f0dcc3SMatthew G. Knepley 9778c0f0dcc3SMatthew G. Knepley Level: developer 9779c0f0dcc3SMatthew G. Knepley 9780c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet() 9781c0f0dcc3SMatthew G. Knepley @*/ 9782c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm) 9783c0f0dcc3SMatthew G. Knepley { 9784c0f0dcc3SMatthew G. Knepley PetscInt m; 9785c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9786c0f0dcc3SMatthew G. Knepley 9787c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9788c0f0dcc3SMatthew G. Knepley if (!dm) PetscFunctionReturn(0); 9789c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9790c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9791c0f0dcc3SMatthew G. Knepley ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr); 9792c0f0dcc3SMatthew G. Knepley } 9793c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9794c0f0dcc3SMatthew G. Knepley } 97952e4af2aeSMatthew G. Knepley 97962e4af2aeSMatthew G. Knepley /*@ 97972e4af2aeSMatthew G. Knepley DMComputeError - Computes the error assuming the user has given exact solution functions 97982e4af2aeSMatthew G. Knepley 97992e4af2aeSMatthew G. Knepley Collective on DM 98002e4af2aeSMatthew G. Knepley 98012e4af2aeSMatthew G. Knepley Input Parameters: 98022e4af2aeSMatthew G. Knepley + dm - The DM 98036b867d5aSJose E. Roman - sol - The solution vector 98042e4af2aeSMatthew G. Knepley 98056b867d5aSJose E. Roman Input/Output Parameter: 98066b867d5aSJose E. Roman . errors - An array of length Nf, the number of fields, or NULL for no output; on output 98076b867d5aSJose E. Roman contains the error in each field 98086b867d5aSJose E. Roman 98096b867d5aSJose E. Roman Output Parameter: 98106b867d5aSJose E. Roman . errorVec - A vector to hold the cellwise error (may be NULL) 98112e4af2aeSMatthew G. Knepley 98122e4af2aeSMatthew G. Knepley Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber(). 98132e4af2aeSMatthew G. Knepley 98142e4af2aeSMatthew G. Knepley Level: developer 98152e4af2aeSMatthew G. Knepley 98162e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber() 98172e4af2aeSMatthew G. Knepley @*/ 98182e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec) 98192e4af2aeSMatthew G. Knepley { 98202e4af2aeSMatthew G. Knepley PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *); 98212e4af2aeSMatthew G. Knepley void **ctxs; 98222e4af2aeSMatthew G. Knepley PetscReal time; 98232e4af2aeSMatthew G. Knepley PetscInt Nf, f, Nds, s; 98242e4af2aeSMatthew G. Knepley PetscErrorCode ierr; 98252e4af2aeSMatthew G. Knepley 98262e4af2aeSMatthew G. Knepley PetscFunctionBegin; 98272e4af2aeSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 98282e4af2aeSMatthew G. Knepley ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr); 98292e4af2aeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 98302e4af2aeSMatthew G. Knepley for (s = 0; s < Nds; ++s) { 98312e4af2aeSMatthew G. Knepley PetscDS ds; 98322e4af2aeSMatthew G. Knepley DMLabel label; 98332e4af2aeSMatthew G. Knepley IS fieldIS; 98342e4af2aeSMatthew G. Knepley const PetscInt *fields; 98352e4af2aeSMatthew G. Knepley PetscInt dsNf; 98362e4af2aeSMatthew G. Knepley 98372e4af2aeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr); 98382e4af2aeSMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr); 98392e4af2aeSMatthew G. Knepley if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);} 98402e4af2aeSMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 98412e4af2aeSMatthew G. Knepley const PetscInt field = fields[f]; 98422e4af2aeSMatthew G. Knepley ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr); 98432e4af2aeSMatthew G. Knepley } 98442e4af2aeSMatthew G. Knepley if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);} 98452e4af2aeSMatthew G. Knepley } 98462e4af2aeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 98472c71b3e2SJacob Faibussowitsch PetscCheckFalse(!exactSol[f],PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "DS must contain exact solution functions in order to calculate error, missing for field %D", f); 98482e4af2aeSMatthew G. Knepley } 98492e4af2aeSMatthew G. Knepley ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr); 98502e4af2aeSMatthew G. Knepley if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);} 98512e4af2aeSMatthew G. Knepley if (errorVec) { 98522e4af2aeSMatthew G. Knepley DM edm; 98532e4af2aeSMatthew G. Knepley DMPolytopeType ct; 98542e4af2aeSMatthew G. Knepley PetscBool simplex; 98552e4af2aeSMatthew G. Knepley PetscInt dim, cStart, Nf; 98562e4af2aeSMatthew G. Knepley 98572e4af2aeSMatthew G. Knepley ierr = DMClone(dm, &edm);CHKERRQ(ierr); 98582e4af2aeSMatthew G. Knepley ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr); 98592e4af2aeSMatthew G. Knepley ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr); 98602e4af2aeSMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 98612e4af2aeSMatthew G. Knepley simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE; 98622e4af2aeSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 98632e4af2aeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 98642e4af2aeSMatthew G. Knepley PetscFE fe, efe; 98652e4af2aeSMatthew G. Knepley PetscQuadrature q; 98662e4af2aeSMatthew G. Knepley const char *name; 98672e4af2aeSMatthew G. Knepley 98682e4af2aeSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr); 98692e4af2aeSMatthew G. Knepley ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr); 98702e4af2aeSMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr); 98712e4af2aeSMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr); 98722e4af2aeSMatthew G. Knepley ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr); 98732e4af2aeSMatthew G. Knepley ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr); 98742e4af2aeSMatthew G. Knepley ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr); 98752e4af2aeSMatthew G. Knepley ierr = PetscFEDestroy(&efe);CHKERRQ(ierr); 98762e4af2aeSMatthew G. Knepley } 98772e4af2aeSMatthew G. Knepley ierr = DMCreateDS(edm);CHKERRQ(ierr); 98782e4af2aeSMatthew G. Knepley 98791e1ea65dSPierre Jolivet ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr); 98802e4af2aeSMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr); 98812e4af2aeSMatthew G. Knepley ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr); 98822e4af2aeSMatthew G. Knepley ierr = DMDestroy(&edm);CHKERRQ(ierr); 98832e4af2aeSMatthew G. Knepley } 98842e4af2aeSMatthew G. Knepley ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr); 98852e4af2aeSMatthew G. Knepley PetscFunctionReturn(0); 98862e4af2aeSMatthew G. Knepley } 98879a2a23afSMatthew G. Knepley 98889a2a23afSMatthew G. Knepley /*@ 98899a2a23afSMatthew G. Knepley DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM 98909a2a23afSMatthew G. Knepley 98919a2a23afSMatthew G. Knepley Not collective 98929a2a23afSMatthew G. Knepley 98939a2a23afSMatthew G. Knepley Input Parameter: 98949a2a23afSMatthew G. Knepley . dm - The DM 98959a2a23afSMatthew G. Knepley 98969a2a23afSMatthew G. Knepley Output Parameter: 9897a5b23f4aSJose E. Roman . numAux - The number of auxiliary data vectors 98989a2a23afSMatthew G. Knepley 98999a2a23afSMatthew G. Knepley Level: advanced 99009a2a23afSMatthew G. Knepley 99019a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 99029a2a23afSMatthew G. Knepley @*/ 99039a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux) 99049a2a23afSMatthew G. Knepley { 99059a2a23afSMatthew G. Knepley PetscErrorCode ierr; 99069a2a23afSMatthew G. Knepley 99079a2a23afSMatthew G. Knepley PetscFunctionBegin; 99089a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 99099a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr); 99109a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 99119a2a23afSMatthew G. Knepley } 99129a2a23afSMatthew G. Knepley 99139a2a23afSMatthew G. Knepley /*@ 99149a2a23afSMatthew G. Knepley DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value 99159a2a23afSMatthew G. Knepley 99169a2a23afSMatthew G. Knepley Not collective 99179a2a23afSMatthew G. Knepley 99189a2a23afSMatthew G. Knepley Input Parameters: 99199a2a23afSMatthew G. Knepley + dm - The DM 99209a2a23afSMatthew G. Knepley . label - The DMLabel 99219a2a23afSMatthew G. Knepley - value - The label value indicating the region 99229a2a23afSMatthew G. Knepley 99239a2a23afSMatthew G. Knepley Output Parameter: 99249a2a23afSMatthew G. Knepley . aux - The Vec holding auxiliary field data 99259a2a23afSMatthew G. Knepley 992604c51a94SMatthew G. Knepley Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well. 992704c51a94SMatthew G. Knepley 99289a2a23afSMatthew G. Knepley Level: advanced 99299a2a23afSMatthew G. Knepley 99309a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec() 99319a2a23afSMatthew G. Knepley @*/ 99329a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux) 99339a2a23afSMatthew G. Knepley { 993404c51a94SMatthew G. Knepley PetscHashAuxKey key, wild = {NULL, 0}; 993504c51a94SMatthew G. Knepley PetscBool has; 99369a2a23afSMatthew G. Knepley PetscErrorCode ierr; 99379a2a23afSMatthew G. Knepley 99389a2a23afSMatthew G. Knepley PetscFunctionBegin; 99399a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 99409a2a23afSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 99419a2a23afSMatthew G. Knepley key.label = label; 99429a2a23afSMatthew G. Knepley key.value = value; 994304c51a94SMatthew G. Knepley ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr); 994404c51a94SMatthew G. Knepley if (has) {ierr = PetscHMapAuxGet(dm->auxData, key, aux);CHKERRQ(ierr);} 994504c51a94SMatthew G. Knepley else {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);} 99469a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 99479a2a23afSMatthew G. Knepley } 99489a2a23afSMatthew G. Knepley 99499a2a23afSMatthew G. Knepley /*@ 99509a2a23afSMatthew G. Knepley DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value 99519a2a23afSMatthew G. Knepley 99529a2a23afSMatthew G. Knepley Not collective 99539a2a23afSMatthew G. Knepley 99549a2a23afSMatthew G. Knepley Input Parameters: 99559a2a23afSMatthew G. Knepley + dm - The DM 99569a2a23afSMatthew G. Knepley . label - The DMLabel 99579a2a23afSMatthew G. Knepley . value - The label value indicating the region 99589a2a23afSMatthew G. Knepley - aux - The Vec holding auxiliary field data 99599a2a23afSMatthew G. Knepley 99609a2a23afSMatthew G. Knepley Level: advanced 99619a2a23afSMatthew G. Knepley 99629a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec() 99639a2a23afSMatthew G. Knepley @*/ 99649a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux) 99659a2a23afSMatthew G. Knepley { 99669a2a23afSMatthew G. Knepley Vec old; 99679a2a23afSMatthew G. Knepley PetscHashAuxKey key; 99689a2a23afSMatthew G. Knepley PetscErrorCode ierr; 99699a2a23afSMatthew G. Knepley 99709a2a23afSMatthew G. Knepley PetscFunctionBegin; 99719a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 99729a2a23afSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 99739a2a23afSMatthew G. Knepley key.label = label; 99749a2a23afSMatthew G. Knepley key.value = value; 99759a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr); 99769a2a23afSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr); 99779a2a23afSMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr); 99789a2a23afSMatthew G. Knepley if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);} 99799a2a23afSMatthew G. Knepley else {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);} 99809a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 99819a2a23afSMatthew G. Knepley } 99829a2a23afSMatthew G. Knepley 99839a2a23afSMatthew G. Knepley /*@C 99849a2a23afSMatthew G. Knepley DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM 99859a2a23afSMatthew G. Knepley 99869a2a23afSMatthew G. Knepley Not collective 99879a2a23afSMatthew G. Knepley 99889a2a23afSMatthew G. Knepley Input Parameter: 99899a2a23afSMatthew G. Knepley . dm - The DM 99909a2a23afSMatthew G. Knepley 99919a2a23afSMatthew G. Knepley Output Parameters: 99929a2a23afSMatthew G. Knepley + labels - The DMLabels for each Vec 99939a2a23afSMatthew G. Knepley - values - The label values for each Vec 99949a2a23afSMatthew G. Knepley 99959a2a23afSMatthew G. Knepley Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec(). 99969a2a23afSMatthew G. Knepley 99979a2a23afSMatthew G. Knepley Level: advanced 99989a2a23afSMatthew G. Knepley 99999a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 100009a2a23afSMatthew G. Knepley @*/ 100019a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[]) 100029a2a23afSMatthew G. Knepley { 100039a2a23afSMatthew G. Knepley PetscHashAuxKey *keys; 100049a2a23afSMatthew G. Knepley PetscInt n, i, off = 0; 100059a2a23afSMatthew G. Knepley PetscErrorCode ierr; 100069a2a23afSMatthew G. Knepley 100079a2a23afSMatthew G. Knepley PetscFunctionBegin; 100089a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 100099a2a23afSMatthew G. Knepley PetscValidPointer(labels, 2); 100109a2a23afSMatthew G. Knepley PetscValidPointer(values, 3); 100119a2a23afSMatthew G. Knepley ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr); 100129a2a23afSMatthew G. Knepley ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr); 100139a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr); 100149a2a23afSMatthew G. Knepley for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;} 100159a2a23afSMatthew G. Knepley ierr = PetscFree(keys);CHKERRQ(ierr); 100169a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 100179a2a23afSMatthew G. Knepley } 100189a2a23afSMatthew G. Knepley 100199a2a23afSMatthew G. Knepley /*@ 100209a2a23afSMatthew G. Knepley DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM 100219a2a23afSMatthew G. Knepley 100229a2a23afSMatthew G. Knepley Not collective 100239a2a23afSMatthew G. Knepley 100249a2a23afSMatthew G. Knepley Input Parameter: 100259a2a23afSMatthew G. Knepley . dm - The DM 100269a2a23afSMatthew G. Knepley 100279a2a23afSMatthew G. Knepley Output Parameter: 100289a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data 100299a2a23afSMatthew G. Knepley 100309a2a23afSMatthew G. Knepley Level: advanced 100319a2a23afSMatthew G. Knepley 100329a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 100339a2a23afSMatthew G. Knepley @*/ 100349a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew) 100359a2a23afSMatthew G. Knepley { 100369a2a23afSMatthew G. Knepley PetscErrorCode ierr; 100379a2a23afSMatthew G. Knepley 100389a2a23afSMatthew G. Knepley PetscFunctionBegin; 100399a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 100409a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr); 100419a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr); 100429a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 100439a2a23afSMatthew G. Knepley } 10044b5a892a1SMatthew G. Knepley 10045b5a892a1SMatthew G. Knepley /*@C 10046b5a892a1SMatthew G. Knepley DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement 10047b5a892a1SMatthew G. Knepley 10048b5a892a1SMatthew G. Knepley Not collective 10049b5a892a1SMatthew G. Knepley 10050b5a892a1SMatthew G. Knepley Input Parameters: 10051b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10052b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces 10053b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces 10054b5a892a1SMatthew G. Knepley 10055b5a892a1SMatthew G. Knepley Output Parameters: 10056b5a892a1SMatthew G. Knepley + ornt - The orientation which will take the source arrangement to the target arrangement 10057b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found 10058b5a892a1SMatthew G. Knepley 10059b5a892a1SMatthew G. Knepley Level: advanced 10060b5a892a1SMatthew G. Knepley 10061b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation() 10062b5a892a1SMatthew G. Knepley @*/ 10063b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found) 10064b5a892a1SMatthew G. Knepley { 10065b5a892a1SMatthew G. Knepley const PetscInt cS = DMPolytopeTypeGetConeSize(ct); 10066b5a892a1SMatthew G. Knepley const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2; 10067b5a892a1SMatthew G. Knepley PetscInt o, c; 10068b5a892a1SMatthew G. Knepley 10069b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10070b5a892a1SMatthew G. Knepley if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);} 10071b5a892a1SMatthew G. Knepley for (o = -nO; o < nO; ++o) { 10072b5a892a1SMatthew G. Knepley const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o); 10073b5a892a1SMatthew G. Knepley 10074b5a892a1SMatthew G. Knepley for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break; 10075b5a892a1SMatthew G. Knepley if (c == cS) {*ornt = o; break;} 10076b5a892a1SMatthew G. Knepley } 10077b5a892a1SMatthew G. Knepley *found = o == nO ? PETSC_FALSE : PETSC_TRUE; 10078b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10079b5a892a1SMatthew G. Knepley } 10080b5a892a1SMatthew G. Knepley 10081b5a892a1SMatthew G. Knepley /*@C 10082b5a892a1SMatthew G. Knepley DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement 10083b5a892a1SMatthew G. Knepley 10084b5a892a1SMatthew G. Knepley Not collective 10085b5a892a1SMatthew G. Knepley 10086b5a892a1SMatthew G. Knepley Input Parameters: 10087b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10088b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces 10089b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces 10090b5a892a1SMatthew G. Knepley 10091b5a892a1SMatthew G. Knepley Output Parameters: 10092b5a892a1SMatthew G. Knepley . ornt - The orientation which will take the source arrangement to the target arrangement 10093b5a892a1SMatthew G. Knepley 10094b5a892a1SMatthew G. Knepley Note: This function will fail if no suitable orientation can be found. 10095b5a892a1SMatthew G. Knepley 10096b5a892a1SMatthew G. Knepley Level: advanced 10097b5a892a1SMatthew G. Knepley 10098b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation() 10099b5a892a1SMatthew G. Knepley @*/ 10100b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt) 10101b5a892a1SMatthew G. Knepley { 10102b5a892a1SMatthew G. Knepley PetscBool found; 10103b5a892a1SMatthew G. Knepley PetscErrorCode ierr; 10104b5a892a1SMatthew G. Knepley 10105b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10106b5a892a1SMatthew G. Knepley ierr = DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr); 101072c71b3e2SJacob Faibussowitsch PetscCheckFalse(!found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]); 10108b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10109b5a892a1SMatthew G. Knepley } 10110b5a892a1SMatthew G. Knepley 10111b5a892a1SMatthew G. Knepley /*@C 10112b5a892a1SMatthew G. Knepley DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement 10113b5a892a1SMatthew G. Knepley 10114b5a892a1SMatthew G. Knepley Not collective 10115b5a892a1SMatthew G. Knepley 10116b5a892a1SMatthew G. Knepley Input Parameters: 10117b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10118b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices 10119b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices 10120b5a892a1SMatthew G. Knepley 10121b5a892a1SMatthew G. Knepley Output Parameters: 10122b5a892a1SMatthew G. Knepley + ornt - The orientation which will take the source arrangement to the target arrangement 10123b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found 10124b5a892a1SMatthew G. Knepley 10125b5a892a1SMatthew G. Knepley Level: advanced 10126b5a892a1SMatthew G. Knepley 10127b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation() 10128b5a892a1SMatthew G. Knepley @*/ 10129b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found) 10130b5a892a1SMatthew G. Knepley { 10131b5a892a1SMatthew G. Knepley const PetscInt cS = DMPolytopeTypeGetNumVertices(ct); 10132b5a892a1SMatthew G. Knepley const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2; 10133b5a892a1SMatthew G. Knepley PetscInt o, c; 10134b5a892a1SMatthew G. Knepley 10135b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10136b5a892a1SMatthew G. Knepley if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);} 10137b5a892a1SMatthew G. Knepley for (o = -nO; o < nO; ++o) { 10138b5a892a1SMatthew G. Knepley const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o); 10139b5a892a1SMatthew G. Knepley 10140b5a892a1SMatthew G. Knepley for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break; 10141b5a892a1SMatthew G. Knepley if (c == cS) {*ornt = o; break;} 10142b5a892a1SMatthew G. Knepley } 10143b5a892a1SMatthew G. Knepley *found = o == nO ? PETSC_FALSE : PETSC_TRUE; 10144b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10145b5a892a1SMatthew G. Knepley } 10146b5a892a1SMatthew G. Knepley 10147b5a892a1SMatthew G. Knepley /*@C 10148b5a892a1SMatthew G. Knepley DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement 10149b5a892a1SMatthew G. Knepley 10150b5a892a1SMatthew G. Knepley Not collective 10151b5a892a1SMatthew G. Knepley 10152b5a892a1SMatthew G. Knepley Input Parameters: 10153b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10154b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices 10155b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices 10156b5a892a1SMatthew G. Knepley 10157b5a892a1SMatthew G. Knepley Output Parameters: 10158b5a892a1SMatthew G. Knepley . ornt - The orientation which will take the source arrangement to the target arrangement 10159b5a892a1SMatthew G. Knepley 10160b5a892a1SMatthew G. Knepley Note: This function will fail if no suitable orientation can be found. 10161b5a892a1SMatthew G. Knepley 10162b5a892a1SMatthew G. Knepley Level: advanced 10163b5a892a1SMatthew G. Knepley 10164b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation() 10165b5a892a1SMatthew G. Knepley @*/ 10166b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt) 10167b5a892a1SMatthew G. Knepley { 10168b5a892a1SMatthew G. Knepley PetscBool found; 10169b5a892a1SMatthew G. Knepley PetscErrorCode ierr; 10170b5a892a1SMatthew G. Knepley 10171b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10172b5a892a1SMatthew G. Knepley ierr = DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr); 101732c71b3e2SJacob Faibussowitsch PetscCheckFalse(!found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]); 10174b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10175b5a892a1SMatthew G. Knepley } 10176012bc364SMatthew G. Knepley 10177012bc364SMatthew G. Knepley /*@C 10178012bc364SMatthew G. Knepley DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type 10179012bc364SMatthew G. Knepley 10180012bc364SMatthew G. Knepley Not collective 10181012bc364SMatthew G. Knepley 10182012bc364SMatthew G. Knepley Input Parameters: 10183012bc364SMatthew G. Knepley + ct - The DMPolytopeType 10184012bc364SMatthew G. Knepley - point - Coordinates of the point 10185012bc364SMatthew G. Knepley 10186012bc364SMatthew G. Knepley Output Parameters: 10187012bc364SMatthew G. Knepley . inside - Flag indicating whether the point is inside the reference cell of given type 10188012bc364SMatthew G. Knepley 10189012bc364SMatthew G. Knepley Level: advanced 10190012bc364SMatthew G. Knepley 10191012bc364SMatthew G. Knepley .seealso: DMLocatePoints() 10192012bc364SMatthew G. Knepley @*/ 10193012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside) 10194012bc364SMatthew G. Knepley { 10195012bc364SMatthew G. Knepley PetscReal sum = 0.0; 10196012bc364SMatthew G. Knepley PetscInt d; 10197012bc364SMatthew G. Knepley 10198012bc364SMatthew G. Knepley PetscFunctionBegin; 10199012bc364SMatthew G. Knepley *inside = PETSC_TRUE; 10200012bc364SMatthew G. Knepley switch (ct) { 10201012bc364SMatthew G. Knepley case DM_POLYTOPE_TRIANGLE: 10202012bc364SMatthew G. Knepley case DM_POLYTOPE_TETRAHEDRON: 10203012bc364SMatthew G. Knepley for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) { 10204012bc364SMatthew G. Knepley if (point[d] < -1.0) {*inside = PETSC_FALSE; break;} 10205012bc364SMatthew G. Knepley sum += point[d]; 10206012bc364SMatthew G. Knepley } 10207012bc364SMatthew G. Knepley if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;} 10208012bc364SMatthew G. Knepley break; 10209012bc364SMatthew G. Knepley case DM_POLYTOPE_QUADRILATERAL: 10210012bc364SMatthew G. Knepley case DM_POLYTOPE_HEXAHEDRON: 10211012bc364SMatthew G. Knepley for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) 10212012bc364SMatthew G. Knepley if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;} 10213012bc364SMatthew G. Knepley break; 10214012bc364SMatthew G. Knepley default: 1021598921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]); 10216012bc364SMatthew G. Knepley } 10217012bc364SMatthew G. Knepley PetscFunctionReturn(0); 10218012bc364SMatthew G. Knepley } 10219