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 10*f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 11*f918ec44SMatthew G. Knepley #include <petscfeceed.h> 12*f918ec44SMatthew G. Knepley #endif 13*f918ec44SMatthew 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}; 2560c22052SBarry Smith 26a4121054SBarry Smith /*@ 27de043629SMatthew G Knepley DMCreate - Creates an empty DM object. The type can then be set with DMSetType(). 28a4121054SBarry Smith 29a4121054SBarry Smith If you never call DMSetType() it will generate an 30a4121054SBarry Smith error when you try to use the vector. 31a4121054SBarry Smith 32d083f849SBarry Smith Collective 33a4121054SBarry Smith 34a4121054SBarry Smith Input Parameter: 35a4121054SBarry Smith . comm - The communicator for the DM object 36a4121054SBarry Smith 37a4121054SBarry Smith Output Parameter: 38a4121054SBarry Smith . dm - The DM object 39a4121054SBarry Smith 40a4121054SBarry Smith Level: beginner 41a4121054SBarry Smith 428472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK 43a4121054SBarry Smith @*/ 447087cfbeSBarry Smith PetscErrorCode DMCreate(MPI_Comm comm,DM *dm) 45a4121054SBarry Smith { 46a4121054SBarry Smith DM v; 47e5e52638SMatthew G. Knepley PetscDS ds; 48a4121054SBarry Smith PetscErrorCode ierr; 49a4121054SBarry Smith 50a4121054SBarry Smith PetscFunctionBegin; 511411c6eeSJed Brown PetscValidPointer(dm,2); 520298fd71SBarry Smith *dm = NULL; 53607a6623SBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 54a4121054SBarry Smith 5573107ff1SLisandro Dalcin ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr); 56e7c4fc90SDmitry Karpeev 5749be4549SMatthew G. Knepley v->setupcalled = PETSC_FALSE; 5849be4549SMatthew G. Knepley v->setfromoptionscalled = PETSC_FALSE; 590298fd71SBarry Smith v->ltogmap = NULL; 601411c6eeSJed Brown v->bs = 1; 61171400e9SBarry Smith v->coloringtype = IS_COLORING_GLOBAL; 6288ed4aceSMatthew G Knepley ierr = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr); 631bb6d2a8SBarry Smith ierr = PetscSFCreate(comm, &v->sectionSF);CHKERRQ(ierr); 64c58f1c22SToby Isaac v->labels = NULL; 6534aa8a36SMatthew G. Knepley v->adjacency[0] = PETSC_FALSE; 6634aa8a36SMatthew G. Knepley v->adjacency[1] = PETSC_TRUE; 67c58f1c22SToby Isaac v->depthLabel = NULL; 68ba2698f1SMatthew G. Knepley v->celltypeLabel = NULL; 691bb6d2a8SBarry Smith v->localSection = NULL; 701bb6d2a8SBarry Smith v->globalSection = NULL; 71fba222abSToby Isaac v->defaultConstraintSection = NULL; 72fba222abSToby Isaac v->defaultConstraintMat = NULL; 73c6b900c6SMatthew G. Knepley v->L = NULL; 74c6b900c6SMatthew G. Knepley v->maxCell = NULL; 755dc8c3f7SMatthew G. Knepley v->bdtype = NULL; 769a9a41abSToby Isaac v->dimEmbed = PETSC_DEFAULT; 7796173672SStefano Zampini v->dim = PETSC_DETERMINE; 78435a35e8SMatthew G Knepley { 79435a35e8SMatthew G Knepley PetscInt i; 80435a35e8SMatthew G Knepley for (i = 0; i < 10; ++i) { 810298fd71SBarry Smith v->nullspaceConstructors[i] = NULL; 82f9d4088aSMatthew G. Knepley v->nearnullspaceConstructors[i] = NULL; 83435a35e8SMatthew G Knepley } 84435a35e8SMatthew G Knepley } 8545480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 86b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr); 87e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 889a2a23afSMatthew G. Knepley ierr = PetscHMapAuxCreate(&v->auxData);CHKERRQ(ierr); 8914f150ffSMatthew G. Knepley v->dmBC = NULL; 90a8fb8f29SToby Isaac v->coarseMesh = NULL; 91f4d763aaSMatthew G. Knepley v->outputSequenceNum = -1; 92cdb7a50dSMatthew G. Knepley v->outputSequenceVal = 0.0; 93c0dedaeaSBarry Smith ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr); 94b412c318SBarry Smith ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr); 954a7a4c06SLawrence Mitchell 961411c6eeSJed Brown *dm = v; 97a4121054SBarry Smith PetscFunctionReturn(0); 98a4121054SBarry Smith } 99a4121054SBarry Smith 10038221697SMatthew G. Knepley /*@ 10138221697SMatthew G. Knepley DMClone - Creates a DM object with the same topology as the original. 10238221697SMatthew G. Knepley 103d083f849SBarry Smith Collective 10438221697SMatthew G. Knepley 10538221697SMatthew G. Knepley Input Parameter: 10638221697SMatthew G. Knepley . dm - The original DM object 10738221697SMatthew G. Knepley 10838221697SMatthew G. Knepley Output Parameter: 10938221697SMatthew G. Knepley . newdm - The new DM object 11038221697SMatthew G. Knepley 11138221697SMatthew G. Knepley Level: beginner 11238221697SMatthew G. Knepley 1131cb8cacdSPatrick Sanan Notes: 1141cb8cacdSPatrick Sanan For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example, 1151cb8cacdSPatrick Sanan DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not 1161cb8cacdSPatrick Sanan share the PetscSection of the original DM. 1171bb6d2a8SBarry Smith 11889706ed2SPatrick Sanan The clone is considered set up iff the original is. 11989706ed2SPatrick Sanan 12092cfd99aSMartin Diehl .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection() 1211bb6d2a8SBarry Smith 12238221697SMatthew G. Knepley @*/ 12338221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm) 12438221697SMatthew G. Knepley { 12538221697SMatthew G. Knepley PetscSF sf; 12638221697SMatthew G. Knepley Vec coords; 12738221697SMatthew G. Knepley void *ctx; 128a3219837SMatthew G. Knepley PetscInt dim, cdim; 12938221697SMatthew G. Knepley PetscErrorCode ierr; 13038221697SMatthew G. Knepley 13138221697SMatthew G. Knepley PetscFunctionBegin; 13238221697SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 13338221697SMatthew G. Knepley PetscValidPointer(newdm,2); 13438221697SMatthew G. Knepley ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr); 1355d80c0bfSVaclav Hapla ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE);CHKERRQ(ierr); 136ddf8437dSMatthew G. Knepley (*newdm)->leveldown = dm->leveldown; 137ddf8437dSMatthew G. Knepley (*newdm)->levelup = dm->levelup; 138c8a6034eSMark (*newdm)->prealloc_only = dm->prealloc_only; 139a587d139SMark ierr = PetscFree((*newdm)->vectype);CHKERRQ(ierr); 140a587d139SMark ierr = PetscStrallocpy(dm->vectype,(char**)&(*newdm)->vectype);CHKERRQ(ierr); 141a587d139SMark ierr = PetscFree((*newdm)->mattype);CHKERRQ(ierr); 142a587d139SMark ierr = PetscStrallocpy(dm->mattype,(char**)&(*newdm)->mattype);CHKERRQ(ierr); 1431de53e9aSMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 1441de53e9aSMatthew G. Knepley ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr); 14538221697SMatthew G. Knepley if (dm->ops->clone) { 14638221697SMatthew G. Knepley ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr); 14738221697SMatthew G. Knepley } 1483f22bcbcSToby Isaac (*newdm)->setupcalled = dm->setupcalled; 14938221697SMatthew G. Knepley ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr); 15038221697SMatthew G. Knepley ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr); 15138221697SMatthew G. Knepley ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr); 15238221697SMatthew G. Knepley ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr); 153be4c1c3eSMatthew G. Knepley if (dm->coordinateDM) { 154be4c1c3eSMatthew G. Knepley DM ncdm; 155be4c1c3eSMatthew G. Knepley PetscSection cs; 1565a0206caSToby Isaac PetscInt pEnd = -1, pEndMax = -1; 157be4c1c3eSMatthew G. Knepley 15892fd8e1eSJed Brown ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr); 159be4c1c3eSMatthew G. Knepley if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);} 160ffc4695bSBarry Smith ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 1615a0206caSToby Isaac if (pEndMax >= 0) { 162be4c1c3eSMatthew G. Knepley ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr); 16383bfc06fSMatthew Knepley ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr); 16492fd8e1eSJed Brown ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr); 165a61e840bSMatthew G. Knepley ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr); 166be4c1c3eSMatthew G. Knepley ierr = DMDestroy(&ncdm);CHKERRQ(ierr); 167be4c1c3eSMatthew G. Knepley } 168be4c1c3eSMatthew G. Knepley } 169a3219837SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 170a3219837SMatthew G. Knepley ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr); 17138221697SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr); 17238221697SMatthew G. Knepley if (coords) { 17338221697SMatthew G. Knepley ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr); 17438221697SMatthew G. Knepley } else { 17538221697SMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 17638221697SMatthew G. Knepley if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);} 17738221697SMatthew G. Knepley } 17890b157c4SStefano Zampini { 17990b157c4SStefano Zampini PetscBool isper; 180c6b900c6SMatthew G. Knepley const PetscReal *maxCell, *L; 1815dc8c3f7SMatthew G. Knepley const DMBoundaryType *bd; 18290b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 18390b157c4SStefano Zampini ierr = DMSetPeriodicity(*newdm, isper, maxCell, L, bd);CHKERRQ(ierr); 184c6b900c6SMatthew G. Knepley } 18534aa8a36SMatthew G. Knepley { 18634aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 18734aa8a36SMatthew G. Knepley 18834aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr); 18934aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 19034aa8a36SMatthew G. Knepley } 19138221697SMatthew G. Knepley PetscFunctionReturn(0); 19238221697SMatthew G. Knepley } 19338221697SMatthew G. Knepley 1949a42bb27SBarry Smith /*@C 195564755cdSBarry Smith DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 1969a42bb27SBarry Smith 197d083f849SBarry Smith Logically Collective on da 1989a42bb27SBarry Smith 1999a42bb27SBarry Smith Input Parameter: 2009a42bb27SBarry Smith + da - initial distributed array 201e9e886b6SKarl Rupp . ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL 2029a42bb27SBarry Smith 2039a42bb27SBarry Smith Options Database: 204dd85299cSBarry Smith . -dm_vec_type ctype 2059a42bb27SBarry Smith 2069a42bb27SBarry Smith Level: intermediate 2079a42bb27SBarry Smith 208a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType() 2099a42bb27SBarry Smith @*/ 21019fd82e9SBarry Smith PetscErrorCode DMSetVecType(DM da,VecType ctype) 2119a42bb27SBarry Smith { 2129a42bb27SBarry Smith PetscErrorCode ierr; 2139a42bb27SBarry Smith 2149a42bb27SBarry Smith PetscFunctionBegin; 2159a42bb27SBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 2169a42bb27SBarry Smith ierr = PetscFree(da->vectype);CHKERRQ(ierr); 21719fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr); 2189a42bb27SBarry Smith PetscFunctionReturn(0); 2199a42bb27SBarry Smith } 2209a42bb27SBarry Smith 221c0dedaeaSBarry Smith /*@C 222c0dedaeaSBarry Smith DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 223c0dedaeaSBarry Smith 224d083f849SBarry Smith Logically Collective on da 225c0dedaeaSBarry Smith 226c0dedaeaSBarry Smith Input Parameter: 227c0dedaeaSBarry Smith . da - initial distributed array 228c0dedaeaSBarry Smith 229c0dedaeaSBarry Smith Output Parameter: 230c0dedaeaSBarry Smith . ctype - the vector type 231c0dedaeaSBarry Smith 232c0dedaeaSBarry Smith Level: intermediate 233c0dedaeaSBarry Smith 234a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType() 235c0dedaeaSBarry Smith @*/ 236c0dedaeaSBarry Smith PetscErrorCode DMGetVecType(DM da,VecType *ctype) 237c0dedaeaSBarry Smith { 238c0dedaeaSBarry Smith PetscFunctionBegin; 239c0dedaeaSBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 240c0dedaeaSBarry Smith *ctype = da->vectype; 241c0dedaeaSBarry Smith PetscFunctionReturn(0); 242c0dedaeaSBarry Smith } 243c0dedaeaSBarry Smith 2445f1ad066SMatthew G Knepley /*@ 24534f98d34SBarry Smith VecGetDM - Gets the DM defining the data layout of the vector 2465f1ad066SMatthew G Knepley 2475f1ad066SMatthew G Knepley Not collective 2485f1ad066SMatthew G Knepley 2495f1ad066SMatthew G Knepley Input Parameter: 2505f1ad066SMatthew G Knepley . v - The Vec 2515f1ad066SMatthew G Knepley 2525f1ad066SMatthew G Knepley Output Parameter: 2535f1ad066SMatthew G Knepley . dm - The DM 2545f1ad066SMatthew G Knepley 2555f1ad066SMatthew G Knepley Level: intermediate 2565f1ad066SMatthew G Knepley 2575f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2585f1ad066SMatthew G Knepley @*/ 2595f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm) 2605f1ad066SMatthew G Knepley { 2615f1ad066SMatthew G Knepley PetscErrorCode ierr; 2625f1ad066SMatthew G Knepley 2635f1ad066SMatthew G Knepley PetscFunctionBegin; 2645f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 2655f1ad066SMatthew G Knepley PetscValidPointer(dm,2); 2665f1ad066SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 2675f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2685f1ad066SMatthew G Knepley } 2695f1ad066SMatthew G Knepley 2705f1ad066SMatthew G Knepley /*@ 271d9805387SMatthew G. Knepley VecSetDM - Sets the DM defining the data layout of the vector. 2725f1ad066SMatthew G Knepley 2735f1ad066SMatthew G Knepley Not collective 2745f1ad066SMatthew G Knepley 2755f1ad066SMatthew G Knepley Input Parameters: 2765f1ad066SMatthew G Knepley + v - The Vec 2775f1ad066SMatthew G Knepley - dm - The DM 2785f1ad066SMatthew G Knepley 279d9805387SMatthew 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. 280d9805387SMatthew G. Knepley 2815f1ad066SMatthew G Knepley Level: intermediate 2825f1ad066SMatthew G Knepley 2835f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2845f1ad066SMatthew G Knepley @*/ 2855f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm) 2865f1ad066SMatthew G Knepley { 2875f1ad066SMatthew G Knepley PetscErrorCode ierr; 2885f1ad066SMatthew G Knepley 2895f1ad066SMatthew G Knepley PetscFunctionBegin; 2905f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 291d7f50e27SLisandro Dalcin if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 2925f1ad066SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 2935f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2945f1ad066SMatthew G Knepley } 2955f1ad066SMatthew G Knepley 296521d9a4cSLisandro Dalcin /*@C 2978f1509bcSBarry Smith DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM 2988f1509bcSBarry Smith 299d083f849SBarry Smith Logically Collective on dm 3008f1509bcSBarry Smith 3018f1509bcSBarry Smith Input Parameters: 3028f1509bcSBarry Smith + dm - the DM context 3038f1509bcSBarry Smith - ctype - the matrix type 3048f1509bcSBarry Smith 3058f1509bcSBarry Smith Options Database: 3068f1509bcSBarry Smith . -dm_is_coloring_type - global or local 3078f1509bcSBarry Smith 3088f1509bcSBarry Smith Level: intermediate 3098f1509bcSBarry Smith 3108f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), 3118f1509bcSBarry Smith DMGetISColoringType() 3128f1509bcSBarry Smith @*/ 3138f1509bcSBarry Smith PetscErrorCode DMSetISColoringType(DM dm,ISColoringType ctype) 3148f1509bcSBarry Smith { 3158f1509bcSBarry Smith PetscFunctionBegin; 3168f1509bcSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3178f1509bcSBarry Smith dm->coloringtype = ctype; 3188f1509bcSBarry Smith PetscFunctionReturn(0); 3198f1509bcSBarry Smith } 3208f1509bcSBarry Smith 3218f1509bcSBarry Smith /*@C 3228f1509bcSBarry Smith DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM 323521d9a4cSLisandro Dalcin 324d083f849SBarry Smith Logically Collective on dm 325521d9a4cSLisandro Dalcin 326521d9a4cSLisandro Dalcin Input Parameter: 3278f1509bcSBarry Smith . dm - the DM context 3288f1509bcSBarry Smith 3298f1509bcSBarry Smith Output Parameter: 3308f1509bcSBarry Smith . ctype - the matrix type 3318f1509bcSBarry Smith 3328f1509bcSBarry Smith Options Database: 3338f1509bcSBarry Smith . -dm_is_coloring_type - global or local 3348f1509bcSBarry Smith 3358f1509bcSBarry Smith Level: intermediate 3368f1509bcSBarry Smith 3378f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), 3388f1509bcSBarry Smith DMGetISColoringType() 3398f1509bcSBarry Smith @*/ 3408f1509bcSBarry Smith PetscErrorCode DMGetISColoringType(DM dm,ISColoringType *ctype) 3418f1509bcSBarry Smith { 3428f1509bcSBarry Smith PetscFunctionBegin; 3438f1509bcSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3448f1509bcSBarry Smith *ctype = dm->coloringtype; 3458f1509bcSBarry Smith PetscFunctionReturn(0); 3468f1509bcSBarry Smith } 3478f1509bcSBarry Smith 3488f1509bcSBarry Smith /*@C 3498f1509bcSBarry Smith DMSetMatType - Sets the type of matrix created with DMCreateMatrix() 3508f1509bcSBarry Smith 351d083f849SBarry Smith Logically Collective on dm 3528f1509bcSBarry Smith 3538f1509bcSBarry Smith Input Parameters: 354521d9a4cSLisandro Dalcin + dm - the DM context 355a2b5a043SBarry Smith - ctype - the matrix type 356521d9a4cSLisandro Dalcin 357521d9a4cSLisandro Dalcin Options Database: 358521d9a4cSLisandro Dalcin . -dm_mat_type ctype 359521d9a4cSLisandro Dalcin 360521d9a4cSLisandro Dalcin Level: intermediate 361521d9a4cSLisandro Dalcin 362a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType() 363521d9a4cSLisandro Dalcin @*/ 36419fd82e9SBarry Smith PetscErrorCode DMSetMatType(DM dm,MatType ctype) 365521d9a4cSLisandro Dalcin { 366521d9a4cSLisandro Dalcin PetscErrorCode ierr; 36788f0584fSBarry Smith 368521d9a4cSLisandro Dalcin PetscFunctionBegin; 369521d9a4cSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 370521d9a4cSLisandro Dalcin ierr = PetscFree(dm->mattype);CHKERRQ(ierr); 37119fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr); 372521d9a4cSLisandro Dalcin PetscFunctionReturn(0); 373521d9a4cSLisandro Dalcin } 374521d9a4cSLisandro Dalcin 375c0dedaeaSBarry Smith /*@C 376c0dedaeaSBarry Smith DMGetMatType - Gets the type of matrix created with DMCreateMatrix() 377c0dedaeaSBarry Smith 378d083f849SBarry Smith Logically Collective on dm 379c0dedaeaSBarry Smith 380c0dedaeaSBarry Smith Input Parameter: 381c0dedaeaSBarry Smith . dm - the DM context 382c0dedaeaSBarry Smith 383c0dedaeaSBarry Smith Output Parameter: 384c0dedaeaSBarry Smith . ctype - the matrix type 385c0dedaeaSBarry Smith 386c0dedaeaSBarry Smith Options Database: 387c0dedaeaSBarry Smith . -dm_mat_type ctype 388c0dedaeaSBarry Smith 389c0dedaeaSBarry Smith Level: intermediate 390c0dedaeaSBarry Smith 391a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType() 392c0dedaeaSBarry Smith @*/ 393c0dedaeaSBarry Smith PetscErrorCode DMGetMatType(DM dm,MatType *ctype) 394c0dedaeaSBarry Smith { 395c0dedaeaSBarry Smith PetscFunctionBegin; 396c0dedaeaSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 397c0dedaeaSBarry Smith *ctype = dm->mattype; 398c0dedaeaSBarry Smith PetscFunctionReturn(0); 399c0dedaeaSBarry Smith } 400c0dedaeaSBarry Smith 401c688c046SMatthew G Knepley /*@ 40234f98d34SBarry Smith MatGetDM - Gets the DM defining the data layout of the matrix 403c688c046SMatthew G Knepley 404c688c046SMatthew G Knepley Not collective 405c688c046SMatthew G Knepley 406c688c046SMatthew G Knepley Input Parameter: 407c688c046SMatthew G Knepley . A - The Mat 408c688c046SMatthew G Knepley 409c688c046SMatthew G Knepley Output Parameter: 410c688c046SMatthew G Knepley . dm - The DM 411c688c046SMatthew G Knepley 412c688c046SMatthew G Knepley Level: intermediate 413c688c046SMatthew G Knepley 4148f1509bcSBarry Smith Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with 4158f1509bcSBarry Smith the Mat through a PetscObjectCompose() operation 4168f1509bcSBarry Smith 417c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType() 418c688c046SMatthew G Knepley @*/ 419c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm) 420c688c046SMatthew G Knepley { 421c688c046SMatthew G Knepley PetscErrorCode ierr; 422c688c046SMatthew G Knepley 423c688c046SMatthew G Knepley PetscFunctionBegin; 424c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 425c688c046SMatthew G Knepley PetscValidPointer(dm,2); 426c688c046SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 427c688c046SMatthew G Knepley PetscFunctionReturn(0); 428c688c046SMatthew G Knepley } 429c688c046SMatthew G Knepley 430c688c046SMatthew G Knepley /*@ 431c688c046SMatthew G Knepley MatSetDM - Sets the DM defining the data layout of the matrix 432c688c046SMatthew G Knepley 433c688c046SMatthew G Knepley Not collective 434c688c046SMatthew G Knepley 435c688c046SMatthew G Knepley Input Parameters: 436c688c046SMatthew G Knepley + A - The Mat 437c688c046SMatthew G Knepley - dm - The DM 438c688c046SMatthew G Knepley 439c688c046SMatthew G Knepley Level: intermediate 440c688c046SMatthew G Knepley 4418f1509bcSBarry Smith Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with 4428f1509bcSBarry Smith the Mat through a PetscObjectCompose() operation 4438f1509bcSBarry Smith 4448f1509bcSBarry Smith 445c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType() 446c688c046SMatthew G Knepley @*/ 447c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm) 448c688c046SMatthew G Knepley { 449c688c046SMatthew G Knepley PetscErrorCode ierr; 450c688c046SMatthew G Knepley 451c688c046SMatthew G Knepley PetscFunctionBegin; 452c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 4538865f1eaSKarl Rupp if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 454c688c046SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 455c688c046SMatthew G Knepley PetscFunctionReturn(0); 456c688c046SMatthew G Knepley } 457c688c046SMatthew G Knepley 4589a42bb27SBarry Smith /*@C 4599a42bb27SBarry Smith DMSetOptionsPrefix - Sets the prefix used for searching for all 4606757b960SDave May DM options in the database. 4619a42bb27SBarry Smith 462d083f849SBarry Smith Logically Collective on dm 4639a42bb27SBarry Smith 4649a42bb27SBarry Smith Input Parameter: 4658353ddbbSDave May + da - the DM context 4669a42bb27SBarry Smith - prefix - the prefix to prepend to all option names 4679a42bb27SBarry Smith 4689a42bb27SBarry Smith Notes: 4699a42bb27SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4709a42bb27SBarry Smith The first character of all runtime options is AUTOMATICALLY the hyphen. 4719a42bb27SBarry Smith 4729a42bb27SBarry Smith Level: advanced 4739a42bb27SBarry Smith 4749a42bb27SBarry Smith .seealso: DMSetFromOptions() 4759a42bb27SBarry Smith @*/ 4767087cfbeSBarry Smith PetscErrorCode DMSetOptionsPrefix(DM dm,const char prefix[]) 4779a42bb27SBarry Smith { 4789a42bb27SBarry Smith PetscErrorCode ierr; 4799a42bb27SBarry Smith 4809a42bb27SBarry Smith PetscFunctionBegin; 4819a42bb27SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4829a42bb27SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 483691be533SLawrence Mitchell if (dm->sf) { 484691be533SLawrence Mitchell ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr); 485691be533SLawrence Mitchell } 4861bb6d2a8SBarry Smith if (dm->sectionSF) { 4871bb6d2a8SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr); 488691be533SLawrence Mitchell } 4899a42bb27SBarry Smith PetscFunctionReturn(0); 4909a42bb27SBarry Smith } 4919a42bb27SBarry Smith 49231697293SDave May /*@C 49331697293SDave May DMAppendOptionsPrefix - Appends to the prefix used for searching for all 49431697293SDave May DM options in the database. 49531697293SDave May 496d083f849SBarry Smith Logically Collective on dm 49731697293SDave May 49831697293SDave May Input Parameters: 49931697293SDave May + dm - the DM context 50031697293SDave May - prefix - the prefix string to prepend to all DM option requests 50131697293SDave May 50231697293SDave May Notes: 50331697293SDave May A hyphen (-) must NOT be given at the beginning of the prefix name. 50431697293SDave May The first character of all runtime options is AUTOMATICALLY the hyphen. 50531697293SDave May 50631697293SDave May Level: advanced 50731697293SDave May 50831697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix() 50931697293SDave May @*/ 51031697293SDave May PetscErrorCode DMAppendOptionsPrefix(DM dm,const char prefix[]) 51131697293SDave May { 51231697293SDave May PetscErrorCode ierr; 51331697293SDave May 51431697293SDave May PetscFunctionBegin; 51531697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 51631697293SDave May ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 51731697293SDave May PetscFunctionReturn(0); 51831697293SDave May } 51931697293SDave May 52031697293SDave May /*@C 52131697293SDave May DMGetOptionsPrefix - Gets the prefix used for searching for all 52231697293SDave May DM options in the database. 52331697293SDave May 52431697293SDave May Not Collective 52531697293SDave May 52631697293SDave May Input Parameters: 52731697293SDave May . dm - the DM context 52831697293SDave May 52931697293SDave May Output Parameters: 53031697293SDave May . prefix - pointer to the prefix string used is returned 53131697293SDave May 53295452b02SPatrick Sanan Notes: 53395452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prefix' of 53431697293SDave May sufficient length to hold the prefix. 53531697293SDave May 53631697293SDave May Level: advanced 53731697293SDave May 53831697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix() 53931697293SDave May @*/ 54031697293SDave May PetscErrorCode DMGetOptionsPrefix(DM dm,const char *prefix[]) 54131697293SDave May { 54231697293SDave May PetscErrorCode ierr; 54331697293SDave May 54431697293SDave May PetscFunctionBegin; 54531697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 54631697293SDave May ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 54731697293SDave May PetscFunctionReturn(0); 54831697293SDave May } 54931697293SDave May 55088bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct) 55188bdff64SToby Isaac { 5526eb26441SStefano Zampini PetscInt refct = ((PetscObject) dm)->refct; 55388bdff64SToby Isaac PetscErrorCode ierr; 55488bdff64SToby Isaac 55588bdff64SToby Isaac PetscFunctionBegin; 556aab5bcd8SJed Brown *ncrefct = 0; 55788bdff64SToby Isaac if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) { 55888bdff64SToby Isaac refct--; 55988bdff64SToby Isaac if (recurseCoarse) { 56088bdff64SToby Isaac PetscInt coarseCount; 56188bdff64SToby Isaac 56288bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr); 56388bdff64SToby Isaac refct += coarseCount; 56488bdff64SToby Isaac } 56588bdff64SToby Isaac } 56688bdff64SToby Isaac if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) { 56788bdff64SToby Isaac refct--; 56888bdff64SToby Isaac if (recurseFine) { 56988bdff64SToby Isaac PetscInt fineCount; 57088bdff64SToby Isaac 57188bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr); 57288bdff64SToby Isaac refct += fineCount; 57388bdff64SToby Isaac } 57488bdff64SToby Isaac } 57588bdff64SToby Isaac *ncrefct = refct; 57688bdff64SToby Isaac PetscFunctionReturn(0); 57788bdff64SToby Isaac } 57888bdff64SToby Isaac 579f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm) 580354557abSToby Isaac { 5815d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 582354557abSToby Isaac PetscErrorCode ierr; 583354557abSToby Isaac 584354557abSToby Isaac PetscFunctionBegin; 585354557abSToby Isaac /* destroy the labels */ 586354557abSToby Isaac while (next) { 587354557abSToby Isaac DMLabelLink tmp = next->next; 588354557abSToby Isaac 5895d80c0bfSVaclav Hapla if (next->label == dm->depthLabel) dm->depthLabel = NULL; 590ba2698f1SMatthew G. Knepley if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL; 591354557abSToby Isaac ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 592354557abSToby Isaac ierr = PetscFree(next);CHKERRQ(ierr); 593354557abSToby Isaac next = tmp; 594354557abSToby Isaac } 5955d80c0bfSVaclav Hapla dm->labels = NULL; 596354557abSToby Isaac PetscFunctionReturn(0); 597354557abSToby Isaac } 598354557abSToby Isaac 5991fb7b255SJunchao Zhang /*@C 6008472ad0fSDave May DMDestroy - Destroys a vector packer or DM. 60147c6ae99SBarry Smith 602d083f849SBarry Smith Collective on dm 60347c6ae99SBarry Smith 60447c6ae99SBarry Smith Input Parameter: 60547c6ae99SBarry Smith . dm - the DM object to destroy 60647c6ae99SBarry Smith 60747c6ae99SBarry Smith Level: developer 60847c6ae99SBarry Smith 609e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 61047c6ae99SBarry Smith 61147c6ae99SBarry Smith @*/ 612fcfd50ebSBarry Smith PetscErrorCode DMDestroy(DM *dm) 61347c6ae99SBarry Smith { 6146eb26441SStefano Zampini PetscInt cnt; 615dfe15315SJed Brown DMNamedVecLink nlink,nnext; 61647c6ae99SBarry Smith PetscErrorCode ierr; 61747c6ae99SBarry Smith 61847c6ae99SBarry Smith PetscFunctionBegin; 6196bf464f9SBarry Smith if (!*dm) PetscFunctionReturn(0); 6206bf464f9SBarry Smith PetscValidHeaderSpecific((*dm),DM_CLASSID,1); 62187e657c6SBarry Smith 62288bdff64SToby Isaac /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */ 62388bdff64SToby Isaac ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr); 62488bdff64SToby Isaac --((PetscObject)(*dm))->refct; 625ea78f98cSLisandro Dalcin if (--cnt > 0) {*dm = NULL; PetscFunctionReturn(0);} 6266bf464f9SBarry Smith if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0); 6276bf464f9SBarry Smith ((PetscObject)(*dm))->refct = 0; 6286eb26441SStefano Zampini 6296eb26441SStefano Zampini ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr); 6306eb26441SStefano Zampini ierr = DMClearLocalVectors(*dm);CHKERRQ(ierr); 6316eb26441SStefano Zampini 632f490541aSPeter Brune nnext=(*dm)->namedglobal; 6330298fd71SBarry Smith (*dm)->namedglobal = NULL; 634f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */ 6352348bcf4SPeter Brune nnext = nlink->next; 6362348bcf4SPeter Brune if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name); 6372348bcf4SPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 6382348bcf4SPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 6392348bcf4SPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 6402348bcf4SPeter Brune } 641f490541aSPeter Brune nnext=(*dm)->namedlocal; 6420298fd71SBarry Smith (*dm)->namedlocal = NULL; 643f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */ 644f490541aSPeter Brune nnext = nlink->next; 645f490541aSPeter Brune if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name); 646f490541aSPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 647f490541aSPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 648f490541aSPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 649f490541aSPeter Brune } 6502348bcf4SPeter Brune 651b17ce1afSJed Brown /* Destroy the list of hooks */ 652c833c3b5SJed Brown { 653c833c3b5SJed Brown DMCoarsenHookLink link,next; 654b17ce1afSJed Brown for (link=(*dm)->coarsenhook; link; link=next) { 655b17ce1afSJed Brown next = link->next; 656b17ce1afSJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 657b17ce1afSJed Brown } 6580298fd71SBarry Smith (*dm)->coarsenhook = NULL; 659c833c3b5SJed Brown } 660c833c3b5SJed Brown { 661c833c3b5SJed Brown DMRefineHookLink link,next; 662c833c3b5SJed Brown for (link=(*dm)->refinehook; link; link=next) { 663c833c3b5SJed Brown next = link->next; 664c833c3b5SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 665c833c3b5SJed Brown } 6660298fd71SBarry Smith (*dm)->refinehook = NULL; 667c833c3b5SJed Brown } 668be081cd6SPeter Brune { 669be081cd6SPeter Brune DMSubDomainHookLink link,next; 670be081cd6SPeter Brune for (link=(*dm)->subdomainhook; link; link=next) { 671be081cd6SPeter Brune next = link->next; 672be081cd6SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 673be081cd6SPeter Brune } 6740298fd71SBarry Smith (*dm)->subdomainhook = NULL; 675be081cd6SPeter Brune } 676baf369e7SPeter Brune { 677baf369e7SPeter Brune DMGlobalToLocalHookLink link,next; 678baf369e7SPeter Brune for (link=(*dm)->gtolhook; link; link=next) { 679baf369e7SPeter Brune next = link->next; 680baf369e7SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 681baf369e7SPeter Brune } 6820298fd71SBarry Smith (*dm)->gtolhook = NULL; 683baf369e7SPeter Brune } 684d4d07f1eSToby Isaac { 685d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,next; 686d4d07f1eSToby Isaac for (link=(*dm)->ltoghook; link; link=next) { 687d4d07f1eSToby Isaac next = link->next; 688d4d07f1eSToby Isaac ierr = PetscFree(link);CHKERRQ(ierr); 689d4d07f1eSToby Isaac } 690d4d07f1eSToby Isaac (*dm)->ltoghook = NULL; 691d4d07f1eSToby Isaac } 692aa1993deSMatthew G Knepley /* Destroy the work arrays */ 693aa1993deSMatthew G Knepley { 694aa1993deSMatthew G Knepley DMWorkLink link,next; 695aa1993deSMatthew G Knepley if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out"); 696aa1993deSMatthew G Knepley for (link=(*dm)->workin; link; link=next) { 697aa1993deSMatthew G Knepley next = link->next; 698aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 699aa1993deSMatthew G Knepley ierr = PetscFree(link);CHKERRQ(ierr); 700aa1993deSMatthew G Knepley } 7010298fd71SBarry Smith (*dm)->workin = NULL; 702aa1993deSMatthew G Knepley } 703c58f1c22SToby Isaac /* destroy the labels */ 704f4cdcedcSVaclav Hapla ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr); 705f4cdcedcSVaclav Hapla /* destroy the fields */ 706e5e52638SMatthew G. Knepley ierr = DMClearFields(*dm);CHKERRQ(ierr); 707f4cdcedcSVaclav Hapla /* destroy the boundaries */ 708e6f8dbb6SToby Isaac { 709e6f8dbb6SToby Isaac DMBoundary next = (*dm)->boundary; 710e6f8dbb6SToby Isaac while (next) { 711e6f8dbb6SToby Isaac DMBoundary b = next; 712e6f8dbb6SToby Isaac 713e6f8dbb6SToby Isaac next = b->next; 714e6f8dbb6SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 715e6f8dbb6SToby Isaac } 716e6f8dbb6SToby Isaac } 717b17ce1afSJed Brown 71852536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr); 71952536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr); 72052536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr); 72152536dc3SBarry Smith 7221a266240SBarry Smith if ((*dm)->ctx && (*dm)->ctxdestroy) { 7231a266240SBarry Smith ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr); 7241a266240SBarry Smith } 72571cd77b2SBarry Smith ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr); 7266bf464f9SBarry Smith ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr); 7276bf464f9SBarry Smith ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr); 728073dac72SJed Brown ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr); 72988ed4aceSMatthew G Knepley 7301bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr); 7311bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr); 7328b1ab98fSJed Brown ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr); 733fba222abSToby Isaac ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr); 734fba222abSToby Isaac ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr); 73588ed4aceSMatthew G Knepley ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr); 7361bb6d2a8SBarry Smith ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr); 737736995cdSBlaise Bourdin if ((*dm)->useNatural) { 738736995cdSBlaise Bourdin if ((*dm)->sfNatural) { 7398e4ac7eaSMatthew G. Knepley ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr); 740736995cdSBlaise Bourdin } 741736995cdSBlaise Bourdin ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr); 742736995cdSBlaise Bourdin } 7439a2a23afSMatthew G. Knepley { 7449a2a23afSMatthew G. Knepley Vec *auxData; 7459a2a23afSMatthew G. Knepley PetscInt n, i, off = 0; 7469a2a23afSMatthew G. Knepley 7479a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetSize((*dm)->auxData, &n);CHKERRQ(ierr); 7489a2a23afSMatthew G. Knepley ierr = PetscMalloc1(n, &auxData);CHKERRQ(ierr); 7499a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetVals((*dm)->auxData, &off, auxData);CHKERRQ(ierr); 7509a2a23afSMatthew G. Knepley for (i = 0; i < n; ++i) {ierr = VecDestroy(&auxData[i]);CHKERRQ(ierr);} 7519a2a23afSMatthew G. Knepley ierr = PetscFree(auxData);CHKERRQ(ierr); 7529a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDestroy(&(*dm)->auxData);CHKERRQ(ierr); 7539a2a23afSMatthew G. Knepley } 75488bdff64SToby Isaac if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) { 75588bdff64SToby Isaac ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr); 75688bdff64SToby Isaac } 7576eb26441SStefano Zampini 758a8fb8f29SToby Isaac ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr); 75988bdff64SToby Isaac if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) { 76088bdff64SToby Isaac ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr); 76188bdff64SToby Isaac } 76288bdff64SToby Isaac ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr); 763f19dbd58SToby Isaac ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr); 7646636e97aSMatthew G Knepley ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr); 7656636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr); 7666636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr); 767412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->L);CHKERRQ(ierr); 768412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->maxCell);CHKERRQ(ierr); 769412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->bdtype);CHKERRQ(ierr); 770ca3d3a14SMatthew G. Knepley if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);} 771ca3d3a14SMatthew G. Knepley ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr); 772ca3d3a14SMatthew G. Knepley ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr); 7736636e97aSMatthew G Knepley 774e5e52638SMatthew G. Knepley ierr = DMClearDS(*dm);CHKERRQ(ierr); 77514f150ffSMatthew G. Knepley ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr); 776e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 777e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr); 778732e2eb9SMatthew G Knepley 779ed3c66a1SDave May if ((*dm)->ops->destroy) { 7806bf464f9SBarry Smith ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr); 781ed3c66a1SDave May } 782c0f0dcc3SMatthew G. Knepley ierr = DMMonitorCancel(*dm);CHKERRQ(ierr); 783*f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 784*f918ec44SMatthew G. Knepley ierr = CeedElemRestrictionDestroy(&(*dm)->ceedERestrict);CHKERRQ(ierr); 785*f918ec44SMatthew G. Knepley ierr = CeedDestroy(&(*dm)->ceed);CHKERRQ(ierr); 786*f918ec44SMatthew G. Knepley #endif 787435a35e8SMatthew G Knepley /* We do not destroy (*dm)->data here so that we can reference count backend objects */ 788732e2eb9SMatthew G Knepley ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr); 78947c6ae99SBarry Smith PetscFunctionReturn(0); 79047c6ae99SBarry Smith } 79147c6ae99SBarry Smith 792d7bf68aeSBarry Smith /*@ 793d7bf68aeSBarry Smith DMSetUp - sets up the data structures inside a DM object 794d7bf68aeSBarry Smith 795d083f849SBarry Smith Collective on dm 796d7bf68aeSBarry Smith 797d7bf68aeSBarry Smith Input Parameter: 798d7bf68aeSBarry Smith . dm - the DM object to setup 799d7bf68aeSBarry Smith 800d7bf68aeSBarry Smith Level: developer 801d7bf68aeSBarry Smith 802e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 803d7bf68aeSBarry Smith 804d7bf68aeSBarry Smith @*/ 8057087cfbeSBarry Smith PetscErrorCode DMSetUp(DM dm) 806d7bf68aeSBarry Smith { 807d7bf68aeSBarry Smith PetscErrorCode ierr; 808d7bf68aeSBarry Smith 809d7bf68aeSBarry Smith PetscFunctionBegin; 810171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8118387afaaSJed Brown if (dm->setupcalled) PetscFunctionReturn(0); 812d7bf68aeSBarry Smith if (dm->ops->setup) { 813d7bf68aeSBarry Smith ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr); 814d7bf68aeSBarry Smith } 8158387afaaSJed Brown dm->setupcalled = PETSC_TRUE; 816d7bf68aeSBarry Smith PetscFunctionReturn(0); 817d7bf68aeSBarry Smith } 818d7bf68aeSBarry Smith 819d7bf68aeSBarry Smith /*@ 820d7bf68aeSBarry Smith DMSetFromOptions - sets parameters in a DM from the options database 821d7bf68aeSBarry Smith 822d083f849SBarry Smith Collective on dm 823d7bf68aeSBarry Smith 824d7bf68aeSBarry Smith Input Parameter: 825d7bf68aeSBarry Smith . dm - the DM object to set options for 826d7bf68aeSBarry Smith 827732e2eb9SMatthew G Knepley Options Database: 8284164ae61SDominic Meiser + -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 8294164ae61SDominic Meiser . -dm_vec_type <type> - type of vector to create inside DM 8304164ae61SDominic Meiser . -dm_mat_type <type> - type of matrix to create inside DM 8318f1509bcSBarry Smith - -dm_is_coloring_type - <global or local> 832732e2eb9SMatthew G Knepley 8339318fe57SMatthew G. Knepley DMPLEX Specific creation options 8349318fe57SMatthew G. Knepley + -dm_plex_filename <str> - File containing a mesh 8359318fe57SMatthew G. Knepley . -dm_plex_boundary_filename <str> - File containing a mesh boundary 8369318fe57SMatthew G. Knepley . -dm_plex_shape <shape> - The domain shape, such as DM_SHAPE_BOX, DM_SHAPE_SPHERE, etc. 8379318fe57SMatthew G. Knepley . -dm_plex_cell <ct> - Cell shape 8389318fe57SMatthew G. Knepley . -dm_plex_reference_cell_domain <bool> - Use a reference cell domain 8399318fe57SMatthew G. Knepley . -dm_plex_dim <dim> - Set the topological dimension 8409318fe57SMatthew G. Knepley . -dm_plex_simplex <bool> - PETSC_TRUE for simplex elements, PETSC_FALSE for tensor elements 8419318fe57SMatthew G. Knepley . -dm_plex_interpolate <bool> - PETSC_TRUE turns on topological interpolation (creating edges and faces) 8429318fe57SMatthew G. Knepley . -dm_plex_scale <sc> - Scale factor for mesh coordinates 8439318fe57SMatthew G. Knepley . -dm_plex_box_faces <m,n,p> - Number of faces along each dimension 8449318fe57SMatthew G. Knepley . -dm_plex_box_lower <x,y,z> - Specify lower-left-bottom coordinates for the box 8459318fe57SMatthew G. Knepley . -dm_plex_box_upper <x,y,z> - Specify upper-right-top coordinates for the box 8469318fe57SMatthew G. Knepley . -dm_plex_box_bd <bx,by,bz> - Specify the DMBoundaryType for each direction 8479318fe57SMatthew G. Knepley . -dm_plex_sphere_radius <r> - The sphere radius 8489318fe57SMatthew G. Knepley . -dm_plex_ball_radius <r> - Radius of the ball 8499318fe57SMatthew G. Knepley . -dm_plex_cylinder_bd <bz> - Boundary type in the z direction 8509318fe57SMatthew G. Knepley . -dm_plex_cylinder_num_wedges <n> - Number of wedges around the cylinder 8519318fe57SMatthew G. Knepley . -dm_refine_pre <n> - The number of refinements before distribution 8529318fe57SMatthew G. Knepley . -dm_refine_uniform_pre <bool> - Flag for uniform refinement before distribution 8539318fe57SMatthew G. Knepley . -dm_refine_volume_limit_pre <v> - The maximum cell volume after refinement before distribution 8549318fe57SMatthew G. Knepley . -dm_refine <n> - The number of refinements after distribution 8559318fe57SMatthew G. Knepley . -dm_extrude_layers <l> - The number of layers to extrude 8569318fe57SMatthew G. Knepley . -dm_extrude_thickness <t> - The thickness of the layer to be extruded 8579318fe57SMatthew G. Knepley . -dm_extrude_column_first <bool> - Order the cells in a vertical column first 8589318fe57SMatthew G. Knepley . -dm_distribute <bool> - Flag to redistribute a mesh among processes 8599318fe57SMatthew G. Knepley . -dm_distribute_overlap <n> - The size of the overlap halo 8609318fe57SMatthew G. Knepley . -dm_plex_adj_cone <bool> - Set adjacency direction 8619318fe57SMatthew G. Knepley - -dm_plex_adj_closure <bool> - Set adjacency size 8629318fe57SMatthew G. Knepley 863384a6580SVaclav Hapla DMPLEX Specific Checks 864384a6580SVaclav Hapla + -dm_plex_check_symmetry - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry() 865384a6580SVaclav Hapla . -dm_plex_check_skeleton - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton() 866384a6580SVaclav 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() 867384a6580SVaclav Hapla . -dm_plex_check_geometry - Check that cells have positive volume - DMPlexCheckGeometry() 868384a6580SVaclav Hapla . -dm_plex_check_pointsf - Check some necessary conditions for PointSF - DMPlexCheckPointSF() 869384a6580SVaclav Hapla . -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones() 870384a6580SVaclav Hapla - -dm_plex_check_all - Perform all the checks above 871d7bf68aeSBarry Smith 87295eb5ee5SVaclav Hapla Level: intermediate 87395eb5ee5SVaclav Hapla 87495eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), 87595eb5ee5SVaclav Hapla DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones() 876d7bf68aeSBarry Smith 877d7bf68aeSBarry Smith @*/ 8787087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm) 879d7bf68aeSBarry Smith { 8807781c08eSBarry Smith char typeName[256]; 881ca266f36SBarry Smith PetscBool flg; 882d7bf68aeSBarry Smith PetscErrorCode ierr; 883d7bf68aeSBarry Smith 884d7bf68aeSBarry Smith PetscFunctionBegin; 885171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 88649be4549SMatthew G. Knepley dm->setfromoptionscalled = PETSC_TRUE; 88749be4549SMatthew G. Knepley if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);} 8881bb6d2a8SBarry Smith if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);} 8893194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr); 8900298fd71SBarry 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); 891a264d7a6SBarry Smith ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr); 892f9ba7244SBarry Smith if (flg) { 893f9ba7244SBarry Smith ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr); 894f9ba7244SBarry Smith } 895a264d7a6SBarry 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); 896073dac72SJed Brown if (flg) { 897521d9a4cSLisandro Dalcin ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr); 898073dac72SJed Brown } 8998f1509bcSBarry Smith ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr); 900f9ba7244SBarry Smith if (dm->ops->setfromoptions) { 901e55864a3SBarry Smith ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr); 902f9ba7244SBarry Smith } 903f9ba7244SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 9040633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr); 90582fcb398SMatthew G Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 906d7bf68aeSBarry Smith PetscFunctionReturn(0); 907d7bf68aeSBarry Smith } 908d7bf68aeSBarry Smith 909fc9bc008SSatish Balay /*@C 910fe2efc57SMark DMViewFromOptions - View from Options 911fe2efc57SMark 912fe2efc57SMark Collective on DM 913fe2efc57SMark 914fe2efc57SMark Input Parameters: 915fe2efc57SMark + dm - the DM object 916736c3998SJose E. Roman . obj - Optional object 917736c3998SJose E. Roman - name - command line option 918fe2efc57SMark 919fe2efc57SMark Level: intermediate 920fe2efc57SMark .seealso: DM, DMView, PetscObjectViewFromOptions(), DMCreate() 921fe2efc57SMark @*/ 922fe2efc57SMark PetscErrorCode DMViewFromOptions(DM dm,PetscObject obj,const char name[]) 923fe2efc57SMark { 924fe2efc57SMark PetscErrorCode ierr; 925fe2efc57SMark 926fe2efc57SMark PetscFunctionBegin; 927fe2efc57SMark PetscValidHeaderSpecific(dm,DM_CLASSID,1); 928fe2efc57SMark ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr); 929fe2efc57SMark PetscFunctionReturn(0); 930fe2efc57SMark } 931fe2efc57SMark 932fe2efc57SMark /*@C 933224748a4SBarry Smith DMView - Views a DM 93447c6ae99SBarry Smith 935d083f849SBarry Smith Collective on dm 93647c6ae99SBarry Smith 93747c6ae99SBarry Smith Input Parameter: 93847c6ae99SBarry Smith + dm - the DM object to view 93947c6ae99SBarry Smith - v - the viewer 94047c6ae99SBarry Smith 941224748a4SBarry Smith Level: beginner 94247c6ae99SBarry Smith 943e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 94447c6ae99SBarry Smith 94547c6ae99SBarry Smith @*/ 9467087cfbeSBarry Smith PetscErrorCode DMView(DM dm,PetscViewer v) 94747c6ae99SBarry Smith { 94847c6ae99SBarry Smith PetscErrorCode ierr; 94932c0f0efSBarry Smith PetscBool isbinary; 95076a8abe0SBarry Smith PetscMPIInt size; 95176a8abe0SBarry Smith PetscViewerFormat format; 95247c6ae99SBarry Smith 95347c6ae99SBarry Smith PetscFunctionBegin; 954171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9553014e516SBarry Smith if (!v) { 956ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr); 9573014e516SBarry Smith } 958b1b135c8SBarry Smith PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2); 95974903a4fSStefano Zampini /* Ideally, we would like to have this test on. 96074903a4fSStefano Zampini However, it currently breaks socket viz via GLVis. 96174903a4fSStefano Zampini During DMView(parallel_mesh,glvis_viewer), each 96274903a4fSStefano Zampini process opens a sequential ASCII socket to visualize 96374903a4fSStefano Zampini the local mesh, and PetscObjectView(dm,local_socket) 96474903a4fSStefano Zampini is internally called inside VecView_GLVis, incurring 96574903a4fSStefano Zampini in an error here */ 96674903a4fSStefano Zampini /* PetscCheckSameComm(dm,1,v,2); */ 9678bfd1ab9SVaclav Hapla ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr); 968b1b135c8SBarry Smith 96976a8abe0SBarry Smith ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr); 970ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRMPI(ierr); 97176a8abe0SBarry Smith if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0); 97298c3331eSBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr); 97332c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 97432c0f0efSBarry Smith if (isbinary) { 97555849f57SBarry Smith PetscInt classid = DM_FILE_CLASSID; 97632c0f0efSBarry Smith char type[256]; 97732c0f0efSBarry Smith 978f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr); 97932c0f0efSBarry Smith ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr); 980f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr); 98132c0f0efSBarry Smith } 9820c010503SBarry Smith if (dm->ops->view) { 9830c010503SBarry Smith ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr); 98447c6ae99SBarry Smith } 98547c6ae99SBarry Smith PetscFunctionReturn(0); 98647c6ae99SBarry Smith } 98747c6ae99SBarry Smith 98847c6ae99SBarry Smith /*@ 9898472ad0fSDave May DMCreateGlobalVector - Creates a global vector from a DM object 99047c6ae99SBarry Smith 991d083f849SBarry Smith Collective on dm 99247c6ae99SBarry Smith 99347c6ae99SBarry Smith Input Parameter: 99447c6ae99SBarry Smith . dm - the DM object 99547c6ae99SBarry Smith 99647c6ae99SBarry Smith Output Parameter: 99747c6ae99SBarry Smith . vec - the global vector 99847c6ae99SBarry Smith 999073dac72SJed Brown Level: beginner 100047c6ae99SBarry Smith 1001ec075b9fSPatrick Sanan .seealso DMCreateLocalVector(), DMGetGlobalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 100247c6ae99SBarry Smith 100347c6ae99SBarry Smith @*/ 10047087cfbeSBarry Smith PetscErrorCode DMCreateGlobalVector(DM dm,Vec *vec) 100547c6ae99SBarry Smith { 100647c6ae99SBarry Smith PetscErrorCode ierr; 100747c6ae99SBarry Smith 100847c6ae99SBarry Smith PetscFunctionBegin; 1009171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1010b9d85ea2SLisandro Dalcin PetscValidPointer(vec,2); 1011b9d85ea2SLisandro Dalcin if (!dm->ops->createglobalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name); 101247c6ae99SBarry Smith ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr); 101376bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1014c6b011d8SStefano Zampini DM vdm; 1015c6b011d8SStefano Zampini 1016c6b011d8SStefano Zampini ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr); 1017c6b011d8SStefano Zampini if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name); 1018c6b011d8SStefano Zampini } 101947c6ae99SBarry Smith PetscFunctionReturn(0); 102047c6ae99SBarry Smith } 102147c6ae99SBarry Smith 102247c6ae99SBarry Smith /*@ 10238472ad0fSDave May DMCreateLocalVector - Creates a local vector from a DM object 102447c6ae99SBarry Smith 102547c6ae99SBarry Smith Not Collective 102647c6ae99SBarry Smith 102747c6ae99SBarry Smith Input Parameter: 102847c6ae99SBarry Smith . dm - the DM object 102947c6ae99SBarry Smith 103047c6ae99SBarry Smith Output Parameter: 103147c6ae99SBarry Smith . vec - the local vector 103247c6ae99SBarry Smith 1033073dac72SJed Brown Level: beginner 103447c6ae99SBarry Smith 1035ec075b9fSPatrick Sanan .seealso DMCreateGlobalVector(), DMGetLocalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 103647c6ae99SBarry Smith 103747c6ae99SBarry Smith @*/ 10387087cfbeSBarry Smith PetscErrorCode DMCreateLocalVector(DM dm,Vec *vec) 103947c6ae99SBarry Smith { 104047c6ae99SBarry Smith PetscErrorCode ierr; 104147c6ae99SBarry Smith 104247c6ae99SBarry Smith PetscFunctionBegin; 1043171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1044b9d85ea2SLisandro Dalcin PetscValidPointer(vec,2); 1045b9d85ea2SLisandro Dalcin if (!dm->ops->createlocalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name); 104647c6ae99SBarry Smith ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr); 104776bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1048c6b011d8SStefano Zampini DM vdm; 1049c6b011d8SStefano Zampini 1050c6b011d8SStefano Zampini ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr); 1051c6b011d8SStefano Zampini if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name); 1052c6b011d8SStefano Zampini } 105347c6ae99SBarry Smith PetscFunctionReturn(0); 105447c6ae99SBarry Smith } 105547c6ae99SBarry Smith 10561411c6eeSJed Brown /*@ 10571411c6eeSJed Brown DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM. 10581411c6eeSJed Brown 1059d083f849SBarry Smith Collective on dm 10601411c6eeSJed Brown 10611411c6eeSJed Brown Input Parameter: 10621411c6eeSJed Brown . dm - the DM that provides the mapping 10631411c6eeSJed Brown 10641411c6eeSJed Brown Output Parameter: 10651411c6eeSJed Brown . ltog - the mapping 10661411c6eeSJed Brown 10671411c6eeSJed Brown Level: intermediate 10681411c6eeSJed Brown 10691411c6eeSJed Brown Notes: 10701411c6eeSJed Brown This mapping can then be used by VecSetLocalToGlobalMapping() or 10711411c6eeSJed Brown MatSetLocalToGlobalMapping(). 10721411c6eeSJed Brown 1073fc31e74dSBarry Smith .seealso: DMCreateLocalVector() 10741411c6eeSJed Brown @*/ 10757087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog) 10761411c6eeSJed Brown { 10770be3e97aSMatthew G. Knepley PetscInt bs = -1, bsLocal[2], bsMinMax[2]; 10781411c6eeSJed Brown PetscErrorCode ierr; 10791411c6eeSJed Brown 10801411c6eeSJed Brown PetscFunctionBegin; 10811411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 10821411c6eeSJed Brown PetscValidPointer(ltog,2); 10831411c6eeSJed Brown if (!dm->ltogmap) { 108437d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 108537d0c07bSMatthew G Knepley 108692fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 108737d0c07bSMatthew G Knepley if (section) { 1088a974ec88SMatthew G. Knepley const PetscInt *cdofs; 108937d0c07bSMatthew G Knepley PetscInt *ltog; 1090ccf3bd66SMatthew G. Knepley PetscInt pStart, pEnd, n, p, k, l; 109137d0c07bSMatthew G Knepley 1092e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 109337d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 1094ccf3bd66SMatthew G. Knepley ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr); 1095ccf3bd66SMatthew G. Knepley ierr = PetscMalloc1(n, <og);CHKERRQ(ierr); /* We want the local+overlap size */ 109637d0c07bSMatthew G Knepley for (p = pStart, l = 0; p < pEnd; ++p) { 1097a974ec88SMatthew G. Knepley PetscInt bdof, cdof, dof, off, c, cind = 0; 109837d0c07bSMatthew G Knepley 109937d0c07bSMatthew G Knepley /* Should probably use constrained dofs */ 110037d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr); 1101a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr); 1102a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr); 110337d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr); 11041a7dc684SMatthew G. Knepley /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */ 11051a7dc684SMatthew G. Knepley bdof = cdof && (dof-cdof) ? 1 : dof; 11061a7dc684SMatthew G. Knepley if (dof) { 1107b190aa46SMatthew G. Knepley if (bs < 0) {bs = bdof;} 1108b190aa46SMatthew G. Knepley else if (bs != bdof) {bs = 1;} 11091a7dc684SMatthew G. Knepley } 111037d0c07bSMatthew G Knepley for (c = 0; c < dof; ++c, ++l) { 1111a974ec88SMatthew G. Knepley if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c; 1112a974ec88SMatthew G. Knepley else ltog[l] = (off < 0 ? -(off+1) : off) + c; 111337d0c07bSMatthew G Knepley } 111437d0c07bSMatthew G Knepley } 1115bff27382SMatthew G. Knepley /* Must have same blocksize on all procs (some might have no points) */ 11160be3e97aSMatthew G. Knepley bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs; 11170be3e97aSMatthew G. Knepley ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr); 11180be3e97aSMatthew G. Knepley if (bsMinMax[0] != bsMinMax[1]) {bs = 1;} 11190be3e97aSMatthew G. Knepley else {bs = bsMinMax[0];} 11207591dbb2SMatthew G. Knepley bs = bs < 0 ? 1 : bs; 11217591dbb2SMatthew G. Knepley /* Must reduce indices by blocksize */ 1122ccf3bd66SMatthew G. Knepley if (bs > 1) { 1123ccf3bd66SMatthew G. Knepley for (l = 0, k = 0; l < n; l += bs, ++k) ltog[k] = ltog[l]/bs; 1124ccf3bd66SMatthew G. Knepley n /= bs; 1125ccf3bd66SMatthew G. Knepley } 1126ccf3bd66SMatthew G. Knepley ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr); 11273bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr); 112837d0c07bSMatthew G Knepley } else { 1129b9d85ea2SLisandro Dalcin if (!dm->ops->getlocaltoglobalmapping) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name); 1130184d77edSJed Brown ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr); 11311411c6eeSJed Brown } 113237d0c07bSMatthew G Knepley } 11331411c6eeSJed Brown *ltog = dm->ltogmap; 11341411c6eeSJed Brown PetscFunctionReturn(0); 11351411c6eeSJed Brown } 11361411c6eeSJed Brown 11371411c6eeSJed Brown /*@ 11381411c6eeSJed Brown DMGetBlockSize - Gets the inherent block size associated with a DM 11391411c6eeSJed Brown 11401411c6eeSJed Brown Not Collective 11411411c6eeSJed Brown 11421411c6eeSJed Brown Input Parameter: 11431411c6eeSJed Brown . dm - the DM with block structure 11441411c6eeSJed Brown 11451411c6eeSJed Brown Output Parameter: 11461411c6eeSJed Brown . bs - the block size, 1 implies no exploitable block structure 11471411c6eeSJed Brown 11481411c6eeSJed Brown Level: intermediate 11491411c6eeSJed Brown 1150fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping() 11511411c6eeSJed Brown @*/ 11527087cfbeSBarry Smith PetscErrorCode DMGetBlockSize(DM dm,PetscInt *bs) 11531411c6eeSJed Brown { 11541411c6eeSJed Brown PetscFunctionBegin; 11551411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1156534a8f05SLisandro Dalcin PetscValidIntPointer(bs,2); 11571411c6eeSJed Brown if (dm->bs < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet"); 11581411c6eeSJed Brown *bs = dm->bs; 11591411c6eeSJed Brown PetscFunctionReturn(0); 11601411c6eeSJed Brown } 11611411c6eeSJed Brown 116248eeb7c8SBarry Smith /*@C 11638472ad0fSDave May DMCreateInterpolation - Gets interpolation matrix between two DM objects 116447c6ae99SBarry Smith 1165a5bc1bf3SBarry Smith Collective on dmc 116647c6ae99SBarry Smith 116747c6ae99SBarry Smith Input Parameter: 1168a5bc1bf3SBarry Smith + dmc - the DM object 1169a5bc1bf3SBarry Smith - dmf - the second, finer DM object 117047c6ae99SBarry Smith 117147c6ae99SBarry Smith Output Parameter: 117247c6ae99SBarry Smith + mat - the interpolation 117347c6ae99SBarry Smith - vec - the scaling (optional) 117447c6ae99SBarry Smith 117547c6ae99SBarry Smith Level: developer 117647c6ae99SBarry Smith 117795452b02SPatrick Sanan Notes: 117895452b02SPatrick 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 117985afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 1180d52bd9f3SBarry Smith 11811f588964SMatthew G Knepley For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors 1182d52bd9f3SBarry Smith EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic. 118385afcc9aSBarry Smith 118485afcc9aSBarry Smith 11852ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale() 118647c6ae99SBarry Smith 118747c6ae99SBarry Smith @*/ 1188a5bc1bf3SBarry Smith PetscErrorCode DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec) 118947c6ae99SBarry Smith { 119047c6ae99SBarry Smith PetscErrorCode ierr; 119147c6ae99SBarry Smith 119247c6ae99SBarry Smith PetscFunctionBegin; 1193a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 1194a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 1195c7d20fa0SStefano Zampini PetscValidPointer(mat,3); 1196a5bc1bf3SBarry Smith if (!dmc->ops->createinterpolation) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name); 1197a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr); 1198a5bc1bf3SBarry Smith ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr); 1199a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr); 120047c6ae99SBarry Smith PetscFunctionReturn(0); 120147c6ae99SBarry Smith } 120247c6ae99SBarry Smith 12033ad4599aSBarry Smith /*@ 1204d3e313eaSPatrick Sanan DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction. 12052ed6491fSPatrick Sanan 12062ed6491fSPatrick Sanan Input Parameters: 12072ed6491fSPatrick Sanan + dac - DM that defines a coarse mesh 12082ed6491fSPatrick Sanan . daf - DM that defines a fine mesh 12092ed6491fSPatrick Sanan - mat - the restriction (or interpolation operator) from fine to coarse 12102ed6491fSPatrick Sanan 12112ed6491fSPatrick Sanan Output Parameter: 12122ed6491fSPatrick Sanan . scale - the scaled vector 12132ed6491fSPatrick Sanan 12142ed6491fSPatrick Sanan Level: developer 12152ed6491fSPatrick Sanan 12162ed6491fSPatrick Sanan .seealso: DMCreateInterpolation() 12172ed6491fSPatrick Sanan 12182ed6491fSPatrick Sanan @*/ 12192ed6491fSPatrick Sanan PetscErrorCode DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale) 12202ed6491fSPatrick Sanan { 12212ed6491fSPatrick Sanan PetscErrorCode ierr; 12222ed6491fSPatrick Sanan Vec fine; 12232ed6491fSPatrick Sanan PetscScalar one = 1.0; 12242ed6491fSPatrick Sanan 12252ed6491fSPatrick Sanan PetscFunctionBegin; 12262ed6491fSPatrick Sanan ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr); 12272ed6491fSPatrick Sanan ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr); 12282ed6491fSPatrick Sanan ierr = VecSet(fine,one);CHKERRQ(ierr); 12292ed6491fSPatrick Sanan ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr); 12302ed6491fSPatrick Sanan ierr = VecDestroy(&fine);CHKERRQ(ierr); 12312ed6491fSPatrick Sanan ierr = VecReciprocal(*scale);CHKERRQ(ierr); 12322ed6491fSPatrick Sanan PetscFunctionReturn(0); 12332ed6491fSPatrick Sanan } 12342ed6491fSPatrick Sanan 12352ed6491fSPatrick Sanan /*@ 12363ad4599aSBarry Smith DMCreateRestriction - Gets restriction matrix between two DM objects 12373ad4599aSBarry Smith 1238a5bc1bf3SBarry Smith Collective on dmc 12393ad4599aSBarry Smith 12403ad4599aSBarry Smith Input Parameter: 1241a5bc1bf3SBarry Smith + dmc - the DM object 1242a5bc1bf3SBarry Smith - dmf - the second, finer DM object 12433ad4599aSBarry Smith 12443ad4599aSBarry Smith Output Parameter: 12453ad4599aSBarry Smith . mat - the restriction 12463ad4599aSBarry Smith 12473ad4599aSBarry Smith 12483ad4599aSBarry Smith Level: developer 12493ad4599aSBarry Smith 125095452b02SPatrick Sanan Notes: 125195452b02SPatrick 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 12523ad4599aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 12533ad4599aSBarry Smith 12543ad4599aSBarry Smith 12553ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation() 12563ad4599aSBarry Smith 12573ad4599aSBarry Smith @*/ 1258a5bc1bf3SBarry Smith PetscErrorCode DMCreateRestriction(DM dmc,DM dmf,Mat *mat) 12593ad4599aSBarry Smith { 12603ad4599aSBarry Smith PetscErrorCode ierr; 12613ad4599aSBarry Smith 12623ad4599aSBarry Smith PetscFunctionBegin; 1263a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 1264a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 12655a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1266a5bc1bf3SBarry Smith if (!dmc->ops->createrestriction) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name); 1267a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr); 1268a5bc1bf3SBarry Smith ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr); 1269a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr); 12703ad4599aSBarry Smith PetscFunctionReturn(0); 12713ad4599aSBarry Smith } 12723ad4599aSBarry Smith 127347c6ae99SBarry Smith /*@ 12748472ad0fSDave May DMCreateInjection - Gets injection matrix between two DM objects 127547c6ae99SBarry Smith 1276a5bc1bf3SBarry Smith Collective on dac 127747c6ae99SBarry Smith 127847c6ae99SBarry Smith Input Parameter: 1279a5bc1bf3SBarry Smith + dac - the DM object 1280a5bc1bf3SBarry Smith - daf - the second, finer DM object 128147c6ae99SBarry Smith 128247c6ae99SBarry Smith Output Parameter: 12836dbf9973SLawrence Mitchell . mat - the injection 128447c6ae99SBarry Smith 128547c6ae99SBarry Smith Level: developer 128647c6ae99SBarry Smith 128795452b02SPatrick Sanan Notes: 128895452b02SPatrick 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 128985afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection. 129085afcc9aSBarry Smith 1291e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation() 129247c6ae99SBarry Smith 129347c6ae99SBarry Smith @*/ 1294a5bc1bf3SBarry Smith PetscErrorCode DMCreateInjection(DM dac,DM daf,Mat *mat) 129547c6ae99SBarry Smith { 129647c6ae99SBarry Smith PetscErrorCode ierr; 129747c6ae99SBarry Smith 129847c6ae99SBarry Smith PetscFunctionBegin; 1299a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dac,DM_CLASSID,1); 1300a5bc1bf3SBarry Smith PetscValidHeaderSpecific(daf,DM_CLASSID,2); 13015a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1302a5bc1bf3SBarry Smith if (!dac->ops->createinjection) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name); 1303a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr); 1304a5bc1bf3SBarry Smith ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr); 1305a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr); 130647c6ae99SBarry Smith PetscFunctionReturn(0); 130747c6ae99SBarry Smith } 130847c6ae99SBarry Smith 1309b412c318SBarry Smith /*@ 1310bd041c0cSMatthew G. Knepley DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j 1311bd041c0cSMatthew G. Knepley 1312a5bc1bf3SBarry Smith Collective on dac 1313bd041c0cSMatthew G. Knepley 1314bd041c0cSMatthew G. Knepley Input Parameter: 1315a5bc1bf3SBarry Smith + dac - the DM object 1316a5bc1bf3SBarry Smith - daf - the second, finer DM object 1317bd041c0cSMatthew G. Knepley 1318bd041c0cSMatthew G. Knepley Output Parameter: 1319bd041c0cSMatthew G. Knepley . mat - the interpolation 1320bd041c0cSMatthew G. Knepley 1321bd041c0cSMatthew G. Knepley Level: developer 1322bd041c0cSMatthew G. Knepley 1323bd041c0cSMatthew G. Knepley .seealso DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection() 1324bd041c0cSMatthew G. Knepley @*/ 1325a5bc1bf3SBarry Smith PetscErrorCode DMCreateMassMatrix(DM dac, DM daf, Mat *mat) 1326bd041c0cSMatthew G. Knepley { 1327bd041c0cSMatthew G. Knepley PetscErrorCode ierr; 1328bd041c0cSMatthew G. Knepley 1329bd041c0cSMatthew G. Knepley PetscFunctionBegin; 1330a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dac, DM_CLASSID, 1); 1331a5bc1bf3SBarry Smith PetscValidHeaderSpecific(daf, DM_CLASSID, 2); 13325a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 1333a5bc1bf3SBarry Smith if (!dac->ops->createmassmatrix) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dac)->type_name); 1334a5bc1bf3SBarry Smith ierr = (*dac->ops->createmassmatrix)(dac, daf, mat);CHKERRQ(ierr); 1335bd041c0cSMatthew G. Knepley PetscFunctionReturn(0); 1336bd041c0cSMatthew G. Knepley } 1337bd041c0cSMatthew G. Knepley 1338bd041c0cSMatthew G. Knepley /*@ 1339b412c318SBarry Smith DMCreateColoring - Gets coloring for a DM 134047c6ae99SBarry Smith 1341d083f849SBarry Smith Collective on dm 134247c6ae99SBarry Smith 134347c6ae99SBarry Smith Input Parameter: 134447c6ae99SBarry Smith + dm - the DM object 13455bdb020cSBarry Smith - ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL 134647c6ae99SBarry Smith 134747c6ae99SBarry Smith Output Parameter: 134847c6ae99SBarry Smith . coloring - the coloring 134947c6ae99SBarry Smith 1350ec5066bdSBarry Smith Notes: 1351ec5066bdSBarry 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 1352ec5066bdSBarry Smith matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors). 1353ec5066bdSBarry Smith 1354ec5066bdSBarry Smith This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate() 1355ec5066bdSBarry Smith 135647c6ae99SBarry Smith Level: developer 135747c6ae99SBarry Smith 1358ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate() 135947c6ae99SBarry Smith 1360aab9d709SJed Brown @*/ 1361b412c318SBarry Smith PetscErrorCode DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring) 136247c6ae99SBarry Smith { 136347c6ae99SBarry Smith PetscErrorCode ierr; 136447c6ae99SBarry Smith 136547c6ae99SBarry Smith PetscFunctionBegin; 1366171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 13675a84ad33SLisandro Dalcin PetscValidPointer(coloring,3); 1368b9d85ea2SLisandro Dalcin if (!dm->ops->getcoloring) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name); 1369b412c318SBarry Smith ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr); 137047c6ae99SBarry Smith PetscFunctionReturn(0); 137147c6ae99SBarry Smith } 137247c6ae99SBarry Smith 1373b412c318SBarry Smith /*@ 13748472ad0fSDave May DMCreateMatrix - Gets empty Jacobian for a DM 137547c6ae99SBarry Smith 1376d083f849SBarry Smith Collective on dm 137747c6ae99SBarry Smith 137847c6ae99SBarry Smith Input Parameter: 1379b412c318SBarry Smith . dm - the DM object 138047c6ae99SBarry Smith 138147c6ae99SBarry Smith Output Parameter: 138247c6ae99SBarry Smith . mat - the empty Jacobian 138347c6ae99SBarry Smith 1384073dac72SJed Brown Level: beginner 138547c6ae99SBarry Smith 138695452b02SPatrick Sanan Notes: 138795452b02SPatrick Sanan This properly preallocates the number of nonzeros in the sparse matrix so you 138894013140SBarry Smith do not need to do it yourself. 138994013140SBarry Smith 139094013140SBarry Smith By default it also sets the nonzero structure and puts in the zero entries. To prevent setting 13917889ec69SBarry Smith the nonzero pattern call DMSetMatrixPreallocateOnly() 139294013140SBarry Smith 139394013140SBarry 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 139494013140SBarry Smith internally by PETSc. 139594013140SBarry Smith 139694013140SBarry Smith For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires 1397aa219208SBarry Smith the indices for the global numbering for DMDAs which is complicated. 139894013140SBarry Smith 1399b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType() 140047c6ae99SBarry Smith 1401aab9d709SJed Brown @*/ 1402b412c318SBarry Smith PetscErrorCode DMCreateMatrix(DM dm,Mat *mat) 140347c6ae99SBarry Smith { 140447c6ae99SBarry Smith PetscErrorCode ierr; 140547c6ae99SBarry Smith 140647c6ae99SBarry Smith PetscFunctionBegin; 1407171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1408064a246eSJacob Faibussowitsch PetscValidPointer(mat,2); 1409b9d85ea2SLisandro Dalcin if (!dm->ops->creatematrix) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name); 14105a84ad33SLisandro Dalcin ierr = MatInitializePackage();CHKERRQ(ierr); 1411fdc842d1SBarry Smith ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 1412b412c318SBarry Smith ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr); 141376bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1414c6b011d8SStefano Zampini DM mdm; 1415c6b011d8SStefano Zampini 1416c6b011d8SStefano Zampini ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr); 1417c6b011d8SStefano Zampini if (!mdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix\n",((PetscObject)dm)->type_name); 1418c6b011d8SStefano Zampini } 1419e571a35bSMatthew G. Knepley /* Handle nullspace and near nullspace */ 1420e5e52638SMatthew G. Knepley if (dm->Nf) { 1421e571a35bSMatthew G. Knepley MatNullSpace nullSpace; 1422649ef022SMatthew Knepley PetscInt Nf, f; 1423e571a35bSMatthew G. Knepley 1424e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 1425649ef022SMatthew Knepley for (f = 0; f < Nf; ++f) { 1426649ef022SMatthew Knepley if (dm->nullspaceConstructors[f]) { 1427649ef022SMatthew Knepley ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr); 1428e571a35bSMatthew G. Knepley ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1429e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1430649ef022SMatthew Knepley break; 1431e571a35bSMatthew G. Knepley } 1432649ef022SMatthew Knepley } 1433649ef022SMatthew Knepley for (f = 0; f < Nf; ++f) { 1434649ef022SMatthew Knepley if (dm->nearnullspaceConstructors[f]) { 1435649ef022SMatthew Knepley ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr); 1436e571a35bSMatthew G. Knepley ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1437e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1438e571a35bSMatthew G. Knepley } 1439e571a35bSMatthew G. Knepley } 1440e571a35bSMatthew G. Knepley } 1441fdc842d1SBarry Smith ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 144247c6ae99SBarry Smith PetscFunctionReturn(0); 144347c6ae99SBarry Smith } 144447c6ae99SBarry Smith 1445732e2eb9SMatthew G Knepley /*@ 1446950540a4SJed Brown DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly 1447732e2eb9SMatthew G Knepley preallocated but the nonzero structure and zero values will not be set. 1448732e2eb9SMatthew G Knepley 1449d083f849SBarry Smith Logically Collective on dm 1450732e2eb9SMatthew G Knepley 1451732e2eb9SMatthew G Knepley Input Parameter: 1452732e2eb9SMatthew G Knepley + dm - the DM 1453732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation 1454732e2eb9SMatthew G Knepley 1455732e2eb9SMatthew G Knepley Level: developer 1456b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly() 1457732e2eb9SMatthew G Knepley @*/ 1458732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only) 1459732e2eb9SMatthew G Knepley { 1460732e2eb9SMatthew G Knepley PetscFunctionBegin; 1461732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1462732e2eb9SMatthew G Knepley dm->prealloc_only = only; 1463732e2eb9SMatthew G Knepley PetscFunctionReturn(0); 1464732e2eb9SMatthew G Knepley } 1465732e2eb9SMatthew G Knepley 1466b06ff27eSHong Zhang /*@ 1467b06ff27eSHong Zhang DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created 1468b06ff27eSHong Zhang but the array for values will not be allocated. 1469b06ff27eSHong Zhang 1470d083f849SBarry Smith Logically Collective on dm 1471b06ff27eSHong Zhang 1472b06ff27eSHong Zhang Input Parameter: 1473b06ff27eSHong Zhang + dm - the DM 1474b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture 1475b06ff27eSHong Zhang 1476b06ff27eSHong Zhang Level: developer 1477b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly() 1478b06ff27eSHong Zhang @*/ 1479b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only) 1480b06ff27eSHong Zhang { 1481b06ff27eSHong Zhang PetscFunctionBegin; 1482b06ff27eSHong Zhang PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1483b06ff27eSHong Zhang dm->structure_only = only; 1484b06ff27eSHong Zhang PetscFunctionReturn(0); 1485b06ff27eSHong Zhang } 1486b06ff27eSHong Zhang 1487a89ea682SMatthew G Knepley /*@C 1488aa1993deSMatthew G Knepley DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1489a89ea682SMatthew G Knepley 1490a89ea682SMatthew G Knepley Not Collective 1491a89ea682SMatthew G Knepley 1492a89ea682SMatthew G Knepley Input Parameters: 1493a89ea682SMatthew G Knepley + dm - the DM object 1494aa1993deSMatthew G Knepley . count - The minium size 149569291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT) 1496a89ea682SMatthew G Knepley 1497a89ea682SMatthew G Knepley Output Parameter: 1498a89ea682SMatthew G Knepley . array - the work array 1499a89ea682SMatthew G Knepley 1500a89ea682SMatthew G Knepley Level: developer 1501a89ea682SMatthew G Knepley 1502a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate() 1503a89ea682SMatthew G Knepley @*/ 150469291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1505a89ea682SMatthew G Knepley { 1506a89ea682SMatthew G Knepley PetscErrorCode ierr; 1507aa1993deSMatthew G Knepley DMWorkLink link; 150869291d52SBarry Smith PetscMPIInt dsize; 1509a89ea682SMatthew G Knepley 1510a89ea682SMatthew G Knepley PetscFunctionBegin; 1511a89ea682SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1512aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1513aa1993deSMatthew G Knepley if (dm->workin) { 1514aa1993deSMatthew G Knepley link = dm->workin; 1515aa1993deSMatthew G Knepley dm->workin = dm->workin->next; 1516aa1993deSMatthew G Knepley } else { 1517b00a9115SJed Brown ierr = PetscNewLog(dm,&link);CHKERRQ(ierr); 1518a89ea682SMatthew G Knepley } 1519ffc4695bSBarry Smith ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr); 15205056fcd2SBarry Smith if (((size_t)dsize*count) > link->bytes) { 1521aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 1522854ce69bSBarry Smith ierr = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr); 1523854ce69bSBarry Smith link->bytes = dsize*count; 1524aa1993deSMatthew G Knepley } 1525aa1993deSMatthew G Knepley link->next = dm->workout; 1526aa1993deSMatthew G Knepley dm->workout = link; 152700d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND) 152800d952a4SJed Brown VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count); 152900d952a4SJed Brown VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count); 153000d952a4SJed Brown #endif 1531aa1993deSMatthew G Knepley *(void**)mem = link->mem; 1532a89ea682SMatthew G Knepley PetscFunctionReturn(0); 1533a89ea682SMatthew G Knepley } 1534a89ea682SMatthew G Knepley 1535aa1993deSMatthew G Knepley /*@C 1536aa1993deSMatthew G Knepley DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1537aa1993deSMatthew G Knepley 1538aa1993deSMatthew G Knepley Not Collective 1539aa1993deSMatthew G Knepley 1540aa1993deSMatthew G Knepley Input Parameters: 1541aa1993deSMatthew G Knepley + dm - the DM object 1542aa1993deSMatthew G Knepley . count - The minium size 154369291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT 1544aa1993deSMatthew G Knepley 1545aa1993deSMatthew G Knepley Output Parameter: 1546aa1993deSMatthew G Knepley . array - the work array 1547aa1993deSMatthew G Knepley 1548aa1993deSMatthew G Knepley Level: developer 1549aa1993deSMatthew G Knepley 155095452b02SPatrick Sanan Developer Notes: 155195452b02SPatrick Sanan count and dtype are ignored, they are only needed for DMGetWorkArray() 1552aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate() 1553aa1993deSMatthew G Knepley @*/ 155469291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1555aa1993deSMatthew G Knepley { 1556aa1993deSMatthew G Knepley DMWorkLink *p,link; 1557aa1993deSMatthew G Knepley 1558aa1993deSMatthew G Knepley PetscFunctionBegin; 1559aa1993deSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1560aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1561aa1993deSMatthew G Knepley for (p=&dm->workout; (link=*p); p=&link->next) { 1562aa1993deSMatthew G Knepley if (link->mem == *(void**)mem) { 1563aa1993deSMatthew G Knepley *p = link->next; 1564aa1993deSMatthew G Knepley link->next = dm->workin; 1565aa1993deSMatthew G Knepley dm->workin = link; 15660298fd71SBarry Smith *(void**)mem = NULL; 1567aa1993deSMatthew G Knepley PetscFunctionReturn(0); 1568aa1993deSMatthew G Knepley } 1569aa1993deSMatthew G Knepley } 1570aa1993deSMatthew G Knepley SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out"); 1571aa1993deSMatthew G Knepley } 1572e7c4fc90SDmitry Karpeev 15738cda7954SMatthew G. Knepley /*@C 15748cda7954SMatthew G. Knepley DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field 15758cda7954SMatthew G. Knepley 15768cda7954SMatthew G. Knepley Logically collective on DM 15778cda7954SMatthew G. Knepley 15788cda7954SMatthew G. Knepley Input Parameters: 15798cda7954SMatthew G. Knepley + dm - The DM 15808cda7954SMatthew G. Knepley . field - The field number for the nullspace 15818cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace 15828cda7954SMatthew G. Knepley 15838cda7954SMatthew G. Knepley Notes: 15848cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 15858cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 15868cda7954SMatthew G. Knepley $ dm - The present DM 15878cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 15888cda7954SMatthew G. Knepley $ field - The field number in dm 15898cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 15908cda7954SMatthew G. Knepley 15918cda7954SMatthew G. Knepley This function is currently not available from Fortran. 15928cda7954SMatthew G. Knepley 15938cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 15948cda7954SMatthew G. Knepley */ 15958cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1596435a35e8SMatthew G Knepley { 1597435a35e8SMatthew G Knepley PetscFunctionBegin; 1598435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 159982f516ccSBarry Smith if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1600435a35e8SMatthew G Knepley dm->nullspaceConstructors[field] = nullsp; 1601435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1602435a35e8SMatthew G Knepley } 1603435a35e8SMatthew G Knepley 16048cda7954SMatthew G. Knepley /*@C 16058cda7954SMatthew G. Knepley DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL 16068cda7954SMatthew G. Knepley 16078cda7954SMatthew G. Knepley Not collective 16088cda7954SMatthew G. Knepley 16098cda7954SMatthew G. Knepley Input Parameters: 16108cda7954SMatthew G. Knepley + dm - The DM 16118cda7954SMatthew G. Knepley - field - The field number for the nullspace 16128cda7954SMatthew G. Knepley 16138cda7954SMatthew G. Knepley Output Parameter: 16148cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace 16158cda7954SMatthew G. Knepley 16168cda7954SMatthew G. Knepley Notes: 16178cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 16188cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 16198cda7954SMatthew G. Knepley $ dm - The present DM 16208cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 16218cda7954SMatthew G. Knepley $ field - The field number in dm 16228cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 16238cda7954SMatthew G. Knepley 16248cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16258cda7954SMatthew G. Knepley 16268cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 16278cda7954SMatthew G. Knepley */ 16288cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 16290a50eb56SMatthew G. Knepley { 16300a50eb56SMatthew G. Knepley PetscFunctionBegin; 16310a50eb56SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1632f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 16330a50eb56SMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 16340a50eb56SMatthew G. Knepley *nullsp = dm->nullspaceConstructors[field]; 16350a50eb56SMatthew G. Knepley PetscFunctionReturn(0); 16360a50eb56SMatthew G. Knepley } 16370a50eb56SMatthew G. Knepley 16388cda7954SMatthew G. Knepley /*@C 16398cda7954SMatthew G. Knepley DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field 16408cda7954SMatthew G. Knepley 16418cda7954SMatthew G. Knepley Logically collective on DM 16428cda7954SMatthew G. Knepley 16438cda7954SMatthew G. Knepley Input Parameters: 16448cda7954SMatthew G. Knepley + dm - The DM 16458cda7954SMatthew G. Knepley . field - The field number for the nullspace 16468cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace 16478cda7954SMatthew G. Knepley 16488cda7954SMatthew G. Knepley Notes: 16498cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 16508cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 16518cda7954SMatthew G. Knepley $ dm - The present DM 16528cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 16538cda7954SMatthew G. Knepley $ field - The field number in dm 16548cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 16558cda7954SMatthew G. Knepley 16568cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16578cda7954SMatthew G. Knepley 16588cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 16598cda7954SMatthew G. Knepley */ 16608cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1661f9d4088aSMatthew G. Knepley { 1662f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1663f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1664f9d4088aSMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1665f9d4088aSMatthew G. Knepley dm->nearnullspaceConstructors[field] = nullsp; 1666f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1667f9d4088aSMatthew G. Knepley } 1668f9d4088aSMatthew G. Knepley 16698cda7954SMatthew G. Knepley /*@C 16708cda7954SMatthew G. Knepley DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL 16718cda7954SMatthew G. Knepley 16728cda7954SMatthew G. Knepley Not collective 16738cda7954SMatthew G. Knepley 16748cda7954SMatthew G. Knepley Input Parameters: 16758cda7954SMatthew G. Knepley + dm - The DM 16768cda7954SMatthew G. Knepley - field - The field number for the nullspace 16778cda7954SMatthew G. Knepley 16788cda7954SMatthew G. Knepley Output Parameter: 16798cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace 16808cda7954SMatthew G. Knepley 16818cda7954SMatthew G. Knepley Notes: 16828cda7954SMatthew G. Knepley The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is 16838cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 16848cda7954SMatthew G. Knepley $ dm - The present DM 16858cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM 16868cda7954SMatthew G. Knepley $ field - The field number in dm 16878cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field 16888cda7954SMatthew G. Knepley 16898cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16908cda7954SMatthew G. Knepley 16918cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 16928cda7954SMatthew G. Knepley */ 16938cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)) 1694f9d4088aSMatthew G. Knepley { 1695f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1696f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1697f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 1698f9d4088aSMatthew G. Knepley if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1699f9d4088aSMatthew G. Knepley *nullsp = dm->nearnullspaceConstructors[field]; 1700f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1701f9d4088aSMatthew G. Knepley } 1702f9d4088aSMatthew G. Knepley 17034f3b5142SJed Brown /*@C 17044d343eeaSMatthew G Knepley DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field 17054d343eeaSMatthew G Knepley 17064d343eeaSMatthew G Knepley Not collective 17074d343eeaSMatthew G Knepley 17084d343eeaSMatthew G Knepley Input Parameter: 17094d343eeaSMatthew G Knepley . dm - the DM object 17104d343eeaSMatthew G Knepley 17114d343eeaSMatthew G Knepley Output Parameters: 17120298fd71SBarry Smith + numFields - The number of fields (or NULL if not requested) 17130298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested) 17140298fd71SBarry Smith - fields - The global indices for each field (or NULL if not requested) 17154d343eeaSMatthew G Knepley 17164d343eeaSMatthew G Knepley Level: intermediate 17174d343eeaSMatthew G Knepley 171821c9b008SJed Brown Notes: 171921c9b008SJed Brown The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 172021c9b008SJed Brown PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with 172121c9b008SJed Brown PetscFree(). 172221c9b008SJed Brown 17234d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 17244d343eeaSMatthew G Knepley @*/ 172537d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields) 17264d343eeaSMatthew G Knepley { 172737d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 17284d343eeaSMatthew G Knepley PetscErrorCode ierr; 17294d343eeaSMatthew G Knepley 17304d343eeaSMatthew G Knepley PetscFunctionBegin; 17314d343eeaSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 173269ca1f37SDmitry Karpeev if (numFields) { 1733534a8f05SLisandro Dalcin PetscValidIntPointer(numFields,2); 173469ca1f37SDmitry Karpeev *numFields = 0; 173569ca1f37SDmitry Karpeev } 173637d0c07bSMatthew G Knepley if (fieldNames) { 173737d0c07bSMatthew G Knepley PetscValidPointer(fieldNames,3); 17380298fd71SBarry Smith *fieldNames = NULL; 173969ca1f37SDmitry Karpeev } 174069ca1f37SDmitry Karpeev if (fields) { 174169ca1f37SDmitry Karpeev PetscValidPointer(fields,4); 17420298fd71SBarry Smith *fields = NULL; 174369ca1f37SDmitry Karpeev } 174492fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 174537d0c07bSMatthew G Knepley if (section) { 17463a544194SStefano Zampini PetscInt *fieldSizes, *fieldNc, **fieldIndices; 174737d0c07bSMatthew G Knepley PetscInt nF, f, pStart, pEnd, p; 174837d0c07bSMatthew G Knepley 1749e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 175037d0c07bSMatthew G Knepley ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr); 17513a544194SStefano Zampini ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr); 175237d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr); 175337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 175437d0c07bSMatthew G Knepley fieldSizes[f] = 0; 17553a544194SStefano Zampini ierr = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr); 175637d0c07bSMatthew G Knepley } 175737d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 175837d0c07bSMatthew G Knepley PetscInt gdof; 175937d0c07bSMatthew G Knepley 176037d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 176137d0c07bSMatthew G Knepley if (gdof > 0) { 176237d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 17633a544194SStefano Zampini PetscInt fdof, fcdof, fpdof; 176437d0c07bSMatthew G Knepley 176537d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 176637d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 17673a544194SStefano Zampini fpdof = fdof-fcdof; 17683a544194SStefano Zampini if (fpdof && fpdof != fieldNc[f]) { 17693a544194SStefano Zampini /* Layout does not admit a pointwise block size */ 17703a544194SStefano Zampini fieldNc[f] = 1; 17713a544194SStefano Zampini } 17723a544194SStefano Zampini fieldSizes[f] += fpdof; 177337d0c07bSMatthew G Knepley } 177437d0c07bSMatthew G Knepley } 177537d0c07bSMatthew G Knepley } 177637d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 1777785e854fSJed Brown ierr = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr); 177837d0c07bSMatthew G Knepley fieldSizes[f] = 0; 177937d0c07bSMatthew G Knepley } 178037d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 178137d0c07bSMatthew G Knepley PetscInt gdof, goff; 178237d0c07bSMatthew G Knepley 178337d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 178437d0c07bSMatthew G Knepley if (gdof > 0) { 178537d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr); 178637d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 178737d0c07bSMatthew G Knepley PetscInt fdof, fcdof, fc; 178837d0c07bSMatthew G Knepley 178937d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 179037d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 179137d0c07bSMatthew G Knepley for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) { 179237d0c07bSMatthew G Knepley fieldIndices[f][fieldSizes[f]] = goff++; 179337d0c07bSMatthew G Knepley } 179437d0c07bSMatthew G Knepley } 179537d0c07bSMatthew G Knepley } 179637d0c07bSMatthew G Knepley } 17978865f1eaSKarl Rupp if (numFields) *numFields = nF; 179837d0c07bSMatthew G Knepley if (fieldNames) { 1799785e854fSJed Brown ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr); 180037d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 180137d0c07bSMatthew G Knepley const char *fieldName; 180237d0c07bSMatthew G Knepley 180337d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 180437d0c07bSMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr); 180537d0c07bSMatthew G Knepley } 180637d0c07bSMatthew G Knepley } 180737d0c07bSMatthew G Knepley if (fields) { 1808785e854fSJed Brown ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr); 180937d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 18103a544194SStefano Zampini PetscInt bs, in[2], out[2]; 18113a544194SStefano Zampini 181282f516ccSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr); 18133a544194SStefano Zampini in[0] = -fieldNc[f]; 18143a544194SStefano Zampini in[1] = fieldNc[f]; 1815820f2d46SBarry Smith ierr = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 18163a544194SStefano Zampini bs = (-out[0] == out[1]) ? out[1] : 1; 18173a544194SStefano Zampini ierr = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr); 181837d0c07bSMatthew G Knepley } 181937d0c07bSMatthew G Knepley } 18203a544194SStefano Zampini ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr); 18218865f1eaSKarl Rupp } else if (dm->ops->createfieldis) { 18228865f1eaSKarl Rupp ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr); 182369ca1f37SDmitry Karpeev } 18244d343eeaSMatthew G Knepley PetscFunctionReturn(0); 18254d343eeaSMatthew G Knepley } 18264d343eeaSMatthew G Knepley 182716621825SDmitry Karpeev 182816621825SDmitry Karpeev /*@C 182916621825SDmitry Karpeev DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems 183016621825SDmitry Karpeev corresponding to different fields: each IS contains the global indices of the dofs of the 183116621825SDmitry Karpeev corresponding field. The optional list of DMs define the DM for each subproblem. 1832e7c4fc90SDmitry Karpeev Generalizes DMCreateFieldIS(). 1833e7c4fc90SDmitry Karpeev 1834e7c4fc90SDmitry Karpeev Not collective 1835e7c4fc90SDmitry Karpeev 1836e7c4fc90SDmitry Karpeev Input Parameter: 1837e7c4fc90SDmitry Karpeev . dm - the DM object 1838e7c4fc90SDmitry Karpeev 1839e7c4fc90SDmitry Karpeev Output Parameters: 18400298fd71SBarry Smith + len - The number of subproblems in the field decomposition (or NULL if not requested) 18410298fd71SBarry Smith . namelist - The name for each field (or NULL if not requested) 18420298fd71SBarry Smith . islist - The global indices for each field (or NULL if not requested) 18430298fd71SBarry Smith - dmlist - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 1844e7c4fc90SDmitry Karpeev 1845e7c4fc90SDmitry Karpeev Level: intermediate 1846e7c4fc90SDmitry Karpeev 1847e7c4fc90SDmitry Karpeev Notes: 1848e7c4fc90SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 1849e7c4fc90SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 1850e7c4fc90SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 1851e7c4fc90SDmitry Karpeev 1852e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1853e7c4fc90SDmitry Karpeev @*/ 185416621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist) 1855e7c4fc90SDmitry Karpeev { 1856e7c4fc90SDmitry Karpeev PetscErrorCode ierr; 1857e7c4fc90SDmitry Karpeev 1858e7c4fc90SDmitry Karpeev PetscFunctionBegin; 1859e7c4fc90SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 18608865f1eaSKarl Rupp if (len) { 1861534a8f05SLisandro Dalcin PetscValidIntPointer(len,2); 18628865f1eaSKarl Rupp *len = 0; 18638865f1eaSKarl Rupp } 18648865f1eaSKarl Rupp if (namelist) { 18658865f1eaSKarl Rupp PetscValidPointer(namelist,3); 1866ea78f98cSLisandro Dalcin *namelist = NULL; 18678865f1eaSKarl Rupp } 18688865f1eaSKarl Rupp if (islist) { 18698865f1eaSKarl Rupp PetscValidPointer(islist,4); 1870ea78f98cSLisandro Dalcin *islist = NULL; 18718865f1eaSKarl Rupp } 18728865f1eaSKarl Rupp if (dmlist) { 18738865f1eaSKarl Rupp PetscValidPointer(dmlist,5); 1874ea78f98cSLisandro Dalcin *dmlist = NULL; 18758865f1eaSKarl Rupp } 1876f3f0edfdSDmitry Karpeev /* 1877f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 1878f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 1879f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 1880f3f0edfdSDmitry Karpeev */ 1881ce94432eSBarry Smith if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 188216621825SDmitry Karpeev if (!dm->ops->createfielddecomposition) { 1883435a35e8SMatthew G Knepley PetscSection section; 1884435a35e8SMatthew G Knepley PetscInt numFields, f; 1885435a35e8SMatthew G Knepley 188692fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 1887435a35e8SMatthew G Knepley if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);} 1888435a35e8SMatthew G Knepley if (section && numFields && dm->ops->createsubdm) { 1889f25d98f1SMatthew G. Knepley if (len) *len = numFields; 189003dc3394SMatthew G. Knepley if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);} 189103dc3394SMatthew G. Knepley if (islist) {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);} 189203dc3394SMatthew G. Knepley if (dmlist) {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);} 1893435a35e8SMatthew G Knepley for (f = 0; f < numFields; ++f) { 1894435a35e8SMatthew G Knepley const char *fieldName; 1895435a35e8SMatthew G Knepley 189603dc3394SMatthew G. Knepley ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr); 189703dc3394SMatthew G. Knepley if (namelist) { 1898435a35e8SMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 1899435a35e8SMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr); 1900435a35e8SMatthew G Knepley } 190103dc3394SMatthew G. Knepley } 1902435a35e8SMatthew G Knepley } else { 190369ca1f37SDmitry Karpeev ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr); 1904e7c4fc90SDmitry Karpeev /* By default there are no DMs associated with subproblems. */ 19050298fd71SBarry Smith if (dmlist) *dmlist = NULL; 1906e7c4fc90SDmitry Karpeev } 19078865f1eaSKarl Rupp } else { 190816621825SDmitry Karpeev ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr); 190916621825SDmitry Karpeev } 191016621825SDmitry Karpeev PetscFunctionReturn(0); 191116621825SDmitry Karpeev } 191216621825SDmitry Karpeev 1913564cec59SMatthew G. Knepley /*@ 1914435a35e8SMatthew G Knepley DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in. 1915435a35e8SMatthew G Knepley The fields are defined by DMCreateFieldIS(). 1916435a35e8SMatthew G Knepley 1917435a35e8SMatthew G Knepley Not collective 1918435a35e8SMatthew G Knepley 1919435a35e8SMatthew G Knepley Input Parameters: 19202adcc780SMatthew G. Knepley + dm - The DM object 19212adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem 19222adcc780SMatthew G. Knepley - fields - The field numbers of the selected fields 1923435a35e8SMatthew G Knepley 1924435a35e8SMatthew G Knepley Output Parameters: 19252adcc780SMatthew G. Knepley + is - The global indices for the subproblem 19262adcc780SMatthew G. Knepley - subdm - The DM for the subproblem 1927435a35e8SMatthew G Knepley 19285d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 19295d3b26e6SMatthew G. Knepley 1930435a35e8SMatthew G Knepley Level: intermediate 1931435a35e8SMatthew G Knepley 19325d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1933435a35e8SMatthew G Knepley @*/ 193437bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm) 1935435a35e8SMatthew G Knepley { 1936435a35e8SMatthew G Knepley PetscErrorCode ierr; 1937435a35e8SMatthew G Knepley 1938435a35e8SMatthew G Knepley PetscFunctionBegin; 1939435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1940435a35e8SMatthew G Knepley PetscValidPointer(fields,3); 19418865f1eaSKarl Rupp if (is) PetscValidPointer(is,4); 19428865f1eaSKarl Rupp if (subdm) PetscValidPointer(subdm,5); 1943b9d85ea2SLisandro Dalcin if (!dm->ops->createsubdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name); 1944435a35e8SMatthew G Knepley ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr); 1945435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1946435a35e8SMatthew G Knepley } 1947435a35e8SMatthew G Knepley 19482adcc780SMatthew G. Knepley /*@C 19492adcc780SMatthew G. Knepley DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in. 19502adcc780SMatthew G. Knepley 19512adcc780SMatthew G. Knepley Not collective 19522adcc780SMatthew G. Knepley 19532adcc780SMatthew G. Knepley Input Parameter: 19542adcc780SMatthew G. Knepley + dms - The DM objects 19552adcc780SMatthew G. Knepley - len - The number of DMs 19562adcc780SMatthew G. Knepley 19572adcc780SMatthew G. Knepley Output Parameters: 1958a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL 19592adcc780SMatthew G. Knepley - superdm - The DM for the superproblem 19602adcc780SMatthew G. Knepley 19615d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 19625d3b26e6SMatthew G. Knepley 19632adcc780SMatthew G. Knepley Level: intermediate 19642adcc780SMatthew G. Knepley 19655d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 19662adcc780SMatthew G. Knepley @*/ 19672adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm) 19682adcc780SMatthew G. Knepley { 19692adcc780SMatthew G. Knepley PetscInt i; 19702adcc780SMatthew G. Knepley PetscErrorCode ierr; 19712adcc780SMatthew G. Knepley 19722adcc780SMatthew G. Knepley PetscFunctionBegin; 19732adcc780SMatthew G. Knepley PetscValidPointer(dms,1); 19742adcc780SMatthew G. Knepley for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);} 19752adcc780SMatthew G. Knepley if (is) PetscValidPointer(is,3); 1976a42bd24dSMatthew G. Knepley PetscValidPointer(superdm,4); 19772adcc780SMatthew G. Knepley if (len < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len); 19782adcc780SMatthew G. Knepley if (len) { 1979b9d85ea2SLisandro Dalcin DM dm = dms[0]; 1980b9d85ea2SLisandro Dalcin if (!dm->ops->createsuperdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name); 1981b9d85ea2SLisandro Dalcin ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr); 19822adcc780SMatthew G. Knepley } 19832adcc780SMatthew G. Knepley PetscFunctionReturn(0); 19842adcc780SMatthew G. Knepley } 19852adcc780SMatthew G. Knepley 198616621825SDmitry Karpeev 198716621825SDmitry Karpeev /*@C 19888d4ac253SDmitry Karpeev DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems 19898d4ac253SDmitry Karpeev corresponding to restrictions to pairs nested subdomains: each IS contains the global 19908d4ac253SDmitry Karpeev indices of the dofs of the corresponding subdomains. The inner subdomains conceptually 19918d4ac253SDmitry Karpeev define a nonoverlapping covering, while outer subdomains can overlap. 19928d4ac253SDmitry Karpeev The optional list of DMs define the DM for each subproblem. 199316621825SDmitry Karpeev 199416621825SDmitry Karpeev Not collective 199516621825SDmitry Karpeev 199616621825SDmitry Karpeev Input Parameter: 199716621825SDmitry Karpeev . dm - the DM object 199816621825SDmitry Karpeev 199916621825SDmitry Karpeev Output Parameters: 20000298fd71SBarry Smith + len - The number of subproblems in the domain decomposition (or NULL if not requested) 20010298fd71SBarry Smith . namelist - The name for each subdomain (or NULL if not requested) 20020298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested) 20030298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested) 20040298fd71SBarry Smith - dmlist - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 200516621825SDmitry Karpeev 200616621825SDmitry Karpeev Level: intermediate 200716621825SDmitry Karpeev 200816621825SDmitry Karpeev Notes: 200916621825SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 201016621825SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 201116621825SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 201216621825SDmitry Karpeev 2013245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition() 201416621825SDmitry Karpeev @*/ 20158d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist) 201616621825SDmitry Karpeev { 201716621825SDmitry Karpeev PetscErrorCode ierr; 2018be081cd6SPeter Brune DMSubDomainHookLink link; 2019be081cd6SPeter Brune PetscInt i,l; 202016621825SDmitry Karpeev 202116621825SDmitry Karpeev PetscFunctionBegin; 202216621825SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 202314a18fd3SPeter Brune if (len) {PetscValidPointer(len,2); *len = 0;} 20240298fd71SBarry Smith if (namelist) {PetscValidPointer(namelist,3); *namelist = NULL;} 20250298fd71SBarry Smith if (innerislist) {PetscValidPointer(innerislist,4); *innerislist = NULL;} 20260298fd71SBarry Smith if (outerislist) {PetscValidPointer(outerislist,5); *outerislist = NULL;} 20270298fd71SBarry Smith if (dmlist) {PetscValidPointer(dmlist,6); *dmlist = NULL;} 2028f3f0edfdSDmitry Karpeev /* 2029f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 2030f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 2031f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 2032f3f0edfdSDmitry Karpeev */ 2033ce94432eSBarry Smith if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 203416621825SDmitry Karpeev if (dm->ops->createdomaindecomposition) { 2035be081cd6SPeter Brune ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr); 203614a18fd3SPeter Brune /* copy subdomain hooks and context over to the subdomain DMs */ 2037f891f5b9SPatrick Sanan if (dmlist && *dmlist) { 2038be081cd6SPeter Brune for (i = 0; i < l; i++) { 2039be081cd6SPeter Brune for (link=dm->subdomainhook; link; link=link->next) { 2040be081cd6SPeter Brune if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);} 2041be081cd6SPeter Brune } 2042648262bbSPatrick Sanan if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx; 2043e7c4fc90SDmitry Karpeev } 204414a18fd3SPeter Brune } 204514a18fd3SPeter Brune if (len) *len = l; 204614a18fd3SPeter Brune } 2047e30e807fSPeter Brune PetscFunctionReturn(0); 2048e30e807fSPeter Brune } 2049e30e807fSPeter Brune 2050e30e807fSPeter Brune 2051e30e807fSPeter Brune /*@C 2052e30e807fSPeter Brune DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector 2053e30e807fSPeter Brune 2054e30e807fSPeter Brune Not collective 2055e30e807fSPeter Brune 2056e30e807fSPeter Brune Input Parameters: 2057e30e807fSPeter Brune + dm - the DM object 2058e30e807fSPeter Brune . n - the number of subdomain scatters 2059e30e807fSPeter Brune - subdms - the local subdomains 2060e30e807fSPeter Brune 2061e30e807fSPeter Brune Output Parameters: 2062e30e807fSPeter Brune + n - the number of scatters returned 2063e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain 2064e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain 2065e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts) 2066e30e807fSPeter Brune 206795452b02SPatrick Sanan Notes: 206895452b02SPatrick Sanan This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution 2069e30e807fSPeter Brune of general nonlinear problems with overlapping subdomain methods. While merely having index sets that enable subsets 2070e30e807fSPeter Brune of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of 2071e30e807fSPeter Brune solution and residual data. 2072e30e807fSPeter Brune 2073e30e807fSPeter Brune Level: developer 2074e30e807fSPeter Brune 2075e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 2076e30e807fSPeter Brune @*/ 2077e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat) 2078e30e807fSPeter Brune { 2079e30e807fSPeter Brune PetscErrorCode ierr; 2080e30e807fSPeter Brune 2081e30e807fSPeter Brune PetscFunctionBegin; 2082e30e807fSPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2083e30e807fSPeter Brune PetscValidPointer(subdms,3); 2084b9d85ea2SLisandro Dalcin if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name); 2085e30e807fSPeter Brune ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr); 2086e7c4fc90SDmitry Karpeev PetscFunctionReturn(0); 2087e7c4fc90SDmitry Karpeev } 2088e7c4fc90SDmitry Karpeev 208947c6ae99SBarry Smith /*@ 209047c6ae99SBarry Smith DMRefine - Refines a DM object 209147c6ae99SBarry Smith 2092d083f849SBarry Smith Collective on dm 209347c6ae99SBarry Smith 209447c6ae99SBarry Smith Input Parameter: 209547c6ae99SBarry Smith + dm - the DM object 209691d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 209747c6ae99SBarry Smith 209847c6ae99SBarry Smith Output Parameter: 20990298fd71SBarry Smith . dmf - the refined DM, or NULL 2100ae0a1c52SMatthew G Knepley 2101412e9a14SMatthew G. Knepley Options Dtabase Keys: 2102412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex 2103412e9a14SMatthew G. Knepley 21040298fd71SBarry Smith Note: If no refinement was done, the return value is NULL 210547c6ae99SBarry Smith 210647c6ae99SBarry Smith Level: developer 210747c6ae99SBarry Smith 2108e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 210947c6ae99SBarry Smith @*/ 21107087cfbeSBarry Smith PetscErrorCode DMRefine(DM dm,MPI_Comm comm,DM *dmf) 211147c6ae99SBarry Smith { 211247c6ae99SBarry Smith PetscErrorCode ierr; 2113c833c3b5SJed Brown DMRefineHookLink link; 211447c6ae99SBarry Smith 211547c6ae99SBarry Smith PetscFunctionBegin; 2116732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2117b9d85ea2SLisandro Dalcin if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name); 21181ac00216SMatthew G. Knepley ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 211947c6ae99SBarry Smith ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr); 21204057135bSMatthew G Knepley if (*dmf) { 212143842a1eSJed Brown (*dmf)->ops->creatematrix = dm->ops->creatematrix; 21228865f1eaSKarl Rupp 21238cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr); 21248865f1eaSKarl Rupp 2125644e2e5bSBarry Smith (*dmf)->ctx = dm->ctx; 21260598a293SJed Brown (*dmf)->leveldown = dm->leveldown; 2127656b349aSBarry Smith (*dmf)->levelup = dm->levelup + 1; 21288865f1eaSKarl Rupp 2129e4b4b23bSJed Brown ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr); 2130c833c3b5SJed Brown for (link=dm->refinehook; link; link=link->next) { 21318865f1eaSKarl Rupp if (link->refinehook) { 21328865f1eaSKarl Rupp ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr); 21338865f1eaSKarl Rupp } 2134c833c3b5SJed Brown } 2135c833c3b5SJed Brown } 21361ac00216SMatthew G. Knepley ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 2137c833c3b5SJed Brown PetscFunctionReturn(0); 2138c833c3b5SJed Brown } 2139c833c3b5SJed Brown 2140bb9467b5SJed Brown /*@C 2141c833c3b5SJed Brown DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid 2142c833c3b5SJed Brown 2143c833c3b5SJed Brown Logically Collective 2144c833c3b5SJed Brown 2145c833c3b5SJed Brown Input Arguments: 2146c833c3b5SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 2147c833c3b5SJed Brown . refinehook - function to run when setting up a coarser level 2148c833c3b5SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 21490298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2150c833c3b5SJed Brown 2151c833c3b5SJed Brown Calling sequence of refinehook: 2152c833c3b5SJed Brown $ refinehook(DM coarse,DM fine,void *ctx); 2153c833c3b5SJed Brown 2154c833c3b5SJed Brown + coarse - coarse level DM 2155c833c3b5SJed Brown . fine - fine level DM to interpolate problem to 2156c833c3b5SJed Brown - ctx - optional user-defined function context 2157c833c3b5SJed Brown 2158c833c3b5SJed Brown Calling sequence for interphook: 2159c833c3b5SJed Brown $ interphook(DM coarse,Mat interp,DM fine,void *ctx) 2160c833c3b5SJed Brown 2161c833c3b5SJed Brown + coarse - coarse level DM 2162c833c3b5SJed Brown . interp - matrix interpolating a coarse-level solution to the finer grid 2163c833c3b5SJed Brown . fine - fine level DM to update 2164c833c3b5SJed Brown - ctx - optional user-defined function context 2165c833c3b5SJed Brown 2166c833c3b5SJed Brown Level: advanced 2167c833c3b5SJed Brown 2168c833c3b5SJed Brown Notes: 2169c833c3b5SJed Brown This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing 2170c833c3b5SJed Brown 2171c833c3b5SJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 2172c833c3b5SJed Brown 2173bb9467b5SJed Brown This function is currently not available from Fortran. 2174bb9467b5SJed Brown 2175c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2176c833c3b5SJed Brown @*/ 2177c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 2178c833c3b5SJed Brown { 2179c833c3b5SJed Brown PetscErrorCode ierr; 2180c833c3b5SJed Brown DMRefineHookLink link,*p; 2181c833c3b5SJed Brown 2182c833c3b5SJed Brown PetscFunctionBegin; 2183c833c3b5SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 21843d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 21853d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0); 21863d8e3701SJed Brown } 218795dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2188c833c3b5SJed Brown link->refinehook = refinehook; 2189c833c3b5SJed Brown link->interphook = interphook; 2190c833c3b5SJed Brown link->ctx = ctx; 21910298fd71SBarry Smith link->next = NULL; 2192c833c3b5SJed Brown *p = link; 2193c833c3b5SJed Brown PetscFunctionReturn(0); 2194c833c3b5SJed Brown } 2195c833c3b5SJed Brown 21963d8e3701SJed Brown /*@C 21973d8e3701SJed Brown DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid 21983d8e3701SJed Brown 21993d8e3701SJed Brown Logically Collective 22003d8e3701SJed Brown 22013d8e3701SJed Brown Input Arguments: 22023d8e3701SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 22033d8e3701SJed Brown . refinehook - function to run when setting up a coarser level 22043d8e3701SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 22053d8e3701SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 22063d8e3701SJed Brown 22073d8e3701SJed Brown Level: advanced 22083d8e3701SJed Brown 22093d8e3701SJed Brown Notes: 22103d8e3701SJed Brown This function does nothing if the hook is not in the list. 22113d8e3701SJed Brown 22123d8e3701SJed Brown This function is currently not available from Fortran. 22133d8e3701SJed Brown 22143d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 22153d8e3701SJed Brown @*/ 22163d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 22173d8e3701SJed Brown { 22183d8e3701SJed Brown PetscErrorCode ierr; 22193d8e3701SJed Brown DMRefineHookLink link,*p; 22203d8e3701SJed Brown 22213d8e3701SJed Brown PetscFunctionBegin; 22223d8e3701SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 22233d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 22243d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) { 22253d8e3701SJed Brown link = *p; 22263d8e3701SJed Brown *p = link->next; 22273d8e3701SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 22283d8e3701SJed Brown break; 22293d8e3701SJed Brown } 22303d8e3701SJed Brown } 22313d8e3701SJed Brown PetscFunctionReturn(0); 22323d8e3701SJed Brown } 22333d8e3701SJed Brown 2234c833c3b5SJed Brown /*@ 2235c833c3b5SJed Brown DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd() 2236c833c3b5SJed Brown 2237c833c3b5SJed Brown Collective if any hooks are 2238c833c3b5SJed Brown 2239c833c3b5SJed Brown Input Arguments: 2240c833c3b5SJed Brown + coarse - coarser DM to use as a base 2241e91eccc2SStefano Zampini . interp - interpolation matrix, apply using MatInterpolate() 2242c833c3b5SJed Brown - fine - finer DM to update 2243c833c3b5SJed Brown 2244c833c3b5SJed Brown Level: developer 2245c833c3b5SJed Brown 2246c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate() 2247c833c3b5SJed Brown @*/ 2248c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine) 2249c833c3b5SJed Brown { 2250c833c3b5SJed Brown PetscErrorCode ierr; 2251c833c3b5SJed Brown DMRefineHookLink link; 2252c833c3b5SJed Brown 2253c833c3b5SJed Brown PetscFunctionBegin; 2254c833c3b5SJed Brown for (link=fine->refinehook; link; link=link->next) { 22558865f1eaSKarl Rupp if (link->interphook) { 22568865f1eaSKarl Rupp ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr); 22578865f1eaSKarl Rupp } 22584057135bSMatthew G Knepley } 225947c6ae99SBarry Smith PetscFunctionReturn(0); 226047c6ae99SBarry Smith } 226147c6ae99SBarry Smith 2262eb3f98d2SBarry Smith /*@ 22631f3379b2SToby Isaac DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh. 22641f3379b2SToby Isaac 22651f3379b2SToby Isaac Collective on DM 22661f3379b2SToby Isaac 22671f3379b2SToby Isaac Input Arguments: 22681f3379b2SToby Isaac + coarse - coarse DM 22691f3379b2SToby Isaac . fine - fine DM 22701f3379b2SToby Isaac . interp - (optional) the matrix computed by DMCreateInterpolation(). Implementations may not need this, but if it 22711f3379b2SToby Isaac is available it can avoid some recomputation. If it is provided, MatInterpolate() will be used if 22721f3379b2SToby Isaac the coarse DM does not have a specialized implementation. 22731f3379b2SToby Isaac - coarseSol - solution on the coarse mesh 22741f3379b2SToby Isaac 22751f3379b2SToby Isaac Output Arguments: 22761f3379b2SToby Isaac . fineSol - the interpolation of coarseSol to the fine mesh 22771f3379b2SToby Isaac 22781f3379b2SToby Isaac Level: developer 22791f3379b2SToby Isaac 22801f3379b2SToby Isaac Note: This function exists because the interpolation of a solution vector between meshes is not always a linear 22811f3379b2SToby Isaac map. For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed 22821f3379b2SToby Isaac out of the solution vector. Or if interpolation is inherently a nonlinear operation, such as a method using 22831f3379b2SToby Isaac slope-limiting reconstruction. 22841f3379b2SToby Isaac 22851f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation() 22861f3379b2SToby Isaac @*/ 22871f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol) 22881f3379b2SToby Isaac { 22891f3379b2SToby Isaac PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL; 22901f3379b2SToby Isaac PetscErrorCode ierr; 22911f3379b2SToby Isaac 22921f3379b2SToby Isaac PetscFunctionBegin; 22931f3379b2SToby Isaac PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 22941f3379b2SToby Isaac if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3); 22951f3379b2SToby Isaac PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4); 22961f3379b2SToby Isaac PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5); 22971f3379b2SToby Isaac 22981f3379b2SToby Isaac ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr); 22991f3379b2SToby Isaac if (interpsol) { 23001f3379b2SToby Isaac ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr); 23011f3379b2SToby Isaac } else if (interp) { 23021f3379b2SToby Isaac ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr); 23031f3379b2SToby Isaac } else SETERRQ1(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name); 23041f3379b2SToby Isaac PetscFunctionReturn(0); 23051f3379b2SToby Isaac } 23061f3379b2SToby Isaac 23071f3379b2SToby Isaac /*@ 2308aed49f88SRichard Tran Mills DMGetRefineLevel - Gets the number of refinements that have generated this DM. 2309eb3f98d2SBarry Smith 2310eb3f98d2SBarry Smith Not Collective 2311eb3f98d2SBarry Smith 2312eb3f98d2SBarry Smith Input Parameter: 2313eb3f98d2SBarry Smith . dm - the DM object 2314eb3f98d2SBarry Smith 2315eb3f98d2SBarry Smith Output Parameter: 2316eb3f98d2SBarry Smith . level - number of refinements 2317eb3f98d2SBarry Smith 2318eb3f98d2SBarry Smith Level: developer 2319eb3f98d2SBarry Smith 23206a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2321eb3f98d2SBarry Smith 2322eb3f98d2SBarry Smith @*/ 2323eb3f98d2SBarry Smith PetscErrorCode DMGetRefineLevel(DM dm,PetscInt *level) 2324eb3f98d2SBarry Smith { 2325eb3f98d2SBarry Smith PetscFunctionBegin; 2326eb3f98d2SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2327eb3f98d2SBarry Smith *level = dm->levelup; 2328eb3f98d2SBarry Smith PetscFunctionReturn(0); 2329eb3f98d2SBarry Smith } 2330eb3f98d2SBarry Smith 2331fef3a512SBarry Smith /*@ 2332aed49f88SRichard Tran Mills DMSetRefineLevel - Sets the number of refinements that have generated this DM. 2333fef3a512SBarry Smith 2334fef3a512SBarry Smith Not Collective 2335fef3a512SBarry Smith 2336fef3a512SBarry Smith Input Parameter: 2337fef3a512SBarry Smith + dm - the DM object 2338fef3a512SBarry Smith - level - number of refinements 2339fef3a512SBarry Smith 2340fef3a512SBarry Smith Level: advanced 2341fef3a512SBarry Smith 234295452b02SPatrick Sanan Notes: 234395452b02SPatrick Sanan This value is used by PCMG to determine how many multigrid levels to use 2344fef3a512SBarry Smith 2345fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2346fef3a512SBarry Smith 2347fef3a512SBarry Smith @*/ 2348fef3a512SBarry Smith PetscErrorCode DMSetRefineLevel(DM dm,PetscInt level) 2349fef3a512SBarry Smith { 2350fef3a512SBarry Smith PetscFunctionBegin; 2351fef3a512SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2352fef3a512SBarry Smith dm->levelup = level; 2353fef3a512SBarry Smith PetscFunctionReturn(0); 2354fef3a512SBarry Smith } 2355fef3a512SBarry Smith 2356ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm) 2357ca3d3a14SMatthew G. Knepley { 2358ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2359ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2360ca3d3a14SMatthew G. Knepley PetscValidPointer(tdm, 2); 2361ca3d3a14SMatthew G. Knepley *tdm = dm->transformDM; 2362ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2363ca3d3a14SMatthew G. Knepley } 2364ca3d3a14SMatthew G. Knepley 2365ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv) 2366ca3d3a14SMatthew G. Knepley { 2367ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2368ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2369ca3d3a14SMatthew G. Knepley PetscValidPointer(tv, 2); 2370ca3d3a14SMatthew G. Knepley *tv = dm->transform; 2371ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2372ca3d3a14SMatthew G. Knepley } 2373ca3d3a14SMatthew G. Knepley 2374ca3d3a14SMatthew G. Knepley /*@ 2375c0f8e1fdSMatthew G. Knepley DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors 2376ca3d3a14SMatthew G. Knepley 2377ca3d3a14SMatthew G. Knepley Input Parameter: 2378ca3d3a14SMatthew G. Knepley . dm - The DM 2379ca3d3a14SMatthew G. Knepley 2380ca3d3a14SMatthew G. Knepley Output Parameter: 2381ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done 2382ca3d3a14SMatthew G. Knepley 2383ca3d3a14SMatthew G. Knepley Level: developer 2384ca3d3a14SMatthew G. Knepley 2385436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation() 2386ca3d3a14SMatthew G. Knepley @*/ 2387ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg) 2388ca3d3a14SMatthew G. Knepley { 2389ca3d3a14SMatthew G. Knepley Vec tv; 2390ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2391ca3d3a14SMatthew G. Knepley 2392ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2393ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2394534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 2395ca3d3a14SMatthew G. Knepley ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr); 2396ca3d3a14SMatthew G. Knepley *flg = tv ? PETSC_TRUE : PETSC_FALSE; 2397ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2398ca3d3a14SMatthew G. Knepley } 2399ca3d3a14SMatthew G. Knepley 2400ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm) 2401ca3d3a14SMatthew G. Knepley { 2402ca3d3a14SMatthew G. Knepley PetscSection s, ts; 2403ca3d3a14SMatthew G. Knepley PetscScalar *ta; 2404ca3d3a14SMatthew G. Knepley PetscInt cdim, pStart, pEnd, p, Nf, f, Nc, dof; 2405ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2406ca3d3a14SMatthew G. Knepley 2407ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2408ca3d3a14SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 240992fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 2410ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 2411ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr); 2412ca3d3a14SMatthew G. Knepley ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr); 241392fd8e1eSJed Brown ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr); 2414ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr); 2415ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr); 2416ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2417ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr); 2418ca3d3a14SMatthew G. Knepley /* We could start to label fields by their transformation properties */ 2419ca3d3a14SMatthew G. Knepley if (Nc != cdim) continue; 2420ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2421ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr); 2422ca3d3a14SMatthew G. Knepley if (!dof) continue; 2423ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr); 2424ca3d3a14SMatthew G. Knepley ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr); 2425ca3d3a14SMatthew G. Knepley } 2426ca3d3a14SMatthew G. Knepley } 2427ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetUp(ts);CHKERRQ(ierr); 2428ca3d3a14SMatthew G. Knepley ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr); 2429ca3d3a14SMatthew G. Knepley ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr); 2430ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2431ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2432ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr); 2433ca3d3a14SMatthew G. Knepley if (dof) { 2434ca3d3a14SMatthew G. Knepley PetscReal x[3] = {0.0, 0.0, 0.0}; 2435ca3d3a14SMatthew G. Knepley PetscScalar *tva; 2436ca3d3a14SMatthew G. Knepley const PetscScalar *A; 2437ca3d3a14SMatthew G. Knepley 2438ca3d3a14SMatthew G. Knepley /* TODO Get quadrature point for this dual basis vector for coordinate */ 2439ca3d3a14SMatthew G. Knepley ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr); 2440ca3d3a14SMatthew G. Knepley ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr); 2441580bdb30SBarry Smith ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr); 2442ca3d3a14SMatthew G. Knepley } 2443ca3d3a14SMatthew G. Knepley } 2444ca3d3a14SMatthew G. Knepley } 2445ca3d3a14SMatthew G. Knepley ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr); 2446ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2447ca3d3a14SMatthew G. Knepley } 2448ca3d3a14SMatthew G. Knepley 2449ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm) 2450ca3d3a14SMatthew G. Knepley { 2451ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2452ca3d3a14SMatthew G. Knepley 2453ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2454ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2455ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(newdm, DM_CLASSID, 2); 2456ca3d3a14SMatthew G. Knepley newdm->transformCtx = dm->transformCtx; 2457ca3d3a14SMatthew G. Knepley newdm->transformSetUp = dm->transformSetUp; 2458ca3d3a14SMatthew G. Knepley newdm->transformDestroy = NULL; 2459ca3d3a14SMatthew G. Knepley newdm->transformGetMatrix = dm->transformGetMatrix; 2460ca3d3a14SMatthew G. Knepley if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);} 2461ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2462ca3d3a14SMatthew G. Knepley } 2463ca3d3a14SMatthew G. Knepley 2464bb9467b5SJed Brown /*@C 2465baf369e7SPeter Brune DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called 2466baf369e7SPeter Brune 2467baf369e7SPeter Brune Logically Collective 2468baf369e7SPeter Brune 2469baf369e7SPeter Brune Input Arguments: 2470baf369e7SPeter Brune + dm - the DM 2471baf369e7SPeter Brune . beginhook - function to run at the beginning of DMGlobalToLocalBegin() 2472baf369e7SPeter Brune . endhook - function to run after DMGlobalToLocalEnd() has completed 24730298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2474baf369e7SPeter Brune 2475baf369e7SPeter Brune Calling sequence for beginhook: 2476baf369e7SPeter Brune $ beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2477baf369e7SPeter Brune 2478baf369e7SPeter Brune + dm - global DM 2479baf369e7SPeter Brune . g - global vector 2480baf369e7SPeter Brune . mode - mode 2481baf369e7SPeter Brune . l - local vector 2482baf369e7SPeter Brune - ctx - optional user-defined function context 2483baf369e7SPeter Brune 2484baf369e7SPeter Brune 2485baf369e7SPeter Brune Calling sequence for endhook: 2486ec4806b8SPeter Brune $ endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2487baf369e7SPeter Brune 2488baf369e7SPeter Brune + global - global DM 2489baf369e7SPeter Brune - ctx - optional user-defined function context 2490baf369e7SPeter Brune 2491baf369e7SPeter Brune Level: advanced 2492baf369e7SPeter Brune 2493baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2494baf369e7SPeter Brune @*/ 2495baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2496baf369e7SPeter Brune { 2497baf369e7SPeter Brune PetscErrorCode ierr; 2498baf369e7SPeter Brune DMGlobalToLocalHookLink link,*p; 2499baf369e7SPeter Brune 2500baf369e7SPeter Brune PetscFunctionBegin; 2501baf369e7SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2502baf369e7SPeter Brune for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 250395dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2504baf369e7SPeter Brune link->beginhook = beginhook; 2505baf369e7SPeter Brune link->endhook = endhook; 2506baf369e7SPeter Brune link->ctx = ctx; 25070298fd71SBarry Smith link->next = NULL; 2508baf369e7SPeter Brune *p = link; 2509baf369e7SPeter Brune PetscFunctionReturn(0); 2510baf369e7SPeter Brune } 2511baf369e7SPeter Brune 25124c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx) 25134c274da1SToby Isaac { 25144c274da1SToby Isaac Mat cMat; 25154c274da1SToby Isaac Vec cVec; 25164c274da1SToby Isaac PetscSection section, cSec; 25174c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 25184c274da1SToby Isaac PetscErrorCode ierr; 25194c274da1SToby Isaac 25204c274da1SToby Isaac PetscFunctionBegin; 25214c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 25224c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 25234c274da1SToby Isaac if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) { 25245db9a05bSToby Isaac PetscInt nRows; 25255db9a05bSToby Isaac 25265db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 25275db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 252892fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 25297711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 25304c274da1SToby Isaac ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr); 25314c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 25324c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 25334c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 25344c274da1SToby Isaac if (dof) { 25354c274da1SToby Isaac PetscScalar *vals; 25364c274da1SToby Isaac ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr); 25374c274da1SToby Isaac ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr); 25384c274da1SToby Isaac } 25394c274da1SToby Isaac } 25404c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 25414c274da1SToby Isaac } 25424c274da1SToby Isaac PetscFunctionReturn(0); 25434c274da1SToby Isaac } 25444c274da1SToby Isaac 254547c6ae99SBarry Smith /*@ 254601729b5cSPatrick Sanan DMGlobalToLocal - update local vectors from global vector 254701729b5cSPatrick Sanan 2548d083f849SBarry Smith Neighbor-wise Collective on dm 254901729b5cSPatrick Sanan 255001729b5cSPatrick Sanan Input Parameters: 255101729b5cSPatrick Sanan + dm - the DM object 255201729b5cSPatrick Sanan . g - the global vector 255301729b5cSPatrick Sanan . mode - INSERT_VALUES or ADD_VALUES 255401729b5cSPatrick Sanan - l - the local vector 255501729b5cSPatrick Sanan 255601729b5cSPatrick Sanan Notes: 255701729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 255801729b5cSPatrick Sanan DMGlobalToLocalBegin() and DMGlobalToLocalEnd(). 255901729b5cSPatrick Sanan 256001729b5cSPatrick Sanan Level: beginner 256101729b5cSPatrick Sanan 256201729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 256301729b5cSPatrick Sanan 256401729b5cSPatrick Sanan @*/ 256501729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l) 256601729b5cSPatrick Sanan { 256701729b5cSPatrick Sanan PetscErrorCode ierr; 256801729b5cSPatrick Sanan 256901729b5cSPatrick Sanan PetscFunctionBegin; 257001729b5cSPatrick Sanan ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr); 257101729b5cSPatrick Sanan ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr); 257201729b5cSPatrick Sanan PetscFunctionReturn(0); 257301729b5cSPatrick Sanan } 257401729b5cSPatrick Sanan 257501729b5cSPatrick Sanan /*@ 257647c6ae99SBarry Smith DMGlobalToLocalBegin - Begins updating local vectors from global vector 257747c6ae99SBarry Smith 2578d083f849SBarry Smith Neighbor-wise Collective on dm 257947c6ae99SBarry Smith 258047c6ae99SBarry Smith Input Parameters: 258147c6ae99SBarry Smith + dm - the DM object 258247c6ae99SBarry Smith . g - the global vector 258347c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 258447c6ae99SBarry Smith - l - the local vector 258547c6ae99SBarry Smith 258601729b5cSPatrick Sanan Level: intermediate 258747c6ae99SBarry Smith 258801729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 258947c6ae99SBarry Smith 259047c6ae99SBarry Smith @*/ 25917087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 259247c6ae99SBarry Smith { 25937128ae9fSMatthew G Knepley PetscSF sf; 259447c6ae99SBarry Smith PetscErrorCode ierr; 2595baf369e7SPeter Brune DMGlobalToLocalHookLink link; 259647c6ae99SBarry Smith 2597d0295fc0SJunchao Zhang 259847c6ae99SBarry Smith PetscFunctionBegin; 2599171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2600baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 26018865f1eaSKarl Rupp if (link->beginhook) { 26028865f1eaSKarl Rupp ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr); 26038865f1eaSKarl Rupp } 2604baf369e7SPeter Brune } 26051bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 26067128ae9fSMatthew G Knepley if (sf) { 2607ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2608ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2609d0295fc0SJunchao Zhang PetscMemType lmtype,gmtype; 26107128ae9fSMatthew G Knepley 261182f516ccSBarry Smith if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 2612a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2613a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2614ad227feaSJunchao Zhang ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr); 2615a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr); 2616a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr); 26177128ae9fSMatthew G Knepley } else { 261833907cc2SStefano Zampini if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name); 2619843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 26207128ae9fSMatthew G Knepley } 262147c6ae99SBarry Smith PetscFunctionReturn(0); 262247c6ae99SBarry Smith } 262347c6ae99SBarry Smith 262447c6ae99SBarry Smith /*@ 262547c6ae99SBarry Smith DMGlobalToLocalEnd - Ends updating local vectors from global vector 262647c6ae99SBarry Smith 2627d083f849SBarry Smith Neighbor-wise Collective on dm 262847c6ae99SBarry Smith 262947c6ae99SBarry Smith Input Parameters: 263047c6ae99SBarry Smith + dm - the DM object 263147c6ae99SBarry Smith . g - the global vector 263247c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 263347c6ae99SBarry Smith - l - the local vector 263447c6ae99SBarry Smith 263501729b5cSPatrick Sanan Level: intermediate 263647c6ae99SBarry Smith 263701729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 263847c6ae99SBarry Smith 263947c6ae99SBarry Smith @*/ 26407087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 264147c6ae99SBarry Smith { 26427128ae9fSMatthew G Knepley PetscSF sf; 264347c6ae99SBarry Smith PetscErrorCode ierr; 2644ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2645ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2646ca3d3a14SMatthew G. Knepley PetscBool transform; 2647baf369e7SPeter Brune DMGlobalToLocalHookLink link; 2648d0295fc0SJunchao Zhang PetscMemType lmtype,gmtype; 264947c6ae99SBarry Smith 265047c6ae99SBarry Smith PetscFunctionBegin; 2651171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 26521bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 2653ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 26547128ae9fSMatthew G Knepley if (sf) { 265582f516ccSBarry Smith if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 26567128ae9fSMatthew G Knepley 2657a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2658a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2659ad227feaSJunchao Zhang ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr); 2660a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr); 2661a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr); 2662ca3d3a14SMatthew G. Knepley if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);} 26637128ae9fSMatthew G Knepley } else { 266433907cc2SStefano Zampini if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name); 2665843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 26667128ae9fSMatthew G Knepley } 26674c274da1SToby Isaac ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr); 2668baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 2669baf369e7SPeter Brune if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 2670baf369e7SPeter Brune } 267147c6ae99SBarry Smith PetscFunctionReturn(0); 267247c6ae99SBarry Smith } 267347c6ae99SBarry Smith 2674d4d07f1eSToby Isaac /*@C 2675d4d07f1eSToby Isaac DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called 2676d4d07f1eSToby Isaac 2677d4d07f1eSToby Isaac Logically Collective 2678d4d07f1eSToby Isaac 2679d4d07f1eSToby Isaac Input Arguments: 2680d4d07f1eSToby Isaac + dm - the DM 2681d4d07f1eSToby Isaac . beginhook - function to run at the beginning of DMLocalToGlobalBegin() 2682d4d07f1eSToby Isaac . endhook - function to run after DMLocalToGlobalEnd() has completed 2683d4d07f1eSToby Isaac - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2684d4d07f1eSToby Isaac 2685d4d07f1eSToby Isaac Calling sequence for beginhook: 2686d4d07f1eSToby Isaac $ beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2687d4d07f1eSToby Isaac 2688d4d07f1eSToby Isaac + dm - global DM 2689d4d07f1eSToby Isaac . l - local vector 2690d4d07f1eSToby Isaac . mode - mode 2691d4d07f1eSToby Isaac . g - global vector 2692d4d07f1eSToby Isaac - ctx - optional user-defined function context 2693d4d07f1eSToby Isaac 2694d4d07f1eSToby Isaac 2695d4d07f1eSToby Isaac Calling sequence for endhook: 2696d4d07f1eSToby Isaac $ endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2697d4d07f1eSToby Isaac 2698d4d07f1eSToby Isaac + global - global DM 2699d4d07f1eSToby Isaac . l - local vector 2700d4d07f1eSToby Isaac . mode - mode 2701d4d07f1eSToby Isaac . g - global vector 2702d4d07f1eSToby Isaac - ctx - optional user-defined function context 2703d4d07f1eSToby Isaac 2704d4d07f1eSToby Isaac Level: advanced 2705d4d07f1eSToby Isaac 2706d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2707d4d07f1eSToby Isaac @*/ 2708d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2709d4d07f1eSToby Isaac { 2710d4d07f1eSToby Isaac PetscErrorCode ierr; 2711d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,*p; 2712d4d07f1eSToby Isaac 2713d4d07f1eSToby Isaac PetscFunctionBegin; 2714d4d07f1eSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2715d4d07f1eSToby Isaac for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 271695dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2717d4d07f1eSToby Isaac link->beginhook = beginhook; 2718d4d07f1eSToby Isaac link->endhook = endhook; 2719d4d07f1eSToby Isaac link->ctx = ctx; 2720d4d07f1eSToby Isaac link->next = NULL; 2721d4d07f1eSToby Isaac *p = link; 2722d4d07f1eSToby Isaac PetscFunctionReturn(0); 2723d4d07f1eSToby Isaac } 2724d4d07f1eSToby Isaac 27254c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx) 27264c274da1SToby Isaac { 27274c274da1SToby Isaac Mat cMat; 27284c274da1SToby Isaac Vec cVec; 27294c274da1SToby Isaac PetscSection section, cSec; 27304c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 27314c274da1SToby Isaac PetscErrorCode ierr; 27324c274da1SToby Isaac 27334c274da1SToby Isaac PetscFunctionBegin; 27344c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 27354c274da1SToby Isaac ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr); 27364c274da1SToby Isaac if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) { 27375db9a05bSToby Isaac PetscInt nRows; 27385db9a05bSToby Isaac 27395db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 27405db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 274192fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 27427711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 27434c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 27444c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 27454c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 27464c274da1SToby Isaac if (dof) { 27474c274da1SToby Isaac PetscInt d; 27484c274da1SToby Isaac PetscScalar *vals; 27494c274da1SToby Isaac ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr); 27504c274da1SToby Isaac ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr); 27514c274da1SToby Isaac /* for this to be the true transpose, we have to zero the values that 27524c274da1SToby Isaac * we just extracted */ 27534c274da1SToby Isaac for (d = 0; d < dof; d++) { 27544c274da1SToby Isaac vals[d] = 0.; 27554c274da1SToby Isaac } 27564c274da1SToby Isaac } 27574c274da1SToby Isaac } 27584c274da1SToby Isaac ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr); 27594c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 27604c274da1SToby Isaac } 27614c274da1SToby Isaac PetscFunctionReturn(0); 27624c274da1SToby Isaac } 276301729b5cSPatrick Sanan /*@ 276401729b5cSPatrick Sanan DMLocalToGlobal - updates global vectors from local vectors 276501729b5cSPatrick Sanan 2766d083f849SBarry Smith Neighbor-wise Collective on dm 276701729b5cSPatrick Sanan 276801729b5cSPatrick Sanan Input Parameters: 276901729b5cSPatrick Sanan + dm - the DM object 277001729b5cSPatrick Sanan . l - the local vector 277101729b5cSPatrick 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. 277201729b5cSPatrick Sanan - g - the global vector 277301729b5cSPatrick Sanan 277401729b5cSPatrick Sanan Notes: 277501729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 277601729b5cSPatrick Sanan DMLocalToGlobalBegin() and DMLocalToGlobalEnd(). 277701729b5cSPatrick Sanan 277801729b5cSPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 277901729b5cSPatrick 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. 278001729b5cSPatrick Sanan 278101729b5cSPatrick Sanan Level: beginner 278201729b5cSPatrick Sanan 278301729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 278401729b5cSPatrick Sanan 278501729b5cSPatrick Sanan @*/ 278601729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g) 278701729b5cSPatrick Sanan { 278801729b5cSPatrick Sanan PetscErrorCode ierr; 278901729b5cSPatrick Sanan 279001729b5cSPatrick Sanan PetscFunctionBegin; 279101729b5cSPatrick Sanan ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr); 279201729b5cSPatrick Sanan ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr); 279301729b5cSPatrick Sanan PetscFunctionReturn(0); 279401729b5cSPatrick Sanan } 27954c274da1SToby Isaac 279647c6ae99SBarry Smith /*@ 279701729b5cSPatrick Sanan DMLocalToGlobalBegin - begins updating global vectors from local vectors 27989a42bb27SBarry Smith 2799d083f849SBarry Smith Neighbor-wise Collective on dm 28009a42bb27SBarry Smith 28019a42bb27SBarry Smith Input Parameters: 28029a42bb27SBarry Smith + dm - the DM object 2803f6813fd5SJed Brown . l - the local vector 28041eb28f2eSBarry 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. 28051eb28f2eSBarry Smith - g - the global vector 28069a42bb27SBarry Smith 280795452b02SPatrick Sanan Notes: 280895452b02SPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 280984330215SMatthew 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. 28109a42bb27SBarry Smith 281101729b5cSPatrick Sanan Level: intermediate 28129a42bb27SBarry Smith 281301729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 28149a42bb27SBarry Smith 28159a42bb27SBarry Smith @*/ 28167087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g) 28179a42bb27SBarry Smith { 28187128ae9fSMatthew G Knepley PetscSF sf; 281984330215SMatthew G. Knepley PetscSection s, gs; 2820d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 2821ca3d3a14SMatthew G. Knepley Vec tmpl; 2822ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2823ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 2824fa88e482SJed Brown PetscBool isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE; 282584330215SMatthew G. Knepley PetscErrorCode ierr; 2826d0295fc0SJunchao Zhang PetscMemType lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST; 28279a42bb27SBarry Smith 28289a42bb27SBarry Smith PetscFunctionBegin; 2829171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2830d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2831d4d07f1eSToby Isaac if (link->beginhook) { 2832d4d07f1eSToby Isaac ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr); 2833d4d07f1eSToby Isaac } 2834d4d07f1eSToby Isaac } 28354c274da1SToby Isaac ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr); 28361bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 283792fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 28387128ae9fSMatthew G Knepley switch (mode) { 28397128ae9fSMatthew G Knepley case INSERT_VALUES: 28407128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 2841304ab55fSMatthew G. Knepley case INSERT_BC_VALUES: 284284330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 28437128ae9fSMatthew G Knepley case ADD_VALUES: 28447128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 2845304ab55fSMatthew G. Knepley case ADD_BC_VALUES: 284684330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 28477128ae9fSMatthew G Knepley default: 284882f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 28497128ae9fSMatthew G Knepley } 2850ca3d3a14SMatthew G. Knepley if ((sf && !isInsert) || (s && isInsert)) { 2851ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 2852ca3d3a14SMatthew G. Knepley if (transform) { 2853ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2854ca3d3a14SMatthew G. Knepley ierr = VecCopy(l, tmpl);CHKERRQ(ierr); 2855ca3d3a14SMatthew G. Knepley ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr); 2856ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2857fa88e482SJed Brown } else if (isInsert) { 2858ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 2859fa88e482SJed Brown } else { 2860a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2861fa88e482SJed Brown l_inplace = PETSC_TRUE; 2862ca3d3a14SMatthew G. Knepley } 2863fa88e482SJed Brown if (s && isInsert) { 28647128ae9fSMatthew G Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 2865fa88e482SJed Brown } else { 2866a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2867fa88e482SJed Brown g_inplace = PETSC_TRUE; 2868fa88e482SJed Brown } 2869ca3d3a14SMatthew G. Knepley if (sf && !isInsert) { 2870d0295fc0SJunchao Zhang ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr); 287184330215SMatthew G. Knepley } else if (s && isInsert) { 287284330215SMatthew G. Knepley PetscInt gStart, pStart, pEnd, p; 287384330215SMatthew G. Knepley 2874e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr); 287584330215SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 287684330215SMatthew G. Knepley ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr); 287784330215SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2878b3b16f48SMatthew G. Knepley PetscInt dof, gdof, cdof, gcdof, off, goff, d, e; 287984330215SMatthew G. Knepley 288084330215SMatthew G. Knepley ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr); 288103442857SMatthew G. Knepley ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr); 288284330215SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr); 2883b3b16f48SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr); 288484330215SMatthew G. Knepley ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr); 288584330215SMatthew G. Knepley ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr); 2886b3b16f48SMatthew G. Knepley /* Ignore off-process data and points with no global data */ 288703442857SMatthew G. Knepley if (!gdof || goff < 0) continue; 2888b3b16f48SMatthew G. Knepley if (dof != gdof) SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof); 2889b3b16f48SMatthew G. Knepley /* If no constraints are enforced in the global vector */ 2890b3b16f48SMatthew G. Knepley if (!gcdof) { 289184330215SMatthew G. Knepley for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d]; 2892b3b16f48SMatthew G. Knepley /* If constraints are enforced in the global vector */ 2893b3b16f48SMatthew G. Knepley } else if (cdof == gcdof) { 289484330215SMatthew G. Knepley const PetscInt *cdofs; 289584330215SMatthew G. Knepley PetscInt cind = 0; 289684330215SMatthew G. Knepley 289784330215SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr); 2898b3b16f48SMatthew G. Knepley for (d = 0, e = 0; d < dof; ++d) { 289984330215SMatthew G. Knepley if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;} 2900b3b16f48SMatthew G. Knepley gArray[goff-gStart+e++] = lArray[off+d]; 290184330215SMatthew G. Knepley } 2902b3b16f48SMatthew G. Knepley } else SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof); 290384330215SMatthew G. Knepley } 2904ca3d3a14SMatthew G. Knepley } 2905fa88e482SJed Brown if (g_inplace) { 2906a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr); 2907fa88e482SJed Brown } else { 29087128ae9fSMatthew G Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 2909fa88e482SJed Brown } 2910ca3d3a14SMatthew G. Knepley if (transform) { 2911ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2912ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2913fa88e482SJed Brown } else if (l_inplace) { 2914a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr); 2915ca3d3a14SMatthew G. Knepley } else { 2916ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 2917ca3d3a14SMatthew G. Knepley } 29187128ae9fSMatthew G Knepley } else { 2919b9d85ea2SLisandro Dalcin if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name); 2920843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 29217128ae9fSMatthew G Knepley } 29229a42bb27SBarry Smith PetscFunctionReturn(0); 29239a42bb27SBarry Smith } 29249a42bb27SBarry Smith 29259a42bb27SBarry Smith /*@ 29269a42bb27SBarry Smith DMLocalToGlobalEnd - updates global vectors from local vectors 292747c6ae99SBarry Smith 2928d083f849SBarry Smith Neighbor-wise Collective on dm 292947c6ae99SBarry Smith 293047c6ae99SBarry Smith Input Parameters: 293147c6ae99SBarry Smith + dm - the DM object 2932f6813fd5SJed Brown . l - the local vector 293347c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 2934f6813fd5SJed Brown - g - the global vector 293547c6ae99SBarry Smith 293601729b5cSPatrick Sanan Level: intermediate 293747c6ae99SBarry Smith 2938e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd() 293947c6ae99SBarry Smith 294047c6ae99SBarry Smith @*/ 29417087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g) 294247c6ae99SBarry Smith { 29437128ae9fSMatthew G Knepley PetscSF sf; 294484330215SMatthew G. Knepley PetscSection s; 2945d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 2946ca3d3a14SMatthew G. Knepley PetscBool isInsert, transform; 294784330215SMatthew G. Knepley PetscErrorCode ierr; 294847c6ae99SBarry Smith 294947c6ae99SBarry Smith PetscFunctionBegin; 2950171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 29511bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 295292fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 29537128ae9fSMatthew G Knepley switch (mode) { 29547128ae9fSMatthew G Knepley case INSERT_VALUES: 29557128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 295684330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 29577128ae9fSMatthew G Knepley case ADD_VALUES: 29587128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 295984330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 29607128ae9fSMatthew G Knepley default: 296182f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 29627128ae9fSMatthew G Knepley } 296384330215SMatthew G. Knepley if (sf && !isInsert) { 2964ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2965ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 2966ca3d3a14SMatthew G. Knepley Vec tmpl; 296784330215SMatthew G. Knepley 2968ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 2969ca3d3a14SMatthew G. Knepley if (transform) { 2970ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2971ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2972ca3d3a14SMatthew G. Knepley } else { 2973a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr); 2974ca3d3a14SMatthew G. Knepley } 2975a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr); 2976a9b180a6SBarry Smith ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr); 2977ca3d3a14SMatthew G. Knepley if (transform) { 2978ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2979ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2980ca3d3a14SMatthew G. Knepley } else { 2981a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr); 2982ca3d3a14SMatthew G. Knepley } 2983a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr); 298484330215SMatthew G. Knepley } else if (s && isInsert) { 29857128ae9fSMatthew G Knepley } else { 2986b9d85ea2SLisandro Dalcin if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name); 2987843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 29887128ae9fSMatthew G Knepley } 2989d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2990d4d07f1eSToby Isaac if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 2991d4d07f1eSToby Isaac } 299247c6ae99SBarry Smith PetscFunctionReturn(0); 299347c6ae99SBarry Smith } 299447c6ae99SBarry Smith 2995f089877aSRichard Tran Mills /*@ 2996bc0a1609SRichard Tran Mills DMLocalToLocalBegin - Maps from a local vector (including ghost points 2997bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 2998d78e899eSRichard Tran Mills points in the second are set correctly. Must be followed by DMLocalToLocalEnd(). 2999f089877aSRichard Tran Mills 3000d083f849SBarry Smith Neighbor-wise Collective on dm 3001f089877aSRichard Tran Mills 3002f089877aSRichard Tran Mills Input Parameters: 3003f089877aSRichard Tran Mills + dm - the DM object 3004bc0a1609SRichard Tran Mills . g - the original local vector 3005bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 3006f089877aSRichard Tran Mills 3007bc0a1609SRichard Tran Mills Output Parameter: 3008bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 3009f089877aSRichard Tran Mills 3010f089877aSRichard Tran Mills Level: intermediate 3011f089877aSRichard Tran Mills 3012bc0a1609SRichard Tran Mills Notes: 3013bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 3014bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 3015bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 3016bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 3017bc0a1609SRichard Tran Mills 3018bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 3019f089877aSRichard Tran Mills 3020f089877aSRichard Tran Mills @*/ 3021f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 3022f089877aSRichard Tran Mills { 3023f089877aSRichard Tran Mills PetscErrorCode ierr; 3024f089877aSRichard Tran Mills 3025f089877aSRichard Tran Mills PetscFunctionBegin; 3026f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3027bb358533SPatrick Sanan if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 3028f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 3029f089877aSRichard Tran Mills PetscFunctionReturn(0); 3030f089877aSRichard Tran Mills } 3031f089877aSRichard Tran Mills 3032f089877aSRichard Tran Mills /*@ 3033bc0a1609SRichard Tran Mills DMLocalToLocalEnd - Maps from a local vector (including ghost points 3034bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 3035d78e899eSRichard Tran Mills points in the second are set correctly. Must be preceded by DMLocalToLocalBegin(). 3036f089877aSRichard Tran Mills 3037d083f849SBarry Smith Neighbor-wise Collective on dm 3038f089877aSRichard Tran Mills 3039f089877aSRichard Tran Mills Input Parameters: 3040bc0a1609SRichard Tran Mills + da - the DM object 3041bc0a1609SRichard Tran Mills . g - the original local vector 3042bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 3043f089877aSRichard Tran Mills 3044bc0a1609SRichard Tran Mills Output Parameter: 3045bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 3046f089877aSRichard Tran Mills 3047f089877aSRichard Tran Mills Level: intermediate 3048f089877aSRichard Tran Mills 3049bc0a1609SRichard Tran Mills Notes: 3050bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 3051bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 3052bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 3053bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 3054bc0a1609SRichard Tran Mills 3055bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 3056f089877aSRichard Tran Mills 3057f089877aSRichard Tran Mills @*/ 3058f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 3059f089877aSRichard Tran Mills { 3060f089877aSRichard Tran Mills PetscErrorCode ierr; 3061f089877aSRichard Tran Mills 3062f089877aSRichard Tran Mills PetscFunctionBegin; 3063f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3064bb358533SPatrick Sanan if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 3065f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 3066f089877aSRichard Tran Mills PetscFunctionReturn(0); 3067f089877aSRichard Tran Mills } 3068f089877aSRichard Tran Mills 3069f089877aSRichard Tran Mills 307047c6ae99SBarry Smith /*@ 307147c6ae99SBarry Smith DMCoarsen - Coarsens a DM object 307247c6ae99SBarry Smith 3073d083f849SBarry Smith Collective on dm 307447c6ae99SBarry Smith 307547c6ae99SBarry Smith Input Parameter: 307647c6ae99SBarry Smith + dm - the DM object 307791d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 307847c6ae99SBarry Smith 307947c6ae99SBarry Smith Output Parameter: 308047c6ae99SBarry Smith . dmc - the coarsened DM 308147c6ae99SBarry Smith 308247c6ae99SBarry Smith Level: developer 308347c6ae99SBarry Smith 3084e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 308547c6ae99SBarry Smith 308647c6ae99SBarry Smith @*/ 30877087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc) 308847c6ae99SBarry Smith { 308947c6ae99SBarry Smith PetscErrorCode ierr; 3090b17ce1afSJed Brown DMCoarsenHookLink link; 309147c6ae99SBarry Smith 309247c6ae99SBarry Smith PetscFunctionBegin; 3093171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3094b9d85ea2SLisandro Dalcin if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name); 309547a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 309647c6ae99SBarry Smith ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr); 3097b9d85ea2SLisandro Dalcin if (*dmc) { 3098a8fb8f29SToby Isaac ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr); 309943842a1eSJed Brown (*dmc)->ops->creatematrix = dm->ops->creatematrix; 31008cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr); 3101644e2e5bSBarry Smith (*dmc)->ctx = dm->ctx; 31020598a293SJed Brown (*dmc)->levelup = dm->levelup; 3103656b349aSBarry Smith (*dmc)->leveldown = dm->leveldown + 1; 3104e4b4b23bSJed Brown ierr = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr); 3105b17ce1afSJed Brown for (link=dm->coarsenhook; link; link=link->next) { 3106b17ce1afSJed Brown if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);} 3107b17ce1afSJed Brown } 3108b9d85ea2SLisandro Dalcin } 310947a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 3110b9d85ea2SLisandro Dalcin if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced"); 3111b17ce1afSJed Brown PetscFunctionReturn(0); 3112b17ce1afSJed Brown } 3113b17ce1afSJed Brown 3114bb9467b5SJed Brown /*@C 3115b17ce1afSJed Brown DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid 3116b17ce1afSJed Brown 3117b17ce1afSJed Brown Logically Collective 3118b17ce1afSJed Brown 3119b17ce1afSJed Brown Input Arguments: 3120b17ce1afSJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 3121b17ce1afSJed Brown . coarsenhook - function to run when setting up a coarser level 3122b17ce1afSJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 31230298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3124b17ce1afSJed Brown 3125b17ce1afSJed Brown Calling sequence of coarsenhook: 3126b17ce1afSJed Brown $ coarsenhook(DM fine,DM coarse,void *ctx); 3127b17ce1afSJed Brown 3128b17ce1afSJed Brown + fine - fine level DM 3129b17ce1afSJed Brown . coarse - coarse level DM to restrict problem to 3130b17ce1afSJed Brown - ctx - optional user-defined function context 3131b17ce1afSJed Brown 3132b17ce1afSJed Brown Calling sequence for restricthook: 3133c833c3b5SJed Brown $ restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx) 3134b17ce1afSJed Brown 3135b17ce1afSJed Brown + fine - fine level DM 3136b17ce1afSJed Brown . mrestrict - matrix restricting a fine-level solution to the coarse grid 3137c833c3b5SJed Brown . rscale - scaling vector for restriction 3138c833c3b5SJed Brown . inject - matrix restricting by injection 3139b17ce1afSJed Brown . coarse - coarse level DM to update 3140b17ce1afSJed Brown - ctx - optional user-defined function context 3141b17ce1afSJed Brown 3142b17ce1afSJed Brown Level: advanced 3143b17ce1afSJed Brown 3144b17ce1afSJed Brown Notes: 3145b17ce1afSJed Brown This function is only needed if auxiliary data needs to be set up on coarse grids. 3146b17ce1afSJed Brown 3147b17ce1afSJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 3148b17ce1afSJed Brown 3149b17ce1afSJed Brown In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3150b17ce1afSJed Brown extract the finest level information from its context (instead of from the SNES). 3151b17ce1afSJed Brown 3152bb9467b5SJed Brown This function is currently not available from Fortran. 3153bb9467b5SJed Brown 3154dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3155b17ce1afSJed Brown @*/ 3156b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 3157b17ce1afSJed Brown { 3158b17ce1afSJed Brown PetscErrorCode ierr; 3159b17ce1afSJed Brown DMCoarsenHookLink link,*p; 3160b17ce1afSJed Brown 3161b17ce1afSJed Brown PetscFunctionBegin; 3162b17ce1afSJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 31631e3d8eccSJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 31641e3d8eccSJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 31651e3d8eccSJed Brown } 316695dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 3167b17ce1afSJed Brown link->coarsenhook = coarsenhook; 3168b17ce1afSJed Brown link->restricthook = restricthook; 3169b17ce1afSJed Brown link->ctx = ctx; 31700298fd71SBarry Smith link->next = NULL; 3171b17ce1afSJed Brown *p = link; 3172b17ce1afSJed Brown PetscFunctionReturn(0); 3173b17ce1afSJed Brown } 3174b17ce1afSJed Brown 3175dc822a44SJed Brown /*@C 3176dc822a44SJed Brown DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid 3177dc822a44SJed Brown 3178dc822a44SJed Brown Logically Collective 3179dc822a44SJed Brown 3180dc822a44SJed Brown Input Arguments: 3181dc822a44SJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 3182dc822a44SJed Brown . coarsenhook - function to run when setting up a coarser level 3183dc822a44SJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 3184dc822a44SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3185dc822a44SJed Brown 3186dc822a44SJed Brown Level: advanced 3187dc822a44SJed Brown 3188dc822a44SJed Brown Notes: 3189dc822a44SJed Brown This function does nothing if the hook is not in the list. 3190dc822a44SJed Brown 3191dc822a44SJed Brown This function is currently not available from Fortran. 3192dc822a44SJed Brown 3193dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3194dc822a44SJed Brown @*/ 3195dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 3196dc822a44SJed Brown { 3197dc822a44SJed Brown PetscErrorCode ierr; 3198dc822a44SJed Brown DMCoarsenHookLink link,*p; 3199dc822a44SJed Brown 3200dc822a44SJed Brown PetscFunctionBegin; 3201dc822a44SJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 3202dc822a44SJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3203dc822a44SJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3204dc822a44SJed Brown link = *p; 3205dc822a44SJed Brown *p = link->next; 3206dc822a44SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3207dc822a44SJed Brown break; 3208dc822a44SJed Brown } 3209dc822a44SJed Brown } 3210dc822a44SJed Brown PetscFunctionReturn(0); 3211dc822a44SJed Brown } 3212dc822a44SJed Brown 3213dc822a44SJed Brown 3214b17ce1afSJed Brown /*@ 3215b17ce1afSJed Brown DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd() 3216b17ce1afSJed Brown 3217b17ce1afSJed Brown Collective if any hooks are 3218b17ce1afSJed Brown 3219b17ce1afSJed Brown Input Arguments: 3220b17ce1afSJed Brown + fine - finer DM to use as a base 3221b17ce1afSJed Brown . restrct - restriction matrix, apply using MatRestrict() 3222e91eccc2SStefano Zampini . rscale - scaling vector for restriction 3223b17ce1afSJed Brown . inject - injection matrix, also use MatRestrict() 3224e91eccc2SStefano Zampini - coarse - coarser DM to update 3225b17ce1afSJed Brown 3226b17ce1afSJed Brown Level: developer 3227b17ce1afSJed Brown 3228b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict() 3229b17ce1afSJed Brown @*/ 3230b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse) 3231b17ce1afSJed Brown { 3232b17ce1afSJed Brown PetscErrorCode ierr; 3233b17ce1afSJed Brown DMCoarsenHookLink link; 3234b17ce1afSJed Brown 3235b17ce1afSJed Brown PetscFunctionBegin; 3236b17ce1afSJed Brown for (link=fine->coarsenhook; link; link=link->next) { 32378865f1eaSKarl Rupp if (link->restricthook) { 32388865f1eaSKarl Rupp ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr); 32398865f1eaSKarl Rupp } 3240b17ce1afSJed Brown } 324147c6ae99SBarry Smith PetscFunctionReturn(0); 324247c6ae99SBarry Smith } 324347c6ae99SBarry Smith 3244bb9467b5SJed Brown /*@C 3245be081cd6SPeter Brune DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid 32465dbd56e3SPeter Brune 3247d083f849SBarry Smith Logically Collective on global 32485dbd56e3SPeter Brune 32495dbd56e3SPeter Brune Input Arguments: 32505dbd56e3SPeter Brune + global - global DM 3251ec4806b8SPeter Brune . ddhook - function to run to pass data to the decomposition DM upon its creation 32525dbd56e3SPeter Brune . restricthook - function to run to update data on block solve (at the beginning of the block solve) 32530298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 32545dbd56e3SPeter Brune 3255ec4806b8SPeter Brune 3256ec4806b8SPeter Brune Calling sequence for ddhook: 3257ec4806b8SPeter Brune $ ddhook(DM global,DM block,void *ctx) 3258ec4806b8SPeter Brune 3259ec4806b8SPeter Brune + global - global DM 3260ec4806b8SPeter Brune . block - block DM 3261ec4806b8SPeter Brune - ctx - optional user-defined function context 3262ec4806b8SPeter Brune 32635dbd56e3SPeter Brune Calling sequence for restricthook: 3264ec4806b8SPeter Brune $ restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx) 32655dbd56e3SPeter Brune 32665dbd56e3SPeter Brune + global - global DM 32675dbd56e3SPeter Brune . out - scatter to the outer (with ghost and overlap points) block vector 32685dbd56e3SPeter Brune . in - scatter to block vector values only owned locally 3269ec4806b8SPeter Brune . block - block DM 32705dbd56e3SPeter Brune - ctx - optional user-defined function context 32715dbd56e3SPeter Brune 32725dbd56e3SPeter Brune Level: advanced 32735dbd56e3SPeter Brune 32745dbd56e3SPeter Brune Notes: 3275ec4806b8SPeter Brune This function is only needed if auxiliary data needs to be set up on subdomain DMs. 32765dbd56e3SPeter Brune 32775dbd56e3SPeter Brune If this function is called multiple times, the hooks will be run in the order they are added. 32785dbd56e3SPeter Brune 32795dbd56e3SPeter Brune In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3280ec4806b8SPeter Brune extract the global information from its context (instead of from the SNES). 32815dbd56e3SPeter Brune 3282bb9467b5SJed Brown This function is currently not available from Fortran. 3283bb9467b5SJed Brown 32845dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 32855dbd56e3SPeter Brune @*/ 3286be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 32875dbd56e3SPeter Brune { 32885dbd56e3SPeter Brune PetscErrorCode ierr; 3289be081cd6SPeter Brune DMSubDomainHookLink link,*p; 32905dbd56e3SPeter Brune 32915dbd56e3SPeter Brune PetscFunctionBegin; 32925dbd56e3SPeter Brune PetscValidHeaderSpecific(global,DM_CLASSID,1); 3293b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 3294b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 3295b3a6b972SJed Brown } 329695dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 32975dbd56e3SPeter Brune link->restricthook = restricthook; 3298be081cd6SPeter Brune link->ddhook = ddhook; 32995dbd56e3SPeter Brune link->ctx = ctx; 33000298fd71SBarry Smith link->next = NULL; 33015dbd56e3SPeter Brune *p = link; 33025dbd56e3SPeter Brune PetscFunctionReturn(0); 33035dbd56e3SPeter Brune } 33045dbd56e3SPeter Brune 3305b3a6b972SJed Brown /*@C 3306b3a6b972SJed Brown DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid 3307b3a6b972SJed Brown 3308b3a6b972SJed Brown Logically Collective 3309b3a6b972SJed Brown 3310b3a6b972SJed Brown Input Arguments: 3311b3a6b972SJed Brown + global - global DM 3312b3a6b972SJed Brown . ddhook - function to run to pass data to the decomposition DM upon its creation 3313b3a6b972SJed Brown . restricthook - function to run to update data on block solve (at the beginning of the block solve) 3314b3a6b972SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3315b3a6b972SJed Brown 3316b3a6b972SJed Brown Level: advanced 3317b3a6b972SJed Brown 3318b3a6b972SJed Brown Notes: 3319b3a6b972SJed Brown 3320b3a6b972SJed Brown This function is currently not available from Fortran. 3321b3a6b972SJed Brown 3322b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3323b3a6b972SJed Brown @*/ 3324b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 3325b3a6b972SJed Brown { 3326b3a6b972SJed Brown PetscErrorCode ierr; 3327b3a6b972SJed Brown DMSubDomainHookLink link,*p; 3328b3a6b972SJed Brown 3329b3a6b972SJed Brown PetscFunctionBegin; 3330b3a6b972SJed Brown PetscValidHeaderSpecific(global,DM_CLASSID,1); 3331b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3332b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3333b3a6b972SJed Brown link = *p; 3334b3a6b972SJed Brown *p = link->next; 3335b3a6b972SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3336b3a6b972SJed Brown break; 3337b3a6b972SJed Brown } 3338b3a6b972SJed Brown } 3339b3a6b972SJed Brown PetscFunctionReturn(0); 3340b3a6b972SJed Brown } 3341b3a6b972SJed Brown 33425dbd56e3SPeter Brune /*@ 3343be081cd6SPeter Brune DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd() 33445dbd56e3SPeter Brune 33455dbd56e3SPeter Brune Collective if any hooks are 33465dbd56e3SPeter Brune 33475dbd56e3SPeter Brune Input Arguments: 33485dbd56e3SPeter Brune + fine - finer DM to use as a base 3349be081cd6SPeter Brune . oscatter - scatter from domain global vector filling subdomain global vector with overlap 3350be081cd6SPeter Brune . gscatter - scatter from domain global vector filling subdomain local vector with ghosts 33515dbd56e3SPeter Brune - coarse - coarer DM to update 33525dbd56e3SPeter Brune 33535dbd56e3SPeter Brune Level: developer 33545dbd56e3SPeter Brune 33555dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict() 33565dbd56e3SPeter Brune @*/ 3357be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm) 33585dbd56e3SPeter Brune { 33595dbd56e3SPeter Brune PetscErrorCode ierr; 3360be081cd6SPeter Brune DMSubDomainHookLink link; 33615dbd56e3SPeter Brune 33625dbd56e3SPeter Brune PetscFunctionBegin; 3363be081cd6SPeter Brune for (link=global->subdomainhook; link; link=link->next) { 33648865f1eaSKarl Rupp if (link->restricthook) { 33658865f1eaSKarl Rupp ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr); 33668865f1eaSKarl Rupp } 33675dbd56e3SPeter Brune } 33685dbd56e3SPeter Brune PetscFunctionReturn(0); 33695dbd56e3SPeter Brune } 33705dbd56e3SPeter Brune 33715fe1f584SPeter Brune /*@ 33726a7d9d85SPeter Brune DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM. 33735fe1f584SPeter Brune 33745fe1f584SPeter Brune Not Collective 33755fe1f584SPeter Brune 33765fe1f584SPeter Brune Input Parameter: 33775fe1f584SPeter Brune . dm - the DM object 33785fe1f584SPeter Brune 33795fe1f584SPeter Brune Output Parameter: 33806a7d9d85SPeter Brune . level - number of coarsenings 33815fe1f584SPeter Brune 33825fe1f584SPeter Brune Level: developer 33835fe1f584SPeter Brune 33846a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 33855fe1f584SPeter Brune 33865fe1f584SPeter Brune @*/ 33875fe1f584SPeter Brune PetscErrorCode DMGetCoarsenLevel(DM dm,PetscInt *level) 33885fe1f584SPeter Brune { 33895fe1f584SPeter Brune PetscFunctionBegin; 33905fe1f584SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3391b9d85ea2SLisandro Dalcin PetscValidIntPointer(level,2); 33925fe1f584SPeter Brune *level = dm->leveldown; 33935fe1f584SPeter Brune PetscFunctionReturn(0); 33945fe1f584SPeter Brune } 33955fe1f584SPeter Brune 33969a64c4a8SMatthew G. Knepley /*@ 33979a64c4a8SMatthew G. Knepley DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM. 33989a64c4a8SMatthew G. Knepley 33999a64c4a8SMatthew G. Knepley Not Collective 34009a64c4a8SMatthew G. Knepley 34019a64c4a8SMatthew G. Knepley Input Parameters: 34029a64c4a8SMatthew G. Knepley + dm - the DM object 34039a64c4a8SMatthew G. Knepley - level - number of coarsenings 34049a64c4a8SMatthew G. Knepley 34059a64c4a8SMatthew G. Knepley Level: developer 34069a64c4a8SMatthew G. Knepley 34079a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 34089a64c4a8SMatthew G. Knepley @*/ 34099a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level) 34109a64c4a8SMatthew G. Knepley { 34119a64c4a8SMatthew G. Knepley PetscFunctionBegin; 34129a64c4a8SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 34139a64c4a8SMatthew G. Knepley dm->leveldown = level; 34149a64c4a8SMatthew G. Knepley PetscFunctionReturn(0); 34159a64c4a8SMatthew G. Knepley } 34169a64c4a8SMatthew G. Knepley 34175fe1f584SPeter Brune 34185fe1f584SPeter Brune 341947c6ae99SBarry Smith /*@C 342047c6ae99SBarry Smith DMRefineHierarchy - Refines a DM object, all levels at once 342147c6ae99SBarry Smith 3422d083f849SBarry Smith Collective on dm 342347c6ae99SBarry Smith 342447c6ae99SBarry Smith Input Parameter: 342547c6ae99SBarry Smith + dm - the DM object 342647c6ae99SBarry Smith - nlevels - the number of levels of refinement 342747c6ae99SBarry Smith 342847c6ae99SBarry Smith Output Parameter: 342947c6ae99SBarry Smith . dmf - the refined DM hierarchy 343047c6ae99SBarry Smith 343147c6ae99SBarry Smith Level: developer 343247c6ae99SBarry Smith 3433e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 343447c6ae99SBarry Smith 343547c6ae99SBarry Smith @*/ 34367087cfbeSBarry Smith PetscErrorCode DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[]) 343747c6ae99SBarry Smith { 343847c6ae99SBarry Smith PetscErrorCode ierr; 343947c6ae99SBarry Smith 344047c6ae99SBarry Smith PetscFunctionBegin; 3441171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3442ce94432eSBarry Smith if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 344347c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 3444b9d85ea2SLisandro Dalcin PetscValidPointer(dmf,3); 344547c6ae99SBarry Smith if (dm->ops->refinehierarchy) { 344647c6ae99SBarry Smith ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr); 344747c6ae99SBarry Smith } else if (dm->ops->refine) { 344847c6ae99SBarry Smith PetscInt i; 344947c6ae99SBarry Smith 3450ce94432eSBarry Smith ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr); 345147c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3452ce94432eSBarry Smith ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr); 345347c6ae99SBarry Smith } 3454ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet"); 345547c6ae99SBarry Smith PetscFunctionReturn(0); 345647c6ae99SBarry Smith } 345747c6ae99SBarry Smith 345847c6ae99SBarry Smith /*@C 345947c6ae99SBarry Smith DMCoarsenHierarchy - Coarsens a DM object, all levels at once 346047c6ae99SBarry Smith 3461d083f849SBarry Smith Collective on dm 346247c6ae99SBarry Smith 346347c6ae99SBarry Smith Input Parameter: 346447c6ae99SBarry Smith + dm - the DM object 346547c6ae99SBarry Smith - nlevels - the number of levels of coarsening 346647c6ae99SBarry Smith 346747c6ae99SBarry Smith Output Parameter: 346847c6ae99SBarry Smith . dmc - the coarsened DM hierarchy 346947c6ae99SBarry Smith 347047c6ae99SBarry Smith Level: developer 347147c6ae99SBarry Smith 3472e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 347347c6ae99SBarry Smith 347447c6ae99SBarry Smith @*/ 34757087cfbeSBarry Smith PetscErrorCode DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[]) 347647c6ae99SBarry Smith { 347747c6ae99SBarry Smith PetscErrorCode ierr; 347847c6ae99SBarry Smith 347947c6ae99SBarry Smith PetscFunctionBegin; 3480171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3481ce94432eSBarry Smith if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 348247c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 348347c6ae99SBarry Smith PetscValidPointer(dmc,3); 348447c6ae99SBarry Smith if (dm->ops->coarsenhierarchy) { 348547c6ae99SBarry Smith ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr); 348647c6ae99SBarry Smith } else if (dm->ops->coarsen) { 348747c6ae99SBarry Smith PetscInt i; 348847c6ae99SBarry Smith 3489ce94432eSBarry Smith ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr); 349047c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3491ce94432eSBarry Smith ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr); 349247c6ae99SBarry Smith } 3493ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet"); 349447c6ae99SBarry Smith PetscFunctionReturn(0); 349547c6ae99SBarry Smith } 349647c6ae99SBarry Smith 34971a266240SBarry Smith /*@C 34981a266240SBarry Smith DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed 34991a266240SBarry Smith 35001a266240SBarry Smith Not Collective 35011a266240SBarry Smith 35021a266240SBarry Smith Input Parameters: 35031a266240SBarry Smith + dm - the DM object 35041a266240SBarry Smith - destroy - the destroy function 35051a266240SBarry Smith 35061a266240SBarry Smith Level: intermediate 35071a266240SBarry Smith 3508e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 35091a266240SBarry Smith 3510f07f9ceaSJed Brown @*/ 35111a266240SBarry Smith PetscErrorCode DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**)) 35121a266240SBarry Smith { 35131a266240SBarry Smith PetscFunctionBegin; 3514171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35151a266240SBarry Smith dm->ctxdestroy = destroy; 35161a266240SBarry Smith PetscFunctionReturn(0); 35171a266240SBarry Smith } 35181a266240SBarry Smith 3519b07ff414SBarry Smith /*@ 35201b2093e4SBarry Smith DMSetApplicationContext - Set a user context into a DM object 352147c6ae99SBarry Smith 352247c6ae99SBarry Smith Not Collective 352347c6ae99SBarry Smith 352447c6ae99SBarry Smith Input Parameters: 352547c6ae99SBarry Smith + dm - the DM object 352647c6ae99SBarry Smith - ctx - the user context 352747c6ae99SBarry Smith 352847c6ae99SBarry Smith Level: intermediate 352947c6ae99SBarry Smith 3530e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 353147c6ae99SBarry Smith 353247c6ae99SBarry Smith @*/ 35331b2093e4SBarry Smith PetscErrorCode DMSetApplicationContext(DM dm,void *ctx) 353447c6ae99SBarry Smith { 353547c6ae99SBarry Smith PetscFunctionBegin; 3536171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 353747c6ae99SBarry Smith dm->ctx = ctx; 353847c6ae99SBarry Smith PetscFunctionReturn(0); 353947c6ae99SBarry Smith } 354047c6ae99SBarry Smith 354147c6ae99SBarry Smith /*@ 35421b2093e4SBarry Smith DMGetApplicationContext - Gets a user context from a DM object 354347c6ae99SBarry Smith 354447c6ae99SBarry Smith Not Collective 354547c6ae99SBarry Smith 354647c6ae99SBarry Smith Input Parameter: 354747c6ae99SBarry Smith . dm - the DM object 354847c6ae99SBarry Smith 354947c6ae99SBarry Smith Output Parameter: 355047c6ae99SBarry Smith . ctx - the user context 355147c6ae99SBarry Smith 355247c6ae99SBarry Smith Level: intermediate 355347c6ae99SBarry Smith 3554e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 355547c6ae99SBarry Smith 355647c6ae99SBarry Smith @*/ 35571b2093e4SBarry Smith PetscErrorCode DMGetApplicationContext(DM dm,void *ctx) 355847c6ae99SBarry Smith { 355947c6ae99SBarry Smith PetscFunctionBegin; 3560171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35611b2093e4SBarry Smith *(void**)ctx = dm->ctx; 356247c6ae99SBarry Smith PetscFunctionReturn(0); 356347c6ae99SBarry Smith } 356447c6ae99SBarry Smith 356508da532bSDmitry Karpeev /*@C 3566df3898eeSBarry Smith DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI. 356708da532bSDmitry Karpeev 3568d083f849SBarry Smith Logically Collective on dm 356908da532bSDmitry Karpeev 357008da532bSDmitry Karpeev Input Parameter: 357108da532bSDmitry Karpeev + dm - the DM object 35720298fd71SBarry Smith - f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set) 357308da532bSDmitry Karpeev 357408da532bSDmitry Karpeev Level: intermediate 357508da532bSDmitry Karpeev 3576835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(), 357708da532bSDmitry Karpeev DMSetJacobian() 357808da532bSDmitry Karpeev 357908da532bSDmitry Karpeev @*/ 358008da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec)) 358108da532bSDmitry Karpeev { 358208da532bSDmitry Karpeev PetscFunctionBegin; 35835a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 358408da532bSDmitry Karpeev dm->ops->computevariablebounds = f; 358508da532bSDmitry Karpeev PetscFunctionReturn(0); 358608da532bSDmitry Karpeev } 358708da532bSDmitry Karpeev 358808da532bSDmitry Karpeev /*@ 358908da532bSDmitry Karpeev DMHasVariableBounds - does the DM object have a variable bounds function? 359008da532bSDmitry Karpeev 359108da532bSDmitry Karpeev Not Collective 359208da532bSDmitry Karpeev 359308da532bSDmitry Karpeev Input Parameter: 359408da532bSDmitry Karpeev . dm - the DM object to destroy 359508da532bSDmitry Karpeev 359608da532bSDmitry Karpeev Output Parameter: 359708da532bSDmitry Karpeev . flg - PETSC_TRUE if the variable bounds function exists 359808da532bSDmitry Karpeev 359908da532bSDmitry Karpeev Level: developer 360008da532bSDmitry Karpeev 360174e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 360208da532bSDmitry Karpeev 360308da532bSDmitry Karpeev @*/ 360408da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg) 360508da532bSDmitry Karpeev { 360608da532bSDmitry Karpeev PetscFunctionBegin; 36075a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3608534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 360908da532bSDmitry Karpeev *flg = (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE; 361008da532bSDmitry Karpeev PetscFunctionReturn(0); 361108da532bSDmitry Karpeev } 361208da532bSDmitry Karpeev 361308da532bSDmitry Karpeev /*@C 361408da532bSDmitry Karpeev DMComputeVariableBounds - compute variable bounds used by SNESVI. 361508da532bSDmitry Karpeev 3616d083f849SBarry Smith Logically Collective on dm 361708da532bSDmitry Karpeev 361808da532bSDmitry Karpeev Input Parameters: 3619907376e6SBarry Smith . dm - the DM object 362008da532bSDmitry Karpeev 362108da532bSDmitry Karpeev Output parameters: 362208da532bSDmitry Karpeev + xl - lower bound 362308da532bSDmitry Karpeev - xu - upper bound 362408da532bSDmitry Karpeev 3625907376e6SBarry Smith Level: advanced 3626907376e6SBarry Smith 362795452b02SPatrick Sanan Notes: 362895452b02SPatrick Sanan This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds() 362908da532bSDmitry Karpeev 363074e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 363108da532bSDmitry Karpeev 363208da532bSDmitry Karpeev @*/ 363308da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu) 363408da532bSDmitry Karpeev { 363508da532bSDmitry Karpeev PetscErrorCode ierr; 36365fd66863SKarl Rupp 363708da532bSDmitry Karpeev PetscFunctionBegin; 36385a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 363908da532bSDmitry Karpeev PetscValidHeaderSpecific(xl,VEC_CLASSID,2); 36405a84ad33SLisandro Dalcin PetscValidHeaderSpecific(xu,VEC_CLASSID,3); 3641b9d85ea2SLisandro Dalcin if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name); 364208da532bSDmitry Karpeev ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr); 364308da532bSDmitry Karpeev PetscFunctionReturn(0); 364408da532bSDmitry Karpeev } 364508da532bSDmitry Karpeev 3646b0ae01b7SPeter Brune /*@ 3647b0ae01b7SPeter Brune DMHasColoring - does the DM object have a method of providing a coloring? 3648b0ae01b7SPeter Brune 3649b0ae01b7SPeter Brune Not Collective 3650b0ae01b7SPeter Brune 3651b0ae01b7SPeter Brune Input Parameter: 3652b0ae01b7SPeter Brune . dm - the DM object 3653b0ae01b7SPeter Brune 3654b0ae01b7SPeter Brune Output Parameter: 3655b0ae01b7SPeter Brune . flg - PETSC_TRUE if the DM has facilities for DMCreateColoring(). 3656b0ae01b7SPeter Brune 3657b0ae01b7SPeter Brune Level: developer 3658b0ae01b7SPeter Brune 36591565f0a7SPatrick Sanan .seealso DMCreateColoring() 3660b0ae01b7SPeter Brune 3661b0ae01b7SPeter Brune @*/ 3662b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg) 3663b0ae01b7SPeter Brune { 3664b0ae01b7SPeter Brune PetscFunctionBegin; 36655a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3666534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 3667b0ae01b7SPeter Brune *flg = (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE; 3668b0ae01b7SPeter Brune PetscFunctionReturn(0); 3669b0ae01b7SPeter Brune } 3670b0ae01b7SPeter Brune 36713ad4599aSBarry Smith /*@ 36723ad4599aSBarry Smith DMHasCreateRestriction - does the DM object have a method of providing a restriction? 36733ad4599aSBarry Smith 36743ad4599aSBarry Smith Not Collective 36753ad4599aSBarry Smith 36763ad4599aSBarry Smith Input Parameter: 36773ad4599aSBarry Smith . dm - the DM object 36783ad4599aSBarry Smith 36793ad4599aSBarry Smith Output Parameter: 36803ad4599aSBarry Smith . flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction(). 36813ad4599aSBarry Smith 36823ad4599aSBarry Smith Level: developer 36833ad4599aSBarry Smith 36841565f0a7SPatrick Sanan .seealso DMCreateRestriction() 36853ad4599aSBarry Smith 36863ad4599aSBarry Smith @*/ 36873ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg) 36883ad4599aSBarry Smith { 36893ad4599aSBarry Smith PetscFunctionBegin; 36905a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3691534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 36923ad4599aSBarry Smith *flg = (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE; 36933ad4599aSBarry Smith PetscFunctionReturn(0); 36943ad4599aSBarry Smith } 36953ad4599aSBarry Smith 3696a7058e45SLawrence Mitchell 3697a7058e45SLawrence Mitchell /*@ 3698a7058e45SLawrence Mitchell DMHasCreateInjection - does the DM object have a method of providing an injection? 3699a7058e45SLawrence Mitchell 3700a7058e45SLawrence Mitchell Not Collective 3701a7058e45SLawrence Mitchell 3702a7058e45SLawrence Mitchell Input Parameter: 3703a7058e45SLawrence Mitchell . dm - the DM object 3704a7058e45SLawrence Mitchell 3705a7058e45SLawrence Mitchell Output Parameter: 3706a7058e45SLawrence Mitchell . flg - PETSC_TRUE if the DM has facilities for DMCreateInjection(). 3707a7058e45SLawrence Mitchell 3708a7058e45SLawrence Mitchell Level: developer 3709a7058e45SLawrence Mitchell 37101565f0a7SPatrick Sanan .seealso DMCreateInjection() 3711a7058e45SLawrence Mitchell 3712a7058e45SLawrence Mitchell @*/ 3713a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg) 3714a7058e45SLawrence Mitchell { 37154a7a4c06SLawrence Mitchell PetscErrorCode ierr; 37165a84ad33SLisandro Dalcin 3717a7058e45SLawrence Mitchell PetscFunctionBegin; 37185a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3719534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 37205a84ad33SLisandro Dalcin if (dm->ops->hascreateinjection) { 37214a7a4c06SLawrence Mitchell ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr); 37225a84ad33SLisandro Dalcin } else { 37235a84ad33SLisandro Dalcin *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE; 37245a84ad33SLisandro Dalcin } 3725a7058e45SLawrence Mitchell PetscFunctionReturn(0); 3726a7058e45SLawrence Mitchell } 3727a7058e45SLawrence Mitchell 37280298fd71SBarry Smith PetscFunctionList DMList = NULL; 3729264ace61SBarry Smith PetscBool DMRegisterAllCalled = PETSC_FALSE; 3730264ace61SBarry Smith 3731264ace61SBarry Smith /*@C 3732264ace61SBarry Smith DMSetType - Builds a DM, for a particular DM implementation. 3733264ace61SBarry Smith 3734d083f849SBarry Smith Collective on dm 3735264ace61SBarry Smith 3736264ace61SBarry Smith Input Parameters: 3737264ace61SBarry Smith + dm - The DM object 3738264ace61SBarry Smith - method - The name of the DM type 3739264ace61SBarry Smith 3740264ace61SBarry Smith Options Database Key: 3741264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types 3742264ace61SBarry Smith 3743264ace61SBarry Smith Notes: 3744e1589f56SBarry Smith See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D). 3745264ace61SBarry Smith 3746264ace61SBarry Smith Level: intermediate 3747264ace61SBarry Smith 3748264ace61SBarry Smith .seealso: DMGetType(), DMCreate() 3749264ace61SBarry Smith @*/ 375019fd82e9SBarry Smith PetscErrorCode DMSetType(DM dm, DMType method) 3751264ace61SBarry Smith { 3752264ace61SBarry Smith PetscErrorCode (*r)(DM); 3753264ace61SBarry Smith PetscBool match; 3754264ace61SBarry Smith PetscErrorCode ierr; 3755264ace61SBarry Smith 3756264ace61SBarry Smith PetscFunctionBegin; 3757264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3758251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr); 3759264ace61SBarry Smith if (match) PetscFunctionReturn(0); 3760264ace61SBarry Smith 37610f51fdf8SToby Isaac ierr = DMRegisterAll();CHKERRQ(ierr); 37621c9cd337SJed Brown ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr); 3763ce94432eSBarry Smith if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method); 3764264ace61SBarry Smith 3765264ace61SBarry Smith if (dm->ops->destroy) { 3766264ace61SBarry Smith ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr); 3767264ace61SBarry Smith } 3768d57f96a3SLisandro Dalcin ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr); 3769264ace61SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr); 3770d57f96a3SLisandro Dalcin ierr = (*r)(dm);CHKERRQ(ierr); 3771264ace61SBarry Smith PetscFunctionReturn(0); 3772264ace61SBarry Smith } 3773264ace61SBarry Smith 3774264ace61SBarry Smith /*@C 3775264ace61SBarry Smith DMGetType - Gets the DM type name (as a string) from the DM. 3776264ace61SBarry Smith 3777264ace61SBarry Smith Not Collective 3778264ace61SBarry Smith 3779264ace61SBarry Smith Input Parameter: 3780264ace61SBarry Smith . dm - The DM 3781264ace61SBarry Smith 3782264ace61SBarry Smith Output Parameter: 3783264ace61SBarry Smith . type - The DM type name 3784264ace61SBarry Smith 3785264ace61SBarry Smith Level: intermediate 3786264ace61SBarry Smith 3787264ace61SBarry Smith .seealso: DMSetType(), DMCreate() 3788264ace61SBarry Smith @*/ 378919fd82e9SBarry Smith PetscErrorCode DMGetType(DM dm, DMType *type) 3790264ace61SBarry Smith { 3791264ace61SBarry Smith PetscErrorCode ierr; 3792264ace61SBarry Smith 3793264ace61SBarry Smith PetscFunctionBegin; 3794264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3795c959eef4SJed Brown PetscValidPointer(type,2); 3796607a6623SBarry Smith ierr = DMRegisterAll();CHKERRQ(ierr); 3797264ace61SBarry Smith *type = ((PetscObject)dm)->type_name; 3798264ace61SBarry Smith PetscFunctionReturn(0); 3799264ace61SBarry Smith } 3800264ace61SBarry Smith 380167a56275SMatthew G Knepley /*@C 380267a56275SMatthew G Knepley DMConvert - Converts a DM to another DM, either of the same or different type. 380367a56275SMatthew G Knepley 3804d083f849SBarry Smith Collective on dm 380567a56275SMatthew G Knepley 380667a56275SMatthew G Knepley Input Parameters: 380767a56275SMatthew G Knepley + dm - the DM 380867a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type) 380967a56275SMatthew G Knepley 381067a56275SMatthew G Knepley Output Parameter: 381167a56275SMatthew G Knepley . M - pointer to new DM 381267a56275SMatthew G Knepley 381367a56275SMatthew G Knepley Notes: 381467a56275SMatthew G Knepley Cannot be used to convert a sequential DM to parallel or parallel to sequential, 381567a56275SMatthew G Knepley the MPI communicator of the generated DM is always the same as the communicator 381667a56275SMatthew G Knepley of the input DM. 381767a56275SMatthew G Knepley 381867a56275SMatthew G Knepley Level: intermediate 381967a56275SMatthew G Knepley 382067a56275SMatthew G Knepley .seealso: DMCreate() 382167a56275SMatthew G Knepley @*/ 382219fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M) 382367a56275SMatthew G Knepley { 382467a56275SMatthew G Knepley DM B; 382567a56275SMatthew G Knepley char convname[256]; 3826c067b6caSMatthew G. Knepley PetscBool sametype/*, issame */; 382767a56275SMatthew G Knepley PetscErrorCode ierr; 382867a56275SMatthew G Knepley 382967a56275SMatthew G Knepley PetscFunctionBegin; 383067a56275SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 383167a56275SMatthew G Knepley PetscValidType(dm,1); 383267a56275SMatthew G Knepley PetscValidPointer(M,3); 3833251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr); 3834c067b6caSMatthew G. Knepley /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */ 3835c067b6caSMatthew G. Knepley if (sametype) { 3836c067b6caSMatthew G. Knepley *M = dm; 3837c067b6caSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr); 3838c067b6caSMatthew G. Knepley PetscFunctionReturn(0); 3839c067b6caSMatthew G. Knepley } else { 38400298fd71SBarry Smith PetscErrorCode (*conv)(DM, DMType, DM*) = NULL; 384167a56275SMatthew G Knepley 384267a56275SMatthew G Knepley /* 384367a56275SMatthew G Knepley Order of precedence: 384467a56275SMatthew G Knepley 1) See if a specialized converter is known to the current DM. 384567a56275SMatthew G Knepley 2) See if a specialized converter is known to the desired DM class. 384667a56275SMatthew G Knepley 3) See if a good general converter is registered for the desired class 384767a56275SMatthew G Knepley 4) See if a good general converter is known for the current matrix. 384867a56275SMatthew G Knepley 5) Use a really basic converter. 384967a56275SMatthew G Knepley */ 385067a56275SMatthew G Knepley 385167a56275SMatthew G Knepley /* 1) See if a specialized converter is known to the current DM and the desired class */ 3852a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3853a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3854a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3855a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3856a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 38570005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr); 385867a56275SMatthew G Knepley if (conv) goto foundconv; 385967a56275SMatthew G Knepley 386067a56275SMatthew G Knepley /* 2) See if a specialized converter is known to the desired DM class. */ 386182f516ccSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr); 386267a56275SMatthew G Knepley ierr = DMSetType(B, newtype);CHKERRQ(ierr); 3863a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3864a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3865a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3866a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3867a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 38680005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr); 386967a56275SMatthew G Knepley if (conv) { 3870fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 387167a56275SMatthew G Knepley goto foundconv; 387267a56275SMatthew G Knepley } 387367a56275SMatthew G Knepley 387467a56275SMatthew G Knepley #if 0 387567a56275SMatthew G Knepley /* 3) See if a good general converter is registered for the desired class */ 387667a56275SMatthew G Knepley conv = B->ops->convertfrom; 3877fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 387867a56275SMatthew G Knepley if (conv) goto foundconv; 387967a56275SMatthew G Knepley 388067a56275SMatthew G Knepley /* 4) See if a good general converter is known for the current matrix */ 388167a56275SMatthew G Knepley if (dm->ops->convert) { 388267a56275SMatthew G Knepley conv = dm->ops->convert; 388367a56275SMatthew G Knepley } 388467a56275SMatthew G Knepley if (conv) goto foundconv; 388567a56275SMatthew G Knepley #endif 388667a56275SMatthew G Knepley 388767a56275SMatthew G Knepley /* 5) Use a really basic converter. */ 388882f516ccSBarry Smith SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype); 388967a56275SMatthew G Knepley 389067a56275SMatthew G Knepley foundconv: 389167a56275SMatthew G Knepley ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 389267a56275SMatthew G Knepley ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr); 389312fa691eSMatthew G. Knepley /* Things that are independent of DM type: We should consult DMClone() here */ 389490b157c4SStefano Zampini { 389590b157c4SStefano Zampini PetscBool isper; 389612fa691eSMatthew G. Knepley const PetscReal *maxCell, *L; 389712fa691eSMatthew G. Knepley const DMBoundaryType *bd; 389890b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 389990b157c4SStefano Zampini ierr = DMSetPeriodicity(*M, isper, maxCell, L, bd);CHKERRQ(ierr); 3900c8a6034eSMark (*M)->prealloc_only = dm->prealloc_only; 3901a587d139SMark ierr = PetscFree((*M)->vectype);CHKERRQ(ierr); 3902a587d139SMark ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr); 3903a587d139SMark ierr = PetscFree((*M)->mattype);CHKERRQ(ierr); 3904a587d139SMark ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr); 390512fa691eSMatthew G. Knepley } 390667a56275SMatthew G Knepley ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 390767a56275SMatthew G Knepley } 390867a56275SMatthew G Knepley ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr); 390967a56275SMatthew G Knepley PetscFunctionReturn(0); 391067a56275SMatthew G Knepley } 3911264ace61SBarry Smith 3912264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/ 3913264ace61SBarry Smith 3914264ace61SBarry Smith /*@C 39151c84c290SBarry Smith DMRegister - Adds a new DM component implementation 39161c84c290SBarry Smith 39171c84c290SBarry Smith Not Collective 39181c84c290SBarry Smith 39191c84c290SBarry Smith Input Parameters: 39201c84c290SBarry Smith + name - The name of a new user-defined creation routine 39211c84c290SBarry Smith - create_func - The creation routine itself 39221c84c290SBarry Smith 39231c84c290SBarry Smith Notes: 39241c84c290SBarry Smith DMRegister() may be called multiple times to add several user-defined DMs 39251c84c290SBarry Smith 39261c84c290SBarry Smith 39271c84c290SBarry Smith Sample usage: 39281c84c290SBarry Smith .vb 3929bdf89e91SBarry Smith DMRegister("my_da", MyDMCreate); 39301c84c290SBarry Smith .ve 39311c84c290SBarry Smith 39321c84c290SBarry Smith Then, your DM type can be chosen with the procedural interface via 39331c84c290SBarry Smith .vb 39341c84c290SBarry Smith DMCreate(MPI_Comm, DM *); 39351c84c290SBarry Smith DMSetType(DM,"my_da"); 39361c84c290SBarry Smith .ve 39371c84c290SBarry Smith or at runtime via the option 39381c84c290SBarry Smith .vb 39391c84c290SBarry Smith -da_type my_da 39401c84c290SBarry Smith .ve 3941264ace61SBarry Smith 3942264ace61SBarry Smith Level: advanced 39431c84c290SBarry Smith 3944bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy() 39451c84c290SBarry Smith 3946264ace61SBarry Smith @*/ 3947bdf89e91SBarry Smith PetscErrorCode DMRegister(const char sname[],PetscErrorCode (*function)(DM)) 3948264ace61SBarry Smith { 3949264ace61SBarry Smith PetscErrorCode ierr; 3950264ace61SBarry Smith 3951264ace61SBarry Smith PetscFunctionBegin; 39521d36bdfdSBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 3953a240a19fSJed Brown ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr); 3954264ace61SBarry Smith PetscFunctionReturn(0); 3955264ace61SBarry Smith } 3956264ace61SBarry Smith 3957b859378eSBarry Smith /*@C 395855849f57SBarry Smith DMLoad - Loads a DM that has been stored in binary with DMView(). 3959b859378eSBarry Smith 3960d083f849SBarry Smith Collective on viewer 3961b859378eSBarry Smith 3962b859378eSBarry Smith Input Parameters: 3963b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or 3964b859378eSBarry Smith some related function before a call to DMLoad(). 3965b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or 3966b859378eSBarry Smith HDF5 file viewer, obtained from PetscViewerHDF5Open() 3967b859378eSBarry Smith 3968b859378eSBarry Smith Level: intermediate 3969b859378eSBarry Smith 3970b859378eSBarry Smith Notes: 397155849f57SBarry Smith The type is determined by the data in the file, any type set into the DM before this call is ignored. 3972b859378eSBarry Smith 3973b859378eSBarry Smith Notes for advanced users: 3974b859378eSBarry Smith Most users should not need to know the details of the binary storage 3975b859378eSBarry Smith format, since DMLoad() and DMView() completely hide these details. 3976b859378eSBarry Smith But for anyone who's interested, the standard binary matrix storage 3977b859378eSBarry Smith format is 3978b859378eSBarry Smith .vb 3979b859378eSBarry Smith has not yet been determined 3980b859378eSBarry Smith .ve 3981b859378eSBarry Smith 3982b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad() 3983b859378eSBarry Smith @*/ 3984b859378eSBarry Smith PetscErrorCode DMLoad(DM newdm, PetscViewer viewer) 3985b859378eSBarry Smith { 39869331c7a4SMatthew G. Knepley PetscBool isbinary, ishdf5; 3987b859378eSBarry Smith PetscErrorCode ierr; 3988b859378eSBarry Smith 3989b859378eSBarry Smith PetscFunctionBegin; 3990b859378eSBarry Smith PetscValidHeaderSpecific(newdm,DM_CLASSID,1); 3991b859378eSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 3992fb694a9eSVaclav Hapla ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr); 399332c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 39949331c7a4SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr); 399558cd63d5SVaclav Hapla ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr); 39969331c7a4SMatthew G. Knepley if (isbinary) { 39979331c7a4SMatthew G. Knepley PetscInt classid; 39989331c7a4SMatthew G. Knepley char type[256]; 3999b859378eSBarry Smith 4000060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 40019200755eSBarry Smith if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid); 4002060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 400332c0f0efSBarry Smith ierr = DMSetType(newdm, type);CHKERRQ(ierr); 40049331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 40059331c7a4SMatthew G. Knepley } else if (ishdf5) { 40069331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 40079331c7a4SMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()"); 400858cd63d5SVaclav Hapla ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr); 4009b859378eSBarry Smith PetscFunctionReturn(0); 4010b859378eSBarry Smith } 4011b859378eSBarry Smith 4012b2e4378dSMatthew G. Knepley /*@ 4013b2e4378dSMatthew G. Knepley DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process. 4014b2e4378dSMatthew G. Knepley 4015b2e4378dSMatthew G. Knepley Not collective 4016b2e4378dSMatthew G. Knepley 4017b2e4378dSMatthew G. Knepley Input Parameter: 4018b2e4378dSMatthew G. Knepley . dm - the DM 4019b2e4378dSMatthew G. Knepley 4020b2e4378dSMatthew G. Knepley Output Parameters: 4021b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional) 4022b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional) 4023b2e4378dSMatthew G. Knepley 4024b2e4378dSMatthew G. Knepley Level: beginner 4025b2e4378dSMatthew G. Knepley 4026b2e4378dSMatthew G. Knepley Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead. 4027b2e4378dSMatthew G. Knepley 4028b2e4378dSMatthew G. Knepley 4029b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox() 4030b2e4378dSMatthew G. Knepley @*/ 4031b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[]) 4032b2e4378dSMatthew G. Knepley { 4033b2e4378dSMatthew G. Knepley Vec coords = NULL; 4034b2e4378dSMatthew G. Knepley PetscReal min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL}; 4035b2e4378dSMatthew G. Knepley PetscReal max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL}; 4036b2e4378dSMatthew G. Knepley const PetscScalar *local_coords; 4037b2e4378dSMatthew G. Knepley PetscInt N, Ni; 4038b2e4378dSMatthew G. Knepley PetscInt cdim, i, j; 4039b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 4040b2e4378dSMatthew G. Knepley 4041b2e4378dSMatthew G. Knepley PetscFunctionBegin; 4042b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4043b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 4044b2e4378dSMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 4045b2e4378dSMatthew G. Knepley if (coords) { 4046b2e4378dSMatthew G. Knepley ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr); 4047b2e4378dSMatthew G. Knepley ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr); 4048b2e4378dSMatthew G. Knepley Ni = N/cdim; 4049b2e4378dSMatthew G. Knepley for (i = 0; i < Ni; ++i) { 4050b2e4378dSMatthew G. Knepley for (j = 0; j < 3; ++j) { 4051b2e4378dSMatthew G. Knepley min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 4052b2e4378dSMatthew G. Knepley max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 4053b2e4378dSMatthew G. Knepley } 4054b2e4378dSMatthew G. Knepley } 4055b2e4378dSMatthew G. Knepley ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr); 4056b2e4378dSMatthew G. Knepley } else { 4057b2e4378dSMatthew G. Knepley PetscBool isda; 4058b2e4378dSMatthew G. Knepley 4059b2e4378dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr); 4060b2e4378dSMatthew G. Knepley if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);} 4061b2e4378dSMatthew G. Knepley } 4062b2e4378dSMatthew G. Knepley if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);} 4063b2e4378dSMatthew G. Knepley if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);} 4064b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 4065b2e4378dSMatthew G. Knepley } 4066b2e4378dSMatthew G. Knepley 4067b2e4378dSMatthew G. Knepley /*@ 4068b2e4378dSMatthew G. Knepley DMGetBoundingBox - Returns the global bounding box for the DM. 4069b2e4378dSMatthew G. Knepley 4070b2e4378dSMatthew G. Knepley Collective 4071b2e4378dSMatthew G. Knepley 4072b2e4378dSMatthew G. Knepley Input Parameter: 4073b2e4378dSMatthew G. Knepley . dm - the DM 4074b2e4378dSMatthew G. Knepley 4075b2e4378dSMatthew G. Knepley Output Parameters: 4076b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional) 4077b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional) 4078b2e4378dSMatthew G. Knepley 4079b2e4378dSMatthew G. Knepley Level: beginner 4080b2e4378dSMatthew G. Knepley 4081b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal() 4082b2e4378dSMatthew G. Knepley @*/ 4083b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[]) 4084b2e4378dSMatthew G. Knepley { 4085b2e4378dSMatthew G. Knepley PetscReal lmin[3], lmax[3]; 40866ce308c4SMatthew G. Knepley PetscInt cdim; 40876ce308c4SMatthew G. Knepley PetscMPIInt count; 4088b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 4089b2e4378dSMatthew G. Knepley 4090b2e4378dSMatthew G. Knepley PetscFunctionBegin; 4091b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4092b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 4093b2e4378dSMatthew G. Knepley ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr); 4094b2e4378dSMatthew G. Knepley ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr); 4095820f2d46SBarry Smith if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);} 4096820f2d46SBarry Smith if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);} 4097b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 4098b2e4378dSMatthew G. Knepley } 4099b2e4378dSMatthew G. Knepley 41007da65231SMatthew G Knepley /******************************** FEM Support **********************************/ 41017da65231SMatthew G Knepley 4102a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[]) 4103a6dfd86eSKarl Rupp { 41041d47ebbbSSatish Balay PetscInt f; 41051b30c384SMatthew G Knepley PetscErrorCode ierr; 41061b30c384SMatthew G Knepley 41077da65231SMatthew G Knepley PetscFunctionBegin; 410874778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 41091d47ebbbSSatish Balay for (f = 0; f < len; ++f) { 411057622a8eSBarry Smith ierr = PetscPrintf(PETSC_COMM_SELF, " | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr); 41117da65231SMatthew G Knepley } 41127da65231SMatthew G Knepley PetscFunctionReturn(0); 41137da65231SMatthew G Knepley } 41147da65231SMatthew G Knepley 4115a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[]) 4116a6dfd86eSKarl Rupp { 41171b30c384SMatthew G Knepley PetscInt f, g; 41187da65231SMatthew G Knepley PetscErrorCode ierr; 41197da65231SMatthew G Knepley 41207da65231SMatthew G Knepley PetscFunctionBegin; 412174778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 41221d47ebbbSSatish Balay for (f = 0; f < rows; ++f) { 412374778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |");CHKERRQ(ierr); 41241d47ebbbSSatish Balay for (g = 0; g < cols; ++g) { 4125e3556bceSMatthew G. Knepley ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr); 41267da65231SMatthew G Knepley } 412774778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr); 41287da65231SMatthew G Knepley } 41297da65231SMatthew G Knepley PetscFunctionReturn(0); 41307da65231SMatthew G Knepley } 4131e7c4fc90SDmitry Karpeev 41326113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X) 4133e759306cSMatthew G. Knepley { 41340c5b8624SToby Isaac PetscInt localSize, bs; 41350c5b8624SToby Isaac PetscMPIInt size; 41360c5b8624SToby Isaac Vec x, xglob; 41370c5b8624SToby Isaac const PetscScalar *xarray; 4138e759306cSMatthew G. Knepley PetscErrorCode ierr; 4139e759306cSMatthew G. Knepley 4140e759306cSMatthew G. Knepley PetscFunctionBegin; 4141ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr); 4142e759306cSMatthew G. Knepley ierr = VecDuplicate(X, &x);CHKERRQ(ierr); 4143e759306cSMatthew G. Knepley ierr = VecCopy(X, x);CHKERRQ(ierr); 41446113b454SMatthew G. Knepley ierr = VecChop(x, tol);CHKERRQ(ierr); 41450c5b8624SToby Isaac ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr); 41460c5b8624SToby Isaac if (size > 1) { 41470c5b8624SToby Isaac ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr); 41480c5b8624SToby Isaac ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr); 41490c5b8624SToby Isaac ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 41500c5b8624SToby Isaac ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr); 41510c5b8624SToby Isaac } else { 41520c5b8624SToby Isaac xglob = x; 41530c5b8624SToby Isaac } 41540c5b8624SToby Isaac ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr); 41550c5b8624SToby Isaac if (size > 1) { 41560c5b8624SToby Isaac ierr = VecDestroy(&xglob);CHKERRQ(ierr); 41570c5b8624SToby Isaac ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr); 41580c5b8624SToby Isaac } 4159e759306cSMatthew G. Knepley ierr = VecDestroy(&x);CHKERRQ(ierr); 4160e759306cSMatthew G. Knepley PetscFunctionReturn(0); 4161e759306cSMatthew G. Knepley } 4162e759306cSMatthew G. Knepley 416388ed4aceSMatthew G Knepley /*@ 41641bb6d2a8SBarry Smith DMGetSection - Get the PetscSection encoding the local data layout for the DM. This is equivalent to DMGetLocalSection(). Deprecated in v3.12 4165061576a5SJed Brown 4166061576a5SJed Brown Input Parameter: 4167061576a5SJed Brown . dm - The DM 4168061576a5SJed Brown 4169061576a5SJed Brown Output Parameter: 4170061576a5SJed Brown . section - The PetscSection 4171061576a5SJed Brown 4172061576a5SJed Brown Options Database Keys: 4173061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM 4174061576a5SJed Brown 4175061576a5SJed Brown Level: advanced 4176061576a5SJed Brown 4177061576a5SJed Brown Notes: 4178061576a5SJed Brown Use DMGetLocalSection() in new code. 4179061576a5SJed Brown 4180061576a5SJed Brown This gets a borrowed reference, so the user should not destroy this PetscSection. 4181061576a5SJed Brown 4182061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection() 4183061576a5SJed Brown @*/ 4184061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section) 4185061576a5SJed Brown { 4186061576a5SJed Brown PetscErrorCode ierr; 4187061576a5SJed Brown 4188061576a5SJed Brown PetscFunctionBegin; 4189061576a5SJed Brown ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr); 4190061576a5SJed Brown PetscFunctionReturn(0); 4191061576a5SJed Brown } 4192061576a5SJed Brown 4193061576a5SJed Brown /*@ 4194061576a5SJed Brown DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM. 419588ed4aceSMatthew G Knepley 419688ed4aceSMatthew G Knepley Input Parameter: 419788ed4aceSMatthew G Knepley . dm - The DM 419888ed4aceSMatthew G Knepley 419988ed4aceSMatthew G Knepley Output Parameter: 420088ed4aceSMatthew G Knepley . section - The PetscSection 420188ed4aceSMatthew G Knepley 4202e5893cccSMatthew G. Knepley Options Database Keys: 4203e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM 4204e5893cccSMatthew G. Knepley 420588ed4aceSMatthew G Knepley Level: intermediate 420688ed4aceSMatthew G Knepley 420788ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 420888ed4aceSMatthew G Knepley 4209061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection() 421088ed4aceSMatthew G Knepley @*/ 4211061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section) 42120adebc6cSBarry Smith { 4213fd59a867SMatthew G. Knepley PetscErrorCode ierr; 4214fd59a867SMatthew G. Knepley 421588ed4aceSMatthew G Knepley PetscFunctionBegin; 421688ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 421788ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 42181bb6d2a8SBarry Smith if (!dm->localSection && dm->ops->createlocalsection) { 4219e5e52638SMatthew G. Knepley PetscInt d; 4220e5e52638SMatthew G. Knepley 422145480ffeSMatthew G. Knepley if (dm->setfromoptionscalled) { 422245480ffeSMatthew G. Knepley PetscObject obj = (PetscObject) dm; 422345480ffeSMatthew G. Knepley PetscViewer viewer; 422445480ffeSMatthew G. Knepley PetscViewerFormat format; 422545480ffeSMatthew G. Knepley PetscBool flg; 422645480ffeSMatthew G. Knepley 422745480ffeSMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr); 422845480ffeSMatthew G. Knepley if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);} 422945480ffeSMatthew G. Knepley for (d = 0; d < dm->Nds; ++d) { 423045480ffeSMatthew G. Knepley ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr); 423145480ffeSMatthew G. Knepley if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);} 423245480ffeSMatthew G. Knepley } 423345480ffeSMatthew G. Knepley if (flg) { 423445480ffeSMatthew G. Knepley ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 423545480ffeSMatthew G. Knepley ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 423645480ffeSMatthew G. Knepley ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 423745480ffeSMatthew G. Knepley } 423845480ffeSMatthew G. Knepley } 42391bb6d2a8SBarry Smith ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr); 42401bb6d2a8SBarry Smith if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);} 42412f0f8703SMatthew G. Knepley } 42421bb6d2a8SBarry Smith *section = dm->localSection; 424388ed4aceSMatthew G Knepley PetscFunctionReturn(0); 424488ed4aceSMatthew G Knepley } 424588ed4aceSMatthew G Knepley 424688ed4aceSMatthew G Knepley /*@ 42471bb6d2a8SBarry Smith DMSetSection - Set the PetscSection encoding the local data layout for the DM. This is equivalent to DMSetLocalSection(). Deprecated in v3.12 4248061576a5SJed Brown 4249061576a5SJed Brown Input Parameters: 4250061576a5SJed Brown + dm - The DM 4251061576a5SJed Brown - section - The PetscSection 4252061576a5SJed Brown 4253061576a5SJed Brown Level: advanced 4254061576a5SJed Brown 4255061576a5SJed Brown Notes: 4256061576a5SJed Brown Use DMSetLocalSection() in new code. 4257061576a5SJed Brown 4258061576a5SJed Brown Any existing Section will be destroyed 4259061576a5SJed Brown 4260061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection() 4261061576a5SJed Brown @*/ 4262061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section) 4263061576a5SJed Brown { 4264061576a5SJed Brown PetscErrorCode ierr; 4265061576a5SJed Brown 4266061576a5SJed Brown PetscFunctionBegin; 4267061576a5SJed Brown ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr); 4268061576a5SJed Brown PetscFunctionReturn(0); 4269061576a5SJed Brown } 4270061576a5SJed Brown 4271061576a5SJed Brown /*@ 4272061576a5SJed Brown DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM. 427388ed4aceSMatthew G Knepley 427488ed4aceSMatthew G Knepley Input Parameters: 427588ed4aceSMatthew G Knepley + dm - The DM 427688ed4aceSMatthew G Knepley - section - The PetscSection 427788ed4aceSMatthew G Knepley 427888ed4aceSMatthew G Knepley Level: intermediate 427988ed4aceSMatthew G Knepley 428088ed4aceSMatthew G Knepley Note: Any existing Section will be destroyed 428188ed4aceSMatthew G Knepley 4282061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection() 428388ed4aceSMatthew G Knepley @*/ 4284061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section) 42850adebc6cSBarry Smith { 4286c473ab19SMatthew G. Knepley PetscInt numFields = 0; 4287af122d2aSMatthew G Knepley PetscInt f; 428888ed4aceSMatthew G Knepley PetscErrorCode ierr; 428988ed4aceSMatthew G Knepley 429088ed4aceSMatthew G Knepley PetscFunctionBegin; 429188ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4292b9d85ea2SLisandro Dalcin if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 42931d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 42941bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr); 42951bb6d2a8SBarry Smith dm->localSection = section; 42961bb6d2a8SBarry Smith if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);} 4297af122d2aSMatthew G Knepley if (numFields) { 4298af122d2aSMatthew G Knepley ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr); 4299af122d2aSMatthew G Knepley for (f = 0; f < numFields; ++f) { 43000f21e855SMatthew G. Knepley PetscObject disc; 4301af122d2aSMatthew G Knepley const char *name; 4302af122d2aSMatthew G Knepley 43031bb6d2a8SBarry Smith ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr); 430444a7f3ddSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr); 43050f21e855SMatthew G. Knepley ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr); 4306af122d2aSMatthew G Knepley } 4307af122d2aSMatthew G Knepley } 4308e87a4003SBarry Smith /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */ 43091bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 431088ed4aceSMatthew G Knepley PetscFunctionReturn(0); 431188ed4aceSMatthew G Knepley } 431288ed4aceSMatthew G Knepley 43139435951eSToby Isaac /*@ 4314b7385021SStefano Zampini DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation. 43159435951eSToby Isaac 4316e228b242SToby Isaac not collective 4317e228b242SToby Isaac 43189435951eSToby Isaac Input Parameter: 43199435951eSToby Isaac . dm - The DM 43209435951eSToby Isaac 43219435951eSToby Isaac Output Parameter: 43229435951eSToby 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. 43239435951eSToby 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. 43249435951eSToby Isaac 43259435951eSToby Isaac Level: advanced 43269435951eSToby Isaac 43279435951eSToby Isaac Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat. 43289435951eSToby Isaac 43299435951eSToby Isaac .seealso: DMSetDefaultConstraints() 43309435951eSToby Isaac @*/ 43319435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat) 43329435951eSToby Isaac { 43339435951eSToby Isaac PetscErrorCode ierr; 43349435951eSToby Isaac 43359435951eSToby Isaac PetscFunctionBegin; 43369435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 43379435951eSToby Isaac if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);} 433845a75d81SToby Isaac if (section) {*section = dm->defaultConstraintSection;} 433945a75d81SToby Isaac if (mat) {*mat = dm->defaultConstraintMat;} 43409435951eSToby Isaac PetscFunctionReturn(0); 43419435951eSToby Isaac } 43429435951eSToby Isaac 43439435951eSToby Isaac /*@ 4344b7385021SStefano Zampini DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation. 43459435951eSToby Isaac 43469435951eSToby 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(). 43479435951eSToby Isaac 43489435951eSToby 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. 43499435951eSToby Isaac 4350e228b242SToby Isaac collective on dm 4351e228b242SToby Isaac 43529435951eSToby Isaac Input Parameters: 43539435951eSToby Isaac + dm - The DM 4354e228b242SToby 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). 4355e228b242SToby 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). 43569435951eSToby Isaac 43579435951eSToby Isaac Level: advanced 43589435951eSToby Isaac 43599435951eSToby Isaac Note: This increments the references of the PetscSection and the Mat, so they user can destroy them 43609435951eSToby Isaac 43619435951eSToby Isaac .seealso: DMGetDefaultConstraints() 43629435951eSToby Isaac @*/ 43639435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat) 43649435951eSToby Isaac { 4365e228b242SToby Isaac PetscMPIInt result; 43669435951eSToby Isaac PetscErrorCode ierr; 43679435951eSToby Isaac 43689435951eSToby Isaac PetscFunctionBegin; 43699435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4370e228b242SToby Isaac if (section) { 4371e228b242SToby Isaac PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 4372ffc4695bSBarry Smith ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr); 4373f60917d2SBarry Smith if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator"); 4374e228b242SToby Isaac } 4375e228b242SToby Isaac if (mat) { 4376e228b242SToby Isaac PetscValidHeaderSpecific(mat,MAT_CLASSID,3); 4377ffc4695bSBarry Smith ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr); 4378f60917d2SBarry Smith if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator"); 4379e228b242SToby Isaac } 43809435951eSToby Isaac ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 43819435951eSToby Isaac ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr); 43829435951eSToby Isaac dm->defaultConstraintSection = section; 43839435951eSToby Isaac ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr); 43849435951eSToby Isaac ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr); 43859435951eSToby Isaac dm->defaultConstraintMat = mat; 43869435951eSToby Isaac PetscFunctionReturn(0); 43879435951eSToby Isaac } 43889435951eSToby Isaac 4389497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 4390507e4973SMatthew G. Knepley /* 4391507e4973SMatthew G. Knepley DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections. 4392507e4973SMatthew G. Knepley 4393507e4973SMatthew G. Knepley Input Parameters: 4394507e4973SMatthew G. Knepley + dm - The DM 4395507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout 4396507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout 4397507e4973SMatthew G. Knepley 4398507e4973SMatthew G. Knepley Level: intermediate 4399507e4973SMatthew G. Knepley 44001bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF() 4401507e4973SMatthew G. Knepley */ 4402f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection) 4403507e4973SMatthew G. Knepley { 4404507e4973SMatthew G. Knepley MPI_Comm comm; 4405507e4973SMatthew G. Knepley PetscLayout layout; 4406507e4973SMatthew G. Knepley const PetscInt *ranges; 4407507e4973SMatthew G. Knepley PetscInt pStart, pEnd, p, nroots; 4408507e4973SMatthew G. Knepley PetscMPIInt size, rank; 4409507e4973SMatthew G. Knepley PetscBool valid = PETSC_TRUE, gvalid; 4410507e4973SMatthew G. Knepley PetscErrorCode ierr; 4411507e4973SMatthew G. Knepley 4412507e4973SMatthew G. Knepley PetscFunctionBegin; 4413507e4973SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr); 4414507e4973SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4415ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 4416ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 4417507e4973SMatthew G. Knepley ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr); 4418507e4973SMatthew G. Knepley ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr); 4419507e4973SMatthew G. Knepley ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr); 4420507e4973SMatthew G. Knepley ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr); 4421507e4973SMatthew G. Knepley ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr); 4422507e4973SMatthew G. Knepley ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr); 4423507e4973SMatthew G. Knepley ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr); 4424507e4973SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 4425f741bcd2SMatthew G. Knepley PetscInt dof, cdof, off, gdof, gcdof, goff, gsize, d; 4426507e4973SMatthew G. Knepley 4427507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr); 4428507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr); 4429507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr); 4430507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 4431507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 4432507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr); 4433507e4973SMatthew G. Knepley if (!gdof) continue; /* Censored point */ 4434507e4973SMatthew 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;} 4435507e4973SMatthew 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;} 4436507e4973SMatthew G. Knepley if (gdof < 0) { 4437507e4973SMatthew G. Knepley gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 4438507e4973SMatthew G. Knepley for (d = 0; d < gsize; ++d) { 4439507e4973SMatthew G. Knepley PetscInt offset = -(goff+1) + d, r; 4440507e4973SMatthew G. Knepley 4441507e4973SMatthew G. Knepley ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr); 4442507e4973SMatthew G. Knepley if (r < 0) r = -(r+2); 4443507e4973SMatthew 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;} 4444507e4973SMatthew G. Knepley } 4445507e4973SMatthew G. Knepley } 4446507e4973SMatthew G. Knepley } 4447507e4973SMatthew G. Knepley ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr); 4448507e4973SMatthew G. Knepley ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr); 4449820f2d46SBarry Smith ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 4450507e4973SMatthew G. Knepley if (!gvalid) { 4451507e4973SMatthew G. Knepley ierr = DMView(dm, NULL);CHKERRQ(ierr); 4452507e4973SMatthew G. Knepley SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections"); 4453507e4973SMatthew G. Knepley } 4454507e4973SMatthew G. Knepley PetscFunctionReturn(0); 4455507e4973SMatthew G. Knepley } 4456f741bcd2SMatthew G. Knepley #endif 4457507e4973SMatthew G. Knepley 445888ed4aceSMatthew G Knepley /*@ 4459e87a4003SBarry Smith DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM. 446088ed4aceSMatthew G Knepley 4461d083f849SBarry Smith Collective on dm 44628b1ab98fSJed Brown 446388ed4aceSMatthew G Knepley Input Parameter: 446488ed4aceSMatthew G Knepley . dm - The DM 446588ed4aceSMatthew G Knepley 446688ed4aceSMatthew G Knepley Output Parameter: 446788ed4aceSMatthew G Knepley . section - The PetscSection 446888ed4aceSMatthew G Knepley 446988ed4aceSMatthew G Knepley Level: intermediate 447088ed4aceSMatthew G Knepley 447188ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 447288ed4aceSMatthew G Knepley 447392fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection() 447488ed4aceSMatthew G Knepley @*/ 4475e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section) 44760adebc6cSBarry Smith { 447788ed4aceSMatthew G Knepley PetscErrorCode ierr; 447888ed4aceSMatthew G Knepley 447988ed4aceSMatthew G Knepley PetscFunctionBegin; 448088ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 448188ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 44821bb6d2a8SBarry Smith if (!dm->globalSection) { 4483fd59a867SMatthew G. Knepley PetscSection s; 4484fd59a867SMatthew G. Knepley 448592fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 4486fd59a867SMatthew G. Knepley if (!s) SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection"); 448733907cc2SStefano Zampini if (!dm->sf) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection"); 44881bb6d2a8SBarry Smith ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr); 4489cf06b437SMatthew G. Knepley ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr); 44901bb6d2a8SBarry Smith ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr); 44911bb6d2a8SBarry Smith ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr); 449288ed4aceSMatthew G Knepley } 44931bb6d2a8SBarry Smith *section = dm->globalSection; 449488ed4aceSMatthew G Knepley PetscFunctionReturn(0); 449588ed4aceSMatthew G Knepley } 449688ed4aceSMatthew G Knepley 4497b21d0597SMatthew G Knepley /*@ 4498e87a4003SBarry Smith DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM. 4499b21d0597SMatthew G Knepley 4500b21d0597SMatthew G Knepley Input Parameters: 4501b21d0597SMatthew G Knepley + dm - The DM 45025080bbdbSMatthew G Knepley - section - The PetscSection, or NULL 4503b21d0597SMatthew G Knepley 4504b21d0597SMatthew G Knepley Level: intermediate 4505b21d0597SMatthew G Knepley 4506b21d0597SMatthew G Knepley Note: Any existing Section will be destroyed 4507b21d0597SMatthew G Knepley 450892fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection() 4509b21d0597SMatthew G Knepley @*/ 4510e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section) 45110adebc6cSBarry Smith { 4512b21d0597SMatthew G Knepley PetscErrorCode ierr; 4513b21d0597SMatthew G Knepley 4514b21d0597SMatthew G Knepley PetscFunctionBegin; 4515b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 45165080bbdbSMatthew G Knepley if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 45171d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 45181bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 45191bb6d2a8SBarry Smith dm->globalSection = section; 4520497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 45211bb6d2a8SBarry Smith if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);} 4522507e4973SMatthew G. Knepley #endif 4523b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4524b21d0597SMatthew G Knepley } 4525b21d0597SMatthew G Knepley 452688ed4aceSMatthew G Knepley /*@ 45271bb6d2a8SBarry Smith DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set, 452888ed4aceSMatthew G Knepley it is created from the default PetscSection layouts in the DM. 452988ed4aceSMatthew G Knepley 453088ed4aceSMatthew G Knepley Input Parameter: 453188ed4aceSMatthew G Knepley . dm - The DM 453288ed4aceSMatthew G Knepley 453388ed4aceSMatthew G Knepley Output Parameter: 453488ed4aceSMatthew G Knepley . sf - The PetscSF 453588ed4aceSMatthew G Knepley 453688ed4aceSMatthew G Knepley Level: intermediate 453788ed4aceSMatthew G Knepley 453888ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 453988ed4aceSMatthew G Knepley 45401bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF() 454188ed4aceSMatthew G Knepley @*/ 45421bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf) 45430adebc6cSBarry Smith { 454488ed4aceSMatthew G Knepley PetscInt nroots; 454588ed4aceSMatthew G Knepley PetscErrorCode ierr; 454688ed4aceSMatthew G Knepley 454788ed4aceSMatthew G Knepley PetscFunctionBegin; 454888ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 454988ed4aceSMatthew G Knepley PetscValidPointer(sf, 2); 45501bb6d2a8SBarry Smith if (!dm->sectionSF) { 45511bb6d2a8SBarry Smith ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr); 455233907cc2SStefano Zampini } 45531bb6d2a8SBarry Smith ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr); 455488ed4aceSMatthew G Knepley if (nroots < 0) { 455588ed4aceSMatthew G Knepley PetscSection section, gSection; 455688ed4aceSMatthew G Knepley 455792fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 455831ea6d37SMatthew G Knepley if (section) { 4559e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr); 45601bb6d2a8SBarry Smith ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr); 456131ea6d37SMatthew G Knepley } else { 45620298fd71SBarry Smith *sf = NULL; 456331ea6d37SMatthew G Knepley PetscFunctionReturn(0); 456431ea6d37SMatthew G Knepley } 456588ed4aceSMatthew G Knepley } 45661bb6d2a8SBarry Smith *sf = dm->sectionSF; 456788ed4aceSMatthew G Knepley PetscFunctionReturn(0); 456888ed4aceSMatthew G Knepley } 456988ed4aceSMatthew G Knepley 457088ed4aceSMatthew G Knepley /*@ 45711bb6d2a8SBarry Smith DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM 457288ed4aceSMatthew G Knepley 457388ed4aceSMatthew G Knepley Input Parameters: 457488ed4aceSMatthew G Knepley + dm - The DM 457588ed4aceSMatthew G Knepley - sf - The PetscSF 457688ed4aceSMatthew G Knepley 457788ed4aceSMatthew G Knepley Level: intermediate 457888ed4aceSMatthew G Knepley 457988ed4aceSMatthew G Knepley Note: Any previous SF is destroyed 458088ed4aceSMatthew G Knepley 45811bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF() 458288ed4aceSMatthew G Knepley @*/ 45831bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf) 45840adebc6cSBarry Smith { 458588ed4aceSMatthew G Knepley PetscErrorCode ierr; 458688ed4aceSMatthew G Knepley 458788ed4aceSMatthew G Knepley PetscFunctionBegin; 458888ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4589b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 459033907cc2SStefano Zampini ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 45911bb6d2a8SBarry Smith ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr); 45921bb6d2a8SBarry Smith dm->sectionSF = sf; 459388ed4aceSMatthew G Knepley PetscFunctionReturn(0); 459488ed4aceSMatthew G Knepley } 459588ed4aceSMatthew G Knepley 459688ed4aceSMatthew G Knepley /*@C 45971bb6d2a8SBarry Smith DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections 459888ed4aceSMatthew G Knepley describing the data layout. 459988ed4aceSMatthew G Knepley 460088ed4aceSMatthew G Knepley Input Parameters: 460188ed4aceSMatthew G Knepley + dm - The DM 460288ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout 460388ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout 460488ed4aceSMatthew G Knepley 46051bb6d2a8SBarry Smith Notes: One usually uses DMGetSectionSF() to obtain the PetscSF 460688ed4aceSMatthew G Knepley 46071bb6d2a8SBarry Smith Level: developer 46081bb6d2a8SBarry Smith 46091bb6d2a8SBarry Smith Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF 46101bb6d2a8SBarry Smith directly into the DM, perhaps this function should not take the local and global sections as 46111bb6d2a8SBarry Smith input and should just obtain them from the DM? 46121bb6d2a8SBarry Smith 46131bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection() 461488ed4aceSMatthew G Knepley @*/ 46151bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection) 461688ed4aceSMatthew G Knepley { 461788ed4aceSMatthew G Knepley PetscErrorCode ierr; 461888ed4aceSMatthew G Knepley 461988ed4aceSMatthew G Knepley PetscFunctionBegin; 462088ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4621b0c7db22SLisandro Dalcin ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr); 462288ed4aceSMatthew G Knepley PetscFunctionReturn(0); 462388ed4aceSMatthew G Knepley } 4624af122d2aSMatthew G Knepley 4625b21d0597SMatthew G Knepley /*@ 4626b21d0597SMatthew G Knepley DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM. 4627b21d0597SMatthew G Knepley 4628b21d0597SMatthew G Knepley Input Parameter: 4629b21d0597SMatthew G Knepley . dm - The DM 4630b21d0597SMatthew G Knepley 4631b21d0597SMatthew G Knepley Output Parameter: 4632b21d0597SMatthew G Knepley . sf - The PetscSF 4633b21d0597SMatthew G Knepley 4634b21d0597SMatthew G Knepley Level: intermediate 4635b21d0597SMatthew G Knepley 4636b21d0597SMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 4637b21d0597SMatthew G Knepley 46381bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4639b21d0597SMatthew G Knepley @*/ 46400adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf) 46410adebc6cSBarry Smith { 4642b21d0597SMatthew G Knepley PetscFunctionBegin; 4643b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4644b21d0597SMatthew G Knepley PetscValidPointer(sf, 2); 4645b21d0597SMatthew G Knepley *sf = dm->sf; 4646b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4647b21d0597SMatthew G Knepley } 4648b21d0597SMatthew G Knepley 4649057b4bcdSMatthew G Knepley /*@ 4650057b4bcdSMatthew G Knepley DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM. 4651057b4bcdSMatthew G Knepley 4652057b4bcdSMatthew G Knepley Input Parameters: 4653057b4bcdSMatthew G Knepley + dm - The DM 4654057b4bcdSMatthew G Knepley - sf - The PetscSF 4655057b4bcdSMatthew G Knepley 4656057b4bcdSMatthew G Knepley Level: intermediate 4657057b4bcdSMatthew G Knepley 46581bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4659057b4bcdSMatthew G Knepley @*/ 46600adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf) 46610adebc6cSBarry Smith { 4662057b4bcdSMatthew G Knepley PetscErrorCode ierr; 4663057b4bcdSMatthew G Knepley 4664057b4bcdSMatthew G Knepley PetscFunctionBegin; 4665057b4bcdSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4666b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 4667057b4bcdSMatthew G Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 466833907cc2SStefano Zampini ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr); 4669057b4bcdSMatthew G Knepley dm->sf = sf; 4670057b4bcdSMatthew G Knepley PetscFunctionReturn(0); 4671057b4bcdSMatthew G Knepley } 4672057b4bcdSMatthew G Knepley 467334aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc) 467434aa8a36SMatthew G. Knepley { 467534aa8a36SMatthew G. Knepley PetscClassId id; 467634aa8a36SMatthew G. Knepley PetscErrorCode ierr; 467734aa8a36SMatthew G. Knepley 467834aa8a36SMatthew G. Knepley PetscFunctionBegin; 467934aa8a36SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 468034aa8a36SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 468134aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 468234aa8a36SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 468334aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr); 468417c1d62eSMatthew G. Knepley } else { 468517c1d62eSMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 468634aa8a36SMatthew G. Knepley } 468734aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 468834aa8a36SMatthew G. Knepley } 468934aa8a36SMatthew G. Knepley 469044a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew) 469144a7f3ddSMatthew G. Knepley { 469244a7f3ddSMatthew G. Knepley RegionField *tmpr; 469344a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf, f; 469444a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 469544a7f3ddSMatthew G. Knepley 469644a7f3ddSMatthew G. Knepley PetscFunctionBegin; 469744a7f3ddSMatthew G. Knepley if (Nf >= NfNew) PetscFunctionReturn(0); 469844a7f3ddSMatthew G. Knepley ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr); 469944a7f3ddSMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f]; 4700e0b68406SMatthew Knepley for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;} 470144a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 470244a7f3ddSMatthew G. Knepley dm->Nf = NfNew; 470344a7f3ddSMatthew G. Knepley dm->fields = tmpr; 470444a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 470544a7f3ddSMatthew G. Knepley } 470644a7f3ddSMatthew G. Knepley 470744a7f3ddSMatthew G. Knepley /*@ 470844a7f3ddSMatthew G. Knepley DMClearFields - Remove all fields from the DM 470944a7f3ddSMatthew G. Knepley 4710d083f849SBarry Smith Logically collective on dm 471144a7f3ddSMatthew G. Knepley 471244a7f3ddSMatthew G. Knepley Input Parameter: 471344a7f3ddSMatthew G. Knepley . dm - The DM 471444a7f3ddSMatthew G. Knepley 471544a7f3ddSMatthew G. Knepley Level: intermediate 471644a7f3ddSMatthew G. Knepley 471744a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField() 471844a7f3ddSMatthew G. Knepley @*/ 471944a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm) 472044a7f3ddSMatthew G. Knepley { 472144a7f3ddSMatthew G. Knepley PetscInt f; 472244a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 472344a7f3ddSMatthew G. Knepley 472444a7f3ddSMatthew G. Knepley PetscFunctionBegin; 472544a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 472644a7f3ddSMatthew G. Knepley for (f = 0; f < dm->Nf; ++f) { 472744a7f3ddSMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 472844a7f3ddSMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 472944a7f3ddSMatthew G. Knepley } 473044a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 473144a7f3ddSMatthew G. Knepley dm->fields = NULL; 473244a7f3ddSMatthew G. Knepley dm->Nf = 0; 473344a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 473444a7f3ddSMatthew G. Knepley } 473544a7f3ddSMatthew G. Knepley 4736689b5837SMatthew G. Knepley /*@ 4737689b5837SMatthew G. Knepley DMGetNumFields - Get the number of fields in the DM 4738689b5837SMatthew G. Knepley 4739689b5837SMatthew G. Knepley Not collective 4740689b5837SMatthew G. Knepley 4741689b5837SMatthew G. Knepley Input Parameter: 4742689b5837SMatthew G. Knepley . dm - The DM 4743689b5837SMatthew G. Knepley 4744689b5837SMatthew G. Knepley Output Parameter: 4745689b5837SMatthew G. Knepley . Nf - The number of fields 4746689b5837SMatthew G. Knepley 4747689b5837SMatthew G. Knepley Level: intermediate 4748689b5837SMatthew G. Knepley 4749689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField() 4750689b5837SMatthew G. Knepley @*/ 47510f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields) 47520f21e855SMatthew G. Knepley { 47530f21e855SMatthew G. Knepley PetscFunctionBegin; 47540f21e855SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4755534a8f05SLisandro Dalcin PetscValidIntPointer(numFields, 2); 475644a7f3ddSMatthew G. Knepley *numFields = dm->Nf; 4757af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4758af122d2aSMatthew G Knepley } 4759af122d2aSMatthew G Knepley 4760689b5837SMatthew G. Knepley /*@ 4761689b5837SMatthew G. Knepley DMSetNumFields - Set the number of fields in the DM 4762689b5837SMatthew G. Knepley 4763d083f849SBarry Smith Logically collective on dm 4764689b5837SMatthew G. Knepley 4765689b5837SMatthew G. Knepley Input Parameters: 4766689b5837SMatthew G. Knepley + dm - The DM 4767689b5837SMatthew G. Knepley - Nf - The number of fields 4768689b5837SMatthew G. Knepley 4769689b5837SMatthew G. Knepley Level: intermediate 4770689b5837SMatthew G. Knepley 4771689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField() 4772689b5837SMatthew G. Knepley @*/ 4773af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields) 4774af122d2aSMatthew G Knepley { 47750f21e855SMatthew G. Knepley PetscInt Nf, f; 4776af122d2aSMatthew G Knepley PetscErrorCode ierr; 4777af122d2aSMatthew G Knepley 4778af122d2aSMatthew G Knepley PetscFunctionBegin; 4779af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 478044a7f3ddSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 47810f21e855SMatthew G. Knepley for (f = Nf; f < numFields; ++f) { 47820f21e855SMatthew G. Knepley PetscContainer obj; 47830f21e855SMatthew G. Knepley 47840f21e855SMatthew G. Knepley ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr); 478544a7f3ddSMatthew G. Knepley ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr); 47860f21e855SMatthew G. Knepley ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr); 4787af122d2aSMatthew G Knepley } 4788af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4789af122d2aSMatthew G Knepley } 4790af122d2aSMatthew G Knepley 4791c1929be8SMatthew G. Knepley /*@ 4792c1929be8SMatthew G. Knepley DMGetField - Return the discretization object for a given DM field 4793c1929be8SMatthew G. Knepley 4794c1929be8SMatthew G. Knepley Not collective 4795c1929be8SMatthew G. Knepley 4796c1929be8SMatthew G. Knepley Input Parameters: 4797c1929be8SMatthew G. Knepley + dm - The DM 4798c1929be8SMatthew G. Knepley - f - The field number 4799c1929be8SMatthew G. Knepley 480044a7f3ddSMatthew G. Knepley Output Parameters: 480144a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh 480244a7f3ddSMatthew G. Knepley - field - The discretization object 4803c1929be8SMatthew G. Knepley 480444a7f3ddSMatthew G. Knepley Level: intermediate 4805c1929be8SMatthew G. Knepley 480644a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField() 4807c1929be8SMatthew G. Knepley @*/ 480844a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field) 4809af122d2aSMatthew G Knepley { 4810af122d2aSMatthew G Knepley PetscFunctionBegin; 4811af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4812064a246eSJacob Faibussowitsch PetscValidPointer(field, 4); 481344a7f3ddSMatthew G. Knepley if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf); 481444a7f3ddSMatthew G. Knepley if (label) *label = dm->fields[f].label; 481544a7f3ddSMatthew G. Knepley if (field) *field = dm->fields[f].disc; 4816decb47aaSMatthew G. Knepley PetscFunctionReturn(0); 4817decb47aaSMatthew G. Knepley } 4818decb47aaSMatthew G. Knepley 4819083401c6SMatthew G. Knepley /* Does not clear the DS */ 4820083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field) 4821083401c6SMatthew G. Knepley { 4822083401c6SMatthew G. Knepley PetscErrorCode ierr; 4823083401c6SMatthew G. Knepley 4824083401c6SMatthew G. Knepley PetscFunctionBegin; 4825083401c6SMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr); 4826083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 4827083401c6SMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 4828083401c6SMatthew G. Knepley dm->fields[f].label = label; 4829083401c6SMatthew G. Knepley dm->fields[f].disc = field; 4830083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 4831083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 4832083401c6SMatthew G. Knepley PetscFunctionReturn(0); 4833083401c6SMatthew G. Knepley } 4834083401c6SMatthew G. Knepley 4835c1929be8SMatthew G. Knepley /*@ 4836c1929be8SMatthew G. Knepley DMSetField - Set the discretization object for a given DM field 4837c1929be8SMatthew G. Knepley 4838d083f849SBarry Smith Logically collective on dm 4839c1929be8SMatthew G. Knepley 4840c1929be8SMatthew G. Knepley Input Parameters: 4841c1929be8SMatthew G. Knepley + dm - The DM 4842c1929be8SMatthew G. Knepley . f - The field number 484344a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 4844c1929be8SMatthew G. Knepley - field - The discretization object 4845c1929be8SMatthew G. Knepley 484644a7f3ddSMatthew G. Knepley Level: intermediate 4847c1929be8SMatthew G. Knepley 484844a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField() 4849c1929be8SMatthew G. Knepley @*/ 485044a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field) 4851decb47aaSMatthew G. Knepley { 4852decb47aaSMatthew G. Knepley PetscErrorCode ierr; 4853decb47aaSMatthew G. Knepley 4854decb47aaSMatthew G. Knepley PetscFunctionBegin; 4855decb47aaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4856e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3); 485744a7f3ddSMatthew G. Knepley PetscValidHeader(field, 4); 4858e5e52638SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 4859083401c6SMatthew G. Knepley ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr); 486034aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr); 48612df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 486244a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 486344a7f3ddSMatthew G. Knepley } 486444a7f3ddSMatthew G. Knepley 486544a7f3ddSMatthew G. Knepley /*@ 486644a7f3ddSMatthew G. Knepley DMAddField - Add the discretization object for the given DM field 486744a7f3ddSMatthew G. Knepley 4868d083f849SBarry Smith Logically collective on dm 486944a7f3ddSMatthew G. Knepley 487044a7f3ddSMatthew G. Knepley Input Parameters: 487144a7f3ddSMatthew G. Knepley + dm - The DM 487244a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 487344a7f3ddSMatthew G. Knepley - field - The discretization object 487444a7f3ddSMatthew G. Knepley 487544a7f3ddSMatthew G. Knepley Level: intermediate 487644a7f3ddSMatthew G. Knepley 487744a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField() 487844a7f3ddSMatthew G. Knepley @*/ 487944a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field) 488044a7f3ddSMatthew G. Knepley { 488144a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf; 488244a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 488344a7f3ddSMatthew G. Knepley 488444a7f3ddSMatthew G. Knepley PetscFunctionBegin; 488544a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4886064a246eSJacob Faibussowitsch if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 488744a7f3ddSMatthew G. Knepley PetscValidHeader(field, 3); 488844a7f3ddSMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr); 488944a7f3ddSMatthew G. Knepley dm->fields[Nf].label = label; 489044a7f3ddSMatthew G. Knepley dm->fields[Nf].disc = field; 489144a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 489244a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 489334aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr); 48942df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 4895af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4896af122d2aSMatthew G Knepley } 48976636e97aSMatthew G Knepley 4898e5e52638SMatthew G. Knepley /*@ 4899e0b68406SMatthew Knepley DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells 4900e0b68406SMatthew Knepley 4901e0b68406SMatthew Knepley Logically collective on dm 4902e0b68406SMatthew Knepley 4903e0b68406SMatthew Knepley Input Parameters: 4904e0b68406SMatthew Knepley + dm - The DM 4905e0b68406SMatthew Knepley . f - The field index 4906e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells 4907e0b68406SMatthew Knepley 4908e0b68406SMatthew Knepley Level: intermediate 4909e0b68406SMatthew Knepley 4910e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField() 4911e0b68406SMatthew Knepley @*/ 4912e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor) 4913e0b68406SMatthew Knepley { 4914e0b68406SMatthew Knepley PetscFunctionBegin; 4915e0b68406SMatthew Knepley if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf); 4916e0b68406SMatthew Knepley dm->fields[f].avoidTensor = avoidTensor; 4917e0b68406SMatthew Knepley PetscFunctionReturn(0); 4918e0b68406SMatthew Knepley } 4919e0b68406SMatthew Knepley 4920e0b68406SMatthew Knepley /*@ 4921e0b68406SMatthew Knepley DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells 4922e0b68406SMatthew Knepley 4923e0b68406SMatthew Knepley Logically collective on dm 4924e0b68406SMatthew Knepley 4925e0b68406SMatthew Knepley Input Parameters: 4926e0b68406SMatthew Knepley + dm - The DM 4927e0b68406SMatthew Knepley - f - The field index 4928e0b68406SMatthew Knepley 4929e0b68406SMatthew Knepley Output Parameter: 4930e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells 4931e0b68406SMatthew Knepley 4932e0b68406SMatthew Knepley Level: intermediate 4933e0b68406SMatthew Knepley 4934e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField() 4935e0b68406SMatthew Knepley @*/ 4936e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor) 4937e0b68406SMatthew Knepley { 4938e0b68406SMatthew Knepley PetscFunctionBegin; 4939e0b68406SMatthew Knepley if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf); 4940e0b68406SMatthew Knepley *avoidTensor = dm->fields[f].avoidTensor; 4941e0b68406SMatthew Knepley PetscFunctionReturn(0); 4942e0b68406SMatthew Knepley } 4943e0b68406SMatthew Knepley 4944e0b68406SMatthew Knepley /*@ 4945e5e52638SMatthew G. Knepley DMCopyFields - Copy the discretizations for the DM into another DM 4946e5e52638SMatthew G. Knepley 4947d083f849SBarry Smith Collective on dm 4948e5e52638SMatthew G. Knepley 4949e5e52638SMatthew G. Knepley Input Parameter: 4950e5e52638SMatthew G. Knepley . dm - The DM 4951e5e52638SMatthew G. Knepley 4952e5e52638SMatthew G. Knepley Output Parameter: 4953e5e52638SMatthew G. Knepley . newdm - The DM 4954e5e52638SMatthew G. Knepley 4955e5e52638SMatthew G. Knepley Level: advanced 4956e5e52638SMatthew G. Knepley 4957e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS() 4958e5e52638SMatthew G. Knepley @*/ 4959e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm) 4960e5e52638SMatthew G. Knepley { 4961e5e52638SMatthew G. Knepley PetscInt Nf, f; 4962e5e52638SMatthew G. Knepley PetscErrorCode ierr; 4963e5e52638SMatthew G. Knepley 4964e5e52638SMatthew G. Knepley PetscFunctionBegin; 4965e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 4966e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 4967e5e52638SMatthew G. Knepley ierr = DMClearFields(newdm);CHKERRQ(ierr); 4968e5e52638SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 4969e5e52638SMatthew G. Knepley DMLabel label; 4970e5e52638SMatthew G. Knepley PetscObject field; 497134aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 4972e5e52638SMatthew G. Knepley 4973e5e52638SMatthew G. Knepley ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr); 4974e5e52638SMatthew G. Knepley ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr); 497534aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr); 497634aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr); 497734aa8a36SMatthew G. Knepley } 497834aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 497934aa8a36SMatthew G. Knepley } 498034aa8a36SMatthew G. Knepley 498134aa8a36SMatthew G. Knepley /*@ 498234aa8a36SMatthew G. Knepley DMGetAdjacency - Returns the flags for determining variable influence 498334aa8a36SMatthew G. Knepley 498434aa8a36SMatthew G. Knepley Not collective 498534aa8a36SMatthew G. Knepley 498634aa8a36SMatthew G. Knepley Input Parameters: 498734aa8a36SMatthew G. Knepley + dm - The DM object 498834aa8a36SMatthew G. Knepley - f - The field number, or PETSC_DEFAULT for the default adjacency 498934aa8a36SMatthew G. Knepley 499034aa8a36SMatthew G. Knepley Output Parameter: 499134aa8a36SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 499234aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 499334aa8a36SMatthew G. Knepley 499434aa8a36SMatthew G. Knepley Notes: 499534aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 499634aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 499734aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 4998979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 499934aa8a36SMatthew G. Knepley 500034aa8a36SMatthew G. Knepley Level: developer 500134aa8a36SMatthew G. Knepley 500234aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField() 500334aa8a36SMatthew G. Knepley @*/ 500434aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure) 500534aa8a36SMatthew G. Knepley { 500634aa8a36SMatthew G. Knepley PetscFunctionBegin; 500734aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5008534a8f05SLisandro Dalcin if (useCone) PetscValidBoolPointer(useCone, 3); 5009534a8f05SLisandro Dalcin if (useClosure) PetscValidBoolPointer(useClosure, 4); 501034aa8a36SMatthew G. Knepley if (f < 0) { 501134aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->adjacency[0]; 501234aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->adjacency[1]; 501334aa8a36SMatthew G. Knepley } else { 501434aa8a36SMatthew G. Knepley PetscInt Nf; 501534aa8a36SMatthew G. Knepley PetscErrorCode ierr; 501634aa8a36SMatthew G. Knepley 501734aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 501834aa8a36SMatthew G. Knepley if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 501934aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->fields[f].adjacency[0]; 502034aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->fields[f].adjacency[1]; 502134aa8a36SMatthew G. Knepley } 502234aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 502334aa8a36SMatthew G. Knepley } 502434aa8a36SMatthew G. Knepley 502534aa8a36SMatthew G. Knepley /*@ 502634aa8a36SMatthew G. Knepley DMSetAdjacency - Set the flags for determining variable influence 502734aa8a36SMatthew G. Knepley 502834aa8a36SMatthew G. Knepley Not collective 502934aa8a36SMatthew G. Knepley 503034aa8a36SMatthew G. Knepley Input Parameters: 503134aa8a36SMatthew G. Knepley + dm - The DM object 503234aa8a36SMatthew G. Knepley . f - The field number 503334aa8a36SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 503434aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 503534aa8a36SMatthew G. Knepley 503634aa8a36SMatthew G. Knepley Notes: 503734aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 503834aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 503934aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5040979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 504134aa8a36SMatthew G. Knepley 504234aa8a36SMatthew G. Knepley Level: developer 504334aa8a36SMatthew G. Knepley 504434aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField() 504534aa8a36SMatthew G. Knepley @*/ 504634aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure) 504734aa8a36SMatthew G. Knepley { 504834aa8a36SMatthew G. Knepley PetscFunctionBegin; 504934aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 505034aa8a36SMatthew G. Knepley if (f < 0) { 505134aa8a36SMatthew G. Knepley dm->adjacency[0] = useCone; 505234aa8a36SMatthew G. Knepley dm->adjacency[1] = useClosure; 505334aa8a36SMatthew G. Knepley } else { 505434aa8a36SMatthew G. Knepley PetscInt Nf; 505534aa8a36SMatthew G. Knepley PetscErrorCode ierr; 505634aa8a36SMatthew G. Knepley 505734aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 505834aa8a36SMatthew G. Knepley if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 505934aa8a36SMatthew G. Knepley dm->fields[f].adjacency[0] = useCone; 506034aa8a36SMatthew G. Knepley dm->fields[f].adjacency[1] = useClosure; 5061e5e52638SMatthew G. Knepley } 5062e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5063e5e52638SMatthew G. Knepley } 5064e5e52638SMatthew G. Knepley 5065b0441da4SMatthew G. Knepley /*@ 5066b0441da4SMatthew G. Knepley DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined 5067b0441da4SMatthew G. Knepley 5068b0441da4SMatthew G. Knepley Not collective 5069b0441da4SMatthew G. Knepley 5070b0441da4SMatthew G. Knepley Input Parameters: 5071b0441da4SMatthew G. Knepley . dm - The DM object 5072b0441da4SMatthew G. Knepley 5073b0441da4SMatthew G. Knepley Output Parameter: 5074b0441da4SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 5075b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 5076b0441da4SMatthew G. Knepley 5077b0441da4SMatthew G. Knepley Notes: 5078b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 5079b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 5080b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5081b0441da4SMatthew G. Knepley 5082b0441da4SMatthew G. Knepley Level: developer 5083b0441da4SMatthew G. Knepley 5084b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField() 5085b0441da4SMatthew G. Knepley @*/ 5086b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure) 5087b0441da4SMatthew G. Knepley { 5088b0441da4SMatthew G. Knepley PetscInt Nf; 5089b0441da4SMatthew G. Knepley PetscErrorCode ierr; 5090b0441da4SMatthew G. Knepley 5091b0441da4SMatthew G. Knepley PetscFunctionBegin; 5092b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5093064a246eSJacob Faibussowitsch if (useCone) PetscValidBoolPointer(useCone, 2); 5094064a246eSJacob Faibussowitsch if (useClosure) PetscValidBoolPointer(useClosure, 3); 5095b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5096b0441da4SMatthew G. Knepley if (!Nf) { 5097b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 5098b0441da4SMatthew G. Knepley } else { 5099b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 5100b0441da4SMatthew G. Knepley } 5101b0441da4SMatthew G. Knepley PetscFunctionReturn(0); 5102b0441da4SMatthew G. Knepley } 5103b0441da4SMatthew G. Knepley 5104b0441da4SMatthew G. Knepley /*@ 5105b0441da4SMatthew G. Knepley DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined 5106b0441da4SMatthew G. Knepley 5107b0441da4SMatthew G. Knepley Not collective 5108b0441da4SMatthew G. Knepley 5109b0441da4SMatthew G. Knepley Input Parameters: 5110b0441da4SMatthew G. Knepley + dm - The DM object 5111b0441da4SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 5112b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 5113b0441da4SMatthew G. Knepley 5114b0441da4SMatthew G. Knepley Notes: 5115b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 5116b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 5117b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5118b0441da4SMatthew G. Knepley 5119b0441da4SMatthew G. Knepley Level: developer 5120b0441da4SMatthew G. Knepley 5121b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField() 5122b0441da4SMatthew G. Knepley @*/ 5123b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure) 5124b0441da4SMatthew G. Knepley { 5125b0441da4SMatthew G. Knepley PetscInt Nf; 5126b0441da4SMatthew G. Knepley PetscErrorCode ierr; 5127b0441da4SMatthew G. Knepley 5128b0441da4SMatthew G. Knepley PetscFunctionBegin; 5129b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5130b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5131b0441da4SMatthew G. Knepley if (!Nf) { 5132b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 5133b0441da4SMatthew G. Knepley } else { 5134b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 5135e5e52638SMatthew G. Knepley } 5136e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5137e5e52638SMatthew G. Knepley } 5138e5e52638SMatthew G. Knepley 5139783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */ 514045480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label) 5141783e2ec8SMatthew G. Knepley { 5142783e2ec8SMatthew G. Knepley PetscObject obj; 5143783e2ec8SMatthew G. Knepley PetscClassId id; 5144783e2ec8SMatthew G. Knepley PetscInt Nbd, bd; 5145783e2ec8SMatthew G. Knepley PetscBool isFE = PETSC_FALSE; 5146783e2ec8SMatthew G. Knepley PetscBool duplicate = PETSC_FALSE; 5147783e2ec8SMatthew G. Knepley PetscErrorCode ierr; 5148783e2ec8SMatthew G. Knepley 5149783e2ec8SMatthew G. Knepley PetscFunctionBegin; 5150783e2ec8SMatthew G. Knepley ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr); 5151783e2ec8SMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 5152783e2ec8SMatthew G. Knepley if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE; 5153783e2ec8SMatthew G. Knepley if (isFE && label) { 5154783e2ec8SMatthew G. Knepley /* Only want to modify label once */ 5155783e2ec8SMatthew G. Knepley ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr); 5156783e2ec8SMatthew G. Knepley for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) { 515745480ffeSMatthew G. Knepley DMLabel l; 5158783e2ec8SMatthew G. Knepley 515945480ffeSMatthew G. Knepley ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 516045480ffeSMatthew G. Knepley duplicate = l == label ? PETSC_TRUE : PETSC_FALSE; 5161783e2ec8SMatthew G. Knepley if (duplicate) break; 5162783e2ec8SMatthew G. Knepley } 5163783e2ec8SMatthew G. Knepley if (!duplicate) { 5164783e2ec8SMatthew G. Knepley DM plex; 5165783e2ec8SMatthew G. Knepley 5166783e2ec8SMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 5167783e2ec8SMatthew G. Knepley if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);} 5168783e2ec8SMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 5169783e2ec8SMatthew G. Knepley } 5170783e2ec8SMatthew G. Knepley } 5171783e2ec8SMatthew G. Knepley PetscFunctionReturn(0); 5172783e2ec8SMatthew G. Knepley } 5173783e2ec8SMatthew G. Knepley 5174e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew) 5175e5e52638SMatthew G. Knepley { 5176e5e52638SMatthew G. Knepley DMSpace *tmpd; 5177e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5178e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5179e5e52638SMatthew G. Knepley 5180e5e52638SMatthew G. Knepley PetscFunctionBegin; 5181e5e52638SMatthew G. Knepley if (Nds >= NdsNew) PetscFunctionReturn(0); 5182e5e52638SMatthew G. Knepley ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr); 5183e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s]; 5184b3cf3223SMatthew G. Knepley for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;} 5185e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 5186e5e52638SMatthew G. Knepley dm->Nds = NdsNew; 5187e5e52638SMatthew G. Knepley dm->probs = tmpd; 5188e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5189e5e52638SMatthew G. Knepley } 5190e5e52638SMatthew G. Knepley 5191e5e52638SMatthew G. Knepley /*@ 5192e5e52638SMatthew G. Knepley DMGetNumDS - Get the number of discrete systems in the DM 5193e5e52638SMatthew G. Knepley 5194e5e52638SMatthew G. Knepley Not collective 5195e5e52638SMatthew G. Knepley 5196e5e52638SMatthew G. Knepley Input Parameter: 5197e5e52638SMatthew G. Knepley . dm - The DM 5198e5e52638SMatthew G. Knepley 5199e5e52638SMatthew G. Knepley Output Parameter: 5200e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects 5201e5e52638SMatthew G. Knepley 5202e5e52638SMatthew G. Knepley Level: intermediate 5203e5e52638SMatthew G. Knepley 5204e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS() 5205e5e52638SMatthew G. Knepley @*/ 5206e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds) 5207e5e52638SMatthew G. Knepley { 5208e5e52638SMatthew G. Knepley PetscFunctionBegin; 5209e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5210534a8f05SLisandro Dalcin PetscValidIntPointer(Nds, 2); 5211e5e52638SMatthew G. Knepley *Nds = dm->Nds; 5212e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5213e5e52638SMatthew G. Knepley } 5214e5e52638SMatthew G. Knepley 5215e5e52638SMatthew G. Knepley /*@ 5216e5e52638SMatthew G. Knepley DMClearDS - Remove all discrete systems from the DM 5217e5e52638SMatthew G. Knepley 5218d083f849SBarry Smith Logically collective on dm 5219e5e52638SMatthew G. Knepley 5220e5e52638SMatthew G. Knepley Input Parameter: 5221e5e52638SMatthew G. Knepley . dm - The DM 5222e5e52638SMatthew G. Knepley 5223e5e52638SMatthew G. Knepley Level: intermediate 5224e5e52638SMatthew G. Knepley 5225e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField() 5226e5e52638SMatthew G. Knepley @*/ 5227e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm) 5228e5e52638SMatthew G. Knepley { 5229e5e52638SMatthew G. Knepley PetscInt s; 5230e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5231e5e52638SMatthew G. Knepley 5232e5e52638SMatthew G. Knepley PetscFunctionBegin; 5233e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5234e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5235e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5236e5e52638SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr); 5237b3cf3223SMatthew G. Knepley ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr); 5238e5e52638SMatthew G. Knepley } 5239e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 5240e5e52638SMatthew G. Knepley dm->probs = NULL; 5241e5e52638SMatthew G. Knepley dm->Nds = 0; 5242e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5243e5e52638SMatthew G. Knepley } 5244e5e52638SMatthew G. Knepley 5245e5e52638SMatthew G. Knepley /*@ 5246e5e52638SMatthew G. Knepley DMGetDS - Get the default PetscDS 5247e5e52638SMatthew G. Knepley 5248e5e52638SMatthew G. Knepley Not collective 5249e5e52638SMatthew G. Knepley 5250e5e52638SMatthew G. Knepley Input Parameter: 5251e5e52638SMatthew G. Knepley . dm - The DM 5252e5e52638SMatthew G. Knepley 5253e5e52638SMatthew G. Knepley Output Parameter: 5254e5e52638SMatthew G. Knepley . prob - The default PetscDS 5255e5e52638SMatthew G. Knepley 5256e5e52638SMatthew G. Knepley Level: intermediate 5257e5e52638SMatthew G. Knepley 5258e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS() 5259e5e52638SMatthew G. Knepley @*/ 5260e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob) 5261e5e52638SMatthew G. Knepley { 5262b0143b4dSMatthew G. Knepley PetscErrorCode ierr; 5263b0143b4dSMatthew G. Knepley 5264e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5265e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5266e5e52638SMatthew G. Knepley PetscValidPointer(prob, 2); 5267b0143b4dSMatthew G. Knepley if (dm->Nds <= 0) { 5268b0143b4dSMatthew G. Knepley PetscDS ds; 5269b0143b4dSMatthew G. Knepley 527045480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 5271b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr); 5272b0143b4dSMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 5273b0143b4dSMatthew G. Knepley } 5274b0143b4dSMatthew G. Knepley *prob = dm->probs[0].ds; 5275e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5276e5e52638SMatthew G. Knepley } 5277e5e52638SMatthew G. Knepley 5278e5e52638SMatthew G. Knepley /*@ 5279e5e52638SMatthew G. Knepley DMGetCellDS - Get the PetscDS defined on a given cell 5280e5e52638SMatthew G. Knepley 5281e5e52638SMatthew G. Knepley Not collective 5282e5e52638SMatthew G. Knepley 5283e5e52638SMatthew G. Knepley Input Parameters: 5284e5e52638SMatthew G. Knepley + dm - The DM 5285e5e52638SMatthew G. Knepley - point - Cell for the DS 5286e5e52638SMatthew G. Knepley 5287e5e52638SMatthew G. Knepley Output Parameter: 5288e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell 5289e5e52638SMatthew G. Knepley 5290e5e52638SMatthew G. Knepley Level: developer 5291e5e52638SMatthew G. Knepley 5292b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS() 5293e5e52638SMatthew G. Knepley @*/ 5294e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob) 5295e5e52638SMatthew G. Knepley { 5296e5e52638SMatthew G. Knepley PetscDS probDef = NULL; 5297e5e52638SMatthew G. Knepley PetscInt s; 5298e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5299e5e52638SMatthew G. Knepley 5300e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5301e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5302e5e52638SMatthew G. Knepley PetscValidPointer(prob, 3); 5303360cf244SMatthew G. Knepley if (point < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point); 5304e5e52638SMatthew G. Knepley *prob = NULL; 5305e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5306e5e52638SMatthew G. Knepley PetscInt val; 5307e5e52638SMatthew G. Knepley 5308e5e52638SMatthew G. Knepley if (!dm->probs[s].label) {probDef = dm->probs[s].ds;} 5309e5e52638SMatthew G. Knepley else { 5310e5e52638SMatthew G. Knepley ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr); 5311e5e52638SMatthew G. Knepley if (val >= 0) {*prob = dm->probs[s].ds; break;} 5312e5e52638SMatthew G. Knepley } 5313e5e52638SMatthew G. Knepley } 5314e5e52638SMatthew G. Knepley if (!*prob) *prob = probDef; 5315e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5316e5e52638SMatthew G. Knepley } 5317e5e52638SMatthew G. Knepley 5318e5e52638SMatthew G. Knepley /*@ 5319e5e52638SMatthew G. Knepley DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel 5320e5e52638SMatthew G. Knepley 5321e5e52638SMatthew G. Knepley Not collective 5322e5e52638SMatthew G. Knepley 5323e5e52638SMatthew G. Knepley Input Parameters: 5324e5e52638SMatthew G. Knepley + dm - The DM 5325e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh 5326e5e52638SMatthew G. Knepley 5327b3cf3223SMatthew G. Knepley Output Parameters: 5328b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5329b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL 5330e5e52638SMatthew G. Knepley 5331e5e52638SMatthew G. Knepley Note: If the label is missing, this function returns an error 5332e5e52638SMatthew G. Knepley 5333e5e52638SMatthew G. Knepley Level: advanced 5334e5e52638SMatthew G. Knepley 5335e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5336e5e52638SMatthew G. Knepley @*/ 5337b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds) 5338e5e52638SMatthew G. Knepley { 5339e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5340e5e52638SMatthew G. Knepley 5341e5e52638SMatthew G. Knepley PetscFunctionBegin; 5342e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5343e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5344b3cf3223SMatthew G. Knepley if (fields) {PetscValidPointer(fields, 3); *fields = NULL;} 5345b3cf3223SMatthew G. Knepley if (ds) {PetscValidPointer(ds, 4); *ds = NULL;} 5346e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5347b3cf3223SMatthew G. Knepley if (dm->probs[s].label == label) { 5348b3cf3223SMatthew G. Knepley if (fields) *fields = dm->probs[s].fields; 5349b3cf3223SMatthew G. Knepley if (ds) *ds = dm->probs[s].ds; 5350b3cf3223SMatthew G. Knepley PetscFunctionReturn(0); 5351b3cf3223SMatthew G. Knepley } 5352e5e52638SMatthew G. Knepley } 53532df9ee95SMatthew G. Knepley PetscFunctionReturn(0); 5354e5e52638SMatthew G. Knepley } 5355e5e52638SMatthew G. Knepley 5356e5e52638SMatthew G. Knepley /*@ 5357083401c6SMatthew G. Knepley DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel 5358083401c6SMatthew G. Knepley 5359083401c6SMatthew G. Knepley Collective on dm 5360083401c6SMatthew G. Knepley 5361083401c6SMatthew G. Knepley Input Parameters: 5362083401c6SMatthew G. Knepley + dm - The DM 5363083401c6SMatthew G. Knepley . label - The DMLabel defining the mesh region, or NULL for the entire mesh 5364083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields 5365083401c6SMatthew G. Knepley - prob - The PetscDS defined on the given cell 5366083401c6SMatthew G. Knepley 5367083401c6SMatthew 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, 5368083401c6SMatthew G. Knepley the fields argument is ignored. 5369083401c6SMatthew G. Knepley 5370083401c6SMatthew G. Knepley Level: advanced 5371083401c6SMatthew G. Knepley 5372083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS() 5373083401c6SMatthew G. Knepley @*/ 5374083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds) 5375083401c6SMatthew G. Knepley { 5376083401c6SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5377083401c6SMatthew G. Knepley PetscErrorCode ierr; 5378083401c6SMatthew G. Knepley 5379083401c6SMatthew G. Knepley PetscFunctionBegin; 5380083401c6SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5381083401c6SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5382064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4); 5383083401c6SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5384083401c6SMatthew G. Knepley if (dm->probs[s].label == label) { 5385083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5386083401c6SMatthew G. Knepley dm->probs[s].ds = ds; 5387083401c6SMatthew G. Knepley PetscFunctionReturn(0); 5388083401c6SMatthew G. Knepley } 5389083401c6SMatthew G. Knepley } 5390083401c6SMatthew G. Knepley ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr); 5391083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5392083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5393083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5394083401c6SMatthew G. Knepley if (!label) { 5395083401c6SMatthew G. Knepley /* Put the NULL label at the front, so it is returned as the default */ 5396083401c6SMatthew G. Knepley for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s]; 5397083401c6SMatthew G. Knepley Nds = 0; 5398083401c6SMatthew G. Knepley } 5399083401c6SMatthew G. Knepley dm->probs[Nds].label = label; 5400083401c6SMatthew G. Knepley dm->probs[Nds].fields = fields; 5401083401c6SMatthew G. Knepley dm->probs[Nds].ds = ds; 5402083401c6SMatthew G. Knepley PetscFunctionReturn(0); 5403083401c6SMatthew G. Knepley } 5404083401c6SMatthew G. Knepley 5405083401c6SMatthew G. Knepley /*@ 5406e5e52638SMatthew G. Knepley DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number 5407e5e52638SMatthew G. Knepley 5408e5e52638SMatthew G. Knepley Not collective 5409e5e52638SMatthew G. Knepley 5410e5e52638SMatthew G. Knepley Input Parameters: 5411e5e52638SMatthew G. Knepley + dm - The DM 5412e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds) 5413e5e52638SMatthew G. Knepley 5414e5e52638SMatthew G. Knepley Output Parameters: 5415b3cf3223SMatthew G. Knepley + label - The region label, or NULL 5416b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5417083401c6SMatthew G. Knepley - ds - The PetscDS defined on the given region, or NULL 5418e5e52638SMatthew G. Knepley 5419e5e52638SMatthew G. Knepley Level: advanced 5420e5e52638SMatthew G. Knepley 5421e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5422e5e52638SMatthew G. Knepley @*/ 5423b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds) 5424e5e52638SMatthew G. Knepley { 5425e5e52638SMatthew G. Knepley PetscInt Nds; 5426e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5427e5e52638SMatthew G. Knepley 5428e5e52638SMatthew G. Knepley PetscFunctionBegin; 5429e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5430e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 5431e5e52638SMatthew G. Knepley if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5432e5e52638SMatthew G. Knepley if (label) { 5433e5e52638SMatthew G. Knepley PetscValidPointer(label, 3); 5434e5e52638SMatthew G. Knepley *label = dm->probs[num].label; 5435e5e52638SMatthew G. Knepley } 5436b3cf3223SMatthew G. Knepley if (fields) { 5437b3cf3223SMatthew G. Knepley PetscValidPointer(fields, 4); 5438b3cf3223SMatthew G. Knepley *fields = dm->probs[num].fields; 5439b3cf3223SMatthew G. Knepley } 5440e5e52638SMatthew G. Knepley if (ds) { 5441b3cf3223SMatthew G. Knepley PetscValidPointer(ds, 5); 5442e5e52638SMatthew G. Knepley *ds = dm->probs[num].ds; 5443e5e52638SMatthew G. Knepley } 5444e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5445e5e52638SMatthew G. Knepley } 5446e5e52638SMatthew G. Knepley 5447e5e52638SMatthew G. Knepley /*@ 5448083401c6SMatthew G. Knepley DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number 5449e5e52638SMatthew G. Knepley 5450083401c6SMatthew G. Knepley Not collective 5451e5e52638SMatthew G. Knepley 5452e5e52638SMatthew G. Knepley Input Parameters: 5453e5e52638SMatthew G. Knepley + dm - The DM 5454083401c6SMatthew G. Knepley . num - The region number, in [0, Nds) 5455083401c6SMatthew G. Knepley . label - The region label, or NULL 5456083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting 5457083401c6SMatthew G. Knepley - ds - The PetscDS defined on the given region, or NULL to prevent setting 5458e5e52638SMatthew G. Knepley 5459e5e52638SMatthew G. Knepley Level: advanced 5460e5e52638SMatthew G. Knepley 5461083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5462e5e52638SMatthew G. Knepley @*/ 5463083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds) 5464e5e52638SMatthew G. Knepley { 5465083401c6SMatthew G. Knepley PetscInt Nds; 5466e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5467e5e52638SMatthew G. Knepley 5468e5e52638SMatthew G. Knepley PetscFunctionBegin; 5469e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5470083401c6SMatthew G. Knepley if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);} 5471083401c6SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 5472083401c6SMatthew G. Knepley if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5473e5e52638SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5474083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr); 5475083401c6SMatthew G. Knepley dm->probs[num].label = label; 5476083401c6SMatthew G. Knepley if (fields) { 5477083401c6SMatthew G. Knepley PetscValidHeaderSpecific(fields, IS_CLASSID, 4); 5478b3cf3223SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5479083401c6SMatthew G. Knepley ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr); 5480083401c6SMatthew G. Knepley dm->probs[num].fields = fields; 5481e5e52638SMatthew G. Knepley } 5482083401c6SMatthew G. Knepley if (ds) { 5483083401c6SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5); 5484083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5485083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr); 5486083401c6SMatthew G. Knepley dm->probs[num].ds = ds; 5487083401c6SMatthew G. Knepley } 5488e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5489e5e52638SMatthew G. Knepley } 5490e5e52638SMatthew G. Knepley 5491e5e52638SMatthew G. Knepley /*@ 54921d3af9e0SMatthew G. Knepley DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found. 54931d3af9e0SMatthew G. Knepley 54941d3af9e0SMatthew G. Knepley Not collective 54951d3af9e0SMatthew G. Knepley 54961d3af9e0SMatthew G. Knepley Input Parameters: 54971d3af9e0SMatthew G. Knepley + dm - The DM 54981d3af9e0SMatthew G. Knepley - ds - The PetscDS defined on the given region 54991d3af9e0SMatthew G. Knepley 55001d3af9e0SMatthew G. Knepley Output Parameter: 55011d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found 55021d3af9e0SMatthew G. Knepley 55031d3af9e0SMatthew G. Knepley Level: advanced 55041d3af9e0SMatthew G. Knepley 55051d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 55061d3af9e0SMatthew G. Knepley @*/ 55071d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num) 55081d3af9e0SMatthew G. Knepley { 55091d3af9e0SMatthew G. Knepley PetscInt Nds, n; 55101d3af9e0SMatthew G. Knepley PetscErrorCode ierr; 55111d3af9e0SMatthew G. Knepley 55121d3af9e0SMatthew G. Knepley PetscFunctionBegin; 55131d3af9e0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 55141d3af9e0SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2); 55151d3af9e0SMatthew G. Knepley PetscValidPointer(num, 3); 55161d3af9e0SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 55171d3af9e0SMatthew G. Knepley for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break; 55181d3af9e0SMatthew G. Knepley if (n >= Nds) *num = -1; 55191d3af9e0SMatthew G. Knepley else *num = n; 55201d3af9e0SMatthew G. Knepley PetscFunctionReturn(0); 55211d3af9e0SMatthew G. Knepley } 55221d3af9e0SMatthew G. Knepley 55231d3af9e0SMatthew G. Knepley /*@ 5524e5e52638SMatthew G. Knepley DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM 5525e5e52638SMatthew G. Knepley 5526d083f849SBarry Smith Collective on dm 5527e5e52638SMatthew G. Knepley 5528e5e52638SMatthew G. Knepley Input Parameter: 5529e5e52638SMatthew G. Knepley . dm - The DM 5530e5e52638SMatthew G. Knepley 553145480ffeSMatthew G. Knepley Options Database Keys: 553245480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM 553345480ffeSMatthew G. Knepley 5534e5e52638SMatthew G. Knepley Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. 5535e5e52638SMatthew G. Knepley 5536e5e52638SMatthew G. Knepley Level: intermediate 5537e5e52638SMatthew G. Knepley 5538e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 5539e5e52638SMatthew G. Knepley @*/ 5540e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm) 5541e5e52638SMatthew G. Knepley { 5542e5e52638SMatthew G. Knepley MPI_Comm comm; 5543083401c6SMatthew G. Knepley PetscDS dsDef; 5544083401c6SMatthew G. Knepley DMLabel *labelSet; 5545f9244615SMatthew G. Knepley PetscInt dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k; 5546f9244615SMatthew G. Knepley PetscBool doSetup = PETSC_TRUE, flg; 5547e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5548e5e52638SMatthew G. Knepley 5549e5e52638SMatthew G. Knepley PetscFunctionBegin; 5550e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5551e5e52638SMatthew G. Knepley if (!dm->fields) PetscFunctionReturn(0); 5552e5e52638SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr); 5553083401c6SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr); 5554083401c6SMatthew G. Knepley /* Determine how many regions we have */ 5555083401c6SMatthew G. Knepley ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr); 5556083401c6SMatthew G. Knepley Nl = 0; 5557083401c6SMatthew G. Knepley Ndef = 0; 5558083401c6SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5559083401c6SMatthew G. Knepley DMLabel label = dm->fields[f].label; 5560083401c6SMatthew G. Knepley PetscInt l; 5561083401c6SMatthew G. Knepley 5562*f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 5563*f918ec44SMatthew G. Knepley /* Move CEED context to discretizations */ 5564*f918ec44SMatthew G. Knepley { 5565*f918ec44SMatthew G. Knepley PetscClassId id; 5566*f918ec44SMatthew G. Knepley 5567*f918ec44SMatthew G. Knepley ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr); 5568*f918ec44SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 5569*f918ec44SMatthew G. Knepley Ceed ceed; 5570*f918ec44SMatthew G. Knepley 5571*f918ec44SMatthew G. Knepley ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr); 5572*f918ec44SMatthew G. Knepley ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr); 5573*f918ec44SMatthew G. Knepley } 5574*f918ec44SMatthew G. Knepley } 5575*f918ec44SMatthew G. Knepley #endif 5576083401c6SMatthew G. Knepley if (!label) {++Ndef; continue;} 5577083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break; 5578083401c6SMatthew G. Knepley if (l < Nl) continue; 5579083401c6SMatthew G. Knepley labelSet[Nl++] = label; 5580083401c6SMatthew G. Knepley } 5581083401c6SMatthew G. Knepley /* Create default DS if there are no labels to intersect with */ 5582083401c6SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr); 5583083401c6SMatthew G. Knepley if (!dsDef && Ndef && !Nl) { 5584b3cf3223SMatthew G. Knepley IS fields; 5585b3cf3223SMatthew G. Knepley PetscInt *fld, nf; 5586b3cf3223SMatthew G. Knepley 5587b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf; 5588083401c6SMatthew G. Knepley if (nf) { 5589b3cf3223SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5590b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f; 559188f0c812SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 559288f0c812SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 559388f0c812SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 559488f0c812SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 559588f0c812SMatthew G. Knepley 559645480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr); 5597083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr); 5598083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr); 5599b3cf3223SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 56002df9ee95SMatthew G. Knepley } 5601083401c6SMatthew G. Knepley } 5602083401c6SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr); 5603083401c6SMatthew G. Knepley if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);} 5604083401c6SMatthew G. Knepley /* Intersect labels with default fields */ 5605083401c6SMatthew G. Knepley if (Ndef && Nl) { 56060122748bSMatthew G. Knepley DM plex; 5607083401c6SMatthew G. Knepley DMLabel cellLabel; 5608083401c6SMatthew G. Knepley IS fieldIS, allcellIS, defcellIS = NULL; 5609083401c6SMatthew G. Knepley PetscInt *fields; 5610083401c6SMatthew G. Knepley const PetscInt *cells; 5611083401c6SMatthew G. Knepley PetscInt depth, nf = 0, n, c; 56120122748bSMatthew G. Knepley 56130122748bSMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 56140122748bSMatthew G. Knepley ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr); 5615083401c6SMatthew G. Knepley ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr); 5616083401c6SMatthew G. Knepley if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);} 5617083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) { 5618083401c6SMatthew G. Knepley DMLabel label = labelSet[l]; 5619083401c6SMatthew G. Knepley IS pointIS; 5620083401c6SMatthew G. Knepley 5621083401c6SMatthew G. Knepley ierr = ISDestroy(&defcellIS);CHKERRQ(ierr); 5622083401c6SMatthew G. Knepley ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr); 5623083401c6SMatthew G. Knepley ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr); 5624083401c6SMatthew G. Knepley ierr = ISDestroy(&pointIS);CHKERRQ(ierr); 5625083401c6SMatthew G. Knepley } 5626083401c6SMatthew G. Knepley ierr = ISDestroy(&allcellIS);CHKERRQ(ierr); 5627083401c6SMatthew G. Knepley 5628083401c6SMatthew G. Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr); 5629083401c6SMatthew G. Knepley ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr); 5630083401c6SMatthew G. Knepley ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr); 5631083401c6SMatthew G. Knepley for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);} 5632083401c6SMatthew G. Knepley ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr); 5633083401c6SMatthew G. Knepley ierr = ISDestroy(&defcellIS);CHKERRQ(ierr); 5634083401c6SMatthew G. Knepley ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr); 5635083401c6SMatthew G. Knepley 5636083401c6SMatthew G. Knepley ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr); 5637083401c6SMatthew G. Knepley for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f; 5638083401c6SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr); 5639083401c6SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr); 5640083401c6SMatthew G. Knepley ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr); 5641083401c6SMatthew G. Knepley ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr); 5642083401c6SMatthew G. Knepley 564345480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr); 5644083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr); 5645083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr); 5646083401c6SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr); 5647083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr); 5648083401c6SMatthew G. Knepley ierr = ISDestroy(&fieldIS);CHKERRQ(ierr); 56490122748bSMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 5650083401c6SMatthew G. Knepley } 5651083401c6SMatthew G. Knepley /* Create label DSes 5652083401c6SMatthew G. Knepley - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS 5653083401c6SMatthew G. Knepley */ 5654083401c6SMatthew G. Knepley /* TODO Should check that labels are disjoint */ 5655083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) { 5656083401c6SMatthew G. Knepley DMLabel label = labelSet[l]; 5657083401c6SMatthew G. Knepley PetscDS ds; 5658083401c6SMatthew G. Knepley IS fields; 5659083401c6SMatthew G. Knepley PetscInt *fld, nf; 5660083401c6SMatthew G. Knepley 566145480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 5662083401c6SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf; 5663083401c6SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5664083401c6SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f; 5665083401c6SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 5666083401c6SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 5667083401c6SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 5668083401c6SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 5669083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr); 5670083401c6SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 5671083401c6SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr); 5672083401c6SMatthew G. Knepley { 5673083401c6SMatthew G. Knepley DMPolytopeType ct; 5674083401c6SMatthew G. Knepley PetscInt lStart, lEnd; 5675083401c6SMatthew G. Knepley PetscBool isHybridLocal = PETSC_FALSE, isHybrid; 56760122748bSMatthew G. Knepley 5677e5e52638SMatthew G. Knepley ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr); 5678665f567fSMatthew G. Knepley if (lStart >= 0) { 5679412e9a14SMatthew G. Knepley ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr); 5680412e9a14SMatthew G. Knepley switch (ct) { 5681412e9a14SMatthew G. Knepley case DM_POLYTOPE_POINT_PRISM_TENSOR: 5682412e9a14SMatthew G. Knepley case DM_POLYTOPE_SEG_PRISM_TENSOR: 5683412e9a14SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM_TENSOR: 5684412e9a14SMatthew G. Knepley case DM_POLYTOPE_QUAD_PRISM_TENSOR: 5685083401c6SMatthew G. Knepley isHybridLocal = PETSC_TRUE;break; 5686083401c6SMatthew G. Knepley default: break; 5687412e9a14SMatthew G. Knepley } 5688665f567fSMatthew G. Knepley } 5689ffc4695bSBarry Smith ierr = MPI_Allreduce(&isHybridLocal, &isHybrid, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr); 5690083401c6SMatthew G. Knepley ierr = PetscDSSetHybrid(ds, isHybrid);CHKERRQ(ierr); 5691e5e52638SMatthew G. Knepley } 5692083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 5693e5e52638SMatthew G. Knepley } 5694083401c6SMatthew G. Knepley ierr = PetscFree(labelSet);CHKERRQ(ierr); 5695e5e52638SMatthew G. Knepley /* Set fields in DSes */ 5696083401c6SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5697083401c6SMatthew G. Knepley PetscDS ds = dm->probs[s].ds; 5698083401c6SMatthew G. Knepley IS fields = dm->probs[s].fields; 5699083401c6SMatthew G. Knepley const PetscInt *fld; 5700083401c6SMatthew G. Knepley PetscInt nf; 5701e5e52638SMatthew G. Knepley 5702083401c6SMatthew G. Knepley ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr); 5703083401c6SMatthew G. Knepley ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr); 5704083401c6SMatthew G. Knepley for (f = 0; f < nf; ++f) { 5705083401c6SMatthew G. Knepley PetscObject disc = dm->fields[fld[f]].disc; 5706083401c6SMatthew G. Knepley PetscBool isHybrid; 5707e5e52638SMatthew G. Knepley PetscClassId id; 5708e5e52638SMatthew G. Knepley 5709083401c6SMatthew G. Knepley ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr); 5710083401c6SMatthew G. Knepley /* If this is a cohesive cell, then it needs the lower dimensional discretization */ 5711083401c6SMatthew G. Knepley if (isHybrid && f < nf-1) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);} 5712083401c6SMatthew G. Knepley ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr); 5713083401c6SMatthew G. Knepley /* We allow people to have placeholder fields and construct the Section by hand */ 5714e5e52638SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 5715e5e52638SMatthew G. Knepley if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE; 5716e5e52638SMatthew G. Knepley } 5717083401c6SMatthew G. Knepley ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr); 5718e5e52638SMatthew G. Knepley } 5719f9244615SMatthew G. Knepley /* Allow k-jet tabulation */ 5720f9244615SMatthew G. Knepley ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr); 5721f9244615SMatthew G. Knepley if (flg) { 57223b4aee56SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 57233b4aee56SMatthew G. Knepley PetscDS ds = dm->probs[s].ds; 57243b4aee56SMatthew G. Knepley PetscInt Nf, f; 57253b4aee56SMatthew G. Knepley 57263b4aee56SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr); 57273b4aee56SMatthew G. Knepley for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);} 57283b4aee56SMatthew G. Knepley } 5729f9244615SMatthew G. Knepley } 5730e5e52638SMatthew G. Knepley /* Setup DSes */ 5731e5e52638SMatthew G. Knepley if (doSetup) { 5732e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);} 5733e5e52638SMatthew G. Knepley } 5734e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5735e5e52638SMatthew G. Knepley } 5736e5e52638SMatthew G. Knepley 5737e5e52638SMatthew G. Knepley /*@ 57387f96f943SMatthew G. Knepley DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information. 57397f96f943SMatthew G. Knepley 5740f2cacb80SMatthew G. Knepley Collective on DM 5741f2cacb80SMatthew G. Knepley 57427f96f943SMatthew G. Knepley Input Parameters: 57437f96f943SMatthew G. Knepley + dm - The DM 57447f96f943SMatthew G. Knepley - time - The time 57457f96f943SMatthew G. Knepley 57467f96f943SMatthew G. Knepley Output Parameters: 5747f2cacb80SMatthew G. Knepley + u - The vector will be filled with exact solution values, or NULL 5748f2cacb80SMatthew G. Knepley - u_t - The vector will be filled with the time derivative of exact solution values, or NULL 57497f96f943SMatthew G. Knepley 57507f96f943SMatthew G. Knepley Note: The user must call PetscDSSetExactSolution() beforehand 57517f96f943SMatthew G. Knepley 57527f96f943SMatthew G. Knepley Level: developer 57537f96f943SMatthew G. Knepley 57547f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution() 57557f96f943SMatthew G. Knepley @*/ 5756f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t) 57577f96f943SMatthew G. Knepley { 57587f96f943SMatthew G. Knepley PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx); 57597f96f943SMatthew G. Knepley void **ectxs; 57607f96f943SMatthew G. Knepley PetscInt Nf, Nds, s; 57617f96f943SMatthew G. Knepley PetscErrorCode ierr; 57627f96f943SMatthew G. Knepley 57637f96f943SMatthew G. Knepley PetscFunctionBegin; 5764f2cacb80SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5765f2cacb80SMatthew G. Knepley if (u) PetscValidHeaderSpecific(u, VEC_CLASSID, 3); 5766f2cacb80SMatthew G. Knepley if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4); 57677f96f943SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 57687f96f943SMatthew G. Knepley ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr); 57697f96f943SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 57707f96f943SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 57717f96f943SMatthew G. Knepley PetscDS ds; 57727f96f943SMatthew G. Knepley DMLabel label; 57737f96f943SMatthew G. Knepley IS fieldIS; 57747f96f943SMatthew G. Knepley const PetscInt *fields, id = 1; 57757f96f943SMatthew G. Knepley PetscInt dsNf, f; 57767f96f943SMatthew G. Knepley 57777f96f943SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr); 57787f96f943SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr); 57797f96f943SMatthew G. Knepley ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr); 57807f96f943SMatthew G. Knepley ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr); 57817f96f943SMatthew G. Knepley ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr); 5782f2cacb80SMatthew G. Knepley if (u) { 57837f96f943SMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 57847f96f943SMatthew G. Knepley const PetscInt field = fields[f]; 57857f96f943SMatthew G. Knepley ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr); 57867f96f943SMatthew G. Knepley } 57877f96f943SMatthew G. Knepley ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr); 57887f96f943SMatthew G. Knepley if (label) { 57897f96f943SMatthew G. Knepley ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr); 57907f96f943SMatthew G. Knepley } else { 57917f96f943SMatthew G. Knepley ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr); 57927f96f943SMatthew G. Knepley } 57937f96f943SMatthew G. Knepley } 5794f2cacb80SMatthew G. Knepley if (u_t) { 5795f2cacb80SMatthew G. Knepley ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr); 5796f2cacb80SMatthew G. Knepley ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr); 5797f2cacb80SMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 5798f2cacb80SMatthew G. Knepley const PetscInt field = fields[f]; 5799f2cacb80SMatthew G. Knepley ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr); 5800f2cacb80SMatthew G. Knepley } 5801f2cacb80SMatthew G. Knepley ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr); 5802f2cacb80SMatthew G. Knepley if (label) { 5803f2cacb80SMatthew G. Knepley ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr); 5804f2cacb80SMatthew G. Knepley } else { 5805f2cacb80SMatthew G. Knepley ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr); 5806f2cacb80SMatthew G. Knepley } 5807f2cacb80SMatthew G. Knepley } 5808f2cacb80SMatthew G. Knepley } 5809f2cacb80SMatthew G. Knepley if (u) { 58107f96f943SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr); 58117f96f943SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr); 5812f2cacb80SMatthew G. Knepley } 5813f2cacb80SMatthew G. Knepley if (u_t) { 5814f2cacb80SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr); 5815f2cacb80SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr); 5816f2cacb80SMatthew G. Knepley } 58177f96f943SMatthew G. Knepley ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr); 58187f96f943SMatthew G. Knepley PetscFunctionReturn(0); 58197f96f943SMatthew G. Knepley } 58207f96f943SMatthew G. Knepley 582145480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds) 582245480ffeSMatthew G. Knepley { 582345480ffeSMatthew G. Knepley PetscDS dsNew; 582445480ffeSMatthew G. Knepley DSBoundary b; 582545480ffeSMatthew G. Knepley PetscInt cdim, Nf, f; 582645480ffeSMatthew G. Knepley void *ctx; 582745480ffeSMatthew G. Knepley PetscErrorCode ierr; 582845480ffeSMatthew G. Knepley 582945480ffeSMatthew G. Knepley PetscFunctionBegin; 583045480ffeSMatthew G. Knepley ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr); 583145480ffeSMatthew G. Knepley ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr); 583245480ffeSMatthew G. Knepley ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr); 583345480ffeSMatthew G. Knepley ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr); 583445480ffeSMatthew G. Knepley ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr); 583545480ffeSMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr); 583645480ffeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 583745480ffeSMatthew G. Knepley ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr); 583845480ffeSMatthew G. Knepley ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr); 583945480ffeSMatthew G. Knepley } 584045480ffeSMatthew G. Knepley if (Nf) { 584145480ffeSMatthew G. Knepley ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr); 584245480ffeSMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr); 584345480ffeSMatthew G. Knepley } 584445480ffeSMatthew G. Knepley ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr); 584545480ffeSMatthew G. Knepley for (b = dsNew->boundary; b; b = b->next) { 584645480ffeSMatthew G. Knepley ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr); 584745480ffeSMatthew G. Knepley /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */ 584845480ffeSMatthew G. Knepley //if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name); 584945480ffeSMatthew G. Knepley } 585045480ffeSMatthew G. Knepley 585145480ffeSMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr); 585245480ffeSMatthew G. Knepley ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr); 585345480ffeSMatthew G. Knepley PetscFunctionReturn(0); 585445480ffeSMatthew G. Knepley } 585545480ffeSMatthew G. Knepley 58567f96f943SMatthew G. Knepley /*@ 5857e5e52638SMatthew G. Knepley DMCopyDS - Copy the discrete systems for the DM into another DM 5858e5e52638SMatthew G. Knepley 5859d083f849SBarry Smith Collective on dm 5860e5e52638SMatthew G. Knepley 5861e5e52638SMatthew G. Knepley Input Parameter: 5862e5e52638SMatthew G. Knepley . dm - The DM 5863e5e52638SMatthew G. Knepley 5864e5e52638SMatthew G. Knepley Output Parameter: 5865e5e52638SMatthew G. Knepley . newdm - The DM 5866e5e52638SMatthew G. Knepley 5867e5e52638SMatthew G. Knepley Level: advanced 5868e5e52638SMatthew G. Knepley 5869e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 5870e5e52638SMatthew G. Knepley @*/ 5871e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm) 5872e5e52638SMatthew G. Knepley { 5873e5e52638SMatthew G. Knepley PetscInt Nds, s; 5874e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5875e5e52638SMatthew G. Knepley 5876e5e52638SMatthew G. Knepley PetscFunctionBegin; 5877e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 5878e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 5879e5e52638SMatthew G. Knepley ierr = DMClearDS(newdm);CHKERRQ(ierr); 5880e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5881e5e52638SMatthew G. Knepley DMLabel label; 5882b3cf3223SMatthew G. Knepley IS fields; 588345480ffeSMatthew G. Knepley PetscDS ds, newds; 5884783e2ec8SMatthew G. Knepley PetscInt Nbd, bd; 5885e5e52638SMatthew G. Knepley 5886b3cf3223SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr); 588745480ffeSMatthew G. Knepley ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr); 588845480ffeSMatthew G. Knepley /* Commplete new labels in the new DS */ 588945480ffeSMatthew G. Knepley ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr); 589045480ffeSMatthew G. Knepley ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr); 5891783e2ec8SMatthew G. Knepley for (bd = 0; bd < Nbd; ++bd) { 589245480ffeSMatthew G. Knepley DMLabel label; 5893783e2ec8SMatthew G. Knepley PetscInt field; 5894783e2ec8SMatthew G. Knepley 589545480ffeSMatthew G. Knepley ierr = PetscDSGetBoundary(newds, bd, NULL, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 589645480ffeSMatthew G. Knepley ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr); 5897783e2ec8SMatthew G. Knepley } 5898e5e52638SMatthew G. Knepley } 5899e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5900e5e52638SMatthew G. Knepley } 5901e5e52638SMatthew G. Knepley 5902e5e52638SMatthew G. Knepley /*@ 5903e5e52638SMatthew G. Knepley DMCopyDisc - Copy the fields and discrete systems for the DM into another DM 5904e5e52638SMatthew G. Knepley 5905d083f849SBarry Smith Collective on dm 5906e5e52638SMatthew G. Knepley 5907e5e52638SMatthew G. Knepley Input Parameter: 5908e5e52638SMatthew G. Knepley . dm - The DM 5909e5e52638SMatthew G. Knepley 5910e5e52638SMatthew G. Knepley Output Parameter: 5911e5e52638SMatthew G. Knepley . newdm - The DM 5912e5e52638SMatthew G. Knepley 5913e5e52638SMatthew G. Knepley Level: advanced 5914e5e52638SMatthew G. Knepley 5915e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS() 5916e5e52638SMatthew G. Knepley @*/ 5917e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm) 5918e5e52638SMatthew G. Knepley { 5919e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5920e5e52638SMatthew G. Knepley 5921e5e52638SMatthew G. Knepley PetscFunctionBegin; 5922e5e52638SMatthew G. Knepley ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr); 5923e5e52638SMatthew G. Knepley ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr); 5924e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5925e5e52638SMatthew G. Knepley } 5926e5e52638SMatthew G. Knepley 5927b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx) 5928b64e0483SPeter Brune { 5929b64e0483SPeter Brune DM dm_coord,dmc_coord; 5930b64e0483SPeter Brune PetscErrorCode ierr; 5931b64e0483SPeter Brune Vec coords,ccoords; 59326dbf9973SLawrence Mitchell Mat inject; 5933b64e0483SPeter Brune PetscFunctionBegin; 5934b64e0483SPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 5935b64e0483SPeter Brune ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr); 5936b64e0483SPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 5937b64e0483SPeter Brune ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr); 5938b64e0483SPeter Brune if (coords && !ccoords) { 5939b64e0483SPeter Brune ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr); 59406668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 59416dbf9973SLawrence Mitchell ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr); 59422adcf181SLawrence Mitchell ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr); 59436dbf9973SLawrence Mitchell ierr = MatDestroy(&inject);CHKERRQ(ierr); 5944b64e0483SPeter Brune ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr); 5945b64e0483SPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 5946b64e0483SPeter Brune } 5947b64e0483SPeter Brune PetscFunctionReturn(0); 5948b64e0483SPeter Brune } 5949b64e0483SPeter Brune 595003dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx) 595103dadc2fSPeter Brune { 595203dadc2fSPeter Brune DM dm_coord,subdm_coord; 595303dadc2fSPeter Brune PetscErrorCode ierr; 595403dadc2fSPeter Brune Vec coords,ccoords,clcoords; 595503dadc2fSPeter Brune VecScatter *scat_i,*scat_g; 595603dadc2fSPeter Brune PetscFunctionBegin; 595703dadc2fSPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 595803dadc2fSPeter Brune ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr); 595903dadc2fSPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 596003dadc2fSPeter Brune ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr); 596103dadc2fSPeter Brune if (coords && !ccoords) { 596203dadc2fSPeter Brune ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr); 59636668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 596403dadc2fSPeter Brune ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr); 596524640c55SToby Isaac ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr); 596603dadc2fSPeter Brune ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr); 596703dadc2fSPeter Brune ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 596803dadc2fSPeter Brune ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 59691ed9ada7SJunchao Zhang ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 597003dadc2fSPeter Brune ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 597103dadc2fSPeter Brune ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr); 597203dadc2fSPeter Brune ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr); 597303dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr); 597403dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr); 597503dadc2fSPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 597603dadc2fSPeter Brune ierr = VecDestroy(&clcoords);CHKERRQ(ierr); 597703dadc2fSPeter Brune ierr = PetscFree(scat_i);CHKERRQ(ierr); 597803dadc2fSPeter Brune ierr = PetscFree(scat_g);CHKERRQ(ierr); 597903dadc2fSPeter Brune } 598003dadc2fSPeter Brune PetscFunctionReturn(0); 598103dadc2fSPeter Brune } 598203dadc2fSPeter Brune 5983c73cfb54SMatthew G. Knepley /*@ 5984c73cfb54SMatthew G. Knepley DMGetDimension - Return the topological dimension of the DM 5985c73cfb54SMatthew G. Knepley 5986c73cfb54SMatthew G. Knepley Not collective 5987c73cfb54SMatthew G. Knepley 5988c73cfb54SMatthew G. Knepley Input Parameter: 5989c73cfb54SMatthew G. Knepley . dm - The DM 5990c73cfb54SMatthew G. Knepley 5991c73cfb54SMatthew G. Knepley Output Parameter: 5992c73cfb54SMatthew G. Knepley . dim - The topological dimension 5993c73cfb54SMatthew G. Knepley 5994c73cfb54SMatthew G. Knepley Level: beginner 5995c73cfb54SMatthew G. Knepley 5996c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate() 5997c73cfb54SMatthew G. Knepley @*/ 5998c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim) 5999c73cfb54SMatthew G. Knepley { 6000c73cfb54SMatthew G. Knepley PetscFunctionBegin; 6001c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6002534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 6003c73cfb54SMatthew G. Knepley *dim = dm->dim; 6004c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 6005c73cfb54SMatthew G. Knepley } 6006c73cfb54SMatthew G. Knepley 6007c73cfb54SMatthew G. Knepley /*@ 6008c73cfb54SMatthew G. Knepley DMSetDimension - Set the topological dimension of the DM 6009c73cfb54SMatthew G. Knepley 6010c73cfb54SMatthew G. Knepley Collective on dm 6011c73cfb54SMatthew G. Knepley 6012c73cfb54SMatthew G. Knepley Input Parameters: 6013c73cfb54SMatthew G. Knepley + dm - The DM 6014c73cfb54SMatthew G. Knepley - dim - The topological dimension 6015c73cfb54SMatthew G. Knepley 6016c73cfb54SMatthew G. Knepley Level: beginner 6017c73cfb54SMatthew G. Knepley 6018c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate() 6019c73cfb54SMatthew G. Knepley @*/ 6020c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim) 6021c73cfb54SMatthew G. Knepley { 6022e5e52638SMatthew G. Knepley PetscDS ds; 602345480ffeSMatthew G. Knepley PetscInt Nds, n; 6024f17e8794SMatthew G. Knepley PetscErrorCode ierr; 6025f17e8794SMatthew G. Knepley 6026c73cfb54SMatthew G. Knepley PetscFunctionBegin; 6027c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6028c73cfb54SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, dim, 2); 6029c73cfb54SMatthew G. Knepley dm->dim = dim; 603045480ffeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 603145480ffeSMatthew G. Knepley for (n = 0; n < Nds; ++n) { 603245480ffeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr); 603345480ffeSMatthew G. Knepley if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);} 603445480ffeSMatthew G. Knepley } 6035c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 6036c73cfb54SMatthew G. Knepley } 6037c73cfb54SMatthew G. Knepley 6038793f3fe5SMatthew G. Knepley /*@ 6039793f3fe5SMatthew G. Knepley DMGetDimPoints - Get the half-open interval for all points of a given dimension 6040793f3fe5SMatthew G. Knepley 6041d083f849SBarry Smith Collective on dm 6042793f3fe5SMatthew G. Knepley 6043793f3fe5SMatthew G. Knepley Input Parameters: 6044793f3fe5SMatthew G. Knepley + dm - the DM 6045793f3fe5SMatthew G. Knepley - dim - the dimension 6046793f3fe5SMatthew G. Knepley 6047793f3fe5SMatthew G. Knepley Output Parameters: 6048793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension 6049aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension 6050793f3fe5SMatthew G. Knepley 6051793f3fe5SMatthew G. Knepley Note: 6052793f3fe5SMatthew G. Knepley The points are vertices in the Hasse diagram encoding the topology. This is explained in 6053a8d69d7bSBarry Smith https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme, 6054793f3fe5SMatthew G. Knepley then the interval is empty. 6055793f3fe5SMatthew G. Knepley 6056793f3fe5SMatthew G. Knepley Level: intermediate 6057793f3fe5SMatthew G. Knepley 6058793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum() 6059793f3fe5SMatthew G. Knepley @*/ 6060793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd) 6061793f3fe5SMatthew G. Knepley { 6062793f3fe5SMatthew G. Knepley PetscInt d; 6063793f3fe5SMatthew G. Knepley PetscErrorCode ierr; 6064793f3fe5SMatthew G. Knepley 6065793f3fe5SMatthew G. Knepley PetscFunctionBegin; 6066793f3fe5SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6067793f3fe5SMatthew G. Knepley ierr = DMGetDimension(dm, &d);CHKERRQ(ierr); 6068793f3fe5SMatthew G. Knepley if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d); 6069b9d85ea2SLisandro Dalcin if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name); 6070793f3fe5SMatthew G. Knepley ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr); 6071793f3fe5SMatthew G. Knepley PetscFunctionReturn(0); 6072793f3fe5SMatthew G. Knepley } 6073793f3fe5SMatthew G. Knepley 60746636e97aSMatthew G Knepley /*@ 60756636e97aSMatthew G Knepley DMSetCoordinates - Sets into the DM a global vector that holds the coordinates 60766636e97aSMatthew G Knepley 6077d083f849SBarry Smith Collective on dm 60786636e97aSMatthew G Knepley 60796636e97aSMatthew G Knepley Input Parameters: 60806636e97aSMatthew G Knepley + dm - the DM 60816636e97aSMatthew G Knepley - c - coordinate vector 60826636e97aSMatthew G Knepley 60832dd40e9bSPatrick Sanan Notes: 60842dd40e9bSPatrick Sanan The coordinates do include those for ghost points, which are in the local vector. 60852dd40e9bSPatrick Sanan 60862dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 60876636e97aSMatthew G Knepley 60886636e97aSMatthew G Knepley Level: intermediate 60896636e97aSMatthew G Knepley 609060c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates() 60916636e97aSMatthew G Knepley @*/ 60926636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c) 60936636e97aSMatthew G Knepley { 60946636e97aSMatthew G Knepley PetscErrorCode ierr; 60956636e97aSMatthew G Knepley 60966636e97aSMatthew G Knepley PetscFunctionBegin; 60976636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 60986636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 60996636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 61006636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 61016636e97aSMatthew G Knepley dm->coordinates = c; 61026636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 6103b64e0483SPeter Brune ierr = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 610403dadc2fSPeter Brune ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 61056636e97aSMatthew G Knepley PetscFunctionReturn(0); 61066636e97aSMatthew G Knepley } 61076636e97aSMatthew G Knepley 61086636e97aSMatthew G Knepley /*@ 61096636e97aSMatthew G Knepley DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates 61106636e97aSMatthew G Knepley 61117058e716SVaclav Hapla Not collective 61126636e97aSMatthew G Knepley 61136636e97aSMatthew G Knepley Input Parameters: 61146636e97aSMatthew G Knepley + dm - the DM 61156636e97aSMatthew G Knepley - c - coordinate vector 61166636e97aSMatthew G Knepley 61172dd40e9bSPatrick Sanan Notes: 61186636e97aSMatthew G Knepley The coordinates of ghost points can be set using DMSetCoordinates() 61196636e97aSMatthew G Knepley followed by DMGetCoordinatesLocal(). This is intended to enable the 61206636e97aSMatthew G Knepley setting of ghost coordinates outside of the domain. 61216636e97aSMatthew G Knepley 61222dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 61232dd40e9bSPatrick Sanan 61246636e97aSMatthew G Knepley Level: intermediate 61256636e97aSMatthew G Knepley 61266636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM() 61276636e97aSMatthew G Knepley @*/ 61286636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c) 61296636e97aSMatthew G Knepley { 61306636e97aSMatthew G Knepley PetscErrorCode ierr; 61316636e97aSMatthew G Knepley 61326636e97aSMatthew G Knepley PetscFunctionBegin; 61336636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 61346636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 61356636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 61366636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 61378865f1eaSKarl Rupp 61386636e97aSMatthew G Knepley dm->coordinatesLocal = c; 61398865f1eaSKarl Rupp 61406636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 61416636e97aSMatthew G Knepley PetscFunctionReturn(0); 61426636e97aSMatthew G Knepley } 61436636e97aSMatthew G Knepley 61446636e97aSMatthew G Knepley /*@ 61456636e97aSMatthew G Knepley DMGetCoordinates - Gets a global vector with the coordinates associated with the DM. 61466636e97aSMatthew G Knepley 6147d083f849SBarry Smith Collective on dm 61486636e97aSMatthew G Knepley 61496636e97aSMatthew G Knepley Input Parameter: 61506636e97aSMatthew G Knepley . dm - the DM 61516636e97aSMatthew G Knepley 61526636e97aSMatthew G Knepley Output Parameter: 61536636e97aSMatthew G Knepley . c - global coordinate vector 61546636e97aSMatthew G Knepley 61556636e97aSMatthew G Knepley Note: 615660c22052SBarry Smith This is a borrowed reference, so the user should NOT destroy this vector. When the DM is 615760c22052SBarry Smith destroyed the array will no longer be valid. 61586636e97aSMatthew G Knepley 6159959c7569SPatrick Sanan Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates). 61606636e97aSMatthew G Knepley 61616636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 61626636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 61636636e97aSMatthew G Knepley 61646636e97aSMatthew G Knepley Level: intermediate 61656636e97aSMatthew G Knepley 616660c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates() 61676636e97aSMatthew G Knepley @*/ 61686636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c) 61696636e97aSMatthew G Knepley { 61706636e97aSMatthew G Knepley PetscErrorCode ierr; 61716636e97aSMatthew G Knepley 61726636e97aSMatthew G Knepley PetscFunctionBegin; 61736636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 61746636e97aSMatthew G Knepley PetscValidPointer(c,2); 61751f588964SMatthew G Knepley if (!dm->coordinates && dm->coordinatesLocal) { 61760298fd71SBarry Smith DM cdm = NULL; 61771970a576SMatthew G. Knepley PetscBool localized; 61786636e97aSMatthew G Knepley 61796636e97aSMatthew G Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 61806636e97aSMatthew G Knepley ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr); 61811970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 61821970a576SMatthew G. Knepley /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */ 61831970a576SMatthew G. Knepley if (localized) { 61841970a576SMatthew G. Knepley PetscInt cdim; 61851970a576SMatthew G. Knepley 61861970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 61871970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 61881970a576SMatthew G. Knepley } 61896636e97aSMatthew G Knepley ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr); 61906636e97aSMatthew G Knepley ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 61916636e97aSMatthew G Knepley ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 61926636e97aSMatthew G Knepley } 61936636e97aSMatthew G Knepley *c = dm->coordinates; 61946636e97aSMatthew G Knepley PetscFunctionReturn(0); 61956636e97aSMatthew G Knepley } 61966636e97aSMatthew G Knepley 61976636e97aSMatthew G Knepley /*@ 619881e9a530SVaclav Hapla DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards. 619981e9a530SVaclav Hapla 6200d083f849SBarry Smith Collective on dm 620181e9a530SVaclav Hapla 620281e9a530SVaclav Hapla Input Parameter: 620381e9a530SVaclav Hapla . dm - the DM 620481e9a530SVaclav Hapla 620581e9a530SVaclav Hapla Level: advanced 620681e9a530SVaclav Hapla 620781e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective() 620881e9a530SVaclav Hapla @*/ 620981e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm) 621081e9a530SVaclav Hapla { 621181e9a530SVaclav Hapla PetscErrorCode ierr; 621281e9a530SVaclav Hapla 621381e9a530SVaclav Hapla PetscFunctionBegin; 621481e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 621581e9a530SVaclav Hapla if (!dm->coordinatesLocal && dm->coordinates) { 62161970a576SMatthew G. Knepley DM cdm = NULL; 62171970a576SMatthew G. Knepley PetscBool localized; 62181970a576SMatthew G. Knepley 621981e9a530SVaclav Hapla ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 622081e9a530SVaclav Hapla ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr); 62211970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 62221970a576SMatthew G. Knepley /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */ 62231970a576SMatthew G. Knepley if (localized) { 62241970a576SMatthew G. Knepley PetscInt cdim; 62251970a576SMatthew G. Knepley 62261970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 62271970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 62281970a576SMatthew G. Knepley } 622981e9a530SVaclav Hapla ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr); 623081e9a530SVaclav Hapla ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 623181e9a530SVaclav Hapla ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 623281e9a530SVaclav Hapla } 623381e9a530SVaclav Hapla PetscFunctionReturn(0); 623481e9a530SVaclav Hapla } 623581e9a530SVaclav Hapla 623681e9a530SVaclav Hapla /*@ 62376636e97aSMatthew G Knepley DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM. 62386636e97aSMatthew G Knepley 6239d083f849SBarry Smith Collective on dm 62406636e97aSMatthew G Knepley 62416636e97aSMatthew G Knepley Input Parameter: 62426636e97aSMatthew G Knepley . dm - the DM 62436636e97aSMatthew G Knepley 62446636e97aSMatthew G Knepley Output Parameter: 62456636e97aSMatthew G Knepley . c - coordinate vector 62466636e97aSMatthew G Knepley 62476636e97aSMatthew G Knepley Note: 62486636e97aSMatthew G Knepley This is a borrowed reference, so the user should NOT destroy this vector 62496636e97aSMatthew G Knepley 62506636e97aSMatthew G Knepley Each process has the local and ghost coordinates 62516636e97aSMatthew G Knepley 62526636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 62536636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 62546636e97aSMatthew G Knepley 62556636e97aSMatthew G Knepley Level: intermediate 62566636e97aSMatthew G Knepley 625781e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective() 62586636e97aSMatthew G Knepley @*/ 62596636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c) 62606636e97aSMatthew G Knepley { 62616636e97aSMatthew G Knepley PetscErrorCode ierr; 62626636e97aSMatthew G Knepley 62636636e97aSMatthew G Knepley PetscFunctionBegin; 62646636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 62656636e97aSMatthew G Knepley PetscValidPointer(c,2); 626681e9a530SVaclav Hapla ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr); 62676636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 62686636e97aSMatthew G Knepley PetscFunctionReturn(0); 62696636e97aSMatthew G Knepley } 62706636e97aSMatthew G Knepley 627181e9a530SVaclav Hapla /*@ 627281e9a530SVaclav Hapla DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called. 627381e9a530SVaclav Hapla 627481e9a530SVaclav Hapla Not collective 627581e9a530SVaclav Hapla 627681e9a530SVaclav Hapla Input Parameter: 627781e9a530SVaclav Hapla . dm - the DM 627881e9a530SVaclav Hapla 627981e9a530SVaclav Hapla Output Parameter: 628081e9a530SVaclav Hapla . c - coordinate vector 628181e9a530SVaclav Hapla 628281e9a530SVaclav Hapla Level: advanced 628381e9a530SVaclav Hapla 628481e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 628581e9a530SVaclav Hapla @*/ 628681e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c) 628781e9a530SVaclav Hapla { 628881e9a530SVaclav Hapla PetscFunctionBegin; 628981e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 629081e9a530SVaclav Hapla PetscValidPointer(c,2); 629181e9a530SVaclav Hapla if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called"); 62926636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 62936636e97aSMatthew G Knepley PetscFunctionReturn(0); 62946636e97aSMatthew G Knepley } 62956636e97aSMatthew G Knepley 62962db98f8dSVaclav Hapla /*@ 62972db98f8dSVaclav Hapla DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout. 62982db98f8dSVaclav Hapla 62992db98f8dSVaclav Hapla Not collective 63002db98f8dSVaclav Hapla 63012db98f8dSVaclav Hapla Input Parameter: 63022db98f8dSVaclav Hapla + dm - the DM 63032db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned 63042db98f8dSVaclav Hapla 63052db98f8dSVaclav Hapla Output Parameter: 63062db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates 63072db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p 63082db98f8dSVaclav Hapla 63092db98f8dSVaclav Hapla Note: 63102db98f8dSVaclav Hapla DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective. 63112db98f8dSVaclav Hapla 63122db98f8dSVaclav Hapla This creates a new vector, so the user SHOULD destroy this vector 63132db98f8dSVaclav Hapla 63142db98f8dSVaclav Hapla Each process has the local and ghost coordinates 63152db98f8dSVaclav Hapla 63162db98f8dSVaclav Hapla For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 63172db98f8dSVaclav Hapla and (x_0,y_0,z_0,x_1,y_1,z_1...) 63182db98f8dSVaclav Hapla 63192db98f8dSVaclav Hapla Level: advanced 63202db98f8dSVaclav Hapla 63212db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 63222db98f8dSVaclav Hapla @*/ 63232db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord) 63242db98f8dSVaclav Hapla { 63252db98f8dSVaclav Hapla PetscSection cs, newcs; 63262db98f8dSVaclav Hapla Vec coords; 63272db98f8dSVaclav Hapla const PetscScalar *arr; 63282db98f8dSVaclav Hapla PetscScalar *newarr=NULL; 63292db98f8dSVaclav Hapla PetscInt n; 63302db98f8dSVaclav Hapla PetscErrorCode ierr; 63312db98f8dSVaclav Hapla 63322db98f8dSVaclav Hapla PetscFunctionBegin; 63332db98f8dSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 63342db98f8dSVaclav Hapla PetscValidHeaderSpecific(p, IS_CLASSID, 2); 63352db98f8dSVaclav Hapla if (pCoordSection) PetscValidPointer(pCoordSection, 3); 63362db98f8dSVaclav Hapla if (pCoord) PetscValidPointer(pCoord, 4); 63372db98f8dSVaclav Hapla if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set"); 63381bb6d2a8SBarry Smith if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported"); 63391bb6d2a8SBarry Smith cs = dm->coordinateDM->localSection; 63402db98f8dSVaclav Hapla coords = dm->coordinatesLocal; 63412db98f8dSVaclav Hapla ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr); 63422db98f8dSVaclav Hapla ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr); 63432db98f8dSVaclav Hapla ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr); 63442db98f8dSVaclav Hapla if (pCoord) { 63452db98f8dSVaclav Hapla ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr); 63462db98f8dSVaclav Hapla /* set array in two steps to mimic PETSC_OWN_POINTER */ 63472db98f8dSVaclav Hapla ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr); 63482db98f8dSVaclav Hapla ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr); 6349ad9ac99dSVaclav Hapla } else { 6350ad9ac99dSVaclav Hapla ierr = PetscFree(newarr);CHKERRQ(ierr); 63512db98f8dSVaclav Hapla } 6352ad9ac99dSVaclav Hapla if (pCoordSection) {*pCoordSection = newcs;} 6353ad9ac99dSVaclav Hapla else {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);} 63542db98f8dSVaclav Hapla PetscFunctionReturn(0); 63552db98f8dSVaclav Hapla } 63562db98f8dSVaclav Hapla 6357f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field) 6358f19dbd58SToby Isaac { 6359f19dbd58SToby Isaac PetscErrorCode ierr; 6360f19dbd58SToby Isaac 6361f19dbd58SToby Isaac PetscFunctionBegin; 6362f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6363f19dbd58SToby Isaac PetscValidPointer(field,2); 6364f19dbd58SToby Isaac if (!dm->coordinateField) { 6365f19dbd58SToby Isaac if (dm->ops->createcoordinatefield) { 6366f19dbd58SToby Isaac ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr); 6367f19dbd58SToby Isaac } 6368f19dbd58SToby Isaac } 6369f19dbd58SToby Isaac *field = dm->coordinateField; 6370f19dbd58SToby Isaac PetscFunctionReturn(0); 6371f19dbd58SToby Isaac } 6372f19dbd58SToby Isaac 6373f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field) 6374f19dbd58SToby Isaac { 6375f19dbd58SToby Isaac PetscErrorCode ierr; 6376f19dbd58SToby Isaac 6377f19dbd58SToby Isaac PetscFunctionBegin; 6378f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6379f19dbd58SToby Isaac if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2); 6380c4e6da2cSBarry Smith ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr); 6381f19dbd58SToby Isaac ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr); 6382f19dbd58SToby Isaac dm->coordinateField = field; 6383f19dbd58SToby Isaac PetscFunctionReturn(0); 6384f19dbd58SToby Isaac } 6385f19dbd58SToby Isaac 63866636e97aSMatthew G Knepley /*@ 63871cfe2091SMatthew G. Knepley DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates 63886636e97aSMatthew G Knepley 6389d083f849SBarry Smith Collective on dm 63906636e97aSMatthew G Knepley 63916636e97aSMatthew G Knepley Input Parameter: 63926636e97aSMatthew G Knepley . dm - the DM 63936636e97aSMatthew G Knepley 63946636e97aSMatthew G Knepley Output Parameter: 63956636e97aSMatthew G Knepley . cdm - coordinate DM 63966636e97aSMatthew G Knepley 63976636e97aSMatthew G Knepley Level: intermediate 63986636e97aSMatthew G Knepley 63991cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 64006636e97aSMatthew G Knepley @*/ 64016636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm) 64026636e97aSMatthew G Knepley { 64036636e97aSMatthew G Knepley PetscErrorCode ierr; 64046636e97aSMatthew G Knepley 64056636e97aSMatthew G Knepley PetscFunctionBegin; 64066636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 64076636e97aSMatthew G Knepley PetscValidPointer(cdm,2); 64086636e97aSMatthew G Knepley if (!dm->coordinateDM) { 6409308f8a94SToby Isaac DM cdm; 6410308f8a94SToby Isaac 641182f516ccSBarry Smith if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM"); 6412308f8a94SToby Isaac ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr); 6413308f8a94SToby Isaac /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup 6414308f8a94SToby Isaac * until the call to CreateCoordinateDM) */ 6415308f8a94SToby Isaac ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 6416308f8a94SToby Isaac dm->coordinateDM = cdm; 64176636e97aSMatthew G Knepley } 64186636e97aSMatthew G Knepley *cdm = dm->coordinateDM; 64196636e97aSMatthew G Knepley PetscFunctionReturn(0); 64206636e97aSMatthew G Knepley } 6421e87bb0d3SMatthew G Knepley 64221cfe2091SMatthew G. Knepley /*@ 64231cfe2091SMatthew G. Knepley DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates 64241cfe2091SMatthew G. Knepley 6425d083f849SBarry Smith Logically Collective on dm 64261cfe2091SMatthew G. Knepley 64271cfe2091SMatthew G. Knepley Input Parameters: 64281cfe2091SMatthew G. Knepley + dm - the DM 64291cfe2091SMatthew G. Knepley - cdm - coordinate DM 64301cfe2091SMatthew G. Knepley 64311cfe2091SMatthew G. Knepley Level: intermediate 64321cfe2091SMatthew G. Knepley 64331cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 64341cfe2091SMatthew G. Knepley @*/ 64351cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm) 64361cfe2091SMatthew G. Knepley { 64371cfe2091SMatthew G. Knepley PetscErrorCode ierr; 64381cfe2091SMatthew G. Knepley 64391cfe2091SMatthew G. Knepley PetscFunctionBegin; 64401cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 64411cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(cdm,DM_CLASSID,2); 6442f26b38b9SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 64431cfe2091SMatthew G. Knepley ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 64441cfe2091SMatthew G. Knepley dm->coordinateDM = cdm; 64451cfe2091SMatthew G. Knepley PetscFunctionReturn(0); 64461cfe2091SMatthew G. Knepley } 64471cfe2091SMatthew G. Knepley 644846e270d4SMatthew G. Knepley /*@ 644946e270d4SMatthew G. Knepley DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values. 645046e270d4SMatthew G. Knepley 645146e270d4SMatthew G. Knepley Not Collective 645246e270d4SMatthew G. Knepley 645346e270d4SMatthew G. Knepley Input Parameter: 645446e270d4SMatthew G. Knepley . dm - The DM object 645546e270d4SMatthew G. Knepley 645646e270d4SMatthew G. Knepley Output Parameter: 645746e270d4SMatthew G. Knepley . dim - The embedding dimension 645846e270d4SMatthew G. Knepley 645946e270d4SMatthew G. Knepley Level: intermediate 646046e270d4SMatthew G. Knepley 646192fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 646246e270d4SMatthew G. Knepley @*/ 646346e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim) 646446e270d4SMatthew G. Knepley { 646546e270d4SMatthew G. Knepley PetscFunctionBegin; 646646e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6467534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 64689a9a41abSToby Isaac if (dm->dimEmbed == PETSC_DEFAULT) { 64699a9a41abSToby Isaac dm->dimEmbed = dm->dim; 64709a9a41abSToby Isaac } 647146e270d4SMatthew G. Knepley *dim = dm->dimEmbed; 647246e270d4SMatthew G. Knepley PetscFunctionReturn(0); 647346e270d4SMatthew G. Knepley } 647446e270d4SMatthew G. Knepley 647546e270d4SMatthew G. Knepley /*@ 647646e270d4SMatthew G. Knepley DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values. 647746e270d4SMatthew G. Knepley 647846e270d4SMatthew G. Knepley Not Collective 647946e270d4SMatthew G. Knepley 648046e270d4SMatthew G. Knepley Input Parameters: 648146e270d4SMatthew G. Knepley + dm - The DM object 648246e270d4SMatthew G. Knepley - dim - The embedding dimension 648346e270d4SMatthew G. Knepley 648446e270d4SMatthew G. Knepley Level: intermediate 648546e270d4SMatthew G. Knepley 648692fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 648746e270d4SMatthew G. Knepley @*/ 648846e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim) 648946e270d4SMatthew G. Knepley { 6490e5e52638SMatthew G. Knepley PetscDS ds; 649145480ffeSMatthew G. Knepley PetscInt Nds, n; 6492f17e8794SMatthew G. Knepley PetscErrorCode ierr; 6493f17e8794SMatthew G. Knepley 649446e270d4SMatthew G. Knepley PetscFunctionBegin; 649546e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 649646e270d4SMatthew G. Knepley dm->dimEmbed = dim; 649745480ffeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 649845480ffeSMatthew G. Knepley for (n = 0; n < Nds; ++n) { 649945480ffeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr); 6500e5e52638SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr); 650145480ffeSMatthew G. Knepley } 650246e270d4SMatthew G. Knepley PetscFunctionReturn(0); 650346e270d4SMatthew G. Knepley } 650446e270d4SMatthew G. Knepley 6505e8abe2deSMatthew G. Knepley /*@ 6506e8abe2deSMatthew G. Knepley DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh. 6507e8abe2deSMatthew G. Knepley 6508d083f849SBarry Smith Collective on dm 6509e8abe2deSMatthew G. Knepley 6510e8abe2deSMatthew G. Knepley Input Parameter: 6511e8abe2deSMatthew G. Knepley . dm - The DM object 6512e8abe2deSMatthew G. Knepley 6513e8abe2deSMatthew G. Knepley Output Parameter: 6514e8abe2deSMatthew G. Knepley . section - The PetscSection object 6515e8abe2deSMatthew G. Knepley 6516e8abe2deSMatthew G. Knepley Level: intermediate 6517e8abe2deSMatthew G. Knepley 651892fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 6519e8abe2deSMatthew G. Knepley @*/ 6520e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section) 6521e8abe2deSMatthew G. Knepley { 6522e8abe2deSMatthew G. Knepley DM cdm; 6523e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 6524e8abe2deSMatthew G. Knepley 6525e8abe2deSMatthew G. Knepley PetscFunctionBegin; 6526e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6527e8abe2deSMatthew G. Knepley PetscValidPointer(section, 2); 6528e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 652992fd8e1eSJed Brown ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr); 6530e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 6531e8abe2deSMatthew G. Knepley } 6532e8abe2deSMatthew G. Knepley 6533e8abe2deSMatthew G. Knepley /*@ 6534e8abe2deSMatthew G. Knepley DMSetCoordinateSection - Set the layout of coordinate values over the mesh. 6535e8abe2deSMatthew G. Knepley 6536e8abe2deSMatthew G. Knepley Not Collective 6537e8abe2deSMatthew G. Knepley 6538e8abe2deSMatthew G. Knepley Input Parameters: 6539e8abe2deSMatthew G. Knepley + dm - The DM object 654046e270d4SMatthew G. Knepley . dim - The embedding dimension, or PETSC_DETERMINE 6541e8abe2deSMatthew G. Knepley - section - The PetscSection object 6542e8abe2deSMatthew G. Knepley 6543e8abe2deSMatthew G. Knepley Level: intermediate 6544e8abe2deSMatthew G. Knepley 654592fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 6546e8abe2deSMatthew G. Knepley @*/ 654746e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section) 6548e8abe2deSMatthew G. Knepley { 6549e8abe2deSMatthew G. Knepley DM cdm; 6550e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 6551e8abe2deSMatthew G. Knepley 6552e8abe2deSMatthew G. Knepley PetscFunctionBegin; 6553e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 655446e270d4SMatthew G. Knepley PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3); 6555e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 655692fd8e1eSJed Brown ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr); 655746e270d4SMatthew G. Knepley if (dim == PETSC_DETERMINE) { 65584c1069a6SMatthew G. Knepley PetscInt d = PETSC_DEFAULT; 655946e270d4SMatthew G. Knepley PetscInt pStart, pEnd, vStart, vEnd, v, dd; 656046e270d4SMatthew G. Knepley 656146e270d4SMatthew G. Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 656246e270d4SMatthew G. Knepley ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr); 656346e270d4SMatthew G. Knepley pStart = PetscMax(vStart, pStart); 656446e270d4SMatthew G. Knepley pEnd = PetscMin(vEnd, pEnd); 656546e270d4SMatthew G. Knepley for (v = pStart; v < pEnd; ++v) { 656646e270d4SMatthew G. Knepley ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr); 656746e270d4SMatthew G. Knepley if (dd) {d = dd; break;} 656846e270d4SMatthew G. Knepley } 6569ebfe4b0dSMatthew G. Knepley if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);} 657046e270d4SMatthew G. Knepley } 6571e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 6572e8abe2deSMatthew G. Knepley } 6573e8abe2deSMatthew G. Knepley 6574d864a3eaSLisandro Dalcin /*@ 6575d864a3eaSLisandro Dalcin DMProjectCoordinates - Project coordinates to a different space 6576d864a3eaSLisandro Dalcin 6577d864a3eaSLisandro Dalcin Input Parameters: 6578d864a3eaSLisandro Dalcin + dm - The DM object 6579d864a3eaSLisandro Dalcin - disc - The new coordinate discretization 6580d864a3eaSLisandro Dalcin 6581d864a3eaSLisandro Dalcin Level: intermediate 6582d864a3eaSLisandro Dalcin 6583d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField() 6584d864a3eaSLisandro Dalcin @*/ 6585d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc) 6586d864a3eaSLisandro Dalcin { 6587d864a3eaSLisandro Dalcin PetscObject discOld; 6588d864a3eaSLisandro Dalcin PetscClassId classid; 6589d864a3eaSLisandro Dalcin DM cdmOld,cdmNew; 6590d864a3eaSLisandro Dalcin Vec coordsOld,coordsNew; 6591d864a3eaSLisandro Dalcin Mat matInterp; 6592d864a3eaSLisandro Dalcin PetscErrorCode ierr; 6593d864a3eaSLisandro Dalcin 6594d864a3eaSLisandro Dalcin PetscFunctionBegin; 6595d864a3eaSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6596d864a3eaSLisandro Dalcin PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2); 6597d864a3eaSLisandro Dalcin 6598d864a3eaSLisandro Dalcin ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr); 6599d864a3eaSLisandro Dalcin /* Check current discretization is compatible */ 6600d864a3eaSLisandro Dalcin ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr); 6601d864a3eaSLisandro Dalcin ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr); 660229ad44c5SMatthew G. Knepley if (classid != PETSCFE_CLASSID) { 660329ad44c5SMatthew G. Knepley if (classid == PETSC_CONTAINER_CLASSID) { 660429ad44c5SMatthew G. Knepley PetscFE feLinear; 660529ad44c5SMatthew G. Knepley DMPolytopeType ct; 660629ad44c5SMatthew G. Knepley PetscInt dim, dE, cStart; 660729ad44c5SMatthew G. Knepley PetscBool simplex; 660829ad44c5SMatthew G. Knepley 660929ad44c5SMatthew G. Knepley /* Assume linear vertex coordinates */ 661029ad44c5SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 661129ad44c5SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr); 661229ad44c5SMatthew G. Knepley ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr); 661329ad44c5SMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 661429ad44c5SMatthew G. Knepley switch (ct) { 661529ad44c5SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM: 661629ad44c5SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM_TENSOR: 661729ad44c5SMatthew G. Knepley SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms"); 661829ad44c5SMatthew G. Knepley default: break; 661929ad44c5SMatthew G. Knepley } 662029ad44c5SMatthew G. Knepley simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE; 662129ad44c5SMatthew G. Knepley ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr); 662229ad44c5SMatthew G. Knepley ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr); 662329ad44c5SMatthew G. Knepley ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr); 662429ad44c5SMatthew G. Knepley ierr = DMCreateDS(cdmOld);CHKERRQ(ierr); 662529ad44c5SMatthew G. Knepley } else { 662629ad44c5SMatthew G. Knepley const char *discname; 662729ad44c5SMatthew G. Knepley 662829ad44c5SMatthew G. Knepley ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr); 662929ad44c5SMatthew G. Knepley SETERRQ1(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname); 663029ad44c5SMatthew G. Knepley } 663129ad44c5SMatthew G. Knepley } 6632d864a3eaSLisandro Dalcin /* Make a fresh clone of the coordinate DM */ 6633d864a3eaSLisandro Dalcin ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr); 6634d864a3eaSLisandro Dalcin ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr); 6635d864a3eaSLisandro Dalcin ierr = DMCreateDS(cdmNew);CHKERRQ(ierr); 6636d864a3eaSLisandro Dalcin /* Project the coordinate vector from old to new space */ 6637d864a3eaSLisandro Dalcin ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr); 6638d864a3eaSLisandro Dalcin ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr); 6639d864a3eaSLisandro Dalcin ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr); 6640d864a3eaSLisandro Dalcin ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr); 6641d864a3eaSLisandro Dalcin ierr = MatDestroy(&matInterp);CHKERRQ(ierr); 6642d864a3eaSLisandro Dalcin /* Set new coordinate structures */ 6643d864a3eaSLisandro Dalcin ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr); 6644d864a3eaSLisandro Dalcin ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr); 6645d864a3eaSLisandro Dalcin ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr); 6646d864a3eaSLisandro Dalcin ierr = VecDestroy(&coordsNew);CHKERRQ(ierr); 6647d864a3eaSLisandro Dalcin ierr = DMDestroy(&cdmNew);CHKERRQ(ierr); 6648d864a3eaSLisandro Dalcin PetscFunctionReturn(0); 6649d864a3eaSLisandro Dalcin } 6650d864a3eaSLisandro Dalcin 66515dc8c3f7SMatthew G. Knepley /*@C 665290b157c4SStefano Zampini DMGetPeriodicity - Get the description of mesh periodicity 66535dc8c3f7SMatthew G. Knepley 66545dc8c3f7SMatthew G. Knepley Input Parameters: 665590b157c4SStefano Zampini . dm - The DM object 665690b157c4SStefano Zampini 665790b157c4SStefano Zampini Output Parameters: 665890b157c4SStefano Zampini + per - Whether the DM is periodic or not 66595dc8c3f7SMatthew 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 66605dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 66615dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 66625dc8c3f7SMatthew G. Knepley 66635dc8c3f7SMatthew G. Knepley Level: developer 66645dc8c3f7SMatthew G. Knepley 66655dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 66665dc8c3f7SMatthew G. Knepley @*/ 666790b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd) 6668c6b900c6SMatthew G. Knepley { 6669c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6670c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 667190b157c4SStefano Zampini if (per) *per = dm->periodic; 6672c6b900c6SMatthew G. Knepley if (L) *L = dm->L; 6673c6b900c6SMatthew G. Knepley if (maxCell) *maxCell = dm->maxCell; 66745dc8c3f7SMatthew G. Knepley if (bd) *bd = dm->bdtype; 6675c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6676c6b900c6SMatthew G. Knepley } 6677c6b900c6SMatthew G. Knepley 66785dc8c3f7SMatthew G. Knepley /*@C 66795dc8c3f7SMatthew G. Knepley DMSetPeriodicity - Set the description of mesh periodicity 66805dc8c3f7SMatthew G. Knepley 66815dc8c3f7SMatthew G. Knepley Input Parameters: 66825dc8c3f7SMatthew G. Knepley + dm - The DM object 6683db2bf62eSStefano Zampini . per - Whether the DM is periodic or not. 6684db2bf62eSStefano 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. 66855dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 66865dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 66875dc8c3f7SMatthew G. Knepley 6688db2bf62eSStefano 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. 6689db2bf62eSStefano Zampini 66905dc8c3f7SMatthew G. Knepley Level: developer 66915dc8c3f7SMatthew G. Knepley 66925dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 66935dc8c3f7SMatthew G. Knepley @*/ 669490b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[]) 6695c6b900c6SMatthew G. Knepley { 6696c6b900c6SMatthew G. Knepley PetscInt dim, d; 6697c6b900c6SMatthew G. Knepley PetscErrorCode ierr; 6698c6b900c6SMatthew G. Knepley 6699c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6700c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 670190b157c4SStefano Zampini PetscValidLogicalCollectiveBool(dm,per,2); 6702412e9a14SMatthew G. Knepley if (maxCell) {PetscValidRealPointer(maxCell,3);} 6703412e9a14SMatthew G. Knepley if (L) {PetscValidRealPointer(L,4);} 6704412e9a14SMatthew G. Knepley if (bd) {PetscValidPointer(bd,5);} 67055dc8c3f7SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 670690b157c4SStefano Zampini if (maxCell) { 6707412e9a14SMatthew G. Knepley if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);} 6708412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d]; 6709db2bf62eSStefano Zampini } else { /* remove maxCell information to disable automatic computation of localized vertices */ 6710db2bf62eSStefano Zampini ierr = PetscFree(dm->maxCell);CHKERRQ(ierr); 6711412e9a14SMatthew G. Knepley } 6712db2bf62eSStefano Zampini 6713412e9a14SMatthew G. Knepley if (L) { 6714412e9a14SMatthew G. Knepley if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);} 6715412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->L[d] = L[d]; 6716412e9a14SMatthew G. Knepley } 6717412e9a14SMatthew G. Knepley if (bd) { 6718412e9a14SMatthew G. Knepley if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);} 6719412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d]; 672090b157c4SStefano Zampini } 6721072d7d67SStefano Zampini dm->periodic = per; 6722c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6723c6b900c6SMatthew G. Knepley } 6724c6b900c6SMatthew G. Knepley 67252e17dfb7SMatthew G. Knepley /*@ 67262e17dfb7SMatthew 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. 67272e17dfb7SMatthew G. Knepley 67282e17dfb7SMatthew G. Knepley Input Parameters: 67292e17dfb7SMatthew G. Knepley + dm - The DM 673065da65dcSMatthew G. Knepley . in - The input coordinate point (dim numbers) 673165da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i 67322e17dfb7SMatthew G. Knepley 67332e17dfb7SMatthew G. Knepley Output Parameter: 67342e17dfb7SMatthew G. Knepley . out - The localized coordinate point 67352e17dfb7SMatthew G. Knepley 67362e17dfb7SMatthew G. Knepley Level: developer 67372e17dfb7SMatthew G. Knepley 67382e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 67392e17dfb7SMatthew G. Knepley @*/ 674065da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[]) 67412e17dfb7SMatthew G. Knepley { 67422e17dfb7SMatthew G. Knepley PetscInt dim, d; 67432e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 67442e17dfb7SMatthew G. Knepley 67452e17dfb7SMatthew G. Knepley PetscFunctionBegin; 67462e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr); 67472e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 67482e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 67492e17dfb7SMatthew G. Knepley } else { 675065da65dcSMatthew G. Knepley if (endpoint) { 675165da65dcSMatthew G. Knepley for (d = 0; d < dim; ++d) { 6752da3333bfSMatthew 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)) { 6753da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1); 675465da65dcSMatthew G. Knepley } else { 6755da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 675665da65dcSMatthew G. Knepley } 675765da65dcSMatthew G. Knepley } 675865da65dcSMatthew G. Knepley } else { 67592e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 67601118d4bcSLisandro Dalcin out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 67612e17dfb7SMatthew G. Knepley } 67622e17dfb7SMatthew G. Knepley } 676365da65dcSMatthew G. Knepley } 67642e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 67652e17dfb7SMatthew G. Knepley } 67662e17dfb7SMatthew G. Knepley 67672e17dfb7SMatthew G. Knepley /* 67682e17dfb7SMatthew 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. 67692e17dfb7SMatthew G. Knepley 67702e17dfb7SMatthew G. Knepley Input Parameters: 67712e17dfb7SMatthew G. Knepley + dm - The DM 67722e17dfb7SMatthew G. Knepley . dim - The spatial dimension 67732e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 67742e17dfb7SMatthew G. Knepley - in - The input coordinate point (dim numbers) 67752e17dfb7SMatthew G. Knepley 67762e17dfb7SMatthew G. Knepley Output Parameter: 67772e17dfb7SMatthew G. Knepley . out - The localized coordinate point 67782e17dfb7SMatthew G. Knepley 67792e17dfb7SMatthew G. Knepley Level: developer 67802e17dfb7SMatthew G. Knepley 67812e17dfb7SMatthew 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 67822e17dfb7SMatthew G. Knepley 67832e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 67842e17dfb7SMatthew G. Knepley */ 67852e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 67862e17dfb7SMatthew G. Knepley { 67872e17dfb7SMatthew G. Knepley PetscInt d; 67882e17dfb7SMatthew G. Knepley 67892e17dfb7SMatthew G. Knepley PetscFunctionBegin; 67902e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 67912e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 67922e17dfb7SMatthew G. Knepley } else { 67932e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6794908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) { 67952e17dfb7SMatthew G. Knepley out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 67962e17dfb7SMatthew G. Knepley } else { 67972e17dfb7SMatthew G. Knepley out[d] = in[d]; 67982e17dfb7SMatthew G. Knepley } 67992e17dfb7SMatthew G. Knepley } 68002e17dfb7SMatthew G. Knepley } 68012e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 68022e17dfb7SMatthew G. Knepley } 6803a5801f52SStefano Zampini 68042e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[]) 68052e17dfb7SMatthew G. Knepley { 68062e17dfb7SMatthew G. Knepley PetscInt d; 68072e17dfb7SMatthew G. Knepley 68082e17dfb7SMatthew G. Knepley PetscFunctionBegin; 68092e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 68102e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 68112e17dfb7SMatthew G. Knepley } else { 68122e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6813908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) { 68142e17dfb7SMatthew G. Knepley out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d]; 68152e17dfb7SMatthew G. Knepley } else { 68162e17dfb7SMatthew G. Knepley out[d] = in[d]; 68172e17dfb7SMatthew G. Knepley } 68182e17dfb7SMatthew G. Knepley } 68192e17dfb7SMatthew G. Knepley } 68202e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 68212e17dfb7SMatthew G. Knepley } 68222e17dfb7SMatthew G. Knepley 68232e17dfb7SMatthew G. Knepley /* 68242e17dfb7SMatthew 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. 68252e17dfb7SMatthew G. Knepley 68262e17dfb7SMatthew G. Knepley Input Parameters: 68272e17dfb7SMatthew G. Knepley + dm - The DM 68282e17dfb7SMatthew G. Knepley . dim - The spatial dimension 68292e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 68302e17dfb7SMatthew G. Knepley . in - The input coordinate delta (dim numbers) 68312e17dfb7SMatthew G. Knepley - out - The input coordinate point (dim numbers) 68322e17dfb7SMatthew G. Knepley 68332e17dfb7SMatthew G. Knepley Output Parameter: 68342e17dfb7SMatthew G. Knepley . out - The localized coordinate in + out 68352e17dfb7SMatthew G. Knepley 68362e17dfb7SMatthew G. Knepley Level: developer 68372e17dfb7SMatthew G. Knepley 68382e17dfb7SMatthew 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 68392e17dfb7SMatthew G. Knepley 68402e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate() 68412e17dfb7SMatthew G. Knepley */ 68422e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 68432e17dfb7SMatthew G. Knepley { 68442e17dfb7SMatthew G. Knepley PetscInt d; 68452e17dfb7SMatthew G. Knepley 68462e17dfb7SMatthew G. Knepley PetscFunctionBegin; 68472e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 68482e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] += in[d]; 68492e17dfb7SMatthew G. Knepley } else { 68502e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 6851412e9a14SMatthew G. Knepley const PetscReal maxC = dm->maxCell[d]; 6852412e9a14SMatthew G. Knepley 6853412e9a14SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) { 6854412e9a14SMatthew G. Knepley const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 6855412e9a14SMatthew G. Knepley 6856412e9a14SMatthew G. Knepley if (PetscAbsScalar(newCoord - anchor[d]) > maxC) 6857412e9a14SMatthew G. Knepley SETERRQ4(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%D-Coordinate %g more than %g away from anchor %g", d, (double) PetscRealPart(in[d]), (double) maxC, (double) PetscRealPart(anchor[d])); 6858412e9a14SMatthew G. Knepley out[d] += newCoord; 68592e17dfb7SMatthew G. Knepley } else { 68602e17dfb7SMatthew G. Knepley out[d] += in[d]; 68612e17dfb7SMatthew G. Knepley } 68622e17dfb7SMatthew G. Knepley } 68632e17dfb7SMatthew G. Knepley } 68642e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 68652e17dfb7SMatthew G. Knepley } 68662e17dfb7SMatthew G. Knepley 686736447a5eSToby Isaac /*@ 68688f700142SStefano Zampini DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process 68698f700142SStefano Zampini 68708f700142SStefano Zampini Not collective 687136447a5eSToby Isaac 687236447a5eSToby Isaac Input Parameter: 687336447a5eSToby Isaac . dm - The DM 687436447a5eSToby Isaac 687536447a5eSToby Isaac Output Parameter: 687636447a5eSToby Isaac areLocalized - True if localized 687736447a5eSToby Isaac 687836447a5eSToby Isaac Level: developer 687936447a5eSToby Isaac 68808f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity() 688136447a5eSToby Isaac @*/ 68828f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized) 688336447a5eSToby Isaac { 688436447a5eSToby Isaac DM cdm; 688536447a5eSToby Isaac PetscSection coordSection; 688646a3a80fSLisandro Dalcin PetscInt cStart, cEnd, sStart, sEnd, c, dof; 688746a3a80fSLisandro Dalcin PetscBool isPlex, alreadyLocalized; 688836447a5eSToby Isaac PetscErrorCode ierr; 688936447a5eSToby Isaac 689036447a5eSToby Isaac PetscFunctionBegin; 689136447a5eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6892534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 68938b09590cSToby Isaac *areLocalized = PETSC_FALSE; 689446a3a80fSLisandro Dalcin 689536447a5eSToby Isaac /* We need some generic way of refering to cells/vertices */ 689636447a5eSToby Isaac ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 689746a3a80fSLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr); 68989f7230bfSMatthew G. Knepley if (!isPlex) PetscFunctionReturn(0); 689946a3a80fSLisandro Dalcin 69009f7230bfSMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 690146a3a80fSLisandro Dalcin ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr); 690236447a5eSToby Isaac ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr); 690336447a5eSToby Isaac alreadyLocalized = PETSC_FALSE; 690446a3a80fSLisandro Dalcin for (c = cStart; c < cEnd; ++c) { 690546a3a80fSLisandro Dalcin if (c < sStart || c >= sEnd) continue; 690636447a5eSToby Isaac ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr); 690746a3a80fSLisandro Dalcin if (dof) { alreadyLocalized = PETSC_TRUE; break; } 690836447a5eSToby Isaac } 69098f700142SStefano Zampini *areLocalized = alreadyLocalized; 691036447a5eSToby Isaac PetscFunctionReturn(0); 691136447a5eSToby Isaac } 691236447a5eSToby Isaac 69138f700142SStefano Zampini /*@ 69148f700142SStefano Zampini DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells 69158f700142SStefano Zampini 69168f700142SStefano Zampini Collective on dm 69178f700142SStefano Zampini 69188f700142SStefano Zampini Input Parameter: 69198f700142SStefano Zampini . dm - The DM 69208f700142SStefano Zampini 69218f700142SStefano Zampini Output Parameter: 69228f700142SStefano Zampini areLocalized - True if localized 69238f700142SStefano Zampini 69248f700142SStefano Zampini Level: developer 69258f700142SStefano Zampini 69268f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal() 69278f700142SStefano Zampini @*/ 69288f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized) 69298f700142SStefano Zampini { 69308f700142SStefano Zampini PetscBool localized; 69318f700142SStefano Zampini PetscErrorCode ierr; 69328f700142SStefano Zampini 69338f700142SStefano Zampini PetscFunctionBegin; 69348f700142SStefano Zampini PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6935534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 69368f700142SStefano Zampini ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr); 6937820f2d46SBarry Smith ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 69388f700142SStefano Zampini PetscFunctionReturn(0); 69398f700142SStefano Zampini } 694036447a5eSToby Isaac 69412e17dfb7SMatthew G. Knepley /*@ 6942492b8470SStefano Zampini DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces 69432e17dfb7SMatthew G. Knepley 69448f700142SStefano Zampini Collective on dm 69458f700142SStefano Zampini 69462e17dfb7SMatthew G. Knepley Input Parameter: 69472e17dfb7SMatthew G. Knepley . dm - The DM 69482e17dfb7SMatthew G. Knepley 69492e17dfb7SMatthew G. Knepley Level: developer 69502e17dfb7SMatthew G. Knepley 69518f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate() 69522e17dfb7SMatthew G. Knepley @*/ 69532e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm) 69542e17dfb7SMatthew G. Knepley { 69552e17dfb7SMatthew G. Knepley DM cdm; 69562e17dfb7SMatthew G. Knepley PetscSection coordSection, cSection; 69572e17dfb7SMatthew G. Knepley Vec coordinates, cVec; 69583e922f36SToby Isaac PetscScalar *coords, *coords2, *anchor, *localized; 69593e922f36SToby Isaac PetscInt Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize; 6960e0ae35bbSToby Isaac PetscBool alreadyLocalized, alreadyLocalizedGlobal; 69613e922f36SToby Isaac PetscInt maxHeight = 0, h; 69623e922f36SToby Isaac PetscInt *pStart = NULL, *pEnd = NULL; 69632e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 69642e17dfb7SMatthew G. Knepley 69652e17dfb7SMatthew G. Knepley PetscFunctionBegin; 69662e17dfb7SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 696792c9c85fSStefano Zampini if (!dm->periodic) PetscFunctionReturn(0); 6968f7cbd40bSStefano Zampini ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr); 6969f7cbd40bSStefano Zampini if (alreadyLocalized) PetscFunctionReturn(0); 6970f7cbd40bSStefano Zampini 69712e17dfb7SMatthew G. Knepley /* We need some generic way of refering to cells/vertices */ 69722e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 69732e17dfb7SMatthew G. Knepley { 69742e17dfb7SMatthew G. Knepley PetscBool isplex; 69752e17dfb7SMatthew G. Knepley 69762e17dfb7SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr); 69772e17dfb7SMatthew G. Knepley if (isplex) { 69782e17dfb7SMatthew G. Knepley ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr); 69793e922f36SToby Isaac ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr); 698069291d52SBarry Smith ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 69813e922f36SToby Isaac pEnd = &pStart[maxHeight + 1]; 69823e922f36SToby Isaac newStart = vStart; 69833e922f36SToby Isaac newEnd = vEnd; 69843e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 69853e922f36SToby Isaac ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr); 69863e922f36SToby Isaac newStart = PetscMin(newStart,pStart[h]); 69873e922f36SToby Isaac newEnd = PetscMax(newEnd,pEnd[h]); 69883e922f36SToby Isaac } 69892e17dfb7SMatthew G. Knepley } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM"); 69902e17dfb7SMatthew G. Knepley } 69912e17dfb7SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr); 699243eeeb2dSStefano Zampini if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector"); 69932e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 69943e922f36SToby Isaac ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr); 6995e0ae35bbSToby Isaac ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr); 69963e922f36SToby Isaac 69972e17dfb7SMatthew G. Knepley ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr); 69982e17dfb7SMatthew G. Knepley ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr); 69992e17dfb7SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr); 70002e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr); 70013e922f36SToby Isaac ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr); 70023e922f36SToby Isaac 700369291d52SBarry Smith ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 70043e922f36SToby Isaac localized = &anchor[bs]; 70053e922f36SToby Isaac alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE; 70063e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 70073e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 70083e922f36SToby Isaac 70093e922f36SToby Isaac for (c = cStart; c < cEnd; ++c) { 70103e922f36SToby Isaac PetscScalar *cellCoords = NULL; 70113e922f36SToby Isaac PetscInt b; 70123e922f36SToby Isaac 70133e922f36SToby Isaac if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE; 70143e922f36SToby Isaac ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 70153e922f36SToby Isaac for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 70163e922f36SToby Isaac for (d = 0; d < dof/bs; ++d) { 70173e922f36SToby Isaac ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr); 70183e922f36SToby Isaac for (b = 0; b < bs; b++) { 70193e922f36SToby Isaac if (cellCoords[d*bs + b] != localized[b]) break; 70203e922f36SToby Isaac } 70213e922f36SToby Isaac if (b < bs) break; 70223e922f36SToby Isaac } 70233e922f36SToby Isaac if (d < dof/bs) { 70243e922f36SToby Isaac if (c >= sStart && c < sEnd) { 70253e922f36SToby Isaac PetscInt cdof; 70263e922f36SToby Isaac 70273e922f36SToby Isaac ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr); 70283e922f36SToby Isaac if (cdof != dof) alreadyLocalized = PETSC_FALSE; 70293e922f36SToby Isaac } 70303e922f36SToby Isaac ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr); 70313e922f36SToby Isaac ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr); 70323e922f36SToby Isaac } 70333e922f36SToby Isaac ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 70343e922f36SToby Isaac } 70353e922f36SToby Isaac } 7036ffc4695bSBarry Smith ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 70373e922f36SToby Isaac if (alreadyLocalizedGlobal) { 703869291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 70393e922f36SToby Isaac ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 704069291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 70413e922f36SToby Isaac PetscFunctionReturn(0); 70423e922f36SToby Isaac } 70432e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 70442e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 70452e17dfb7SMatthew G. Knepley ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr); 70462e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr); 70472e17dfb7SMatthew G. Knepley } 70482e17dfb7SMatthew G. Knepley ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr); 70492e17dfb7SMatthew G. Knepley ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr); 7050c2be7e5eSLisandro Dalcin ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr); 70512e17dfb7SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr); 70522e17dfb7SMatthew G. Knepley ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr); 70532e17dfb7SMatthew G. Knepley ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr); 70542e17dfb7SMatthew G. Knepley ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr); 7055c2be7e5eSLisandro Dalcin ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 70562e17dfb7SMatthew G. Knepley ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr); 70572e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 70582e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 70592e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr); 70602e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, v, &off2);CHKERRQ(ierr); 70612e17dfb7SMatthew G. Knepley for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d]; 70622e17dfb7SMatthew G. Knepley } 70633e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 70643e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 70653e922f36SToby Isaac 70662e17dfb7SMatthew G. Knepley for (c = cStart; c < cEnd; ++c) { 70672e17dfb7SMatthew G. Knepley PetscScalar *cellCoords = NULL; 70683e922f36SToby Isaac PetscInt b, cdof; 70692e17dfb7SMatthew G. Knepley 70703e922f36SToby Isaac ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr); 70713e922f36SToby Isaac if (!cdof) continue; 70722e17dfb7SMatthew G. Knepley ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 70732e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr); 70742e17dfb7SMatthew G. Knepley for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 70752e17dfb7SMatthew G. Knepley for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);} 70762e17dfb7SMatthew G. Knepley ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 70772e17dfb7SMatthew G. Knepley } 70783e922f36SToby Isaac } 707969291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 708069291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 7081c2be7e5eSLisandro Dalcin ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 70822e17dfb7SMatthew G. Knepley ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr); 70832e17dfb7SMatthew G. Knepley ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr); 70842e17dfb7SMatthew G. Knepley ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr); 70852e17dfb7SMatthew G. Knepley ierr = VecDestroy(&cVec);CHKERRQ(ierr); 70862e17dfb7SMatthew G. Knepley ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 70872e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 70882e17dfb7SMatthew G. Knepley } 70892e17dfb7SMatthew G. Knepley 7090e87bb0d3SMatthew G Knepley /*@ 70913a93e3b7SToby Isaac DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells 7092e87bb0d3SMatthew G Knepley 7093d083f849SBarry Smith Collective on v (see explanation below) 7094e87bb0d3SMatthew G Knepley 7095e87bb0d3SMatthew G Knepley Input Parameters: 7096e87bb0d3SMatthew G Knepley + dm - The DM 70973a93e3b7SToby Isaac . v - The Vec of points 709862a38674SMatthew G. Knepley . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST 70993a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point. 7100e87bb0d3SMatthew G Knepley 710161e3bb9bSMatthew G Knepley Output Parameter: 710262a38674SMatthew G. Knepley + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used 710362a38674SMatthew G. Knepley - cells - The PetscSF containing the ranks and local indices of the containing points. 71043a93e3b7SToby Isaac 7105e87bb0d3SMatthew G Knepley 7106e87bb0d3SMatthew G Knepley Level: developer 710761e3bb9bSMatthew G Knepley 710862a38674SMatthew G. Knepley Notes: 71093a93e3b7SToby Isaac To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator. 711062a38674SMatthew G. Knepley To do a search of all the cells in the distributed mesh, v should have the same communicator as dm. 71113a93e3b7SToby Isaac 71123a93e3b7SToby Isaac If *cellSF is NULL on input, a PetscSF will be created. 711362a38674SMatthew G. Knepley If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses. 71143a93e3b7SToby Isaac 71153a93e3b7SToby Isaac An array that maps each point to its containing cell can be obtained with 71163a93e3b7SToby Isaac 711762a38674SMatthew G. Knepley $ const PetscSFNode *cells; 711862a38674SMatthew G. Knepley $ PetscInt nFound; 7119a6216909SToby Isaac $ const PetscInt *found; 712062a38674SMatthew G. Knepley $ 7121a6216909SToby Isaac $ PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells); 71223a93e3b7SToby Isaac 71233a93e3b7SToby 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 71243a93e3b7SToby Isaac the index of the cell in its rank's local numbering. 71253a93e3b7SToby Isaac 712662a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType 712761e3bb9bSMatthew G Knepley @*/ 712862a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF) 7129e87bb0d3SMatthew G Knepley { 7130735aa83eSMatthew G Knepley PetscErrorCode ierr; 7131735aa83eSMatthew G Knepley 7132e87bb0d3SMatthew G Knepley PetscFunctionBegin; 7133e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7134e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,2); 7135e0fc9d1bSMatthew G. Knepley PetscValidPointer(cellSF,4); 71363a93e3b7SToby Isaac if (*cellSF) { 71373a93e3b7SToby Isaac PetscMPIInt result; 71383a93e3b7SToby Isaac 7139e0fc9d1bSMatthew G. Knepley PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4); 7140ffc4695bSBarry Smith ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr); 71413a93e3b7SToby Isaac if (result != MPI_IDENT && result != MPI_CONGRUENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's"); 7142e0fc9d1bSMatthew G. Knepley } else { 71433a93e3b7SToby Isaac ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr); 71443a93e3b7SToby Isaac } 7145b9d85ea2SLisandro Dalcin if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM"); 714647a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 714762a38674SMatthew G. Knepley ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr); 714847a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 7149e87bb0d3SMatthew G Knepley PetscFunctionReturn(0); 7150e87bb0d3SMatthew G Knepley } 715114f150ffSMatthew G. Knepley 7152f4d763aaSMatthew G. Knepley /*@ 7153f4d763aaSMatthew G. Knepley DMGetOutputDM - Retrieve the DM associated with the layout for output 7154f4d763aaSMatthew G. Knepley 71558f700142SStefano Zampini Collective on dm 71568f700142SStefano Zampini 7157f4d763aaSMatthew G. Knepley Input Parameter: 7158f4d763aaSMatthew G. Knepley . dm - The original DM 7159f4d763aaSMatthew G. Knepley 7160f4d763aaSMatthew G. Knepley Output Parameter: 7161f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output 7162f4d763aaSMatthew G. Knepley 7163f4d763aaSMatthew G. Knepley Level: intermediate 7164f4d763aaSMatthew G. Knepley 7165e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection() 7166f4d763aaSMatthew G. Knepley @*/ 716714f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm) 716814f150ffSMatthew G. Knepley { 7169c26acbdeSMatthew G. Knepley PetscSection section; 71702d4e4a49SMatthew G. Knepley PetscBool hasConstraints, ghasConstraints; 717114f150ffSMatthew G. Knepley PetscErrorCode ierr; 717214f150ffSMatthew G. Knepley 717314f150ffSMatthew G. Knepley PetscFunctionBegin; 717414f150ffSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 717514f150ffSMatthew G. Knepley PetscValidPointer(odm,2); 717692fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 7177c26acbdeSMatthew G. Knepley ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr); 7178ffc4695bSBarry Smith ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr); 71792d4e4a49SMatthew G. Knepley if (!ghasConstraints) { 7180c26acbdeSMatthew G. Knepley *odm = dm; 7181c26acbdeSMatthew G. Knepley PetscFunctionReturn(0); 7182c26acbdeSMatthew G. Knepley } 718314f150ffSMatthew G. Knepley if (!dm->dmBC) { 7184c26acbdeSMatthew G. Knepley PetscSection newSection, gsection; 718514f150ffSMatthew G. Knepley PetscSF sf; 718614f150ffSMatthew G. Knepley 718714f150ffSMatthew G. Knepley ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr); 7188e5e52638SMatthew G. Knepley ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr); 718914f150ffSMatthew G. Knepley ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr); 719092fd8e1eSJed Brown ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr); 719114f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr); 719214f150ffSMatthew G. Knepley ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr); 719315b58121SMatthew G. Knepley ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr); 7194e87a4003SBarry Smith ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr); 719514f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr); 719614f150ffSMatthew G. Knepley } 719714f150ffSMatthew G. Knepley *odm = dm->dmBC; 719814f150ffSMatthew G. Knepley PetscFunctionReturn(0); 719914f150ffSMatthew G. Knepley } 7200f4d763aaSMatthew G. Knepley 7201f4d763aaSMatthew G. Knepley /*@ 7202cdb7a50dSMatthew G. Knepley DMGetOutputSequenceNumber - Retrieve the sequence number/value for output 7203f4d763aaSMatthew G. Knepley 7204f4d763aaSMatthew G. Knepley Input Parameter: 7205f4d763aaSMatthew G. Knepley . dm - The original DM 7206f4d763aaSMatthew G. Knepley 7207cdb7a50dSMatthew G. Knepley Output Parameters: 7208cdb7a50dSMatthew G. Knepley + num - The output sequence number 7209cdb7a50dSMatthew G. Knepley - val - The output sequence value 7210f4d763aaSMatthew G. Knepley 7211f4d763aaSMatthew G. Knepley Level: intermediate 7212f4d763aaSMatthew G. Knepley 7213f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7214f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7215f4d763aaSMatthew G. Knepley 7216f4d763aaSMatthew G. Knepley .seealso: VecView() 7217f4d763aaSMatthew G. Knepley @*/ 7218cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val) 7219f4d763aaSMatthew G. Knepley { 7220f4d763aaSMatthew G. Knepley PetscFunctionBegin; 7221f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7222534a8f05SLisandro Dalcin if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;} 7223534a8f05SLisandro Dalcin if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;} 7224f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 7225f4d763aaSMatthew G. Knepley } 7226f4d763aaSMatthew G. Knepley 7227f4d763aaSMatthew G. Knepley /*@ 7228cdb7a50dSMatthew G. Knepley DMSetOutputSequenceNumber - Set the sequence number/value for output 7229f4d763aaSMatthew G. Knepley 7230f4d763aaSMatthew G. Knepley Input Parameters: 7231f4d763aaSMatthew G. Knepley + dm - The original DM 7232cdb7a50dSMatthew G. Knepley . num - The output sequence number 7233cdb7a50dSMatthew G. Knepley - val - The output sequence value 7234f4d763aaSMatthew G. Knepley 7235f4d763aaSMatthew G. Knepley Level: intermediate 7236f4d763aaSMatthew G. Knepley 7237f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7238f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7239f4d763aaSMatthew G. Knepley 7240f4d763aaSMatthew G. Knepley .seealso: VecView() 7241f4d763aaSMatthew G. Knepley @*/ 7242cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val) 7243f4d763aaSMatthew G. Knepley { 7244f4d763aaSMatthew G. Knepley PetscFunctionBegin; 7245f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7246f4d763aaSMatthew G. Knepley dm->outputSequenceNum = num; 7247cdb7a50dSMatthew G. Knepley dm->outputSequenceVal = val; 7248cdb7a50dSMatthew G. Knepley PetscFunctionReturn(0); 7249cdb7a50dSMatthew G. Knepley } 7250cdb7a50dSMatthew G. Knepley 7251cdb7a50dSMatthew G. Knepley /*@C 7252cdb7a50dSMatthew G. Knepley DMOutputSequenceLoad - Retrieve the sequence value from a Viewer 7253cdb7a50dSMatthew G. Knepley 7254cdb7a50dSMatthew G. Knepley Input Parameters: 7255cdb7a50dSMatthew G. Knepley + dm - The original DM 7256cdb7a50dSMatthew G. Knepley . name - The sequence name 7257cdb7a50dSMatthew G. Knepley - num - The output sequence number 7258cdb7a50dSMatthew G. Knepley 7259cdb7a50dSMatthew G. Knepley Output Parameter: 7260cdb7a50dSMatthew G. Knepley . val - The output sequence value 7261cdb7a50dSMatthew G. Knepley 7262cdb7a50dSMatthew G. Knepley Level: intermediate 7263cdb7a50dSMatthew G. Knepley 7264cdb7a50dSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7265cdb7a50dSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7266cdb7a50dSMatthew G. Knepley 7267cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView() 7268cdb7a50dSMatthew G. Knepley @*/ 7269cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val) 7270cdb7a50dSMatthew G. Knepley { 7271cdb7a50dSMatthew G. Knepley PetscBool ishdf5; 7272cdb7a50dSMatthew G. Knepley PetscErrorCode ierr; 7273cdb7a50dSMatthew G. Knepley 7274cdb7a50dSMatthew G. Knepley PetscFunctionBegin; 7275cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7276cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 7277064a246eSJacob Faibussowitsch PetscValidRealPointer(val,5); 7278cdb7a50dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr); 7279cdb7a50dSMatthew G. Knepley if (ishdf5) { 7280cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5) 7281cdb7a50dSMatthew G. Knepley PetscScalar value; 7282cdb7a50dSMatthew G. Knepley 728339d25373SMatthew G. Knepley ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr); 72844aeb217fSMatthew G. Knepley *val = PetscRealPart(value); 7285cdb7a50dSMatthew G. Knepley #endif 7286cdb7a50dSMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()"); 7287f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 7288f4d763aaSMatthew G. Knepley } 72898e4ac7eaSMatthew G. Knepley 72908e4ac7eaSMatthew G. Knepley /*@ 72918e4ac7eaSMatthew G. Knepley DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution 72928e4ac7eaSMatthew G. Knepley 72938e4ac7eaSMatthew G. Knepley Not collective 72948e4ac7eaSMatthew G. Knepley 72958e4ac7eaSMatthew G. Knepley Input Parameter: 72968e4ac7eaSMatthew G. Knepley . dm - The DM 72978e4ac7eaSMatthew G. Knepley 72988e4ac7eaSMatthew G. Knepley Output Parameter: 72998e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution 73008e4ac7eaSMatthew G. Knepley 73018e4ac7eaSMatthew G. Knepley Level: beginner 73028e4ac7eaSMatthew G. Knepley 73038e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate() 73048e4ac7eaSMatthew G. Knepley @*/ 73058e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural) 73068e4ac7eaSMatthew G. Knepley { 73078e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 73088e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7309534a8f05SLisandro Dalcin PetscValidBoolPointer(useNatural, 2); 73108e4ac7eaSMatthew G. Knepley *useNatural = dm->useNatural; 73118e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 73128e4ac7eaSMatthew G. Knepley } 73138e4ac7eaSMatthew G. Knepley 73148e4ac7eaSMatthew G. Knepley /*@ 73155d3b26e6SMatthew G. Knepley DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution 73168e4ac7eaSMatthew G. Knepley 73178e4ac7eaSMatthew G. Knepley Collective on dm 73188e4ac7eaSMatthew G. Knepley 73198e4ac7eaSMatthew G. Knepley Input Parameters: 73208e4ac7eaSMatthew G. Knepley + dm - The DM 73218e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution 73228e4ac7eaSMatthew G. Knepley 73235d3b26e6SMatthew G. Knepley Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM() 73245d3b26e6SMatthew G. Knepley 73258e4ac7eaSMatthew G. Knepley Level: beginner 73268e4ac7eaSMatthew G. Knepley 73275d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM() 73288e4ac7eaSMatthew G. Knepley @*/ 73298e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural) 73308e4ac7eaSMatthew G. Knepley { 73318e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 73328e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 73338833efb5SBlaise Bourdin PetscValidLogicalCollectiveBool(dm, useNatural, 2); 73348e4ac7eaSMatthew G. Knepley dm->useNatural = useNatural; 73358e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 73368e4ac7eaSMatthew G. Knepley } 7337c58f1c22SToby Isaac 7338c58f1c22SToby Isaac 7339c58f1c22SToby Isaac /*@C 7340c58f1c22SToby Isaac DMCreateLabel - Create a label of the given name if it does not already exist 7341c58f1c22SToby Isaac 7342c58f1c22SToby Isaac Not Collective 7343c58f1c22SToby Isaac 7344c58f1c22SToby Isaac Input Parameters: 7345c58f1c22SToby Isaac + dm - The DM object 7346c58f1c22SToby Isaac - name - The label name 7347c58f1c22SToby Isaac 7348c58f1c22SToby Isaac Level: intermediate 7349c58f1c22SToby Isaac 7350c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7351c58f1c22SToby Isaac @*/ 7352c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[]) 7353c58f1c22SToby Isaac { 73545d80c0bfSVaclav Hapla PetscBool flg; 73555d80c0bfSVaclav Hapla DMLabel label; 7356c58f1c22SToby Isaac PetscErrorCode ierr; 7357c58f1c22SToby Isaac 7358c58f1c22SToby Isaac PetscFunctionBegin; 7359c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7360c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 73615d80c0bfSVaclav Hapla ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 7362c58f1c22SToby Isaac if (!flg) { 73635d80c0bfSVaclav Hapla ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 73645d80c0bfSVaclav Hapla ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 73655d80c0bfSVaclav Hapla ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 7366c58f1c22SToby Isaac } 7367c58f1c22SToby Isaac PetscFunctionReturn(0); 7368c58f1c22SToby Isaac } 7369c58f1c22SToby Isaac 7370c58f1c22SToby Isaac /*@C 73710fdc7489SMatthew Knepley DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index. 73720fdc7489SMatthew Knepley 73730fdc7489SMatthew Knepley Not Collective 73740fdc7489SMatthew Knepley 73750fdc7489SMatthew Knepley Input Parameters: 73760fdc7489SMatthew Knepley + dm - The DM object 73770fdc7489SMatthew Knepley . l - The index for the label 73780fdc7489SMatthew Knepley - name - The label name 73790fdc7489SMatthew Knepley 73800fdc7489SMatthew Knepley Level: intermediate 73810fdc7489SMatthew Knepley 73820fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 73830fdc7489SMatthew Knepley @*/ 73840fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[]) 73850fdc7489SMatthew Knepley { 73860fdc7489SMatthew Knepley DMLabelLink orig, prev = NULL; 73870fdc7489SMatthew Knepley DMLabel label; 73880fdc7489SMatthew Knepley PetscInt Nl, m; 73890fdc7489SMatthew Knepley PetscBool flg, match; 73900fdc7489SMatthew Knepley const char *lname; 73910fdc7489SMatthew Knepley PetscErrorCode ierr; 73920fdc7489SMatthew Knepley 73930fdc7489SMatthew Knepley PetscFunctionBegin; 73940fdc7489SMatthew Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7395064a246eSJacob Faibussowitsch PetscValidCharPointer(name, 3); 73960fdc7489SMatthew Knepley ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 73970fdc7489SMatthew Knepley if (!flg) { 73980fdc7489SMatthew Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 73990fdc7489SMatthew Knepley ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 74000fdc7489SMatthew Knepley ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 74010fdc7489SMatthew Knepley } 74020fdc7489SMatthew Knepley ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr); 74030fdc7489SMatthew Knepley if (l >= Nl) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl); 74040fdc7489SMatthew Knepley for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) { 74050fdc7489SMatthew Knepley ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr); 74060fdc7489SMatthew Knepley ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr); 74070fdc7489SMatthew Knepley if (match) break; 74080fdc7489SMatthew Knepley } 74090fdc7489SMatthew Knepley if (m == l) PetscFunctionReturn(0); 74100fdc7489SMatthew Knepley if (!m) dm->labels = orig->next; 74110fdc7489SMatthew Knepley else prev->next = orig->next; 74120fdc7489SMatthew Knepley if (!l) { 74130fdc7489SMatthew Knepley orig->next = dm->labels; 74140fdc7489SMatthew Knepley dm->labels = orig; 74150fdc7489SMatthew Knepley } else { 74160fdc7489SMatthew Knepley for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next); 74170fdc7489SMatthew Knepley orig->next = prev->next; 74180fdc7489SMatthew Knepley prev->next = orig; 74190fdc7489SMatthew Knepley } 74200fdc7489SMatthew Knepley PetscFunctionReturn(0); 74210fdc7489SMatthew Knepley } 74220fdc7489SMatthew Knepley 74230fdc7489SMatthew Knepley /*@C 7424c58f1c22SToby Isaac DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default 7425c58f1c22SToby Isaac 7426c58f1c22SToby Isaac Not Collective 7427c58f1c22SToby Isaac 7428c58f1c22SToby Isaac Input Parameters: 7429c58f1c22SToby Isaac + dm - The DM object 7430c58f1c22SToby Isaac . name - The label name 7431c58f1c22SToby Isaac - point - The mesh point 7432c58f1c22SToby Isaac 7433c58f1c22SToby Isaac Output Parameter: 7434c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label 7435c58f1c22SToby Isaac 7436c58f1c22SToby Isaac Level: beginner 7437c58f1c22SToby Isaac 7438c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS() 7439c58f1c22SToby Isaac @*/ 7440c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value) 7441c58f1c22SToby Isaac { 7442c58f1c22SToby Isaac DMLabel label; 7443c58f1c22SToby Isaac PetscErrorCode ierr; 7444c58f1c22SToby Isaac 7445c58f1c22SToby Isaac PetscFunctionBegin; 7446c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7447c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7448c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 744913903a91SSatish Balay if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name); 7450c58f1c22SToby Isaac ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr); 7451c58f1c22SToby Isaac PetscFunctionReturn(0); 7452c58f1c22SToby Isaac } 7453c58f1c22SToby Isaac 7454c58f1c22SToby Isaac /*@C 7455c58f1c22SToby Isaac DMSetLabelValue - Add a point to a Sieve Label with given value 7456c58f1c22SToby Isaac 7457c58f1c22SToby Isaac Not Collective 7458c58f1c22SToby Isaac 7459c58f1c22SToby Isaac Input Parameters: 7460c58f1c22SToby Isaac + dm - The DM object 7461c58f1c22SToby Isaac . name - The label name 7462c58f1c22SToby Isaac . point - The mesh point 7463c58f1c22SToby Isaac - value - The label value for this point 7464c58f1c22SToby Isaac 7465c58f1c22SToby Isaac Output Parameter: 7466c58f1c22SToby Isaac 7467c58f1c22SToby Isaac Level: beginner 7468c58f1c22SToby Isaac 7469c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue() 7470c58f1c22SToby Isaac @*/ 7471c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 7472c58f1c22SToby Isaac { 7473c58f1c22SToby Isaac DMLabel label; 7474c58f1c22SToby Isaac PetscErrorCode ierr; 7475c58f1c22SToby Isaac 7476c58f1c22SToby Isaac PetscFunctionBegin; 7477c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7478c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7479c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7480c58f1c22SToby Isaac if (!label) { 7481c58f1c22SToby Isaac ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 7482c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7483c58f1c22SToby Isaac } 7484c58f1c22SToby Isaac ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr); 7485c58f1c22SToby Isaac PetscFunctionReturn(0); 7486c58f1c22SToby Isaac } 7487c58f1c22SToby Isaac 7488c58f1c22SToby Isaac /*@C 7489c58f1c22SToby Isaac DMClearLabelValue - Remove a point from a Sieve Label with given value 7490c58f1c22SToby Isaac 7491c58f1c22SToby Isaac Not Collective 7492c58f1c22SToby Isaac 7493c58f1c22SToby Isaac Input Parameters: 7494c58f1c22SToby Isaac + dm - The DM object 7495c58f1c22SToby Isaac . name - The label name 7496c58f1c22SToby Isaac . point - The mesh point 7497c58f1c22SToby Isaac - value - The label value for this point 7498c58f1c22SToby Isaac 7499c58f1c22SToby Isaac Output Parameter: 7500c58f1c22SToby Isaac 7501c58f1c22SToby Isaac Level: beginner 7502c58f1c22SToby Isaac 7503c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS() 7504c58f1c22SToby Isaac @*/ 7505c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 7506c58f1c22SToby Isaac { 7507c58f1c22SToby Isaac DMLabel label; 7508c58f1c22SToby Isaac PetscErrorCode ierr; 7509c58f1c22SToby Isaac 7510c58f1c22SToby Isaac PetscFunctionBegin; 7511c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7512c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7513c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7514c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7515c58f1c22SToby Isaac ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr); 7516c58f1c22SToby Isaac PetscFunctionReturn(0); 7517c58f1c22SToby Isaac } 7518c58f1c22SToby Isaac 7519c58f1c22SToby Isaac /*@C 7520c58f1c22SToby Isaac DMGetLabelSize - Get the number of different integer ids in a Label 7521c58f1c22SToby Isaac 7522c58f1c22SToby Isaac Not Collective 7523c58f1c22SToby Isaac 7524c58f1c22SToby Isaac Input Parameters: 7525c58f1c22SToby Isaac + dm - The DM object 7526c58f1c22SToby Isaac - name - The label name 7527c58f1c22SToby Isaac 7528c58f1c22SToby Isaac Output Parameter: 7529c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist 7530c58f1c22SToby Isaac 7531c58f1c22SToby Isaac Level: beginner 7532c58f1c22SToby Isaac 7533df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue() 7534c58f1c22SToby Isaac @*/ 7535c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size) 7536c58f1c22SToby Isaac { 7537c58f1c22SToby Isaac DMLabel label; 7538c58f1c22SToby Isaac PetscErrorCode ierr; 7539c58f1c22SToby Isaac 7540c58f1c22SToby Isaac PetscFunctionBegin; 7541c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7542c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7543534a8f05SLisandro Dalcin PetscValidIntPointer(size, 3); 7544c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7545c58f1c22SToby Isaac *size = 0; 7546c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7547c58f1c22SToby Isaac ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr); 7548c58f1c22SToby Isaac PetscFunctionReturn(0); 7549c58f1c22SToby Isaac } 7550c58f1c22SToby Isaac 7551c58f1c22SToby Isaac /*@C 7552c58f1c22SToby Isaac DMGetLabelIdIS - Get the integer ids in a label 7553c58f1c22SToby Isaac 7554c58f1c22SToby Isaac Not Collective 7555c58f1c22SToby Isaac 7556c58f1c22SToby Isaac Input Parameters: 7557c58f1c22SToby Isaac + mesh - The DM object 7558c58f1c22SToby Isaac - name - The label name 7559c58f1c22SToby Isaac 7560c58f1c22SToby Isaac Output Parameter: 7561c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist 7562c58f1c22SToby Isaac 7563c58f1c22SToby Isaac Level: beginner 7564c58f1c22SToby Isaac 7565c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize() 7566c58f1c22SToby Isaac @*/ 7567c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids) 7568c58f1c22SToby Isaac { 7569c58f1c22SToby Isaac DMLabel label; 7570c58f1c22SToby Isaac PetscErrorCode ierr; 7571c58f1c22SToby Isaac 7572c58f1c22SToby Isaac PetscFunctionBegin; 7573c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7574c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7575c58f1c22SToby Isaac PetscValidPointer(ids, 3); 7576c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7577c58f1c22SToby Isaac *ids = NULL; 7578dab2e251SBlaise Bourdin if (label) { 7579c58f1c22SToby Isaac ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr); 7580dab2e251SBlaise Bourdin } else { 7581dab2e251SBlaise Bourdin /* returning an empty IS */ 7582dab2e251SBlaise Bourdin ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr); 7583dab2e251SBlaise Bourdin } 7584c58f1c22SToby Isaac PetscFunctionReturn(0); 7585c58f1c22SToby Isaac } 7586c58f1c22SToby Isaac 7587c58f1c22SToby Isaac /*@C 7588c58f1c22SToby Isaac DMGetStratumSize - Get the number of points in a label stratum 7589c58f1c22SToby Isaac 7590c58f1c22SToby Isaac Not Collective 7591c58f1c22SToby Isaac 7592c58f1c22SToby Isaac Input Parameters: 7593c58f1c22SToby Isaac + dm - The DM object 7594c58f1c22SToby Isaac . name - The label name 7595c58f1c22SToby Isaac - value - The stratum value 7596c58f1c22SToby Isaac 7597c58f1c22SToby Isaac Output Parameter: 7598c58f1c22SToby Isaac . size - The stratum size 7599c58f1c22SToby Isaac 7600c58f1c22SToby Isaac Level: beginner 7601c58f1c22SToby Isaac 7602c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds() 7603c58f1c22SToby Isaac @*/ 7604c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size) 7605c58f1c22SToby Isaac { 7606c58f1c22SToby Isaac DMLabel label; 7607c58f1c22SToby Isaac PetscErrorCode ierr; 7608c58f1c22SToby Isaac 7609c58f1c22SToby Isaac PetscFunctionBegin; 7610c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7611c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7612534a8f05SLisandro Dalcin PetscValidIntPointer(size, 4); 7613c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7614c58f1c22SToby Isaac *size = 0; 7615c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7616c58f1c22SToby Isaac ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr); 7617c58f1c22SToby Isaac PetscFunctionReturn(0); 7618c58f1c22SToby Isaac } 7619c58f1c22SToby Isaac 7620c58f1c22SToby Isaac /*@C 7621c58f1c22SToby Isaac DMGetStratumIS - Get the points in a label stratum 7622c58f1c22SToby Isaac 7623c58f1c22SToby Isaac Not Collective 7624c58f1c22SToby Isaac 7625c58f1c22SToby Isaac Input Parameters: 7626c58f1c22SToby Isaac + dm - The DM object 7627c58f1c22SToby Isaac . name - The label name 7628c58f1c22SToby Isaac - value - The stratum value 7629c58f1c22SToby Isaac 7630c58f1c22SToby Isaac Output Parameter: 7631c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value 7632c58f1c22SToby Isaac 7633c58f1c22SToby Isaac Level: beginner 7634c58f1c22SToby Isaac 7635c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize() 7636c58f1c22SToby Isaac @*/ 7637c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points) 7638c58f1c22SToby Isaac { 7639c58f1c22SToby Isaac DMLabel label; 7640c58f1c22SToby Isaac PetscErrorCode ierr; 7641c58f1c22SToby Isaac 7642c58f1c22SToby Isaac PetscFunctionBegin; 7643c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7644c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7645c58f1c22SToby Isaac PetscValidPointer(points, 4); 7646c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7647c58f1c22SToby Isaac *points = NULL; 7648c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7649c58f1c22SToby Isaac ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr); 7650c58f1c22SToby Isaac PetscFunctionReturn(0); 7651c58f1c22SToby Isaac } 7652c58f1c22SToby Isaac 76534de306b1SToby Isaac /*@C 76549044fa66SMatthew G. Knepley DMSetStratumIS - Set the points in a label stratum 76554de306b1SToby Isaac 76564de306b1SToby Isaac Not Collective 76574de306b1SToby Isaac 76584de306b1SToby Isaac Input Parameters: 76594de306b1SToby Isaac + dm - The DM object 76604de306b1SToby Isaac . name - The label name 76614de306b1SToby Isaac . value - The stratum value 76624de306b1SToby Isaac - points - The stratum points 76634de306b1SToby Isaac 76644de306b1SToby Isaac Level: beginner 76654de306b1SToby Isaac 76664de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize() 76674de306b1SToby Isaac @*/ 76684de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points) 76694de306b1SToby Isaac { 76704de306b1SToby Isaac DMLabel label; 76714de306b1SToby Isaac PetscErrorCode ierr; 76724de306b1SToby Isaac 76734de306b1SToby Isaac PetscFunctionBegin; 76744de306b1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 76754de306b1SToby Isaac PetscValidCharPointer(name, 2); 76764de306b1SToby Isaac PetscValidPointer(points, 4); 76774de306b1SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 76784de306b1SToby Isaac if (!label) PetscFunctionReturn(0); 76794de306b1SToby Isaac ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr); 76804de306b1SToby Isaac PetscFunctionReturn(0); 76814de306b1SToby Isaac } 76824de306b1SToby Isaac 7683c58f1c22SToby Isaac /*@C 7684c58f1c22SToby Isaac DMClearLabelStratum - Remove all points from a stratum from a Sieve Label 7685c58f1c22SToby Isaac 7686c58f1c22SToby Isaac Not Collective 7687c58f1c22SToby Isaac 7688c58f1c22SToby Isaac Input Parameters: 7689c58f1c22SToby Isaac + dm - The DM object 7690c58f1c22SToby Isaac . name - The label name 7691c58f1c22SToby Isaac - value - The label value for this point 7692c58f1c22SToby Isaac 7693c58f1c22SToby Isaac Output Parameter: 7694c58f1c22SToby Isaac 7695c58f1c22SToby Isaac Level: beginner 7696c58f1c22SToby Isaac 7697c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue() 7698c58f1c22SToby Isaac @*/ 7699c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value) 7700c58f1c22SToby Isaac { 7701c58f1c22SToby Isaac DMLabel label; 7702c58f1c22SToby Isaac PetscErrorCode ierr; 7703c58f1c22SToby Isaac 7704c58f1c22SToby Isaac PetscFunctionBegin; 7705c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7706c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7707c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7708c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7709c58f1c22SToby Isaac ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr); 7710c58f1c22SToby Isaac PetscFunctionReturn(0); 7711c58f1c22SToby Isaac } 7712c58f1c22SToby Isaac 7713c58f1c22SToby Isaac /*@ 7714c58f1c22SToby Isaac DMGetNumLabels - Return the number of labels defined by the mesh 7715c58f1c22SToby Isaac 7716c58f1c22SToby Isaac Not Collective 7717c58f1c22SToby Isaac 7718c58f1c22SToby Isaac Input Parameter: 7719c58f1c22SToby Isaac . dm - The DM object 7720c58f1c22SToby Isaac 7721c58f1c22SToby Isaac Output Parameter: 7722c58f1c22SToby Isaac . numLabels - the number of Labels 7723c58f1c22SToby Isaac 7724c58f1c22SToby Isaac Level: intermediate 7725c58f1c22SToby Isaac 7726c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7727c58f1c22SToby Isaac @*/ 7728c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels) 7729c58f1c22SToby Isaac { 77305d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7731c58f1c22SToby Isaac PetscInt n = 0; 7732c58f1c22SToby Isaac 7733c58f1c22SToby Isaac PetscFunctionBegin; 7734c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7735534a8f05SLisandro Dalcin PetscValidIntPointer(numLabels, 2); 7736c58f1c22SToby Isaac while (next) {++n; next = next->next;} 7737c58f1c22SToby Isaac *numLabels = n; 7738c58f1c22SToby Isaac PetscFunctionReturn(0); 7739c58f1c22SToby Isaac } 7740c58f1c22SToby Isaac 7741c58f1c22SToby Isaac /*@C 7742c58f1c22SToby Isaac DMGetLabelName - Return the name of nth label 7743c58f1c22SToby Isaac 7744c58f1c22SToby Isaac Not Collective 7745c58f1c22SToby Isaac 7746c58f1c22SToby Isaac Input Parameters: 7747c58f1c22SToby Isaac + dm - The DM object 7748c58f1c22SToby Isaac - n - the label number 7749c58f1c22SToby Isaac 7750c58f1c22SToby Isaac Output Parameter: 7751c58f1c22SToby Isaac . name - the label name 7752c58f1c22SToby Isaac 7753c58f1c22SToby Isaac Level: intermediate 7754c58f1c22SToby Isaac 7755c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7756c58f1c22SToby Isaac @*/ 7757c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name) 7758c58f1c22SToby Isaac { 77595d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7760c58f1c22SToby Isaac PetscInt l = 0; 7761d67d17b1SMatthew G. Knepley PetscErrorCode ierr; 7762c58f1c22SToby Isaac 7763c58f1c22SToby Isaac PetscFunctionBegin; 7764c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7765c58f1c22SToby Isaac PetscValidPointer(name, 3); 7766c58f1c22SToby Isaac while (next) { 7767c58f1c22SToby Isaac if (l == n) { 7768d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr); 7769c58f1c22SToby Isaac PetscFunctionReturn(0); 7770c58f1c22SToby Isaac } 7771c58f1c22SToby Isaac ++l; 7772c58f1c22SToby Isaac next = next->next; 7773c58f1c22SToby Isaac } 7774c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 7775c58f1c22SToby Isaac } 7776c58f1c22SToby Isaac 7777c58f1c22SToby Isaac /*@C 7778c58f1c22SToby Isaac DMHasLabel - Determine whether the mesh has a label of a given name 7779c58f1c22SToby Isaac 7780c58f1c22SToby Isaac Not Collective 7781c58f1c22SToby Isaac 7782c58f1c22SToby Isaac Input Parameters: 7783c58f1c22SToby Isaac + dm - The DM object 7784c58f1c22SToby Isaac - name - The label name 7785c58f1c22SToby Isaac 7786c58f1c22SToby Isaac Output Parameter: 7787c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present 7788c58f1c22SToby Isaac 7789c58f1c22SToby Isaac Level: intermediate 7790c58f1c22SToby Isaac 7791c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7792c58f1c22SToby Isaac @*/ 7793c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel) 7794c58f1c22SToby Isaac { 77955d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7796d67d17b1SMatthew G. Knepley const char *lname; 7797c58f1c22SToby Isaac PetscErrorCode ierr; 7798c58f1c22SToby Isaac 7799c58f1c22SToby Isaac PetscFunctionBegin; 7800c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7801c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7802534a8f05SLisandro Dalcin PetscValidBoolPointer(hasLabel, 3); 7803c58f1c22SToby Isaac *hasLabel = PETSC_FALSE; 7804c58f1c22SToby Isaac while (next) { 7805d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 7806d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr); 7807c58f1c22SToby Isaac if (*hasLabel) break; 7808c58f1c22SToby Isaac next = next->next; 7809c58f1c22SToby Isaac } 7810c58f1c22SToby Isaac PetscFunctionReturn(0); 7811c58f1c22SToby Isaac } 7812c58f1c22SToby Isaac 7813c58f1c22SToby Isaac /*@C 7814c58f1c22SToby Isaac DMGetLabel - Return the label of a given name, or NULL 7815c58f1c22SToby Isaac 7816c58f1c22SToby Isaac Not Collective 7817c58f1c22SToby Isaac 7818c58f1c22SToby Isaac Input Parameters: 7819c58f1c22SToby Isaac + dm - The DM object 7820c58f1c22SToby Isaac - name - The label name 7821c58f1c22SToby Isaac 7822c58f1c22SToby Isaac Output Parameter: 7823c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 7824c58f1c22SToby Isaac 78256d7c9049SMatthew G. Knepley Note: Some of the default labels in a DMPlex will be 78266d7c9049SMatthew G. Knepley $ "depth" - Holds the depth (co-dimension) of each mesh point 78276d7c9049SMatthew G. Knepley $ "celltype" - Holds the topological type of each cell 78286d7c9049SMatthew G. Knepley $ "ghost" - If the DM is distributed with overlap, this marks the cells and faces in the overlap 78296d7c9049SMatthew G. Knepley $ "Cell Sets" - Mirrors the cell sets defined by GMsh and ExodusII 78306d7c9049SMatthew G. Knepley $ "Face Sets" - Mirrors the face sets defined by GMsh and ExodusII 78316d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh 78326d7c9049SMatthew G. Knepley 7833c58f1c22SToby Isaac Level: intermediate 7834c58f1c22SToby Isaac 78356d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType() 7836c58f1c22SToby Isaac @*/ 7837c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label) 7838c58f1c22SToby Isaac { 78395d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7840c58f1c22SToby Isaac PetscBool hasLabel; 7841d67d17b1SMatthew G. Knepley const char *lname; 7842c58f1c22SToby Isaac PetscErrorCode ierr; 7843c58f1c22SToby Isaac 7844c58f1c22SToby Isaac PetscFunctionBegin; 7845c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7846c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7847c58f1c22SToby Isaac PetscValidPointer(label, 3); 7848c58f1c22SToby Isaac *label = NULL; 7849c58f1c22SToby Isaac while (next) { 7850d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 7851d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 7852c58f1c22SToby Isaac if (hasLabel) { 7853c58f1c22SToby Isaac *label = next->label; 7854c58f1c22SToby Isaac break; 7855c58f1c22SToby Isaac } 7856c58f1c22SToby Isaac next = next->next; 7857c58f1c22SToby Isaac } 7858c58f1c22SToby Isaac PetscFunctionReturn(0); 7859c58f1c22SToby Isaac } 7860c58f1c22SToby Isaac 7861c58f1c22SToby Isaac /*@C 7862c58f1c22SToby Isaac DMGetLabelByNum - Return the nth label 7863c58f1c22SToby Isaac 7864c58f1c22SToby Isaac Not Collective 7865c58f1c22SToby Isaac 7866c58f1c22SToby Isaac Input Parameters: 7867c58f1c22SToby Isaac + dm - The DM object 7868c58f1c22SToby Isaac - n - the label number 7869c58f1c22SToby Isaac 7870c58f1c22SToby Isaac Output Parameter: 7871c58f1c22SToby Isaac . label - the label 7872c58f1c22SToby Isaac 7873c58f1c22SToby Isaac Level: intermediate 7874c58f1c22SToby Isaac 7875c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7876c58f1c22SToby Isaac @*/ 7877c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label) 7878c58f1c22SToby Isaac { 78795d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7880c58f1c22SToby Isaac PetscInt l = 0; 7881c58f1c22SToby Isaac 7882c58f1c22SToby Isaac PetscFunctionBegin; 7883c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7884c58f1c22SToby Isaac PetscValidPointer(label, 3); 7885c58f1c22SToby Isaac while (next) { 7886c58f1c22SToby Isaac if (l == n) { 7887c58f1c22SToby Isaac *label = next->label; 7888c58f1c22SToby Isaac PetscFunctionReturn(0); 7889c58f1c22SToby Isaac } 7890c58f1c22SToby Isaac ++l; 7891c58f1c22SToby Isaac next = next->next; 7892c58f1c22SToby Isaac } 7893c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 7894c58f1c22SToby Isaac } 7895c58f1c22SToby Isaac 7896c58f1c22SToby Isaac /*@C 7897c58f1c22SToby Isaac DMAddLabel - Add the label to this mesh 7898c58f1c22SToby Isaac 7899c58f1c22SToby Isaac Not Collective 7900c58f1c22SToby Isaac 7901c58f1c22SToby Isaac Input Parameters: 7902c58f1c22SToby Isaac + dm - The DM object 7903c58f1c22SToby Isaac - label - The DMLabel 7904c58f1c22SToby Isaac 7905c58f1c22SToby Isaac Level: developer 7906c58f1c22SToby Isaac 7907c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7908c58f1c22SToby Isaac @*/ 7909c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label) 7910c58f1c22SToby Isaac { 79115d80c0bfSVaclav Hapla DMLabelLink l, *p, tmpLabel; 7912c58f1c22SToby Isaac PetscBool hasLabel; 7913d67d17b1SMatthew G. Knepley const char *lname; 79145d80c0bfSVaclav Hapla PetscBool flg; 7915c58f1c22SToby Isaac PetscErrorCode ierr; 7916c58f1c22SToby Isaac 7917c58f1c22SToby Isaac PetscFunctionBegin; 7918c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7919d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr); 7920d67d17b1SMatthew G. Knepley ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr); 7921d67d17b1SMatthew G. Knepley if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname); 7922c58f1c22SToby Isaac ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr); 7923c58f1c22SToby Isaac tmpLabel->label = label; 7924c58f1c22SToby Isaac tmpLabel->output = PETSC_TRUE; 79255d80c0bfSVaclav Hapla for (p=&dm->labels; (l=*p); p=&l->next) {} 79265d80c0bfSVaclav Hapla *p = tmpLabel; 792708f633c4SVaclav Hapla ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr); 79285d80c0bfSVaclav Hapla ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 79295d80c0bfSVaclav Hapla if (flg) dm->depthLabel = label; 7930ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr); 7931ba2698f1SMatthew G. Knepley if (flg) dm->celltypeLabel = label; 7932c58f1c22SToby Isaac PetscFunctionReturn(0); 7933c58f1c22SToby Isaac } 7934c58f1c22SToby Isaac 7935c58f1c22SToby Isaac /*@C 79364a7ee7d0SMatthew G. Knepley DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present 79374a7ee7d0SMatthew G. Knepley 79384a7ee7d0SMatthew G. Knepley Not Collective 79394a7ee7d0SMatthew G. Knepley 79404a7ee7d0SMatthew G. Knepley Input Parameters: 79414a7ee7d0SMatthew G. Knepley + dm - The DM object 79424a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute 79434a7ee7d0SMatthew G. Knepley 79444a7ee7d0SMatthew G. Knepley Note: Some of the default labels in a DMPlex will be 79454a7ee7d0SMatthew G. Knepley $ "depth" - Holds the depth (co-dimension) of each mesh point 79464a7ee7d0SMatthew G. Knepley $ "celltype" - Holds the topological type of each cell 79474a7ee7d0SMatthew G. Knepley $ "ghost" - If the DM is distributed with overlap, this marks the cells and faces in the overlap 79484a7ee7d0SMatthew G. Knepley $ "Cell Sets" - Mirrors the cell sets defined by GMsh and ExodusII 79494a7ee7d0SMatthew G. Knepley $ "Face Sets" - Mirrors the face sets defined by GMsh and ExodusII 79504a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh 79514a7ee7d0SMatthew G. Knepley 79524a7ee7d0SMatthew G. Knepley Level: intermediate 79534a7ee7d0SMatthew G. Knepley 79544a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType() 79554a7ee7d0SMatthew G. Knepley @*/ 79564a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label) 79574a7ee7d0SMatthew G. Knepley { 79584a7ee7d0SMatthew G. Knepley DMLabelLink next = dm->labels; 79594a7ee7d0SMatthew G. Knepley PetscBool hasLabel, flg; 79604a7ee7d0SMatthew G. Knepley const char *name, *lname; 79614a7ee7d0SMatthew G. Knepley PetscErrorCode ierr; 79624a7ee7d0SMatthew G. Knepley 79634a7ee7d0SMatthew G. Knepley PetscFunctionBegin; 79644a7ee7d0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 79654a7ee7d0SMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 79664a7ee7d0SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr); 79674a7ee7d0SMatthew G. Knepley while (next) { 79684a7ee7d0SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 79694a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 79704a7ee7d0SMatthew G. Knepley if (hasLabel) { 79714a7ee7d0SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 79724a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 79734a7ee7d0SMatthew G. Knepley if (flg) dm->depthLabel = label; 79744a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr); 79754a7ee7d0SMatthew G. Knepley if (flg) dm->celltypeLabel = label; 79764a7ee7d0SMatthew G. Knepley ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 79774a7ee7d0SMatthew G. Knepley next->label = label; 79784a7ee7d0SMatthew G. Knepley break; 79794a7ee7d0SMatthew G. Knepley } 79804a7ee7d0SMatthew G. Knepley next = next->next; 79814a7ee7d0SMatthew G. Knepley } 79824a7ee7d0SMatthew G. Knepley PetscFunctionReturn(0); 79834a7ee7d0SMatthew G. Knepley } 79844a7ee7d0SMatthew G. Knepley 79854a7ee7d0SMatthew G. Knepley /*@C 7986e5472504SVaclav Hapla DMRemoveLabel - Remove the label given by name from this mesh 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 . label - The DMLabel, or NULL if the label is absent 7996c58f1c22SToby Isaac 7997c58f1c22SToby Isaac Level: developer 7998c58f1c22SToby Isaac 7999e5472504SVaclav Hapla Notes: 8000e5472504SVaclav Hapla DMRemoveLabel(dm,name,NULL) removes the label from dm and calls 8001e5472504SVaclav Hapla DMLabelDestroy() on the label. 8002e5472504SVaclav Hapla 8003e5472504SVaclav Hapla DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT 8004e5472504SVaclav Hapla call DMLabelDestroy(). Instead, the label is returned and the user is 8005e5472504SVaclav Hapla responsible of calling DMLabelDestroy() at some point. 8006e5472504SVaclav Hapla 8007e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf() 8008c58f1c22SToby Isaac @*/ 8009c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label) 8010c58f1c22SToby Isaac { 801195d578d6SVaclav Hapla DMLabelLink link, *pnext; 8012c58f1c22SToby Isaac PetscBool hasLabel; 8013d67d17b1SMatthew G. Knepley const char *lname; 8014c58f1c22SToby Isaac PetscErrorCode ierr; 8015c58f1c22SToby Isaac 8016c58f1c22SToby Isaac PetscFunctionBegin; 8017c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8018e5472504SVaclav Hapla PetscValidCharPointer(name, 2); 8019e5472504SVaclav Hapla if (label) { 8020e5472504SVaclav Hapla PetscValidPointer(label, 3); 8021c58f1c22SToby Isaac *label = NULL; 8022e5472504SVaclav Hapla } 80235d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 802495d578d6SVaclav Hapla ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr); 8025d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 8026c58f1c22SToby Isaac if (hasLabel) { 802795d578d6SVaclav Hapla *pnext = link->next; /* Remove from list */ 8028c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr); 802995d578d6SVaclav Hapla if (hasLabel) dm->depthLabel = NULL; 8030ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr); 8031ba2698f1SMatthew G. Knepley if (hasLabel) dm->celltypeLabel = NULL; 803295d578d6SVaclav Hapla if (label) *label = link->label; 803395d578d6SVaclav Hapla else {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);} 803495d578d6SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 8035c58f1c22SToby Isaac break; 8036c58f1c22SToby Isaac } 8037c58f1c22SToby Isaac } 8038c58f1c22SToby Isaac PetscFunctionReturn(0); 8039c58f1c22SToby Isaac } 8040c58f1c22SToby Isaac 8041306894acSVaclav Hapla /*@ 8042306894acSVaclav Hapla DMRemoveLabelBySelf - Remove the label from this mesh 8043306894acSVaclav Hapla 8044306894acSVaclav Hapla Not Collective 8045306894acSVaclav Hapla 8046306894acSVaclav Hapla Input Parameters: 8047306894acSVaclav Hapla + dm - The DM object 8048306894acSVaclav Hapla . label - (Optional) The DMLabel to be removed from the DM 8049306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM? 8050306894acSVaclav Hapla 8051306894acSVaclav Hapla Level: developer 8052306894acSVaclav Hapla 8053306894acSVaclav Hapla Notes: 8054306894acSVaclav Hapla Only exactly the same instance is removed if found, name match is ignored. 8055306894acSVaclav Hapla If the DM has an exclusive reference to the label, it gets destroyed and 8056306894acSVaclav Hapla *label nullified. 8057306894acSVaclav Hapla 8058306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel() 8059306894acSVaclav Hapla @*/ 8060306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound) 8061306894acSVaclav Hapla { 806243e45a93SVaclav Hapla DMLabelLink link, *pnext; 8063306894acSVaclav Hapla PetscBool hasLabel = PETSC_FALSE; 8064306894acSVaclav Hapla PetscErrorCode ierr; 8065306894acSVaclav Hapla 8066306894acSVaclav Hapla PetscFunctionBegin; 8067306894acSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8068306894acSVaclav Hapla PetscValidPointer(label, 2); 8069f39a9ae0SVaclav Hapla if (!*label && !failNotFound) PetscFunctionReturn(0); 8070306894acSVaclav Hapla PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2); 8071306894acSVaclav Hapla PetscValidLogicalCollectiveBool(dm,failNotFound,3); 80725d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 807343e45a93SVaclav Hapla if (*label == link->label) { 8074306894acSVaclav Hapla hasLabel = PETSC_TRUE; 807543e45a93SVaclav Hapla *pnext = link->next; /* Remove from list */ 8076306894acSVaclav Hapla if (*label == dm->depthLabel) dm->depthLabel = NULL; 8077ba2698f1SMatthew G. Knepley if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL; 807843e45a93SVaclav Hapla if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */ 807943e45a93SVaclav Hapla ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr); 808043e45a93SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 8081306894acSVaclav Hapla break; 8082306894acSVaclav Hapla } 8083306894acSVaclav Hapla } 8084306894acSVaclav Hapla if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM"); 8085306894acSVaclav Hapla PetscFunctionReturn(0); 8086306894acSVaclav Hapla } 8087306894acSVaclav Hapla 8088c58f1c22SToby Isaac /*@C 8089c58f1c22SToby Isaac DMGetLabelOutput - Get the output flag for a given label 8090c58f1c22SToby Isaac 8091c58f1c22SToby Isaac Not Collective 8092c58f1c22SToby Isaac 8093c58f1c22SToby Isaac Input Parameters: 8094c58f1c22SToby Isaac + dm - The DM object 8095c58f1c22SToby Isaac - name - The label name 8096c58f1c22SToby Isaac 8097c58f1c22SToby Isaac Output Parameter: 8098c58f1c22SToby Isaac . output - The flag for output 8099c58f1c22SToby Isaac 8100c58f1c22SToby Isaac Level: developer 8101c58f1c22SToby Isaac 8102c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8103c58f1c22SToby Isaac @*/ 8104c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output) 8105c58f1c22SToby Isaac { 81065d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8107d67d17b1SMatthew G. Knepley const char *lname; 8108c58f1c22SToby Isaac PetscErrorCode ierr; 8109c58f1c22SToby Isaac 8110c58f1c22SToby Isaac PetscFunctionBegin; 8111c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8112c58f1c22SToby Isaac PetscValidPointer(name, 2); 8113c58f1c22SToby Isaac PetscValidPointer(output, 3); 8114c58f1c22SToby Isaac while (next) { 8115c58f1c22SToby Isaac PetscBool flg; 8116c58f1c22SToby Isaac 8117d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8118d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 8119c58f1c22SToby Isaac if (flg) {*output = next->output; PetscFunctionReturn(0);} 8120c58f1c22SToby Isaac next = next->next; 8121c58f1c22SToby Isaac } 8122c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 8123c58f1c22SToby Isaac } 8124c58f1c22SToby Isaac 8125c58f1c22SToby Isaac /*@C 8126c58f1c22SToby Isaac DMSetLabelOutput - Set the output flag for a given label 8127c58f1c22SToby Isaac 8128c58f1c22SToby Isaac Not Collective 8129c58f1c22SToby Isaac 8130c58f1c22SToby Isaac Input Parameters: 8131c58f1c22SToby Isaac + dm - The DM object 8132c58f1c22SToby Isaac . name - The label name 8133c58f1c22SToby Isaac - output - The flag for output 8134c58f1c22SToby Isaac 8135c58f1c22SToby Isaac Level: developer 8136c58f1c22SToby Isaac 8137c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8138c58f1c22SToby Isaac @*/ 8139c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output) 8140c58f1c22SToby Isaac { 81415d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8142d67d17b1SMatthew G. Knepley const char *lname; 8143c58f1c22SToby Isaac PetscErrorCode ierr; 8144c58f1c22SToby Isaac 8145c58f1c22SToby Isaac PetscFunctionBegin; 8146c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8147534a8f05SLisandro Dalcin PetscValidCharPointer(name, 2); 8148c58f1c22SToby Isaac while (next) { 8149c58f1c22SToby Isaac PetscBool flg; 8150c58f1c22SToby Isaac 8151d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8152d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 8153c58f1c22SToby Isaac if (flg) {next->output = output; PetscFunctionReturn(0);} 8154c58f1c22SToby Isaac next = next->next; 8155c58f1c22SToby Isaac } 8156c58f1c22SToby Isaac SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 8157c58f1c22SToby Isaac } 8158c58f1c22SToby Isaac 8159c58f1c22SToby Isaac /*@ 8160c58f1c22SToby Isaac DMCopyLabels - Copy labels from one mesh to another with a superset of the points 8161c58f1c22SToby Isaac 8162d083f849SBarry Smith Collective on dmA 8163c58f1c22SToby Isaac 8164c58f1c22SToby Isaac Input Parameter: 81655d80c0bfSVaclav Hapla + dmA - The DM object with initial labels 81662e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels 81675d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES) 8168ba2698f1SMatthew G. Knepley - all - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE) 8169c58f1c22SToby Isaac 8170c58f1c22SToby Isaac Level: intermediate 8171c58f1c22SToby Isaac 8172c58f1c22SToby Isaac Note: This is typically used when interpolating or otherwise adding to a mesh 8173c58f1c22SToby Isaac 81745d80c0bfSVaclav Hapla .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection(), DMShareLabels() 8175c58f1c22SToby Isaac @*/ 81765d80c0bfSVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all) 8177c58f1c22SToby Isaac { 8178c58f1c22SToby Isaac DMLabel label, labelNew; 8179c58f1c22SToby Isaac const char *name; 8180c58f1c22SToby Isaac PetscBool flg; 81815d80c0bfSVaclav Hapla DMLabelLink link; 81825d80c0bfSVaclav Hapla PetscErrorCode ierr; 8183c58f1c22SToby Isaac 81845d80c0bfSVaclav Hapla PetscFunctionBegin; 81855d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmA, DM_CLASSID, 1); 81865d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmB, DM_CLASSID, 2); 81875d80c0bfSVaclav Hapla PetscValidLogicalCollectiveEnum(dmA, mode,3); 81885d80c0bfSVaclav Hapla PetscValidLogicalCollectiveBool(dmA, all, 4); 81895d80c0bfSVaclav Hapla if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects"); 81905d80c0bfSVaclav Hapla if (dmA == dmB) PetscFunctionReturn(0); 81915d80c0bfSVaclav Hapla for (link=dmA->labels; link; link=link->next) { 81925d80c0bfSVaclav Hapla label=link->label; 81935d80c0bfSVaclav Hapla ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr); 81945d80c0bfSVaclav Hapla if (!all) { 8195c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr); 8196c58f1c22SToby Isaac if (flg) continue; 81977d5acc75SStefano Zampini ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr); 81987d5acc75SStefano Zampini if (flg) continue; 8199ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr); 8200ba2698f1SMatthew G. Knepley if (flg) continue; 82015d80c0bfSVaclav Hapla } 82025d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) { 8203c58f1c22SToby Isaac ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr); 82045d80c0bfSVaclav Hapla } else { 82055d80c0bfSVaclav Hapla labelNew = label; 82065d80c0bfSVaclav Hapla } 8207c58f1c22SToby Isaac ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr); 82085d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);} 8209c58f1c22SToby Isaac } 8210c58f1c22SToby Isaac PetscFunctionReturn(0); 8211c58f1c22SToby Isaac } 82120fdc7489SMatthew Knepley /* 82130fdc7489SMatthew Knepley Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would 82140fdc7489SMatthew Knepley like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every 82150fdc7489SMatthew Knepley (label, id) pair in the DM. 82160fdc7489SMatthew Knepley 82170fdc7489SMatthew Knepley However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to 82180fdc7489SMatthew Knepley each label. 82190fdc7489SMatthew Knepley */ 82200fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal) 82210fdc7489SMatthew Knepley { 82220fdc7489SMatthew Knepley DMUniversalLabel ul; 82230fdc7489SMatthew Knepley PetscBool *active; 82240fdc7489SMatthew Knepley PetscInt pStart, pEnd, p, Nl, l, m; 82250fdc7489SMatthew Knepley PetscErrorCode ierr; 82260fdc7489SMatthew Knepley 82270fdc7489SMatthew Knepley PetscFunctionBegin; 82280fdc7489SMatthew Knepley ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr); 82290fdc7489SMatthew Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr); 82300fdc7489SMatthew Knepley ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr); 82310fdc7489SMatthew Knepley ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr); 82320fdc7489SMatthew Knepley ul->Nl = 0; 82330fdc7489SMatthew Knepley for (l = 0; l < Nl; ++l) { 82340fdc7489SMatthew Knepley PetscBool isdepth, iscelltype; 82350fdc7489SMatthew Knepley const char *name; 82360fdc7489SMatthew Knepley 82370fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr); 82380fdc7489SMatthew Knepley ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr); 82390fdc7489SMatthew Knepley ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr); 82400fdc7489SMatthew Knepley active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE; 82410fdc7489SMatthew Knepley if (active[l]) ++ul->Nl; 82420fdc7489SMatthew Knepley } 82430fdc7489SMatthew 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); 82440fdc7489SMatthew Knepley ul->Nv = 0; 82450fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 82460fdc7489SMatthew Knepley DMLabel label; 82470fdc7489SMatthew Knepley PetscInt nv; 82480fdc7489SMatthew Knepley const char *name; 82490fdc7489SMatthew Knepley 82500fdc7489SMatthew Knepley if (!active[l]) continue; 82510fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr); 82520fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 82530fdc7489SMatthew Knepley ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr); 82540fdc7489SMatthew Knepley ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr); 82550fdc7489SMatthew Knepley ul->indices[m] = l; 82560fdc7489SMatthew Knepley ul->Nv += nv; 82570fdc7489SMatthew Knepley ul->offsets[m+1] = nv; 82580fdc7489SMatthew Knepley ul->bits[m+1] = PetscCeilReal(PetscLog2Real(nv+1)); 82590fdc7489SMatthew Knepley ++m; 82600fdc7489SMatthew Knepley } 82610fdc7489SMatthew Knepley for (l = 1; l <= ul->Nl; ++l) { 82620fdc7489SMatthew Knepley ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l]; 82630fdc7489SMatthew Knepley ul->bits[l] = ul->bits[l-1] + ul->bits[l]; 82640fdc7489SMatthew Knepley } 82650fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 82660fdc7489SMatthew Knepley PetscInt b; 82670fdc7489SMatthew Knepley 82680fdc7489SMatthew Knepley ul->masks[l] = 0; 82690fdc7489SMatthew Knepley for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b; 82700fdc7489SMatthew Knepley } 82710fdc7489SMatthew Knepley ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr); 82720fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 82730fdc7489SMatthew Knepley DMLabel label; 82740fdc7489SMatthew Knepley IS valueIS; 82750fdc7489SMatthew Knepley const PetscInt *varr; 82760fdc7489SMatthew Knepley PetscInt nv, v; 82770fdc7489SMatthew Knepley 82780fdc7489SMatthew Knepley if (!active[l]) continue; 82790fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 82800fdc7489SMatthew Knepley ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr); 82810fdc7489SMatthew Knepley ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr); 82820fdc7489SMatthew Knepley ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr); 82830fdc7489SMatthew Knepley for (v = 0; v < nv; ++v) { 82840fdc7489SMatthew Knepley ul->values[ul->offsets[m]+v] = varr[v]; 82850fdc7489SMatthew Knepley } 82860fdc7489SMatthew Knepley ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr); 82870fdc7489SMatthew Knepley ierr = ISDestroy(&valueIS);CHKERRQ(ierr); 82880fdc7489SMatthew Knepley ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr); 82890fdc7489SMatthew Knepley ++m; 82900fdc7489SMatthew Knepley } 82910fdc7489SMatthew Knepley ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr); 82920fdc7489SMatthew Knepley for (p = pStart; p < pEnd; ++p) { 82930fdc7489SMatthew Knepley PetscInt uval = 0; 82940fdc7489SMatthew Knepley PetscBool marked = PETSC_FALSE; 82950fdc7489SMatthew Knepley 82960fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 82970fdc7489SMatthew Knepley DMLabel label; 82980649b39aSStefano Zampini PetscInt val, defval, loc, nv; 82990fdc7489SMatthew Knepley 83000fdc7489SMatthew Knepley if (!active[l]) continue; 83010fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 83020fdc7489SMatthew Knepley ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr); 83030fdc7489SMatthew Knepley ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr); 83040fdc7489SMatthew Knepley if (val == defval) {++m; continue;} 83050649b39aSStefano Zampini nv = ul->offsets[m+1]-ul->offsets[m]; 83060fdc7489SMatthew Knepley marked = PETSC_TRUE; 83070fdc7489SMatthew Knepley ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr); 83080fdc7489SMatthew Knepley if (loc < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val); 83090fdc7489SMatthew Knepley uval += (loc+1) << ul->bits[m]; 83100fdc7489SMatthew Knepley ++m; 83110fdc7489SMatthew Knepley } 83120fdc7489SMatthew Knepley if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);} 83130fdc7489SMatthew Knepley } 83140fdc7489SMatthew Knepley ierr = PetscFree(active);CHKERRQ(ierr); 83150fdc7489SMatthew Knepley *universal = ul; 83160fdc7489SMatthew Knepley PetscFunctionReturn(0); 83170fdc7489SMatthew Knepley } 83180fdc7489SMatthew Knepley 83190fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal) 83200fdc7489SMatthew Knepley { 83210fdc7489SMatthew Knepley PetscInt l; 83220fdc7489SMatthew Knepley PetscErrorCode ierr; 83230fdc7489SMatthew Knepley 83240fdc7489SMatthew Knepley PetscFunctionBegin; 83250fdc7489SMatthew Knepley for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);} 83260fdc7489SMatthew Knepley ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr); 83270fdc7489SMatthew Knepley ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr); 83280fdc7489SMatthew Knepley ierr = PetscFree((*universal)->values);CHKERRQ(ierr); 83290fdc7489SMatthew Knepley ierr = PetscFree(*universal);CHKERRQ(ierr); 83300fdc7489SMatthew Knepley *universal = NULL; 83310fdc7489SMatthew Knepley PetscFunctionReturn(0); 83320fdc7489SMatthew Knepley } 83330fdc7489SMatthew Knepley 83340fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel) 83350fdc7489SMatthew Knepley { 83360fdc7489SMatthew Knepley PetscFunctionBegin; 83370fdc7489SMatthew Knepley PetscValidPointer(ulabel, 2); 83380fdc7489SMatthew Knepley *ulabel = ul->label; 83390fdc7489SMatthew Knepley PetscFunctionReturn(0); 83400fdc7489SMatthew Knepley } 83410fdc7489SMatthew Knepley 83420fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm) 83430fdc7489SMatthew Knepley { 83440fdc7489SMatthew Knepley PetscInt Nl = ul->Nl, l; 83450fdc7489SMatthew Knepley PetscErrorCode ierr; 83460fdc7489SMatthew Knepley 83470fdc7489SMatthew Knepley PetscFunctionBegin; 8348064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(dm, DM_CLASSID, 3); 83490fdc7489SMatthew Knepley for (l = 0; l < Nl; ++l) { 83500fdc7489SMatthew Knepley if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);} 83510fdc7489SMatthew Knepley else {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);} 83520fdc7489SMatthew Knepley } 83530fdc7489SMatthew Knepley if (preserveOrder) { 83540fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 83550fdc7489SMatthew Knepley const char *name; 83560fdc7489SMatthew Knepley PetscBool match; 83570fdc7489SMatthew Knepley 83580fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr); 83590fdc7489SMatthew Knepley ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr); 83600fdc7489SMatthew Knepley if (!match) SETERRQ3(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]); 83610fdc7489SMatthew Knepley } 83620fdc7489SMatthew Knepley } 83630fdc7489SMatthew Knepley PetscFunctionReturn(0); 83640fdc7489SMatthew Knepley } 83650fdc7489SMatthew Knepley 83660fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value) 83670fdc7489SMatthew Knepley { 83680fdc7489SMatthew Knepley PetscInt l; 83690fdc7489SMatthew Knepley PetscErrorCode ierr; 83700fdc7489SMatthew Knepley 83710fdc7489SMatthew Knepley PetscFunctionBegin; 83720fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 83730fdc7489SMatthew Knepley DMLabel label; 83740fdc7489SMatthew Knepley PetscInt lval = (value & ul->masks[l]) >> ul->bits[l]; 83750fdc7489SMatthew Knepley 83760fdc7489SMatthew Knepley if (lval) { 83770fdc7489SMatthew Knepley if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);} 83780fdc7489SMatthew Knepley else {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);} 83790fdc7489SMatthew Knepley ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr); 83800fdc7489SMatthew Knepley } 83810fdc7489SMatthew Knepley } 83820fdc7489SMatthew Knepley PetscFunctionReturn(0); 83830fdc7489SMatthew Knepley } 8384a8fb8f29SToby Isaac 8385a8fb8f29SToby Isaac /*@ 8386a8fb8f29SToby Isaac DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement 8387a8fb8f29SToby Isaac 8388a8fb8f29SToby Isaac Input Parameter: 8389a8fb8f29SToby Isaac . dm - The DM object 8390a8fb8f29SToby Isaac 8391a8fb8f29SToby Isaac Output Parameter: 8392a8fb8f29SToby Isaac . cdm - The coarse DM 8393a8fb8f29SToby Isaac 8394a8fb8f29SToby Isaac Level: intermediate 8395a8fb8f29SToby Isaac 8396a8fb8f29SToby Isaac .seealso: DMSetCoarseDM() 8397a8fb8f29SToby Isaac @*/ 8398a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm) 8399a8fb8f29SToby Isaac { 8400a8fb8f29SToby Isaac PetscFunctionBegin; 8401a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8402a8fb8f29SToby Isaac PetscValidPointer(cdm, 2); 8403a8fb8f29SToby Isaac *cdm = dm->coarseMesh; 8404a8fb8f29SToby Isaac PetscFunctionReturn(0); 8405a8fb8f29SToby Isaac } 8406a8fb8f29SToby Isaac 8407a8fb8f29SToby Isaac /*@ 8408a8fb8f29SToby Isaac DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement 8409a8fb8f29SToby Isaac 8410a8fb8f29SToby Isaac Input Parameters: 8411a8fb8f29SToby Isaac + dm - The DM object 8412a8fb8f29SToby Isaac - cdm - The coarse DM 8413a8fb8f29SToby Isaac 8414a8fb8f29SToby Isaac Level: intermediate 8415a8fb8f29SToby Isaac 8416a8fb8f29SToby Isaac .seealso: DMGetCoarseDM() 8417a8fb8f29SToby Isaac @*/ 8418a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm) 8419a8fb8f29SToby Isaac { 8420a8fb8f29SToby Isaac PetscErrorCode ierr; 8421a8fb8f29SToby Isaac 8422a8fb8f29SToby Isaac PetscFunctionBegin; 8423a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8424a8fb8f29SToby Isaac if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2); 8425a8fb8f29SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 8426a8fb8f29SToby Isaac ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr); 8427a8fb8f29SToby Isaac dm->coarseMesh = cdm; 8428a8fb8f29SToby Isaac PetscFunctionReturn(0); 8429a8fb8f29SToby Isaac } 8430a8fb8f29SToby Isaac 843188bdff64SToby Isaac /*@ 843288bdff64SToby Isaac DMGetFineDM - Get the fine mesh from which this was obtained by refinement 843388bdff64SToby Isaac 843488bdff64SToby Isaac Input Parameter: 843588bdff64SToby Isaac . dm - The DM object 843688bdff64SToby Isaac 843788bdff64SToby Isaac Output Parameter: 843888bdff64SToby Isaac . fdm - The fine DM 843988bdff64SToby Isaac 844088bdff64SToby Isaac Level: intermediate 844188bdff64SToby Isaac 844288bdff64SToby Isaac .seealso: DMSetFineDM() 844388bdff64SToby Isaac @*/ 844488bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm) 844588bdff64SToby Isaac { 844688bdff64SToby Isaac PetscFunctionBegin; 844788bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 844888bdff64SToby Isaac PetscValidPointer(fdm, 2); 844988bdff64SToby Isaac *fdm = dm->fineMesh; 845088bdff64SToby Isaac PetscFunctionReturn(0); 845188bdff64SToby Isaac } 845288bdff64SToby Isaac 845388bdff64SToby Isaac /*@ 845488bdff64SToby Isaac DMSetFineDM - Set the fine mesh from which this was obtained by refinement 845588bdff64SToby Isaac 845688bdff64SToby Isaac Input Parameters: 845788bdff64SToby Isaac + dm - The DM object 845888bdff64SToby Isaac - fdm - The fine DM 845988bdff64SToby Isaac 846088bdff64SToby Isaac Level: intermediate 846188bdff64SToby Isaac 846288bdff64SToby Isaac .seealso: DMGetFineDM() 846388bdff64SToby Isaac @*/ 846488bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm) 846588bdff64SToby Isaac { 846688bdff64SToby Isaac PetscErrorCode ierr; 846788bdff64SToby Isaac 846888bdff64SToby Isaac PetscFunctionBegin; 846988bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 847088bdff64SToby Isaac if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2); 847188bdff64SToby Isaac ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr); 847288bdff64SToby Isaac ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr); 847388bdff64SToby Isaac dm->fineMesh = fdm; 847488bdff64SToby Isaac PetscFunctionReturn(0); 847588bdff64SToby Isaac } 847688bdff64SToby Isaac 8477a6ba4734SToby Isaac /*=== DMBoundary code ===*/ 8478a6ba4734SToby Isaac 8479a6ba4734SToby Isaac /*@C 8480a6ba4734SToby Isaac DMAddBoundary - Add a boundary condition to the model 8481a6ba4734SToby Isaac 8482783e2ec8SMatthew G. Knepley Collective on dm 8483783e2ec8SMatthew G. Knepley 8484a6ba4734SToby Isaac Input Parameters: 84854c258f51SMatthew G. Knepley + dm - The DM, with a PetscDS that matches the problem being constrained 8486f971fd6bSMatthew G. Knepley . type - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 8487a6ba4734SToby Isaac . name - The BC name 848845480ffeSMatthew G. Knepley . label - The label defining constrained points 848945480ffeSMatthew G. Knepley . Nv - The number of DMLabel values for constrained points 849045480ffeSMatthew G. Knepley . values - An array of values for constrained points 8491a6ba4734SToby Isaac . field - The field to constrain 849245480ffeSMatthew G. Knepley . Nc - The number of constrained field components (0 will constrain all fields) 8493a6ba4734SToby Isaac . comps - An array of constrained component numbers 8494a6ba4734SToby Isaac . bcFunc - A pointwise function giving boundary values 849556cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL 8496a6ba4734SToby Isaac - ctx - An optional user context for bcFunc 8497a6ba4734SToby Isaac 849845480ffeSMatthew G. Knepley Output Parameter: 849945480ffeSMatthew G. Knepley . bd - (Optional) Boundary number 850045480ffeSMatthew G. Knepley 8501a6ba4734SToby Isaac Options Database Keys: 8502a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 8503a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 8504a6ba4734SToby Isaac 850556cf3b9cSMatthew G. Knepley Note: 850656cf3b9cSMatthew 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: 850756cf3b9cSMatthew G. Knepley 850856cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[]) 850956cf3b9cSMatthew G. Knepley 851056cf3b9cSMatthew G. Knepley If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is: 851156cf3b9cSMatthew G. Knepley 851256cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux, 851356cf3b9cSMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 851456cf3b9cSMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 851556cf3b9cSMatthew G. Knepley $ PetscReal time, const PetscReal x[], PetscScalar bcval[]) 851656cf3b9cSMatthew G. Knepley 851756cf3b9cSMatthew G. Knepley + dim - the spatial dimension 851856cf3b9cSMatthew G. Knepley . Nf - the number of fields 851956cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 852056cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 852156cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point 852256cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 852356cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 852456cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 852556cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 852656cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point 852756cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 852856cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 852956cf3b9cSMatthew G. Knepley . t - current time 853056cf3b9cSMatthew G. Knepley . x - coordinates of the current point 853156cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters 853256cf3b9cSMatthew G. Knepley . constants - constant parameters 853356cf3b9cSMatthew G. Knepley - bcval - output values at the current point 853456cf3b9cSMatthew G. Knepley 8535a6ba4734SToby Isaac Level: developer 8536a6ba4734SToby Isaac 853745480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary() 8538a6ba4734SToby Isaac @*/ 853945480ffeSMatthew 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) 8540a6ba4734SToby Isaac { 8541e5e52638SMatthew G. Knepley PetscDS ds; 8542a6ba4734SToby Isaac PetscErrorCode ierr; 8543a6ba4734SToby Isaac 8544a6ba4734SToby Isaac PetscFunctionBegin; 8545a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8546783e2ec8SMatthew G. Knepley PetscValidLogicalCollectiveEnum(dm, type, 2); 854745480ffeSMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4); 854845480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nv, 5); 854945480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, field, 7); 855045480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nc, 8); 8551e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 855245480ffeSMatthew G. Knepley ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr); 855345480ffeSMatthew G. Knepley ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr); 8554a6ba4734SToby Isaac PetscFunctionReturn(0); 8555a6ba4734SToby Isaac } 8556a6ba4734SToby Isaac 855745480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */ 8558e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm) 8559e6f8dbb6SToby Isaac { 8560e5e52638SMatthew G. Knepley PetscDS ds; 8561dff059c6SToby Isaac DMBoundary *lastnext; 8562e6f8dbb6SToby Isaac DSBoundary dsbound; 8563e6f8dbb6SToby Isaac PetscErrorCode ierr; 8564e6f8dbb6SToby Isaac 8565e6f8dbb6SToby Isaac PetscFunctionBegin; 8566e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 8567e5e52638SMatthew G. Knepley dsbound = ds->boundary; 856847a1f5adSToby Isaac if (dm->boundary) { 856947a1f5adSToby Isaac DMBoundary next = dm->boundary; 857047a1f5adSToby Isaac 857147a1f5adSToby Isaac /* quick check to see if the PetscDS has changed */ 857247a1f5adSToby Isaac if (next->dsboundary == dsbound) PetscFunctionReturn(0); 857347a1f5adSToby Isaac /* the PetscDS has changed: tear down and rebuild */ 857447a1f5adSToby Isaac while (next) { 857547a1f5adSToby Isaac DMBoundary b = next; 857647a1f5adSToby Isaac 857747a1f5adSToby Isaac next = b->next; 857847a1f5adSToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 8579a6ba4734SToby Isaac } 858047a1f5adSToby Isaac dm->boundary = NULL; 8581a6ba4734SToby Isaac } 858247a1f5adSToby Isaac 8583dff059c6SToby Isaac lastnext = &(dm->boundary); 8584e6f8dbb6SToby Isaac while (dsbound) { 8585e6f8dbb6SToby Isaac DMBoundary dmbound; 8586e6f8dbb6SToby Isaac 8587e6f8dbb6SToby Isaac ierr = PetscNew(&dmbound);CHKERRQ(ierr); 8588e6f8dbb6SToby Isaac dmbound->dsboundary = dsbound; 858945480ffeSMatthew G. Knepley dmbound->label = dsbound->label; 859047a1f5adSToby Isaac /* push on the back instead of the front so that it is in the same order as in the PetscDS */ 8591dff059c6SToby Isaac *lastnext = dmbound; 8592dff059c6SToby Isaac lastnext = &(dmbound->next); 8593dff059c6SToby Isaac dsbound = dsbound->next; 8594a6ba4734SToby Isaac } 8595a6ba4734SToby Isaac PetscFunctionReturn(0); 8596a6ba4734SToby Isaac } 8597a6ba4734SToby Isaac 8598a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd) 8599a6ba4734SToby Isaac { 8600b95f2879SToby Isaac DMBoundary b; 8601a6ba4734SToby Isaac PetscErrorCode ierr; 8602a6ba4734SToby Isaac 8603a6ba4734SToby Isaac PetscFunctionBegin; 8604a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8605534a8f05SLisandro Dalcin PetscValidBoolPointer(isBd, 3); 8606a6ba4734SToby Isaac *isBd = PETSC_FALSE; 8607e6f8dbb6SToby Isaac ierr = DMPopulateBoundary(dm);CHKERRQ(ierr); 8608b95f2879SToby Isaac b = dm->boundary; 8609a6ba4734SToby Isaac while (b && !(*isBd)) { 8610e6f8dbb6SToby Isaac DMLabel label = b->label; 8611e6f8dbb6SToby Isaac DSBoundary dsb = b->dsboundary; 8612a6ba4734SToby Isaac PetscInt i; 8613a6ba4734SToby Isaac 861445480ffeSMatthew G. Knepley if (label) { 861545480ffeSMatthew G. Knepley for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);} 8616a6ba4734SToby Isaac } 8617a6ba4734SToby Isaac b = b->next; 8618a6ba4734SToby Isaac } 8619a6ba4734SToby Isaac PetscFunctionReturn(0); 8620a6ba4734SToby Isaac } 86214d6f44ffSToby Isaac 86224d6f44ffSToby Isaac /*@C 8623a6e0b375SMatthew G. Knepley DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector. 8624a6e0b375SMatthew G. Knepley 8625a6e0b375SMatthew G. Knepley Collective on DM 86264d6f44ffSToby Isaac 86274d6f44ffSToby Isaac Input Parameters: 86284d6f44ffSToby Isaac + dm - The DM 86290709b2feSToby Isaac . time - The time 86304d6f44ffSToby Isaac . funcs - The coordinate functions to evaluate, one per field 86314d6f44ffSToby Isaac . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 86324d6f44ffSToby Isaac - mode - The insertion mode for values 86334d6f44ffSToby Isaac 86344d6f44ffSToby Isaac Output Parameter: 86354d6f44ffSToby Isaac . X - vector 86364d6f44ffSToby Isaac 86374d6f44ffSToby Isaac Calling sequence of func: 86380709b2feSToby Isaac $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx); 86394d6f44ffSToby Isaac 86404d6f44ffSToby Isaac + dim - The spatial dimension 86418ec8862eSJed Brown . time - The time at which to sample 86424d6f44ffSToby Isaac . x - The coordinates 86434d6f44ffSToby Isaac . Nf - The number of fields 86444d6f44ffSToby Isaac . u - The output field values 86454d6f44ffSToby Isaac - ctx - optional user-defined function context 86464d6f44ffSToby Isaac 86474d6f44ffSToby Isaac Level: developer 86484d6f44ffSToby Isaac 8649a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff() 86504d6f44ffSToby Isaac @*/ 86510709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X) 86524d6f44ffSToby Isaac { 86534d6f44ffSToby Isaac Vec localX; 86544d6f44ffSToby Isaac PetscErrorCode ierr; 86554d6f44ffSToby Isaac 86564d6f44ffSToby Isaac PetscFunctionBegin; 86574d6f44ffSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 86584d6f44ffSToby Isaac ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 86590709b2feSToby Isaac ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 86604d6f44ffSToby Isaac ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 86614d6f44ffSToby Isaac ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 86624d6f44ffSToby Isaac ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 86634d6f44ffSToby Isaac PetscFunctionReturn(0); 86644d6f44ffSToby Isaac } 86654d6f44ffSToby Isaac 8666a6e0b375SMatthew G. Knepley /*@C 8667a6e0b375SMatthew G. Knepley DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector. 8668a6e0b375SMatthew G. Knepley 8669a6e0b375SMatthew G. Knepley Not collective 8670a6e0b375SMatthew G. Knepley 8671a6e0b375SMatthew G. Knepley Input Parameters: 8672a6e0b375SMatthew G. Knepley + dm - The DM 8673a6e0b375SMatthew G. Knepley . time - The time 8674a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 8675a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 8676a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 8677a6e0b375SMatthew G. Knepley 8678a6e0b375SMatthew G. Knepley Output Parameter: 8679a6e0b375SMatthew G. Knepley . localX - vector 8680a6e0b375SMatthew G. Knepley 8681a6e0b375SMatthew G. Knepley Calling sequence of func: 8682a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx); 8683a6e0b375SMatthew G. Knepley 8684a6e0b375SMatthew G. Knepley + dim - The spatial dimension 8685a6e0b375SMatthew G. Knepley . x - The coordinates 8686a6e0b375SMatthew G. Knepley . Nf - The number of fields 8687a6e0b375SMatthew G. Knepley . u - The output field values 8688a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 8689a6e0b375SMatthew G. Knepley 8690a6e0b375SMatthew G. Knepley Level: developer 8691a6e0b375SMatthew G. Knepley 8692a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff() 8693a6e0b375SMatthew G. Knepley @*/ 86940709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 86954d6f44ffSToby Isaac { 86964d6f44ffSToby Isaac PetscErrorCode ierr; 86974d6f44ffSToby Isaac 86984d6f44ffSToby Isaac PetscFunctionBegin; 86994d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8700064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 87010918c465SMatthew G. Knepley if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name); 87020709b2feSToby Isaac ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 87034d6f44ffSToby Isaac PetscFunctionReturn(0); 87044d6f44ffSToby Isaac } 87054d6f44ffSToby Isaac 8706a6e0b375SMatthew G. Knepley /*@C 8707a6e0b375SMatthew 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. 8708a6e0b375SMatthew G. Knepley 8709a6e0b375SMatthew G. Knepley Collective on DM 8710a6e0b375SMatthew G. Knepley 8711a6e0b375SMatthew G. Knepley Input Parameters: 8712a6e0b375SMatthew G. Knepley + dm - The DM 8713a6e0b375SMatthew G. Knepley . time - The time 8714a6e0b375SMatthew G. Knepley . label - The DMLabel selecting the portion of the mesh for projection 8715a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 8716a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 8717a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 8718a6e0b375SMatthew G. Knepley 8719a6e0b375SMatthew G. Knepley Output Parameter: 8720a6e0b375SMatthew G. Knepley . X - vector 8721a6e0b375SMatthew G. Knepley 8722a6e0b375SMatthew G. Knepley Calling sequence of func: 8723a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx); 8724a6e0b375SMatthew G. Knepley 8725a6e0b375SMatthew G. Knepley + dim - The spatial dimension 8726a6e0b375SMatthew G. Knepley . x - The coordinates 8727a6e0b375SMatthew G. Knepley . Nf - The number of fields 8728a6e0b375SMatthew G. Knepley . u - The output field values 8729a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 8730a6e0b375SMatthew G. Knepley 8731a6e0b375SMatthew G. Knepley Level: developer 8732a6e0b375SMatthew G. Knepley 8733a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff() 8734a6e0b375SMatthew G. Knepley @*/ 87352c53366bSMatthew 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) 87362c53366bSMatthew G. Knepley { 87372c53366bSMatthew G. Knepley Vec localX; 87382c53366bSMatthew G. Knepley PetscErrorCode ierr; 87392c53366bSMatthew G. Knepley 87402c53366bSMatthew G. Knepley PetscFunctionBegin; 87412c53366bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 87422c53366bSMatthew G. Knepley ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 87432c53366bSMatthew G. Knepley ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 87442c53366bSMatthew G. Knepley ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 87452c53366bSMatthew G. Knepley ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 87462c53366bSMatthew G. Knepley ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 87472c53366bSMatthew G. Knepley PetscFunctionReturn(0); 87482c53366bSMatthew G. Knepley } 87492c53366bSMatthew G. Knepley 8750a6e0b375SMatthew G. Knepley /*@C 8751a6e0b375SMatthew 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. 8752a6e0b375SMatthew G. Knepley 8753a6e0b375SMatthew G. Knepley Not collective 8754a6e0b375SMatthew G. Knepley 8755a6e0b375SMatthew G. Knepley Input Parameters: 8756a6e0b375SMatthew G. Knepley + dm - The DM 8757a6e0b375SMatthew G. Knepley . time - The time 8758a6e0b375SMatthew G. Knepley . label - The DMLabel selecting the portion of the mesh for projection 8759a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 8760a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 8761a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 8762a6e0b375SMatthew G. Knepley 8763a6e0b375SMatthew G. Knepley Output Parameter: 8764a6e0b375SMatthew G. Knepley . localX - vector 8765a6e0b375SMatthew G. Knepley 8766a6e0b375SMatthew G. Knepley Calling sequence of func: 8767a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx); 8768a6e0b375SMatthew G. Knepley 8769a6e0b375SMatthew G. Knepley + dim - The spatial dimension 8770a6e0b375SMatthew G. Knepley . x - The coordinates 8771a6e0b375SMatthew G. Knepley . Nf - The number of fields 8772a6e0b375SMatthew G. Knepley . u - The output field values 8773a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 8774a6e0b375SMatthew G. Knepley 8775a6e0b375SMatthew G. Knepley Level: developer 8776a6e0b375SMatthew G. Knepley 8777a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff() 8778a6e0b375SMatthew G. Knepley @*/ 87791c531cf8SMatthew 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) 87804d6f44ffSToby Isaac { 87814d6f44ffSToby Isaac PetscErrorCode ierr; 87824d6f44ffSToby Isaac 87834d6f44ffSToby Isaac PetscFunctionBegin; 87844d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8785064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 87860918c465SMatthew G. Knepley if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name); 87871c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 87884d6f44ffSToby Isaac PetscFunctionReturn(0); 87894d6f44ffSToby Isaac } 87902716604bSToby Isaac 8791a6e0b375SMatthew G. Knepley /*@C 8792a6e0b375SMatthew G. Knepley DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector. 8793a6e0b375SMatthew G. Knepley 8794a6e0b375SMatthew G. Knepley Not collective 8795a6e0b375SMatthew G. Knepley 8796a6e0b375SMatthew G. Knepley Input Parameters: 8797a6e0b375SMatthew G. Knepley + dm - The DM 8798a6e0b375SMatthew G. Knepley . time - The time 8799a6e0b375SMatthew G. Knepley . localU - The input field vector 8800a6e0b375SMatthew G. Knepley . funcs - The functions to evaluate, one per field 8801a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 8802a6e0b375SMatthew G. Knepley 8803a6e0b375SMatthew G. Knepley Output Parameter: 8804a6e0b375SMatthew G. Knepley . localX - The output vector 8805a6e0b375SMatthew G. Knepley 8806a6e0b375SMatthew G. Knepley Calling sequence of func: 8807a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 8808a6e0b375SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 8809a6e0b375SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 8810a6e0b375SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 8811a6e0b375SMatthew G. Knepley 8812a6e0b375SMatthew G. Knepley + dim - The spatial dimension 8813a6e0b375SMatthew G. Knepley . Nf - The number of input fields 8814a6e0b375SMatthew G. Knepley . NfAux - The number of input auxiliary fields 8815a6e0b375SMatthew G. Knepley . uOff - The offset of each field in u[] 8816a6e0b375SMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 8817a6e0b375SMatthew G. Knepley . u - The field values at this point in space 8818a6e0b375SMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 8819a6e0b375SMatthew G. Knepley . u_x - The field derivatives at this point in space 8820a6e0b375SMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 8821a6e0b375SMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 8822a6e0b375SMatthew G. Knepley . a - The auxiliary field values at this point in space 8823a6e0b375SMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 8824a6e0b375SMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 8825a6e0b375SMatthew G. Knepley . t - The current time 8826a6e0b375SMatthew G. Knepley . x - The coordinates of this point 8827a6e0b375SMatthew G. Knepley . numConstants - The number of constants 8828a6e0b375SMatthew G. Knepley . constants - The value of each constant 8829a6e0b375SMatthew G. Knepley - f - The value of the function at this point in space 8830a6e0b375SMatthew G. Knepley 8831a6e0b375SMatthew 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. 8832a6e0b375SMatthew 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 8833a6e0b375SMatthew 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 8834a6e0b375SMatthew 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. 8835a6e0b375SMatthew G. Knepley 8836a6e0b375SMatthew G. Knepley Level: intermediate 8837a6e0b375SMatthew G. Knepley 8838a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 8839a6e0b375SMatthew G. Knepley @*/ 88408c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU, 88418c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 88428c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 88438c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 8844191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 88458c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 88468c6c5593SMatthew G. Knepley { 88478c6c5593SMatthew G. Knepley PetscErrorCode ierr; 88488c6c5593SMatthew G. Knepley 88498c6c5593SMatthew G. Knepley PetscFunctionBegin; 88508c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 88518c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localU,VEC_CLASSID,3); 88528c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 88530918c465SMatthew G. Knepley if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name); 88548c6c5593SMatthew G. Knepley ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr); 88558c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 88568c6c5593SMatthew G. Knepley } 88578c6c5593SMatthew G. Knepley 8858a6e0b375SMatthew G. Knepley /*@C 8859a6e0b375SMatthew 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. 8860a6e0b375SMatthew G. Knepley 8861a6e0b375SMatthew G. Knepley Not collective 8862a6e0b375SMatthew G. Knepley 8863a6e0b375SMatthew G. Knepley Input Parameters: 8864a6e0b375SMatthew G. Knepley + dm - The DM 8865a6e0b375SMatthew G. Knepley . time - The time 8866a6e0b375SMatthew G. Knepley . label - The DMLabel marking the portion of the domain to output 8867a6e0b375SMatthew G. Knepley . numIds - The number of label ids to use 8868a6e0b375SMatthew G. Knepley . ids - The label ids to use for marking 8869a6e0b375SMatthew G. Knepley . Nc - The number of components to set in the output, or PETSC_DETERMINE for all components 8870a6e0b375SMatthew G. Knepley . comps - The components to set in the output, or NULL for all components 8871a6e0b375SMatthew G. Knepley . localU - The input field vector 8872a6e0b375SMatthew G. Knepley . funcs - The functions to evaluate, one per field 8873a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 8874a6e0b375SMatthew G. Knepley 8875a6e0b375SMatthew G. Knepley Output Parameter: 8876a6e0b375SMatthew G. Knepley . localX - The output vector 8877a6e0b375SMatthew G. Knepley 8878a6e0b375SMatthew G. Knepley Calling sequence of func: 8879a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 8880a6e0b375SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 8881a6e0b375SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 8882a6e0b375SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 8883a6e0b375SMatthew G. Knepley 8884a6e0b375SMatthew G. Knepley + dim - The spatial dimension 8885a6e0b375SMatthew G. Knepley . Nf - The number of input fields 8886a6e0b375SMatthew G. Knepley . NfAux - The number of input auxiliary fields 8887a6e0b375SMatthew G. Knepley . uOff - The offset of each field in u[] 8888a6e0b375SMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 8889a6e0b375SMatthew G. Knepley . u - The field values at this point in space 8890a6e0b375SMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 8891a6e0b375SMatthew G. Knepley . u_x - The field derivatives at this point in space 8892a6e0b375SMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 8893a6e0b375SMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 8894a6e0b375SMatthew G. Knepley . a - The auxiliary field values at this point in space 8895a6e0b375SMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 8896a6e0b375SMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 8897a6e0b375SMatthew G. Knepley . t - The current time 8898a6e0b375SMatthew G. Knepley . x - The coordinates of this point 8899a6e0b375SMatthew G. Knepley . numConstants - The number of constants 8900a6e0b375SMatthew G. Knepley . constants - The value of each constant 8901a6e0b375SMatthew G. Knepley - f - The value of the function at this point in space 8902a6e0b375SMatthew G. Knepley 8903a6e0b375SMatthew 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. 8904a6e0b375SMatthew 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 8905a6e0b375SMatthew 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 8906a6e0b375SMatthew 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. 8907a6e0b375SMatthew G. Knepley 8908a6e0b375SMatthew G. Knepley Level: intermediate 8909a6e0b375SMatthew G. Knepley 8910a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 8911a6e0b375SMatthew G. Knepley @*/ 89121c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 89138c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 89148c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 89158c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 8916191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 89178c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 89188c6c5593SMatthew G. Knepley { 89198c6c5593SMatthew G. Knepley PetscErrorCode ierr; 89208c6c5593SMatthew G. Knepley 89218c6c5593SMatthew G. Knepley PetscFunctionBegin; 89228c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8923064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localU,VEC_CLASSID,8); 8924064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 8925ece3a9fcSMatthew G. Knepley if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name); 89261c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 89278c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 89288c6c5593SMatthew G. Knepley } 89298c6c5593SMatthew G. Knepley 89302716604bSToby Isaac /*@C 8931ece3a9fcSMatthew 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. 8932ece3a9fcSMatthew G. Knepley 8933ece3a9fcSMatthew G. Knepley Not collective 8934ece3a9fcSMatthew G. Knepley 8935ece3a9fcSMatthew G. Knepley Input Parameters: 8936ece3a9fcSMatthew G. Knepley + dm - The DM 8937ece3a9fcSMatthew G. Knepley . time - The time 8938ece3a9fcSMatthew G. Knepley . label - The DMLabel marking the portion of the domain boundary to output 8939ece3a9fcSMatthew G. Knepley . numIds - The number of label ids to use 8940ece3a9fcSMatthew G. Knepley . ids - The label ids to use for marking 8941ece3a9fcSMatthew G. Knepley . Nc - The number of components to set in the output, or PETSC_DETERMINE for all components 8942ece3a9fcSMatthew G. Knepley . comps - The components to set in the output, or NULL for all components 8943ece3a9fcSMatthew G. Knepley . localU - The input field vector 8944ece3a9fcSMatthew G. Knepley . funcs - The functions to evaluate, one per field 8945ece3a9fcSMatthew G. Knepley - mode - The insertion mode for values 8946ece3a9fcSMatthew G. Knepley 8947ece3a9fcSMatthew G. Knepley Output Parameter: 8948ece3a9fcSMatthew G. Knepley . localX - The output vector 8949ece3a9fcSMatthew G. Knepley 8950ece3a9fcSMatthew G. Knepley Calling sequence of func: 8951ece3a9fcSMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 8952ece3a9fcSMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 8953ece3a9fcSMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 8954ece3a9fcSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 8955ece3a9fcSMatthew G. Knepley 8956ece3a9fcSMatthew G. Knepley + dim - The spatial dimension 8957ece3a9fcSMatthew G. Knepley . Nf - The number of input fields 8958ece3a9fcSMatthew G. Knepley . NfAux - The number of input auxiliary fields 8959ece3a9fcSMatthew G. Knepley . uOff - The offset of each field in u[] 8960ece3a9fcSMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 8961ece3a9fcSMatthew G. Knepley . u - The field values at this point in space 8962ece3a9fcSMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 8963ece3a9fcSMatthew G. Knepley . u_x - The field derivatives at this point in space 8964ece3a9fcSMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 8965ece3a9fcSMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 8966ece3a9fcSMatthew G. Knepley . a - The auxiliary field values at this point in space 8967ece3a9fcSMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 8968ece3a9fcSMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 8969ece3a9fcSMatthew G. Knepley . t - The current time 8970ece3a9fcSMatthew G. Knepley . x - The coordinates of this point 8971ece3a9fcSMatthew G. Knepley . n - The face normal 8972ece3a9fcSMatthew G. Knepley . numConstants - The number of constants 8973ece3a9fcSMatthew G. Knepley . constants - The value of each constant 8974ece3a9fcSMatthew G. Knepley - f - The value of the function at this point in space 8975ece3a9fcSMatthew G. Knepley 8976ece3a9fcSMatthew G. Knepley Note: 8977ece3a9fcSMatthew 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. 8978ece3a9fcSMatthew 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 8979ece3a9fcSMatthew 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 8980ece3a9fcSMatthew 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. 8981ece3a9fcSMatthew G. Knepley 8982ece3a9fcSMatthew G. Knepley Level: intermediate 8983ece3a9fcSMatthew G. Knepley 8984ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 8985ece3a9fcSMatthew G. Knepley @*/ 8986ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 8987ece3a9fcSMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 8988ece3a9fcSMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 8989ece3a9fcSMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 8990ece3a9fcSMatthew G. Knepley PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 8991ece3a9fcSMatthew G. Knepley InsertMode mode, Vec localX) 8992ece3a9fcSMatthew G. Knepley { 8993ece3a9fcSMatthew G. Knepley PetscErrorCode ierr; 8994ece3a9fcSMatthew G. Knepley 8995ece3a9fcSMatthew G. Knepley PetscFunctionBegin; 8996ece3a9fcSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8997064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localU,VEC_CLASSID,8); 8998064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 8999ece3a9fcSMatthew G. Knepley if (!dm->ops->projectbdfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name); 9000ece3a9fcSMatthew G. Knepley ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 9001ece3a9fcSMatthew G. Knepley PetscFunctionReturn(0); 9002ece3a9fcSMatthew G. Knepley } 9003ece3a9fcSMatthew G. Knepley 9004ece3a9fcSMatthew G. Knepley /*@C 90052716604bSToby Isaac DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h. 90062716604bSToby Isaac 90072716604bSToby Isaac Input Parameters: 90082716604bSToby Isaac + dm - The DM 90090709b2feSToby Isaac . time - The time 90102716604bSToby Isaac . funcs - The functions to evaluate for each field component 90112716604bSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9012574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 90132716604bSToby Isaac 90142716604bSToby Isaac Output Parameter: 90152716604bSToby Isaac . diff - The diff ||u - u_h||_2 90162716604bSToby Isaac 90172716604bSToby Isaac Level: developer 90182716604bSToby Isaac 90191189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 90202716604bSToby Isaac @*/ 90210709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff) 90222716604bSToby Isaac { 90232716604bSToby Isaac PetscErrorCode ierr; 90242716604bSToby Isaac 90252716604bSToby Isaac PetscFunctionBegin; 90262716604bSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9027b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 90280918c465SMatthew G. Knepley if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name); 90290709b2feSToby Isaac ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 90302716604bSToby Isaac PetscFunctionReturn(0); 90312716604bSToby Isaac } 9032b698f381SToby Isaac 9033b698f381SToby Isaac /*@C 9034b698f381SToby Isaac DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h. 9035b698f381SToby Isaac 9036d083f849SBarry Smith Collective on dm 9037d083f849SBarry Smith 9038b698f381SToby Isaac Input Parameters: 9039b698f381SToby Isaac + dm - The DM 9040b698f381SToby Isaac , time - The time 9041b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component 9042b698f381SToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9043574a98acSMatthew G. Knepley . X - The coefficient vector u_h, a global vector 9044b698f381SToby Isaac - n - The vector to project along 9045b698f381SToby Isaac 9046b698f381SToby Isaac Output Parameter: 9047b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2 9048b698f381SToby Isaac 9049b698f381SToby Isaac Level: developer 9050b698f381SToby Isaac 9051b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff() 9052b698f381SToby Isaac @*/ 9053b698f381SToby 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) 9054b698f381SToby Isaac { 9055b698f381SToby Isaac PetscErrorCode ierr; 9056b698f381SToby Isaac 9057b698f381SToby Isaac PetscFunctionBegin; 9058b698f381SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9059b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 9060b698f381SToby Isaac if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name); 9061b698f381SToby Isaac ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr); 9062b698f381SToby Isaac PetscFunctionReturn(0); 9063b698f381SToby Isaac } 9064b698f381SToby Isaac 90652a16baeaSToby Isaac /*@C 90662a16baeaSToby Isaac DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components. 90672a16baeaSToby Isaac 9068d083f849SBarry Smith Collective on dm 9069d083f849SBarry Smith 90702a16baeaSToby Isaac Input Parameters: 90712a16baeaSToby Isaac + dm - The DM 90722a16baeaSToby Isaac . time - The time 90732a16baeaSToby Isaac . funcs - The functions to evaluate for each field component 90742a16baeaSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9075574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 90762a16baeaSToby Isaac 90772a16baeaSToby Isaac Output Parameter: 90782a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2 90792a16baeaSToby Isaac 90802a16baeaSToby Isaac Level: developer 90812a16baeaSToby Isaac 90821189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 90832a16baeaSToby Isaac @*/ 90841189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[]) 90852a16baeaSToby Isaac { 90862a16baeaSToby Isaac PetscErrorCode ierr; 90872a16baeaSToby Isaac 90882a16baeaSToby Isaac PetscFunctionBegin; 90892a16baeaSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 90902a16baeaSToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 90910918c465SMatthew G. Knepley if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name); 90922a16baeaSToby Isaac ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 90932a16baeaSToby Isaac PetscFunctionReturn(0); 90942a16baeaSToby Isaac } 90952a16baeaSToby Isaac 9096df0b854cSToby Isaac /*@C 9097df0b854cSToby Isaac DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags. Specific implementations of DM maybe have 9098cd3c525cSToby Isaac specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN. 9099df0b854cSToby Isaac 9100df0b854cSToby Isaac Collective on dm 9101df0b854cSToby Isaac 9102df0b854cSToby Isaac Input parameters: 9103df0b854cSToby Isaac + dm - the pre-adaptation DM object 9104a1b0c543SToby Isaac - label - label with the flags 9105df0b854cSToby Isaac 9106df0b854cSToby Isaac Output parameters: 91070d1cd5e0SMatthew G. Knepley . dmAdapt - the adapted DM object: may be NULL if an adapted DM could not be produced. 9108df0b854cSToby Isaac 9109df0b854cSToby Isaac Level: intermediate 91100d1cd5e0SMatthew G. Knepley 91110d1cd5e0SMatthew G. Knepley .seealso: DMAdaptMetric(), DMCoarsen(), DMRefine() 9112df0b854cSToby Isaac @*/ 91130d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt) 9114df0b854cSToby Isaac { 9115df0b854cSToby Isaac PetscErrorCode ierr; 9116df0b854cSToby Isaac 9117df0b854cSToby Isaac PetscFunctionBegin; 9118df0b854cSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9119a1b0c543SToby Isaac PetscValidPointer(label,2); 91200d1cd5e0SMatthew G. Knepley PetscValidPointer(dmAdapt,3); 91210d1cd5e0SMatthew G. Knepley *dmAdapt = NULL; 91226f25b0d8SLisandro Dalcin if (!dm->ops->adaptlabel) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptLabel",((PetscObject)dm)->type_name); 91230d1cd5e0SMatthew G. Knepley ierr = (dm->ops->adaptlabel)(dm, label, dmAdapt);CHKERRQ(ierr); 9124a587d139SMark if (*dmAdapt) { 9125a587d139SMark (*dmAdapt)->prealloc_only = dm->prealloc_only; /* maybe this should go .... */ 9126a587d139SMark ierr = PetscFree((*dmAdapt)->vectype);CHKERRQ(ierr); 9127a587d139SMark ierr = PetscStrallocpy(dm->vectype,(char**)&(*dmAdapt)->vectype);CHKERRQ(ierr); 9128a587d139SMark ierr = PetscFree((*dmAdapt)->mattype);CHKERRQ(ierr); 9129a587d139SMark ierr = PetscStrallocpy(dm->mattype,(char**)&(*dmAdapt)->mattype);CHKERRQ(ierr); 9130a587d139SMark } 91310d1cd5e0SMatthew G. Knepley PetscFunctionReturn(0); 91320d1cd5e0SMatthew G. Knepley } 91330d1cd5e0SMatthew G. Knepley 91340d1cd5e0SMatthew G. Knepley /*@C 91350d1cd5e0SMatthew G. Knepley DMAdaptMetric - Generates a mesh adapted to the specified metric field using the pragmatic library. 91360d1cd5e0SMatthew G. Knepley 91370d1cd5e0SMatthew G. Knepley Input Parameters: 91380d1cd5e0SMatthew G. Knepley + dm - The DM object 91390d1cd5e0SMatthew G. Knepley . metric - The metric to which the mesh is adapted, defined vertex-wise. 91406f25b0d8SLisandro Dalcin - bdLabel - Label for boundary tags, which will be preserved in the output mesh. bdLabel should be NULL if there is no such label, and should be different from "_boundary_". 91410d1cd5e0SMatthew G. Knepley 91420d1cd5e0SMatthew G. Knepley Output Parameter: 91430d1cd5e0SMatthew G. Knepley . dmAdapt - Pointer to the DM object containing the adapted mesh 91440d1cd5e0SMatthew G. Knepley 91450d1cd5e0SMatthew G. Knepley Note: The label in the adapted mesh will be registered under the name of the input DMLabel object 91460d1cd5e0SMatthew G. Knepley 91470d1cd5e0SMatthew G. Knepley Level: advanced 91480d1cd5e0SMatthew G. Knepley 91490d1cd5e0SMatthew G. Knepley .seealso: DMAdaptLabel(), DMCoarsen(), DMRefine() 91500d1cd5e0SMatthew G. Knepley @*/ 91510d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DM *dmAdapt) 91520d1cd5e0SMatthew G. Knepley { 91530d1cd5e0SMatthew G. Knepley PetscErrorCode ierr; 91540d1cd5e0SMatthew G. Knepley 91550d1cd5e0SMatthew G. Knepley PetscFunctionBegin; 91560d1cd5e0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 91570d1cd5e0SMatthew G. Knepley PetscValidHeaderSpecific(metric, VEC_CLASSID, 2); 91580d1cd5e0SMatthew G. Knepley if (bdLabel) PetscValidPointer(bdLabel, 3); 91590d1cd5e0SMatthew G. Knepley PetscValidPointer(dmAdapt, 4); 91606f25b0d8SLisandro Dalcin *dmAdapt = NULL; 91616f25b0d8SLisandro Dalcin if (!dm->ops->adaptmetric) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptMetric",((PetscObject)dm)->type_name); 91620d1cd5e0SMatthew G. Knepley ierr = (dm->ops->adaptmetric)(dm, metric, bdLabel, dmAdapt);CHKERRQ(ierr); 9163df0b854cSToby Isaac PetscFunctionReturn(0); 9164df0b854cSToby Isaac } 9165c4088d22SMatthew G. Knepley 9166502a2867SDave May /*@C 9167502a2867SDave May DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors 9168502a2867SDave May 9169502a2867SDave May Not Collective 9170502a2867SDave May 9171502a2867SDave May Input Parameter: 9172502a2867SDave May . dm - The DM 9173502a2867SDave May 91740a19bb7dSprj- Output Parameters: 91750a19bb7dSprj- + nranks - the number of neighbours 91760a19bb7dSprj- - ranks - the neighbors ranks 9177502a2867SDave May 9178502a2867SDave May Notes: 9179502a2867SDave May Do not free the array, it is freed when the DM is destroyed. 9180502a2867SDave May 9181502a2867SDave May Level: beginner 9182502a2867SDave May 9183dec1416fSJunchao Zhang .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks() 9184502a2867SDave May @*/ 9185502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[]) 9186502a2867SDave May { 9187502a2867SDave May PetscErrorCode ierr; 9188502a2867SDave May 9189502a2867SDave May PetscFunctionBegin; 9190502a2867SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 91910918c465SMatthew G. Knepley if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name); 9192502a2867SDave May ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr); 9193502a2867SDave May PetscFunctionReturn(0); 9194502a2867SDave May } 9195502a2867SDave May 9196531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */ 9197531c7667SBarry Smith 9198531c7667SBarry Smith /* 9199531c7667SBarry Smith Converts the input vector to a ghosted vector and then calls the standard coloring code. 9200531c7667SBarry Smith This has be a different function because it requires DM which is not defined in the Mat library 9201531c7667SBarry Smith */ 9202531c7667SBarry Smith PetscErrorCode MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx) 9203531c7667SBarry Smith { 9204531c7667SBarry Smith PetscErrorCode ierr; 9205531c7667SBarry Smith 9206531c7667SBarry Smith PetscFunctionBegin; 9207531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 9208531c7667SBarry Smith Vec x1local; 9209531c7667SBarry Smith DM dm; 9210531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 9211531c7667SBarry Smith if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM"); 9212531c7667SBarry Smith ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr); 9213531c7667SBarry Smith ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 9214531c7667SBarry Smith ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 9215531c7667SBarry Smith x1 = x1local; 9216531c7667SBarry Smith } 9217531c7667SBarry Smith ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr); 9218531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 9219531c7667SBarry Smith DM dm; 9220531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 9221531c7667SBarry Smith ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr); 9222531c7667SBarry Smith } 9223531c7667SBarry Smith PetscFunctionReturn(0); 9224531c7667SBarry Smith } 9225531c7667SBarry Smith 9226531c7667SBarry Smith /*@ 9227531c7667SBarry Smith MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring 9228531c7667SBarry Smith 9229531c7667SBarry Smith Input Parameter: 9230531c7667SBarry Smith . coloring - the MatFDColoring object 9231531c7667SBarry Smith 923295452b02SPatrick Sanan Developer Notes: 923395452b02SPatrick Sanan this routine exists because the PETSc Mat library does not know about the DM objects 9234531c7667SBarry Smith 92351b266c99SBarry Smith Level: advanced 92361b266c99SBarry Smith 9237531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType 9238531c7667SBarry Smith @*/ 9239531c7667SBarry Smith PetscErrorCode MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring) 9240531c7667SBarry Smith { 9241531c7667SBarry Smith PetscFunctionBegin; 9242531c7667SBarry Smith coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM; 9243531c7667SBarry Smith PetscFunctionReturn(0); 9244531c7667SBarry Smith } 92458320bc6fSPatrick Sanan 92468320bc6fSPatrick Sanan /*@ 92478320bc6fSPatrick Sanan DMGetCompatibility - determine if two DMs are compatible 92488320bc6fSPatrick Sanan 92498320bc6fSPatrick Sanan Collective 92508320bc6fSPatrick Sanan 92518320bc6fSPatrick Sanan Input Parameters: 9252a5bc1bf3SBarry Smith + dm1 - the first DM 92538320bc6fSPatrick Sanan - dm2 - the second DM 92548320bc6fSPatrick Sanan 92558320bc6fSPatrick Sanan Output Parameters: 92568320bc6fSPatrick Sanan + compatible - whether or not the two DMs are compatible 92578320bc6fSPatrick Sanan - set - whether or not the compatible value was set 92588320bc6fSPatrick Sanan 92598320bc6fSPatrick Sanan Notes: 92608320bc6fSPatrick Sanan Two DMs are deemed compatible if they represent the same parallel decomposition 92613d862458SPatrick Sanan of the same topology. This implies that the section (field data) on one 92628320bc6fSPatrick Sanan "makes sense" with respect to the topology and parallel decomposition of the other. 92633d862458SPatrick Sanan Loosely speaking, compatible DMs represent the same domain and parallel 92643d862458SPatrick Sanan decomposition, but hold different data. 92658320bc6fSPatrick Sanan 92668320bc6fSPatrick Sanan Typically, one would confirm compatibility if intending to simultaneously iterate 92678320bc6fSPatrick Sanan over a pair of vectors obtained from different DMs. 92688320bc6fSPatrick Sanan 92698320bc6fSPatrick Sanan For example, two DMDA objects are compatible if they have the same local 92708320bc6fSPatrick Sanan and global sizes and the same stencil width. They can have different numbers 92718320bc6fSPatrick Sanan of degrees of freedom per node. Thus, one could use the node numbering from 92728320bc6fSPatrick Sanan either DM in bounds for a loop over vectors derived from either DM. 92738320bc6fSPatrick Sanan 92748320bc6fSPatrick Sanan Consider the operation of summing data living on a 2-dof DMDA to data living 92758320bc6fSPatrick Sanan on a 1-dof DMDA, which should be compatible, as in the following snippet. 92768320bc6fSPatrick Sanan .vb 92778320bc6fSPatrick Sanan ... 92788320bc6fSPatrick Sanan ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr); 92798320bc6fSPatrick Sanan if (set && compatible) { 92808320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 92818320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 92823d862458SPatrick Sanan ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr); 92838320bc6fSPatrick Sanan for (j=y; j<y+n; ++j) { 92848320bc6fSPatrick Sanan for (i=x; i<x+m, ++i) { 92858320bc6fSPatrick Sanan arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1]; 92868320bc6fSPatrick Sanan } 92878320bc6fSPatrick Sanan } 92888320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 92898320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 92908320bc6fSPatrick Sanan } else { 92918320bc6fSPatrick Sanan SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible"); 92928320bc6fSPatrick Sanan } 92938320bc6fSPatrick Sanan ... 92948320bc6fSPatrick Sanan .ve 92958320bc6fSPatrick Sanan 92968320bc6fSPatrick Sanan Checking compatibility might be expensive for a given implementation of DM, 92978320bc6fSPatrick Sanan or might be impossible to unambiguously confirm or deny. For this reason, 92988320bc6fSPatrick Sanan this function may decline to determine compatibility, and hence users should 92998320bc6fSPatrick Sanan always check the "set" output parameter. 93008320bc6fSPatrick Sanan 93018320bc6fSPatrick Sanan A DM is always compatible with itself. 93028320bc6fSPatrick Sanan 93038320bc6fSPatrick Sanan In the current implementation, DMs which live on "unequal" communicators 93048320bc6fSPatrick Sanan (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed 93058320bc6fSPatrick Sanan incompatible. 93068320bc6fSPatrick Sanan 93078320bc6fSPatrick Sanan This function is labeled "Collective," as information about all subdomains 93088320bc6fSPatrick Sanan is required on each rank. However, in DM implementations which store all this 93098320bc6fSPatrick Sanan information locally, this function may be merely "Logically Collective". 93108320bc6fSPatrick Sanan 93118320bc6fSPatrick Sanan Developer Notes: 93123d862458SPatrick Sanan Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B 93133d862458SPatrick Sanan iff B is compatible with A. Thus, this function checks the implementations 9314a5bc1bf3SBarry Smith of both dm and dmc (if they are of different types), attempting to determine 93158320bc6fSPatrick Sanan compatibility. It is left to DM implementers to ensure that symmetry is 93168320bc6fSPatrick Sanan preserved. The simplest way to do this is, when implementing type-specific 93173d862458SPatrick Sanan logic for this function, is to check for existing logic in the implementation 93183d862458SPatrick Sanan of other DM types and let *set = PETSC_FALSE if found. 93198320bc6fSPatrick Sanan 93208320bc6fSPatrick Sanan Level: advanced 93218320bc6fSPatrick Sanan 93223d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag() 93238320bc6fSPatrick Sanan @*/ 93248320bc6fSPatrick Sanan 9325a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set) 93268320bc6fSPatrick Sanan { 93278320bc6fSPatrick Sanan PetscErrorCode ierr; 93288320bc6fSPatrick Sanan PetscMPIInt compareResult; 93298320bc6fSPatrick Sanan DMType type,type2; 93308320bc6fSPatrick Sanan PetscBool sameType; 93318320bc6fSPatrick Sanan 93328320bc6fSPatrick Sanan PetscFunctionBegin; 9333a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 93348320bc6fSPatrick Sanan PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 93358320bc6fSPatrick Sanan 93368320bc6fSPatrick Sanan /* Declare a DM compatible with itself */ 9337a5bc1bf3SBarry Smith if (dm1 == dm2) { 93388320bc6fSPatrick Sanan *set = PETSC_TRUE; 93398320bc6fSPatrick Sanan *compatible = PETSC_TRUE; 93408320bc6fSPatrick Sanan PetscFunctionReturn(0); 93418320bc6fSPatrick Sanan } 93428320bc6fSPatrick Sanan 93438320bc6fSPatrick Sanan /* Declare a DM incompatible with a DM that lives on an "unequal" 93448320bc6fSPatrick Sanan communicator. Note that this does not preclude compatibility with 93458320bc6fSPatrick Sanan DMs living on "congruent" or "similar" communicators, but this must be 93468320bc6fSPatrick Sanan determined by the implementation-specific logic */ 9347ffc4695bSBarry Smith ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr); 93488320bc6fSPatrick Sanan if (compareResult == MPI_UNEQUAL) { 93498320bc6fSPatrick Sanan *set = PETSC_TRUE; 93508320bc6fSPatrick Sanan *compatible = PETSC_FALSE; 93518320bc6fSPatrick Sanan PetscFunctionReturn(0); 93528320bc6fSPatrick Sanan } 93538320bc6fSPatrick Sanan 93548320bc6fSPatrick Sanan /* Pass to the implementation-specific routine, if one exists. */ 9355a5bc1bf3SBarry Smith if (dm1->ops->getcompatibility) { 9356a5bc1bf3SBarry Smith ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr); 9357b9d85ea2SLisandro Dalcin if (*set) PetscFunctionReturn(0); 93588320bc6fSPatrick Sanan } 93598320bc6fSPatrick Sanan 9360a5bc1bf3SBarry Smith /* If dm1 and dm2 are of different types, then attempt to check compatibility 93618320bc6fSPatrick Sanan with an implementation of this function from dm2 */ 9362a5bc1bf3SBarry Smith ierr = DMGetType(dm1,&type);CHKERRQ(ierr); 93638320bc6fSPatrick Sanan ierr = DMGetType(dm2,&type2);CHKERRQ(ierr); 93648320bc6fSPatrick Sanan ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr); 93658320bc6fSPatrick Sanan if (!sameType && dm2->ops->getcompatibility) { 9366a5bc1bf3SBarry Smith ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */ 93678320bc6fSPatrick Sanan } else { 93688320bc6fSPatrick Sanan *set = PETSC_FALSE; 93698320bc6fSPatrick Sanan } 93708320bc6fSPatrick Sanan PetscFunctionReturn(0); 93718320bc6fSPatrick Sanan } 9372c0f0dcc3SMatthew G. Knepley 9373c0f0dcc3SMatthew G. Knepley /*@C 9374c0f0dcc3SMatthew G. Knepley DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance. 9375c0f0dcc3SMatthew G. Knepley 9376c0f0dcc3SMatthew G. Knepley Logically Collective on DM 9377c0f0dcc3SMatthew G. Knepley 9378c0f0dcc3SMatthew G. Knepley Input Parameters: 9379c0f0dcc3SMatthew G. Knepley + DM - the DM 9380c0f0dcc3SMatthew G. Knepley . f - the monitor function 9381c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired) 9382c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL) 9383c0f0dcc3SMatthew G. Knepley 9384c0f0dcc3SMatthew G. Knepley Options Database Keys: 9385c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but 9386c0f0dcc3SMatthew G. Knepley does not cancel those set via the options database. 9387c0f0dcc3SMatthew G. Knepley 9388c0f0dcc3SMatthew G. Knepley Notes: 9389c0f0dcc3SMatthew G. Knepley Several different monitoring routines may be set by calling 9390c0f0dcc3SMatthew G. Knepley DMMonitorSet() multiple times; all will be called in the 9391c0f0dcc3SMatthew G. Knepley order in which they were set. 9392c0f0dcc3SMatthew G. Knepley 9393c0f0dcc3SMatthew G. Knepley Fortran Notes: 9394c0f0dcc3SMatthew G. Knepley Only a single monitor function can be set for each DM object 9395c0f0dcc3SMatthew G. Knepley 9396c0f0dcc3SMatthew G. Knepley Level: intermediate 9397c0f0dcc3SMatthew G. Knepley 9398c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel() 9399c0f0dcc3SMatthew G. Knepley @*/ 9400c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**)) 9401c0f0dcc3SMatthew G. Knepley { 9402c0f0dcc3SMatthew G. Knepley PetscInt m; 9403c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9404c0f0dcc3SMatthew G. Knepley 9405c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9406c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9407c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9408c0f0dcc3SMatthew G. Knepley PetscBool identical; 9409c0f0dcc3SMatthew G. Knepley 9410c0f0dcc3SMatthew G. Knepley ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr); 9411c0f0dcc3SMatthew G. Knepley if (identical) PetscFunctionReturn(0); 9412c0f0dcc3SMatthew G. Knepley } 9413c0f0dcc3SMatthew G. Knepley if (dm->numbermonitors >= MAXDMMONITORS) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set"); 9414c0f0dcc3SMatthew G. Knepley dm->monitor[dm->numbermonitors] = f; 9415c0f0dcc3SMatthew G. Knepley dm->monitordestroy[dm->numbermonitors] = monitordestroy; 9416c0f0dcc3SMatthew G. Knepley dm->monitorcontext[dm->numbermonitors++] = (void *) mctx; 9417c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9418c0f0dcc3SMatthew G. Knepley } 9419c0f0dcc3SMatthew G. Knepley 9420c0f0dcc3SMatthew G. Knepley /*@ 9421c0f0dcc3SMatthew G. Knepley DMMonitorCancel - Clears all the monitor functions for a DM object. 9422c0f0dcc3SMatthew G. Knepley 9423c0f0dcc3SMatthew G. Knepley Logically Collective on DM 9424c0f0dcc3SMatthew G. Knepley 9425c0f0dcc3SMatthew G. Knepley Input Parameter: 9426c0f0dcc3SMatthew G. Knepley . dm - the DM 9427c0f0dcc3SMatthew G. Knepley 9428c0f0dcc3SMatthew G. Knepley Options Database Key: 9429c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired 9430c0f0dcc3SMatthew G. Knepley into a code by calls to DMonitorSet(), but does not cancel those 9431c0f0dcc3SMatthew G. Knepley set via the options database 9432c0f0dcc3SMatthew G. Knepley 9433c0f0dcc3SMatthew G. Knepley Notes: 9434c0f0dcc3SMatthew G. Knepley There is no way to clear one specific monitor from a DM object. 9435c0f0dcc3SMatthew G. Knepley 9436c0f0dcc3SMatthew G. Knepley Level: intermediate 9437c0f0dcc3SMatthew G. Knepley 9438c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet() 9439c0f0dcc3SMatthew G. Knepley @*/ 9440c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm) 9441c0f0dcc3SMatthew G. Knepley { 9442c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9443c0f0dcc3SMatthew G. Knepley PetscInt m; 9444c0f0dcc3SMatthew G. Knepley 9445c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9446c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9447c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9448c0f0dcc3SMatthew G. Knepley if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);} 9449c0f0dcc3SMatthew G. Knepley } 9450c0f0dcc3SMatthew G. Knepley dm->numbermonitors = 0; 9451c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9452c0f0dcc3SMatthew G. Knepley } 9453c0f0dcc3SMatthew G. Knepley 9454c0f0dcc3SMatthew G. Knepley /*@C 9455c0f0dcc3SMatthew G. Knepley DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 9456c0f0dcc3SMatthew G. Knepley 9457c0f0dcc3SMatthew G. Knepley Collective on DM 9458c0f0dcc3SMatthew G. Knepley 9459c0f0dcc3SMatthew G. Knepley Input Parameters: 9460c0f0dcc3SMatthew G. Knepley + dm - DM object you wish to monitor 9461c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking 9462c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done 9463c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor 9464c0f0dcc3SMatthew G. Knepley . monitor - the monitor function 9465c0f0dcc3SMatthew 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 9466c0f0dcc3SMatthew G. Knepley 9467c0f0dcc3SMatthew G. Knepley Output Parameter: 9468c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created 9469c0f0dcc3SMatthew G. Knepley 9470c0f0dcc3SMatthew G. Knepley Level: developer 9471c0f0dcc3SMatthew G. Knepley 9472c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 9473c0f0dcc3SMatthew G. Knepley PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 9474c0f0dcc3SMatthew G. Knepley PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 9475c0f0dcc3SMatthew G. Knepley PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 9476c0f0dcc3SMatthew G. Knepley PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 9477c0f0dcc3SMatthew G. Knepley PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 9478c0f0dcc3SMatthew G. Knepley PetscOptionsFList(), PetscOptionsEList() 9479c0f0dcc3SMatthew G. Knepley @*/ 9480c0f0dcc3SMatthew 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) 9481c0f0dcc3SMatthew G. Knepley { 9482c0f0dcc3SMatthew G. Knepley PetscViewer viewer; 9483c0f0dcc3SMatthew G. Knepley PetscViewerFormat format; 9484c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9485c0f0dcc3SMatthew G. Knepley 9486c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9487c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9488c0f0dcc3SMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr); 9489c0f0dcc3SMatthew G. Knepley if (*flg) { 9490c0f0dcc3SMatthew G. Knepley PetscViewerAndFormat *vf; 9491c0f0dcc3SMatthew G. Knepley 9492c0f0dcc3SMatthew G. Knepley ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr); 9493c0f0dcc3SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr); 9494c0f0dcc3SMatthew G. Knepley if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);} 9495c0f0dcc3SMatthew G. Knepley ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr); 9496c0f0dcc3SMatthew G. Knepley } 9497c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9498c0f0dcc3SMatthew G. Knepley } 9499c0f0dcc3SMatthew G. Knepley 9500c0f0dcc3SMatthew G. Knepley /*@ 9501c0f0dcc3SMatthew G. Knepley DMMonitor - runs the user provided monitor routines, if they exist 9502c0f0dcc3SMatthew G. Knepley 9503c0f0dcc3SMatthew G. Knepley Collective on DM 9504c0f0dcc3SMatthew G. Knepley 9505c0f0dcc3SMatthew G. Knepley Input Parameters: 9506c0f0dcc3SMatthew G. Knepley . dm - The DM 9507c0f0dcc3SMatthew G. Knepley 9508c0f0dcc3SMatthew G. Knepley Level: developer 9509c0f0dcc3SMatthew G. Knepley 9510c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet() 9511c0f0dcc3SMatthew G. Knepley @*/ 9512c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm) 9513c0f0dcc3SMatthew G. Knepley { 9514c0f0dcc3SMatthew G. Knepley PetscInt m; 9515c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9516c0f0dcc3SMatthew G. Knepley 9517c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9518c0f0dcc3SMatthew G. Knepley if (!dm) PetscFunctionReturn(0); 9519c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9520c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9521c0f0dcc3SMatthew G. Knepley ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr); 9522c0f0dcc3SMatthew G. Knepley } 9523c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9524c0f0dcc3SMatthew G. Knepley } 95252e4af2aeSMatthew G. Knepley 95262e4af2aeSMatthew G. Knepley /*@ 95272e4af2aeSMatthew G. Knepley DMComputeError - Computes the error assuming the user has given exact solution functions 95282e4af2aeSMatthew G. Knepley 95292e4af2aeSMatthew G. Knepley Collective on DM 95302e4af2aeSMatthew G. Knepley 95312e4af2aeSMatthew G. Knepley Input Parameters: 95322e4af2aeSMatthew G. Knepley + dm - The DM 95332e4af2aeSMatthew G. Knepley . sol - The solution vector 95342e4af2aeSMatthew G. Knepley . errors - An array of length Nf, the number of fields, or NULL for no output 953599c90e12SSatish Balay - errorVec - A Vec pointer, or NULL for no output 95362e4af2aeSMatthew G. Knepley 95372e4af2aeSMatthew G. Knepley Output Parameters: 95382e4af2aeSMatthew G. Knepley + errors - The error in each field 95392e4af2aeSMatthew G. Knepley - errorVec - Creates a vector to hold the cellwise error 95402e4af2aeSMatthew G. Knepley 95412e4af2aeSMatthew G. Knepley Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber(). 95422e4af2aeSMatthew G. Knepley 95432e4af2aeSMatthew G. Knepley Level: developer 95442e4af2aeSMatthew G. Knepley 95452e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber() 95462e4af2aeSMatthew G. Knepley @*/ 95472e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec) 95482e4af2aeSMatthew G. Knepley { 95492e4af2aeSMatthew G. Knepley PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *); 95502e4af2aeSMatthew G. Knepley void **ctxs; 95512e4af2aeSMatthew G. Knepley PetscReal time; 95522e4af2aeSMatthew G. Knepley PetscInt Nf, f, Nds, s; 95532e4af2aeSMatthew G. Knepley PetscErrorCode ierr; 95542e4af2aeSMatthew G. Knepley 95552e4af2aeSMatthew G. Knepley PetscFunctionBegin; 95562e4af2aeSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 95572e4af2aeSMatthew G. Knepley ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr); 95582e4af2aeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 95592e4af2aeSMatthew G. Knepley for (s = 0; s < Nds; ++s) { 95602e4af2aeSMatthew G. Knepley PetscDS ds; 95612e4af2aeSMatthew G. Knepley DMLabel label; 95622e4af2aeSMatthew G. Knepley IS fieldIS; 95632e4af2aeSMatthew G. Knepley const PetscInt *fields; 95642e4af2aeSMatthew G. Knepley PetscInt dsNf; 95652e4af2aeSMatthew G. Knepley 95662e4af2aeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr); 95672e4af2aeSMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr); 95682e4af2aeSMatthew G. Knepley if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);} 95692e4af2aeSMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 95702e4af2aeSMatthew G. Knepley const PetscInt field = fields[f]; 95712e4af2aeSMatthew G. Knepley ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr); 95722e4af2aeSMatthew G. Knepley } 95732e4af2aeSMatthew G. Knepley if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);} 95742e4af2aeSMatthew G. Knepley } 95752e4af2aeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 95762e4af2aeSMatthew G. Knepley if (!exactSol[f]) SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "DS must contain exact solution functions in order to calculate error, missing for field %D", f); 95772e4af2aeSMatthew G. Knepley } 95782e4af2aeSMatthew G. Knepley ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr); 95792e4af2aeSMatthew G. Knepley if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);} 95802e4af2aeSMatthew G. Knepley if (errorVec) { 95812e4af2aeSMatthew G. Knepley DM edm; 95822e4af2aeSMatthew G. Knepley DMPolytopeType ct; 95832e4af2aeSMatthew G. Knepley PetscBool simplex; 95842e4af2aeSMatthew G. Knepley PetscInt dim, cStart, Nf; 95852e4af2aeSMatthew G. Knepley 95862e4af2aeSMatthew G. Knepley ierr = DMClone(dm, &edm);CHKERRQ(ierr); 95872e4af2aeSMatthew G. Knepley ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr); 95882e4af2aeSMatthew G. Knepley ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr); 95892e4af2aeSMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 95902e4af2aeSMatthew G. Knepley simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE; 95912e4af2aeSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 95922e4af2aeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 95932e4af2aeSMatthew G. Knepley PetscFE fe, efe; 95942e4af2aeSMatthew G. Knepley PetscQuadrature q; 95952e4af2aeSMatthew G. Knepley const char *name; 95962e4af2aeSMatthew G. Knepley 95972e4af2aeSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr); 95982e4af2aeSMatthew G. Knepley ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr); 95992e4af2aeSMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr); 96002e4af2aeSMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr); 96012e4af2aeSMatthew G. Knepley ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr); 96022e4af2aeSMatthew G. Knepley ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr); 96032e4af2aeSMatthew G. Knepley ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr); 96042e4af2aeSMatthew G. Knepley ierr = PetscFEDestroy(&efe);CHKERRQ(ierr); 96052e4af2aeSMatthew G. Knepley } 96062e4af2aeSMatthew G. Knepley ierr = DMCreateDS(edm);CHKERRQ(ierr); 96072e4af2aeSMatthew G. Knepley 96082e4af2aeSMatthew G. Knepley ierr = DMCreateGlobalVector(edm, errorVec); 96092e4af2aeSMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr); 96102e4af2aeSMatthew G. Knepley ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr); 96112e4af2aeSMatthew G. Knepley ierr = DMDestroy(&edm);CHKERRQ(ierr); 96122e4af2aeSMatthew G. Knepley } 96132e4af2aeSMatthew G. Knepley ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr); 96142e4af2aeSMatthew G. Knepley PetscFunctionReturn(0); 96152e4af2aeSMatthew G. Knepley } 96169a2a23afSMatthew G. Knepley 96179a2a23afSMatthew G. Knepley /*@ 96189a2a23afSMatthew G. Knepley DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM 96199a2a23afSMatthew G. Knepley 96209a2a23afSMatthew G. Knepley Not collective 96219a2a23afSMatthew G. Knepley 96229a2a23afSMatthew G. Knepley Input Parameter: 96239a2a23afSMatthew G. Knepley . dm - The DM 96249a2a23afSMatthew G. Knepley 96259a2a23afSMatthew G. Knepley Output Parameter: 96269a2a23afSMatthew G. Knepley . numAux - The nubmer of auxiliary data vectors 96279a2a23afSMatthew G. Knepley 96289a2a23afSMatthew G. Knepley Level: advanced 96299a2a23afSMatthew G. Knepley 96309a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 96319a2a23afSMatthew G. Knepley @*/ 96329a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux) 96339a2a23afSMatthew G. Knepley { 96349a2a23afSMatthew G. Knepley PetscErrorCode ierr; 96359a2a23afSMatthew G. Knepley 96369a2a23afSMatthew G. Knepley PetscFunctionBegin; 96379a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 96389a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr); 96399a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 96409a2a23afSMatthew G. Knepley } 96419a2a23afSMatthew G. Knepley 96429a2a23afSMatthew G. Knepley /*@ 96439a2a23afSMatthew G. Knepley DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value 96449a2a23afSMatthew G. Knepley 96459a2a23afSMatthew G. Knepley Not collective 96469a2a23afSMatthew G. Knepley 96479a2a23afSMatthew G. Knepley Input Parameters: 96489a2a23afSMatthew G. Knepley + dm - The DM 96499a2a23afSMatthew G. Knepley . label - The DMLabel 96509a2a23afSMatthew G. Knepley - value - The label value indicating the region 96519a2a23afSMatthew G. Knepley 96529a2a23afSMatthew G. Knepley Output Parameter: 96539a2a23afSMatthew G. Knepley . aux - The Vec holding auxiliary field data 96549a2a23afSMatthew G. Knepley 96559a2a23afSMatthew G. Knepley Level: advanced 96569a2a23afSMatthew G. Knepley 96579a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec() 96589a2a23afSMatthew G. Knepley @*/ 96599a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux) 96609a2a23afSMatthew G. Knepley { 96619a2a23afSMatthew G. Knepley PetscHashAuxKey key; 96629a2a23afSMatthew G. Knepley PetscErrorCode ierr; 96639a2a23afSMatthew G. Knepley 96649a2a23afSMatthew G. Knepley PetscFunctionBegin; 96659a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 96669a2a23afSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 96679a2a23afSMatthew G. Knepley key.label = label; 96689a2a23afSMatthew G. Knepley key.value = value; 96699a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGet(dm->auxData, key, aux);CHKERRQ(ierr); 96709a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 96719a2a23afSMatthew G. Knepley } 96729a2a23afSMatthew G. Knepley 96739a2a23afSMatthew G. Knepley /*@ 96749a2a23afSMatthew G. Knepley DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value 96759a2a23afSMatthew G. Knepley 96769a2a23afSMatthew G. Knepley Not collective 96779a2a23afSMatthew G. Knepley 96789a2a23afSMatthew G. Knepley Input Parameters: 96799a2a23afSMatthew G. Knepley + dm - The DM 96809a2a23afSMatthew G. Knepley . label - The DMLabel 96819a2a23afSMatthew G. Knepley . value - The label value indicating the region 96829a2a23afSMatthew G. Knepley - aux - The Vec holding auxiliary field data 96839a2a23afSMatthew G. Knepley 96849a2a23afSMatthew G. Knepley Level: advanced 96859a2a23afSMatthew G. Knepley 96869a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec() 96879a2a23afSMatthew G. Knepley @*/ 96889a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux) 96899a2a23afSMatthew G. Knepley { 96909a2a23afSMatthew G. Knepley Vec old; 96919a2a23afSMatthew G. Knepley PetscHashAuxKey key; 96929a2a23afSMatthew G. Knepley PetscErrorCode ierr; 96939a2a23afSMatthew G. Knepley 96949a2a23afSMatthew G. Knepley PetscFunctionBegin; 96959a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 96969a2a23afSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 96979a2a23afSMatthew G. Knepley key.label = label; 96989a2a23afSMatthew G. Knepley key.value = value; 96999a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr); 97009a2a23afSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr); 97019a2a23afSMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr); 97029a2a23afSMatthew G. Knepley if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);} 97039a2a23afSMatthew G. Knepley else {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);} 97049a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 97059a2a23afSMatthew G. Knepley } 97069a2a23afSMatthew G. Knepley 97079a2a23afSMatthew G. Knepley /*@C 97089a2a23afSMatthew G. Knepley DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM 97099a2a23afSMatthew G. Knepley 97109a2a23afSMatthew G. Knepley Not collective 97119a2a23afSMatthew G. Knepley 97129a2a23afSMatthew G. Knepley Input Parameter: 97139a2a23afSMatthew G. Knepley . dm - The DM 97149a2a23afSMatthew G. Knepley 97159a2a23afSMatthew G. Knepley Output Parameters: 97169a2a23afSMatthew G. Knepley + labels - The DMLabels for each Vec 97179a2a23afSMatthew G. Knepley - values - The label values for each Vec 97189a2a23afSMatthew G. Knepley 97199a2a23afSMatthew G. Knepley Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec(). 97209a2a23afSMatthew G. Knepley 97219a2a23afSMatthew G. Knepley Level: advanced 97229a2a23afSMatthew G. Knepley 97239a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 97249a2a23afSMatthew G. Knepley @*/ 97259a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[]) 97269a2a23afSMatthew G. Knepley { 97279a2a23afSMatthew G. Knepley PetscHashAuxKey *keys; 97289a2a23afSMatthew G. Knepley PetscInt n, i, off = 0; 97299a2a23afSMatthew G. Knepley PetscErrorCode ierr; 97309a2a23afSMatthew G. Knepley 97319a2a23afSMatthew G. Knepley PetscFunctionBegin; 97329a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 97339a2a23afSMatthew G. Knepley PetscValidPointer(labels, 2); 97349a2a23afSMatthew G. Knepley PetscValidPointer(values, 3); 97359a2a23afSMatthew G. Knepley ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr); 97369a2a23afSMatthew G. Knepley ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr); 97379a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr); 97389a2a23afSMatthew G. Knepley for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;} 97399a2a23afSMatthew G. Knepley ierr = PetscFree(keys);CHKERRQ(ierr); 97409a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 97419a2a23afSMatthew G. Knepley } 97429a2a23afSMatthew G. Knepley 97439a2a23afSMatthew G. Knepley /*@ 97449a2a23afSMatthew G. Knepley DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM 97459a2a23afSMatthew G. Knepley 97469a2a23afSMatthew G. Knepley Not collective 97479a2a23afSMatthew G. Knepley 97489a2a23afSMatthew G. Knepley Input Parameter: 97499a2a23afSMatthew G. Knepley . dm - The DM 97509a2a23afSMatthew G. Knepley 97519a2a23afSMatthew G. Knepley Output Parameter: 97529a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data 97539a2a23afSMatthew G. Knepley 97549a2a23afSMatthew G. Knepley Level: advanced 97559a2a23afSMatthew G. Knepley 97569a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 97579a2a23afSMatthew G. Knepley @*/ 97589a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew) 97599a2a23afSMatthew G. Knepley { 97609a2a23afSMatthew G. Knepley PetscErrorCode ierr; 97619a2a23afSMatthew G. Knepley 97629a2a23afSMatthew G. Knepley PetscFunctionBegin; 97639a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 97649a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr); 97659a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr); 97669a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 97679a2a23afSMatthew G. Knepley } 9768