1d0295fc0SJunchao Zhang #include <petscvec.h> 2af0996ceSBarry Smith #include <petsc/private/dmimpl.h> /*I "petscdm.h" I*/ 3c58f1c22SToby Isaac #include <petsc/private/dmlabelimpl.h> /*I "petscdmlabel.h" I*/ 4e6f8dbb6SToby Isaac #include <petsc/private/petscdsimpl.h> /*I "petscds.h" I*/ 53e922f36SToby Isaac #include <petscdmplex.h> 6f19dbd58SToby Isaac #include <petscdmfield.h> 70c312b8eSJed Brown #include <petscsf.h> 82764a2aaSMatthew G. Knepley #include <petscds.h> 947c6ae99SBarry Smith 10f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 11f918ec44SMatthew G. Knepley #include <petscfeceed.h> 12f918ec44SMatthew G. Knepley #endif 13f918ec44SMatthew G. Knepley 1400d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND) 1500d952a4SJed Brown # include <valgrind/memcheck.h> 1600d952a4SJed Brown #endif 1700d952a4SJed Brown 18732e2eb9SMatthew G Knepley PetscClassId DM_CLASSID; 19d67d17b1SMatthew G. Knepley PetscClassId DMLABEL_CLASSID; 20557cf195SMatthew G. Knepley PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_Refine, DM_CreateInterpolation, DM_CreateRestriction, DM_CreateInjection, DM_CreateMatrix, DM_Load, DM_AdaptInterpolator; 2167a56275SMatthew G Knepley 22ea78f98cSLisandro Dalcin const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DMBoundaryType","DM_BOUNDARY_", NULL}; 23d1b3049bSMatthew G. Knepley const char *const DMBoundaryConditionTypes[] = {"INVALID","ESSENTIAL","NATURAL","INVALID","INVALID","ESSENTIAL_FIELD","NATURAL_FIELD","INVALID","INVALID","ESSENTIAL_BD_FIELD","NATURAL_RIEMANN","DMBoundaryConditionType","DM_BC_", NULL}; 24da9060c4SMatthew G. Knepley const char *const DMPolytopeTypes[] = {"vertex", "segment", "tensor_segment", "triangle", "quadrilateral", "tensor_quad", "tetrahedron", "hexahedron", "triangular_prism", "tensor_triangular_prism", "tensor_quadrilateral_prism", "pyramid", "FV_ghost_cell", "interior_ghost_cell", "unknown", "invalid", "DMPolytopeType", "DM_POLYTOPE_", NULL}; 252cbb9b06SVaclav Hapla const char *const DMCopyLabelsModes[] = {"replace","keep","fail","DMCopyLabelsMode","DM_COPY_LABELS_", NULL}; 2660c22052SBarry Smith 27a4121054SBarry Smith /*@ 28de043629SMatthew G Knepley DMCreate - Creates an empty DM object. The type can then be set with DMSetType(). 29a4121054SBarry Smith 30a4121054SBarry Smith If you never call DMSetType() it will generate an 31a4121054SBarry Smith error when you try to use the vector. 32a4121054SBarry Smith 33d083f849SBarry Smith Collective 34a4121054SBarry Smith 35a4121054SBarry Smith Input Parameter: 36a4121054SBarry Smith . comm - The communicator for the DM object 37a4121054SBarry Smith 38a4121054SBarry Smith Output Parameter: 39a4121054SBarry Smith . dm - The DM object 40a4121054SBarry Smith 41a4121054SBarry Smith Level: beginner 42a4121054SBarry Smith 438472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK 44a4121054SBarry Smith @*/ 457087cfbeSBarry Smith PetscErrorCode DMCreate(MPI_Comm comm,DM *dm) 46a4121054SBarry Smith { 47a4121054SBarry Smith DM v; 48e5e52638SMatthew G. Knepley PetscDS ds; 49a4121054SBarry Smith PetscErrorCode ierr; 50a4121054SBarry Smith 51a4121054SBarry Smith PetscFunctionBegin; 521411c6eeSJed Brown PetscValidPointer(dm,2); 530298fd71SBarry Smith *dm = NULL; 54607a6623SBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 55a4121054SBarry Smith 5673107ff1SLisandro Dalcin ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr); 57e7c4fc90SDmitry Karpeev 5849be4549SMatthew G. Knepley v->setupcalled = PETSC_FALSE; 5949be4549SMatthew G. Knepley v->setfromoptionscalled = PETSC_FALSE; 600298fd71SBarry Smith v->ltogmap = NULL; 61a4ea9b21SRichard Tran Mills v->bind_below = 0; 621411c6eeSJed Brown v->bs = 1; 63171400e9SBarry Smith v->coloringtype = IS_COLORING_GLOBAL; 6488ed4aceSMatthew G Knepley ierr = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr); 651bb6d2a8SBarry Smith ierr = PetscSFCreate(comm, &v->sectionSF);CHKERRQ(ierr); 66c58f1c22SToby Isaac v->labels = NULL; 6734aa8a36SMatthew G. Knepley v->adjacency[0] = PETSC_FALSE; 6834aa8a36SMatthew G. Knepley v->adjacency[1] = PETSC_TRUE; 69c58f1c22SToby Isaac v->depthLabel = NULL; 70ba2698f1SMatthew G. Knepley v->celltypeLabel = NULL; 711bb6d2a8SBarry Smith v->localSection = NULL; 721bb6d2a8SBarry Smith v->globalSection = NULL; 733b8ba7d1SJed Brown v->defaultConstraint.section = NULL; 743b8ba7d1SJed Brown v->defaultConstraint.mat = NULL; 7579769bd5SJed Brown v->defaultConstraint.bias = NULL; 76c6b900c6SMatthew G. Knepley v->L = NULL; 77c6b900c6SMatthew G. Knepley v->maxCell = NULL; 785dc8c3f7SMatthew G. Knepley v->bdtype = NULL; 799a9a41abSToby Isaac v->dimEmbed = PETSC_DEFAULT; 8096173672SStefano Zampini v->dim = PETSC_DETERMINE; 81435a35e8SMatthew G Knepley { 82435a35e8SMatthew G Knepley PetscInt i; 83435a35e8SMatthew G Knepley for (i = 0; i < 10; ++i) { 840298fd71SBarry Smith v->nullspaceConstructors[i] = NULL; 85f9d4088aSMatthew G. Knepley v->nearnullspaceConstructors[i] = NULL; 86435a35e8SMatthew G Knepley } 87435a35e8SMatthew G Knepley } 8845480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 89b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr); 90e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 919a2a23afSMatthew G. Knepley ierr = PetscHMapAuxCreate(&v->auxData);CHKERRQ(ierr); 9214f150ffSMatthew G. Knepley v->dmBC = NULL; 93a8fb8f29SToby Isaac v->coarseMesh = NULL; 94f4d763aaSMatthew G. Knepley v->outputSequenceNum = -1; 95cdb7a50dSMatthew G. Knepley v->outputSequenceVal = 0.0; 96c0dedaeaSBarry Smith ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr); 97b412c318SBarry Smith ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr); 984a7a4c06SLawrence Mitchell 991411c6eeSJed Brown *dm = v; 100a4121054SBarry Smith PetscFunctionReturn(0); 101a4121054SBarry Smith } 102a4121054SBarry Smith 10338221697SMatthew G. Knepley /*@ 10438221697SMatthew G. Knepley DMClone - Creates a DM object with the same topology as the original. 10538221697SMatthew G. Knepley 106d083f849SBarry Smith Collective 10738221697SMatthew G. Knepley 10838221697SMatthew G. Knepley Input Parameter: 10938221697SMatthew G. Knepley . dm - The original DM object 11038221697SMatthew G. Knepley 11138221697SMatthew G. Knepley Output Parameter: 11238221697SMatthew G. Knepley . newdm - The new DM object 11338221697SMatthew G. Knepley 11438221697SMatthew G. Knepley Level: beginner 11538221697SMatthew G. Knepley 1161cb8cacdSPatrick Sanan Notes: 1171cb8cacdSPatrick Sanan For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example, 1181cb8cacdSPatrick Sanan DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not 1191cb8cacdSPatrick Sanan share the PetscSection of the original DM. 1201bb6d2a8SBarry Smith 12189706ed2SPatrick Sanan The clone is considered set up iff the original is. 12289706ed2SPatrick Sanan 12392cfd99aSMartin Diehl .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection() 1241bb6d2a8SBarry Smith 12538221697SMatthew G. Knepley @*/ 12638221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm) 12738221697SMatthew G. Knepley { 12838221697SMatthew G. Knepley PetscSF sf; 12938221697SMatthew G. Knepley Vec coords; 13038221697SMatthew G. Knepley void *ctx; 131a3219837SMatthew G. Knepley PetscInt dim, cdim; 13238221697SMatthew G. Knepley PetscErrorCode ierr; 13338221697SMatthew G. Knepley 13438221697SMatthew G. Knepley PetscFunctionBegin; 13538221697SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 13638221697SMatthew G. Knepley PetscValidPointer(newdm,2); 13738221697SMatthew G. Knepley ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr); 1382cbb9b06SVaclav Hapla ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE, DM_COPY_LABELS_FAIL);CHKERRQ(ierr); 139ddf8437dSMatthew G. Knepley (*newdm)->leveldown = dm->leveldown; 140ddf8437dSMatthew G. Knepley (*newdm)->levelup = dm->levelup; 141c8a6034eSMark (*newdm)->prealloc_only = dm->prealloc_only; 142a587d139SMark ierr = PetscFree((*newdm)->vectype);CHKERRQ(ierr); 143a587d139SMark ierr = PetscStrallocpy(dm->vectype,(char**)&(*newdm)->vectype);CHKERRQ(ierr); 144a587d139SMark ierr = PetscFree((*newdm)->mattype);CHKERRQ(ierr); 145a587d139SMark ierr = PetscStrallocpy(dm->mattype,(char**)&(*newdm)->mattype);CHKERRQ(ierr); 1461de53e9aSMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 1471de53e9aSMatthew G. Knepley ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr); 14838221697SMatthew G. Knepley if (dm->ops->clone) { 14938221697SMatthew G. Knepley ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr); 15038221697SMatthew G. Knepley } 1513f22bcbcSToby Isaac (*newdm)->setupcalled = dm->setupcalled; 15238221697SMatthew G. Knepley ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr); 15338221697SMatthew G. Knepley ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr); 15438221697SMatthew G. Knepley ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr); 15538221697SMatthew G. Knepley ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr); 156be4c1c3eSMatthew G. Knepley if (dm->coordinateDM) { 157be4c1c3eSMatthew G. Knepley DM ncdm; 158be4c1c3eSMatthew G. Knepley PetscSection cs; 1595a0206caSToby Isaac PetscInt pEnd = -1, pEndMax = -1; 160be4c1c3eSMatthew G. Knepley 16192fd8e1eSJed Brown ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr); 162be4c1c3eSMatthew G. Knepley if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);} 163ffc4695bSBarry Smith ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 1645a0206caSToby Isaac if (pEndMax >= 0) { 165be4c1c3eSMatthew G. Knepley ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr); 16683bfc06fSMatthew Knepley ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr); 16792fd8e1eSJed Brown ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr); 168a61e840bSMatthew G. Knepley ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr); 169be4c1c3eSMatthew G. Knepley ierr = DMDestroy(&ncdm);CHKERRQ(ierr); 170be4c1c3eSMatthew G. Knepley } 171be4c1c3eSMatthew G. Knepley } 172a3219837SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 173a3219837SMatthew G. Knepley ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr); 17438221697SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr); 17538221697SMatthew G. Knepley if (coords) { 17638221697SMatthew G. Knepley ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr); 17738221697SMatthew G. Knepley } else { 17838221697SMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 17938221697SMatthew G. Knepley if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);} 18038221697SMatthew G. Knepley } 18190b157c4SStefano Zampini { 18290b157c4SStefano Zampini PetscBool isper; 183c6b900c6SMatthew G. Knepley const PetscReal *maxCell, *L; 1845dc8c3f7SMatthew G. Knepley const DMBoundaryType *bd; 18590b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 18690b157c4SStefano Zampini ierr = DMSetPeriodicity(*newdm, isper, maxCell, L, bd);CHKERRQ(ierr); 187c6b900c6SMatthew G. Knepley } 18834aa8a36SMatthew G. Knepley { 18934aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 19034aa8a36SMatthew G. Knepley 19134aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr); 19234aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 19334aa8a36SMatthew G. Knepley } 19438221697SMatthew G. Knepley PetscFunctionReturn(0); 19538221697SMatthew G. Knepley } 19638221697SMatthew G. Knepley 1979a42bb27SBarry Smith /*@C 198564755cdSBarry Smith DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 1999a42bb27SBarry Smith 200d083f849SBarry Smith Logically Collective on da 2019a42bb27SBarry Smith 202*147403d9SBarry Smith Input Parameters: 2039a42bb27SBarry Smith + da - initial distributed array 204*147403d9SBarry Smith - ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL 2059a42bb27SBarry Smith 2069a42bb27SBarry Smith Options Database: 207*147403d9SBarry Smith . -dm_vec_type ctype - the type of vector to create 2089a42bb27SBarry Smith 2099a42bb27SBarry Smith Level: intermediate 2109a42bb27SBarry Smith 211a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType() 2129a42bb27SBarry Smith @*/ 21319fd82e9SBarry Smith PetscErrorCode DMSetVecType(DM da,VecType ctype) 2149a42bb27SBarry Smith { 2159a42bb27SBarry Smith PetscErrorCode ierr; 2169a42bb27SBarry Smith 2179a42bb27SBarry Smith PetscFunctionBegin; 2189a42bb27SBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 2199a42bb27SBarry Smith ierr = PetscFree(da->vectype);CHKERRQ(ierr); 22019fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr); 2219a42bb27SBarry Smith PetscFunctionReturn(0); 2229a42bb27SBarry Smith } 2239a42bb27SBarry Smith 224c0dedaeaSBarry Smith /*@C 225c0dedaeaSBarry Smith DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() 226c0dedaeaSBarry Smith 227d083f849SBarry Smith Logically Collective on da 228c0dedaeaSBarry Smith 229c0dedaeaSBarry Smith Input Parameter: 230c0dedaeaSBarry Smith . da - initial distributed array 231c0dedaeaSBarry Smith 232c0dedaeaSBarry Smith Output Parameter: 233c0dedaeaSBarry Smith . ctype - the vector type 234c0dedaeaSBarry Smith 235c0dedaeaSBarry Smith Level: intermediate 236c0dedaeaSBarry Smith 237a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType() 238c0dedaeaSBarry Smith @*/ 239c0dedaeaSBarry Smith PetscErrorCode DMGetVecType(DM da,VecType *ctype) 240c0dedaeaSBarry Smith { 241c0dedaeaSBarry Smith PetscFunctionBegin; 242c0dedaeaSBarry Smith PetscValidHeaderSpecific(da,DM_CLASSID,1); 243c0dedaeaSBarry Smith *ctype = da->vectype; 244c0dedaeaSBarry Smith PetscFunctionReturn(0); 245c0dedaeaSBarry Smith } 246c0dedaeaSBarry Smith 2475f1ad066SMatthew G Knepley /*@ 24834f98d34SBarry Smith VecGetDM - Gets the DM defining the data layout of the vector 2495f1ad066SMatthew G Knepley 2505f1ad066SMatthew G Knepley Not collective 2515f1ad066SMatthew G Knepley 2525f1ad066SMatthew G Knepley Input Parameter: 2535f1ad066SMatthew G Knepley . v - The Vec 2545f1ad066SMatthew G Knepley 2555f1ad066SMatthew G Knepley Output Parameter: 2565f1ad066SMatthew G Knepley . dm - The DM 2575f1ad066SMatthew G Knepley 2585f1ad066SMatthew G Knepley Level: intermediate 2595f1ad066SMatthew G Knepley 2605f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2615f1ad066SMatthew G Knepley @*/ 2625f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm) 2635f1ad066SMatthew G Knepley { 2645f1ad066SMatthew G Knepley PetscErrorCode ierr; 2655f1ad066SMatthew G Knepley 2665f1ad066SMatthew G Knepley PetscFunctionBegin; 2675f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 2685f1ad066SMatthew G Knepley PetscValidPointer(dm,2); 2695f1ad066SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 2705f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2715f1ad066SMatthew G Knepley } 2725f1ad066SMatthew G Knepley 2735f1ad066SMatthew G Knepley /*@ 274d9805387SMatthew G. Knepley VecSetDM - Sets the DM defining the data layout of the vector. 2755f1ad066SMatthew G Knepley 2765f1ad066SMatthew G Knepley Not collective 2775f1ad066SMatthew G Knepley 2785f1ad066SMatthew G Knepley Input Parameters: 2795f1ad066SMatthew G Knepley + v - The Vec 2805f1ad066SMatthew G Knepley - dm - The DM 2815f1ad066SMatthew G Knepley 282d9805387SMatthew 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. 283d9805387SMatthew G. Knepley 2845f1ad066SMatthew G Knepley Level: intermediate 2855f1ad066SMatthew G Knepley 2865f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType() 2875f1ad066SMatthew G Knepley @*/ 2885f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm) 2895f1ad066SMatthew G Knepley { 2905f1ad066SMatthew G Knepley PetscErrorCode ierr; 2915f1ad066SMatthew G Knepley 2925f1ad066SMatthew G Knepley PetscFunctionBegin; 2935f1ad066SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,1); 294d7f50e27SLisandro Dalcin if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 2955f1ad066SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 2965f1ad066SMatthew G Knepley PetscFunctionReturn(0); 2975f1ad066SMatthew G Knepley } 2985f1ad066SMatthew G Knepley 299521d9a4cSLisandro Dalcin /*@C 3008f1509bcSBarry Smith DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM 3018f1509bcSBarry Smith 302d083f849SBarry Smith Logically Collective on dm 3038f1509bcSBarry Smith 3048f1509bcSBarry Smith Input Parameters: 3058f1509bcSBarry Smith + dm - the DM context 3068f1509bcSBarry Smith - ctype - the matrix type 3078f1509bcSBarry Smith 3088f1509bcSBarry Smith Options Database: 3098f1509bcSBarry Smith . -dm_is_coloring_type - global or local 3108f1509bcSBarry Smith 3118f1509bcSBarry Smith Level: intermediate 3128f1509bcSBarry Smith 3138f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), 3148f1509bcSBarry Smith DMGetISColoringType() 3158f1509bcSBarry Smith @*/ 3168f1509bcSBarry Smith PetscErrorCode DMSetISColoringType(DM dm,ISColoringType ctype) 3178f1509bcSBarry Smith { 3188f1509bcSBarry Smith PetscFunctionBegin; 3198f1509bcSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3208f1509bcSBarry Smith dm->coloringtype = ctype; 3218f1509bcSBarry Smith PetscFunctionReturn(0); 3228f1509bcSBarry Smith } 3238f1509bcSBarry Smith 3248f1509bcSBarry Smith /*@C 3258f1509bcSBarry Smith DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM 326521d9a4cSLisandro Dalcin 327d083f849SBarry Smith Logically Collective on dm 328521d9a4cSLisandro Dalcin 329521d9a4cSLisandro Dalcin Input Parameter: 3308f1509bcSBarry Smith . dm - the DM context 3318f1509bcSBarry Smith 3328f1509bcSBarry Smith Output Parameter: 3338f1509bcSBarry Smith . ctype - the matrix type 3348f1509bcSBarry Smith 3358f1509bcSBarry Smith Options Database: 3368f1509bcSBarry Smith . -dm_is_coloring_type - global or local 3378f1509bcSBarry Smith 3388f1509bcSBarry Smith Level: intermediate 3398f1509bcSBarry Smith 3408f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), 3418f1509bcSBarry Smith DMGetISColoringType() 3428f1509bcSBarry Smith @*/ 3438f1509bcSBarry Smith PetscErrorCode DMGetISColoringType(DM dm,ISColoringType *ctype) 3448f1509bcSBarry Smith { 3458f1509bcSBarry Smith PetscFunctionBegin; 3468f1509bcSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3478f1509bcSBarry Smith *ctype = dm->coloringtype; 3488f1509bcSBarry Smith PetscFunctionReturn(0); 3498f1509bcSBarry Smith } 3508f1509bcSBarry Smith 3518f1509bcSBarry Smith /*@C 3528f1509bcSBarry Smith DMSetMatType - Sets the type of matrix created with DMCreateMatrix() 3538f1509bcSBarry Smith 354d083f849SBarry Smith Logically Collective on dm 3558f1509bcSBarry Smith 3568f1509bcSBarry Smith Input Parameters: 357521d9a4cSLisandro Dalcin + dm - the DM context 358a2b5a043SBarry Smith - ctype - the matrix type 359521d9a4cSLisandro Dalcin 360521d9a4cSLisandro Dalcin Options Database: 361*147403d9SBarry Smith . -dm_mat_type ctype - the type of the matrix to create 362521d9a4cSLisandro Dalcin 363521d9a4cSLisandro Dalcin Level: intermediate 364521d9a4cSLisandro Dalcin 365a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType() 366521d9a4cSLisandro Dalcin @*/ 36719fd82e9SBarry Smith PetscErrorCode DMSetMatType(DM dm,MatType ctype) 368521d9a4cSLisandro Dalcin { 369521d9a4cSLisandro Dalcin PetscErrorCode ierr; 37088f0584fSBarry Smith 371521d9a4cSLisandro Dalcin PetscFunctionBegin; 372521d9a4cSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 373521d9a4cSLisandro Dalcin ierr = PetscFree(dm->mattype);CHKERRQ(ierr); 37419fd82e9SBarry Smith ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr); 375521d9a4cSLisandro Dalcin PetscFunctionReturn(0); 376521d9a4cSLisandro Dalcin } 377521d9a4cSLisandro Dalcin 378c0dedaeaSBarry Smith /*@C 379c0dedaeaSBarry Smith DMGetMatType - Gets the type of matrix created with DMCreateMatrix() 380c0dedaeaSBarry Smith 381d083f849SBarry Smith Logically Collective on dm 382c0dedaeaSBarry Smith 383c0dedaeaSBarry Smith Input Parameter: 384c0dedaeaSBarry Smith . dm - the DM context 385c0dedaeaSBarry Smith 386c0dedaeaSBarry Smith Output Parameter: 387c0dedaeaSBarry Smith . ctype - the matrix type 388c0dedaeaSBarry Smith 389c0dedaeaSBarry Smith Options Database: 390*147403d9SBarry Smith . -dm_mat_type ctype - the matrix type 391c0dedaeaSBarry Smith 392c0dedaeaSBarry Smith Level: intermediate 393c0dedaeaSBarry Smith 394a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType() 395c0dedaeaSBarry Smith @*/ 396c0dedaeaSBarry Smith PetscErrorCode DMGetMatType(DM dm,MatType *ctype) 397c0dedaeaSBarry Smith { 398c0dedaeaSBarry Smith PetscFunctionBegin; 399c0dedaeaSBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 400c0dedaeaSBarry Smith *ctype = dm->mattype; 401c0dedaeaSBarry Smith PetscFunctionReturn(0); 402c0dedaeaSBarry Smith } 403c0dedaeaSBarry Smith 404c688c046SMatthew G Knepley /*@ 40534f98d34SBarry Smith MatGetDM - Gets the DM defining the data layout of the matrix 406c688c046SMatthew G Knepley 407c688c046SMatthew G Knepley Not collective 408c688c046SMatthew G Knepley 409c688c046SMatthew G Knepley Input Parameter: 410c688c046SMatthew G Knepley . A - The Mat 411c688c046SMatthew G Knepley 412c688c046SMatthew G Knepley Output Parameter: 413c688c046SMatthew G Knepley . dm - The DM 414c688c046SMatthew G Knepley 415c688c046SMatthew G Knepley Level: intermediate 416c688c046SMatthew G Knepley 4178f1509bcSBarry Smith Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with 4188f1509bcSBarry Smith the Mat through a PetscObjectCompose() operation 4198f1509bcSBarry Smith 420c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType() 421c688c046SMatthew G Knepley @*/ 422c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm) 423c688c046SMatthew G Knepley { 424c688c046SMatthew G Knepley PetscErrorCode ierr; 425c688c046SMatthew G Knepley 426c688c046SMatthew G Knepley PetscFunctionBegin; 427c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 428c688c046SMatthew G Knepley PetscValidPointer(dm,2); 429c688c046SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr); 430c688c046SMatthew G Knepley PetscFunctionReturn(0); 431c688c046SMatthew G Knepley } 432c688c046SMatthew G Knepley 433c688c046SMatthew G Knepley /*@ 434c688c046SMatthew G Knepley MatSetDM - Sets the DM defining the data layout of the matrix 435c688c046SMatthew G Knepley 436c688c046SMatthew G Knepley Not collective 437c688c046SMatthew G Knepley 438c688c046SMatthew G Knepley Input Parameters: 439c688c046SMatthew G Knepley + A - The Mat 440c688c046SMatthew G Knepley - dm - The DM 441c688c046SMatthew G Knepley 442c688c046SMatthew G Knepley Level: intermediate 443c688c046SMatthew G Knepley 4448f1509bcSBarry Smith Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with 4458f1509bcSBarry Smith the Mat through a PetscObjectCompose() operation 4468f1509bcSBarry Smith 447c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType() 448c688c046SMatthew G Knepley @*/ 449c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm) 450c688c046SMatthew G Knepley { 451c688c046SMatthew G Knepley PetscErrorCode ierr; 452c688c046SMatthew G Knepley 453c688c046SMatthew G Knepley PetscFunctionBegin; 454c688c046SMatthew G Knepley PetscValidHeaderSpecific(A,MAT_CLASSID,1); 4558865f1eaSKarl Rupp if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2); 456c688c046SMatthew G Knepley ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr); 457c688c046SMatthew G Knepley PetscFunctionReturn(0); 458c688c046SMatthew G Knepley } 459c688c046SMatthew G Knepley 4609a42bb27SBarry Smith /*@C 4619a42bb27SBarry Smith DMSetOptionsPrefix - Sets the prefix used for searching for all 4626757b960SDave May DM options in the database. 4639a42bb27SBarry Smith 464d083f849SBarry Smith Logically Collective on dm 4659a42bb27SBarry Smith 466d8d19677SJose E. Roman Input Parameters: 4678353ddbbSDave May + da - the DM context 4689a42bb27SBarry Smith - prefix - the prefix to prepend to all option names 4699a42bb27SBarry Smith 4709a42bb27SBarry Smith Notes: 4719a42bb27SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4729a42bb27SBarry Smith The first character of all runtime options is AUTOMATICALLY the hyphen. 4739a42bb27SBarry Smith 4749a42bb27SBarry Smith Level: advanced 4759a42bb27SBarry Smith 4769a42bb27SBarry Smith .seealso: DMSetFromOptions() 4779a42bb27SBarry Smith @*/ 4787087cfbeSBarry Smith PetscErrorCode DMSetOptionsPrefix(DM dm,const char prefix[]) 4799a42bb27SBarry Smith { 4809a42bb27SBarry Smith PetscErrorCode ierr; 4819a42bb27SBarry Smith 4829a42bb27SBarry Smith PetscFunctionBegin; 4839a42bb27SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 4849a42bb27SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 485691be533SLawrence Mitchell if (dm->sf) { 486691be533SLawrence Mitchell ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr); 487691be533SLawrence Mitchell } 4881bb6d2a8SBarry Smith if (dm->sectionSF) { 4891bb6d2a8SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr); 490691be533SLawrence Mitchell } 4919a42bb27SBarry Smith PetscFunctionReturn(0); 4929a42bb27SBarry Smith } 4939a42bb27SBarry Smith 49431697293SDave May /*@C 49531697293SDave May DMAppendOptionsPrefix - Appends to the prefix used for searching for all 49631697293SDave May DM options in the database. 49731697293SDave May 498d083f849SBarry Smith Logically Collective on dm 49931697293SDave May 50031697293SDave May Input Parameters: 50131697293SDave May + dm - the DM context 50231697293SDave May - prefix - the prefix string to prepend to all DM option requests 50331697293SDave May 50431697293SDave May Notes: 50531697293SDave May A hyphen (-) must NOT be given at the beginning of the prefix name. 50631697293SDave May The first character of all runtime options is AUTOMATICALLY the hyphen. 50731697293SDave May 50831697293SDave May Level: advanced 50931697293SDave May 51031697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix() 51131697293SDave May @*/ 51231697293SDave May PetscErrorCode DMAppendOptionsPrefix(DM dm,const char prefix[]) 51331697293SDave May { 51431697293SDave May PetscErrorCode ierr; 51531697293SDave May 51631697293SDave May PetscFunctionBegin; 51731697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 51831697293SDave May ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 51931697293SDave May PetscFunctionReturn(0); 52031697293SDave May } 52131697293SDave May 52231697293SDave May /*@C 52331697293SDave May DMGetOptionsPrefix - Gets the prefix used for searching for all 52431697293SDave May DM options in the database. 52531697293SDave May 52631697293SDave May Not Collective 52731697293SDave May 52831697293SDave May Input Parameters: 52931697293SDave May . dm - the DM context 53031697293SDave May 53131697293SDave May Output Parameters: 53231697293SDave May . prefix - pointer to the prefix string used is returned 53331697293SDave May 53495452b02SPatrick Sanan Notes: 53595452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prefix' of 53631697293SDave May sufficient length to hold the prefix. 53731697293SDave May 53831697293SDave May Level: advanced 53931697293SDave May 54031697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix() 54131697293SDave May @*/ 54231697293SDave May PetscErrorCode DMGetOptionsPrefix(DM dm,const char *prefix[]) 54331697293SDave May { 54431697293SDave May PetscErrorCode ierr; 54531697293SDave May 54631697293SDave May PetscFunctionBegin; 54731697293SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 54831697293SDave May ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr); 54931697293SDave May PetscFunctionReturn(0); 55031697293SDave May } 55131697293SDave May 55288bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct) 55388bdff64SToby Isaac { 5546eb26441SStefano Zampini PetscInt refct = ((PetscObject) dm)->refct; 55588bdff64SToby Isaac PetscErrorCode ierr; 55688bdff64SToby Isaac 55788bdff64SToby Isaac PetscFunctionBegin; 558aab5bcd8SJed Brown *ncrefct = 0; 55988bdff64SToby Isaac if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) { 56088bdff64SToby Isaac refct--; 56188bdff64SToby Isaac if (recurseCoarse) { 56288bdff64SToby Isaac PetscInt coarseCount; 56388bdff64SToby Isaac 56488bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr); 56588bdff64SToby Isaac refct += coarseCount; 56688bdff64SToby Isaac } 56788bdff64SToby Isaac } 56888bdff64SToby Isaac if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) { 56988bdff64SToby Isaac refct--; 57088bdff64SToby Isaac if (recurseFine) { 57188bdff64SToby Isaac PetscInt fineCount; 57288bdff64SToby Isaac 57388bdff64SToby Isaac ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr); 57488bdff64SToby Isaac refct += fineCount; 57588bdff64SToby Isaac } 57688bdff64SToby Isaac } 57788bdff64SToby Isaac *ncrefct = refct; 57888bdff64SToby Isaac PetscFunctionReturn(0); 57988bdff64SToby Isaac } 58088bdff64SToby Isaac 581f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm) 582354557abSToby Isaac { 5835d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 584354557abSToby Isaac PetscErrorCode ierr; 585354557abSToby Isaac 586354557abSToby Isaac PetscFunctionBegin; 587354557abSToby Isaac /* destroy the labels */ 588354557abSToby Isaac while (next) { 589354557abSToby Isaac DMLabelLink tmp = next->next; 590354557abSToby Isaac 5915d80c0bfSVaclav Hapla if (next->label == dm->depthLabel) dm->depthLabel = NULL; 592ba2698f1SMatthew G. Knepley if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL; 593354557abSToby Isaac ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 594354557abSToby Isaac ierr = PetscFree(next);CHKERRQ(ierr); 595354557abSToby Isaac next = tmp; 596354557abSToby Isaac } 5975d80c0bfSVaclav Hapla dm->labels = NULL; 598354557abSToby Isaac PetscFunctionReturn(0); 599354557abSToby Isaac } 600354557abSToby Isaac 6011fb7b255SJunchao Zhang /*@C 6028472ad0fSDave May DMDestroy - Destroys a vector packer or DM. 60347c6ae99SBarry Smith 604d083f849SBarry Smith Collective on dm 60547c6ae99SBarry Smith 60647c6ae99SBarry Smith Input Parameter: 60747c6ae99SBarry Smith . dm - the DM object to destroy 60847c6ae99SBarry Smith 60947c6ae99SBarry Smith Level: developer 61047c6ae99SBarry Smith 611e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 61247c6ae99SBarry Smith 61347c6ae99SBarry Smith @*/ 614fcfd50ebSBarry Smith PetscErrorCode DMDestroy(DM *dm) 61547c6ae99SBarry Smith { 6166eb26441SStefano Zampini PetscInt cnt; 617dfe15315SJed Brown DMNamedVecLink nlink,nnext; 61847c6ae99SBarry Smith PetscErrorCode ierr; 61947c6ae99SBarry Smith 62047c6ae99SBarry Smith PetscFunctionBegin; 6216bf464f9SBarry Smith if (!*dm) PetscFunctionReturn(0); 6226bf464f9SBarry Smith PetscValidHeaderSpecific((*dm),DM_CLASSID,1); 62387e657c6SBarry Smith 62488bdff64SToby Isaac /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */ 62588bdff64SToby Isaac ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr); 62688bdff64SToby Isaac --((PetscObject)(*dm))->refct; 627ea78f98cSLisandro Dalcin if (--cnt > 0) {*dm = NULL; PetscFunctionReturn(0);} 6286bf464f9SBarry Smith if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0); 6296bf464f9SBarry Smith ((PetscObject)(*dm))->refct = 0; 6306eb26441SStefano Zampini 6316eb26441SStefano Zampini ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr); 6326eb26441SStefano Zampini ierr = DMClearLocalVectors(*dm);CHKERRQ(ierr); 6336eb26441SStefano Zampini 634f490541aSPeter Brune nnext=(*dm)->namedglobal; 6350298fd71SBarry Smith (*dm)->namedglobal = NULL; 636f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */ 6372348bcf4SPeter Brune nnext = nlink->next; 6382c71b3e2SJacob Faibussowitsch PetscCheckFalse(nlink->status != DMVEC_STATUS_IN,((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name); 6392348bcf4SPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 6402348bcf4SPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 6412348bcf4SPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 6422348bcf4SPeter Brune } 643f490541aSPeter Brune nnext=(*dm)->namedlocal; 6440298fd71SBarry Smith (*dm)->namedlocal = NULL; 645f490541aSPeter Brune for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */ 646f490541aSPeter Brune nnext = nlink->next; 6472c71b3e2SJacob Faibussowitsch PetscCheckFalse(nlink->status != DMVEC_STATUS_IN,((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name); 648f490541aSPeter Brune ierr = PetscFree(nlink->name);CHKERRQ(ierr); 649f490541aSPeter Brune ierr = VecDestroy(&nlink->X);CHKERRQ(ierr); 650f490541aSPeter Brune ierr = PetscFree(nlink);CHKERRQ(ierr); 651f490541aSPeter Brune } 6522348bcf4SPeter Brune 653b17ce1afSJed Brown /* Destroy the list of hooks */ 654c833c3b5SJed Brown { 655c833c3b5SJed Brown DMCoarsenHookLink link,next; 656b17ce1afSJed Brown for (link=(*dm)->coarsenhook; link; link=next) { 657b17ce1afSJed Brown next = link->next; 658b17ce1afSJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 659b17ce1afSJed Brown } 6600298fd71SBarry Smith (*dm)->coarsenhook = NULL; 661c833c3b5SJed Brown } 662c833c3b5SJed Brown { 663c833c3b5SJed Brown DMRefineHookLink link,next; 664c833c3b5SJed Brown for (link=(*dm)->refinehook; link; link=next) { 665c833c3b5SJed Brown next = link->next; 666c833c3b5SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 667c833c3b5SJed Brown } 6680298fd71SBarry Smith (*dm)->refinehook = NULL; 669c833c3b5SJed Brown } 670be081cd6SPeter Brune { 671be081cd6SPeter Brune DMSubDomainHookLink link,next; 672be081cd6SPeter Brune for (link=(*dm)->subdomainhook; link; link=next) { 673be081cd6SPeter Brune next = link->next; 674be081cd6SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 675be081cd6SPeter Brune } 6760298fd71SBarry Smith (*dm)->subdomainhook = NULL; 677be081cd6SPeter Brune } 678baf369e7SPeter Brune { 679baf369e7SPeter Brune DMGlobalToLocalHookLink link,next; 680baf369e7SPeter Brune for (link=(*dm)->gtolhook; link; link=next) { 681baf369e7SPeter Brune next = link->next; 682baf369e7SPeter Brune ierr = PetscFree(link);CHKERRQ(ierr); 683baf369e7SPeter Brune } 6840298fd71SBarry Smith (*dm)->gtolhook = NULL; 685baf369e7SPeter Brune } 686d4d07f1eSToby Isaac { 687d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,next; 688d4d07f1eSToby Isaac for (link=(*dm)->ltoghook; link; link=next) { 689d4d07f1eSToby Isaac next = link->next; 690d4d07f1eSToby Isaac ierr = PetscFree(link);CHKERRQ(ierr); 691d4d07f1eSToby Isaac } 692d4d07f1eSToby Isaac (*dm)->ltoghook = NULL; 693d4d07f1eSToby Isaac } 694aa1993deSMatthew G Knepley /* Destroy the work arrays */ 695aa1993deSMatthew G Knepley { 696aa1993deSMatthew G Knepley DMWorkLink link,next; 6972c71b3e2SJacob Faibussowitsch PetscCheckFalse((*dm)->workout,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out"); 698aa1993deSMatthew G Knepley for (link=(*dm)->workin; link; link=next) { 699aa1993deSMatthew G Knepley next = link->next; 700aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 701aa1993deSMatthew G Knepley ierr = PetscFree(link);CHKERRQ(ierr); 702aa1993deSMatthew G Knepley } 7030298fd71SBarry Smith (*dm)->workin = NULL; 704aa1993deSMatthew G Knepley } 705c58f1c22SToby Isaac /* destroy the labels */ 706f4cdcedcSVaclav Hapla ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr); 707f4cdcedcSVaclav Hapla /* destroy the fields */ 708e5e52638SMatthew G. Knepley ierr = DMClearFields(*dm);CHKERRQ(ierr); 709f4cdcedcSVaclav Hapla /* destroy the boundaries */ 710e6f8dbb6SToby Isaac { 711e6f8dbb6SToby Isaac DMBoundary next = (*dm)->boundary; 712e6f8dbb6SToby Isaac while (next) { 713e6f8dbb6SToby Isaac DMBoundary b = next; 714e6f8dbb6SToby Isaac 715e6f8dbb6SToby Isaac next = b->next; 716e6f8dbb6SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 717e6f8dbb6SToby Isaac } 718e6f8dbb6SToby Isaac } 719b17ce1afSJed Brown 72052536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr); 72152536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr); 72252536dc3SBarry Smith ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr); 72352536dc3SBarry Smith 7241a266240SBarry Smith if ((*dm)->ctx && (*dm)->ctxdestroy) { 7251a266240SBarry Smith ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr); 7261a266240SBarry Smith } 72771cd77b2SBarry Smith ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr); 7286bf464f9SBarry Smith ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr); 7296bf464f9SBarry Smith ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr); 730073dac72SJed Brown ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr); 73188ed4aceSMatthew G Knepley 7321bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr); 7331bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr); 7348b1ab98fSJed Brown ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr); 7353b8ba7d1SJed Brown ierr = PetscSectionDestroy(&(*dm)->defaultConstraint.section);CHKERRQ(ierr); 7363b8ba7d1SJed Brown ierr = MatDestroy(&(*dm)->defaultConstraint.mat);CHKERRQ(ierr); 73788ed4aceSMatthew G Knepley ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr); 7381bb6d2a8SBarry Smith ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr); 739736995cdSBlaise Bourdin if ((*dm)->useNatural) { 740736995cdSBlaise Bourdin if ((*dm)->sfNatural) { 7418e4ac7eaSMatthew G. Knepley ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr); 742736995cdSBlaise Bourdin } 743736995cdSBlaise Bourdin ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr); 744736995cdSBlaise Bourdin } 7459a2a23afSMatthew G. Knepley { 7469a2a23afSMatthew G. Knepley Vec *auxData; 7479a2a23afSMatthew G. Knepley PetscInt n, i, off = 0; 7489a2a23afSMatthew G. Knepley 7499a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetSize((*dm)->auxData, &n);CHKERRQ(ierr); 7509a2a23afSMatthew G. Knepley ierr = PetscMalloc1(n, &auxData);CHKERRQ(ierr); 7519a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetVals((*dm)->auxData, &off, auxData);CHKERRQ(ierr); 7529a2a23afSMatthew G. Knepley for (i = 0; i < n; ++i) {ierr = VecDestroy(&auxData[i]);CHKERRQ(ierr);} 7539a2a23afSMatthew G. Knepley ierr = PetscFree(auxData);CHKERRQ(ierr); 7549a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDestroy(&(*dm)->auxData);CHKERRQ(ierr); 7559a2a23afSMatthew G. Knepley } 75688bdff64SToby Isaac if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) { 75788bdff64SToby Isaac ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr); 75888bdff64SToby Isaac } 7596eb26441SStefano Zampini 760a8fb8f29SToby Isaac ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr); 76188bdff64SToby Isaac if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) { 76288bdff64SToby Isaac ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr); 76388bdff64SToby Isaac } 76488bdff64SToby Isaac ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr); 765f19dbd58SToby Isaac ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr); 7666636e97aSMatthew G Knepley ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr); 7676636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr); 7686636e97aSMatthew G Knepley ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr); 769412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->L);CHKERRQ(ierr); 770412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->maxCell);CHKERRQ(ierr); 771412e9a14SMatthew G. Knepley ierr = PetscFree((*dm)->bdtype);CHKERRQ(ierr); 772ca3d3a14SMatthew G. Knepley if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);} 773ca3d3a14SMatthew G. Knepley ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr); 774ca3d3a14SMatthew G. Knepley ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr); 7756636e97aSMatthew G Knepley 776e5e52638SMatthew G. Knepley ierr = DMClearDS(*dm);CHKERRQ(ierr); 77714f150ffSMatthew G. Knepley ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr); 778e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 779e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr); 780732e2eb9SMatthew G Knepley 781ed3c66a1SDave May if ((*dm)->ops->destroy) { 7826bf464f9SBarry Smith ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr); 783ed3c66a1SDave May } 784c0f0dcc3SMatthew G. Knepley ierr = DMMonitorCancel(*dm);CHKERRQ(ierr); 785f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 786a2c9b50fSJeremy L Thompson ierr = CeedElemRestrictionDestroy(&(*dm)->ceedERestrict);CHKERRQ_CEED(ierr); 787a2c9b50fSJeremy L Thompson ierr = CeedDestroy(&(*dm)->ceed);CHKERRQ_CEED(ierr); 788f918ec44SMatthew G. Knepley #endif 789435a35e8SMatthew G Knepley /* We do not destroy (*dm)->data here so that we can reference count backend objects */ 790732e2eb9SMatthew G Knepley ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr); 79147c6ae99SBarry Smith PetscFunctionReturn(0); 79247c6ae99SBarry Smith } 79347c6ae99SBarry Smith 794d7bf68aeSBarry Smith /*@ 795d7bf68aeSBarry Smith DMSetUp - sets up the data structures inside a DM object 796d7bf68aeSBarry Smith 797d083f849SBarry Smith Collective on dm 798d7bf68aeSBarry Smith 799d7bf68aeSBarry Smith Input Parameter: 800d7bf68aeSBarry Smith . dm - the DM object to setup 801d7bf68aeSBarry Smith 802d7bf68aeSBarry Smith Level: developer 803d7bf68aeSBarry Smith 804e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 805d7bf68aeSBarry Smith 806d7bf68aeSBarry Smith @*/ 8077087cfbeSBarry Smith PetscErrorCode DMSetUp(DM dm) 808d7bf68aeSBarry Smith { 809d7bf68aeSBarry Smith PetscErrorCode ierr; 810d7bf68aeSBarry Smith 811d7bf68aeSBarry Smith PetscFunctionBegin; 812171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 8138387afaaSJed Brown if (dm->setupcalled) PetscFunctionReturn(0); 814d7bf68aeSBarry Smith if (dm->ops->setup) { 815d7bf68aeSBarry Smith ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr); 816d7bf68aeSBarry Smith } 8178387afaaSJed Brown dm->setupcalled = PETSC_TRUE; 818d7bf68aeSBarry Smith PetscFunctionReturn(0); 819d7bf68aeSBarry Smith } 820d7bf68aeSBarry Smith 821d7bf68aeSBarry Smith /*@ 822d7bf68aeSBarry Smith DMSetFromOptions - sets parameters in a DM from the options database 823d7bf68aeSBarry Smith 824d083f849SBarry Smith Collective on dm 825d7bf68aeSBarry Smith 826d7bf68aeSBarry Smith Input Parameter: 827d7bf68aeSBarry Smith . dm - the DM object to set options for 828d7bf68aeSBarry Smith 829732e2eb9SMatthew G Knepley Options Database: 8304164ae61SDominic Meiser + -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 8314164ae61SDominic Meiser . -dm_vec_type <type> - type of vector to create inside DM 8324164ae61SDominic Meiser . -dm_mat_type <type> - type of matrix to create inside DM 833a4ea9b21SRichard Tran Mills . -dm_is_coloring_type - <global or local> 834a4ea9b21SRichard Tran Mills - -dm_bind_below <n> - bind (force execution on CPU) for Vec and Mat objects with local size (number of vector entries or matrix rows) below n; currently only supported for DMDA 835732e2eb9SMatthew G Knepley 8369318fe57SMatthew G. Knepley DMPLEX Specific creation options 8379318fe57SMatthew G. Knepley + -dm_plex_filename <str> - File containing a mesh 8389318fe57SMatthew G. Knepley . -dm_plex_boundary_filename <str> - File containing a mesh boundary 839cd7e8a5eSksagiyam . -dm_plex_name <str> - Name of the mesh in the file 8409318fe57SMatthew G. Knepley . -dm_plex_shape <shape> - The domain shape, such as DM_SHAPE_BOX, DM_SHAPE_SPHERE, etc. 8419318fe57SMatthew G. Knepley . -dm_plex_cell <ct> - Cell shape 8429318fe57SMatthew G. Knepley . -dm_plex_reference_cell_domain <bool> - Use a reference cell domain 8439318fe57SMatthew G. Knepley . -dm_plex_dim <dim> - Set the topological dimension 8449318fe57SMatthew G. Knepley . -dm_plex_simplex <bool> - PETSC_TRUE for simplex elements, PETSC_FALSE for tensor elements 8459318fe57SMatthew G. Knepley . -dm_plex_interpolate <bool> - PETSC_TRUE turns on topological interpolation (creating edges and faces) 8469318fe57SMatthew G. Knepley . -dm_plex_scale <sc> - Scale factor for mesh coordinates 8479318fe57SMatthew G. Knepley . -dm_plex_box_faces <m,n,p> - Number of faces along each dimension 8489318fe57SMatthew G. Knepley . -dm_plex_box_lower <x,y,z> - Specify lower-left-bottom coordinates for the box 8499318fe57SMatthew G. Knepley . -dm_plex_box_upper <x,y,z> - Specify upper-right-top coordinates for the box 8509318fe57SMatthew G. Knepley . -dm_plex_box_bd <bx,by,bz> - Specify the DMBoundaryType for each direction 8519318fe57SMatthew G. Knepley . -dm_plex_sphere_radius <r> - The sphere radius 8529318fe57SMatthew G. Knepley . -dm_plex_ball_radius <r> - Radius of the ball 8539318fe57SMatthew G. Knepley . -dm_plex_cylinder_bd <bz> - Boundary type in the z direction 8549318fe57SMatthew G. Knepley . -dm_plex_cylinder_num_wedges <n> - Number of wedges around the cylinder 855bdf63967SMatthew G. Knepley . -dm_plex_reorder <order> - Reorder the mesh using the specified algorithm 8569318fe57SMatthew G. Knepley . -dm_refine_pre <n> - The number of refinements before distribution 8579318fe57SMatthew G. Knepley . -dm_refine_uniform_pre <bool> - Flag for uniform refinement before distribution 8589318fe57SMatthew G. Knepley . -dm_refine_volume_limit_pre <v> - The maximum cell volume after refinement before distribution 8599318fe57SMatthew G. Knepley . -dm_refine <n> - The number of refinements after distribution 860bdf63967SMatthew G. Knepley . -dm_extrude <l> - Activate extrusion and specify the number of layers to extrude 861d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thickness <t> - The total thickness of extruded layers 862d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_use_tensor <bool> - Use tensor cells when extruding 863d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_symmetric <bool> - Extrude layers symmetrically about the surface 864d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_normal <n0,...,nd> - Specify the extrusion direction 865d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thicknesses <t0,...,tl> - Specify thickness of each layer 866909dfd52SMatthew G. Knepley . -dm_plex_create_fv_ghost_cells - Flag to create finite volume ghost cells on the boundary 867909dfd52SMatthew G. Knepley . -dm_plex_fv_ghost_cells_label <name> - Label name for ghost cells boundary 8689318fe57SMatthew G. Knepley . -dm_distribute <bool> - Flag to redistribute a mesh among processes 8699318fe57SMatthew G. Knepley . -dm_distribute_overlap <n> - The size of the overlap halo 8709318fe57SMatthew G. Knepley . -dm_plex_adj_cone <bool> - Set adjacency direction 8719318fe57SMatthew G. Knepley - -dm_plex_adj_closure <bool> - Set adjacency size 8729318fe57SMatthew G. Knepley 873384a6580SVaclav Hapla DMPLEX Specific Checks 874384a6580SVaclav Hapla + -dm_plex_check_symmetry - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry() 875384a6580SVaclav Hapla . -dm_plex_check_skeleton - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton() 876384a6580SVaclav 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() 877384a6580SVaclav Hapla . -dm_plex_check_geometry - Check that cells have positive volume - DMPlexCheckGeometry() 878384a6580SVaclav Hapla . -dm_plex_check_pointsf - Check some necessary conditions for PointSF - DMPlexCheckPointSF() 879384a6580SVaclav Hapla . -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones() 880384a6580SVaclav Hapla - -dm_plex_check_all - Perform all the checks above 881d7bf68aeSBarry Smith 88295eb5ee5SVaclav Hapla Level: intermediate 88395eb5ee5SVaclav Hapla 88495eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), 88595eb5ee5SVaclav Hapla DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones() 886d7bf68aeSBarry Smith 887d7bf68aeSBarry Smith @*/ 8887087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm) 889d7bf68aeSBarry Smith { 8907781c08eSBarry Smith char typeName[256]; 891ca266f36SBarry Smith PetscBool flg; 892d7bf68aeSBarry Smith PetscErrorCode ierr; 893d7bf68aeSBarry Smith 894d7bf68aeSBarry Smith PetscFunctionBegin; 895171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 89649be4549SMatthew G. Knepley dm->setfromoptionscalled = PETSC_TRUE; 89749be4549SMatthew G. Knepley if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);} 8981bb6d2a8SBarry Smith if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);} 8993194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr); 9000298fd71SBarry 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); 901a264d7a6SBarry Smith ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr); 902f9ba7244SBarry Smith if (flg) { 903f9ba7244SBarry Smith ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr); 904f9ba7244SBarry Smith } 905a264d7a6SBarry 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); 906073dac72SJed Brown if (flg) { 907521d9a4cSLisandro Dalcin ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr); 908073dac72SJed Brown } 9098f1509bcSBarry Smith ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr); 910a4ea9b21SRichard Tran Mills ierr = PetscOptionsInt("-dm_bind_below","Set the size threshold (in entries) below which the Vec is bound to the CPU","VecBindToCPU",dm->bind_below,&dm->bind_below,&flg);CHKERRQ(ierr); 911f9ba7244SBarry Smith if (dm->ops->setfromoptions) { 912e55864a3SBarry Smith ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr); 913f9ba7244SBarry Smith } 914f9ba7244SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 9150633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr); 91682fcb398SMatthew G Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 917d7bf68aeSBarry Smith PetscFunctionReturn(0); 918d7bf68aeSBarry Smith } 919d7bf68aeSBarry Smith 920fc9bc008SSatish Balay /*@C 921fe2efc57SMark DMViewFromOptions - View from Options 922fe2efc57SMark 923fe2efc57SMark Collective on DM 924fe2efc57SMark 925fe2efc57SMark Input Parameters: 926fe2efc57SMark + dm - the DM object 927736c3998SJose E. Roman . obj - Optional object 928736c3998SJose E. Roman - name - command line option 929fe2efc57SMark 930fe2efc57SMark Level: intermediate 931fe2efc57SMark .seealso: DM, DMView, PetscObjectViewFromOptions(), DMCreate() 932fe2efc57SMark @*/ 933fe2efc57SMark PetscErrorCode DMViewFromOptions(DM dm,PetscObject obj,const char name[]) 934fe2efc57SMark { 935fe2efc57SMark PetscErrorCode ierr; 936fe2efc57SMark 937fe2efc57SMark PetscFunctionBegin; 938fe2efc57SMark PetscValidHeaderSpecific(dm,DM_CLASSID,1); 939fe2efc57SMark ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr); 940fe2efc57SMark PetscFunctionReturn(0); 941fe2efc57SMark } 942fe2efc57SMark 943fe2efc57SMark /*@C 944224748a4SBarry Smith DMView - Views a DM 94547c6ae99SBarry Smith 946d083f849SBarry Smith Collective on dm 94747c6ae99SBarry Smith 948d8d19677SJose E. Roman Input Parameters: 94947c6ae99SBarry Smith + dm - the DM object to view 95047c6ae99SBarry Smith - v - the viewer 95147c6ae99SBarry Smith 952cd7e8a5eSksagiyam Notes: 953cd7e8a5eSksagiyam Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex 954cd7e8a5eSksagiyam meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName() 955cd7e8a5eSksagiyam before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object. 956cd7e8a5eSksagiyam 957224748a4SBarry Smith Level: beginner 95847c6ae99SBarry Smith 959cd7e8a5eSksagiyam .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMLoad(), PetscObjectSetName() 96047c6ae99SBarry Smith 96147c6ae99SBarry Smith @*/ 9627087cfbeSBarry Smith PetscErrorCode DMView(DM dm,PetscViewer v) 96347c6ae99SBarry Smith { 96447c6ae99SBarry Smith PetscErrorCode ierr; 96532c0f0efSBarry Smith PetscBool isbinary; 96676a8abe0SBarry Smith PetscMPIInt size; 96776a8abe0SBarry Smith PetscViewerFormat format; 96847c6ae99SBarry Smith 96947c6ae99SBarry Smith PetscFunctionBegin; 970171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9713014e516SBarry Smith if (!v) { 972ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr); 9733014e516SBarry Smith } 974b1b135c8SBarry Smith PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2); 97574903a4fSStefano Zampini /* Ideally, we would like to have this test on. 97674903a4fSStefano Zampini However, it currently breaks socket viz via GLVis. 97774903a4fSStefano Zampini During DMView(parallel_mesh,glvis_viewer), each 97874903a4fSStefano Zampini process opens a sequential ASCII socket to visualize 97974903a4fSStefano Zampini the local mesh, and PetscObjectView(dm,local_socket) 98074903a4fSStefano Zampini is internally called inside VecView_GLVis, incurring 98174903a4fSStefano Zampini in an error here */ 98274903a4fSStefano Zampini /* PetscCheckSameComm(dm,1,v,2); */ 9838bfd1ab9SVaclav Hapla ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr); 984b1b135c8SBarry Smith 98576a8abe0SBarry Smith ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr); 986ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRMPI(ierr); 98776a8abe0SBarry Smith if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0); 98898c3331eSBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr); 98932c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 99032c0f0efSBarry Smith if (isbinary) { 99155849f57SBarry Smith PetscInt classid = DM_FILE_CLASSID; 99232c0f0efSBarry Smith char type[256]; 99332c0f0efSBarry Smith 994f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr); 99532c0f0efSBarry Smith ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr); 996f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr); 99732c0f0efSBarry Smith } 9980c010503SBarry Smith if (dm->ops->view) { 9990c010503SBarry Smith ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr); 100047c6ae99SBarry Smith } 100147c6ae99SBarry Smith PetscFunctionReturn(0); 100247c6ae99SBarry Smith } 100347c6ae99SBarry Smith 100447c6ae99SBarry Smith /*@ 10058472ad0fSDave May DMCreateGlobalVector - Creates a global vector from a DM object 100647c6ae99SBarry Smith 1007d083f849SBarry Smith Collective on dm 100847c6ae99SBarry Smith 100947c6ae99SBarry Smith Input Parameter: 101047c6ae99SBarry Smith . dm - the DM object 101147c6ae99SBarry Smith 101247c6ae99SBarry Smith Output Parameter: 101347c6ae99SBarry Smith . vec - the global vector 101447c6ae99SBarry Smith 1015073dac72SJed Brown Level: beginner 101647c6ae99SBarry Smith 1017ec075b9fSPatrick Sanan .seealso DMCreateLocalVector(), DMGetGlobalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 101847c6ae99SBarry Smith 101947c6ae99SBarry Smith @*/ 10207087cfbeSBarry Smith PetscErrorCode DMCreateGlobalVector(DM dm,Vec *vec) 102147c6ae99SBarry Smith { 102247c6ae99SBarry Smith PetscErrorCode ierr; 102347c6ae99SBarry Smith 102447c6ae99SBarry Smith PetscFunctionBegin; 1025171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1026b9d85ea2SLisandro Dalcin PetscValidPointer(vec,2); 10272c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createglobalvector,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name); 102847c6ae99SBarry Smith ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr); 102976bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1030c6b011d8SStefano Zampini DM vdm; 1031c6b011d8SStefano Zampini 1032c6b011d8SStefano Zampini ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr); 10332c71b3e2SJacob Faibussowitsch PetscCheckFalse(!vdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector",((PetscObject)dm)->type_name); 1034c6b011d8SStefano Zampini } 103547c6ae99SBarry Smith PetscFunctionReturn(0); 103647c6ae99SBarry Smith } 103747c6ae99SBarry Smith 103847c6ae99SBarry Smith /*@ 10398472ad0fSDave May DMCreateLocalVector - Creates a local vector from a DM object 104047c6ae99SBarry Smith 104147c6ae99SBarry Smith Not Collective 104247c6ae99SBarry Smith 104347c6ae99SBarry Smith Input Parameter: 104447c6ae99SBarry Smith . dm - the DM object 104547c6ae99SBarry Smith 104647c6ae99SBarry Smith Output Parameter: 104747c6ae99SBarry Smith . vec - the local vector 104847c6ae99SBarry Smith 1049073dac72SJed Brown Level: beginner 105047c6ae99SBarry Smith 1051ec075b9fSPatrick Sanan .seealso DMCreateGlobalVector(), DMGetLocalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 105247c6ae99SBarry Smith 105347c6ae99SBarry Smith @*/ 10547087cfbeSBarry Smith PetscErrorCode DMCreateLocalVector(DM dm,Vec *vec) 105547c6ae99SBarry Smith { 105647c6ae99SBarry Smith PetscErrorCode ierr; 105747c6ae99SBarry Smith 105847c6ae99SBarry Smith PetscFunctionBegin; 1059171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1060b9d85ea2SLisandro Dalcin PetscValidPointer(vec,2); 10612c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createlocalvector,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name); 106247c6ae99SBarry Smith ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr); 106376bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1064c6b011d8SStefano Zampini DM vdm; 1065c6b011d8SStefano Zampini 1066c6b011d8SStefano Zampini ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr); 10672c71b3e2SJacob Faibussowitsch PetscCheckFalse(!vdm,PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector",((PetscObject)dm)->type_name); 1068c6b011d8SStefano Zampini } 106947c6ae99SBarry Smith PetscFunctionReturn(0); 107047c6ae99SBarry Smith } 107147c6ae99SBarry Smith 10721411c6eeSJed Brown /*@ 10731411c6eeSJed Brown DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM. 10741411c6eeSJed Brown 1075d083f849SBarry Smith Collective on dm 10761411c6eeSJed Brown 10771411c6eeSJed Brown Input Parameter: 10781411c6eeSJed Brown . dm - the DM that provides the mapping 10791411c6eeSJed Brown 10801411c6eeSJed Brown Output Parameter: 10811411c6eeSJed Brown . ltog - the mapping 10821411c6eeSJed Brown 10831411c6eeSJed Brown Level: intermediate 10841411c6eeSJed Brown 10851411c6eeSJed Brown Notes: 10861411c6eeSJed Brown This mapping can then be used by VecSetLocalToGlobalMapping() or 10871411c6eeSJed Brown MatSetLocalToGlobalMapping(). 10881411c6eeSJed Brown 1089fc31e74dSBarry Smith .seealso: DMCreateLocalVector() 10901411c6eeSJed Brown @*/ 10917087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog) 10921411c6eeSJed Brown { 10930be3e97aSMatthew G. Knepley PetscInt bs = -1, bsLocal[2], bsMinMax[2]; 10941411c6eeSJed Brown PetscErrorCode ierr; 10951411c6eeSJed Brown 10961411c6eeSJed Brown PetscFunctionBegin; 10971411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 10981411c6eeSJed Brown PetscValidPointer(ltog,2); 10991411c6eeSJed Brown if (!dm->ltogmap) { 110037d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 110137d0c07bSMatthew G Knepley 110292fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 110337d0c07bSMatthew G Knepley if (section) { 1104a974ec88SMatthew G. Knepley const PetscInt *cdofs; 110537d0c07bSMatthew G Knepley PetscInt *ltog; 1106ccf3bd66SMatthew G. Knepley PetscInt pStart, pEnd, n, p, k, l; 110737d0c07bSMatthew G Knepley 1108e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 110937d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 1110ccf3bd66SMatthew G. Knepley ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr); 1111ccf3bd66SMatthew G. Knepley ierr = PetscMalloc1(n, <og);CHKERRQ(ierr); /* We want the local+overlap size */ 111237d0c07bSMatthew G Knepley for (p = pStart, l = 0; p < pEnd; ++p) { 1113e6befd46SJed Brown PetscInt bdof, cdof, dof, off, c, cind; 111437d0c07bSMatthew G Knepley 111537d0c07bSMatthew G Knepley /* Should probably use constrained dofs */ 111637d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr); 1117a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr); 1118a974ec88SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr); 111937d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr); 11201a7dc684SMatthew G. Knepley /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */ 11211a7dc684SMatthew G. Knepley bdof = cdof && (dof-cdof) ? 1 : dof; 11221a7dc684SMatthew G. Knepley if (dof) { 11235b8243e1SJed Brown bs = bs < 0 ? bdof : PetscGCD(bs, bdof); 11241a7dc684SMatthew G. Knepley } 11255227eafbSStefano Zampini 1126e6befd46SJed Brown for (c = 0, cind = 0; c < dof; ++c, ++l) { 11275227eafbSStefano Zampini if (cind < cdof && c == cdofs[cind]) { 1128e6befd46SJed Brown ltog[l] = off < 0 ? off-c : -(off+c+1); 1129e6befd46SJed Brown cind++; 1130e6befd46SJed Brown } else { 11315227eafbSStefano Zampini ltog[l] = (off < 0 ? -(off+1) : off) + c - cind; 1132e6befd46SJed Brown } 113337d0c07bSMatthew G Knepley } 113437d0c07bSMatthew G Knepley } 1135bff27382SMatthew G. Knepley /* Must have same blocksize on all procs (some might have no points) */ 11360be3e97aSMatthew G. Knepley bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs; 11370be3e97aSMatthew G. Knepley ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr); 11380be3e97aSMatthew G. Knepley if (bsMinMax[0] != bsMinMax[1]) {bs = 1;} 11390be3e97aSMatthew G. Knepley else {bs = bsMinMax[0];} 11407591dbb2SMatthew G. Knepley bs = bs < 0 ? 1 : bs; 11417591dbb2SMatthew G. Knepley /* Must reduce indices by blocksize */ 1142ccf3bd66SMatthew G. Knepley if (bs > 1) { 1143ca469d19SJed Brown for (l = 0, k = 0; l < n; l += bs, ++k) { 1144ca469d19SJed Brown // Integer division of negative values truncates toward zero(!), not toward negative infinity 1145ca469d19SJed Brown ltog[k] = ltog[l] >= 0 ? ltog[l]/bs : -(-(ltog[l]+1)/bs + 1); 1146ca469d19SJed Brown } 1147ccf3bd66SMatthew G. Knepley n /= bs; 1148ccf3bd66SMatthew G. Knepley } 1149ccf3bd66SMatthew G. Knepley ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr); 11503bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr); 115137d0c07bSMatthew G Knepley } else { 11522c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->getlocaltoglobalmapping,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name); 1153184d77edSJed Brown ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr); 11541411c6eeSJed Brown } 115537d0c07bSMatthew G Knepley } 11561411c6eeSJed Brown *ltog = dm->ltogmap; 11571411c6eeSJed Brown PetscFunctionReturn(0); 11581411c6eeSJed Brown } 11591411c6eeSJed Brown 11601411c6eeSJed Brown /*@ 11611411c6eeSJed Brown DMGetBlockSize - Gets the inherent block size associated with a DM 11621411c6eeSJed Brown 11631411c6eeSJed Brown Not Collective 11641411c6eeSJed Brown 11651411c6eeSJed Brown Input Parameter: 11661411c6eeSJed Brown . dm - the DM with block structure 11671411c6eeSJed Brown 11681411c6eeSJed Brown Output Parameter: 11691411c6eeSJed Brown . bs - the block size, 1 implies no exploitable block structure 11701411c6eeSJed Brown 11711411c6eeSJed Brown Level: intermediate 11721411c6eeSJed Brown 1173fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping() 11741411c6eeSJed Brown @*/ 11757087cfbeSBarry Smith PetscErrorCode DMGetBlockSize(DM dm,PetscInt *bs) 11761411c6eeSJed Brown { 11771411c6eeSJed Brown PetscFunctionBegin; 11781411c6eeSJed Brown PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1179534a8f05SLisandro Dalcin PetscValidIntPointer(bs,2); 11802c71b3e2SJacob Faibussowitsch PetscCheckFalse(dm->bs < 1,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet"); 11811411c6eeSJed Brown *bs = dm->bs; 11821411c6eeSJed Brown PetscFunctionReturn(0); 11831411c6eeSJed Brown } 11841411c6eeSJed Brown 118548eeb7c8SBarry Smith /*@C 11868472ad0fSDave May DMCreateInterpolation - Gets interpolation matrix between two DM objects 118747c6ae99SBarry Smith 1188a5bc1bf3SBarry Smith Collective on dmc 118947c6ae99SBarry Smith 1190d8d19677SJose E. Roman Input Parameters: 1191a5bc1bf3SBarry Smith + dmc - the DM object 1192a5bc1bf3SBarry Smith - dmf - the second, finer DM object 119347c6ae99SBarry Smith 1194d8d19677SJose E. Roman Output Parameters: 119547c6ae99SBarry Smith + mat - the interpolation 119647c6ae99SBarry Smith - vec - the scaling (optional) 119747c6ae99SBarry Smith 119847c6ae99SBarry Smith Level: developer 119947c6ae99SBarry Smith 120095452b02SPatrick Sanan Notes: 120195452b02SPatrick 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 120285afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 1203d52bd9f3SBarry Smith 12041f588964SMatthew G Knepley For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors 1205d52bd9f3SBarry Smith EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic. 120685afcc9aSBarry Smith 12072ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale() 120847c6ae99SBarry Smith 120947c6ae99SBarry Smith @*/ 1210a5bc1bf3SBarry Smith PetscErrorCode DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec) 121147c6ae99SBarry Smith { 121247c6ae99SBarry Smith PetscErrorCode ierr; 121347c6ae99SBarry Smith 121447c6ae99SBarry Smith PetscFunctionBegin; 1215a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 1216a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 1217c7d20fa0SStefano Zampini PetscValidPointer(mat,3); 12182c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dmc->ops->createinterpolation,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name); 1219a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr); 1220a5bc1bf3SBarry Smith ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr); 1221a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr); 122247c6ae99SBarry Smith PetscFunctionReturn(0); 122347c6ae99SBarry Smith } 122447c6ae99SBarry Smith 12253ad4599aSBarry Smith /*@ 1226d3e313eaSPatrick Sanan DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction. 12272ed6491fSPatrick Sanan 12282ed6491fSPatrick Sanan Input Parameters: 12292ed6491fSPatrick Sanan + dac - DM that defines a coarse mesh 12302ed6491fSPatrick Sanan . daf - DM that defines a fine mesh 12312ed6491fSPatrick Sanan - mat - the restriction (or interpolation operator) from fine to coarse 12322ed6491fSPatrick Sanan 12332ed6491fSPatrick Sanan Output Parameter: 12342ed6491fSPatrick Sanan . scale - the scaled vector 12352ed6491fSPatrick Sanan 12362ed6491fSPatrick Sanan Level: developer 12372ed6491fSPatrick Sanan 1238e9c74fd6SRichard Tran Mills Developer Notes: 1239e9c74fd6SRichard Tran Mills If the fine-scale DMDA has the -dm_bind_below option set to true, then DMCreateInterpolationScale() calls MatSetBindingPropagates() 1240e9c74fd6SRichard Tran Mills on the restriction/interpolation operator to set the bindingpropagates flag to true. 1241e9c74fd6SRichard Tran Mills 12422ed6491fSPatrick Sanan .seealso: DMCreateInterpolation() 12432ed6491fSPatrick Sanan 12442ed6491fSPatrick Sanan @*/ 12452ed6491fSPatrick Sanan PetscErrorCode DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale) 12462ed6491fSPatrick Sanan { 12472ed6491fSPatrick Sanan PetscErrorCode ierr; 12482ed6491fSPatrick Sanan Vec fine; 12492ed6491fSPatrick Sanan PetscScalar one = 1.0; 12509704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA) 1251e9c74fd6SRichard Tran Mills PetscBool bindingpropagates,isbound; 12529704db99SRichard Tran Mills #endif 12532ed6491fSPatrick Sanan 12542ed6491fSPatrick Sanan PetscFunctionBegin; 12552ed6491fSPatrick Sanan ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr); 12562ed6491fSPatrick Sanan ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr); 12572ed6491fSPatrick Sanan ierr = VecSet(fine,one);CHKERRQ(ierr); 12589704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA) 12599704db99SRichard Tran Mills /* If the 'fine' Vec is bound to the CPU, it makes sense to bind 'mat' as well. 12609704db99SRichard Tran Mills * Note that we only do this for the CUDA case, right now, but if we add support for MatMultTranspose() via ViennaCL, 12619704db99SRichard Tran Mills * we'll need to do it for that case, too.*/ 1262e9c74fd6SRichard Tran Mills ierr = VecGetBindingPropagates(fine,&bindingpropagates);CHKERRQ(ierr); 1263e9c74fd6SRichard Tran Mills if (bindingpropagates) { 1264b1538989SRichard Tran Mills ierr = MatSetBindingPropagates(mat,PETSC_TRUE);CHKERRQ(ierr); 1265e9c74fd6SRichard Tran Mills ierr = VecBoundToCPU(fine,&isbound);CHKERRQ(ierr); 1266e9c74fd6SRichard Tran Mills ierr = MatBindToCPU(mat,isbound);CHKERRQ(ierr); 126783aa49f4SRichard Tran Mills } 12689704db99SRichard Tran Mills #endif 12692ed6491fSPatrick Sanan ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr); 12702ed6491fSPatrick Sanan ierr = VecDestroy(&fine);CHKERRQ(ierr); 12712ed6491fSPatrick Sanan ierr = VecReciprocal(*scale);CHKERRQ(ierr); 12722ed6491fSPatrick Sanan PetscFunctionReturn(0); 12732ed6491fSPatrick Sanan } 12742ed6491fSPatrick Sanan 12752ed6491fSPatrick Sanan /*@ 12763ad4599aSBarry Smith DMCreateRestriction - Gets restriction matrix between two DM objects 12773ad4599aSBarry Smith 1278a5bc1bf3SBarry Smith Collective on dmc 12793ad4599aSBarry Smith 1280d8d19677SJose E. Roman Input Parameters: 1281a5bc1bf3SBarry Smith + dmc - the DM object 1282a5bc1bf3SBarry Smith - dmf - the second, finer DM object 12833ad4599aSBarry Smith 12843ad4599aSBarry Smith Output Parameter: 12853ad4599aSBarry Smith . mat - the restriction 12863ad4599aSBarry Smith 12873ad4599aSBarry Smith Level: developer 12883ad4599aSBarry Smith 128995452b02SPatrick Sanan Notes: 129095452b02SPatrick 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 12913ad4599aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation. 12923ad4599aSBarry Smith 12933ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation() 12943ad4599aSBarry Smith 12953ad4599aSBarry Smith @*/ 1296a5bc1bf3SBarry Smith PetscErrorCode DMCreateRestriction(DM dmc,DM dmf,Mat *mat) 12973ad4599aSBarry Smith { 12983ad4599aSBarry Smith PetscErrorCode ierr; 12993ad4599aSBarry Smith 13003ad4599aSBarry Smith PetscFunctionBegin; 1301a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmc,DM_CLASSID,1); 1302a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dmf,DM_CLASSID,2); 13035a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 13042c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dmc->ops->createrestriction,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name); 1305a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr); 1306a5bc1bf3SBarry Smith ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr); 1307a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr); 13083ad4599aSBarry Smith PetscFunctionReturn(0); 13093ad4599aSBarry Smith } 13103ad4599aSBarry Smith 131147c6ae99SBarry Smith /*@ 13128472ad0fSDave May DMCreateInjection - Gets injection matrix between two DM objects 131347c6ae99SBarry Smith 1314a5bc1bf3SBarry Smith Collective on dac 131547c6ae99SBarry Smith 1316d8d19677SJose E. Roman Input Parameters: 1317a5bc1bf3SBarry Smith + dac - the DM object 1318a5bc1bf3SBarry Smith - daf - the second, finer DM object 131947c6ae99SBarry Smith 132047c6ae99SBarry Smith Output Parameter: 13216dbf9973SLawrence Mitchell . mat - the injection 132247c6ae99SBarry Smith 132347c6ae99SBarry Smith Level: developer 132447c6ae99SBarry Smith 132595452b02SPatrick Sanan Notes: 132695452b02SPatrick 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 132785afcc9aSBarry Smith DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection. 132885afcc9aSBarry Smith 1329e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation() 133047c6ae99SBarry Smith 133147c6ae99SBarry Smith @*/ 1332a5bc1bf3SBarry Smith PetscErrorCode DMCreateInjection(DM dac,DM daf,Mat *mat) 133347c6ae99SBarry Smith { 133447c6ae99SBarry Smith PetscErrorCode ierr; 133547c6ae99SBarry Smith 133647c6ae99SBarry Smith PetscFunctionBegin; 1337a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dac,DM_CLASSID,1); 1338a5bc1bf3SBarry Smith PetscValidHeaderSpecific(daf,DM_CLASSID,2); 13395a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 13402c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dac->ops->createinjection,PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name); 1341a5bc1bf3SBarry Smith ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr); 1342a5bc1bf3SBarry Smith ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr); 1343a5bc1bf3SBarry Smith ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr); 134447c6ae99SBarry Smith PetscFunctionReturn(0); 134547c6ae99SBarry Smith } 134647c6ae99SBarry Smith 1347b412c318SBarry Smith /*@ 1348bd041c0cSMatthew G. Knepley DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j 1349bd041c0cSMatthew G. Knepley 1350a5bc1bf3SBarry Smith Collective on dac 1351bd041c0cSMatthew G. Knepley 1352d8d19677SJose E. Roman Input Parameters: 1353b4937a87SMatthew G. Knepley + dmc - the target DM object 1354b4937a87SMatthew G. Knepley - dmf - the source DM object 1355bd041c0cSMatthew G. Knepley 1356bd041c0cSMatthew G. Knepley Output Parameter: 1357b4937a87SMatthew G. Knepley . mat - the mass matrix 1358bd041c0cSMatthew G. Knepley 1359bd041c0cSMatthew G. Knepley Level: developer 1360bd041c0cSMatthew G. Knepley 1361b4937a87SMatthew G. Knepley .seealso DMCreateMassMatrixLumped(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection() 1362bd041c0cSMatthew G. Knepley @*/ 1363b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrix(DM dmc, DM dmf, Mat *mat) 1364bd041c0cSMatthew G. Knepley { 1365bd041c0cSMatthew G. Knepley PetscErrorCode ierr; 1366bd041c0cSMatthew G. Knepley 1367bd041c0cSMatthew G. Knepley PetscFunctionBegin; 1368b4937a87SMatthew G. Knepley PetscValidHeaderSpecific(dmc, DM_CLASSID, 1); 1369b4937a87SMatthew G. Knepley PetscValidHeaderSpecific(dmf, DM_CLASSID, 2); 13705a84ad33SLisandro Dalcin PetscValidPointer(mat,3); 13712c71b3e2SJacob Faibussowitsch PetscCheck(dmc->ops->createmassmatrix,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dmc)->type_name); 1372b4937a87SMatthew G. Knepley ierr = (*dmc->ops->createmassmatrix)(dmc, dmf, mat);CHKERRQ(ierr); 1373b4937a87SMatthew G. Knepley PetscFunctionReturn(0); 1374b4937a87SMatthew G. Knepley } 1375b4937a87SMatthew G. Knepley 1376b4937a87SMatthew G. Knepley /*@ 1377b4937a87SMatthew G. Knepley DMCreateMassMatrixLumped - Gets the lumped mass matrix for a given DM 1378b4937a87SMatthew G. Knepley 1379b4937a87SMatthew G. Knepley Collective on dm 1380b4937a87SMatthew G. Knepley 1381b4937a87SMatthew G. Knepley Input Parameter: 1382b4937a87SMatthew G. Knepley . dm - the DM object 1383b4937a87SMatthew G. Knepley 1384b4937a87SMatthew G. Knepley Output Parameter: 1385b4937a87SMatthew G. Knepley . lm - the lumped mass matrix 1386b4937a87SMatthew G. Knepley 1387b4937a87SMatthew G. Knepley Level: developer 1388b4937a87SMatthew G. Knepley 1389b4937a87SMatthew G. Knepley .seealso DMCreateMassMatrix(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection() 1390b4937a87SMatthew G. Knepley @*/ 1391b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrixLumped(DM dm, Vec *lm) 1392b4937a87SMatthew G. Knepley { 1393b4937a87SMatthew G. Knepley PetscErrorCode ierr; 1394b4937a87SMatthew G. Knepley 1395b4937a87SMatthew G. Knepley PetscFunctionBegin; 1396b4937a87SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1397b4937a87SMatthew G. Knepley PetscValidPointer(lm,2); 13982c71b3e2SJacob Faibussowitsch PetscCheck(dm->ops->createmassmatrixlumped,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrixLumped",((PetscObject)dm)->type_name); 1399b4937a87SMatthew G. Knepley ierr = (*dm->ops->createmassmatrixlumped)(dm, lm);CHKERRQ(ierr); 1400bd041c0cSMatthew G. Knepley PetscFunctionReturn(0); 1401bd041c0cSMatthew G. Knepley } 1402bd041c0cSMatthew G. Knepley 1403bd041c0cSMatthew G. Knepley /*@ 1404b412c318SBarry Smith DMCreateColoring - Gets coloring for a DM 140547c6ae99SBarry Smith 1406d083f849SBarry Smith Collective on dm 140747c6ae99SBarry Smith 1408d8d19677SJose E. Roman Input Parameters: 140947c6ae99SBarry Smith + dm - the DM object 14105bdb020cSBarry Smith - ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL 141147c6ae99SBarry Smith 141247c6ae99SBarry Smith Output Parameter: 141347c6ae99SBarry Smith . coloring - the coloring 141447c6ae99SBarry Smith 1415ec5066bdSBarry Smith Notes: 1416ec5066bdSBarry 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 1417ec5066bdSBarry Smith matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors). 1418ec5066bdSBarry Smith 1419ec5066bdSBarry Smith This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate() 1420ec5066bdSBarry Smith 142147c6ae99SBarry Smith Level: developer 142247c6ae99SBarry Smith 1423ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate() 142447c6ae99SBarry Smith 1425aab9d709SJed Brown @*/ 1426b412c318SBarry Smith PetscErrorCode DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring) 142747c6ae99SBarry Smith { 142847c6ae99SBarry Smith PetscErrorCode ierr; 142947c6ae99SBarry Smith 143047c6ae99SBarry Smith PetscFunctionBegin; 1431171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 14325a84ad33SLisandro Dalcin PetscValidPointer(coloring,3); 14332c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->getcoloring,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name); 1434b412c318SBarry Smith ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr); 143547c6ae99SBarry Smith PetscFunctionReturn(0); 143647c6ae99SBarry Smith } 143747c6ae99SBarry Smith 1438b412c318SBarry Smith /*@ 14398472ad0fSDave May DMCreateMatrix - Gets empty Jacobian for a DM 144047c6ae99SBarry Smith 1441d083f849SBarry Smith Collective on dm 144247c6ae99SBarry Smith 144347c6ae99SBarry Smith Input Parameter: 1444b412c318SBarry Smith . dm - the DM object 144547c6ae99SBarry Smith 144647c6ae99SBarry Smith Output Parameter: 144747c6ae99SBarry Smith . mat - the empty Jacobian 144847c6ae99SBarry Smith 1449073dac72SJed Brown Level: beginner 145047c6ae99SBarry Smith 1451f27dd7c6SMatthew G. Knepley Options Database Keys: 1452f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 1453f27dd7c6SMatthew G. Knepley 145495452b02SPatrick Sanan Notes: 145595452b02SPatrick Sanan This properly preallocates the number of nonzeros in the sparse matrix so you 145694013140SBarry Smith do not need to do it yourself. 145794013140SBarry Smith 145894013140SBarry Smith By default it also sets the nonzero structure and puts in the zero entries. To prevent setting 14597889ec69SBarry Smith the nonzero pattern call DMSetMatrixPreallocateOnly() 146094013140SBarry Smith 146194013140SBarry 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 146294013140SBarry Smith internally by PETSc. 146394013140SBarry Smith 146494013140SBarry Smith For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires 1465aa219208SBarry Smith the indices for the global numbering for DMDAs which is complicated. 146694013140SBarry Smith 1467b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType() 146847c6ae99SBarry Smith 1469aab9d709SJed Brown @*/ 1470b412c318SBarry Smith PetscErrorCode DMCreateMatrix(DM dm,Mat *mat) 147147c6ae99SBarry Smith { 147247c6ae99SBarry Smith PetscErrorCode ierr; 147347c6ae99SBarry Smith 147447c6ae99SBarry Smith PetscFunctionBegin; 1475171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1476064a246eSJacob Faibussowitsch PetscValidPointer(mat,2); 14772c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->creatematrix,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name); 14785a84ad33SLisandro Dalcin ierr = MatInitializePackage();CHKERRQ(ierr); 1479fdc842d1SBarry Smith ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 1480b412c318SBarry Smith ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr); 148176bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1482c6b011d8SStefano Zampini DM mdm; 1483c6b011d8SStefano Zampini 1484c6b011d8SStefano Zampini ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr); 14852c71b3e2SJacob Faibussowitsch PetscCheckFalse(!mdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix",((PetscObject)dm)->type_name); 1486c6b011d8SStefano Zampini } 1487e571a35bSMatthew G. Knepley /* Handle nullspace and near nullspace */ 1488e5e52638SMatthew G. Knepley if (dm->Nf) { 1489e571a35bSMatthew G. Knepley MatNullSpace nullSpace; 1490649ef022SMatthew Knepley PetscInt Nf, f; 1491e571a35bSMatthew G. Knepley 1492e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 1493649ef022SMatthew Knepley for (f = 0; f < Nf; ++f) { 1494649ef022SMatthew Knepley if (dm->nullspaceConstructors[f]) { 1495649ef022SMatthew Knepley ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr); 1496e571a35bSMatthew G. Knepley ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1497e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1498649ef022SMatthew Knepley break; 1499e571a35bSMatthew G. Knepley } 1500649ef022SMatthew Knepley } 1501649ef022SMatthew Knepley for (f = 0; f < Nf; ++f) { 1502649ef022SMatthew Knepley if (dm->nearnullspaceConstructors[f]) { 1503649ef022SMatthew Knepley ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr); 1504e571a35bSMatthew G. Knepley ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr); 1505e571a35bSMatthew G. Knepley ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr); 1506e571a35bSMatthew G. Knepley } 1507e571a35bSMatthew G. Knepley } 1508e571a35bSMatthew G. Knepley } 1509fdc842d1SBarry Smith ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr); 151047c6ae99SBarry Smith PetscFunctionReturn(0); 151147c6ae99SBarry Smith } 151247c6ae99SBarry Smith 1513732e2eb9SMatthew G Knepley /*@ 1514950540a4SJed Brown DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly 1515732e2eb9SMatthew G Knepley preallocated but the nonzero structure and zero values will not be set. 1516732e2eb9SMatthew G Knepley 1517d083f849SBarry Smith Logically Collective on dm 1518732e2eb9SMatthew G Knepley 1519d8d19677SJose E. Roman Input Parameters: 1520732e2eb9SMatthew G Knepley + dm - the DM 1521732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation 1522732e2eb9SMatthew G Knepley 1523732e2eb9SMatthew G Knepley Level: developer 1524f27dd7c6SMatthew G. Knepley 1525f27dd7c6SMatthew G. Knepley Options Database Keys: 1526f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros 1527f27dd7c6SMatthew G. Knepley 1528b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly() 1529732e2eb9SMatthew G Knepley @*/ 1530732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only) 1531732e2eb9SMatthew G Knepley { 1532732e2eb9SMatthew G Knepley PetscFunctionBegin; 1533732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1534732e2eb9SMatthew G Knepley dm->prealloc_only = only; 1535732e2eb9SMatthew G Knepley PetscFunctionReturn(0); 1536732e2eb9SMatthew G Knepley } 1537732e2eb9SMatthew G Knepley 1538b06ff27eSHong Zhang /*@ 1539b06ff27eSHong Zhang DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created 1540b06ff27eSHong Zhang but the array for values will not be allocated. 1541b06ff27eSHong Zhang 1542d083f849SBarry Smith Logically Collective on dm 1543b06ff27eSHong Zhang 1544d8d19677SJose E. Roman Input Parameters: 1545b06ff27eSHong Zhang + dm - the DM 1546b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture 1547b06ff27eSHong Zhang 1548b06ff27eSHong Zhang Level: developer 1549b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly() 1550b06ff27eSHong Zhang @*/ 1551b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only) 1552b06ff27eSHong Zhang { 1553b06ff27eSHong Zhang PetscFunctionBegin; 1554b06ff27eSHong Zhang PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1555b06ff27eSHong Zhang dm->structure_only = only; 1556b06ff27eSHong Zhang PetscFunctionReturn(0); 1557b06ff27eSHong Zhang } 1558b06ff27eSHong Zhang 1559a89ea682SMatthew G Knepley /*@C 1560aa1993deSMatthew G Knepley DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1561a89ea682SMatthew G Knepley 1562a89ea682SMatthew G Knepley Not Collective 1563a89ea682SMatthew G Knepley 1564a89ea682SMatthew G Knepley Input Parameters: 1565a89ea682SMatthew G Knepley + dm - the DM object 1566a5b23f4aSJose E. Roman . count - The minimum size 156769291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT) 1568a89ea682SMatthew G Knepley 1569a89ea682SMatthew G Knepley Output Parameter: 1570a89ea682SMatthew G Knepley . array - the work array 1571a89ea682SMatthew G Knepley 1572a89ea682SMatthew G Knepley Level: developer 1573a89ea682SMatthew G Knepley 1574a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate() 1575a89ea682SMatthew G Knepley @*/ 157669291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1577a89ea682SMatthew G Knepley { 1578a89ea682SMatthew G Knepley PetscErrorCode ierr; 1579aa1993deSMatthew G Knepley DMWorkLink link; 158069291d52SBarry Smith PetscMPIInt dsize; 1581a89ea682SMatthew G Knepley 1582a89ea682SMatthew G Knepley PetscFunctionBegin; 1583a89ea682SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1584aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1585aa1993deSMatthew G Knepley if (dm->workin) { 1586aa1993deSMatthew G Knepley link = dm->workin; 1587aa1993deSMatthew G Knepley dm->workin = dm->workin->next; 1588aa1993deSMatthew G Knepley } else { 1589b00a9115SJed Brown ierr = PetscNewLog(dm,&link);CHKERRQ(ierr); 1590a89ea682SMatthew G Knepley } 1591ffc4695bSBarry Smith ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr); 15925056fcd2SBarry Smith if (((size_t)dsize*count) > link->bytes) { 1593aa1993deSMatthew G Knepley ierr = PetscFree(link->mem);CHKERRQ(ierr); 1594854ce69bSBarry Smith ierr = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr); 1595854ce69bSBarry Smith link->bytes = dsize*count; 1596aa1993deSMatthew G Knepley } 1597aa1993deSMatthew G Knepley link->next = dm->workout; 1598aa1993deSMatthew G Knepley dm->workout = link; 159900d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND) 160000d952a4SJed Brown VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count); 160100d952a4SJed Brown VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count); 160200d952a4SJed Brown #endif 1603aa1993deSMatthew G Knepley *(void**)mem = link->mem; 1604a89ea682SMatthew G Knepley PetscFunctionReturn(0); 1605a89ea682SMatthew G Knepley } 1606a89ea682SMatthew G Knepley 1607aa1993deSMatthew G Knepley /*@C 1608aa1993deSMatthew G Knepley DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray() 1609aa1993deSMatthew G Knepley 1610aa1993deSMatthew G Knepley Not Collective 1611aa1993deSMatthew G Knepley 1612aa1993deSMatthew G Knepley Input Parameters: 1613aa1993deSMatthew G Knepley + dm - the DM object 1614a5b23f4aSJose E. Roman . count - The minimum size 161569291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT 1616aa1993deSMatthew G Knepley 1617aa1993deSMatthew G Knepley Output Parameter: 1618aa1993deSMatthew G Knepley . array - the work array 1619aa1993deSMatthew G Knepley 1620aa1993deSMatthew G Knepley Level: developer 1621aa1993deSMatthew G Knepley 162295452b02SPatrick Sanan Developer Notes: 162395452b02SPatrick Sanan count and dtype are ignored, they are only needed for DMGetWorkArray() 1624*147403d9SBarry Smith 1625aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate() 1626aa1993deSMatthew G Knepley @*/ 162769291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem) 1628aa1993deSMatthew G Knepley { 1629aa1993deSMatthew G Knepley DMWorkLink *p,link; 1630aa1993deSMatthew G Knepley 1631aa1993deSMatthew G Knepley PetscFunctionBegin; 1632aa1993deSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 1633aa1993deSMatthew G Knepley PetscValidPointer(mem,4); 1634aa1993deSMatthew G Knepley for (p=&dm->workout; (link=*p); p=&link->next) { 1635aa1993deSMatthew G Knepley if (link->mem == *(void**)mem) { 1636aa1993deSMatthew G Knepley *p = link->next; 1637aa1993deSMatthew G Knepley link->next = dm->workin; 1638aa1993deSMatthew G Knepley dm->workin = link; 16390298fd71SBarry Smith *(void**)mem = NULL; 1640aa1993deSMatthew G Knepley PetscFunctionReturn(0); 1641aa1993deSMatthew G Knepley } 1642aa1993deSMatthew G Knepley } 1643aa1993deSMatthew G Knepley SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out"); 1644aa1993deSMatthew G Knepley } 1645e7c4fc90SDmitry Karpeev 16468cda7954SMatthew G. Knepley /*@C 1647*147403d9SBarry Smith DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field when function spaces are joined or split, such as in DMCreateSubDM() 16488cda7954SMatthew G. Knepley 16498cda7954SMatthew G. Knepley Logically collective on DM 16508cda7954SMatthew G. Knepley 16518cda7954SMatthew G. Knepley Input Parameters: 16528cda7954SMatthew G. Knepley + dm - The DM 16538cda7954SMatthew G. Knepley . field - The field number for the nullspace 16548cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace 16558cda7954SMatthew G. Knepley 1656*147403d9SBarry Smith Calling sequence of nullsp: 1657*147403d9SBarry Smith .vb 1658*147403d9SBarry Smith PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 1659*147403d9SBarry Smith .ve 1660*147403d9SBarry Smith + dm - The present DM 1661*147403d9SBarry Smith . origField - The field number given above, in the original DM 1662*147403d9SBarry Smith . field - The field number in dm 1663*147403d9SBarry Smith - nullSpace - The nullspace for the given field 16648cda7954SMatthew G. Knepley 16658cda7954SMatthew G. Knepley This function is currently not available from Fortran. 16668cda7954SMatthew G. Knepley 16678cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 1668*147403d9SBarry Smith @*/ 1669*147403d9SBarry Smith PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM, PetscInt, PetscInt, MatNullSpace*)) 1670435a35e8SMatthew G Knepley { 1671435a35e8SMatthew G Knepley PetscFunctionBegin; 1672435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 16732c71b3e2SJacob Faibussowitsch PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1674435a35e8SMatthew G Knepley dm->nullspaceConstructors[field] = nullsp; 1675435a35e8SMatthew G Knepley PetscFunctionReturn(0); 1676435a35e8SMatthew G Knepley } 1677435a35e8SMatthew G Knepley 16788cda7954SMatthew G. Knepley /*@C 16798cda7954SMatthew G. Knepley DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL 16808cda7954SMatthew G. Knepley 16818cda7954SMatthew G. Knepley Not collective 16828cda7954SMatthew G. Knepley 16838cda7954SMatthew G. Knepley Input Parameters: 16848cda7954SMatthew G. Knepley + dm - The DM 16858cda7954SMatthew G. Knepley - field - The field number for the nullspace 16868cda7954SMatthew G. Knepley 16878cda7954SMatthew G. Knepley Output Parameter: 16888cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace 16898cda7954SMatthew G. Knepley 1690*147403d9SBarry Smith Calling sequence of nullsp: 1691*147403d9SBarry Smith .vb 1692*147403d9SBarry Smith PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 1693*147403d9SBarry Smith .ve 1694*147403d9SBarry Smith + dm - The present DM 1695*147403d9SBarry Smith . origField - The field number given above, in the original DM 1696*147403d9SBarry Smith . field - The field number in dm 1697*147403d9SBarry Smith - nullSpace - The nullspace for the given field 16988cda7954SMatthew G. Knepley 16998cda7954SMatthew G. Knepley This function is currently not available from Fortran. 17008cda7954SMatthew G. Knepley 17018cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 1702*147403d9SBarry Smith @*/ 1703*147403d9SBarry Smith PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM, PetscInt, PetscInt, MatNullSpace *)) 17040a50eb56SMatthew G. Knepley { 17050a50eb56SMatthew G. Knepley PetscFunctionBegin; 17060a50eb56SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1707f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 17082c71b3e2SJacob Faibussowitsch PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 17090a50eb56SMatthew G. Knepley *nullsp = dm->nullspaceConstructors[field]; 17100a50eb56SMatthew G. Knepley PetscFunctionReturn(0); 17110a50eb56SMatthew G. Knepley } 17120a50eb56SMatthew G. Knepley 17138cda7954SMatthew G. Knepley /*@C 17148cda7954SMatthew G. Knepley DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field 17158cda7954SMatthew G. Knepley 17168cda7954SMatthew G. Knepley Logically collective on DM 17178cda7954SMatthew G. Knepley 17188cda7954SMatthew G. Knepley Input Parameters: 17198cda7954SMatthew G. Knepley + dm - The DM 17208cda7954SMatthew G. Knepley . field - The field number for the nullspace 17218cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace 17228cda7954SMatthew G. Knepley 1723*147403d9SBarry Smith Calling sequence of nullsp: 1724*147403d9SBarry Smith .vb 1725*147403d9SBarry Smith PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 1726*147403d9SBarry Smith .ve 1727*147403d9SBarry Smith + dm - The present DM 1728*147403d9SBarry Smith . origField - The field number given above, in the original DM 1729*147403d9SBarry Smith . field - The field number in dm 1730*147403d9SBarry Smith - nullSpace - The nullspace for the given field 17318cda7954SMatthew G. Knepley 17328cda7954SMatthew G. Knepley This function is currently not available from Fortran. 17338cda7954SMatthew G. Knepley 17348cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 1735*147403d9SBarry Smith @*/ 1736*147403d9SBarry Smith PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM, PetscInt, PetscInt, MatNullSpace *)) 1737f9d4088aSMatthew G. Knepley { 1738f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1739f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 17402c71b3e2SJacob Faibussowitsch PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1741f9d4088aSMatthew G. Knepley dm->nearnullspaceConstructors[field] = nullsp; 1742f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1743f9d4088aSMatthew G. Knepley } 1744f9d4088aSMatthew G. Knepley 17458cda7954SMatthew G. Knepley /*@C 17468cda7954SMatthew G. Knepley DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL 17478cda7954SMatthew G. Knepley 17488cda7954SMatthew G. Knepley Not collective 17498cda7954SMatthew G. Knepley 17508cda7954SMatthew G. Knepley Input Parameters: 17518cda7954SMatthew G. Knepley + dm - The DM 17528cda7954SMatthew G. Knepley - field - The field number for the nullspace 17538cda7954SMatthew G. Knepley 17548cda7954SMatthew G. Knepley Output Parameter: 17558cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace 17568cda7954SMatthew G. Knepley 1757*147403d9SBarry Smith Calling sequence of nullsp: 1758*147403d9SBarry Smith .vb 1759*147403d9SBarry Smith PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace) 1760*147403d9SBarry Smith .ve 1761*147403d9SBarry Smith + dm - The present DM 1762*147403d9SBarry Smith . origField - The field number given above, in the original DM 1763*147403d9SBarry Smith . field - The field number in dm 1764*147403d9SBarry Smith - nullSpace - The nullspace for the given field 17658cda7954SMatthew G. Knepley 17668cda7954SMatthew G. Knepley This function is currently not available from Fortran. 17678cda7954SMatthew G. Knepley 17688cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM() 1769*147403d9SBarry Smith @*/ 1770*147403d9SBarry Smith PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM, PetscInt, PetscInt, MatNullSpace *)) 1771f9d4088aSMatthew G. Knepley { 1772f9d4088aSMatthew G. Knepley PetscFunctionBegin; 1773f9d4088aSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 1774f9d4088aSMatthew G. Knepley PetscValidPointer(nullsp, 3); 17752c71b3e2SJacob Faibussowitsch PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field); 1776f9d4088aSMatthew G. Knepley *nullsp = dm->nearnullspaceConstructors[field]; 1777f9d4088aSMatthew G. Knepley PetscFunctionReturn(0); 1778f9d4088aSMatthew G. Knepley } 1779f9d4088aSMatthew G. Knepley 17804f3b5142SJed Brown /*@C 17814d343eeaSMatthew G Knepley DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field 17824d343eeaSMatthew G Knepley 17834d343eeaSMatthew G Knepley Not collective 17844d343eeaSMatthew G Knepley 17854d343eeaSMatthew G Knepley Input Parameter: 17864d343eeaSMatthew G Knepley . dm - the DM object 17874d343eeaSMatthew G Knepley 17884d343eeaSMatthew G Knepley Output Parameters: 17890298fd71SBarry Smith + numFields - The number of fields (or NULL if not requested) 17900298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested) 17910298fd71SBarry Smith - fields - The global indices for each field (or NULL if not requested) 17924d343eeaSMatthew G Knepley 17934d343eeaSMatthew G Knepley Level: intermediate 17944d343eeaSMatthew G Knepley 179521c9b008SJed Brown Notes: 179621c9b008SJed Brown The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 179721c9b008SJed Brown PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with 179821c9b008SJed Brown PetscFree(). 179921c9b008SJed Brown 18004d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix() 18014d343eeaSMatthew G Knepley @*/ 180237d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields) 18034d343eeaSMatthew G Knepley { 180437d0c07bSMatthew G Knepley PetscSection section, sectionGlobal; 18054d343eeaSMatthew G Knepley PetscErrorCode ierr; 18064d343eeaSMatthew G Knepley 18074d343eeaSMatthew G Knepley PetscFunctionBegin; 18084d343eeaSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 180969ca1f37SDmitry Karpeev if (numFields) { 1810534a8f05SLisandro Dalcin PetscValidIntPointer(numFields,2); 181169ca1f37SDmitry Karpeev *numFields = 0; 181269ca1f37SDmitry Karpeev } 181337d0c07bSMatthew G Knepley if (fieldNames) { 181437d0c07bSMatthew G Knepley PetscValidPointer(fieldNames,3); 18150298fd71SBarry Smith *fieldNames = NULL; 181669ca1f37SDmitry Karpeev } 181769ca1f37SDmitry Karpeev if (fields) { 181869ca1f37SDmitry Karpeev PetscValidPointer(fields,4); 18190298fd71SBarry Smith *fields = NULL; 182069ca1f37SDmitry Karpeev } 182192fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 182237d0c07bSMatthew G Knepley if (section) { 18233a544194SStefano Zampini PetscInt *fieldSizes, *fieldNc, **fieldIndices; 182437d0c07bSMatthew G Knepley PetscInt nF, f, pStart, pEnd, p; 182537d0c07bSMatthew G Knepley 1826e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, §ionGlobal);CHKERRQ(ierr); 182737d0c07bSMatthew G Knepley ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr); 18283a544194SStefano Zampini ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr); 182937d0c07bSMatthew G Knepley ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr); 183037d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 183137d0c07bSMatthew G Knepley fieldSizes[f] = 0; 18323a544194SStefano Zampini ierr = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr); 183337d0c07bSMatthew G Knepley } 183437d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 183537d0c07bSMatthew G Knepley PetscInt gdof; 183637d0c07bSMatthew G Knepley 183737d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 183837d0c07bSMatthew G Knepley if (gdof > 0) { 183937d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 18403a544194SStefano Zampini PetscInt fdof, fcdof, fpdof; 184137d0c07bSMatthew G Knepley 184237d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 184337d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 18443a544194SStefano Zampini fpdof = fdof-fcdof; 18453a544194SStefano Zampini if (fpdof && fpdof != fieldNc[f]) { 18463a544194SStefano Zampini /* Layout does not admit a pointwise block size */ 18473a544194SStefano Zampini fieldNc[f] = 1; 18483a544194SStefano Zampini } 18493a544194SStefano Zampini fieldSizes[f] += fpdof; 185037d0c07bSMatthew G Knepley } 185137d0c07bSMatthew G Knepley } 185237d0c07bSMatthew G Knepley } 185337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 1854785e854fSJed Brown ierr = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr); 185537d0c07bSMatthew G Knepley fieldSizes[f] = 0; 185637d0c07bSMatthew G Knepley } 185737d0c07bSMatthew G Knepley for (p = pStart; p < pEnd; ++p) { 185837d0c07bSMatthew G Knepley PetscInt gdof, goff; 185937d0c07bSMatthew G Knepley 186037d0c07bSMatthew G Knepley ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr); 186137d0c07bSMatthew G Knepley if (gdof > 0) { 186237d0c07bSMatthew G Knepley ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr); 186337d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 186437d0c07bSMatthew G Knepley PetscInt fdof, fcdof, fc; 186537d0c07bSMatthew G Knepley 186637d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr); 186737d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr); 186837d0c07bSMatthew G Knepley for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) { 186937d0c07bSMatthew G Knepley fieldIndices[f][fieldSizes[f]] = goff++; 187037d0c07bSMatthew G Knepley } 187137d0c07bSMatthew G Knepley } 187237d0c07bSMatthew G Knepley } 187337d0c07bSMatthew G Knepley } 18748865f1eaSKarl Rupp if (numFields) *numFields = nF; 187537d0c07bSMatthew G Knepley if (fieldNames) { 1876785e854fSJed Brown ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr); 187737d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 187837d0c07bSMatthew G Knepley const char *fieldName; 187937d0c07bSMatthew G Knepley 188037d0c07bSMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 188137d0c07bSMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr); 188237d0c07bSMatthew G Knepley } 188337d0c07bSMatthew G Knepley } 188437d0c07bSMatthew G Knepley if (fields) { 1885785e854fSJed Brown ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr); 188637d0c07bSMatthew G Knepley for (f = 0; f < nF; ++f) { 18873a544194SStefano Zampini PetscInt bs, in[2], out[2]; 18883a544194SStefano Zampini 188982f516ccSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr); 18903a544194SStefano Zampini in[0] = -fieldNc[f]; 18913a544194SStefano Zampini in[1] = fieldNc[f]; 1892820f2d46SBarry Smith ierr = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 18933a544194SStefano Zampini bs = (-out[0] == out[1]) ? out[1] : 1; 18943a544194SStefano Zampini ierr = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr); 189537d0c07bSMatthew G Knepley } 189637d0c07bSMatthew G Knepley } 18973a544194SStefano Zampini ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr); 18988865f1eaSKarl Rupp } else if (dm->ops->createfieldis) { 18998865f1eaSKarl Rupp ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr); 190069ca1f37SDmitry Karpeev } 19014d343eeaSMatthew G Knepley PetscFunctionReturn(0); 19024d343eeaSMatthew G Knepley } 19034d343eeaSMatthew G Knepley 190416621825SDmitry Karpeev /*@C 190516621825SDmitry Karpeev DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems 190616621825SDmitry Karpeev corresponding to different fields: each IS contains the global indices of the dofs of the 190716621825SDmitry Karpeev corresponding field. The optional list of DMs define the DM for each subproblem. 1908e7c4fc90SDmitry Karpeev Generalizes DMCreateFieldIS(). 1909e7c4fc90SDmitry Karpeev 1910e7c4fc90SDmitry Karpeev Not collective 1911e7c4fc90SDmitry Karpeev 1912e7c4fc90SDmitry Karpeev Input Parameter: 1913e7c4fc90SDmitry Karpeev . dm - the DM object 1914e7c4fc90SDmitry Karpeev 1915e7c4fc90SDmitry Karpeev Output Parameters: 19160298fd71SBarry Smith + len - The number of subproblems in the field decomposition (or NULL if not requested) 19170298fd71SBarry Smith . namelist - The name for each field (or NULL if not requested) 19180298fd71SBarry Smith . islist - The global indices for each field (or NULL if not requested) 19190298fd71SBarry Smith - dmlist - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 1920e7c4fc90SDmitry Karpeev 1921e7c4fc90SDmitry Karpeev Level: intermediate 1922e7c4fc90SDmitry Karpeev 1923e7c4fc90SDmitry Karpeev Notes: 1924e7c4fc90SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 1925e7c4fc90SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 1926e7c4fc90SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 1927e7c4fc90SDmitry Karpeev 1928e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 1929e7c4fc90SDmitry Karpeev @*/ 193016621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist) 1931e7c4fc90SDmitry Karpeev { 1932e7c4fc90SDmitry Karpeev PetscErrorCode ierr; 1933e7c4fc90SDmitry Karpeev 1934e7c4fc90SDmitry Karpeev PetscFunctionBegin; 1935e7c4fc90SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 19368865f1eaSKarl Rupp if (len) { 1937534a8f05SLisandro Dalcin PetscValidIntPointer(len,2); 19388865f1eaSKarl Rupp *len = 0; 19398865f1eaSKarl Rupp } 19408865f1eaSKarl Rupp if (namelist) { 19418865f1eaSKarl Rupp PetscValidPointer(namelist,3); 1942ea78f98cSLisandro Dalcin *namelist = NULL; 19438865f1eaSKarl Rupp } 19448865f1eaSKarl Rupp if (islist) { 19458865f1eaSKarl Rupp PetscValidPointer(islist,4); 1946ea78f98cSLisandro Dalcin *islist = NULL; 19478865f1eaSKarl Rupp } 19488865f1eaSKarl Rupp if (dmlist) { 19498865f1eaSKarl Rupp PetscValidPointer(dmlist,5); 1950ea78f98cSLisandro Dalcin *dmlist = NULL; 19518865f1eaSKarl Rupp } 1952f3f0edfdSDmitry Karpeev /* 1953f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 1954f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 1955f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 1956f3f0edfdSDmitry Karpeev */ 19572c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 195816621825SDmitry Karpeev if (!dm->ops->createfielddecomposition) { 1959435a35e8SMatthew G Knepley PetscSection section; 1960435a35e8SMatthew G Knepley PetscInt numFields, f; 1961435a35e8SMatthew G Knepley 196292fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 1963435a35e8SMatthew G Knepley if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);} 1964435a35e8SMatthew G Knepley if (section && numFields && dm->ops->createsubdm) { 1965f25d98f1SMatthew G. Knepley if (len) *len = numFields; 196603dc3394SMatthew G. Knepley if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);} 196703dc3394SMatthew G. Knepley if (islist) {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);} 196803dc3394SMatthew G. Knepley if (dmlist) {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);} 1969435a35e8SMatthew G Knepley for (f = 0; f < numFields; ++f) { 1970435a35e8SMatthew G Knepley const char *fieldName; 1971435a35e8SMatthew G Knepley 197203dc3394SMatthew G. Knepley ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr); 197303dc3394SMatthew G. Knepley if (namelist) { 1974435a35e8SMatthew G Knepley ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr); 1975435a35e8SMatthew G Knepley ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr); 1976435a35e8SMatthew G Knepley } 197703dc3394SMatthew G. Knepley } 1978435a35e8SMatthew G Knepley } else { 197969ca1f37SDmitry Karpeev ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr); 1980e7c4fc90SDmitry Karpeev /* By default there are no DMs associated with subproblems. */ 19810298fd71SBarry Smith if (dmlist) *dmlist = NULL; 1982e7c4fc90SDmitry Karpeev } 19838865f1eaSKarl Rupp } else { 198416621825SDmitry Karpeev ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr); 198516621825SDmitry Karpeev } 198616621825SDmitry Karpeev PetscFunctionReturn(0); 198716621825SDmitry Karpeev } 198816621825SDmitry Karpeev 1989564cec59SMatthew G. Knepley /*@ 1990435a35e8SMatthew G Knepley DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in. 1991435a35e8SMatthew G Knepley The fields are defined by DMCreateFieldIS(). 1992435a35e8SMatthew G Knepley 1993435a35e8SMatthew G Knepley Not collective 1994435a35e8SMatthew G Knepley 1995435a35e8SMatthew G Knepley Input Parameters: 19962adcc780SMatthew G. Knepley + dm - The DM object 19972adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem 19982adcc780SMatthew G. Knepley - fields - The field numbers of the selected fields 1999435a35e8SMatthew G Knepley 2000435a35e8SMatthew G Knepley Output Parameters: 20012adcc780SMatthew G. Knepley + is - The global indices for the subproblem 20022adcc780SMatthew G. Knepley - subdm - The DM for the subproblem 2003435a35e8SMatthew G Knepley 20045d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 20055d3b26e6SMatthew G. Knepley 2006435a35e8SMatthew G Knepley Level: intermediate 2007435a35e8SMatthew G Knepley 20085d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 2009435a35e8SMatthew G Knepley @*/ 201037bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm) 2011435a35e8SMatthew G Knepley { 2012435a35e8SMatthew G Knepley PetscErrorCode ierr; 2013435a35e8SMatthew G Knepley 2014435a35e8SMatthew G Knepley PetscFunctionBegin; 2015435a35e8SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2016435a35e8SMatthew G Knepley PetscValidPointer(fields,3); 20178865f1eaSKarl Rupp if (is) PetscValidPointer(is,4); 20188865f1eaSKarl Rupp if (subdm) PetscValidPointer(subdm,5); 20192c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createsubdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name); 2020435a35e8SMatthew G Knepley ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr); 2021435a35e8SMatthew G Knepley PetscFunctionReturn(0); 2022435a35e8SMatthew G Knepley } 2023435a35e8SMatthew G Knepley 20242adcc780SMatthew G. Knepley /*@C 20252adcc780SMatthew G. Knepley DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in. 20262adcc780SMatthew G. Knepley 20272adcc780SMatthew G. Knepley Not collective 20282adcc780SMatthew G. Knepley 2029d8d19677SJose E. Roman Input Parameters: 20302adcc780SMatthew G. Knepley + dms - The DM objects 20312adcc780SMatthew G. Knepley - len - The number of DMs 20322adcc780SMatthew G. Knepley 20332adcc780SMatthew G. Knepley Output Parameters: 2034a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL 20352adcc780SMatthew G. Knepley - superdm - The DM for the superproblem 20362adcc780SMatthew G. Knepley 20375d3b26e6SMatthew G. Knepley Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed 20385d3b26e6SMatthew G. Knepley 20392adcc780SMatthew G. Knepley Level: intermediate 20402adcc780SMatthew G. Knepley 20415d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 20422adcc780SMatthew G. Knepley @*/ 20432adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm) 20442adcc780SMatthew G. Knepley { 20452adcc780SMatthew G. Knepley PetscInt i; 20462adcc780SMatthew G. Knepley PetscErrorCode ierr; 20472adcc780SMatthew G. Knepley 20482adcc780SMatthew G. Knepley PetscFunctionBegin; 20492adcc780SMatthew G. Knepley PetscValidPointer(dms,1); 20502adcc780SMatthew G. Knepley for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);} 20512adcc780SMatthew G. Knepley if (is) PetscValidPointer(is,3); 2052a42bd24dSMatthew G. Knepley PetscValidPointer(superdm,4); 20532c71b3e2SJacob Faibussowitsch PetscCheckFalse(len < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len); 20542adcc780SMatthew G. Knepley if (len) { 2055b9d85ea2SLisandro Dalcin DM dm = dms[0]; 20562c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createsuperdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name); 2057b9d85ea2SLisandro Dalcin ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr); 20582adcc780SMatthew G. Knepley } 20592adcc780SMatthew G. Knepley PetscFunctionReturn(0); 20602adcc780SMatthew G. Knepley } 20612adcc780SMatthew G. Knepley 206216621825SDmitry Karpeev /*@C 20638d4ac253SDmitry Karpeev DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems 20648d4ac253SDmitry Karpeev corresponding to restrictions to pairs nested subdomains: each IS contains the global 20658d4ac253SDmitry Karpeev indices of the dofs of the corresponding subdomains. The inner subdomains conceptually 20668d4ac253SDmitry Karpeev define a nonoverlapping covering, while outer subdomains can overlap. 20678d4ac253SDmitry Karpeev The optional list of DMs define the DM for each subproblem. 206816621825SDmitry Karpeev 206916621825SDmitry Karpeev Not collective 207016621825SDmitry Karpeev 207116621825SDmitry Karpeev Input Parameter: 207216621825SDmitry Karpeev . dm - the DM object 207316621825SDmitry Karpeev 207416621825SDmitry Karpeev Output Parameters: 20750298fd71SBarry Smith + len - The number of subproblems in the domain decomposition (or NULL if not requested) 20760298fd71SBarry Smith . namelist - The name for each subdomain (or NULL if not requested) 20770298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested) 20780298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested) 20790298fd71SBarry Smith - dmlist - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined) 208016621825SDmitry Karpeev 208116621825SDmitry Karpeev Level: intermediate 208216621825SDmitry Karpeev 208316621825SDmitry Karpeev Notes: 208416621825SDmitry Karpeev The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with 208516621825SDmitry Karpeev PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(), 208616621825SDmitry Karpeev and all of the arrays should be freed with PetscFree(). 208716621825SDmitry Karpeev 2088245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition() 208916621825SDmitry Karpeev @*/ 20908d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist) 209116621825SDmitry Karpeev { 209216621825SDmitry Karpeev PetscErrorCode ierr; 2093be081cd6SPeter Brune DMSubDomainHookLink link; 2094be081cd6SPeter Brune PetscInt i,l; 209516621825SDmitry Karpeev 209616621825SDmitry Karpeev PetscFunctionBegin; 209716621825SDmitry Karpeev PetscValidHeaderSpecific(dm,DM_CLASSID,1); 209814a18fd3SPeter Brune if (len) {PetscValidPointer(len,2); *len = 0;} 20990298fd71SBarry Smith if (namelist) {PetscValidPointer(namelist,3); *namelist = NULL;} 21000298fd71SBarry Smith if (innerislist) {PetscValidPointer(innerislist,4); *innerislist = NULL;} 21010298fd71SBarry Smith if (outerislist) {PetscValidPointer(outerislist,5); *outerislist = NULL;} 21020298fd71SBarry Smith if (dmlist) {PetscValidPointer(dmlist,6); *dmlist = NULL;} 2103f3f0edfdSDmitry Karpeev /* 2104f3f0edfdSDmitry Karpeev Is it a good idea to apply the following check across all impls? 2105f3f0edfdSDmitry Karpeev Perhaps some impls can have a well-defined decomposition before DMSetUp? 2106f3f0edfdSDmitry Karpeev This, however, follows the general principle that accessors are not well-behaved until the object is set up. 2107f3f0edfdSDmitry Karpeev */ 21082c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp"); 210916621825SDmitry Karpeev if (dm->ops->createdomaindecomposition) { 2110be081cd6SPeter Brune ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr); 211114a18fd3SPeter Brune /* copy subdomain hooks and context over to the subdomain DMs */ 2112f891f5b9SPatrick Sanan if (dmlist && *dmlist) { 2113be081cd6SPeter Brune for (i = 0; i < l; i++) { 2114be081cd6SPeter Brune for (link=dm->subdomainhook; link; link=link->next) { 2115be081cd6SPeter Brune if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);} 2116be081cd6SPeter Brune } 2117648262bbSPatrick Sanan if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx; 2118e7c4fc90SDmitry Karpeev } 211914a18fd3SPeter Brune } 212014a18fd3SPeter Brune if (len) *len = l; 212114a18fd3SPeter Brune } 2122e30e807fSPeter Brune PetscFunctionReturn(0); 2123e30e807fSPeter Brune } 2124e30e807fSPeter Brune 2125e30e807fSPeter Brune /*@C 2126e30e807fSPeter Brune DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector 2127e30e807fSPeter Brune 2128e30e807fSPeter Brune Not collective 2129e30e807fSPeter Brune 2130e30e807fSPeter Brune Input Parameters: 2131e30e807fSPeter Brune + dm - the DM object 2132e30e807fSPeter Brune . n - the number of subdomain scatters 2133e30e807fSPeter Brune - subdms - the local subdomains 2134e30e807fSPeter Brune 2135e30e807fSPeter Brune Output Parameters: 21366b867d5aSJose E. Roman + iscat - scatter from global vector to nonoverlapping global vector entries on subdomain 2137e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain 2138e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts) 2139e30e807fSPeter Brune 214095452b02SPatrick Sanan Notes: 214195452b02SPatrick Sanan This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution 2142e30e807fSPeter Brune of general nonlinear problems with overlapping subdomain methods. While merely having index sets that enable subsets 2143e30e807fSPeter Brune of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of 2144e30e807fSPeter Brune solution and residual data. 2145e30e807fSPeter Brune 2146e30e807fSPeter Brune Level: developer 2147e30e807fSPeter Brune 2148e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS() 2149e30e807fSPeter Brune @*/ 2150e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat) 2151e30e807fSPeter Brune { 2152e30e807fSPeter Brune PetscErrorCode ierr; 2153e30e807fSPeter Brune 2154e30e807fSPeter Brune PetscFunctionBegin; 2155e30e807fSPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2156e30e807fSPeter Brune PetscValidPointer(subdms,3); 21572c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createddscatters,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name); 2158e30e807fSPeter Brune ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr); 2159e7c4fc90SDmitry Karpeev PetscFunctionReturn(0); 2160e7c4fc90SDmitry Karpeev } 2161e7c4fc90SDmitry Karpeev 216247c6ae99SBarry Smith /*@ 216347c6ae99SBarry Smith DMRefine - Refines a DM object 216447c6ae99SBarry Smith 2165d083f849SBarry Smith Collective on dm 216647c6ae99SBarry Smith 2167d8d19677SJose E. Roman Input Parameters: 216847c6ae99SBarry Smith + dm - the DM object 216991d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 217047c6ae99SBarry Smith 217147c6ae99SBarry Smith Output Parameter: 21720298fd71SBarry Smith . dmf - the refined DM, or NULL 2173ae0a1c52SMatthew G Knepley 2174f27dd7c6SMatthew G. Knepley Options Database Keys: 2175412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex 2176412e9a14SMatthew G. Knepley 21770298fd71SBarry Smith Note: If no refinement was done, the return value is NULL 217847c6ae99SBarry Smith 217947c6ae99SBarry Smith Level: developer 218047c6ae99SBarry Smith 2181e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 218247c6ae99SBarry Smith @*/ 21837087cfbeSBarry Smith PetscErrorCode DMRefine(DM dm,MPI_Comm comm,DM *dmf) 218447c6ae99SBarry Smith { 218547c6ae99SBarry Smith PetscErrorCode ierr; 2186c833c3b5SJed Brown DMRefineHookLink link; 218747c6ae99SBarry Smith 218847c6ae99SBarry Smith PetscFunctionBegin; 2189732e2eb9SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 21902c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->refine,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name); 21911ac00216SMatthew G. Knepley ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 219247c6ae99SBarry Smith ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr); 21934057135bSMatthew G Knepley if (*dmf) { 219443842a1eSJed Brown (*dmf)->ops->creatematrix = dm->ops->creatematrix; 21958865f1eaSKarl Rupp 21968cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr); 21978865f1eaSKarl Rupp 2198644e2e5bSBarry Smith (*dmf)->ctx = dm->ctx; 21990598a293SJed Brown (*dmf)->leveldown = dm->leveldown; 2200656b349aSBarry Smith (*dmf)->levelup = dm->levelup + 1; 22018865f1eaSKarl Rupp 2202e4b4b23bSJed Brown ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr); 2203c833c3b5SJed Brown for (link=dm->refinehook; link; link=link->next) { 22048865f1eaSKarl Rupp if (link->refinehook) { 22058865f1eaSKarl Rupp ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr); 22068865f1eaSKarl Rupp } 2207c833c3b5SJed Brown } 2208c833c3b5SJed Brown } 22091ac00216SMatthew G. Knepley ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr); 2210c833c3b5SJed Brown PetscFunctionReturn(0); 2211c833c3b5SJed Brown } 2212c833c3b5SJed Brown 2213bb9467b5SJed Brown /*@C 2214c833c3b5SJed Brown DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid 2215c833c3b5SJed Brown 2216c833c3b5SJed Brown Logically Collective 2217c833c3b5SJed Brown 22184165533cSJose E. Roman Input Parameters: 2219c833c3b5SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 2220c833c3b5SJed Brown . refinehook - function to run when setting up a coarser level 2221c833c3b5SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 22220298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2223c833c3b5SJed Brown 2224c833c3b5SJed Brown Calling sequence of refinehook: 2225c833c3b5SJed Brown $ refinehook(DM coarse,DM fine,void *ctx); 2226c833c3b5SJed Brown 2227c833c3b5SJed Brown + coarse - coarse level DM 2228c833c3b5SJed Brown . fine - fine level DM to interpolate problem to 2229c833c3b5SJed Brown - ctx - optional user-defined function context 2230c833c3b5SJed Brown 2231c833c3b5SJed Brown Calling sequence for interphook: 2232c833c3b5SJed Brown $ interphook(DM coarse,Mat interp,DM fine,void *ctx) 2233c833c3b5SJed Brown 2234c833c3b5SJed Brown + coarse - coarse level DM 2235c833c3b5SJed Brown . interp - matrix interpolating a coarse-level solution to the finer grid 2236c833c3b5SJed Brown . fine - fine level DM to update 2237c833c3b5SJed Brown - ctx - optional user-defined function context 2238c833c3b5SJed Brown 2239c833c3b5SJed Brown Level: advanced 2240c833c3b5SJed Brown 2241c833c3b5SJed Brown Notes: 2242c833c3b5SJed Brown This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing 2243c833c3b5SJed Brown 2244c833c3b5SJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 2245c833c3b5SJed Brown 2246bb9467b5SJed Brown This function is currently not available from Fortran. 2247bb9467b5SJed Brown 2248c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2249c833c3b5SJed Brown @*/ 2250c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 2251c833c3b5SJed Brown { 2252c833c3b5SJed Brown PetscErrorCode ierr; 2253c833c3b5SJed Brown DMRefineHookLink link,*p; 2254c833c3b5SJed Brown 2255c833c3b5SJed Brown PetscFunctionBegin; 2256c833c3b5SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 22573d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 22583d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0); 22593d8e3701SJed Brown } 226095dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2261c833c3b5SJed Brown link->refinehook = refinehook; 2262c833c3b5SJed Brown link->interphook = interphook; 2263c833c3b5SJed Brown link->ctx = ctx; 22640298fd71SBarry Smith link->next = NULL; 2265c833c3b5SJed Brown *p = link; 2266c833c3b5SJed Brown PetscFunctionReturn(0); 2267c833c3b5SJed Brown } 2268c833c3b5SJed Brown 22693d8e3701SJed Brown /*@C 22703d8e3701SJed Brown DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid 22713d8e3701SJed Brown 22723d8e3701SJed Brown Logically Collective 22733d8e3701SJed Brown 22744165533cSJose E. Roman Input Parameters: 22753d8e3701SJed Brown + coarse - nonlinear solver context on which to run a hook when restricting to a coarser level 22763d8e3701SJed Brown . refinehook - function to run when setting up a coarser level 22773d8e3701SJed Brown . interphook - function to run to update data on finer levels (once per SNESSolve()) 22783d8e3701SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 22793d8e3701SJed Brown 22803d8e3701SJed Brown Level: advanced 22813d8e3701SJed Brown 22823d8e3701SJed Brown Notes: 22833d8e3701SJed Brown This function does nothing if the hook is not in the list. 22843d8e3701SJed Brown 22853d8e3701SJed Brown This function is currently not available from Fortran. 22863d8e3701SJed Brown 22873d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 22883d8e3701SJed Brown @*/ 22893d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx) 22903d8e3701SJed Brown { 22913d8e3701SJed Brown PetscErrorCode ierr; 22923d8e3701SJed Brown DMRefineHookLink link,*p; 22933d8e3701SJed Brown 22943d8e3701SJed Brown PetscFunctionBegin; 22953d8e3701SJed Brown PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 22963d8e3701SJed Brown for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 22973d8e3701SJed Brown if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) { 22983d8e3701SJed Brown link = *p; 22993d8e3701SJed Brown *p = link->next; 23003d8e3701SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 23013d8e3701SJed Brown break; 23023d8e3701SJed Brown } 23033d8e3701SJed Brown } 23043d8e3701SJed Brown PetscFunctionReturn(0); 23053d8e3701SJed Brown } 23063d8e3701SJed Brown 2307c833c3b5SJed Brown /*@ 2308c833c3b5SJed Brown DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd() 2309c833c3b5SJed Brown 2310c833c3b5SJed Brown Collective if any hooks are 2311c833c3b5SJed Brown 23124165533cSJose E. Roman Input Parameters: 2313c833c3b5SJed Brown + coarse - coarser DM to use as a base 2314e91eccc2SStefano Zampini . interp - interpolation matrix, apply using MatInterpolate() 2315c833c3b5SJed Brown - fine - finer DM to update 2316c833c3b5SJed Brown 2317c833c3b5SJed Brown Level: developer 2318c833c3b5SJed Brown 2319c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate() 2320c833c3b5SJed Brown @*/ 2321c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine) 2322c833c3b5SJed Brown { 2323c833c3b5SJed Brown PetscErrorCode ierr; 2324c833c3b5SJed Brown DMRefineHookLink link; 2325c833c3b5SJed Brown 2326c833c3b5SJed Brown PetscFunctionBegin; 2327c833c3b5SJed Brown for (link=fine->refinehook; link; link=link->next) { 23288865f1eaSKarl Rupp if (link->interphook) { 23298865f1eaSKarl Rupp ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr); 23308865f1eaSKarl Rupp } 23314057135bSMatthew G Knepley } 233247c6ae99SBarry Smith PetscFunctionReturn(0); 233347c6ae99SBarry Smith } 233447c6ae99SBarry Smith 2335eb3f98d2SBarry Smith /*@ 23361f3379b2SToby Isaac DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh. 23371f3379b2SToby Isaac 23381f3379b2SToby Isaac Collective on DM 23391f3379b2SToby Isaac 23404165533cSJose E. Roman Input Parameters: 23411f3379b2SToby Isaac + coarse - coarse DM 23421f3379b2SToby Isaac . fine - fine DM 23431f3379b2SToby Isaac . interp - (optional) the matrix computed by DMCreateInterpolation(). Implementations may not need this, but if it 23441f3379b2SToby Isaac is available it can avoid some recomputation. If it is provided, MatInterpolate() will be used if 23451f3379b2SToby Isaac the coarse DM does not have a specialized implementation. 23461f3379b2SToby Isaac - coarseSol - solution on the coarse mesh 23471f3379b2SToby Isaac 23484165533cSJose E. Roman Output Parameter: 23491f3379b2SToby Isaac . fineSol - the interpolation of coarseSol to the fine mesh 23501f3379b2SToby Isaac 23511f3379b2SToby Isaac Level: developer 23521f3379b2SToby Isaac 23531f3379b2SToby Isaac Note: This function exists because the interpolation of a solution vector between meshes is not always a linear 23541f3379b2SToby Isaac map. For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed 23551f3379b2SToby Isaac out of the solution vector. Or if interpolation is inherently a nonlinear operation, such as a method using 23561f3379b2SToby Isaac slope-limiting reconstruction. 23571f3379b2SToby Isaac 23581f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation() 23591f3379b2SToby Isaac @*/ 23601f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol) 23611f3379b2SToby Isaac { 23621f3379b2SToby Isaac PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL; 23631f3379b2SToby Isaac PetscErrorCode ierr; 23641f3379b2SToby Isaac 23651f3379b2SToby Isaac PetscFunctionBegin; 23661f3379b2SToby Isaac PetscValidHeaderSpecific(coarse,DM_CLASSID,1); 23671f3379b2SToby Isaac if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3); 23681f3379b2SToby Isaac PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4); 23691f3379b2SToby Isaac PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5); 23701f3379b2SToby Isaac 23711f3379b2SToby Isaac ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr); 23721f3379b2SToby Isaac if (interpsol) { 23731f3379b2SToby Isaac ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr); 23741f3379b2SToby Isaac } else if (interp) { 23751f3379b2SToby Isaac ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr); 237698921bdaSJacob Faibussowitsch } else SETERRQ(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name); 23771f3379b2SToby Isaac PetscFunctionReturn(0); 23781f3379b2SToby Isaac } 23791f3379b2SToby Isaac 23801f3379b2SToby Isaac /*@ 2381aed49f88SRichard Tran Mills DMGetRefineLevel - Gets the number of refinements that have generated this DM. 2382eb3f98d2SBarry Smith 2383eb3f98d2SBarry Smith Not Collective 2384eb3f98d2SBarry Smith 2385eb3f98d2SBarry Smith Input Parameter: 2386eb3f98d2SBarry Smith . dm - the DM object 2387eb3f98d2SBarry Smith 2388eb3f98d2SBarry Smith Output Parameter: 2389eb3f98d2SBarry Smith . level - number of refinements 2390eb3f98d2SBarry Smith 2391eb3f98d2SBarry Smith Level: developer 2392eb3f98d2SBarry Smith 23936a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2394eb3f98d2SBarry Smith 2395eb3f98d2SBarry Smith @*/ 2396eb3f98d2SBarry Smith PetscErrorCode DMGetRefineLevel(DM dm,PetscInt *level) 2397eb3f98d2SBarry Smith { 2398eb3f98d2SBarry Smith PetscFunctionBegin; 2399eb3f98d2SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2400eb3f98d2SBarry Smith *level = dm->levelup; 2401eb3f98d2SBarry Smith PetscFunctionReturn(0); 2402eb3f98d2SBarry Smith } 2403eb3f98d2SBarry Smith 2404fef3a512SBarry Smith /*@ 2405aed49f88SRichard Tran Mills DMSetRefineLevel - Sets the number of refinements that have generated this DM. 2406fef3a512SBarry Smith 2407fef3a512SBarry Smith Not Collective 2408fef3a512SBarry Smith 2409d8d19677SJose E. Roman Input Parameters: 2410fef3a512SBarry Smith + dm - the DM object 2411fef3a512SBarry Smith - level - number of refinements 2412fef3a512SBarry Smith 2413fef3a512SBarry Smith Level: advanced 2414fef3a512SBarry Smith 241595452b02SPatrick Sanan Notes: 241695452b02SPatrick Sanan This value is used by PCMG to determine how many multigrid levels to use 2417fef3a512SBarry Smith 2418fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 2419fef3a512SBarry Smith 2420fef3a512SBarry Smith @*/ 2421fef3a512SBarry Smith PetscErrorCode DMSetRefineLevel(DM dm,PetscInt level) 2422fef3a512SBarry Smith { 2423fef3a512SBarry Smith PetscFunctionBegin; 2424fef3a512SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2425fef3a512SBarry Smith dm->levelup = level; 2426fef3a512SBarry Smith PetscFunctionReturn(0); 2427fef3a512SBarry Smith } 2428fef3a512SBarry Smith 2429d410b0cfSMatthew G. Knepley /*@ 2430d410b0cfSMatthew G. Knepley DMExtrude - Extrude a DM object from a surface 2431d410b0cfSMatthew G. Knepley 2432d410b0cfSMatthew G. Knepley Collective on dm 2433d410b0cfSMatthew G. Knepley 2434f1a722f8SMatthew G. Knepley Input Parameters: 2435d410b0cfSMatthew G. Knepley + dm - the DM object 2436d410b0cfSMatthew G. Knepley - layers - the number of extruded cell layers 2437d410b0cfSMatthew G. Knepley 2438d410b0cfSMatthew G. Knepley Output Parameter: 2439d410b0cfSMatthew G. Knepley . dme - the extruded DM, or NULL 2440d410b0cfSMatthew G. Knepley 2441d410b0cfSMatthew G. Knepley Note: If no extrusion was done, the return value is NULL 2442d410b0cfSMatthew G. Knepley 2443d410b0cfSMatthew G. Knepley Level: developer 2444d410b0cfSMatthew G. Knepley 2445d410b0cfSMatthew G. Knepley .seealso DMRefine(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector() 2446d410b0cfSMatthew G. Knepley @*/ 2447d410b0cfSMatthew G. Knepley PetscErrorCode DMExtrude(DM dm, PetscInt layers, DM *dme) 2448d410b0cfSMatthew G. Knepley { 2449d410b0cfSMatthew G. Knepley PetscErrorCode ierr; 2450d410b0cfSMatthew G. Knepley 2451d410b0cfSMatthew G. Knepley PetscFunctionBegin; 2452d410b0cfSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 24532c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->extrude,PetscObjectComm((PetscObject) dm), PETSC_ERR_SUP, "DM type %s does not implement DMExtrude", ((PetscObject) dm)->type_name); 2454d410b0cfSMatthew G. Knepley ierr = (*dm->ops->extrude)(dm, layers, dme);CHKERRQ(ierr); 2455d410b0cfSMatthew G. Knepley if (*dme) { 2456d410b0cfSMatthew G. Knepley (*dme)->ops->creatematrix = dm->ops->creatematrix; 2457d410b0cfSMatthew G. Knepley ierr = PetscObjectCopyFortranFunctionPointers((PetscObject) dm, (PetscObject) *dme);CHKERRQ(ierr); 2458d410b0cfSMatthew G. Knepley (*dme)->ctx = dm->ctx; 2459d410b0cfSMatthew G. Knepley ierr = DMSetMatType(*dme, dm->mattype);CHKERRQ(ierr); 2460d410b0cfSMatthew G. Knepley } 2461d410b0cfSMatthew G. Knepley PetscFunctionReturn(0); 2462d410b0cfSMatthew G. Knepley } 2463d410b0cfSMatthew G. Knepley 2464ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm) 2465ca3d3a14SMatthew G. Knepley { 2466ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2467ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2468ca3d3a14SMatthew G. Knepley PetscValidPointer(tdm, 2); 2469ca3d3a14SMatthew G. Knepley *tdm = dm->transformDM; 2470ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2471ca3d3a14SMatthew G. Knepley } 2472ca3d3a14SMatthew G. Knepley 2473ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv) 2474ca3d3a14SMatthew G. Knepley { 2475ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2476ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2477ca3d3a14SMatthew G. Knepley PetscValidPointer(tv, 2); 2478ca3d3a14SMatthew G. Knepley *tv = dm->transform; 2479ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2480ca3d3a14SMatthew G. Knepley } 2481ca3d3a14SMatthew G. Knepley 2482ca3d3a14SMatthew G. Knepley /*@ 2483c0f8e1fdSMatthew G. Knepley DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors 2484ca3d3a14SMatthew G. Knepley 2485ca3d3a14SMatthew G. Knepley Input Parameter: 2486ca3d3a14SMatthew G. Knepley . dm - The DM 2487ca3d3a14SMatthew G. Knepley 2488ca3d3a14SMatthew G. Knepley Output Parameter: 2489ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done 2490ca3d3a14SMatthew G. Knepley 2491ca3d3a14SMatthew G. Knepley Level: developer 2492ca3d3a14SMatthew G. Knepley 2493436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation() 2494ca3d3a14SMatthew G. Knepley @*/ 2495ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg) 2496ca3d3a14SMatthew G. Knepley { 2497ca3d3a14SMatthew G. Knepley Vec tv; 2498ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2499ca3d3a14SMatthew G. Knepley 2500ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2501ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2502534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 2503ca3d3a14SMatthew G. Knepley ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr); 2504ca3d3a14SMatthew G. Knepley *flg = tv ? PETSC_TRUE : PETSC_FALSE; 2505ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2506ca3d3a14SMatthew G. Knepley } 2507ca3d3a14SMatthew G. Knepley 2508ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm) 2509ca3d3a14SMatthew G. Knepley { 2510ca3d3a14SMatthew G. Knepley PetscSection s, ts; 2511ca3d3a14SMatthew G. Knepley PetscScalar *ta; 2512ca3d3a14SMatthew G. Knepley PetscInt cdim, pStart, pEnd, p, Nf, f, Nc, dof; 2513ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2514ca3d3a14SMatthew G. Knepley 2515ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2516ca3d3a14SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 251792fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 2518ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 2519ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr); 2520ca3d3a14SMatthew G. Knepley ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr); 252192fd8e1eSJed Brown ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr); 2522ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr); 2523ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr); 2524ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2525ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr); 2526ca3d3a14SMatthew G. Knepley /* We could start to label fields by their transformation properties */ 2527ca3d3a14SMatthew G. Knepley if (Nc != cdim) continue; 2528ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2529ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr); 2530ca3d3a14SMatthew G. Knepley if (!dof) continue; 2531ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr); 2532ca3d3a14SMatthew G. Knepley ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr); 2533ca3d3a14SMatthew G. Knepley } 2534ca3d3a14SMatthew G. Knepley } 2535ca3d3a14SMatthew G. Knepley ierr = PetscSectionSetUp(ts);CHKERRQ(ierr); 2536ca3d3a14SMatthew G. Knepley ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr); 2537ca3d3a14SMatthew G. Knepley ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr); 2538ca3d3a14SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2539ca3d3a14SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2540ca3d3a14SMatthew G. Knepley ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr); 2541ca3d3a14SMatthew G. Knepley if (dof) { 2542ca3d3a14SMatthew G. Knepley PetscReal x[3] = {0.0, 0.0, 0.0}; 2543ca3d3a14SMatthew G. Knepley PetscScalar *tva; 2544ca3d3a14SMatthew G. Knepley const PetscScalar *A; 2545ca3d3a14SMatthew G. Knepley 2546ca3d3a14SMatthew G. Knepley /* TODO Get quadrature point for this dual basis vector for coordinate */ 2547ca3d3a14SMatthew G. Knepley ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr); 2548ca3d3a14SMatthew G. Knepley ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr); 2549580bdb30SBarry Smith ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr); 2550ca3d3a14SMatthew G. Knepley } 2551ca3d3a14SMatthew G. Knepley } 2552ca3d3a14SMatthew G. Knepley } 2553ca3d3a14SMatthew G. Knepley ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr); 2554ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2555ca3d3a14SMatthew G. Knepley } 2556ca3d3a14SMatthew G. Knepley 2557ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm) 2558ca3d3a14SMatthew G. Knepley { 2559ca3d3a14SMatthew G. Knepley PetscErrorCode ierr; 2560ca3d3a14SMatthew G. Knepley 2561ca3d3a14SMatthew G. Knepley PetscFunctionBegin; 2562ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 2563ca3d3a14SMatthew G. Knepley PetscValidHeaderSpecific(newdm, DM_CLASSID, 2); 2564ca3d3a14SMatthew G. Knepley newdm->transformCtx = dm->transformCtx; 2565ca3d3a14SMatthew G. Knepley newdm->transformSetUp = dm->transformSetUp; 2566ca3d3a14SMatthew G. Knepley newdm->transformDestroy = NULL; 2567ca3d3a14SMatthew G. Knepley newdm->transformGetMatrix = dm->transformGetMatrix; 2568ca3d3a14SMatthew G. Knepley if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);} 2569ca3d3a14SMatthew G. Knepley PetscFunctionReturn(0); 2570ca3d3a14SMatthew G. Knepley } 2571ca3d3a14SMatthew G. Knepley 2572bb9467b5SJed Brown /*@C 2573baf369e7SPeter Brune DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called 2574baf369e7SPeter Brune 2575baf369e7SPeter Brune Logically Collective 2576baf369e7SPeter Brune 25774165533cSJose E. Roman Input Parameters: 2578baf369e7SPeter Brune + dm - the DM 2579baf369e7SPeter Brune . beginhook - function to run at the beginning of DMGlobalToLocalBegin() 2580baf369e7SPeter Brune . endhook - function to run after DMGlobalToLocalEnd() has completed 25810298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2582baf369e7SPeter Brune 2583baf369e7SPeter Brune Calling sequence for beginhook: 2584baf369e7SPeter Brune $ beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2585baf369e7SPeter Brune 2586baf369e7SPeter Brune + dm - global DM 2587baf369e7SPeter Brune . g - global vector 2588baf369e7SPeter Brune . mode - mode 2589baf369e7SPeter Brune . l - local vector 2590baf369e7SPeter Brune - ctx - optional user-defined function context 2591baf369e7SPeter Brune 2592baf369e7SPeter Brune Calling sequence for endhook: 2593ec4806b8SPeter Brune $ endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx) 2594baf369e7SPeter Brune 2595baf369e7SPeter Brune + global - global DM 2596baf369e7SPeter Brune - ctx - optional user-defined function context 2597baf369e7SPeter Brune 2598baf369e7SPeter Brune Level: advanced 2599baf369e7SPeter Brune 2600baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2601baf369e7SPeter Brune @*/ 2602baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2603baf369e7SPeter Brune { 2604baf369e7SPeter Brune PetscErrorCode ierr; 2605baf369e7SPeter Brune DMGlobalToLocalHookLink link,*p; 2606baf369e7SPeter Brune 2607baf369e7SPeter Brune PetscFunctionBegin; 2608baf369e7SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2609baf369e7SPeter Brune for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 261095dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2611baf369e7SPeter Brune link->beginhook = beginhook; 2612baf369e7SPeter Brune link->endhook = endhook; 2613baf369e7SPeter Brune link->ctx = ctx; 26140298fd71SBarry Smith link->next = NULL; 2615baf369e7SPeter Brune *p = link; 2616baf369e7SPeter Brune PetscFunctionReturn(0); 2617baf369e7SPeter Brune } 2618baf369e7SPeter Brune 26194c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx) 26204c274da1SToby Isaac { 26214c274da1SToby Isaac Mat cMat; 262279769bd5SJed Brown Vec cVec, cBias; 26234c274da1SToby Isaac PetscSection section, cSec; 26244c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 26254c274da1SToby Isaac PetscErrorCode ierr; 26264c274da1SToby Isaac 26274c274da1SToby Isaac PetscFunctionBegin; 26284c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 262979769bd5SJed Brown ierr = DMGetDefaultConstraints(dm,&cSec,&cMat,&cBias);CHKERRQ(ierr); 26304c274da1SToby Isaac if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) { 26315db9a05bSToby Isaac PetscInt nRows; 26325db9a05bSToby Isaac 26335db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 26345db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 263592fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 26367711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 26374c274da1SToby Isaac ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr); 263879769bd5SJed Brown if (cBias) {ierr = VecAXPY(cVec,1.,cBias);CHKERRQ(ierr);} 26394c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 26404c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 26414c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 26424c274da1SToby Isaac if (dof) { 26434c274da1SToby Isaac PetscScalar *vals; 26444c274da1SToby Isaac ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr); 26454c274da1SToby Isaac ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr); 26464c274da1SToby Isaac } 26474c274da1SToby Isaac } 26484c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 26494c274da1SToby Isaac } 26504c274da1SToby Isaac PetscFunctionReturn(0); 26514c274da1SToby Isaac } 26524c274da1SToby Isaac 265347c6ae99SBarry Smith /*@ 265401729b5cSPatrick Sanan DMGlobalToLocal - update local vectors from global vector 265501729b5cSPatrick Sanan 2656d083f849SBarry Smith Neighbor-wise Collective on dm 265701729b5cSPatrick Sanan 265801729b5cSPatrick Sanan Input Parameters: 265901729b5cSPatrick Sanan + dm - the DM object 266001729b5cSPatrick Sanan . g - the global vector 266101729b5cSPatrick Sanan . mode - INSERT_VALUES or ADD_VALUES 266201729b5cSPatrick Sanan - l - the local vector 266301729b5cSPatrick Sanan 266401729b5cSPatrick Sanan Notes: 266501729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 266601729b5cSPatrick Sanan DMGlobalToLocalBegin() and DMGlobalToLocalEnd(). 266701729b5cSPatrick Sanan 266801729b5cSPatrick Sanan Level: beginner 266901729b5cSPatrick Sanan 267001729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 267101729b5cSPatrick Sanan 267201729b5cSPatrick Sanan @*/ 267301729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l) 267401729b5cSPatrick Sanan { 267501729b5cSPatrick Sanan PetscErrorCode ierr; 267601729b5cSPatrick Sanan 267701729b5cSPatrick Sanan PetscFunctionBegin; 267801729b5cSPatrick Sanan ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr); 267901729b5cSPatrick Sanan ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr); 268001729b5cSPatrick Sanan PetscFunctionReturn(0); 268101729b5cSPatrick Sanan } 268201729b5cSPatrick Sanan 268301729b5cSPatrick Sanan /*@ 268447c6ae99SBarry Smith DMGlobalToLocalBegin - Begins updating local vectors from global vector 268547c6ae99SBarry Smith 2686d083f849SBarry Smith Neighbor-wise Collective on dm 268747c6ae99SBarry Smith 268847c6ae99SBarry Smith Input Parameters: 268947c6ae99SBarry Smith + dm - the DM object 269047c6ae99SBarry Smith . g - the global vector 269147c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 269247c6ae99SBarry Smith - l - the local vector 269347c6ae99SBarry Smith 269401729b5cSPatrick Sanan Level: intermediate 269547c6ae99SBarry Smith 269601729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 269747c6ae99SBarry Smith 269847c6ae99SBarry Smith @*/ 26997087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 270047c6ae99SBarry Smith { 27017128ae9fSMatthew G Knepley PetscSF sf; 270247c6ae99SBarry Smith PetscErrorCode ierr; 2703baf369e7SPeter Brune DMGlobalToLocalHookLink link; 270447c6ae99SBarry Smith 270547c6ae99SBarry Smith PetscFunctionBegin; 2706171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2707baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 27088865f1eaSKarl Rupp if (link->beginhook) { 27098865f1eaSKarl Rupp ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr); 27108865f1eaSKarl Rupp } 2711baf369e7SPeter Brune } 27121bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 27137128ae9fSMatthew G Knepley if (sf) { 2714ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2715ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2716d0295fc0SJunchao Zhang PetscMemType lmtype,gmtype; 27177128ae9fSMatthew G Knepley 27182c71b3e2SJacob Faibussowitsch PetscCheckFalse(mode == ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 2719a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2720a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2721ad227feaSJunchao Zhang ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr); 2722a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr); 2723a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr); 27247128ae9fSMatthew G Knepley } else { 27252c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->globaltolocalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name); 2726843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 27277128ae9fSMatthew G Knepley } 272847c6ae99SBarry Smith PetscFunctionReturn(0); 272947c6ae99SBarry Smith } 273047c6ae99SBarry Smith 273147c6ae99SBarry Smith /*@ 273247c6ae99SBarry Smith DMGlobalToLocalEnd - Ends updating local vectors from global vector 273347c6ae99SBarry Smith 2734d083f849SBarry Smith Neighbor-wise Collective on dm 273547c6ae99SBarry Smith 273647c6ae99SBarry Smith Input Parameters: 273747c6ae99SBarry Smith + dm - the DM object 273847c6ae99SBarry Smith . g - the global vector 273947c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 274047c6ae99SBarry Smith - l - the local vector 274147c6ae99SBarry Smith 274201729b5cSPatrick Sanan Level: intermediate 274347c6ae99SBarry Smith 274401729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd() 274547c6ae99SBarry Smith 274647c6ae99SBarry Smith @*/ 27477087cfbeSBarry Smith PetscErrorCode DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 274847c6ae99SBarry Smith { 27497128ae9fSMatthew G Knepley PetscSF sf; 275047c6ae99SBarry Smith PetscErrorCode ierr; 2751ae5cfb4aSMatthew G. Knepley const PetscScalar *gArray; 2752ae5cfb4aSMatthew G. Knepley PetscScalar *lArray; 2753ca3d3a14SMatthew G. Knepley PetscBool transform; 2754baf369e7SPeter Brune DMGlobalToLocalHookLink link; 2755d0295fc0SJunchao Zhang PetscMemType lmtype,gmtype; 275647c6ae99SBarry Smith 275747c6ae99SBarry Smith PetscFunctionBegin; 2758171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 27591bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 2760ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 27617128ae9fSMatthew G Knepley if (sf) { 27622c71b3e2SJacob Faibussowitsch PetscCheckFalse(mode == ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 27637128ae9fSMatthew G Knepley 2764a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2765a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2766ad227feaSJunchao Zhang ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr); 2767a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr); 2768a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr); 2769ca3d3a14SMatthew G. Knepley if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);} 27707128ae9fSMatthew G Knepley } else { 27712c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->globaltolocalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name); 2772843c4018SMatthew G Knepley ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 27737128ae9fSMatthew G Knepley } 27744c274da1SToby Isaac ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr); 2775baf369e7SPeter Brune for (link=dm->gtolhook; link; link=link->next) { 2776baf369e7SPeter Brune if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 2777baf369e7SPeter Brune } 277847c6ae99SBarry Smith PetscFunctionReturn(0); 277947c6ae99SBarry Smith } 278047c6ae99SBarry Smith 2781d4d07f1eSToby Isaac /*@C 2782d4d07f1eSToby Isaac DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called 2783d4d07f1eSToby Isaac 2784d4d07f1eSToby Isaac Logically Collective 2785d4d07f1eSToby Isaac 27864165533cSJose E. Roman Input Parameters: 2787d4d07f1eSToby Isaac + dm - the DM 2788d4d07f1eSToby Isaac . beginhook - function to run at the beginning of DMLocalToGlobalBegin() 2789d4d07f1eSToby Isaac . endhook - function to run after DMLocalToGlobalEnd() has completed 2790d4d07f1eSToby Isaac - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 2791d4d07f1eSToby Isaac 2792d4d07f1eSToby Isaac Calling sequence for beginhook: 2793d4d07f1eSToby Isaac $ beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2794d4d07f1eSToby Isaac 2795d4d07f1eSToby Isaac + dm - global DM 2796d4d07f1eSToby Isaac . l - local vector 2797d4d07f1eSToby Isaac . mode - mode 2798d4d07f1eSToby Isaac . g - global vector 2799d4d07f1eSToby Isaac - ctx - optional user-defined function context 2800d4d07f1eSToby Isaac 2801d4d07f1eSToby Isaac Calling sequence for endhook: 2802d4d07f1eSToby Isaac $ endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx) 2803d4d07f1eSToby Isaac 2804d4d07f1eSToby Isaac + global - global DM 2805d4d07f1eSToby Isaac . l - local vector 2806d4d07f1eSToby Isaac . mode - mode 2807d4d07f1eSToby Isaac . g - global vector 2808d4d07f1eSToby Isaac - ctx - optional user-defined function context 2809d4d07f1eSToby Isaac 2810d4d07f1eSToby Isaac Level: advanced 2811d4d07f1eSToby Isaac 2812d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 2813d4d07f1eSToby Isaac @*/ 2814d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx) 2815d4d07f1eSToby Isaac { 2816d4d07f1eSToby Isaac PetscErrorCode ierr; 2817d4d07f1eSToby Isaac DMLocalToGlobalHookLink link,*p; 2818d4d07f1eSToby Isaac 2819d4d07f1eSToby Isaac PetscFunctionBegin; 2820d4d07f1eSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2821d4d07f1eSToby Isaac for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */ 282295dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 2823d4d07f1eSToby Isaac link->beginhook = beginhook; 2824d4d07f1eSToby Isaac link->endhook = endhook; 2825d4d07f1eSToby Isaac link->ctx = ctx; 2826d4d07f1eSToby Isaac link->next = NULL; 2827d4d07f1eSToby Isaac *p = link; 2828d4d07f1eSToby Isaac PetscFunctionReturn(0); 2829d4d07f1eSToby Isaac } 2830d4d07f1eSToby Isaac 28314c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx) 28324c274da1SToby Isaac { 28334c274da1SToby Isaac Mat cMat; 28344c274da1SToby Isaac Vec cVec; 28354c274da1SToby Isaac PetscSection section, cSec; 28364c274da1SToby Isaac PetscInt pStart, pEnd, p, dof; 28374c274da1SToby Isaac PetscErrorCode ierr; 28384c274da1SToby Isaac 28394c274da1SToby Isaac PetscFunctionBegin; 28404c274da1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 284179769bd5SJed Brown ierr = DMGetDefaultConstraints(dm,&cSec,&cMat,NULL);CHKERRQ(ierr); 28424c274da1SToby Isaac if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) { 28435db9a05bSToby Isaac PetscInt nRows; 28445db9a05bSToby Isaac 28455db9a05bSToby Isaac ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr); 28465db9a05bSToby Isaac if (nRows <= 0) PetscFunctionReturn(0); 284792fd8e1eSJed Brown ierr = DMGetLocalSection(dm,§ion);CHKERRQ(ierr); 28487711e48fSToby Isaac ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr); 28494c274da1SToby Isaac ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr); 28504c274da1SToby Isaac for (p = pStart; p < pEnd; p++) { 28514c274da1SToby Isaac ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr); 28524c274da1SToby Isaac if (dof) { 28534c274da1SToby Isaac PetscInt d; 28544c274da1SToby Isaac PetscScalar *vals; 28554c274da1SToby Isaac ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr); 28564c274da1SToby Isaac ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr); 28574c274da1SToby Isaac /* for this to be the true transpose, we have to zero the values that 28584c274da1SToby Isaac * we just extracted */ 28594c274da1SToby Isaac for (d = 0; d < dof; d++) { 28604c274da1SToby Isaac vals[d] = 0.; 28614c274da1SToby Isaac } 28624c274da1SToby Isaac } 28634c274da1SToby Isaac } 28644c274da1SToby Isaac ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr); 28654c274da1SToby Isaac ierr = VecDestroy(&cVec);CHKERRQ(ierr); 28664c274da1SToby Isaac } 28674c274da1SToby Isaac PetscFunctionReturn(0); 28684c274da1SToby Isaac } 286901729b5cSPatrick Sanan /*@ 287001729b5cSPatrick Sanan DMLocalToGlobal - updates global vectors from local vectors 287101729b5cSPatrick Sanan 2872d083f849SBarry Smith Neighbor-wise Collective on dm 287301729b5cSPatrick Sanan 287401729b5cSPatrick Sanan Input Parameters: 287501729b5cSPatrick Sanan + dm - the DM object 287601729b5cSPatrick Sanan . l - the local vector 287701729b5cSPatrick 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. 287801729b5cSPatrick Sanan - g - the global vector 287901729b5cSPatrick Sanan 288001729b5cSPatrick Sanan Notes: 288101729b5cSPatrick Sanan The communication involved in this update can be overlapped with computation by using 288201729b5cSPatrick Sanan DMLocalToGlobalBegin() and DMLocalToGlobalEnd(). 288301729b5cSPatrick Sanan 288401729b5cSPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 288501729b5cSPatrick 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. 288601729b5cSPatrick Sanan 288701729b5cSPatrick Sanan Level: beginner 288801729b5cSPatrick Sanan 288901729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 289001729b5cSPatrick Sanan 289101729b5cSPatrick Sanan @*/ 289201729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g) 289301729b5cSPatrick Sanan { 289401729b5cSPatrick Sanan PetscErrorCode ierr; 289501729b5cSPatrick Sanan 289601729b5cSPatrick Sanan PetscFunctionBegin; 289701729b5cSPatrick Sanan ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr); 289801729b5cSPatrick Sanan ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr); 289901729b5cSPatrick Sanan PetscFunctionReturn(0); 290001729b5cSPatrick Sanan } 29014c274da1SToby Isaac 290247c6ae99SBarry Smith /*@ 290301729b5cSPatrick Sanan DMLocalToGlobalBegin - begins updating global vectors from local vectors 29049a42bb27SBarry Smith 2905d083f849SBarry Smith Neighbor-wise Collective on dm 29069a42bb27SBarry Smith 29079a42bb27SBarry Smith Input Parameters: 29089a42bb27SBarry Smith + dm - the DM object 2909f6813fd5SJed Brown . l - the local vector 29101eb28f2eSBarry 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. 29111eb28f2eSBarry Smith - g - the global vector 29129a42bb27SBarry Smith 291395452b02SPatrick Sanan Notes: 291495452b02SPatrick Sanan In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation. 291584330215SMatthew 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. 29169a42bb27SBarry Smith 291701729b5cSPatrick Sanan Level: intermediate 29189a42bb27SBarry Smith 291901729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin() 29209a42bb27SBarry Smith 29219a42bb27SBarry Smith @*/ 29227087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g) 29239a42bb27SBarry Smith { 29247128ae9fSMatthew G Knepley PetscSF sf; 292584330215SMatthew G. Knepley PetscSection s, gs; 2926d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 2927ca3d3a14SMatthew G. Knepley Vec tmpl; 2928ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 2929ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 2930fa88e482SJed Brown PetscBool isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE; 293184330215SMatthew G. Knepley PetscErrorCode ierr; 2932d0295fc0SJunchao Zhang PetscMemType lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST; 29339a42bb27SBarry Smith 29349a42bb27SBarry Smith PetscFunctionBegin; 2935171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 2936d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 2937d4d07f1eSToby Isaac if (link->beginhook) { 2938d4d07f1eSToby Isaac ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr); 2939d4d07f1eSToby Isaac } 2940d4d07f1eSToby Isaac } 29414c274da1SToby Isaac ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr); 29421bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 294392fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 29447128ae9fSMatthew G Knepley switch (mode) { 29457128ae9fSMatthew G Knepley case INSERT_VALUES: 29467128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 2947304ab55fSMatthew G. Knepley case INSERT_BC_VALUES: 294884330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 29497128ae9fSMatthew G Knepley case ADD_VALUES: 29507128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 2951304ab55fSMatthew G. Knepley case ADD_BC_VALUES: 295284330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 29537128ae9fSMatthew G Knepley default: 295498921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 29557128ae9fSMatthew G Knepley } 2956ca3d3a14SMatthew G. Knepley if ((sf && !isInsert) || (s && isInsert)) { 2957ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 2958ca3d3a14SMatthew G. Knepley if (transform) { 2959ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 2960ca3d3a14SMatthew G. Knepley ierr = VecCopy(l, tmpl);CHKERRQ(ierr); 2961ca3d3a14SMatthew G. Knepley ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr); 2962ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 2963fa88e482SJed Brown } else if (isInsert) { 2964ae5cfb4aSMatthew G. Knepley ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr); 2965fa88e482SJed Brown } else { 2966a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr); 2967fa88e482SJed Brown l_inplace = PETSC_TRUE; 2968ca3d3a14SMatthew G. Knepley } 2969fa88e482SJed Brown if (s && isInsert) { 29707128ae9fSMatthew G Knepley ierr = VecGetArray(g, &gArray);CHKERRQ(ierr); 2971fa88e482SJed Brown } else { 2972a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr); 2973fa88e482SJed Brown g_inplace = PETSC_TRUE; 2974fa88e482SJed Brown } 2975ca3d3a14SMatthew G. Knepley if (sf && !isInsert) { 2976d0295fc0SJunchao Zhang ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr); 297784330215SMatthew G. Knepley } else if (s && isInsert) { 297884330215SMatthew G. Knepley PetscInt gStart, pStart, pEnd, p; 297984330215SMatthew G. Knepley 2980e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr); 298184330215SMatthew G. Knepley ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr); 298284330215SMatthew G. Knepley ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr); 298384330215SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 2984b3b16f48SMatthew G. Knepley PetscInt dof, gdof, cdof, gcdof, off, goff, d, e; 298584330215SMatthew G. Knepley 298684330215SMatthew G. Knepley ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr); 298703442857SMatthew G. Knepley ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr); 298884330215SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr); 2989b3b16f48SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr); 299084330215SMatthew G. Knepley ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr); 299184330215SMatthew G. Knepley ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr); 2992b3b16f48SMatthew G. Knepley /* Ignore off-process data and points with no global data */ 299303442857SMatthew G. Knepley if (!gdof || goff < 0) continue; 29942c71b3e2SJacob Faibussowitsch PetscCheckFalse(dof != gdof,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof); 2995b3b16f48SMatthew G. Knepley /* If no constraints are enforced in the global vector */ 2996b3b16f48SMatthew G. Knepley if (!gcdof) { 299784330215SMatthew G. Knepley for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d]; 2998b3b16f48SMatthew G. Knepley /* If constraints are enforced in the global vector */ 2999b3b16f48SMatthew G. Knepley } else if (cdof == gcdof) { 300084330215SMatthew G. Knepley const PetscInt *cdofs; 300184330215SMatthew G. Knepley PetscInt cind = 0; 300284330215SMatthew G. Knepley 300384330215SMatthew G. Knepley ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr); 3004b3b16f48SMatthew G. Knepley for (d = 0, e = 0; d < dof; ++d) { 300584330215SMatthew G. Knepley if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;} 3006b3b16f48SMatthew G. Knepley gArray[goff-gStart+e++] = lArray[off+d]; 300784330215SMatthew G. Knepley } 300898921bdaSJacob Faibussowitsch } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof); 300984330215SMatthew G. Knepley } 3010ca3d3a14SMatthew G. Knepley } 3011fa88e482SJed Brown if (g_inplace) { 3012a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr); 3013fa88e482SJed Brown } else { 30147128ae9fSMatthew G Knepley ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr); 3015fa88e482SJed Brown } 3016ca3d3a14SMatthew G. Knepley if (transform) { 3017ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 3018ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 3019fa88e482SJed Brown } else if (l_inplace) { 3020a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr); 3021ca3d3a14SMatthew G. Knepley } else { 3022ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr); 3023ca3d3a14SMatthew G. Knepley } 30247128ae9fSMatthew G Knepley } else { 30252c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->localtoglobalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name); 3026843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 30277128ae9fSMatthew G Knepley } 30289a42bb27SBarry Smith PetscFunctionReturn(0); 30299a42bb27SBarry Smith } 30309a42bb27SBarry Smith 30319a42bb27SBarry Smith /*@ 30329a42bb27SBarry Smith DMLocalToGlobalEnd - updates global vectors from local vectors 303347c6ae99SBarry Smith 3034d083f849SBarry Smith Neighbor-wise Collective on dm 303547c6ae99SBarry Smith 303647c6ae99SBarry Smith Input Parameters: 303747c6ae99SBarry Smith + dm - the DM object 3038f6813fd5SJed Brown . l - the local vector 303947c6ae99SBarry Smith . mode - INSERT_VALUES or ADD_VALUES 3040f6813fd5SJed Brown - g - the global vector 304147c6ae99SBarry Smith 304201729b5cSPatrick Sanan Level: intermediate 304347c6ae99SBarry Smith 3044e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd() 304547c6ae99SBarry Smith 304647c6ae99SBarry Smith @*/ 30477087cfbeSBarry Smith PetscErrorCode DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g) 304847c6ae99SBarry Smith { 30497128ae9fSMatthew G Knepley PetscSF sf; 305084330215SMatthew G. Knepley PetscSection s; 3051d4d07f1eSToby Isaac DMLocalToGlobalHookLink link; 3052ca3d3a14SMatthew G. Knepley PetscBool isInsert, transform; 305384330215SMatthew G. Knepley PetscErrorCode ierr; 305447c6ae99SBarry Smith 305547c6ae99SBarry Smith PetscFunctionBegin; 3056171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 30571bb6d2a8SBarry Smith ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr); 305892fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 30597128ae9fSMatthew G Knepley switch (mode) { 30607128ae9fSMatthew G Knepley case INSERT_VALUES: 30617128ae9fSMatthew G Knepley case INSERT_ALL_VALUES: 306284330215SMatthew G. Knepley isInsert = PETSC_TRUE; break; 30637128ae9fSMatthew G Knepley case ADD_VALUES: 30647128ae9fSMatthew G Knepley case ADD_ALL_VALUES: 306584330215SMatthew G. Knepley isInsert = PETSC_FALSE; break; 30667128ae9fSMatthew G Knepley default: 306798921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode); 30687128ae9fSMatthew G Knepley } 306984330215SMatthew G. Knepley if (sf && !isInsert) { 3070ae5cfb4aSMatthew G. Knepley const PetscScalar *lArray; 3071ae5cfb4aSMatthew G. Knepley PetscScalar *gArray; 3072ca3d3a14SMatthew G. Knepley Vec tmpl; 307384330215SMatthew G. Knepley 3074ca3d3a14SMatthew G. Knepley ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr); 3075ca3d3a14SMatthew G. Knepley if (transform) { 3076ca3d3a14SMatthew G. Knepley ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 3077ca3d3a14SMatthew G. Knepley ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr); 3078ca3d3a14SMatthew G. Knepley } else { 3079a256111fSJunchao Zhang ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr); 3080ca3d3a14SMatthew G. Knepley } 3081a256111fSJunchao Zhang ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr); 3082a9b180a6SBarry Smith ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr); 3083ca3d3a14SMatthew G. Knepley if (transform) { 3084ca3d3a14SMatthew G. Knepley ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr); 3085ca3d3a14SMatthew G. Knepley ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr); 3086ca3d3a14SMatthew G. Knepley } else { 3087a256111fSJunchao Zhang ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr); 3088ca3d3a14SMatthew G. Knepley } 3089a256111fSJunchao Zhang ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr); 309084330215SMatthew G. Knepley } else if (s && isInsert) { 30917128ae9fSMatthew G Knepley } else { 30922c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->localtoglobalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name); 3093843c4018SMatthew G Knepley ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr); 30947128ae9fSMatthew G Knepley } 3095d4d07f1eSToby Isaac for (link=dm->ltoghook; link; link=link->next) { 3096d4d07f1eSToby Isaac if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);} 3097d4d07f1eSToby Isaac } 309847c6ae99SBarry Smith PetscFunctionReturn(0); 309947c6ae99SBarry Smith } 310047c6ae99SBarry Smith 3101f089877aSRichard Tran Mills /*@ 3102bc0a1609SRichard Tran Mills DMLocalToLocalBegin - Maps from a local vector (including ghost points 3103bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 3104d78e899eSRichard Tran Mills points in the second are set correctly. Must be followed by DMLocalToLocalEnd(). 3105f089877aSRichard Tran Mills 3106d083f849SBarry Smith Neighbor-wise Collective on dm 3107f089877aSRichard Tran Mills 3108f089877aSRichard Tran Mills Input Parameters: 3109f089877aSRichard Tran Mills + dm - the DM object 3110bc0a1609SRichard Tran Mills . g - the original local vector 3111bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 3112f089877aSRichard Tran Mills 3113bc0a1609SRichard Tran Mills Output Parameter: 3114bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 3115f089877aSRichard Tran Mills 3116f089877aSRichard Tran Mills Level: intermediate 3117f089877aSRichard Tran Mills 3118bc0a1609SRichard Tran Mills Notes: 3119bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 3120bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 3121bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 3122bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 3123bc0a1609SRichard Tran Mills 3124bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 3125f089877aSRichard Tran Mills 3126f089877aSRichard Tran Mills @*/ 3127f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l) 3128f089877aSRichard Tran Mills { 3129f089877aSRichard Tran Mills PetscErrorCode ierr; 3130f089877aSRichard Tran Mills 3131f089877aSRichard Tran Mills PetscFunctionBegin; 3132f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 31332c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->localtolocalbegin,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 3134f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 3135f089877aSRichard Tran Mills PetscFunctionReturn(0); 3136f089877aSRichard Tran Mills } 3137f089877aSRichard Tran Mills 3138f089877aSRichard Tran Mills /*@ 3139bc0a1609SRichard Tran Mills DMLocalToLocalEnd - Maps from a local vector (including ghost points 3140bc0a1609SRichard Tran Mills that contain irrelevant values) to another local vector where the ghost 3141d78e899eSRichard Tran Mills points in the second are set correctly. Must be preceded by DMLocalToLocalBegin(). 3142f089877aSRichard Tran Mills 3143d083f849SBarry Smith Neighbor-wise Collective on dm 3144f089877aSRichard Tran Mills 3145f089877aSRichard Tran Mills Input Parameters: 3146bc0a1609SRichard Tran Mills + da - the DM object 3147bc0a1609SRichard Tran Mills . g - the original local vector 3148bc0a1609SRichard Tran Mills - mode - one of INSERT_VALUES or ADD_VALUES 3149f089877aSRichard Tran Mills 3150bc0a1609SRichard Tran Mills Output Parameter: 3151bc0a1609SRichard Tran Mills . l - the local vector with correct ghost values 3152f089877aSRichard Tran Mills 3153f089877aSRichard Tran Mills Level: intermediate 3154f089877aSRichard Tran Mills 3155bc0a1609SRichard Tran Mills Notes: 3156bc0a1609SRichard Tran Mills The local vectors used here need not be the same as those 3157bc0a1609SRichard Tran Mills obtained from DMCreateLocalVector(), BUT they 3158bc0a1609SRichard Tran Mills must have the same parallel data layout; they could, for example, be 3159bc0a1609SRichard Tran Mills obtained with VecDuplicate() from the DM originating vectors. 3160bc0a1609SRichard Tran Mills 3161bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin() 3162f089877aSRichard Tran Mills 3163f089877aSRichard Tran Mills @*/ 3164f089877aSRichard Tran Mills PetscErrorCode DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) 3165f089877aSRichard Tran Mills { 3166f089877aSRichard Tran Mills PetscErrorCode ierr; 3167f089877aSRichard Tran Mills 3168f089877aSRichard Tran Mills PetscFunctionBegin; 3169f089877aSRichard Tran Mills PetscValidHeaderSpecific(dm,DM_CLASSID,1); 31702c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->localtolocalend,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps"); 3171f089877aSRichard Tran Mills ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr); 3172f089877aSRichard Tran Mills PetscFunctionReturn(0); 3173f089877aSRichard Tran Mills } 3174f089877aSRichard Tran Mills 317547c6ae99SBarry Smith /*@ 317647c6ae99SBarry Smith DMCoarsen - Coarsens a DM object 317747c6ae99SBarry Smith 3178d083f849SBarry Smith Collective on dm 317947c6ae99SBarry Smith 3180d8d19677SJose E. Roman Input Parameters: 318147c6ae99SBarry Smith + dm - the DM object 318291d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL) 318347c6ae99SBarry Smith 318447c6ae99SBarry Smith Output Parameter: 318547c6ae99SBarry Smith . dmc - the coarsened DM 318647c6ae99SBarry Smith 318747c6ae99SBarry Smith Level: developer 318847c6ae99SBarry Smith 3189e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 319047c6ae99SBarry Smith 319147c6ae99SBarry Smith @*/ 31927087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc) 319347c6ae99SBarry Smith { 319447c6ae99SBarry Smith PetscErrorCode ierr; 3195b17ce1afSJed Brown DMCoarsenHookLink link; 319647c6ae99SBarry Smith 319747c6ae99SBarry Smith PetscFunctionBegin; 3198171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 31992c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->coarsen,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name); 320047a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 320147c6ae99SBarry Smith ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr); 3202b9d85ea2SLisandro Dalcin if (*dmc) { 3203a3574896SRichard Tran Mills (*dmc)->bind_below = dm->bind_below; /* Propagate this from parent DM; otherwise -dm_bind_below will be useless for multigrid cases. */ 3204a8fb8f29SToby Isaac ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr); 320543842a1eSJed Brown (*dmc)->ops->creatematrix = dm->ops->creatematrix; 32068cd211a4SJed Brown ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr); 3207644e2e5bSBarry Smith (*dmc)->ctx = dm->ctx; 32080598a293SJed Brown (*dmc)->levelup = dm->levelup; 3209656b349aSBarry Smith (*dmc)->leveldown = dm->leveldown + 1; 3210e4b4b23bSJed Brown ierr = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr); 3211b17ce1afSJed Brown for (link=dm->coarsenhook; link; link=link->next) { 3212b17ce1afSJed Brown if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);} 3213b17ce1afSJed Brown } 3214b9d85ea2SLisandro Dalcin } 321547a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr); 32162c71b3e2SJacob Faibussowitsch PetscCheckFalse(!(*dmc),PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced"); 3217b17ce1afSJed Brown PetscFunctionReturn(0); 3218b17ce1afSJed Brown } 3219b17ce1afSJed Brown 3220bb9467b5SJed Brown /*@C 3221b17ce1afSJed Brown DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid 3222b17ce1afSJed Brown 3223b17ce1afSJed Brown Logically Collective 3224b17ce1afSJed Brown 32254165533cSJose E. Roman Input Parameters: 3226b17ce1afSJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 3227b17ce1afSJed Brown . coarsenhook - function to run when setting up a coarser level 3228b17ce1afSJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 32290298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3230b17ce1afSJed Brown 3231b17ce1afSJed Brown Calling sequence of coarsenhook: 3232b17ce1afSJed Brown $ coarsenhook(DM fine,DM coarse,void *ctx); 3233b17ce1afSJed Brown 3234b17ce1afSJed Brown + fine - fine level DM 3235b17ce1afSJed Brown . coarse - coarse level DM to restrict problem to 3236b17ce1afSJed Brown - ctx - optional user-defined function context 3237b17ce1afSJed Brown 3238b17ce1afSJed Brown Calling sequence for restricthook: 3239c833c3b5SJed Brown $ restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx) 3240b17ce1afSJed Brown 3241b17ce1afSJed Brown + fine - fine level DM 3242b17ce1afSJed Brown . mrestrict - matrix restricting a fine-level solution to the coarse grid 3243c833c3b5SJed Brown . rscale - scaling vector for restriction 3244c833c3b5SJed Brown . inject - matrix restricting by injection 3245b17ce1afSJed Brown . coarse - coarse level DM to update 3246b17ce1afSJed Brown - ctx - optional user-defined function context 3247b17ce1afSJed Brown 3248b17ce1afSJed Brown Level: advanced 3249b17ce1afSJed Brown 3250b17ce1afSJed Brown Notes: 3251b17ce1afSJed Brown This function is only needed if auxiliary data needs to be set up on coarse grids. 3252b17ce1afSJed Brown 3253b17ce1afSJed Brown If this function is called multiple times, the hooks will be run in the order they are added. 3254b17ce1afSJed Brown 3255b17ce1afSJed Brown In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3256b17ce1afSJed Brown extract the finest level information from its context (instead of from the SNES). 3257b17ce1afSJed Brown 3258bb9467b5SJed Brown This function is currently not available from Fortran. 3259bb9467b5SJed Brown 3260dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3261b17ce1afSJed Brown @*/ 3262b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 3263b17ce1afSJed Brown { 3264b17ce1afSJed Brown PetscErrorCode ierr; 3265b17ce1afSJed Brown DMCoarsenHookLink link,*p; 3266b17ce1afSJed Brown 3267b17ce1afSJed Brown PetscFunctionBegin; 3268b17ce1afSJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 32691e3d8eccSJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 32701e3d8eccSJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 32711e3d8eccSJed Brown } 327295dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 3273b17ce1afSJed Brown link->coarsenhook = coarsenhook; 3274b17ce1afSJed Brown link->restricthook = restricthook; 3275b17ce1afSJed Brown link->ctx = ctx; 32760298fd71SBarry Smith link->next = NULL; 3277b17ce1afSJed Brown *p = link; 3278b17ce1afSJed Brown PetscFunctionReturn(0); 3279b17ce1afSJed Brown } 3280b17ce1afSJed Brown 3281dc822a44SJed Brown /*@C 3282dc822a44SJed Brown DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid 3283dc822a44SJed Brown 3284dc822a44SJed Brown Logically Collective 3285dc822a44SJed Brown 32864165533cSJose E. Roman Input Parameters: 3287dc822a44SJed Brown + fine - nonlinear solver context on which to run a hook when restricting to a coarser level 3288dc822a44SJed Brown . coarsenhook - function to run when setting up a coarser level 3289dc822a44SJed Brown . restricthook - function to run to update data on coarser levels (once per SNESSolve()) 3290dc822a44SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3291dc822a44SJed Brown 3292dc822a44SJed Brown Level: advanced 3293dc822a44SJed Brown 3294dc822a44SJed Brown Notes: 3295dc822a44SJed Brown This function does nothing if the hook is not in the list. 3296dc822a44SJed Brown 3297dc822a44SJed Brown This function is currently not available from Fortran. 3298dc822a44SJed Brown 3299dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3300dc822a44SJed Brown @*/ 3301dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx) 3302dc822a44SJed Brown { 3303dc822a44SJed Brown PetscErrorCode ierr; 3304dc822a44SJed Brown DMCoarsenHookLink link,*p; 3305dc822a44SJed Brown 3306dc822a44SJed Brown PetscFunctionBegin; 3307dc822a44SJed Brown PetscValidHeaderSpecific(fine,DM_CLASSID,1); 3308dc822a44SJed Brown for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3309dc822a44SJed Brown if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3310dc822a44SJed Brown link = *p; 3311dc822a44SJed Brown *p = link->next; 3312dc822a44SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3313dc822a44SJed Brown break; 3314dc822a44SJed Brown } 3315dc822a44SJed Brown } 3316dc822a44SJed Brown PetscFunctionReturn(0); 3317dc822a44SJed Brown } 3318dc822a44SJed Brown 3319b17ce1afSJed Brown /*@ 3320b17ce1afSJed Brown DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd() 3321b17ce1afSJed Brown 3322b17ce1afSJed Brown Collective if any hooks are 3323b17ce1afSJed Brown 33244165533cSJose E. Roman Input Parameters: 3325b17ce1afSJed Brown + fine - finer DM to use as a base 3326b17ce1afSJed Brown . restrct - restriction matrix, apply using MatRestrict() 3327e91eccc2SStefano Zampini . rscale - scaling vector for restriction 3328b17ce1afSJed Brown . inject - injection matrix, also use MatRestrict() 3329e91eccc2SStefano Zampini - coarse - coarser DM to update 3330b17ce1afSJed Brown 3331b17ce1afSJed Brown Level: developer 3332b17ce1afSJed Brown 3333b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict() 3334b17ce1afSJed Brown @*/ 3335b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse) 3336b17ce1afSJed Brown { 3337b17ce1afSJed Brown PetscErrorCode ierr; 3338b17ce1afSJed Brown DMCoarsenHookLink link; 3339b17ce1afSJed Brown 3340b17ce1afSJed Brown PetscFunctionBegin; 3341b17ce1afSJed Brown for (link=fine->coarsenhook; link; link=link->next) { 33428865f1eaSKarl Rupp if (link->restricthook) { 33438865f1eaSKarl Rupp ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr); 33448865f1eaSKarl Rupp } 3345b17ce1afSJed Brown } 334647c6ae99SBarry Smith PetscFunctionReturn(0); 334747c6ae99SBarry Smith } 334847c6ae99SBarry Smith 3349bb9467b5SJed Brown /*@C 3350be081cd6SPeter Brune DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid 33515dbd56e3SPeter Brune 3352d083f849SBarry Smith Logically Collective on global 33535dbd56e3SPeter Brune 33544165533cSJose E. Roman Input Parameters: 33555dbd56e3SPeter Brune + global - global DM 3356ec4806b8SPeter Brune . ddhook - function to run to pass data to the decomposition DM upon its creation 33575dbd56e3SPeter Brune . restricthook - function to run to update data on block solve (at the beginning of the block solve) 33580298fd71SBarry Smith - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 33595dbd56e3SPeter Brune 3360ec4806b8SPeter Brune Calling sequence for ddhook: 3361ec4806b8SPeter Brune $ ddhook(DM global,DM block,void *ctx) 3362ec4806b8SPeter Brune 3363ec4806b8SPeter Brune + global - global DM 3364ec4806b8SPeter Brune . block - block DM 3365ec4806b8SPeter Brune - ctx - optional user-defined function context 3366ec4806b8SPeter Brune 33675dbd56e3SPeter Brune Calling sequence for restricthook: 3368ec4806b8SPeter Brune $ restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx) 33695dbd56e3SPeter Brune 33705dbd56e3SPeter Brune + global - global DM 33715dbd56e3SPeter Brune . out - scatter to the outer (with ghost and overlap points) block vector 33725dbd56e3SPeter Brune . in - scatter to block vector values only owned locally 3373ec4806b8SPeter Brune . block - block DM 33745dbd56e3SPeter Brune - ctx - optional user-defined function context 33755dbd56e3SPeter Brune 33765dbd56e3SPeter Brune Level: advanced 33775dbd56e3SPeter Brune 33785dbd56e3SPeter Brune Notes: 3379ec4806b8SPeter Brune This function is only needed if auxiliary data needs to be set up on subdomain DMs. 33805dbd56e3SPeter Brune 33815dbd56e3SPeter Brune If this function is called multiple times, the hooks will be run in the order they are added. 33825dbd56e3SPeter Brune 33835dbd56e3SPeter Brune In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to 3384ec4806b8SPeter Brune extract the global information from its context (instead of from the SNES). 33855dbd56e3SPeter Brune 3386bb9467b5SJed Brown This function is currently not available from Fortran. 3387bb9467b5SJed Brown 33885dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 33895dbd56e3SPeter Brune @*/ 3390be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 33915dbd56e3SPeter Brune { 33925dbd56e3SPeter Brune PetscErrorCode ierr; 3393be081cd6SPeter Brune DMSubDomainHookLink link,*p; 33945dbd56e3SPeter Brune 33955dbd56e3SPeter Brune PetscFunctionBegin; 33965dbd56e3SPeter Brune PetscValidHeaderSpecific(global,DM_CLASSID,1); 3397b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */ 3398b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0); 3399b3a6b972SJed Brown } 340095dccacaSBarry Smith ierr = PetscNew(&link);CHKERRQ(ierr); 34015dbd56e3SPeter Brune link->restricthook = restricthook; 3402be081cd6SPeter Brune link->ddhook = ddhook; 34035dbd56e3SPeter Brune link->ctx = ctx; 34040298fd71SBarry Smith link->next = NULL; 34055dbd56e3SPeter Brune *p = link; 34065dbd56e3SPeter Brune PetscFunctionReturn(0); 34075dbd56e3SPeter Brune } 34085dbd56e3SPeter Brune 3409b3a6b972SJed Brown /*@C 3410b3a6b972SJed Brown DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid 3411b3a6b972SJed Brown 3412b3a6b972SJed Brown Logically Collective 3413b3a6b972SJed Brown 34144165533cSJose E. Roman Input Parameters: 3415b3a6b972SJed Brown + global - global DM 3416b3a6b972SJed Brown . ddhook - function to run to pass data to the decomposition DM upon its creation 3417b3a6b972SJed Brown . restricthook - function to run to update data on block solve (at the beginning of the block solve) 3418b3a6b972SJed Brown - ctx - [optional] user-defined context for provide data for the hooks (may be NULL) 3419b3a6b972SJed Brown 3420b3a6b972SJed Brown Level: advanced 3421b3a6b972SJed Brown 3422b3a6b972SJed Brown Notes: 3423b3a6b972SJed Brown 3424b3a6b972SJed Brown This function is currently not available from Fortran. 3425b3a6b972SJed Brown 3426b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate() 3427b3a6b972SJed Brown @*/ 3428b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx) 3429b3a6b972SJed Brown { 3430b3a6b972SJed Brown PetscErrorCode ierr; 3431b3a6b972SJed Brown DMSubDomainHookLink link,*p; 3432b3a6b972SJed Brown 3433b3a6b972SJed Brown PetscFunctionBegin; 3434b3a6b972SJed Brown PetscValidHeaderSpecific(global,DM_CLASSID,1); 3435b3a6b972SJed Brown for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */ 3436b3a6b972SJed Brown if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) { 3437b3a6b972SJed Brown link = *p; 3438b3a6b972SJed Brown *p = link->next; 3439b3a6b972SJed Brown ierr = PetscFree(link);CHKERRQ(ierr); 3440b3a6b972SJed Brown break; 3441b3a6b972SJed Brown } 3442b3a6b972SJed Brown } 3443b3a6b972SJed Brown PetscFunctionReturn(0); 3444b3a6b972SJed Brown } 3445b3a6b972SJed Brown 34465dbd56e3SPeter Brune /*@ 3447be081cd6SPeter Brune DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd() 34485dbd56e3SPeter Brune 34495dbd56e3SPeter Brune Collective if any hooks are 34505dbd56e3SPeter Brune 34514165533cSJose E. Roman Input Parameters: 34525dbd56e3SPeter Brune + fine - finer DM to use as a base 3453be081cd6SPeter Brune . oscatter - scatter from domain global vector filling subdomain global vector with overlap 3454be081cd6SPeter Brune . gscatter - scatter from domain global vector filling subdomain local vector with ghosts 34555dbd56e3SPeter Brune - coarse - coarer DM to update 34565dbd56e3SPeter Brune 34575dbd56e3SPeter Brune Level: developer 34585dbd56e3SPeter Brune 34595dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict() 34605dbd56e3SPeter Brune @*/ 3461be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm) 34625dbd56e3SPeter Brune { 34635dbd56e3SPeter Brune PetscErrorCode ierr; 3464be081cd6SPeter Brune DMSubDomainHookLink link; 34655dbd56e3SPeter Brune 34665dbd56e3SPeter Brune PetscFunctionBegin; 3467be081cd6SPeter Brune for (link=global->subdomainhook; link; link=link->next) { 34688865f1eaSKarl Rupp if (link->restricthook) { 34698865f1eaSKarl Rupp ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr); 34708865f1eaSKarl Rupp } 34715dbd56e3SPeter Brune } 34725dbd56e3SPeter Brune PetscFunctionReturn(0); 34735dbd56e3SPeter Brune } 34745dbd56e3SPeter Brune 34755fe1f584SPeter Brune /*@ 34766a7d9d85SPeter Brune DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM. 34775fe1f584SPeter Brune 34785fe1f584SPeter Brune Not Collective 34795fe1f584SPeter Brune 34805fe1f584SPeter Brune Input Parameter: 34815fe1f584SPeter Brune . dm - the DM object 34825fe1f584SPeter Brune 34835fe1f584SPeter Brune Output Parameter: 34846a7d9d85SPeter Brune . level - number of coarsenings 34855fe1f584SPeter Brune 34865fe1f584SPeter Brune Level: developer 34875fe1f584SPeter Brune 34886a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 34895fe1f584SPeter Brune 34905fe1f584SPeter Brune @*/ 34915fe1f584SPeter Brune PetscErrorCode DMGetCoarsenLevel(DM dm,PetscInt *level) 34925fe1f584SPeter Brune { 34935fe1f584SPeter Brune PetscFunctionBegin; 34945fe1f584SPeter Brune PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3495b9d85ea2SLisandro Dalcin PetscValidIntPointer(level,2); 34965fe1f584SPeter Brune *level = dm->leveldown; 34975fe1f584SPeter Brune PetscFunctionReturn(0); 34985fe1f584SPeter Brune } 34995fe1f584SPeter Brune 35009a64c4a8SMatthew G. Knepley /*@ 35019a64c4a8SMatthew G. Knepley DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM. 35029a64c4a8SMatthew G. Knepley 35039a64c4a8SMatthew G. Knepley Not Collective 35049a64c4a8SMatthew G. Knepley 35059a64c4a8SMatthew G. Knepley Input Parameters: 35069a64c4a8SMatthew G. Knepley + dm - the DM object 35079a64c4a8SMatthew G. Knepley - level - number of coarsenings 35089a64c4a8SMatthew G. Knepley 35099a64c4a8SMatthew G. Knepley Level: developer 35109a64c4a8SMatthew G. Knepley 35119a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 35129a64c4a8SMatthew G. Knepley @*/ 35139a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level) 35149a64c4a8SMatthew G. Knepley { 35159a64c4a8SMatthew G. Knepley PetscFunctionBegin; 35169a64c4a8SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35179a64c4a8SMatthew G. Knepley dm->leveldown = level; 35189a64c4a8SMatthew G. Knepley PetscFunctionReturn(0); 35199a64c4a8SMatthew G. Knepley } 35209a64c4a8SMatthew G. Knepley 352147c6ae99SBarry Smith /*@C 352247c6ae99SBarry Smith DMRefineHierarchy - Refines a DM object, all levels at once 352347c6ae99SBarry Smith 3524d083f849SBarry Smith Collective on dm 352547c6ae99SBarry Smith 3526d8d19677SJose E. Roman Input Parameters: 352747c6ae99SBarry Smith + dm - the DM object 352847c6ae99SBarry Smith - nlevels - the number of levels of refinement 352947c6ae99SBarry Smith 353047c6ae99SBarry Smith Output Parameter: 353147c6ae99SBarry Smith . dmf - the refined DM hierarchy 353247c6ae99SBarry Smith 353347c6ae99SBarry Smith Level: developer 353447c6ae99SBarry Smith 3535e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 353647c6ae99SBarry Smith 353747c6ae99SBarry Smith @*/ 35387087cfbeSBarry Smith PetscErrorCode DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[]) 353947c6ae99SBarry Smith { 354047c6ae99SBarry Smith PetscErrorCode ierr; 354147c6ae99SBarry Smith 354247c6ae99SBarry Smith PetscFunctionBegin; 3543171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35442c71b3e2SJacob Faibussowitsch PetscCheckFalse(nlevels < 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 354547c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 3546b9d85ea2SLisandro Dalcin PetscValidPointer(dmf,3); 354747c6ae99SBarry Smith if (dm->ops->refinehierarchy) { 354847c6ae99SBarry Smith ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr); 354947c6ae99SBarry Smith } else if (dm->ops->refine) { 355047c6ae99SBarry Smith PetscInt i; 355147c6ae99SBarry Smith 3552ce94432eSBarry Smith ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr); 355347c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3554ce94432eSBarry Smith ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr); 355547c6ae99SBarry Smith } 3556ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet"); 355747c6ae99SBarry Smith PetscFunctionReturn(0); 355847c6ae99SBarry Smith } 355947c6ae99SBarry Smith 356047c6ae99SBarry Smith /*@C 356147c6ae99SBarry Smith DMCoarsenHierarchy - Coarsens a DM object, all levels at once 356247c6ae99SBarry Smith 3563d083f849SBarry Smith Collective on dm 356447c6ae99SBarry Smith 3565d8d19677SJose E. Roman Input Parameters: 356647c6ae99SBarry Smith + dm - the DM object 356747c6ae99SBarry Smith - nlevels - the number of levels of coarsening 356847c6ae99SBarry Smith 356947c6ae99SBarry Smith Output Parameter: 357047c6ae99SBarry Smith . dmc - the coarsened DM hierarchy 357147c6ae99SBarry Smith 357247c6ae99SBarry Smith Level: developer 357347c6ae99SBarry Smith 3574e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation() 357547c6ae99SBarry Smith 357647c6ae99SBarry Smith @*/ 35777087cfbeSBarry Smith PetscErrorCode DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[]) 357847c6ae99SBarry Smith { 357947c6ae99SBarry Smith PetscErrorCode ierr; 358047c6ae99SBarry Smith 358147c6ae99SBarry Smith PetscFunctionBegin; 3582171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 35832c71b3e2SJacob Faibussowitsch PetscCheckFalse(nlevels < 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative"); 358447c6ae99SBarry Smith if (nlevels == 0) PetscFunctionReturn(0); 358547c6ae99SBarry Smith PetscValidPointer(dmc,3); 358647c6ae99SBarry Smith if (dm->ops->coarsenhierarchy) { 358747c6ae99SBarry Smith ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr); 358847c6ae99SBarry Smith } else if (dm->ops->coarsen) { 358947c6ae99SBarry Smith PetscInt i; 359047c6ae99SBarry Smith 3591ce94432eSBarry Smith ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr); 359247c6ae99SBarry Smith for (i=1; i<nlevels; i++) { 3593ce94432eSBarry Smith ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr); 359447c6ae99SBarry Smith } 3595ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet"); 359647c6ae99SBarry Smith PetscFunctionReturn(0); 359747c6ae99SBarry Smith } 359847c6ae99SBarry Smith 35991a266240SBarry Smith /*@C 36001a266240SBarry Smith DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed 36011a266240SBarry Smith 36021a266240SBarry Smith Not Collective 36031a266240SBarry Smith 36041a266240SBarry Smith Input Parameters: 36051a266240SBarry Smith + dm - the DM object 36061a266240SBarry Smith - destroy - the destroy function 36071a266240SBarry Smith 36081a266240SBarry Smith Level: intermediate 36091a266240SBarry Smith 3610e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 36111a266240SBarry Smith 3612f07f9ceaSJed Brown @*/ 36131a266240SBarry Smith PetscErrorCode DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**)) 36141a266240SBarry Smith { 36151a266240SBarry Smith PetscFunctionBegin; 3616171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 36171a266240SBarry Smith dm->ctxdestroy = destroy; 36181a266240SBarry Smith PetscFunctionReturn(0); 36191a266240SBarry Smith } 36201a266240SBarry Smith 3621b07ff414SBarry Smith /*@ 36221b2093e4SBarry Smith DMSetApplicationContext - Set a user context into a DM object 362347c6ae99SBarry Smith 362447c6ae99SBarry Smith Not Collective 362547c6ae99SBarry Smith 362647c6ae99SBarry Smith Input Parameters: 362747c6ae99SBarry Smith + dm - the DM object 362847c6ae99SBarry Smith - ctx - the user context 362947c6ae99SBarry Smith 363047c6ae99SBarry Smith Level: intermediate 363147c6ae99SBarry Smith 3632e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 363347c6ae99SBarry Smith 363447c6ae99SBarry Smith @*/ 36351b2093e4SBarry Smith PetscErrorCode DMSetApplicationContext(DM dm,void *ctx) 363647c6ae99SBarry Smith { 363747c6ae99SBarry Smith PetscFunctionBegin; 3638171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 363947c6ae99SBarry Smith dm->ctx = ctx; 364047c6ae99SBarry Smith PetscFunctionReturn(0); 364147c6ae99SBarry Smith } 364247c6ae99SBarry Smith 364347c6ae99SBarry Smith /*@ 36441b2093e4SBarry Smith DMGetApplicationContext - Gets a user context from a DM object 364547c6ae99SBarry Smith 364647c6ae99SBarry Smith Not Collective 364747c6ae99SBarry Smith 364847c6ae99SBarry Smith Input Parameter: 364947c6ae99SBarry Smith . dm - the DM object 365047c6ae99SBarry Smith 365147c6ae99SBarry Smith Output Parameter: 365247c6ae99SBarry Smith . ctx - the user context 365347c6ae99SBarry Smith 365447c6ae99SBarry Smith Level: intermediate 365547c6ae99SBarry Smith 3656e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 365747c6ae99SBarry Smith 365847c6ae99SBarry Smith @*/ 36591b2093e4SBarry Smith PetscErrorCode DMGetApplicationContext(DM dm,void *ctx) 366047c6ae99SBarry Smith { 366147c6ae99SBarry Smith PetscFunctionBegin; 3662171400e9SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,1); 36631b2093e4SBarry Smith *(void**)ctx = dm->ctx; 366447c6ae99SBarry Smith PetscFunctionReturn(0); 366547c6ae99SBarry Smith } 366647c6ae99SBarry Smith 366708da532bSDmitry Karpeev /*@C 3668df3898eeSBarry Smith DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI. 366908da532bSDmitry Karpeev 3670d083f849SBarry Smith Logically Collective on dm 367108da532bSDmitry Karpeev 3672d8d19677SJose E. Roman Input Parameters: 367308da532bSDmitry Karpeev + dm - the DM object 36740298fd71SBarry Smith - f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set) 367508da532bSDmitry Karpeev 367608da532bSDmitry Karpeev Level: intermediate 367708da532bSDmitry Karpeev 3678835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(), 367908da532bSDmitry Karpeev DMSetJacobian() 368008da532bSDmitry Karpeev 368108da532bSDmitry Karpeev @*/ 368208da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec)) 368308da532bSDmitry Karpeev { 368408da532bSDmitry Karpeev PetscFunctionBegin; 36855a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 368608da532bSDmitry Karpeev dm->ops->computevariablebounds = f; 368708da532bSDmitry Karpeev PetscFunctionReturn(0); 368808da532bSDmitry Karpeev } 368908da532bSDmitry Karpeev 369008da532bSDmitry Karpeev /*@ 369108da532bSDmitry Karpeev DMHasVariableBounds - does the DM object have a variable bounds function? 369208da532bSDmitry Karpeev 369308da532bSDmitry Karpeev Not Collective 369408da532bSDmitry Karpeev 369508da532bSDmitry Karpeev Input Parameter: 369608da532bSDmitry Karpeev . dm - the DM object to destroy 369708da532bSDmitry Karpeev 369808da532bSDmitry Karpeev Output Parameter: 369908da532bSDmitry Karpeev . flg - PETSC_TRUE if the variable bounds function exists 370008da532bSDmitry Karpeev 370108da532bSDmitry Karpeev Level: developer 370208da532bSDmitry Karpeev 370374e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 370408da532bSDmitry Karpeev 370508da532bSDmitry Karpeev @*/ 370608da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg) 370708da532bSDmitry Karpeev { 370808da532bSDmitry Karpeev PetscFunctionBegin; 37095a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3710534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 371108da532bSDmitry Karpeev *flg = (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE; 371208da532bSDmitry Karpeev PetscFunctionReturn(0); 371308da532bSDmitry Karpeev } 371408da532bSDmitry Karpeev 371508da532bSDmitry Karpeev /*@C 371608da532bSDmitry Karpeev DMComputeVariableBounds - compute variable bounds used by SNESVI. 371708da532bSDmitry Karpeev 3718d083f849SBarry Smith Logically Collective on dm 371908da532bSDmitry Karpeev 3720f899ff85SJose E. Roman Input Parameter: 3721907376e6SBarry Smith . dm - the DM object 372208da532bSDmitry Karpeev 372308da532bSDmitry Karpeev Output parameters: 372408da532bSDmitry Karpeev + xl - lower bound 372508da532bSDmitry Karpeev - xu - upper bound 372608da532bSDmitry Karpeev 3727907376e6SBarry Smith Level: advanced 3728907376e6SBarry Smith 372995452b02SPatrick Sanan Notes: 373095452b02SPatrick Sanan This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds() 373108da532bSDmitry Karpeev 373274e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext() 373308da532bSDmitry Karpeev 373408da532bSDmitry Karpeev @*/ 373508da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu) 373608da532bSDmitry Karpeev { 373708da532bSDmitry Karpeev PetscErrorCode ierr; 37385fd66863SKarl Rupp 373908da532bSDmitry Karpeev PetscFunctionBegin; 37405a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 374108da532bSDmitry Karpeev PetscValidHeaderSpecific(xl,VEC_CLASSID,2); 37425a84ad33SLisandro Dalcin PetscValidHeaderSpecific(xu,VEC_CLASSID,3); 37432c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->computevariablebounds,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name); 374408da532bSDmitry Karpeev ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr); 374508da532bSDmitry Karpeev PetscFunctionReturn(0); 374608da532bSDmitry Karpeev } 374708da532bSDmitry Karpeev 3748b0ae01b7SPeter Brune /*@ 3749b0ae01b7SPeter Brune DMHasColoring - does the DM object have a method of providing a coloring? 3750b0ae01b7SPeter Brune 3751b0ae01b7SPeter Brune Not Collective 3752b0ae01b7SPeter Brune 3753b0ae01b7SPeter Brune Input Parameter: 3754b0ae01b7SPeter Brune . dm - the DM object 3755b0ae01b7SPeter Brune 3756b0ae01b7SPeter Brune Output Parameter: 3757b0ae01b7SPeter Brune . flg - PETSC_TRUE if the DM has facilities for DMCreateColoring(). 3758b0ae01b7SPeter Brune 3759b0ae01b7SPeter Brune Level: developer 3760b0ae01b7SPeter Brune 37611565f0a7SPatrick Sanan .seealso DMCreateColoring() 3762b0ae01b7SPeter Brune 3763b0ae01b7SPeter Brune @*/ 3764b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg) 3765b0ae01b7SPeter Brune { 3766b0ae01b7SPeter Brune PetscFunctionBegin; 37675a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3768534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 3769b0ae01b7SPeter Brune *flg = (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE; 3770b0ae01b7SPeter Brune PetscFunctionReturn(0); 3771b0ae01b7SPeter Brune } 3772b0ae01b7SPeter Brune 37733ad4599aSBarry Smith /*@ 37743ad4599aSBarry Smith DMHasCreateRestriction - does the DM object have a method of providing a restriction? 37753ad4599aSBarry Smith 37763ad4599aSBarry Smith Not Collective 37773ad4599aSBarry Smith 37783ad4599aSBarry Smith Input Parameter: 37793ad4599aSBarry Smith . dm - the DM object 37803ad4599aSBarry Smith 37813ad4599aSBarry Smith Output Parameter: 37823ad4599aSBarry Smith . flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction(). 37833ad4599aSBarry Smith 37843ad4599aSBarry Smith Level: developer 37853ad4599aSBarry Smith 37861565f0a7SPatrick Sanan .seealso DMCreateRestriction() 37873ad4599aSBarry Smith 37883ad4599aSBarry Smith @*/ 37893ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg) 37903ad4599aSBarry Smith { 37913ad4599aSBarry Smith PetscFunctionBegin; 37925a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3793534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 37943ad4599aSBarry Smith *flg = (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE; 37953ad4599aSBarry Smith PetscFunctionReturn(0); 37963ad4599aSBarry Smith } 37973ad4599aSBarry Smith 3798a7058e45SLawrence Mitchell /*@ 3799a7058e45SLawrence Mitchell DMHasCreateInjection - does the DM object have a method of providing an injection? 3800a7058e45SLawrence Mitchell 3801a7058e45SLawrence Mitchell Not Collective 3802a7058e45SLawrence Mitchell 3803a7058e45SLawrence Mitchell Input Parameter: 3804a7058e45SLawrence Mitchell . dm - the DM object 3805a7058e45SLawrence Mitchell 3806a7058e45SLawrence Mitchell Output Parameter: 3807a7058e45SLawrence Mitchell . flg - PETSC_TRUE if the DM has facilities for DMCreateInjection(). 3808a7058e45SLawrence Mitchell 3809a7058e45SLawrence Mitchell Level: developer 3810a7058e45SLawrence Mitchell 38111565f0a7SPatrick Sanan .seealso DMCreateInjection() 3812a7058e45SLawrence Mitchell 3813a7058e45SLawrence Mitchell @*/ 3814a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg) 3815a7058e45SLawrence Mitchell { 38164a7a4c06SLawrence Mitchell PetscErrorCode ierr; 38175a84ad33SLisandro Dalcin 3818a7058e45SLawrence Mitchell PetscFunctionBegin; 38195a84ad33SLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 3820534a8f05SLisandro Dalcin PetscValidBoolPointer(flg,2); 38215a84ad33SLisandro Dalcin if (dm->ops->hascreateinjection) { 38224a7a4c06SLawrence Mitchell ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr); 38235a84ad33SLisandro Dalcin } else { 38245a84ad33SLisandro Dalcin *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE; 38255a84ad33SLisandro Dalcin } 3826a7058e45SLawrence Mitchell PetscFunctionReturn(0); 3827a7058e45SLawrence Mitchell } 3828a7058e45SLawrence Mitchell 38290298fd71SBarry Smith PetscFunctionList DMList = NULL; 3830264ace61SBarry Smith PetscBool DMRegisterAllCalled = PETSC_FALSE; 3831264ace61SBarry Smith 3832264ace61SBarry Smith /*@C 3833264ace61SBarry Smith DMSetType - Builds a DM, for a particular DM implementation. 3834264ace61SBarry Smith 3835d083f849SBarry Smith Collective on dm 3836264ace61SBarry Smith 3837264ace61SBarry Smith Input Parameters: 3838264ace61SBarry Smith + dm - The DM object 3839264ace61SBarry Smith - method - The name of the DM type 3840264ace61SBarry Smith 3841264ace61SBarry Smith Options Database Key: 3842264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types 3843264ace61SBarry Smith 3844264ace61SBarry Smith Notes: 3845e1589f56SBarry Smith See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D). 3846264ace61SBarry Smith 3847264ace61SBarry Smith Level: intermediate 3848264ace61SBarry Smith 3849264ace61SBarry Smith .seealso: DMGetType(), DMCreate() 3850264ace61SBarry Smith @*/ 385119fd82e9SBarry Smith PetscErrorCode DMSetType(DM dm, DMType method) 3852264ace61SBarry Smith { 3853264ace61SBarry Smith PetscErrorCode (*r)(DM); 3854264ace61SBarry Smith PetscBool match; 3855264ace61SBarry Smith PetscErrorCode ierr; 3856264ace61SBarry Smith 3857264ace61SBarry Smith PetscFunctionBegin; 3858264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3859251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr); 3860264ace61SBarry Smith if (match) PetscFunctionReturn(0); 3861264ace61SBarry Smith 38620f51fdf8SToby Isaac ierr = DMRegisterAll();CHKERRQ(ierr); 38631c9cd337SJed Brown ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr); 38642c71b3e2SJacob Faibussowitsch PetscCheckFalse(!r,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method); 3865264ace61SBarry Smith 3866264ace61SBarry Smith if (dm->ops->destroy) { 3867264ace61SBarry Smith ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr); 3868264ace61SBarry Smith } 3869d57f96a3SLisandro Dalcin ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr); 3870264ace61SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr); 3871d57f96a3SLisandro Dalcin ierr = (*r)(dm);CHKERRQ(ierr); 3872264ace61SBarry Smith PetscFunctionReturn(0); 3873264ace61SBarry Smith } 3874264ace61SBarry Smith 3875264ace61SBarry Smith /*@C 3876264ace61SBarry Smith DMGetType - Gets the DM type name (as a string) from the DM. 3877264ace61SBarry Smith 3878264ace61SBarry Smith Not Collective 3879264ace61SBarry Smith 3880264ace61SBarry Smith Input Parameter: 3881264ace61SBarry Smith . dm - The DM 3882264ace61SBarry Smith 3883264ace61SBarry Smith Output Parameter: 3884264ace61SBarry Smith . type - The DM type name 3885264ace61SBarry Smith 3886264ace61SBarry Smith Level: intermediate 3887264ace61SBarry Smith 3888264ace61SBarry Smith .seealso: DMSetType(), DMCreate() 3889264ace61SBarry Smith @*/ 389019fd82e9SBarry Smith PetscErrorCode DMGetType(DM dm, DMType *type) 3891264ace61SBarry Smith { 3892264ace61SBarry Smith PetscErrorCode ierr; 3893264ace61SBarry Smith 3894264ace61SBarry Smith PetscFunctionBegin; 3895264ace61SBarry Smith PetscValidHeaderSpecific(dm, DM_CLASSID,1); 3896c959eef4SJed Brown PetscValidPointer(type,2); 3897607a6623SBarry Smith ierr = DMRegisterAll();CHKERRQ(ierr); 3898264ace61SBarry Smith *type = ((PetscObject)dm)->type_name; 3899264ace61SBarry Smith PetscFunctionReturn(0); 3900264ace61SBarry Smith } 3901264ace61SBarry Smith 390267a56275SMatthew G Knepley /*@C 390367a56275SMatthew G Knepley DMConvert - Converts a DM to another DM, either of the same or different type. 390467a56275SMatthew G Knepley 3905d083f849SBarry Smith Collective on dm 390667a56275SMatthew G Knepley 390767a56275SMatthew G Knepley Input Parameters: 390867a56275SMatthew G Knepley + dm - the DM 390967a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type) 391067a56275SMatthew G Knepley 391167a56275SMatthew G Knepley Output Parameter: 391267a56275SMatthew G Knepley . M - pointer to new DM 391367a56275SMatthew G Knepley 391467a56275SMatthew G Knepley Notes: 391567a56275SMatthew G Knepley Cannot be used to convert a sequential DM to parallel or parallel to sequential, 391667a56275SMatthew G Knepley the MPI communicator of the generated DM is always the same as the communicator 391767a56275SMatthew G Knepley of the input DM. 391867a56275SMatthew G Knepley 391967a56275SMatthew G Knepley Level: intermediate 392067a56275SMatthew G Knepley 392167a56275SMatthew G Knepley .seealso: DMCreate() 392267a56275SMatthew G Knepley @*/ 392319fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M) 392467a56275SMatthew G Knepley { 392567a56275SMatthew G Knepley DM B; 392667a56275SMatthew G Knepley char convname[256]; 3927c067b6caSMatthew G. Knepley PetscBool sametype/*, issame */; 392867a56275SMatthew G Knepley PetscErrorCode ierr; 392967a56275SMatthew G Knepley 393067a56275SMatthew G Knepley PetscFunctionBegin; 393167a56275SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 393267a56275SMatthew G Knepley PetscValidType(dm,1); 393367a56275SMatthew G Knepley PetscValidPointer(M,3); 3934251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr); 3935c067b6caSMatthew G. Knepley /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */ 3936c067b6caSMatthew G. Knepley if (sametype) { 3937c067b6caSMatthew G. Knepley *M = dm; 3938c067b6caSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr); 3939c067b6caSMatthew G. Knepley PetscFunctionReturn(0); 3940c067b6caSMatthew G. Knepley } else { 39410298fd71SBarry Smith PetscErrorCode (*conv)(DM, DMType, DM*) = NULL; 394267a56275SMatthew G Knepley 394367a56275SMatthew G Knepley /* 394467a56275SMatthew G Knepley Order of precedence: 394567a56275SMatthew G Knepley 1) See if a specialized converter is known to the current DM. 394667a56275SMatthew G Knepley 2) See if a specialized converter is known to the desired DM class. 394767a56275SMatthew G Knepley 3) See if a good general converter is registered for the desired class 394867a56275SMatthew G Knepley 4) See if a good general converter is known for the current matrix. 394967a56275SMatthew G Knepley 5) Use a really basic converter. 395067a56275SMatthew G Knepley */ 395167a56275SMatthew G Knepley 395267a56275SMatthew G Knepley /* 1) See if a specialized converter is known to the current DM and the desired class */ 3953a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3954a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3955a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3956a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3957a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 39580005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr); 395967a56275SMatthew G Knepley if (conv) goto foundconv; 396067a56275SMatthew G Knepley 396167a56275SMatthew G Knepley /* 2) See if a specialized converter is known to the desired DM class. */ 396282f516ccSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr); 396367a56275SMatthew G Knepley ierr = DMSetType(B, newtype);CHKERRQ(ierr); 3964a126751eSBarry Smith ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr); 3965a126751eSBarry Smith ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr); 3966a126751eSBarry Smith ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr); 3967a126751eSBarry Smith ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr); 3968a126751eSBarry Smith ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr); 39690005d66cSJed Brown ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr); 397067a56275SMatthew G Knepley if (conv) { 3971fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 397267a56275SMatthew G Knepley goto foundconv; 397367a56275SMatthew G Knepley } 397467a56275SMatthew G Knepley 397567a56275SMatthew G Knepley #if 0 397667a56275SMatthew G Knepley /* 3) See if a good general converter is registered for the desired class */ 397767a56275SMatthew G Knepley conv = B->ops->convertfrom; 3978fcfd50ebSBarry Smith ierr = DMDestroy(&B);CHKERRQ(ierr); 397967a56275SMatthew G Knepley if (conv) goto foundconv; 398067a56275SMatthew G Knepley 398167a56275SMatthew G Knepley /* 4) See if a good general converter is known for the current matrix */ 398267a56275SMatthew G Knepley if (dm->ops->convert) { 398367a56275SMatthew G Knepley conv = dm->ops->convert; 398467a56275SMatthew G Knepley } 398567a56275SMatthew G Knepley if (conv) goto foundconv; 398667a56275SMatthew G Knepley #endif 398767a56275SMatthew G Knepley 398867a56275SMatthew G Knepley /* 5) Use a really basic converter. */ 398998921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype); 399067a56275SMatthew G Knepley 399167a56275SMatthew G Knepley foundconv: 399267a56275SMatthew G Knepley ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 399367a56275SMatthew G Knepley ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr); 399412fa691eSMatthew G. Knepley /* Things that are independent of DM type: We should consult DMClone() here */ 399590b157c4SStefano Zampini { 399690b157c4SStefano Zampini PetscBool isper; 399712fa691eSMatthew G. Knepley const PetscReal *maxCell, *L; 399812fa691eSMatthew G. Knepley const DMBoundaryType *bd; 399990b157c4SStefano Zampini ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr); 400090b157c4SStefano Zampini ierr = DMSetPeriodicity(*M, isper, maxCell, L, bd);CHKERRQ(ierr); 4001c8a6034eSMark (*M)->prealloc_only = dm->prealloc_only; 4002a587d139SMark ierr = PetscFree((*M)->vectype);CHKERRQ(ierr); 4003a587d139SMark ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr); 4004a587d139SMark ierr = PetscFree((*M)->mattype);CHKERRQ(ierr); 4005a587d139SMark ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr); 400612fa691eSMatthew G. Knepley } 400767a56275SMatthew G Knepley ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr); 400867a56275SMatthew G Knepley } 400967a56275SMatthew G Knepley ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr); 401067a56275SMatthew G Knepley PetscFunctionReturn(0); 401167a56275SMatthew G Knepley } 4012264ace61SBarry Smith 4013264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/ 4014264ace61SBarry Smith 4015264ace61SBarry Smith /*@C 40161c84c290SBarry Smith DMRegister - Adds a new DM component implementation 40171c84c290SBarry Smith 40181c84c290SBarry Smith Not Collective 40191c84c290SBarry Smith 40201c84c290SBarry Smith Input Parameters: 40211c84c290SBarry Smith + name - The name of a new user-defined creation routine 40221c84c290SBarry Smith - create_func - The creation routine itself 40231c84c290SBarry Smith 40241c84c290SBarry Smith Notes: 40251c84c290SBarry Smith DMRegister() may be called multiple times to add several user-defined DMs 40261c84c290SBarry Smith 40271c84c290SBarry Smith Sample usage: 40281c84c290SBarry Smith .vb 4029bdf89e91SBarry Smith DMRegister("my_da", MyDMCreate); 40301c84c290SBarry Smith .ve 40311c84c290SBarry Smith 40321c84c290SBarry Smith Then, your DM type can be chosen with the procedural interface via 40331c84c290SBarry Smith .vb 40341c84c290SBarry Smith DMCreate(MPI_Comm, DM *); 40351c84c290SBarry Smith DMSetType(DM,"my_da"); 40361c84c290SBarry Smith .ve 40371c84c290SBarry Smith or at runtime via the option 40381c84c290SBarry Smith .vb 40391c84c290SBarry Smith -da_type my_da 40401c84c290SBarry Smith .ve 4041264ace61SBarry Smith 4042264ace61SBarry Smith Level: advanced 40431c84c290SBarry Smith 4044bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy() 40451c84c290SBarry Smith 4046264ace61SBarry Smith @*/ 4047bdf89e91SBarry Smith PetscErrorCode DMRegister(const char sname[],PetscErrorCode (*function)(DM)) 4048264ace61SBarry Smith { 4049264ace61SBarry Smith PetscErrorCode ierr; 4050264ace61SBarry Smith 4051264ace61SBarry Smith PetscFunctionBegin; 40521d36bdfdSBarry Smith ierr = DMInitializePackage();CHKERRQ(ierr); 4053a240a19fSJed Brown ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr); 4054264ace61SBarry Smith PetscFunctionReturn(0); 4055264ace61SBarry Smith } 4056264ace61SBarry Smith 4057b859378eSBarry Smith /*@C 405855849f57SBarry Smith DMLoad - Loads a DM that has been stored in binary with DMView(). 4059b859378eSBarry Smith 4060d083f849SBarry Smith Collective on viewer 4061b859378eSBarry Smith 4062b859378eSBarry Smith Input Parameters: 4063b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or 4064b859378eSBarry Smith some related function before a call to DMLoad(). 4065b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or 4066b859378eSBarry Smith HDF5 file viewer, obtained from PetscViewerHDF5Open() 4067b859378eSBarry Smith 4068b859378eSBarry Smith Level: intermediate 4069b859378eSBarry Smith 4070b859378eSBarry Smith Notes: 407155849f57SBarry Smith The type is determined by the data in the file, any type set into the DM before this call is ignored. 4072b859378eSBarry Smith 4073cd7e8a5eSksagiyam Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex 4074cd7e8a5eSksagiyam meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName() 4075cd7e8a5eSksagiyam before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object. 4076cd7e8a5eSksagiyam 4077b859378eSBarry Smith Notes for advanced users: 4078b859378eSBarry Smith Most users should not need to know the details of the binary storage 4079b859378eSBarry Smith format, since DMLoad() and DMView() completely hide these details. 4080b859378eSBarry Smith But for anyone who's interested, the standard binary matrix storage 4081b859378eSBarry Smith format is 4082b859378eSBarry Smith .vb 4083b859378eSBarry Smith has not yet been determined 4084b859378eSBarry Smith .ve 4085b859378eSBarry Smith 4086b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad() 4087b859378eSBarry Smith @*/ 4088b859378eSBarry Smith PetscErrorCode DMLoad(DM newdm, PetscViewer viewer) 4089b859378eSBarry Smith { 40909331c7a4SMatthew G. Knepley PetscBool isbinary, ishdf5; 4091b859378eSBarry Smith PetscErrorCode ierr; 4092b859378eSBarry Smith 4093b859378eSBarry Smith PetscFunctionBegin; 4094b859378eSBarry Smith PetscValidHeaderSpecific(newdm,DM_CLASSID,1); 4095b859378eSBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 4096fb694a9eSVaclav Hapla ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr); 409732c0f0efSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 40989331c7a4SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr); 409958cd63d5SVaclav Hapla ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr); 41009331c7a4SMatthew G. Knepley if (isbinary) { 41019331c7a4SMatthew G. Knepley PetscInt classid; 41029331c7a4SMatthew G. Knepley char type[256]; 4103b859378eSBarry Smith 4104060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 41052c71b3e2SJacob Faibussowitsch PetscCheckFalse(classid != DM_FILE_CLASSID,PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid); 4106060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 410732c0f0efSBarry Smith ierr = DMSetType(newdm, type);CHKERRQ(ierr); 41089331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 41099331c7a4SMatthew G. Knepley } else if (ishdf5) { 41109331c7a4SMatthew G. Knepley if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);} 41119331c7a4SMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()"); 411258cd63d5SVaclav Hapla ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr); 4113b859378eSBarry Smith PetscFunctionReturn(0); 4114b859378eSBarry Smith } 4115b859378eSBarry Smith 4116b2e4378dSMatthew G. Knepley /*@ 4117b2e4378dSMatthew G. Knepley DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process. 4118b2e4378dSMatthew G. Knepley 4119b2e4378dSMatthew G. Knepley Not collective 4120b2e4378dSMatthew G. Knepley 4121b2e4378dSMatthew G. Knepley Input Parameter: 4122b2e4378dSMatthew G. Knepley . dm - the DM 4123b2e4378dSMatthew G. Knepley 4124b2e4378dSMatthew G. Knepley Output Parameters: 4125b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional) 4126b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional) 4127b2e4378dSMatthew G. Knepley 4128b2e4378dSMatthew G. Knepley Level: beginner 4129b2e4378dSMatthew G. Knepley 4130b2e4378dSMatthew G. Knepley Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead. 4131b2e4378dSMatthew G. Knepley 4132b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox() 4133b2e4378dSMatthew G. Knepley @*/ 4134b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[]) 4135b2e4378dSMatthew G. Knepley { 4136b2e4378dSMatthew G. Knepley Vec coords = NULL; 4137b2e4378dSMatthew G. Knepley PetscReal min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL}; 4138b2e4378dSMatthew G. Knepley PetscReal max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL}; 4139b2e4378dSMatthew G. Knepley const PetscScalar *local_coords; 4140b2e4378dSMatthew G. Knepley PetscInt N, Ni; 4141b2e4378dSMatthew G. Knepley PetscInt cdim, i, j; 4142b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 4143b2e4378dSMatthew G. Knepley 4144b2e4378dSMatthew G. Knepley PetscFunctionBegin; 4145b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4146b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 4147b2e4378dSMatthew G. Knepley ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr); 4148b2e4378dSMatthew G. Knepley if (coords) { 4149b2e4378dSMatthew G. Knepley ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr); 4150b2e4378dSMatthew G. Knepley ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr); 4151b2e4378dSMatthew G. Knepley Ni = N/cdim; 4152b2e4378dSMatthew G. Knepley for (i = 0; i < Ni; ++i) { 4153b2e4378dSMatthew G. Knepley for (j = 0; j < 3; ++j) { 4154b2e4378dSMatthew G. Knepley min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 4155b2e4378dSMatthew G. Knepley max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0; 4156b2e4378dSMatthew G. Knepley } 4157b2e4378dSMatthew G. Knepley } 4158b2e4378dSMatthew G. Knepley ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr); 4159b2e4378dSMatthew G. Knepley } else { 4160b2e4378dSMatthew G. Knepley PetscBool isda; 4161b2e4378dSMatthew G. Knepley 4162b2e4378dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr); 4163b2e4378dSMatthew G. Knepley if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);} 4164b2e4378dSMatthew G. Knepley } 4165b2e4378dSMatthew G. Knepley if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);} 4166b2e4378dSMatthew G. Knepley if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);} 4167b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 4168b2e4378dSMatthew G. Knepley } 4169b2e4378dSMatthew G. Knepley 4170b2e4378dSMatthew G. Knepley /*@ 4171b2e4378dSMatthew G. Knepley DMGetBoundingBox - Returns the global bounding box for the DM. 4172b2e4378dSMatthew G. Knepley 4173b2e4378dSMatthew G. Knepley Collective 4174b2e4378dSMatthew G. Knepley 4175b2e4378dSMatthew G. Knepley Input Parameter: 4176b2e4378dSMatthew G. Knepley . dm - the DM 4177b2e4378dSMatthew G. Knepley 4178b2e4378dSMatthew G. Knepley Output Parameters: 4179b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional) 4180b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional) 4181b2e4378dSMatthew G. Knepley 4182b2e4378dSMatthew G. Knepley Level: beginner 4183b2e4378dSMatthew G. Knepley 4184b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal() 4185b2e4378dSMatthew G. Knepley @*/ 4186b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[]) 4187b2e4378dSMatthew G. Knepley { 4188b2e4378dSMatthew G. Knepley PetscReal lmin[3], lmax[3]; 41896ce308c4SMatthew G. Knepley PetscInt cdim; 41906ce308c4SMatthew G. Knepley PetscMPIInt count; 4191b2e4378dSMatthew G. Knepley PetscErrorCode ierr; 4192b2e4378dSMatthew G. Knepley 4193b2e4378dSMatthew G. Knepley PetscFunctionBegin; 4194b2e4378dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4195b2e4378dSMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 4196b2e4378dSMatthew G. Knepley ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr); 4197b2e4378dSMatthew G. Knepley ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr); 4198820f2d46SBarry Smith if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);} 4199820f2d46SBarry Smith if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);} 4200b2e4378dSMatthew G. Knepley PetscFunctionReturn(0); 4201b2e4378dSMatthew G. Knepley } 4202b2e4378dSMatthew G. Knepley 42037da65231SMatthew G Knepley /******************************** FEM Support **********************************/ 42047da65231SMatthew G Knepley 4205a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[]) 4206a6dfd86eSKarl Rupp { 42071d47ebbbSSatish Balay PetscInt f; 42081b30c384SMatthew G Knepley PetscErrorCode ierr; 42091b30c384SMatthew G Knepley 42107da65231SMatthew G Knepley PetscFunctionBegin; 421174778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 42121d47ebbbSSatish Balay for (f = 0; f < len; ++f) { 421357622a8eSBarry Smith ierr = PetscPrintf(PETSC_COMM_SELF, " | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr); 42147da65231SMatthew G Knepley } 42157da65231SMatthew G Knepley PetscFunctionReturn(0); 42167da65231SMatthew G Knepley } 42177da65231SMatthew G Knepley 4218a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[]) 4219a6dfd86eSKarl Rupp { 42201b30c384SMatthew G Knepley PetscInt f, g; 42217da65231SMatthew G Knepley PetscErrorCode ierr; 42227da65231SMatthew G Knepley 42237da65231SMatthew G Knepley PetscFunctionBegin; 422474778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr); 42251d47ebbbSSatish Balay for (f = 0; f < rows; ++f) { 422674778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |");CHKERRQ(ierr); 42271d47ebbbSSatish Balay for (g = 0; g < cols; ++g) { 4228e3556bceSMatthew G. Knepley ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr); 42297da65231SMatthew G Knepley } 423074778d6cSJed Brown ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr); 42317da65231SMatthew G Knepley } 42327da65231SMatthew G Knepley PetscFunctionReturn(0); 42337da65231SMatthew G Knepley } 4234e7c4fc90SDmitry Karpeev 42356113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X) 4236e759306cSMatthew G. Knepley { 42370c5b8624SToby Isaac PetscInt localSize, bs; 42380c5b8624SToby Isaac PetscMPIInt size; 42390c5b8624SToby Isaac Vec x, xglob; 42400c5b8624SToby Isaac const PetscScalar *xarray; 4241e759306cSMatthew G. Knepley PetscErrorCode ierr; 4242e759306cSMatthew G. Knepley 4243e759306cSMatthew G. Knepley PetscFunctionBegin; 4244ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr); 4245e759306cSMatthew G. Knepley ierr = VecDuplicate(X, &x);CHKERRQ(ierr); 4246e759306cSMatthew G. Knepley ierr = VecCopy(X, x);CHKERRQ(ierr); 42476113b454SMatthew G. Knepley ierr = VecChop(x, tol);CHKERRQ(ierr); 42480c5b8624SToby Isaac ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr); 42490c5b8624SToby Isaac if (size > 1) { 42500c5b8624SToby Isaac ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr); 42510c5b8624SToby Isaac ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr); 42520c5b8624SToby Isaac ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 42530c5b8624SToby Isaac ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr); 42540c5b8624SToby Isaac } else { 42550c5b8624SToby Isaac xglob = x; 42560c5b8624SToby Isaac } 42570c5b8624SToby Isaac ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr); 42580c5b8624SToby Isaac if (size > 1) { 42590c5b8624SToby Isaac ierr = VecDestroy(&xglob);CHKERRQ(ierr); 42600c5b8624SToby Isaac ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr); 42610c5b8624SToby Isaac } 4262e759306cSMatthew G. Knepley ierr = VecDestroy(&x);CHKERRQ(ierr); 4263e759306cSMatthew G. Knepley PetscFunctionReturn(0); 4264e759306cSMatthew G. Knepley } 4265e759306cSMatthew G. Knepley 426688ed4aceSMatthew G Knepley /*@ 42671bb6d2a8SBarry Smith DMGetSection - Get the PetscSection encoding the local data layout for the DM. This is equivalent to DMGetLocalSection(). Deprecated in v3.12 4268061576a5SJed Brown 4269061576a5SJed Brown Input Parameter: 4270061576a5SJed Brown . dm - The DM 4271061576a5SJed Brown 4272061576a5SJed Brown Output Parameter: 4273061576a5SJed Brown . section - The PetscSection 4274061576a5SJed Brown 4275061576a5SJed Brown Options Database Keys: 4276061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM 4277061576a5SJed Brown 4278061576a5SJed Brown Level: advanced 4279061576a5SJed Brown 4280061576a5SJed Brown Notes: 4281061576a5SJed Brown Use DMGetLocalSection() in new code. 4282061576a5SJed Brown 4283061576a5SJed Brown This gets a borrowed reference, so the user should not destroy this PetscSection. 4284061576a5SJed Brown 4285061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection() 4286061576a5SJed Brown @*/ 4287061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section) 4288061576a5SJed Brown { 4289061576a5SJed Brown PetscErrorCode ierr; 4290061576a5SJed Brown 4291061576a5SJed Brown PetscFunctionBegin; 4292061576a5SJed Brown ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr); 4293061576a5SJed Brown PetscFunctionReturn(0); 4294061576a5SJed Brown } 4295061576a5SJed Brown 4296061576a5SJed Brown /*@ 4297061576a5SJed Brown DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM. 429888ed4aceSMatthew G Knepley 429988ed4aceSMatthew G Knepley Input Parameter: 430088ed4aceSMatthew G Knepley . dm - The DM 430188ed4aceSMatthew G Knepley 430288ed4aceSMatthew G Knepley Output Parameter: 430388ed4aceSMatthew G Knepley . section - The PetscSection 430488ed4aceSMatthew G Knepley 4305e5893cccSMatthew G. Knepley Options Database Keys: 4306e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM 4307e5893cccSMatthew G. Knepley 430888ed4aceSMatthew G Knepley Level: intermediate 430988ed4aceSMatthew G Knepley 431088ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 431188ed4aceSMatthew G Knepley 4312061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection() 431388ed4aceSMatthew G Knepley @*/ 4314061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section) 43150adebc6cSBarry Smith { 4316fd59a867SMatthew G. Knepley PetscErrorCode ierr; 4317fd59a867SMatthew G. Knepley 431888ed4aceSMatthew G Knepley PetscFunctionBegin; 431988ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 432088ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 43211bb6d2a8SBarry Smith if (!dm->localSection && dm->ops->createlocalsection) { 4322e5e52638SMatthew G. Knepley PetscInt d; 4323e5e52638SMatthew G. Knepley 432445480ffeSMatthew G. Knepley if (dm->setfromoptionscalled) { 432545480ffeSMatthew G. Knepley PetscObject obj = (PetscObject) dm; 432645480ffeSMatthew G. Knepley PetscViewer viewer; 432745480ffeSMatthew G. Knepley PetscViewerFormat format; 432845480ffeSMatthew G. Knepley PetscBool flg; 432945480ffeSMatthew G. Knepley 433045480ffeSMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr); 433145480ffeSMatthew G. Knepley if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);} 433245480ffeSMatthew G. Knepley for (d = 0; d < dm->Nds; ++d) { 433345480ffeSMatthew G. Knepley ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr); 433445480ffeSMatthew G. Knepley if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);} 433545480ffeSMatthew G. Knepley } 433645480ffeSMatthew G. Knepley if (flg) { 433745480ffeSMatthew G. Knepley ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 433845480ffeSMatthew G. Knepley ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 433945480ffeSMatthew G. Knepley ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 434045480ffeSMatthew G. Knepley } 434145480ffeSMatthew G. Knepley } 43421bb6d2a8SBarry Smith ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr); 43431bb6d2a8SBarry Smith if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);} 43442f0f8703SMatthew G. Knepley } 43451bb6d2a8SBarry Smith *section = dm->localSection; 434688ed4aceSMatthew G Knepley PetscFunctionReturn(0); 434788ed4aceSMatthew G Knepley } 434888ed4aceSMatthew G Knepley 434988ed4aceSMatthew G Knepley /*@ 43501bb6d2a8SBarry Smith DMSetSection - Set the PetscSection encoding the local data layout for the DM. This is equivalent to DMSetLocalSection(). Deprecated in v3.12 4351061576a5SJed Brown 4352061576a5SJed Brown Input Parameters: 4353061576a5SJed Brown + dm - The DM 4354061576a5SJed Brown - section - The PetscSection 4355061576a5SJed Brown 4356061576a5SJed Brown Level: advanced 4357061576a5SJed Brown 4358061576a5SJed Brown Notes: 4359061576a5SJed Brown Use DMSetLocalSection() in new code. 4360061576a5SJed Brown 4361061576a5SJed Brown Any existing Section will be destroyed 4362061576a5SJed Brown 4363061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection() 4364061576a5SJed Brown @*/ 4365061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section) 4366061576a5SJed Brown { 4367061576a5SJed Brown PetscErrorCode ierr; 4368061576a5SJed Brown 4369061576a5SJed Brown PetscFunctionBegin; 4370061576a5SJed Brown ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr); 4371061576a5SJed Brown PetscFunctionReturn(0); 4372061576a5SJed Brown } 4373061576a5SJed Brown 4374061576a5SJed Brown /*@ 4375061576a5SJed Brown DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM. 437688ed4aceSMatthew G Knepley 437788ed4aceSMatthew G Knepley Input Parameters: 437888ed4aceSMatthew G Knepley + dm - The DM 437988ed4aceSMatthew G Knepley - section - The PetscSection 438088ed4aceSMatthew G Knepley 438188ed4aceSMatthew G Knepley Level: intermediate 438288ed4aceSMatthew G Knepley 438388ed4aceSMatthew G Knepley Note: Any existing Section will be destroyed 438488ed4aceSMatthew G Knepley 4385061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection() 438688ed4aceSMatthew G Knepley @*/ 4387061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section) 43880adebc6cSBarry Smith { 4389c473ab19SMatthew G. Knepley PetscInt numFields = 0; 4390af122d2aSMatthew G Knepley PetscInt f; 439188ed4aceSMatthew G Knepley PetscErrorCode ierr; 439288ed4aceSMatthew G Knepley 439388ed4aceSMatthew G Knepley PetscFunctionBegin; 439488ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4395b9d85ea2SLisandro Dalcin if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 43961d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 43971bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr); 43981bb6d2a8SBarry Smith dm->localSection = section; 43991bb6d2a8SBarry Smith if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);} 4400af122d2aSMatthew G Knepley if (numFields) { 4401af122d2aSMatthew G Knepley ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr); 4402af122d2aSMatthew G Knepley for (f = 0; f < numFields; ++f) { 44030f21e855SMatthew G. Knepley PetscObject disc; 4404af122d2aSMatthew G Knepley const char *name; 4405af122d2aSMatthew G Knepley 44061bb6d2a8SBarry Smith ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr); 440744a7f3ddSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr); 44080f21e855SMatthew G. Knepley ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr); 4409af122d2aSMatthew G Knepley } 4410af122d2aSMatthew G Knepley } 4411e87a4003SBarry Smith /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */ 44121bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 441388ed4aceSMatthew G Knepley PetscFunctionReturn(0); 441488ed4aceSMatthew G Knepley } 441588ed4aceSMatthew G Knepley 44169435951eSToby Isaac /*@ 4417b7385021SStefano Zampini DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation. 44189435951eSToby Isaac 4419e228b242SToby Isaac not collective 4420e228b242SToby Isaac 44219435951eSToby Isaac Input Parameter: 44229435951eSToby Isaac . dm - The DM 44239435951eSToby Isaac 4424d8d19677SJose E. Roman Output Parameters: 44259435951eSToby 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. 442679769bd5SJed Brown . 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. 442779769bd5SJed Brown - bias - Vector containing bias to be added to constrained dofs 44289435951eSToby Isaac 44299435951eSToby Isaac Level: advanced 44309435951eSToby Isaac 443179769bd5SJed Brown Note: This gets borrowed references, so the user should not destroy the PetscSection, Mat, or Vec. 44329435951eSToby Isaac 44339435951eSToby Isaac .seealso: DMSetDefaultConstraints() 44349435951eSToby Isaac @*/ 443579769bd5SJed Brown PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat, Vec *bias) 44369435951eSToby Isaac { 44379435951eSToby Isaac PetscErrorCode ierr; 44389435951eSToby Isaac 44399435951eSToby Isaac PetscFunctionBegin; 44409435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 44413b8ba7d1SJed Brown if (!dm->defaultConstraint.section && !dm->defaultConstraint.mat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);} 44423b8ba7d1SJed Brown if (section) *section = dm->defaultConstraint.section; 44433b8ba7d1SJed Brown if (mat) *mat = dm->defaultConstraint.mat; 444479769bd5SJed Brown if (bias) *bias = dm->defaultConstraint.bias; 44459435951eSToby Isaac PetscFunctionReturn(0); 44469435951eSToby Isaac } 44479435951eSToby Isaac 44489435951eSToby Isaac /*@ 4449b7385021SStefano Zampini DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation. 44509435951eSToby Isaac 445179769bd5SJed Brown 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 + bias, l[s[i]] = c[i], where the scatter s is defined by the PetscSection returned by DMGetDefaultConstraints(). 44529435951eSToby Isaac 445379769bd5SJed Brown 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. Any bias, if specified, is ignored when accumulating. 44549435951eSToby Isaac 4455e228b242SToby Isaac collective on dm 4456e228b242SToby Isaac 44579435951eSToby Isaac Input Parameters: 44589435951eSToby Isaac + dm - The DM 445979769bd5SJed Brown . 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). 446079769bd5SJed Brown . 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). 446179769bd5SJed Brown - bias - A bias vector to be added to constrained values in the local vector. NULL indicates no bias. Must have a local communicator (PETSC_COMM_SELF or derivative). 44629435951eSToby Isaac 44639435951eSToby Isaac Level: advanced 44649435951eSToby Isaac 446579769bd5SJed Brown Note: This increments the references of the PetscSection, Mat, and Vec, so they user can destroy them. 44669435951eSToby Isaac 44679435951eSToby Isaac .seealso: DMGetDefaultConstraints() 44689435951eSToby Isaac @*/ 446979769bd5SJed Brown PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat, Vec bias) 44709435951eSToby Isaac { 4471e228b242SToby Isaac PetscMPIInt result; 44729435951eSToby Isaac PetscErrorCode ierr; 44739435951eSToby Isaac 44749435951eSToby Isaac PetscFunctionBegin; 44759435951eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4476e228b242SToby Isaac if (section) { 4477e228b242SToby Isaac PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 4478ffc4695bSBarry Smith ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr); 44792c71b3e2SJacob Faibussowitsch PetscCheckFalse(result != MPI_CONGRUENT && result != MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator"); 4480e228b242SToby Isaac } 4481e228b242SToby Isaac if (mat) { 4482e228b242SToby Isaac PetscValidHeaderSpecific(mat,MAT_CLASSID,3); 4483ffc4695bSBarry Smith ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr); 44842c71b3e2SJacob Faibussowitsch PetscCheckFalse(result != MPI_CONGRUENT && result != MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator"); 4485e228b242SToby Isaac } 448679769bd5SJed Brown if (bias) { 448779769bd5SJed Brown PetscValidHeaderSpecific(bias,VEC_CLASSID,4); 448879769bd5SJed Brown ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)bias),&result);CHKERRMPI(ierr); 448979769bd5SJed Brown PetscCheck(result == MPI_CONGRUENT || result == MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint bias must have local communicator"); 449079769bd5SJed Brown } 44919435951eSToby Isaac ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 44923b8ba7d1SJed Brown ierr = PetscSectionDestroy(&dm->defaultConstraint.section);CHKERRQ(ierr); 44933b8ba7d1SJed Brown dm->defaultConstraint.section = section; 44949435951eSToby Isaac ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr); 44953b8ba7d1SJed Brown ierr = MatDestroy(&dm->defaultConstraint.mat);CHKERRQ(ierr); 44963b8ba7d1SJed Brown dm->defaultConstraint.mat = mat; 449779769bd5SJed Brown ierr = PetscObjectReference((PetscObject)bias);CHKERRQ(ierr); 449879769bd5SJed Brown ierr = VecDestroy(&dm->defaultConstraint.bias);CHKERRQ(ierr); 449979769bd5SJed Brown dm->defaultConstraint.bias = bias; 45009435951eSToby Isaac PetscFunctionReturn(0); 45019435951eSToby Isaac } 45029435951eSToby Isaac 4503497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 4504507e4973SMatthew G. Knepley /* 4505507e4973SMatthew G. Knepley DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections. 4506507e4973SMatthew G. Knepley 4507507e4973SMatthew G. Knepley Input Parameters: 4508507e4973SMatthew G. Knepley + dm - The DM 4509507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout 4510507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout 4511507e4973SMatthew G. Knepley 4512507e4973SMatthew G. Knepley Level: intermediate 4513507e4973SMatthew G. Knepley 45141bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF() 4515507e4973SMatthew G. Knepley */ 4516f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection) 4517507e4973SMatthew G. Knepley { 4518507e4973SMatthew G. Knepley MPI_Comm comm; 4519507e4973SMatthew G. Knepley PetscLayout layout; 4520507e4973SMatthew G. Knepley const PetscInt *ranges; 4521507e4973SMatthew G. Knepley PetscInt pStart, pEnd, p, nroots; 4522507e4973SMatthew G. Knepley PetscMPIInt size, rank; 4523507e4973SMatthew G. Knepley PetscBool valid = PETSC_TRUE, gvalid; 4524507e4973SMatthew G. Knepley PetscErrorCode ierr; 4525507e4973SMatthew G. Knepley 4526507e4973SMatthew G. Knepley PetscFunctionBegin; 4527507e4973SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr); 4528507e4973SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4529ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 4530ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 4531507e4973SMatthew G. Knepley ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr); 4532507e4973SMatthew G. Knepley ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr); 4533507e4973SMatthew G. Knepley ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr); 4534507e4973SMatthew G. Knepley ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr); 4535507e4973SMatthew G. Knepley ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr); 4536507e4973SMatthew G. Knepley ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr); 4537507e4973SMatthew G. Knepley ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr); 4538507e4973SMatthew G. Knepley for (p = pStart; p < pEnd; ++p) { 4539f741bcd2SMatthew G. Knepley PetscInt dof, cdof, off, gdof, gcdof, goff, gsize, d; 4540507e4973SMatthew G. Knepley 4541507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr); 4542507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr); 4543507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr); 4544507e4973SMatthew G. Knepley ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr); 4545507e4973SMatthew G. Knepley ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr); 4546507e4973SMatthew G. Knepley ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr); 4547507e4973SMatthew G. Knepley if (!gdof) continue; /* Censored point */ 4548507e4973SMatthew 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;} 4549507e4973SMatthew 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;} 4550507e4973SMatthew G. Knepley if (gdof < 0) { 4551507e4973SMatthew G. Knepley gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof; 4552507e4973SMatthew G. Knepley for (d = 0; d < gsize; ++d) { 4553507e4973SMatthew G. Knepley PetscInt offset = -(goff+1) + d, r; 4554507e4973SMatthew G. Knepley 4555507e4973SMatthew G. Knepley ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr); 4556507e4973SMatthew G. Knepley if (r < 0) r = -(r+2); 4557507e4973SMatthew 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;} 4558507e4973SMatthew G. Knepley } 4559507e4973SMatthew G. Knepley } 4560507e4973SMatthew G. Knepley } 4561507e4973SMatthew G. Knepley ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr); 4562507e4973SMatthew G. Knepley ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr); 4563820f2d46SBarry Smith ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 4564507e4973SMatthew G. Knepley if (!gvalid) { 4565507e4973SMatthew G. Knepley ierr = DMView(dm, NULL);CHKERRQ(ierr); 4566507e4973SMatthew G. Knepley SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections"); 4567507e4973SMatthew G. Knepley } 4568507e4973SMatthew G. Knepley PetscFunctionReturn(0); 4569507e4973SMatthew G. Knepley } 4570f741bcd2SMatthew G. Knepley #endif 4571507e4973SMatthew G. Knepley 457288ed4aceSMatthew G Knepley /*@ 4573e87a4003SBarry Smith DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM. 457488ed4aceSMatthew G Knepley 4575d083f849SBarry Smith Collective on dm 45768b1ab98fSJed Brown 457788ed4aceSMatthew G Knepley Input Parameter: 457888ed4aceSMatthew G Knepley . dm - The DM 457988ed4aceSMatthew G Knepley 458088ed4aceSMatthew G Knepley Output Parameter: 458188ed4aceSMatthew G Knepley . section - The PetscSection 458288ed4aceSMatthew G Knepley 458388ed4aceSMatthew G Knepley Level: intermediate 458488ed4aceSMatthew G Knepley 458588ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSection. 458688ed4aceSMatthew G Knepley 458792fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection() 458888ed4aceSMatthew G Knepley @*/ 4589e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section) 45900adebc6cSBarry Smith { 459188ed4aceSMatthew G Knepley PetscErrorCode ierr; 459288ed4aceSMatthew G Knepley 459388ed4aceSMatthew G Knepley PetscFunctionBegin; 459488ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 459588ed4aceSMatthew G Knepley PetscValidPointer(section, 2); 45961bb6d2a8SBarry Smith if (!dm->globalSection) { 4597fd59a867SMatthew G. Knepley PetscSection s; 4598fd59a867SMatthew G. Knepley 459992fd8e1eSJed Brown ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr); 46002c71b3e2SJacob Faibussowitsch PetscCheckFalse(!s,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection"); 46012c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->sf,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection"); 46021bb6d2a8SBarry Smith ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr); 4603cf06b437SMatthew G. Knepley ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr); 46041bb6d2a8SBarry Smith ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr); 46051bb6d2a8SBarry Smith ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr); 460688ed4aceSMatthew G Knepley } 46071bb6d2a8SBarry Smith *section = dm->globalSection; 460888ed4aceSMatthew G Knepley PetscFunctionReturn(0); 460988ed4aceSMatthew G Knepley } 461088ed4aceSMatthew G Knepley 4611b21d0597SMatthew G Knepley /*@ 4612e87a4003SBarry Smith DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM. 4613b21d0597SMatthew G Knepley 4614b21d0597SMatthew G Knepley Input Parameters: 4615b21d0597SMatthew G Knepley + dm - The DM 46165080bbdbSMatthew G Knepley - section - The PetscSection, or NULL 4617b21d0597SMatthew G Knepley 4618b21d0597SMatthew G Knepley Level: intermediate 4619b21d0597SMatthew G Knepley 4620b21d0597SMatthew G Knepley Note: Any existing Section will be destroyed 4621b21d0597SMatthew G Knepley 462292fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection() 4623b21d0597SMatthew G Knepley @*/ 4624e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section) 46250adebc6cSBarry Smith { 4626b21d0597SMatthew G Knepley PetscErrorCode ierr; 4627b21d0597SMatthew G Knepley 4628b21d0597SMatthew G Knepley PetscFunctionBegin; 4629b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 46305080bbdbSMatthew G Knepley if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2); 46311d799100SJed Brown ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr); 46321bb6d2a8SBarry Smith ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr); 46331bb6d2a8SBarry Smith dm->globalSection = section; 4634497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG) 46351bb6d2a8SBarry Smith if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);} 4636507e4973SMatthew G. Knepley #endif 4637b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4638b21d0597SMatthew G Knepley } 4639b21d0597SMatthew G Knepley 464088ed4aceSMatthew G Knepley /*@ 46411bb6d2a8SBarry Smith DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set, 464288ed4aceSMatthew G Knepley it is created from the default PetscSection layouts in the DM. 464388ed4aceSMatthew G Knepley 464488ed4aceSMatthew G Knepley Input Parameter: 464588ed4aceSMatthew G Knepley . dm - The DM 464688ed4aceSMatthew G Knepley 464788ed4aceSMatthew G Knepley Output Parameter: 464888ed4aceSMatthew G Knepley . sf - The PetscSF 464988ed4aceSMatthew G Knepley 465088ed4aceSMatthew G Knepley Level: intermediate 465188ed4aceSMatthew G Knepley 465288ed4aceSMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 465388ed4aceSMatthew G Knepley 46541bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF() 465588ed4aceSMatthew G Knepley @*/ 46561bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf) 46570adebc6cSBarry Smith { 465888ed4aceSMatthew G Knepley PetscInt nroots; 465988ed4aceSMatthew G Knepley PetscErrorCode ierr; 466088ed4aceSMatthew G Knepley 466188ed4aceSMatthew G Knepley PetscFunctionBegin; 466288ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 466388ed4aceSMatthew G Knepley PetscValidPointer(sf, 2); 46641bb6d2a8SBarry Smith if (!dm->sectionSF) { 46651bb6d2a8SBarry Smith ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr); 466633907cc2SStefano Zampini } 46671bb6d2a8SBarry Smith ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr); 466888ed4aceSMatthew G Knepley if (nroots < 0) { 466988ed4aceSMatthew G Knepley PetscSection section, gSection; 467088ed4aceSMatthew G Knepley 467192fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 467231ea6d37SMatthew G Knepley if (section) { 4673e87a4003SBarry Smith ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr); 46741bb6d2a8SBarry Smith ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr); 467531ea6d37SMatthew G Knepley } else { 46760298fd71SBarry Smith *sf = NULL; 467731ea6d37SMatthew G Knepley PetscFunctionReturn(0); 467831ea6d37SMatthew G Knepley } 467988ed4aceSMatthew G Knepley } 46801bb6d2a8SBarry Smith *sf = dm->sectionSF; 468188ed4aceSMatthew G Knepley PetscFunctionReturn(0); 468288ed4aceSMatthew G Knepley } 468388ed4aceSMatthew G Knepley 468488ed4aceSMatthew G Knepley /*@ 46851bb6d2a8SBarry Smith DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM 468688ed4aceSMatthew G Knepley 468788ed4aceSMatthew G Knepley Input Parameters: 468888ed4aceSMatthew G Knepley + dm - The DM 468988ed4aceSMatthew G Knepley - sf - The PetscSF 469088ed4aceSMatthew G Knepley 469188ed4aceSMatthew G Knepley Level: intermediate 469288ed4aceSMatthew G Knepley 469388ed4aceSMatthew G Knepley Note: Any previous SF is destroyed 469488ed4aceSMatthew G Knepley 46951bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF() 469688ed4aceSMatthew G Knepley @*/ 46971bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf) 46980adebc6cSBarry Smith { 469988ed4aceSMatthew G Knepley PetscErrorCode ierr; 470088ed4aceSMatthew G Knepley 470188ed4aceSMatthew G Knepley PetscFunctionBegin; 470288ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4703b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 470433907cc2SStefano Zampini ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 47051bb6d2a8SBarry Smith ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr); 47061bb6d2a8SBarry Smith dm->sectionSF = sf; 470788ed4aceSMatthew G Knepley PetscFunctionReturn(0); 470888ed4aceSMatthew G Knepley } 470988ed4aceSMatthew G Knepley 471088ed4aceSMatthew G Knepley /*@C 47111bb6d2a8SBarry Smith DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections 471288ed4aceSMatthew G Knepley describing the data layout. 471388ed4aceSMatthew G Knepley 471488ed4aceSMatthew G Knepley Input Parameters: 471588ed4aceSMatthew G Knepley + dm - The DM 471688ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout 471788ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout 471888ed4aceSMatthew G Knepley 47191bb6d2a8SBarry Smith Notes: One usually uses DMGetSectionSF() to obtain the PetscSF 472088ed4aceSMatthew G Knepley 47211bb6d2a8SBarry Smith Level: developer 47221bb6d2a8SBarry Smith 47231bb6d2a8SBarry Smith Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF 47241bb6d2a8SBarry Smith directly into the DM, perhaps this function should not take the local and global sections as 47251bb6d2a8SBarry Smith input and should just obtain them from the DM? 47261bb6d2a8SBarry Smith 47271bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection() 472888ed4aceSMatthew G Knepley @*/ 47291bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection) 473088ed4aceSMatthew G Knepley { 473188ed4aceSMatthew G Knepley PetscErrorCode ierr; 473288ed4aceSMatthew G Knepley 473388ed4aceSMatthew G Knepley PetscFunctionBegin; 473488ed4aceSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4735b0c7db22SLisandro Dalcin ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr); 473688ed4aceSMatthew G Knepley PetscFunctionReturn(0); 473788ed4aceSMatthew G Knepley } 4738af122d2aSMatthew G Knepley 4739b21d0597SMatthew G Knepley /*@ 4740b21d0597SMatthew G Knepley DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM. 4741b21d0597SMatthew G Knepley 4742b21d0597SMatthew G Knepley Input Parameter: 4743b21d0597SMatthew G Knepley . dm - The DM 4744b21d0597SMatthew G Knepley 4745b21d0597SMatthew G Knepley Output Parameter: 4746b21d0597SMatthew G Knepley . sf - The PetscSF 4747b21d0597SMatthew G Knepley 4748b21d0597SMatthew G Knepley Level: intermediate 4749b21d0597SMatthew G Knepley 4750b21d0597SMatthew G Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 4751b21d0597SMatthew G Knepley 47521bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4753b21d0597SMatthew G Knepley @*/ 47540adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf) 47550adebc6cSBarry Smith { 4756b21d0597SMatthew G Knepley PetscFunctionBegin; 4757b21d0597SMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4758b21d0597SMatthew G Knepley PetscValidPointer(sf, 2); 4759b21d0597SMatthew G Knepley *sf = dm->sf; 4760b21d0597SMatthew G Knepley PetscFunctionReturn(0); 4761b21d0597SMatthew G Knepley } 4762b21d0597SMatthew G Knepley 4763057b4bcdSMatthew G Knepley /*@ 4764057b4bcdSMatthew G Knepley DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM. 4765057b4bcdSMatthew G Knepley 4766057b4bcdSMatthew G Knepley Input Parameters: 4767057b4bcdSMatthew G Knepley + dm - The DM 4768057b4bcdSMatthew G Knepley - sf - The PetscSF 4769057b4bcdSMatthew G Knepley 4770057b4bcdSMatthew G Knepley Level: intermediate 4771057b4bcdSMatthew G Knepley 47721bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF() 4773057b4bcdSMatthew G Knepley @*/ 47740adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf) 47750adebc6cSBarry Smith { 4776057b4bcdSMatthew G Knepley PetscErrorCode ierr; 4777057b4bcdSMatthew G Knepley 4778057b4bcdSMatthew G Knepley PetscFunctionBegin; 4779057b4bcdSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4780b9d85ea2SLisandro Dalcin if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 4781057b4bcdSMatthew G Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 478233907cc2SStefano Zampini ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr); 4783057b4bcdSMatthew G Knepley dm->sf = sf; 4784057b4bcdSMatthew G Knepley PetscFunctionReturn(0); 4785057b4bcdSMatthew G Knepley } 4786057b4bcdSMatthew G Knepley 47874f37162bSMatthew G. Knepley /*@ 47884f37162bSMatthew G. Knepley DMGetNaturalSF - Get the PetscSF encoding the map back to the original mesh ordering 47894f37162bSMatthew G. Knepley 47904f37162bSMatthew G. Knepley Input Parameter: 47914f37162bSMatthew G. Knepley . dm - The DM 47924f37162bSMatthew G. Knepley 47934f37162bSMatthew G. Knepley Output Parameter: 47944f37162bSMatthew G. Knepley . sf - The PetscSF 47954f37162bSMatthew G. Knepley 47964f37162bSMatthew G. Knepley Level: intermediate 47974f37162bSMatthew G. Knepley 47984f37162bSMatthew G. Knepley Note: This gets a borrowed reference, so the user should not destroy this PetscSF. 47994f37162bSMatthew G. Knepley 48004f37162bSMatthew G. Knepley .seealso: DMSetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute() 48014f37162bSMatthew G. Knepley @*/ 48024f37162bSMatthew G. Knepley PetscErrorCode DMGetNaturalSF(DM dm, PetscSF *sf) 48034f37162bSMatthew G. Knepley { 48044f37162bSMatthew G. Knepley PetscFunctionBegin; 48054f37162bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 48064f37162bSMatthew G. Knepley PetscValidPointer(sf, 2); 48074f37162bSMatthew G. Knepley *sf = dm->sfNatural; 48084f37162bSMatthew G. Knepley PetscFunctionReturn(0); 48094f37162bSMatthew G. Knepley } 48104f37162bSMatthew G. Knepley 48114f37162bSMatthew G. Knepley /*@ 48124f37162bSMatthew G. Knepley DMSetNaturalSF - Set the PetscSF encoding the map back to the original mesh ordering 48134f37162bSMatthew G. Knepley 48144f37162bSMatthew G. Knepley Input Parameters: 48154f37162bSMatthew G. Knepley + dm - The DM 48164f37162bSMatthew G. Knepley - sf - The PetscSF 48174f37162bSMatthew G. Knepley 48184f37162bSMatthew G. Knepley Level: intermediate 48194f37162bSMatthew G. Knepley 48204f37162bSMatthew G. Knepley .seealso: DMGetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute() 48214f37162bSMatthew G. Knepley @*/ 48224f37162bSMatthew G. Knepley PetscErrorCode DMSetNaturalSF(DM dm, PetscSF sf) 48234f37162bSMatthew G. Knepley { 48244f37162bSMatthew G. Knepley PetscErrorCode ierr; 48254f37162bSMatthew G. Knepley 48264f37162bSMatthew G. Knepley PetscFunctionBegin; 48274f37162bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 48284f37162bSMatthew G. Knepley if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 48294f37162bSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr); 48304f37162bSMatthew G. Knepley ierr = PetscSFDestroy(&dm->sfNatural);CHKERRQ(ierr); 48314f37162bSMatthew G. Knepley dm->sfNatural = sf; 48324f37162bSMatthew G. Knepley PetscFunctionReturn(0); 48334f37162bSMatthew G. Knepley } 48344f37162bSMatthew G. Knepley 483534aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc) 483634aa8a36SMatthew G. Knepley { 483734aa8a36SMatthew G. Knepley PetscClassId id; 483834aa8a36SMatthew G. Knepley PetscErrorCode ierr; 483934aa8a36SMatthew G. Knepley 484034aa8a36SMatthew G. Knepley PetscFunctionBegin; 484134aa8a36SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 484234aa8a36SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 484334aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 484434aa8a36SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 484534aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr); 484617c1d62eSMatthew G. Knepley } else { 484717c1d62eSMatthew G. Knepley ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 484834aa8a36SMatthew G. Knepley } 484934aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 485034aa8a36SMatthew G. Knepley } 485134aa8a36SMatthew G. Knepley 485244a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew) 485344a7f3ddSMatthew G. Knepley { 485444a7f3ddSMatthew G. Knepley RegionField *tmpr; 485544a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf, f; 485644a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 485744a7f3ddSMatthew G. Knepley 485844a7f3ddSMatthew G. Knepley PetscFunctionBegin; 485944a7f3ddSMatthew G. Knepley if (Nf >= NfNew) PetscFunctionReturn(0); 486044a7f3ddSMatthew G. Knepley ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr); 486144a7f3ddSMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f]; 4862e0b68406SMatthew Knepley for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;} 486344a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 486444a7f3ddSMatthew G. Knepley dm->Nf = NfNew; 486544a7f3ddSMatthew G. Knepley dm->fields = tmpr; 486644a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 486744a7f3ddSMatthew G. Knepley } 486844a7f3ddSMatthew G. Knepley 486944a7f3ddSMatthew G. Knepley /*@ 487044a7f3ddSMatthew G. Knepley DMClearFields - Remove all fields from the DM 487144a7f3ddSMatthew G. Knepley 4872d083f849SBarry Smith Logically collective on dm 487344a7f3ddSMatthew G. Knepley 487444a7f3ddSMatthew G. Knepley Input Parameter: 487544a7f3ddSMatthew G. Knepley . dm - The DM 487644a7f3ddSMatthew G. Knepley 487744a7f3ddSMatthew G. Knepley Level: intermediate 487844a7f3ddSMatthew G. Knepley 487944a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField() 488044a7f3ddSMatthew G. Knepley @*/ 488144a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm) 488244a7f3ddSMatthew G. Knepley { 488344a7f3ddSMatthew G. Knepley PetscInt f; 488444a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 488544a7f3ddSMatthew G. Knepley 488644a7f3ddSMatthew G. Knepley PetscFunctionBegin; 488744a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 488844a7f3ddSMatthew G. Knepley for (f = 0; f < dm->Nf; ++f) { 488944a7f3ddSMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 489044a7f3ddSMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 489144a7f3ddSMatthew G. Knepley } 489244a7f3ddSMatthew G. Knepley ierr = PetscFree(dm->fields);CHKERRQ(ierr); 489344a7f3ddSMatthew G. Knepley dm->fields = NULL; 489444a7f3ddSMatthew G. Knepley dm->Nf = 0; 489544a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 489644a7f3ddSMatthew G. Knepley } 489744a7f3ddSMatthew G. Knepley 4898689b5837SMatthew G. Knepley /*@ 4899689b5837SMatthew G. Knepley DMGetNumFields - Get the number of fields in the DM 4900689b5837SMatthew G. Knepley 4901689b5837SMatthew G. Knepley Not collective 4902689b5837SMatthew G. Knepley 4903689b5837SMatthew G. Knepley Input Parameter: 4904689b5837SMatthew G. Knepley . dm - The DM 4905689b5837SMatthew G. Knepley 4906689b5837SMatthew G. Knepley Output Parameter: 4907689b5837SMatthew G. Knepley . Nf - The number of fields 4908689b5837SMatthew G. Knepley 4909689b5837SMatthew G. Knepley Level: intermediate 4910689b5837SMatthew G. Knepley 4911689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField() 4912689b5837SMatthew G. Knepley @*/ 49130f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields) 49140f21e855SMatthew G. Knepley { 49150f21e855SMatthew G. Knepley PetscFunctionBegin; 49160f21e855SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4917534a8f05SLisandro Dalcin PetscValidIntPointer(numFields, 2); 491844a7f3ddSMatthew G. Knepley *numFields = dm->Nf; 4919af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4920af122d2aSMatthew G Knepley } 4921af122d2aSMatthew G Knepley 4922689b5837SMatthew G. Knepley /*@ 4923689b5837SMatthew G. Knepley DMSetNumFields - Set the number of fields in the DM 4924689b5837SMatthew G. Knepley 4925d083f849SBarry Smith Logically collective on dm 4926689b5837SMatthew G. Knepley 4927689b5837SMatthew G. Knepley Input Parameters: 4928689b5837SMatthew G. Knepley + dm - The DM 4929689b5837SMatthew G. Knepley - Nf - The number of fields 4930689b5837SMatthew G. Knepley 4931689b5837SMatthew G. Knepley Level: intermediate 4932689b5837SMatthew G. Knepley 4933689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField() 4934689b5837SMatthew G. Knepley @*/ 4935af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields) 4936af122d2aSMatthew G Knepley { 49370f21e855SMatthew G. Knepley PetscInt Nf, f; 4938af122d2aSMatthew G Knepley PetscErrorCode ierr; 4939af122d2aSMatthew G Knepley 4940af122d2aSMatthew G Knepley PetscFunctionBegin; 4941af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 494244a7f3ddSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 49430f21e855SMatthew G. Knepley for (f = Nf; f < numFields; ++f) { 49440f21e855SMatthew G. Knepley PetscContainer obj; 49450f21e855SMatthew G. Knepley 49460f21e855SMatthew G. Knepley ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr); 494744a7f3ddSMatthew G. Knepley ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr); 49480f21e855SMatthew G. Knepley ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr); 4949af122d2aSMatthew G Knepley } 4950af122d2aSMatthew G Knepley PetscFunctionReturn(0); 4951af122d2aSMatthew G Knepley } 4952af122d2aSMatthew G Knepley 4953c1929be8SMatthew G. Knepley /*@ 4954c1929be8SMatthew G. Knepley DMGetField - Return the discretization object for a given DM field 4955c1929be8SMatthew G. Knepley 4956c1929be8SMatthew G. Knepley Not collective 4957c1929be8SMatthew G. Knepley 4958c1929be8SMatthew G. Knepley Input Parameters: 4959c1929be8SMatthew G. Knepley + dm - The DM 4960c1929be8SMatthew G. Knepley - f - The field number 4961c1929be8SMatthew G. Knepley 496244a7f3ddSMatthew G. Knepley Output Parameters: 496344a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh 496444a7f3ddSMatthew G. Knepley - field - The discretization object 4965c1929be8SMatthew G. Knepley 496644a7f3ddSMatthew G. Knepley Level: intermediate 4967c1929be8SMatthew G. Knepley 496844a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField() 4969c1929be8SMatthew G. Knepley @*/ 497044a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field) 4971af122d2aSMatthew G Knepley { 4972af122d2aSMatthew G Knepley PetscFunctionBegin; 4973af122d2aSMatthew G Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 4974064a246eSJacob Faibussowitsch PetscValidPointer(field, 4); 49752c71b3e2SJacob Faibussowitsch PetscCheckFalse((f < 0) || (f >= dm->Nf),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf); 497644a7f3ddSMatthew G. Knepley if (label) *label = dm->fields[f].label; 497744a7f3ddSMatthew G. Knepley if (field) *field = dm->fields[f].disc; 4978decb47aaSMatthew G. Knepley PetscFunctionReturn(0); 4979decb47aaSMatthew G. Knepley } 4980decb47aaSMatthew G. Knepley 4981083401c6SMatthew G. Knepley /* Does not clear the DS */ 4982083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field) 4983083401c6SMatthew G. Knepley { 4984083401c6SMatthew G. Knepley PetscErrorCode ierr; 4985083401c6SMatthew G. Knepley 4986083401c6SMatthew G. Knepley PetscFunctionBegin; 4987083401c6SMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr); 4988083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr); 4989083401c6SMatthew G. Knepley ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr); 4990083401c6SMatthew G. Knepley dm->fields[f].label = label; 4991083401c6SMatthew G. Knepley dm->fields[f].disc = field; 4992083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 4993083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 4994083401c6SMatthew G. Knepley PetscFunctionReturn(0); 4995083401c6SMatthew G. Knepley } 4996083401c6SMatthew G. Knepley 4997c1929be8SMatthew G. Knepley /*@ 4998c1929be8SMatthew G. Knepley DMSetField - Set the discretization object for a given DM field 4999c1929be8SMatthew G. Knepley 5000d083f849SBarry Smith Logically collective on dm 5001c1929be8SMatthew G. Knepley 5002c1929be8SMatthew G. Knepley Input Parameters: 5003c1929be8SMatthew G. Knepley + dm - The DM 5004c1929be8SMatthew G. Knepley . f - The field number 500544a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 5006c1929be8SMatthew G. Knepley - field - The discretization object 5007c1929be8SMatthew G. Knepley 500844a7f3ddSMatthew G. Knepley Level: intermediate 5009c1929be8SMatthew G. Knepley 501044a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField() 5011c1929be8SMatthew G. Knepley @*/ 501244a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field) 5013decb47aaSMatthew G. Knepley { 5014decb47aaSMatthew G. Knepley PetscErrorCode ierr; 5015decb47aaSMatthew G. Knepley 5016decb47aaSMatthew G. Knepley PetscFunctionBegin; 5017decb47aaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5018e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3); 501944a7f3ddSMatthew G. Knepley PetscValidHeader(field, 4); 50202c71b3e2SJacob Faibussowitsch PetscCheckFalse(f < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 5021083401c6SMatthew G. Knepley ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr); 502234aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr); 50232df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 502444a7f3ddSMatthew G. Knepley PetscFunctionReturn(0); 502544a7f3ddSMatthew G. Knepley } 502644a7f3ddSMatthew G. Knepley 502744a7f3ddSMatthew G. Knepley /*@ 502844a7f3ddSMatthew G. Knepley DMAddField - Add the discretization object for the given DM field 502944a7f3ddSMatthew G. Knepley 5030d083f849SBarry Smith Logically collective on dm 503144a7f3ddSMatthew G. Knepley 503244a7f3ddSMatthew G. Knepley Input Parameters: 503344a7f3ddSMatthew G. Knepley + dm - The DM 503444a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh 503544a7f3ddSMatthew G. Knepley - field - The discretization object 503644a7f3ddSMatthew G. Knepley 503744a7f3ddSMatthew G. Knepley Level: intermediate 503844a7f3ddSMatthew G. Knepley 503944a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField() 504044a7f3ddSMatthew G. Knepley @*/ 504144a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field) 504244a7f3ddSMatthew G. Knepley { 504344a7f3ddSMatthew G. Knepley PetscInt Nf = dm->Nf; 504444a7f3ddSMatthew G. Knepley PetscErrorCode ierr; 504544a7f3ddSMatthew G. Knepley 504644a7f3ddSMatthew G. Knepley PetscFunctionBegin; 504744a7f3ddSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5048064a246eSJacob Faibussowitsch if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 504944a7f3ddSMatthew G. Knepley PetscValidHeader(field, 3); 505044a7f3ddSMatthew G. Knepley ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr); 505144a7f3ddSMatthew G. Knepley dm->fields[Nf].label = label; 505244a7f3ddSMatthew G. Knepley dm->fields[Nf].disc = field; 505344a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 505444a7f3ddSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr); 505534aa8a36SMatthew G. Knepley ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr); 50562df9ee95SMatthew G. Knepley ierr = DMClearDS(dm);CHKERRQ(ierr); 5057af122d2aSMatthew G Knepley PetscFunctionReturn(0); 5058af122d2aSMatthew G Knepley } 50596636e97aSMatthew G Knepley 5060e5e52638SMatthew G. Knepley /*@ 5061e0b68406SMatthew Knepley DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells 5062e0b68406SMatthew Knepley 5063e0b68406SMatthew Knepley Logically collective on dm 5064e0b68406SMatthew Knepley 5065e0b68406SMatthew Knepley Input Parameters: 5066e0b68406SMatthew Knepley + dm - The DM 5067e0b68406SMatthew Knepley . f - The field index 5068e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells 5069e0b68406SMatthew Knepley 5070e0b68406SMatthew Knepley Level: intermediate 5071e0b68406SMatthew Knepley 5072e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField() 5073e0b68406SMatthew Knepley @*/ 5074e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor) 5075e0b68406SMatthew Knepley { 5076e0b68406SMatthew Knepley PetscFunctionBegin; 50772c71b3e2SJacob Faibussowitsch PetscCheckFalse((f < 0) || (f >= dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf); 5078e0b68406SMatthew Knepley dm->fields[f].avoidTensor = avoidTensor; 5079e0b68406SMatthew Knepley PetscFunctionReturn(0); 5080e0b68406SMatthew Knepley } 5081e0b68406SMatthew Knepley 5082e0b68406SMatthew Knepley /*@ 5083e0b68406SMatthew Knepley DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells 5084e0b68406SMatthew Knepley 5085e0b68406SMatthew Knepley Logically collective on dm 5086e0b68406SMatthew Knepley 5087e0b68406SMatthew Knepley Input Parameters: 5088e0b68406SMatthew Knepley + dm - The DM 5089e0b68406SMatthew Knepley - f - The field index 5090e0b68406SMatthew Knepley 5091e0b68406SMatthew Knepley Output Parameter: 5092e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells 5093e0b68406SMatthew Knepley 5094e0b68406SMatthew Knepley Level: intermediate 5095e0b68406SMatthew Knepley 5096e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField() 5097e0b68406SMatthew Knepley @*/ 5098e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor) 5099e0b68406SMatthew Knepley { 5100e0b68406SMatthew Knepley PetscFunctionBegin; 51012c71b3e2SJacob Faibussowitsch PetscCheckFalse((f < 0) || (f >= dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf); 5102e0b68406SMatthew Knepley *avoidTensor = dm->fields[f].avoidTensor; 5103e0b68406SMatthew Knepley PetscFunctionReturn(0); 5104e0b68406SMatthew Knepley } 5105e0b68406SMatthew Knepley 5106e0b68406SMatthew Knepley /*@ 5107e5e52638SMatthew G. Knepley DMCopyFields - Copy the discretizations for the DM into another DM 5108e5e52638SMatthew G. Knepley 5109d083f849SBarry Smith Collective on dm 5110e5e52638SMatthew G. Knepley 5111e5e52638SMatthew G. Knepley Input Parameter: 5112e5e52638SMatthew G. Knepley . dm - The DM 5113e5e52638SMatthew G. Knepley 5114e5e52638SMatthew G. Knepley Output Parameter: 5115e5e52638SMatthew G. Knepley . newdm - The DM 5116e5e52638SMatthew G. Knepley 5117e5e52638SMatthew G. Knepley Level: advanced 5118e5e52638SMatthew G. Knepley 5119e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS() 5120e5e52638SMatthew G. Knepley @*/ 5121e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm) 5122e5e52638SMatthew G. Knepley { 5123e5e52638SMatthew G. Knepley PetscInt Nf, f; 5124e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5125e5e52638SMatthew G. Knepley 5126e5e52638SMatthew G. Knepley PetscFunctionBegin; 5127e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 5128e5e52638SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5129e5e52638SMatthew G. Knepley ierr = DMClearFields(newdm);CHKERRQ(ierr); 5130e5e52638SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5131e5e52638SMatthew G. Knepley DMLabel label; 5132e5e52638SMatthew G. Knepley PetscObject field; 513334aa8a36SMatthew G. Knepley PetscBool useCone, useClosure; 5134e5e52638SMatthew G. Knepley 5135e5e52638SMatthew G. Knepley ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr); 5136e5e52638SMatthew G. Knepley ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr); 513734aa8a36SMatthew G. Knepley ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr); 513834aa8a36SMatthew G. Knepley ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr); 513934aa8a36SMatthew G. Knepley } 514034aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 514134aa8a36SMatthew G. Knepley } 514234aa8a36SMatthew G. Knepley 514334aa8a36SMatthew G. Knepley /*@ 514434aa8a36SMatthew G. Knepley DMGetAdjacency - Returns the flags for determining variable influence 514534aa8a36SMatthew G. Knepley 514634aa8a36SMatthew G. Knepley Not collective 514734aa8a36SMatthew G. Knepley 514834aa8a36SMatthew G. Knepley Input Parameters: 514934aa8a36SMatthew G. Knepley + dm - The DM object 515034aa8a36SMatthew G. Knepley - f - The field number, or PETSC_DEFAULT for the default adjacency 515134aa8a36SMatthew G. Knepley 5152d8d19677SJose E. Roman Output Parameters: 515334aa8a36SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 515434aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 515534aa8a36SMatthew G. Knepley 515634aa8a36SMatthew G. Knepley Notes: 515734aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 515834aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 515934aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5160979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 516134aa8a36SMatthew G. Knepley 516234aa8a36SMatthew G. Knepley Level: developer 516334aa8a36SMatthew G. Knepley 516434aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField() 516534aa8a36SMatthew G. Knepley @*/ 516634aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure) 516734aa8a36SMatthew G. Knepley { 516834aa8a36SMatthew G. Knepley PetscFunctionBegin; 516934aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5170534a8f05SLisandro Dalcin if (useCone) PetscValidBoolPointer(useCone, 3); 5171534a8f05SLisandro Dalcin if (useClosure) PetscValidBoolPointer(useClosure, 4); 517234aa8a36SMatthew G. Knepley if (f < 0) { 517334aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->adjacency[0]; 517434aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->adjacency[1]; 517534aa8a36SMatthew G. Knepley } else { 517634aa8a36SMatthew G. Knepley PetscInt Nf; 517734aa8a36SMatthew G. Knepley PetscErrorCode ierr; 517834aa8a36SMatthew G. Knepley 517934aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 51802c71b3e2SJacob Faibussowitsch PetscCheckFalse(f >= Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 518134aa8a36SMatthew G. Knepley if (useCone) *useCone = dm->fields[f].adjacency[0]; 518234aa8a36SMatthew G. Knepley if (useClosure) *useClosure = dm->fields[f].adjacency[1]; 518334aa8a36SMatthew G. Knepley } 518434aa8a36SMatthew G. Knepley PetscFunctionReturn(0); 518534aa8a36SMatthew G. Knepley } 518634aa8a36SMatthew G. Knepley 518734aa8a36SMatthew G. Knepley /*@ 518834aa8a36SMatthew G. Knepley DMSetAdjacency - Set the flags for determining variable influence 518934aa8a36SMatthew G. Knepley 519034aa8a36SMatthew G. Knepley Not collective 519134aa8a36SMatthew G. Knepley 519234aa8a36SMatthew G. Knepley Input Parameters: 519334aa8a36SMatthew G. Knepley + dm - The DM object 519434aa8a36SMatthew G. Knepley . f - The field number 519534aa8a36SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 519634aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 519734aa8a36SMatthew G. Knepley 519834aa8a36SMatthew G. Knepley Notes: 519934aa8a36SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 520034aa8a36SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 520134aa8a36SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5202979e053dSMatthew G. Knepley Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another. 520334aa8a36SMatthew G. Knepley 520434aa8a36SMatthew G. Knepley Level: developer 520534aa8a36SMatthew G. Knepley 520634aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField() 520734aa8a36SMatthew G. Knepley @*/ 520834aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure) 520934aa8a36SMatthew G. Knepley { 521034aa8a36SMatthew G. Knepley PetscFunctionBegin; 521134aa8a36SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 521234aa8a36SMatthew G. Knepley if (f < 0) { 521334aa8a36SMatthew G. Knepley dm->adjacency[0] = useCone; 521434aa8a36SMatthew G. Knepley dm->adjacency[1] = useClosure; 521534aa8a36SMatthew G. Knepley } else { 521634aa8a36SMatthew G. Knepley PetscInt Nf; 521734aa8a36SMatthew G. Knepley PetscErrorCode ierr; 521834aa8a36SMatthew G. Knepley 521934aa8a36SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 52202c71b3e2SJacob Faibussowitsch PetscCheckFalse(f >= Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf); 522134aa8a36SMatthew G. Knepley dm->fields[f].adjacency[0] = useCone; 522234aa8a36SMatthew G. Knepley dm->fields[f].adjacency[1] = useClosure; 5223e5e52638SMatthew G. Knepley } 5224e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5225e5e52638SMatthew G. Knepley } 5226e5e52638SMatthew G. Knepley 5227b0441da4SMatthew G. Knepley /*@ 5228b0441da4SMatthew G. Knepley DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined 5229b0441da4SMatthew G. Knepley 5230b0441da4SMatthew G. Knepley Not collective 5231b0441da4SMatthew G. Knepley 5232f899ff85SJose E. Roman Input Parameter: 5233b0441da4SMatthew G. Knepley . dm - The DM object 5234b0441da4SMatthew G. Knepley 5235d8d19677SJose E. Roman Output Parameters: 5236b0441da4SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 5237b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 5238b0441da4SMatthew G. Knepley 5239b0441da4SMatthew G. Knepley Notes: 5240b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 5241b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 5242b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5243b0441da4SMatthew G. Knepley 5244b0441da4SMatthew G. Knepley Level: developer 5245b0441da4SMatthew G. Knepley 5246b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField() 5247b0441da4SMatthew G. Knepley @*/ 5248b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure) 5249b0441da4SMatthew G. Knepley { 5250b0441da4SMatthew G. Knepley PetscInt Nf; 5251b0441da4SMatthew G. Knepley PetscErrorCode ierr; 5252b0441da4SMatthew G. Knepley 5253b0441da4SMatthew G. Knepley PetscFunctionBegin; 5254b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5255064a246eSJacob Faibussowitsch if (useCone) PetscValidBoolPointer(useCone, 2); 5256064a246eSJacob Faibussowitsch if (useClosure) PetscValidBoolPointer(useClosure, 3); 5257b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5258b0441da4SMatthew G. Knepley if (!Nf) { 5259b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 5260b0441da4SMatthew G. Knepley } else { 5261b0441da4SMatthew G. Knepley ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 5262b0441da4SMatthew G. Knepley } 5263b0441da4SMatthew G. Knepley PetscFunctionReturn(0); 5264b0441da4SMatthew G. Knepley } 5265b0441da4SMatthew G. Knepley 5266b0441da4SMatthew G. Knepley /*@ 5267b0441da4SMatthew G. Knepley DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined 5268b0441da4SMatthew G. Knepley 5269b0441da4SMatthew G. Knepley Not collective 5270b0441da4SMatthew G. Knepley 5271b0441da4SMatthew G. Knepley Input Parameters: 5272b0441da4SMatthew G. Knepley + dm - The DM object 5273b0441da4SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 5274b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 5275b0441da4SMatthew G. Knepley 5276b0441da4SMatthew G. Knepley Notes: 5277b0441da4SMatthew G. Knepley $ FEM: Two points p and q are adjacent if q \in closure(star(p)), useCone = PETSC_FALSE, useClosure = PETSC_TRUE 5278b0441da4SMatthew G. Knepley $ FVM: Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE, useClosure = PETSC_FALSE 5279b0441da4SMatthew G. Knepley $ FVM++: Two points p and q are adjacent if q \in star(closure(p)), useCone = PETSC_TRUE, useClosure = PETSC_TRUE 5280b0441da4SMatthew G. Knepley 5281b0441da4SMatthew G. Knepley Level: developer 5282b0441da4SMatthew G. Knepley 5283b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField() 5284b0441da4SMatthew G. Knepley @*/ 5285b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure) 5286b0441da4SMatthew G. Knepley { 5287b0441da4SMatthew G. Knepley PetscInt Nf; 5288b0441da4SMatthew G. Knepley PetscErrorCode ierr; 5289b0441da4SMatthew G. Knepley 5290b0441da4SMatthew G. Knepley PetscFunctionBegin; 5291b0441da4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5292b0441da4SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 5293b0441da4SMatthew G. Knepley if (!Nf) { 5294b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr); 5295b0441da4SMatthew G. Knepley } else { 5296b0441da4SMatthew G. Knepley ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr); 5297e5e52638SMatthew G. Knepley } 5298e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5299e5e52638SMatthew G. Knepley } 5300e5e52638SMatthew G. Knepley 5301783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */ 530245480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label) 5303783e2ec8SMatthew G. Knepley { 5304783e2ec8SMatthew G. Knepley PetscObject obj; 5305783e2ec8SMatthew G. Knepley PetscClassId id; 5306783e2ec8SMatthew G. Knepley PetscInt Nbd, bd; 5307783e2ec8SMatthew G. Knepley PetscBool isFE = PETSC_FALSE; 5308783e2ec8SMatthew G. Knepley PetscBool duplicate = PETSC_FALSE; 5309783e2ec8SMatthew G. Knepley PetscErrorCode ierr; 5310783e2ec8SMatthew G. Knepley 5311783e2ec8SMatthew G. Knepley PetscFunctionBegin; 5312783e2ec8SMatthew G. Knepley ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr); 5313783e2ec8SMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 5314783e2ec8SMatthew G. Knepley if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE; 5315783e2ec8SMatthew G. Knepley if (isFE && label) { 5316783e2ec8SMatthew G. Knepley /* Only want to modify label once */ 5317783e2ec8SMatthew G. Knepley ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr); 5318783e2ec8SMatthew G. Knepley for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) { 531945480ffeSMatthew G. Knepley DMLabel l; 5320783e2ec8SMatthew G. Knepley 532145480ffeSMatthew G. Knepley ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 532245480ffeSMatthew G. Knepley duplicate = l == label ? PETSC_TRUE : PETSC_FALSE; 5323783e2ec8SMatthew G. Knepley if (duplicate) break; 5324783e2ec8SMatthew G. Knepley } 5325783e2ec8SMatthew G. Knepley if (!duplicate) { 5326783e2ec8SMatthew G. Knepley DM plex; 5327783e2ec8SMatthew G. Knepley 5328783e2ec8SMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 5329783e2ec8SMatthew G. Knepley if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);} 5330783e2ec8SMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 5331783e2ec8SMatthew G. Knepley } 5332783e2ec8SMatthew G. Knepley } 5333783e2ec8SMatthew G. Knepley PetscFunctionReturn(0); 5334783e2ec8SMatthew G. Knepley } 5335783e2ec8SMatthew G. Knepley 5336e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew) 5337e5e52638SMatthew G. Knepley { 5338e5e52638SMatthew G. Knepley DMSpace *tmpd; 5339e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5340e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5341e5e52638SMatthew G. Knepley 5342e5e52638SMatthew G. Knepley PetscFunctionBegin; 5343e5e52638SMatthew G. Knepley if (Nds >= NdsNew) PetscFunctionReturn(0); 5344e5e52638SMatthew G. Knepley ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr); 5345e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s]; 5346b3cf3223SMatthew G. Knepley for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;} 5347e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 5348e5e52638SMatthew G. Knepley dm->Nds = NdsNew; 5349e5e52638SMatthew G. Knepley dm->probs = tmpd; 5350e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5351e5e52638SMatthew G. Knepley } 5352e5e52638SMatthew G. Knepley 5353e5e52638SMatthew G. Knepley /*@ 5354e5e52638SMatthew G. Knepley DMGetNumDS - Get the number of discrete systems in the DM 5355e5e52638SMatthew G. Knepley 5356e5e52638SMatthew G. Knepley Not collective 5357e5e52638SMatthew G. Knepley 5358e5e52638SMatthew G. Knepley Input Parameter: 5359e5e52638SMatthew G. Knepley . dm - The DM 5360e5e52638SMatthew G. Knepley 5361e5e52638SMatthew G. Knepley Output Parameter: 5362e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects 5363e5e52638SMatthew G. Knepley 5364e5e52638SMatthew G. Knepley Level: intermediate 5365e5e52638SMatthew G. Knepley 5366e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS() 5367e5e52638SMatthew G. Knepley @*/ 5368e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds) 5369e5e52638SMatthew G. Knepley { 5370e5e52638SMatthew G. Knepley PetscFunctionBegin; 5371e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5372534a8f05SLisandro Dalcin PetscValidIntPointer(Nds, 2); 5373e5e52638SMatthew G. Knepley *Nds = dm->Nds; 5374e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5375e5e52638SMatthew G. Knepley } 5376e5e52638SMatthew G. Knepley 5377e5e52638SMatthew G. Knepley /*@ 5378e5e52638SMatthew G. Knepley DMClearDS - Remove all discrete systems from the DM 5379e5e52638SMatthew G. Knepley 5380d083f849SBarry Smith Logically collective on dm 5381e5e52638SMatthew G. Knepley 5382e5e52638SMatthew G. Knepley Input Parameter: 5383e5e52638SMatthew G. Knepley . dm - The DM 5384e5e52638SMatthew G. Knepley 5385e5e52638SMatthew G. Knepley Level: intermediate 5386e5e52638SMatthew G. Knepley 5387e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField() 5388e5e52638SMatthew G. Knepley @*/ 5389e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm) 5390e5e52638SMatthew G. Knepley { 5391e5e52638SMatthew G. Knepley PetscInt s; 5392e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5393e5e52638SMatthew G. Knepley 5394e5e52638SMatthew G. Knepley PetscFunctionBegin; 5395e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5396e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5397e5e52638SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5398e5e52638SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr); 5399b3cf3223SMatthew G. Knepley ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr); 5400e5e52638SMatthew G. Knepley } 5401e5e52638SMatthew G. Knepley ierr = PetscFree(dm->probs);CHKERRQ(ierr); 5402e5e52638SMatthew G. Knepley dm->probs = NULL; 5403e5e52638SMatthew G. Knepley dm->Nds = 0; 5404e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5405e5e52638SMatthew G. Knepley } 5406e5e52638SMatthew G. Knepley 5407e5e52638SMatthew G. Knepley /*@ 5408e5e52638SMatthew G. Knepley DMGetDS - Get the default PetscDS 5409e5e52638SMatthew G. Knepley 5410e5e52638SMatthew G. Knepley Not collective 5411e5e52638SMatthew G. Knepley 5412e5e52638SMatthew G. Knepley Input Parameter: 5413e5e52638SMatthew G. Knepley . dm - The DM 5414e5e52638SMatthew G. Knepley 5415e5e52638SMatthew G. Knepley Output Parameter: 5416e5e52638SMatthew G. Knepley . prob - The default PetscDS 5417e5e52638SMatthew G. Knepley 5418e5e52638SMatthew G. Knepley Level: intermediate 5419e5e52638SMatthew G. Knepley 5420e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS() 5421e5e52638SMatthew G. Knepley @*/ 5422e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob) 5423e5e52638SMatthew G. Knepley { 5424b0143b4dSMatthew G. Knepley PetscErrorCode ierr; 5425b0143b4dSMatthew G. Knepley 5426e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5427e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5428e5e52638SMatthew G. Knepley PetscValidPointer(prob, 2); 5429b0143b4dSMatthew G. Knepley if (dm->Nds <= 0) { 5430b0143b4dSMatthew G. Knepley PetscDS ds; 5431b0143b4dSMatthew G. Knepley 543245480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 5433b3cf3223SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr); 5434b0143b4dSMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 5435b0143b4dSMatthew G. Knepley } 5436b0143b4dSMatthew G. Knepley *prob = dm->probs[0].ds; 5437e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5438e5e52638SMatthew G. Knepley } 5439e5e52638SMatthew G. Knepley 5440e5e52638SMatthew G. Knepley /*@ 5441e5e52638SMatthew G. Knepley DMGetCellDS - Get the PetscDS defined on a given cell 5442e5e52638SMatthew G. Knepley 5443e5e52638SMatthew G. Knepley Not collective 5444e5e52638SMatthew G. Knepley 5445e5e52638SMatthew G. Knepley Input Parameters: 5446e5e52638SMatthew G. Knepley + dm - The DM 5447e5e52638SMatthew G. Knepley - point - Cell for the DS 5448e5e52638SMatthew G. Knepley 5449e5e52638SMatthew G. Knepley Output Parameter: 5450e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell 5451e5e52638SMatthew G. Knepley 5452e5e52638SMatthew G. Knepley Level: developer 5453e5e52638SMatthew G. Knepley 5454b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS() 5455e5e52638SMatthew G. Knepley @*/ 5456e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob) 5457e5e52638SMatthew G. Knepley { 5458e5e52638SMatthew G. Knepley PetscDS probDef = NULL; 5459e5e52638SMatthew G. Knepley PetscInt s; 5460e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5461e5e52638SMatthew G. Knepley 5462e5e52638SMatthew G. Knepley PetscFunctionBeginHot; 5463e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5464e5e52638SMatthew G. Knepley PetscValidPointer(prob, 3); 54652c71b3e2SJacob Faibussowitsch PetscCheckFalse(point < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point); 5466e5e52638SMatthew G. Knepley *prob = NULL; 5467e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5468e5e52638SMatthew G. Knepley PetscInt val; 5469e5e52638SMatthew G. Knepley 5470e5e52638SMatthew G. Knepley if (!dm->probs[s].label) {probDef = dm->probs[s].ds;} 5471e5e52638SMatthew G. Knepley else { 5472e5e52638SMatthew G. Knepley ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr); 5473e5e52638SMatthew G. Knepley if (val >= 0) {*prob = dm->probs[s].ds; break;} 5474e5e52638SMatthew G. Knepley } 5475e5e52638SMatthew G. Knepley } 5476e5e52638SMatthew G. Knepley if (!*prob) *prob = probDef; 5477e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5478e5e52638SMatthew G. Knepley } 5479e5e52638SMatthew G. Knepley 5480e5e52638SMatthew G. Knepley /*@ 5481e5e52638SMatthew G. Knepley DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel 5482e5e52638SMatthew G. Knepley 5483e5e52638SMatthew G. Knepley Not collective 5484e5e52638SMatthew G. Knepley 5485e5e52638SMatthew G. Knepley Input Parameters: 5486e5e52638SMatthew G. Knepley + dm - The DM 5487e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh 5488e5e52638SMatthew G. Knepley 5489b3cf3223SMatthew G. Knepley Output Parameters: 5490b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5491b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL 5492e5e52638SMatthew G. Knepley 5493154ca461SJed Brown Note: 5494154ca461SJed Brown If a non-NULL label is given, but there is no PetscDS on that specific label, 5495154ca461SJed Brown the PetscDS for the full domain (if present) is returned. Returns with 5496154ca461SJed Brown fields=NULL and prob=NULL if there is no PetscDS for the full domain. 5497e5e52638SMatthew G. Knepley 5498e5e52638SMatthew G. Knepley Level: advanced 5499e5e52638SMatthew G. Knepley 5500e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5501e5e52638SMatthew G. Knepley @*/ 5502b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds) 5503e5e52638SMatthew G. Knepley { 5504e5e52638SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5505e5e52638SMatthew G. Knepley 5506e5e52638SMatthew G. Knepley PetscFunctionBegin; 5507e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5508e5e52638SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5509b3cf3223SMatthew G. Knepley if (fields) {PetscValidPointer(fields, 3); *fields = NULL;} 5510b3cf3223SMatthew G. Knepley if (ds) {PetscValidPointer(ds, 4); *ds = NULL;} 5511e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5512154ca461SJed Brown if (dm->probs[s].label == label || !dm->probs[s].label) { 5513b3cf3223SMatthew G. Knepley if (fields) *fields = dm->probs[s].fields; 5514b3cf3223SMatthew G. Knepley if (ds) *ds = dm->probs[s].ds; 5515154ca461SJed Brown if (dm->probs[s].label) PetscFunctionReturn(0); 5516b3cf3223SMatthew G. Knepley } 5517e5e52638SMatthew G. Knepley } 55182df9ee95SMatthew G. Knepley PetscFunctionReturn(0); 5519e5e52638SMatthew G. Knepley } 5520e5e52638SMatthew G. Knepley 5521e5e52638SMatthew G. Knepley /*@ 5522083401c6SMatthew G. Knepley DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel 5523083401c6SMatthew G. Knepley 5524083401c6SMatthew G. Knepley Collective on dm 5525083401c6SMatthew G. Knepley 5526083401c6SMatthew G. Knepley Input Parameters: 5527083401c6SMatthew G. Knepley + dm - The DM 5528083401c6SMatthew G. Knepley . label - The DMLabel defining the mesh region, or NULL for the entire mesh 5529083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields 5530083401c6SMatthew G. Knepley - prob - The PetscDS defined on the given cell 5531083401c6SMatthew G. Knepley 5532083401c6SMatthew 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, 5533083401c6SMatthew G. Knepley the fields argument is ignored. 5534083401c6SMatthew G. Knepley 5535083401c6SMatthew G. Knepley Level: advanced 5536083401c6SMatthew G. Knepley 5537083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS() 5538083401c6SMatthew G. Knepley @*/ 5539083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds) 5540083401c6SMatthew G. Knepley { 5541083401c6SMatthew G. Knepley PetscInt Nds = dm->Nds, s; 5542083401c6SMatthew G. Knepley PetscErrorCode ierr; 5543083401c6SMatthew G. Knepley 5544083401c6SMatthew G. Knepley PetscFunctionBegin; 5545083401c6SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5546083401c6SMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 5547064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4); 5548083401c6SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 5549083401c6SMatthew G. Knepley if (dm->probs[s].label == label) { 5550083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr); 5551083401c6SMatthew G. Knepley dm->probs[s].ds = ds; 5552083401c6SMatthew G. Knepley PetscFunctionReturn(0); 5553083401c6SMatthew G. Knepley } 5554083401c6SMatthew G. Knepley } 5555083401c6SMatthew G. Knepley ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr); 5556083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5557083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5558083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5559083401c6SMatthew G. Knepley if (!label) { 5560083401c6SMatthew G. Knepley /* Put the NULL label at the front, so it is returned as the default */ 5561083401c6SMatthew G. Knepley for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s]; 5562083401c6SMatthew G. Knepley Nds = 0; 5563083401c6SMatthew G. Knepley } 5564083401c6SMatthew G. Knepley dm->probs[Nds].label = label; 5565083401c6SMatthew G. Knepley dm->probs[Nds].fields = fields; 5566083401c6SMatthew G. Knepley dm->probs[Nds].ds = ds; 5567083401c6SMatthew G. Knepley PetscFunctionReturn(0); 5568083401c6SMatthew G. Knepley } 5569083401c6SMatthew G. Knepley 5570083401c6SMatthew G. Knepley /*@ 5571e5e52638SMatthew G. Knepley DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number 5572e5e52638SMatthew G. Knepley 5573e5e52638SMatthew G. Knepley Not collective 5574e5e52638SMatthew G. Knepley 5575e5e52638SMatthew G. Knepley Input Parameters: 5576e5e52638SMatthew G. Knepley + dm - The DM 5577e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds) 5578e5e52638SMatthew G. Knepley 5579e5e52638SMatthew G. Knepley Output Parameters: 5580b3cf3223SMatthew G. Knepley + label - The region label, or NULL 5581b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL 5582083401c6SMatthew G. Knepley - ds - The PetscDS defined on the given region, or NULL 5583e5e52638SMatthew G. Knepley 5584e5e52638SMatthew G. Knepley Level: advanced 5585e5e52638SMatthew G. Knepley 5586e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5587e5e52638SMatthew G. Knepley @*/ 5588b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds) 5589e5e52638SMatthew G. Knepley { 5590e5e52638SMatthew G. Knepley PetscInt Nds; 5591e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5592e5e52638SMatthew G. Knepley 5593e5e52638SMatthew G. Knepley PetscFunctionBegin; 5594e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5595e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 55962c71b3e2SJacob Faibussowitsch PetscCheckFalse((num < 0) || (num >= Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5597e5e52638SMatthew G. Knepley if (label) { 5598e5e52638SMatthew G. Knepley PetscValidPointer(label, 3); 5599e5e52638SMatthew G. Knepley *label = dm->probs[num].label; 5600e5e52638SMatthew G. Knepley } 5601b3cf3223SMatthew G. Knepley if (fields) { 5602b3cf3223SMatthew G. Knepley PetscValidPointer(fields, 4); 5603b3cf3223SMatthew G. Knepley *fields = dm->probs[num].fields; 5604b3cf3223SMatthew G. Knepley } 5605e5e52638SMatthew G. Knepley if (ds) { 5606b3cf3223SMatthew G. Knepley PetscValidPointer(ds, 5); 5607e5e52638SMatthew G. Knepley *ds = dm->probs[num].ds; 5608e5e52638SMatthew G. Knepley } 5609e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5610e5e52638SMatthew G. Knepley } 5611e5e52638SMatthew G. Knepley 5612e5e52638SMatthew G. Knepley /*@ 5613083401c6SMatthew G. Knepley DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number 5614e5e52638SMatthew G. Knepley 5615083401c6SMatthew G. Knepley Not collective 5616e5e52638SMatthew G. Knepley 5617e5e52638SMatthew G. Knepley Input Parameters: 5618e5e52638SMatthew G. Knepley + dm - The DM 5619083401c6SMatthew G. Knepley . num - The region number, in [0, Nds) 5620083401c6SMatthew G. Knepley . label - The region label, or NULL 5621083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting 5622083401c6SMatthew G. Knepley - ds - The PetscDS defined on the given region, or NULL to prevent setting 5623e5e52638SMatthew G. Knepley 5624e5e52638SMatthew G. Knepley Level: advanced 5625e5e52638SMatthew G. Knepley 5626083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 5627e5e52638SMatthew G. Knepley @*/ 5628083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds) 5629e5e52638SMatthew G. Knepley { 5630083401c6SMatthew G. Knepley PetscInt Nds; 5631e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5632e5e52638SMatthew G. Knepley 5633e5e52638SMatthew G. Knepley PetscFunctionBegin; 5634e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5635083401c6SMatthew G. Knepley if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);} 5636083401c6SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 56372c71b3e2SJacob Faibussowitsch PetscCheckFalse((num < 0) || (num >= Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds); 5638e5e52638SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 5639083401c6SMatthew G. Knepley ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr); 5640083401c6SMatthew G. Knepley dm->probs[num].label = label; 5641083401c6SMatthew G. Knepley if (fields) { 5642083401c6SMatthew G. Knepley PetscValidHeaderSpecific(fields, IS_CLASSID, 4); 5643b3cf3223SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr); 5644083401c6SMatthew G. Knepley ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr); 5645083401c6SMatthew G. Knepley dm->probs[num].fields = fields; 5646e5e52638SMatthew G. Knepley } 5647083401c6SMatthew G. Knepley if (ds) { 5648083401c6SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5); 5649083401c6SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr); 5650083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr); 5651083401c6SMatthew G. Knepley dm->probs[num].ds = ds; 5652083401c6SMatthew G. Knepley } 5653e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5654e5e52638SMatthew G. Knepley } 5655e5e52638SMatthew G. Knepley 5656e5e52638SMatthew G. Knepley /*@ 56571d3af9e0SMatthew G. Knepley DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found. 56581d3af9e0SMatthew G. Knepley 56591d3af9e0SMatthew G. Knepley Not collective 56601d3af9e0SMatthew G. Knepley 56611d3af9e0SMatthew G. Knepley Input Parameters: 56621d3af9e0SMatthew G. Knepley + dm - The DM 56631d3af9e0SMatthew G. Knepley - ds - The PetscDS defined on the given region 56641d3af9e0SMatthew G. Knepley 56651d3af9e0SMatthew G. Knepley Output Parameter: 56661d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found 56671d3af9e0SMatthew G. Knepley 56681d3af9e0SMatthew G. Knepley Level: advanced 56691d3af9e0SMatthew G. Knepley 56701d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS() 56711d3af9e0SMatthew G. Knepley @*/ 56721d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num) 56731d3af9e0SMatthew G. Knepley { 56741d3af9e0SMatthew G. Knepley PetscInt Nds, n; 56751d3af9e0SMatthew G. Knepley PetscErrorCode ierr; 56761d3af9e0SMatthew G. Knepley 56771d3af9e0SMatthew G. Knepley PetscFunctionBegin; 56781d3af9e0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 56791d3af9e0SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2); 56801d3af9e0SMatthew G. Knepley PetscValidPointer(num, 3); 56811d3af9e0SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 56821d3af9e0SMatthew G. Knepley for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break; 56831d3af9e0SMatthew G. Knepley if (n >= Nds) *num = -1; 56841d3af9e0SMatthew G. Knepley else *num = n; 56851d3af9e0SMatthew G. Knepley PetscFunctionReturn(0); 56861d3af9e0SMatthew G. Knepley } 56871d3af9e0SMatthew G. Knepley 56882df84da0SMatthew G. Knepley /*@C 56892df84da0SMatthew G. Knepley DMCreateFEDefault - Create a PetscFE based on the celltype for the mesh 56902df84da0SMatthew G. Knepley 56912df84da0SMatthew G. Knepley Not collective 56922df84da0SMatthew G. Knepley 5693f1a722f8SMatthew G. Knepley Input Parameters: 56942df84da0SMatthew G. Knepley + dm - The DM 56952df84da0SMatthew G. Knepley . Nc - The number of components for the field 56962df84da0SMatthew G. Knepley . prefix - The options prefix for the output PetscFE, or NULL 56972df84da0SMatthew G. Knepley - qorder - The quadrature order or PETSC_DETERMINE to use PetscSpace polynomial degree 56982df84da0SMatthew G. Knepley 56992df84da0SMatthew G. Knepley Output Parameter: 57002df84da0SMatthew G. Knepley . fem - The PetscFE 57012df84da0SMatthew G. Knepley 57022df84da0SMatthew G. Knepley Note: This is a convenience method that just calls PetscFECreateByCell() underneath. 57032df84da0SMatthew G. Knepley 57042df84da0SMatthew G. Knepley Level: intermediate 57052df84da0SMatthew G. Knepley 57062df84da0SMatthew G. Knepley .seealso: PetscFECreateByCell(), DMAddField(), DMCreateDS(), DMGetCellDS(), DMGetRegionDS() 57072df84da0SMatthew G. Knepley @*/ 57082df84da0SMatthew G. Knepley PetscErrorCode DMCreateFEDefault(DM dm, PetscInt Nc, const char prefix[], PetscInt qorder, PetscFE *fem) 57092df84da0SMatthew G. Knepley { 57102df84da0SMatthew G. Knepley DMPolytopeType ct; 57112df84da0SMatthew G. Knepley PetscInt dim, cStart; 57122df84da0SMatthew G. Knepley PetscErrorCode ierr; 57132df84da0SMatthew G. Knepley 57142df84da0SMatthew G. Knepley PetscFunctionBegin; 57152df84da0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 57162df84da0SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nc, 2); 57172df84da0SMatthew G. Knepley if (prefix) PetscValidCharPointer(prefix, 3); 57182df84da0SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, qorder, 4); 57192df84da0SMatthew G. Knepley PetscValidPointer(fem, 5); 57202df84da0SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 57212df84da0SMatthew G. Knepley ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr); 57222df84da0SMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 57232df84da0SMatthew G. Knepley ierr = PetscFECreateByCell(PETSC_COMM_SELF, dim, Nc, ct, prefix, qorder, fem);CHKERRQ(ierr); 57242df84da0SMatthew G. Knepley PetscFunctionReturn(0); 57252df84da0SMatthew G. Knepley } 57262df84da0SMatthew G. Knepley 57271d3af9e0SMatthew G. Knepley /*@ 5728e5e52638SMatthew G. Knepley DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM 5729e5e52638SMatthew G. Knepley 5730d083f849SBarry Smith Collective on dm 5731e5e52638SMatthew G. Knepley 5732e5e52638SMatthew G. Knepley Input Parameter: 5733e5e52638SMatthew G. Knepley . dm - The DM 5734e5e52638SMatthew G. Knepley 573545480ffeSMatthew G. Knepley Options Database Keys: 573645480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM 573745480ffeSMatthew G. Knepley 5738e5e52638SMatthew G. Knepley Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. 5739e5e52638SMatthew G. Knepley 5740e5e52638SMatthew G. Knepley Level: intermediate 5741e5e52638SMatthew G. Knepley 5742e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 5743e5e52638SMatthew G. Knepley @*/ 5744e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm) 5745e5e52638SMatthew G. Knepley { 5746e5e52638SMatthew G. Knepley MPI_Comm comm; 5747083401c6SMatthew G. Knepley PetscDS dsDef; 5748083401c6SMatthew G. Knepley DMLabel *labelSet; 5749f9244615SMatthew G. Knepley PetscInt dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k; 5750f9244615SMatthew G. Knepley PetscBool doSetup = PETSC_TRUE, flg; 5751e5e52638SMatthew G. Knepley PetscErrorCode ierr; 5752e5e52638SMatthew G. Knepley 5753e5e52638SMatthew G. Knepley PetscFunctionBegin; 5754e5e52638SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5755e5e52638SMatthew G. Knepley if (!dm->fields) PetscFunctionReturn(0); 5756e5e52638SMatthew G. Knepley ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr); 5757083401c6SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr); 5758083401c6SMatthew G. Knepley /* Determine how many regions we have */ 5759083401c6SMatthew G. Knepley ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr); 5760083401c6SMatthew G. Knepley Nl = 0; 5761083401c6SMatthew G. Knepley Ndef = 0; 5762083401c6SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 5763083401c6SMatthew G. Knepley DMLabel label = dm->fields[f].label; 5764083401c6SMatthew G. Knepley PetscInt l; 5765083401c6SMatthew G. Knepley 5766f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED 5767f918ec44SMatthew G. Knepley /* Move CEED context to discretizations */ 5768f918ec44SMatthew G. Knepley { 5769f918ec44SMatthew G. Knepley PetscClassId id; 5770f918ec44SMatthew G. Knepley 5771f918ec44SMatthew G. Knepley ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr); 5772f918ec44SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 5773f918ec44SMatthew G. Knepley Ceed ceed; 5774f918ec44SMatthew G. Knepley 5775f918ec44SMatthew G. Knepley ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr); 5776f918ec44SMatthew G. Knepley ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr); 5777f918ec44SMatthew G. Knepley } 5778f918ec44SMatthew G. Knepley } 5779f918ec44SMatthew G. Knepley #endif 5780083401c6SMatthew G. Knepley if (!label) {++Ndef; continue;} 5781083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break; 5782083401c6SMatthew G. Knepley if (l < Nl) continue; 5783083401c6SMatthew G. Knepley labelSet[Nl++] = label; 5784083401c6SMatthew G. Knepley } 5785083401c6SMatthew G. Knepley /* Create default DS if there are no labels to intersect with */ 5786083401c6SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr); 5787083401c6SMatthew G. Knepley if (!dsDef && Ndef && !Nl) { 5788b3cf3223SMatthew G. Knepley IS fields; 5789b3cf3223SMatthew G. Knepley PetscInt *fld, nf; 5790b3cf3223SMatthew G. Knepley 5791b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf; 57922c71b3e2SJacob Faibussowitsch PetscCheckFalse(!nf,comm, PETSC_ERR_PLIB, "All fields have labels, but we are trying to create a default DS"); 5793b3cf3223SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5794b3cf3223SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f; 579588f0c812SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 579688f0c812SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 579788f0c812SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 579888f0c812SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 579988f0c812SMatthew G. Knepley 580045480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr); 5801083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr); 5802083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr); 5803b3cf3223SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 58042df9ee95SMatthew G. Knepley } 5805083401c6SMatthew G. Knepley ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr); 5806083401c6SMatthew G. Knepley if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);} 5807083401c6SMatthew G. Knepley /* Intersect labels with default fields */ 5808083401c6SMatthew G. Knepley if (Ndef && Nl) { 58090122748bSMatthew G. Knepley DM plex; 5810083401c6SMatthew G. Knepley DMLabel cellLabel; 5811083401c6SMatthew G. Knepley IS fieldIS, allcellIS, defcellIS = NULL; 5812083401c6SMatthew G. Knepley PetscInt *fields; 5813083401c6SMatthew G. Knepley const PetscInt *cells; 5814083401c6SMatthew G. Knepley PetscInt depth, nf = 0, n, c; 58150122748bSMatthew G. Knepley 58160122748bSMatthew G. Knepley ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr); 58170122748bSMatthew G. Knepley ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr); 5818083401c6SMatthew G. Knepley ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr); 5819083401c6SMatthew G. Knepley if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);} 58205fedec97SMatthew G. Knepley /* TODO This looks like it only works for one label */ 5821083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) { 5822083401c6SMatthew G. Knepley DMLabel label = labelSet[l]; 5823083401c6SMatthew G. Knepley IS pointIS; 5824083401c6SMatthew G. Knepley 5825083401c6SMatthew G. Knepley ierr = ISDestroy(&defcellIS);CHKERRQ(ierr); 5826083401c6SMatthew G. Knepley ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr); 5827083401c6SMatthew G. Knepley ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr); 5828083401c6SMatthew G. Knepley ierr = ISDestroy(&pointIS);CHKERRQ(ierr); 5829083401c6SMatthew G. Knepley } 5830083401c6SMatthew G. Knepley ierr = ISDestroy(&allcellIS);CHKERRQ(ierr); 5831083401c6SMatthew G. Knepley 5832083401c6SMatthew G. Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr); 5833083401c6SMatthew G. Knepley ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr); 5834083401c6SMatthew G. Knepley ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr); 5835083401c6SMatthew G. Knepley for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);} 5836083401c6SMatthew G. Knepley ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr); 5837083401c6SMatthew G. Knepley ierr = ISDestroy(&defcellIS);CHKERRQ(ierr); 5838083401c6SMatthew G. Knepley ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr); 5839083401c6SMatthew G. Knepley 5840083401c6SMatthew G. Knepley ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr); 5841083401c6SMatthew G. Knepley for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f; 5842083401c6SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr); 5843083401c6SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr); 5844083401c6SMatthew G. Knepley ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr); 5845083401c6SMatthew G. Knepley ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr); 5846083401c6SMatthew G. Knepley 584745480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr); 5848083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr); 5849083401c6SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr); 58505fedec97SMatthew G. Knepley ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr); 5851083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr); 5852083401c6SMatthew G. Knepley ierr = ISDestroy(&fieldIS);CHKERRQ(ierr); 58530122748bSMatthew G. Knepley ierr = DMDestroy(&plex);CHKERRQ(ierr); 5854083401c6SMatthew G. Knepley } 5855083401c6SMatthew G. Knepley /* Create label DSes 5856083401c6SMatthew G. Knepley - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS 5857083401c6SMatthew G. Knepley */ 5858083401c6SMatthew G. Knepley /* TODO Should check that labels are disjoint */ 5859083401c6SMatthew G. Knepley for (l = 0; l < Nl; ++l) { 5860083401c6SMatthew G. Knepley DMLabel label = labelSet[l]; 5861083401c6SMatthew G. Knepley PetscDS ds; 5862083401c6SMatthew G. Knepley IS fields; 5863083401c6SMatthew G. Knepley PetscInt *fld, nf; 5864083401c6SMatthew G. Knepley 586545480ffeSMatthew G. Knepley ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr); 5866083401c6SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf; 5867083401c6SMatthew G. Knepley ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr); 5868083401c6SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f; 5869083401c6SMatthew G. Knepley ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr); 5870083401c6SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr); 5871083401c6SMatthew G. Knepley ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr); 5872083401c6SMatthew G. Knepley ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr); 5873083401c6SMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr); 5874083401c6SMatthew G. Knepley ierr = ISDestroy(&fields);CHKERRQ(ierr); 5875083401c6SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr); 5876083401c6SMatthew G. Knepley { 5877083401c6SMatthew G. Knepley DMPolytopeType ct; 5878083401c6SMatthew G. Knepley PetscInt lStart, lEnd; 58795fedec97SMatthew G. Knepley PetscBool isCohesiveLocal = PETSC_FALSE, isCohesive; 58800122748bSMatthew G. Knepley 5881e5e52638SMatthew G. Knepley ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr); 5882665f567fSMatthew G. Knepley if (lStart >= 0) { 5883412e9a14SMatthew G. Knepley ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr); 5884412e9a14SMatthew G. Knepley switch (ct) { 5885412e9a14SMatthew G. Knepley case DM_POLYTOPE_POINT_PRISM_TENSOR: 5886412e9a14SMatthew G. Knepley case DM_POLYTOPE_SEG_PRISM_TENSOR: 5887412e9a14SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM_TENSOR: 5888412e9a14SMatthew G. Knepley case DM_POLYTOPE_QUAD_PRISM_TENSOR: 58895fedec97SMatthew G. Knepley isCohesiveLocal = PETSC_TRUE;break; 5890083401c6SMatthew G. Knepley default: break; 5891412e9a14SMatthew G. Knepley } 5892665f567fSMatthew G. Knepley } 58935fedec97SMatthew G. Knepley ierr = MPI_Allreduce(&isCohesiveLocal, &isCohesive, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr); 58945fedec97SMatthew G. Knepley for (f = 0, nf = 0; f < Nf; ++f) { 58955fedec97SMatthew G. Knepley if (label == dm->fields[f].label || !dm->fields[f].label) { 58965fedec97SMatthew G. Knepley if (label == dm->fields[f].label) { 58975fedec97SMatthew G. Knepley ierr = PetscDSSetDiscretization(ds, nf, NULL);CHKERRQ(ierr); 58985fedec97SMatthew G. Knepley ierr = PetscDSSetCohesive(ds, nf, isCohesive);CHKERRQ(ierr); 58995fedec97SMatthew G. Knepley } 59005fedec97SMatthew G. Knepley ++nf; 59015fedec97SMatthew G. Knepley } 59025fedec97SMatthew G. Knepley } 5903e5e52638SMatthew G. Knepley } 5904083401c6SMatthew G. Knepley ierr = PetscDSDestroy(&ds);CHKERRQ(ierr); 5905e5e52638SMatthew G. Knepley } 5906083401c6SMatthew G. Knepley ierr = PetscFree(labelSet);CHKERRQ(ierr); 5907e5e52638SMatthew G. Knepley /* Set fields in DSes */ 5908083401c6SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 5909083401c6SMatthew G. Knepley PetscDS ds = dm->probs[s].ds; 5910083401c6SMatthew G. Knepley IS fields = dm->probs[s].fields; 5911083401c6SMatthew G. Knepley const PetscInt *fld; 59125fedec97SMatthew G. Knepley PetscInt nf, dsnf; 59135fedec97SMatthew G. Knepley PetscBool isCohesive; 5914e5e52638SMatthew G. Knepley 59155fedec97SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsnf);CHKERRQ(ierr); 59165fedec97SMatthew G. Knepley ierr = PetscDSIsCohesive(ds, &isCohesive);CHKERRQ(ierr); 5917083401c6SMatthew G. Knepley ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr); 5918083401c6SMatthew G. Knepley ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr); 5919083401c6SMatthew G. Knepley for (f = 0; f < nf; ++f) { 5920083401c6SMatthew G. Knepley PetscObject disc = dm->fields[fld[f]].disc; 59215fedec97SMatthew G. Knepley PetscBool isCohesiveField; 5922e5e52638SMatthew G. Knepley PetscClassId id; 5923e5e52638SMatthew G. Knepley 59245fedec97SMatthew G. Knepley /* Handle DS with no fields */ 59255fedec97SMatthew G. Knepley if (dsnf) {ierr = PetscDSGetCohesive(ds, f, &isCohesiveField);CHKERRQ(ierr);} 59265fedec97SMatthew G. Knepley /* If this is a cohesive cell, then regular fields need the lower dimensional discretization */ 59275fedec97SMatthew G. Knepley if (isCohesive && !isCohesiveField) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);} 5928083401c6SMatthew G. Knepley ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr); 5929083401c6SMatthew G. Knepley /* We allow people to have placeholder fields and construct the Section by hand */ 5930e5e52638SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 5931e5e52638SMatthew G. Knepley if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE; 5932e5e52638SMatthew G. Knepley } 5933083401c6SMatthew G. Knepley ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr); 5934e5e52638SMatthew G. Knepley } 5935f9244615SMatthew G. Knepley /* Allow k-jet tabulation */ 5936f9244615SMatthew G. Knepley ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr); 5937f9244615SMatthew G. Knepley if (flg) { 59383b4aee56SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) { 59393b4aee56SMatthew G. Knepley PetscDS ds = dm->probs[s].ds; 59403b4aee56SMatthew G. Knepley PetscInt Nf, f; 59413b4aee56SMatthew G. Knepley 59423b4aee56SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr); 59433b4aee56SMatthew G. Knepley for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);} 59443b4aee56SMatthew G. Knepley } 5945f9244615SMatthew G. Knepley } 5946e5e52638SMatthew G. Knepley /* Setup DSes */ 5947e5e52638SMatthew G. Knepley if (doSetup) { 5948e5e52638SMatthew G. Knepley for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);} 5949e5e52638SMatthew G. Knepley } 5950e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 5951e5e52638SMatthew G. Knepley } 5952e5e52638SMatthew G. Knepley 5953e5e52638SMatthew G. Knepley /*@ 59547f96f943SMatthew G. Knepley DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information. 59557f96f943SMatthew G. Knepley 5956f2cacb80SMatthew G. Knepley Collective on DM 5957f2cacb80SMatthew G. Knepley 59587f96f943SMatthew G. Knepley Input Parameters: 59597f96f943SMatthew G. Knepley + dm - The DM 59607f96f943SMatthew G. Knepley - time - The time 59617f96f943SMatthew G. Knepley 59627f96f943SMatthew G. Knepley Output Parameters: 5963f2cacb80SMatthew G. Knepley + u - The vector will be filled with exact solution values, or NULL 5964f2cacb80SMatthew G. Knepley - u_t - The vector will be filled with the time derivative of exact solution values, or NULL 59657f96f943SMatthew G. Knepley 59667f96f943SMatthew G. Knepley Note: The user must call PetscDSSetExactSolution() beforehand 59677f96f943SMatthew G. Knepley 59687f96f943SMatthew G. Knepley Level: developer 59697f96f943SMatthew G. Knepley 59707f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution() 59717f96f943SMatthew G. Knepley @*/ 5972f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t) 59737f96f943SMatthew G. Knepley { 59747f96f943SMatthew G. Knepley PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx); 59757f96f943SMatthew G. Knepley void **ectxs; 59767f96f943SMatthew G. Knepley PetscInt Nf, Nds, s; 59777f96f943SMatthew G. Knepley PetscErrorCode ierr; 59787f96f943SMatthew G. Knepley 59797f96f943SMatthew G. Knepley PetscFunctionBegin; 5980f2cacb80SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 5981f2cacb80SMatthew G. Knepley if (u) PetscValidHeaderSpecific(u, VEC_CLASSID, 3); 5982f2cacb80SMatthew G. Knepley if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4); 59837f96f943SMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 59847f96f943SMatthew G. Knepley ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr); 59857f96f943SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 59867f96f943SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 59877f96f943SMatthew G. Knepley PetscDS ds; 59887f96f943SMatthew G. Knepley DMLabel label; 59897f96f943SMatthew G. Knepley IS fieldIS; 59907f96f943SMatthew G. Knepley const PetscInt *fields, id = 1; 59917f96f943SMatthew G. Knepley PetscInt dsNf, f; 59927f96f943SMatthew G. Knepley 59937f96f943SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr); 59947f96f943SMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr); 59957f96f943SMatthew G. Knepley ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr); 59967f96f943SMatthew G. Knepley ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr); 59977f96f943SMatthew G. Knepley ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr); 5998f2cacb80SMatthew G. Knepley if (u) { 59997f96f943SMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 60007f96f943SMatthew G. Knepley const PetscInt field = fields[f]; 60017f96f943SMatthew G. Knepley ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr); 60027f96f943SMatthew G. Knepley } 60037f96f943SMatthew G. Knepley ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr); 60047f96f943SMatthew G. Knepley if (label) { 60057f96f943SMatthew G. Knepley ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr); 60067f96f943SMatthew G. Knepley } else { 60077f96f943SMatthew G. Knepley ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr); 60087f96f943SMatthew G. Knepley } 60097f96f943SMatthew G. Knepley } 6010f2cacb80SMatthew G. Knepley if (u_t) { 6011f2cacb80SMatthew G. Knepley ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr); 6012f2cacb80SMatthew G. Knepley ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr); 6013f2cacb80SMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 6014f2cacb80SMatthew G. Knepley const PetscInt field = fields[f]; 6015f2cacb80SMatthew G. Knepley ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr); 6016f2cacb80SMatthew G. Knepley } 6017f2cacb80SMatthew G. Knepley ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr); 6018f2cacb80SMatthew G. Knepley if (label) { 6019f2cacb80SMatthew G. Knepley ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr); 6020f2cacb80SMatthew G. Knepley } else { 6021f2cacb80SMatthew G. Knepley ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr); 6022f2cacb80SMatthew G. Knepley } 6023f2cacb80SMatthew G. Knepley } 6024f2cacb80SMatthew G. Knepley } 6025f2cacb80SMatthew G. Knepley if (u) { 60267f96f943SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr); 60277f96f943SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr); 6028f2cacb80SMatthew G. Knepley } 6029f2cacb80SMatthew G. Knepley if (u_t) { 6030f2cacb80SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr); 6031f2cacb80SMatthew G. Knepley ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr); 6032f2cacb80SMatthew G. Knepley } 60337f96f943SMatthew G. Knepley ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr); 60347f96f943SMatthew G. Knepley PetscFunctionReturn(0); 60357f96f943SMatthew G. Knepley } 60367f96f943SMatthew G. Knepley 603745480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds) 603845480ffeSMatthew G. Knepley { 603945480ffeSMatthew G. Knepley PetscDS dsNew; 604045480ffeSMatthew G. Knepley DSBoundary b; 604145480ffeSMatthew G. Knepley PetscInt cdim, Nf, f; 60425fedec97SMatthew G. Knepley PetscBool isCohesive; 604345480ffeSMatthew G. Knepley void *ctx; 604445480ffeSMatthew G. Knepley PetscErrorCode ierr; 604545480ffeSMatthew G. Knepley 604645480ffeSMatthew G. Knepley PetscFunctionBegin; 604745480ffeSMatthew G. Knepley ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr); 604845480ffeSMatthew G. Knepley ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr); 604945480ffeSMatthew G. Knepley ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr); 605045480ffeSMatthew G. Knepley ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr); 605145480ffeSMatthew G. Knepley ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr); 605245480ffeSMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr); 605345480ffeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 605445480ffeSMatthew G. Knepley ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr); 605545480ffeSMatthew G. Knepley ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr); 60565fedec97SMatthew G. Knepley ierr = PetscDSGetCohesive(ds, f, &isCohesive);CHKERRQ(ierr); 60575fedec97SMatthew G. Knepley ierr = PetscDSSetCohesive(dsNew, f, isCohesive);CHKERRQ(ierr); 605845480ffeSMatthew G. Knepley } 605945480ffeSMatthew G. Knepley if (Nf) { 606045480ffeSMatthew G. Knepley ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr); 606145480ffeSMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr); 606245480ffeSMatthew G. Knepley } 606345480ffeSMatthew G. Knepley ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr); 606445480ffeSMatthew G. Knepley for (b = dsNew->boundary; b; b = b->next) { 606545480ffeSMatthew G. Knepley ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr); 606645480ffeSMatthew G. Knepley /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */ 60672c71b3e2SJacob Faibussowitsch //PetscCheckFalse(!b->label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name); 606845480ffeSMatthew G. Knepley } 606945480ffeSMatthew G. Knepley 607045480ffeSMatthew G. Knepley ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr); 607145480ffeSMatthew G. Knepley ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr); 607245480ffeSMatthew G. Knepley PetscFunctionReturn(0); 607345480ffeSMatthew G. Knepley } 607445480ffeSMatthew G. Knepley 60757f96f943SMatthew G. Knepley /*@ 6076e5e52638SMatthew G. Knepley DMCopyDS - Copy the discrete systems for the DM into another DM 6077e5e52638SMatthew G. Knepley 6078d083f849SBarry Smith Collective on dm 6079e5e52638SMatthew G. Knepley 6080e5e52638SMatthew G. Knepley Input Parameter: 6081e5e52638SMatthew G. Knepley . dm - The DM 6082e5e52638SMatthew G. Knepley 6083e5e52638SMatthew G. Knepley Output Parameter: 6084e5e52638SMatthew G. Knepley . newdm - The DM 6085e5e52638SMatthew G. Knepley 6086e5e52638SMatthew G. Knepley Level: advanced 6087e5e52638SMatthew G. Knepley 6088e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS() 6089e5e52638SMatthew G. Knepley @*/ 6090e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm) 6091e5e52638SMatthew G. Knepley { 6092e5e52638SMatthew G. Knepley PetscInt Nds, s; 6093e5e52638SMatthew G. Knepley PetscErrorCode ierr; 6094e5e52638SMatthew G. Knepley 6095e5e52638SMatthew G. Knepley PetscFunctionBegin; 6096e5e52638SMatthew G. Knepley if (dm == newdm) PetscFunctionReturn(0); 6097e5e52638SMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 6098e5e52638SMatthew G. Knepley ierr = DMClearDS(newdm);CHKERRQ(ierr); 6099e5e52638SMatthew G. Knepley for (s = 0; s < Nds; ++s) { 6100e5e52638SMatthew G. Knepley DMLabel label; 6101b3cf3223SMatthew G. Knepley IS fields; 610245480ffeSMatthew G. Knepley PetscDS ds, newds; 6103783e2ec8SMatthew G. Knepley PetscInt Nbd, bd; 6104e5e52638SMatthew G. Knepley 6105b3cf3223SMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr); 6106b8025e53SMatthew G. Knepley /* TODO: We need to change all keys from labels in the old DM to labels in the new DM */ 610745480ffeSMatthew G. Knepley ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr); 610845480ffeSMatthew G. Knepley /* Commplete new labels in the new DS */ 610945480ffeSMatthew G. Knepley ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr); 611045480ffeSMatthew G. Knepley ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr); 6111783e2ec8SMatthew G. Knepley for (bd = 0; bd < Nbd; ++bd) { 6112b8025e53SMatthew G. Knepley PetscWeakForm wf; 611345480ffeSMatthew G. Knepley DMLabel label; 6114783e2ec8SMatthew G. Knepley PetscInt field; 6115783e2ec8SMatthew G. Knepley 6116b8025e53SMatthew G. Knepley ierr = PetscDSGetBoundary(newds, bd, &wf, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 611745480ffeSMatthew G. Knepley ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr); 6118b8025e53SMatthew G. Knepley ierr = PetscWeakFormReplaceLabel(wf, label);CHKERRQ(ierr); 6119783e2ec8SMatthew G. Knepley } 6120e5e52638SMatthew G. Knepley } 6121e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 6122e5e52638SMatthew G. Knepley } 6123e5e52638SMatthew G. Knepley 6124e5e52638SMatthew G. Knepley /*@ 6125e5e52638SMatthew G. Knepley DMCopyDisc - Copy the fields and discrete systems for the DM into another DM 6126e5e52638SMatthew G. Knepley 6127d083f849SBarry Smith Collective on dm 6128e5e52638SMatthew G. Knepley 6129e5e52638SMatthew G. Knepley Input Parameter: 6130e5e52638SMatthew G. Knepley . dm - The DM 6131e5e52638SMatthew G. Knepley 6132e5e52638SMatthew G. Knepley Output Parameter: 6133e5e52638SMatthew G. Knepley . newdm - The DM 6134e5e52638SMatthew G. Knepley 6135e5e52638SMatthew G. Knepley Level: advanced 6136e5e52638SMatthew G. Knepley 6137e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS() 6138e5e52638SMatthew G. Knepley @*/ 6139e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm) 6140e5e52638SMatthew G. Knepley { 6141e5e52638SMatthew G. Knepley PetscErrorCode ierr; 6142e5e52638SMatthew G. Knepley 6143e5e52638SMatthew G. Knepley PetscFunctionBegin; 6144e5e52638SMatthew G. Knepley ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr); 6145e5e52638SMatthew G. Knepley ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr); 6146e5e52638SMatthew G. Knepley PetscFunctionReturn(0); 6147e5e52638SMatthew G. Knepley } 6148e5e52638SMatthew G. Knepley 6149b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx) 6150b64e0483SPeter Brune { 6151b64e0483SPeter Brune DM dm_coord,dmc_coord; 6152b64e0483SPeter Brune PetscErrorCode ierr; 6153b64e0483SPeter Brune Vec coords,ccoords; 61546dbf9973SLawrence Mitchell Mat inject; 6155b64e0483SPeter Brune PetscFunctionBegin; 6156b64e0483SPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 6157b64e0483SPeter Brune ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr); 6158b64e0483SPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 6159b64e0483SPeter Brune ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr); 6160b64e0483SPeter Brune if (coords && !ccoords) { 6161b64e0483SPeter Brune ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr); 61626668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 61636dbf9973SLawrence Mitchell ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr); 61642adcf181SLawrence Mitchell ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr); 61656dbf9973SLawrence Mitchell ierr = MatDestroy(&inject);CHKERRQ(ierr); 6166b64e0483SPeter Brune ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr); 6167b64e0483SPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 6168b64e0483SPeter Brune } 6169b64e0483SPeter Brune PetscFunctionReturn(0); 6170b64e0483SPeter Brune } 6171b64e0483SPeter Brune 617203dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx) 617303dadc2fSPeter Brune { 617403dadc2fSPeter Brune DM dm_coord,subdm_coord; 617503dadc2fSPeter Brune PetscErrorCode ierr; 617603dadc2fSPeter Brune Vec coords,ccoords,clcoords; 617703dadc2fSPeter Brune VecScatter *scat_i,*scat_g; 617803dadc2fSPeter Brune PetscFunctionBegin; 617903dadc2fSPeter Brune ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr); 618003dadc2fSPeter Brune ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr); 618103dadc2fSPeter Brune ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr); 618203dadc2fSPeter Brune ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr); 618303dadc2fSPeter Brune if (coords && !ccoords) { 618403dadc2fSPeter Brune ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr); 61856668ed41SLisandro Dalcin ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr); 618603dadc2fSPeter Brune ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr); 618724640c55SToby Isaac ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr); 618803dadc2fSPeter Brune ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr); 618903dadc2fSPeter Brune ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 619003dadc2fSPeter Brune ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 61911ed9ada7SJunchao Zhang ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 619203dadc2fSPeter Brune ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 619303dadc2fSPeter Brune ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr); 619403dadc2fSPeter Brune ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr); 619503dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr); 619603dadc2fSPeter Brune ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr); 619703dadc2fSPeter Brune ierr = VecDestroy(&ccoords);CHKERRQ(ierr); 619803dadc2fSPeter Brune ierr = VecDestroy(&clcoords);CHKERRQ(ierr); 619903dadc2fSPeter Brune ierr = PetscFree(scat_i);CHKERRQ(ierr); 620003dadc2fSPeter Brune ierr = PetscFree(scat_g);CHKERRQ(ierr); 620103dadc2fSPeter Brune } 620203dadc2fSPeter Brune PetscFunctionReturn(0); 620303dadc2fSPeter Brune } 620403dadc2fSPeter Brune 6205c73cfb54SMatthew G. Knepley /*@ 6206c73cfb54SMatthew G. Knepley DMGetDimension - Return the topological dimension of the DM 6207c73cfb54SMatthew G. Knepley 6208c73cfb54SMatthew G. Knepley Not collective 6209c73cfb54SMatthew G. Knepley 6210c73cfb54SMatthew G. Knepley Input Parameter: 6211c73cfb54SMatthew G. Knepley . dm - The DM 6212c73cfb54SMatthew G. Knepley 6213c73cfb54SMatthew G. Knepley Output Parameter: 6214c73cfb54SMatthew G. Knepley . dim - The topological dimension 6215c73cfb54SMatthew G. Knepley 6216c73cfb54SMatthew G. Knepley Level: beginner 6217c73cfb54SMatthew G. Knepley 6218c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate() 6219c73cfb54SMatthew G. Knepley @*/ 6220c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim) 6221c73cfb54SMatthew G. Knepley { 6222c73cfb54SMatthew G. Knepley PetscFunctionBegin; 6223c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6224534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 6225c73cfb54SMatthew G. Knepley *dim = dm->dim; 6226c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 6227c73cfb54SMatthew G. Knepley } 6228c73cfb54SMatthew G. Knepley 6229c73cfb54SMatthew G. Knepley /*@ 6230c73cfb54SMatthew G. Knepley DMSetDimension - Set the topological dimension of the DM 6231c73cfb54SMatthew G. Knepley 6232c73cfb54SMatthew G. Knepley Collective on dm 6233c73cfb54SMatthew G. Knepley 6234c73cfb54SMatthew G. Knepley Input Parameters: 6235c73cfb54SMatthew G. Knepley + dm - The DM 6236c73cfb54SMatthew G. Knepley - dim - The topological dimension 6237c73cfb54SMatthew G. Knepley 6238c73cfb54SMatthew G. Knepley Level: beginner 6239c73cfb54SMatthew G. Knepley 6240c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate() 6241c73cfb54SMatthew G. Knepley @*/ 6242c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim) 6243c73cfb54SMatthew G. Knepley { 6244e5e52638SMatthew G. Knepley PetscDS ds; 624545480ffeSMatthew G. Knepley PetscInt Nds, n; 6246f17e8794SMatthew G. Knepley PetscErrorCode ierr; 6247f17e8794SMatthew G. Knepley 6248c73cfb54SMatthew G. Knepley PetscFunctionBegin; 6249c73cfb54SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6250c73cfb54SMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, dim, 2); 6251c73cfb54SMatthew G. Knepley dm->dim = dim; 6252d17bd122SMatthew G. Knepley if (dm->dim >= 0) { 625345480ffeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 625445480ffeSMatthew G. Knepley for (n = 0; n < Nds; ++n) { 625545480ffeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr); 625645480ffeSMatthew G. Knepley if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);} 625745480ffeSMatthew G. Knepley } 6258d17bd122SMatthew G. Knepley } 6259c73cfb54SMatthew G. Knepley PetscFunctionReturn(0); 6260c73cfb54SMatthew G. Knepley } 6261c73cfb54SMatthew G. Knepley 6262793f3fe5SMatthew G. Knepley /*@ 6263793f3fe5SMatthew G. Knepley DMGetDimPoints - Get the half-open interval for all points of a given dimension 6264793f3fe5SMatthew G. Knepley 6265d083f849SBarry Smith Collective on dm 6266793f3fe5SMatthew G. Knepley 6267793f3fe5SMatthew G. Knepley Input Parameters: 6268793f3fe5SMatthew G. Knepley + dm - the DM 6269793f3fe5SMatthew G. Knepley - dim - the dimension 6270793f3fe5SMatthew G. Knepley 6271793f3fe5SMatthew G. Knepley Output Parameters: 6272793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension 6273aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension 6274793f3fe5SMatthew G. Knepley 6275793f3fe5SMatthew G. Knepley Note: 6276793f3fe5SMatthew G. Knepley The points are vertices in the Hasse diagram encoding the topology. This is explained in 6277a8d69d7bSBarry Smith https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme, 6278793f3fe5SMatthew G. Knepley then the interval is empty. 6279793f3fe5SMatthew G. Knepley 6280793f3fe5SMatthew G. Knepley Level: intermediate 6281793f3fe5SMatthew G. Knepley 6282793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum() 6283793f3fe5SMatthew G. Knepley @*/ 6284793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd) 6285793f3fe5SMatthew G. Knepley { 6286793f3fe5SMatthew G. Knepley PetscInt d; 6287793f3fe5SMatthew G. Knepley PetscErrorCode ierr; 6288793f3fe5SMatthew G. Knepley 6289793f3fe5SMatthew G. Knepley PetscFunctionBegin; 6290793f3fe5SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6291793f3fe5SMatthew G. Knepley ierr = DMGetDimension(dm, &d);CHKERRQ(ierr); 62922c71b3e2SJacob Faibussowitsch PetscCheckFalse((dim < 0) || (dim > d),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d); 62932c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->getdimpoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name); 6294793f3fe5SMatthew G. Knepley ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr); 6295793f3fe5SMatthew G. Knepley PetscFunctionReturn(0); 6296793f3fe5SMatthew G. Knepley } 6297793f3fe5SMatthew G. Knepley 62986636e97aSMatthew G Knepley /*@ 62996636e97aSMatthew G Knepley DMSetCoordinates - Sets into the DM a global vector that holds the coordinates 63006636e97aSMatthew G Knepley 6301d083f849SBarry Smith Collective on dm 63026636e97aSMatthew G Knepley 63036636e97aSMatthew G Knepley Input Parameters: 63046636e97aSMatthew G Knepley + dm - the DM 63056636e97aSMatthew G Knepley - c - coordinate vector 63066636e97aSMatthew G Knepley 63072dd40e9bSPatrick Sanan Notes: 63082dd40e9bSPatrick Sanan The coordinates do include those for ghost points, which are in the local vector. 63092dd40e9bSPatrick Sanan 63102dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 63116636e97aSMatthew G Knepley 63126636e97aSMatthew G Knepley Level: intermediate 63136636e97aSMatthew G Knepley 631460c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates() 63156636e97aSMatthew G Knepley @*/ 63166636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c) 63176636e97aSMatthew G Knepley { 63186636e97aSMatthew G Knepley PetscErrorCode ierr; 63196636e97aSMatthew G Knepley 63206636e97aSMatthew G Knepley PetscFunctionBegin; 63216636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 63226636e97aSMatthew G Knepley PetscValidHeaderSpecific(c,VEC_CLASSID,2); 63236636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 63246636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 63256636e97aSMatthew G Knepley dm->coordinates = c; 63266636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 6327b64e0483SPeter Brune ierr = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 632803dadc2fSPeter Brune ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr); 63296636e97aSMatthew G Knepley PetscFunctionReturn(0); 63306636e97aSMatthew G Knepley } 63316636e97aSMatthew G Knepley 63326636e97aSMatthew G Knepley /*@ 63336636e97aSMatthew G Knepley DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates 63346636e97aSMatthew G Knepley 63357058e716SVaclav Hapla Not collective 63366636e97aSMatthew G Knepley 63376636e97aSMatthew G Knepley Input Parameters: 63386636e97aSMatthew G Knepley + dm - the DM 63396636e97aSMatthew G Knepley - c - coordinate vector 63406636e97aSMatthew G Knepley 63412dd40e9bSPatrick Sanan Notes: 63426636e97aSMatthew G Knepley The coordinates of ghost points can be set using DMSetCoordinates() 63436636e97aSMatthew G Knepley followed by DMGetCoordinatesLocal(). This is intended to enable the 63446636e97aSMatthew G Knepley setting of ghost coordinates outside of the domain. 63456636e97aSMatthew G Knepley 63462dd40e9bSPatrick Sanan The vector c should be destroyed by the caller. 63472dd40e9bSPatrick Sanan 63486636e97aSMatthew G Knepley Level: intermediate 63496636e97aSMatthew G Knepley 63506636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM() 63516636e97aSMatthew G Knepley @*/ 63526636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c) 63536636e97aSMatthew G Knepley { 63546636e97aSMatthew G Knepley PetscErrorCode ierr; 63556636e97aSMatthew G Knepley 63566636e97aSMatthew G Knepley PetscFunctionBegin; 63576636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6358b7f5c055SJed Brown if (c) PetscValidHeaderSpecific(c,VEC_CLASSID,2); 63596636e97aSMatthew G Knepley ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr); 63606636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr); 63618865f1eaSKarl Rupp 63626636e97aSMatthew G Knepley dm->coordinatesLocal = c; 63638865f1eaSKarl Rupp 63646636e97aSMatthew G Knepley ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr); 63656636e97aSMatthew G Knepley PetscFunctionReturn(0); 63666636e97aSMatthew G Knepley } 63676636e97aSMatthew G Knepley 63686636e97aSMatthew G Knepley /*@ 63696636e97aSMatthew G Knepley DMGetCoordinates - Gets a global vector with the coordinates associated with the DM. 63706636e97aSMatthew G Knepley 6371d083f849SBarry Smith Collective on dm 63726636e97aSMatthew G Knepley 63736636e97aSMatthew G Knepley Input Parameter: 63746636e97aSMatthew G Knepley . dm - the DM 63756636e97aSMatthew G Knepley 63766636e97aSMatthew G Knepley Output Parameter: 63776636e97aSMatthew G Knepley . c - global coordinate vector 63786636e97aSMatthew G Knepley 63796636e97aSMatthew G Knepley Note: 638060c22052SBarry Smith This is a borrowed reference, so the user should NOT destroy this vector. When the DM is 638160c22052SBarry Smith destroyed the array will no longer be valid. 63826636e97aSMatthew G Knepley 6383959c7569SPatrick Sanan Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates). 63846636e97aSMatthew G Knepley 63856636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 63866636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 63876636e97aSMatthew G Knepley 63886636e97aSMatthew G Knepley Level: intermediate 63896636e97aSMatthew G Knepley 639060c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates() 63916636e97aSMatthew G Knepley @*/ 63926636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c) 63936636e97aSMatthew G Knepley { 63946636e97aSMatthew G Knepley PetscErrorCode ierr; 63956636e97aSMatthew G Knepley 63966636e97aSMatthew G Knepley PetscFunctionBegin; 63976636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 63986636e97aSMatthew G Knepley PetscValidPointer(c,2); 63991f588964SMatthew G Knepley if (!dm->coordinates && dm->coordinatesLocal) { 64000298fd71SBarry Smith DM cdm = NULL; 64011970a576SMatthew G. Knepley PetscBool localized; 64026636e97aSMatthew G Knepley 64036636e97aSMatthew G Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 64046636e97aSMatthew G Knepley ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr); 64051970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 64061970a576SMatthew G. Knepley /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */ 64071970a576SMatthew G. Knepley if (localized) { 64081970a576SMatthew G. Knepley PetscInt cdim; 64091970a576SMatthew G. Knepley 64101970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 64111970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 64121970a576SMatthew G. Knepley } 64136636e97aSMatthew G Knepley ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr); 64146636e97aSMatthew G Knepley ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 64156636e97aSMatthew G Knepley ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr); 64166636e97aSMatthew G Knepley } 64176636e97aSMatthew G Knepley *c = dm->coordinates; 64186636e97aSMatthew G Knepley PetscFunctionReturn(0); 64196636e97aSMatthew G Knepley } 64206636e97aSMatthew G Knepley 64216636e97aSMatthew G Knepley /*@ 642281e9a530SVaclav Hapla DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards. 642381e9a530SVaclav Hapla 6424d083f849SBarry Smith Collective on dm 642581e9a530SVaclav Hapla 642681e9a530SVaclav Hapla Input Parameter: 642781e9a530SVaclav Hapla . dm - the DM 642881e9a530SVaclav Hapla 642981e9a530SVaclav Hapla Level: advanced 643081e9a530SVaclav Hapla 643181e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective() 643281e9a530SVaclav Hapla @*/ 643381e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm) 643481e9a530SVaclav Hapla { 643581e9a530SVaclav Hapla PetscErrorCode ierr; 643681e9a530SVaclav Hapla 643781e9a530SVaclav Hapla PetscFunctionBegin; 643881e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 643981e9a530SVaclav Hapla if (!dm->coordinatesLocal && dm->coordinates) { 64401970a576SMatthew G. Knepley DM cdm = NULL; 64411970a576SMatthew G. Knepley PetscBool localized; 64421970a576SMatthew G. Knepley 644381e9a530SVaclav Hapla ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 644481e9a530SVaclav Hapla ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr); 64451970a576SMatthew G. Knepley ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr); 64461970a576SMatthew G. Knepley /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */ 64471970a576SMatthew G. Knepley if (localized) { 64481970a576SMatthew G. Knepley PetscInt cdim; 64491970a576SMatthew G. Knepley 64501970a576SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr); 64511970a576SMatthew G. Knepley ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr); 64521970a576SMatthew G. Knepley } 645381e9a530SVaclav Hapla ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr); 645481e9a530SVaclav Hapla ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 645581e9a530SVaclav Hapla ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr); 645681e9a530SVaclav Hapla } 645781e9a530SVaclav Hapla PetscFunctionReturn(0); 645881e9a530SVaclav Hapla } 645981e9a530SVaclav Hapla 646081e9a530SVaclav Hapla /*@ 64616636e97aSMatthew G Knepley DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM. 64626636e97aSMatthew G Knepley 6463d083f849SBarry Smith Collective on dm 64646636e97aSMatthew G Knepley 64656636e97aSMatthew G Knepley Input Parameter: 64666636e97aSMatthew G Knepley . dm - the DM 64676636e97aSMatthew G Knepley 64686636e97aSMatthew G Knepley Output Parameter: 64696636e97aSMatthew G Knepley . c - coordinate vector 64706636e97aSMatthew G Knepley 64716636e97aSMatthew G Knepley Note: 64726636e97aSMatthew G Knepley This is a borrowed reference, so the user should NOT destroy this vector 64736636e97aSMatthew G Knepley 64746636e97aSMatthew G Knepley Each process has the local and ghost coordinates 64756636e97aSMatthew G Knepley 64766636e97aSMatthew G Knepley For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 64776636e97aSMatthew G Knepley and (x_0,y_0,z_0,x_1,y_1,z_1...) 64786636e97aSMatthew G Knepley 64796636e97aSMatthew G Knepley Level: intermediate 64806636e97aSMatthew G Knepley 648181e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective() 64826636e97aSMatthew G Knepley @*/ 64836636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c) 64846636e97aSMatthew G Knepley { 64856636e97aSMatthew G Knepley PetscErrorCode ierr; 64866636e97aSMatthew G Knepley 64876636e97aSMatthew G Knepley PetscFunctionBegin; 64886636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 64896636e97aSMatthew G Knepley PetscValidPointer(c,2); 649081e9a530SVaclav Hapla ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr); 64916636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 64926636e97aSMatthew G Knepley PetscFunctionReturn(0); 64936636e97aSMatthew G Knepley } 64946636e97aSMatthew G Knepley 649581e9a530SVaclav Hapla /*@ 649681e9a530SVaclav Hapla DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called. 649781e9a530SVaclav Hapla 649881e9a530SVaclav Hapla Not collective 649981e9a530SVaclav Hapla 650081e9a530SVaclav Hapla Input Parameter: 650181e9a530SVaclav Hapla . dm - the DM 650281e9a530SVaclav Hapla 650381e9a530SVaclav Hapla Output Parameter: 650481e9a530SVaclav Hapla . c - coordinate vector 650581e9a530SVaclav Hapla 650681e9a530SVaclav Hapla Level: advanced 650781e9a530SVaclav Hapla 650881e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 650981e9a530SVaclav Hapla @*/ 651081e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c) 651181e9a530SVaclav Hapla { 651281e9a530SVaclav Hapla PetscFunctionBegin; 651381e9a530SVaclav Hapla PetscValidHeaderSpecific(dm,DM_CLASSID,1); 651481e9a530SVaclav Hapla PetscValidPointer(c,2); 65152c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->coordinatesLocal && dm->coordinates,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called"); 65166636e97aSMatthew G Knepley *c = dm->coordinatesLocal; 65176636e97aSMatthew G Knepley PetscFunctionReturn(0); 65186636e97aSMatthew G Knepley } 65196636e97aSMatthew G Knepley 65202db98f8dSVaclav Hapla /*@ 65212db98f8dSVaclav Hapla DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout. 65222db98f8dSVaclav Hapla 65232db98f8dSVaclav Hapla Not collective 65242db98f8dSVaclav Hapla 6525d8d19677SJose E. Roman Input Parameters: 65262db98f8dSVaclav Hapla + dm - the DM 65272db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned 65282db98f8dSVaclav Hapla 6529d8d19677SJose E. Roman Output Parameters: 65302db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates 65312db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p 65322db98f8dSVaclav Hapla 65332db98f8dSVaclav Hapla Note: 65342db98f8dSVaclav Hapla DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective. 65352db98f8dSVaclav Hapla 65362db98f8dSVaclav Hapla This creates a new vector, so the user SHOULD destroy this vector 65372db98f8dSVaclav Hapla 65382db98f8dSVaclav Hapla Each process has the local and ghost coordinates 65392db98f8dSVaclav Hapla 65402db98f8dSVaclav Hapla For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...) 65412db98f8dSVaclav Hapla and (x_0,y_0,z_0,x_1,y_1,z_1...) 65422db98f8dSVaclav Hapla 65432db98f8dSVaclav Hapla Level: advanced 65442db98f8dSVaclav Hapla 65452db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM() 65462db98f8dSVaclav Hapla @*/ 65472db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord) 65482db98f8dSVaclav Hapla { 65492db98f8dSVaclav Hapla PetscSection cs, newcs; 65502db98f8dSVaclav Hapla Vec coords; 65512db98f8dSVaclav Hapla const PetscScalar *arr; 65522db98f8dSVaclav Hapla PetscScalar *newarr=NULL; 65532db98f8dSVaclav Hapla PetscInt n; 65542db98f8dSVaclav Hapla PetscErrorCode ierr; 65552db98f8dSVaclav Hapla 65562db98f8dSVaclav Hapla PetscFunctionBegin; 65572db98f8dSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 65582db98f8dSVaclav Hapla PetscValidHeaderSpecific(p, IS_CLASSID, 2); 65592db98f8dSVaclav Hapla if (pCoordSection) PetscValidPointer(pCoordSection, 3); 65602db98f8dSVaclav Hapla if (pCoord) PetscValidPointer(pCoord, 4); 65612c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->coordinatesLocal,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set"); 65622c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->coordinateDM || !dm->coordinateDM->localSection,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported"); 65631bb6d2a8SBarry Smith cs = dm->coordinateDM->localSection; 65642db98f8dSVaclav Hapla coords = dm->coordinatesLocal; 65652db98f8dSVaclav Hapla ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr); 65662db98f8dSVaclav Hapla ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr); 65672db98f8dSVaclav Hapla ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr); 65682db98f8dSVaclav Hapla if (pCoord) { 65692db98f8dSVaclav Hapla ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr); 65702db98f8dSVaclav Hapla /* set array in two steps to mimic PETSC_OWN_POINTER */ 65712db98f8dSVaclav Hapla ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr); 65722db98f8dSVaclav Hapla ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr); 6573ad9ac99dSVaclav Hapla } else { 6574ad9ac99dSVaclav Hapla ierr = PetscFree(newarr);CHKERRQ(ierr); 65752db98f8dSVaclav Hapla } 6576ad9ac99dSVaclav Hapla if (pCoordSection) {*pCoordSection = newcs;} 6577ad9ac99dSVaclav Hapla else {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);} 65782db98f8dSVaclav Hapla PetscFunctionReturn(0); 65792db98f8dSVaclav Hapla } 65802db98f8dSVaclav Hapla 6581f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field) 6582f19dbd58SToby Isaac { 6583f19dbd58SToby Isaac PetscErrorCode ierr; 6584f19dbd58SToby Isaac 6585f19dbd58SToby Isaac PetscFunctionBegin; 6586f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6587f19dbd58SToby Isaac PetscValidPointer(field,2); 6588f19dbd58SToby Isaac if (!dm->coordinateField) { 6589f19dbd58SToby Isaac if (dm->ops->createcoordinatefield) { 6590f19dbd58SToby Isaac ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr); 6591f19dbd58SToby Isaac } 6592f19dbd58SToby Isaac } 6593f19dbd58SToby Isaac *field = dm->coordinateField; 6594f19dbd58SToby Isaac PetscFunctionReturn(0); 6595f19dbd58SToby Isaac } 6596f19dbd58SToby Isaac 6597f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field) 6598f19dbd58SToby Isaac { 6599f19dbd58SToby Isaac PetscErrorCode ierr; 6600f19dbd58SToby Isaac 6601f19dbd58SToby Isaac PetscFunctionBegin; 6602f19dbd58SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6603f19dbd58SToby Isaac if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2); 6604c4e6da2cSBarry Smith ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr); 6605f19dbd58SToby Isaac ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr); 6606f19dbd58SToby Isaac dm->coordinateField = field; 6607f19dbd58SToby Isaac PetscFunctionReturn(0); 6608f19dbd58SToby Isaac } 6609f19dbd58SToby Isaac 66106636e97aSMatthew G Knepley /*@ 66111cfe2091SMatthew G. Knepley DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates 66126636e97aSMatthew G Knepley 6613d083f849SBarry Smith Collective on dm 66146636e97aSMatthew G Knepley 66156636e97aSMatthew G Knepley Input Parameter: 66166636e97aSMatthew G Knepley . dm - the DM 66176636e97aSMatthew G Knepley 66186636e97aSMatthew G Knepley Output Parameter: 66196636e97aSMatthew G Knepley . cdm - coordinate DM 66206636e97aSMatthew G Knepley 66216636e97aSMatthew G Knepley Level: intermediate 66226636e97aSMatthew G Knepley 66231cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 66246636e97aSMatthew G Knepley @*/ 66256636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm) 66266636e97aSMatthew G Knepley { 66276636e97aSMatthew G Knepley PetscErrorCode ierr; 66286636e97aSMatthew G Knepley 66296636e97aSMatthew G Knepley PetscFunctionBegin; 66306636e97aSMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 66316636e97aSMatthew G Knepley PetscValidPointer(cdm,2); 66326636e97aSMatthew G Knepley if (!dm->coordinateDM) { 6633308f8a94SToby Isaac DM cdm; 6634308f8a94SToby Isaac 66352c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->createcoordinatedm,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM"); 6636308f8a94SToby Isaac ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr); 6637c9ad657eSksagiyam ierr = PetscObjectSetName((PetscObject)cdm, "coordinateDM");CHKERRQ(ierr); 6638308f8a94SToby Isaac /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup 6639308f8a94SToby Isaac * until the call to CreateCoordinateDM) */ 6640308f8a94SToby Isaac ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 6641308f8a94SToby Isaac dm->coordinateDM = cdm; 66426636e97aSMatthew G Knepley } 66436636e97aSMatthew G Knepley *cdm = dm->coordinateDM; 66446636e97aSMatthew G Knepley PetscFunctionReturn(0); 66456636e97aSMatthew G Knepley } 6646e87bb0d3SMatthew G Knepley 66471cfe2091SMatthew G. Knepley /*@ 66481cfe2091SMatthew G. Knepley DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates 66491cfe2091SMatthew G. Knepley 6650d083f849SBarry Smith Logically Collective on dm 66511cfe2091SMatthew G. Knepley 66521cfe2091SMatthew G. Knepley Input Parameters: 66531cfe2091SMatthew G. Knepley + dm - the DM 66541cfe2091SMatthew G. Knepley - cdm - coordinate DM 66551cfe2091SMatthew G. Knepley 66561cfe2091SMatthew G. Knepley Level: intermediate 66571cfe2091SMatthew G. Knepley 66581cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal() 66591cfe2091SMatthew G. Knepley @*/ 66601cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm) 66611cfe2091SMatthew G. Knepley { 66621cfe2091SMatthew G. Knepley PetscErrorCode ierr; 66631cfe2091SMatthew G. Knepley 66641cfe2091SMatthew G. Knepley PetscFunctionBegin; 66651cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 66661cfe2091SMatthew G. Knepley PetscValidHeaderSpecific(cdm,DM_CLASSID,2); 6667f26b38b9SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 66681cfe2091SMatthew G. Knepley ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr); 66691cfe2091SMatthew G. Knepley dm->coordinateDM = cdm; 66701cfe2091SMatthew G. Knepley PetscFunctionReturn(0); 66711cfe2091SMatthew G. Knepley } 66721cfe2091SMatthew G. Knepley 667346e270d4SMatthew G. Knepley /*@ 667446e270d4SMatthew G. Knepley DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values. 667546e270d4SMatthew G. Knepley 667646e270d4SMatthew G. Knepley Not Collective 667746e270d4SMatthew G. Knepley 667846e270d4SMatthew G. Knepley Input Parameter: 667946e270d4SMatthew G. Knepley . dm - The DM object 668046e270d4SMatthew G. Knepley 668146e270d4SMatthew G. Knepley Output Parameter: 668246e270d4SMatthew G. Knepley . dim - The embedding dimension 668346e270d4SMatthew G. Knepley 668446e270d4SMatthew G. Knepley Level: intermediate 668546e270d4SMatthew G. Knepley 668692fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 668746e270d4SMatthew G. Knepley @*/ 668846e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim) 668946e270d4SMatthew G. Knepley { 669046e270d4SMatthew G. Knepley PetscFunctionBegin; 669146e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6692534a8f05SLisandro Dalcin PetscValidIntPointer(dim, 2); 66939a9a41abSToby Isaac if (dm->dimEmbed == PETSC_DEFAULT) { 66949a9a41abSToby Isaac dm->dimEmbed = dm->dim; 66959a9a41abSToby Isaac } 669646e270d4SMatthew G. Knepley *dim = dm->dimEmbed; 669746e270d4SMatthew G. Knepley PetscFunctionReturn(0); 669846e270d4SMatthew G. Knepley } 669946e270d4SMatthew G. Knepley 670046e270d4SMatthew G. Knepley /*@ 670146e270d4SMatthew G. Knepley DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values. 670246e270d4SMatthew G. Knepley 670346e270d4SMatthew G. Knepley Not Collective 670446e270d4SMatthew G. Knepley 670546e270d4SMatthew G. Knepley Input Parameters: 670646e270d4SMatthew G. Knepley + dm - The DM object 670746e270d4SMatthew G. Knepley - dim - The embedding dimension 670846e270d4SMatthew G. Knepley 670946e270d4SMatthew G. Knepley Level: intermediate 671046e270d4SMatthew G. Knepley 671192fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 671246e270d4SMatthew G. Knepley @*/ 671346e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim) 671446e270d4SMatthew G. Knepley { 6715e5e52638SMatthew G. Knepley PetscDS ds; 671645480ffeSMatthew G. Knepley PetscInt Nds, n; 6717f17e8794SMatthew G. Knepley PetscErrorCode ierr; 6718f17e8794SMatthew G. Knepley 671946e270d4SMatthew G. Knepley PetscFunctionBegin; 672046e270d4SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 672146e270d4SMatthew G. Knepley dm->dimEmbed = dim; 6722d17bd122SMatthew G. Knepley if (dm->dim >= 0) { 672345480ffeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 672445480ffeSMatthew G. Knepley for (n = 0; n < Nds; ++n) { 672545480ffeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr); 6726e5e52638SMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr); 672745480ffeSMatthew G. Knepley } 6728d17bd122SMatthew G. Knepley } 672946e270d4SMatthew G. Knepley PetscFunctionReturn(0); 673046e270d4SMatthew G. Knepley } 673146e270d4SMatthew G. Knepley 6732e8abe2deSMatthew G. Knepley /*@ 6733e8abe2deSMatthew G. Knepley DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh. 6734e8abe2deSMatthew G. Knepley 6735d083f849SBarry Smith Collective on dm 6736e8abe2deSMatthew G. Knepley 6737e8abe2deSMatthew G. Knepley Input Parameter: 6738e8abe2deSMatthew G. Knepley . dm - The DM object 6739e8abe2deSMatthew G. Knepley 6740e8abe2deSMatthew G. Knepley Output Parameter: 6741e8abe2deSMatthew G. Knepley . section - The PetscSection object 6742e8abe2deSMatthew G. Knepley 6743e8abe2deSMatthew G. Knepley Level: intermediate 6744e8abe2deSMatthew G. Knepley 674592fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection() 6746e8abe2deSMatthew G. Knepley @*/ 6747e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section) 6748e8abe2deSMatthew G. Knepley { 6749e8abe2deSMatthew G. Knepley DM cdm; 6750e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 6751e8abe2deSMatthew G. Knepley 6752e8abe2deSMatthew G. Knepley PetscFunctionBegin; 6753e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 6754e8abe2deSMatthew G. Knepley PetscValidPointer(section, 2); 6755e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 675692fd8e1eSJed Brown ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr); 6757e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 6758e8abe2deSMatthew G. Knepley } 6759e8abe2deSMatthew G. Knepley 6760e8abe2deSMatthew G. Knepley /*@ 6761e8abe2deSMatthew G. Knepley DMSetCoordinateSection - Set the layout of coordinate values over the mesh. 6762e8abe2deSMatthew G. Knepley 6763e8abe2deSMatthew G. Knepley Not Collective 6764e8abe2deSMatthew G. Knepley 6765e8abe2deSMatthew G. Knepley Input Parameters: 6766e8abe2deSMatthew G. Knepley + dm - The DM object 676746e270d4SMatthew G. Knepley . dim - The embedding dimension, or PETSC_DETERMINE 6768e8abe2deSMatthew G. Knepley - section - The PetscSection object 6769e8abe2deSMatthew G. Knepley 6770e8abe2deSMatthew G. Knepley Level: intermediate 6771e8abe2deSMatthew G. Knepley 677292fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection() 6773e8abe2deSMatthew G. Knepley @*/ 677446e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section) 6775e8abe2deSMatthew G. Knepley { 6776e8abe2deSMatthew G. Knepley DM cdm; 6777e8abe2deSMatthew G. Knepley PetscErrorCode ierr; 6778e8abe2deSMatthew G. Knepley 6779e8abe2deSMatthew G. Knepley PetscFunctionBegin; 6780e8abe2deSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 678146e270d4SMatthew G. Knepley PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3); 6782e8abe2deSMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 678392fd8e1eSJed Brown ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr); 678446e270d4SMatthew G. Knepley if (dim == PETSC_DETERMINE) { 67854c1069a6SMatthew G. Knepley PetscInt d = PETSC_DEFAULT; 678646e270d4SMatthew G. Knepley PetscInt pStart, pEnd, vStart, vEnd, v, dd; 678746e270d4SMatthew G. Knepley 678846e270d4SMatthew G. Knepley ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr); 678946e270d4SMatthew G. Knepley ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr); 679046e270d4SMatthew G. Knepley pStart = PetscMax(vStart, pStart); 679146e270d4SMatthew G. Knepley pEnd = PetscMin(vEnd, pEnd); 679246e270d4SMatthew G. Knepley for (v = pStart; v < pEnd; ++v) { 679346e270d4SMatthew G. Knepley ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr); 679446e270d4SMatthew G. Knepley if (dd) {d = dd; break;} 679546e270d4SMatthew G. Knepley } 6796ebfe4b0dSMatthew G. Knepley if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);} 679746e270d4SMatthew G. Knepley } 6798e8abe2deSMatthew G. Knepley PetscFunctionReturn(0); 6799e8abe2deSMatthew G. Knepley } 6800e8abe2deSMatthew G. Knepley 6801d864a3eaSLisandro Dalcin /*@ 6802d864a3eaSLisandro Dalcin DMProjectCoordinates - Project coordinates to a different space 6803d864a3eaSLisandro Dalcin 6804d864a3eaSLisandro Dalcin Input Parameters: 6805d864a3eaSLisandro Dalcin + dm - The DM object 6806d864a3eaSLisandro Dalcin - disc - The new coordinate discretization 6807d864a3eaSLisandro Dalcin 6808d864a3eaSLisandro Dalcin Level: intermediate 6809d864a3eaSLisandro Dalcin 6810d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField() 6811d864a3eaSLisandro Dalcin @*/ 6812d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc) 6813d864a3eaSLisandro Dalcin { 6814d864a3eaSLisandro Dalcin PetscObject discOld; 6815d864a3eaSLisandro Dalcin PetscClassId classid; 6816d864a3eaSLisandro Dalcin DM cdmOld,cdmNew; 6817d864a3eaSLisandro Dalcin Vec coordsOld,coordsNew; 6818d864a3eaSLisandro Dalcin Mat matInterp; 6819d864a3eaSLisandro Dalcin PetscErrorCode ierr; 6820d864a3eaSLisandro Dalcin 6821d864a3eaSLisandro Dalcin PetscFunctionBegin; 6822d864a3eaSLisandro Dalcin PetscValidHeaderSpecific(dm,DM_CLASSID,1); 6823d864a3eaSLisandro Dalcin PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2); 6824d864a3eaSLisandro Dalcin 6825d864a3eaSLisandro Dalcin ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr); 6826d864a3eaSLisandro Dalcin /* Check current discretization is compatible */ 6827d864a3eaSLisandro Dalcin ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr); 6828d864a3eaSLisandro Dalcin ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr); 682929ad44c5SMatthew G. Knepley if (classid != PETSCFE_CLASSID) { 683029ad44c5SMatthew G. Knepley if (classid == PETSC_CONTAINER_CLASSID) { 683129ad44c5SMatthew G. Knepley PetscFE feLinear; 683229ad44c5SMatthew G. Knepley DMPolytopeType ct; 683329ad44c5SMatthew G. Knepley PetscInt dim, dE, cStart; 683429ad44c5SMatthew G. Knepley PetscBool simplex; 683529ad44c5SMatthew G. Knepley 683629ad44c5SMatthew G. Knepley /* Assume linear vertex coordinates */ 683729ad44c5SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 683829ad44c5SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr); 683929ad44c5SMatthew G. Knepley ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr); 684029ad44c5SMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 684129ad44c5SMatthew G. Knepley switch (ct) { 684229ad44c5SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM: 684329ad44c5SMatthew G. Knepley case DM_POLYTOPE_TRI_PRISM_TENSOR: 684429ad44c5SMatthew G. Knepley SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms"); 684529ad44c5SMatthew G. Knepley default: break; 684629ad44c5SMatthew G. Knepley } 684729ad44c5SMatthew G. Knepley simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE; 684829ad44c5SMatthew G. Knepley ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr); 684929ad44c5SMatthew G. Knepley ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr); 685029ad44c5SMatthew G. Knepley ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr); 685129ad44c5SMatthew G. Knepley ierr = DMCreateDS(cdmOld);CHKERRQ(ierr); 685229ad44c5SMatthew G. Knepley } else { 685329ad44c5SMatthew G. Knepley const char *discname; 685429ad44c5SMatthew G. Knepley 685529ad44c5SMatthew G. Knepley ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr); 685698921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname); 685729ad44c5SMatthew G. Knepley } 685829ad44c5SMatthew G. Knepley } 6859d864a3eaSLisandro Dalcin /* Make a fresh clone of the coordinate DM */ 6860d864a3eaSLisandro Dalcin ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr); 6861d864a3eaSLisandro Dalcin ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr); 6862d864a3eaSLisandro Dalcin ierr = DMCreateDS(cdmNew);CHKERRQ(ierr); 6863d864a3eaSLisandro Dalcin /* Project the coordinate vector from old to new space */ 6864d864a3eaSLisandro Dalcin ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr); 6865d864a3eaSLisandro Dalcin ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr); 6866d864a3eaSLisandro Dalcin ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr); 6867d864a3eaSLisandro Dalcin ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr); 6868d864a3eaSLisandro Dalcin ierr = MatDestroy(&matInterp);CHKERRQ(ierr); 6869d864a3eaSLisandro Dalcin /* Set new coordinate structures */ 6870d864a3eaSLisandro Dalcin ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr); 6871d864a3eaSLisandro Dalcin ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr); 6872d864a3eaSLisandro Dalcin ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr); 6873d864a3eaSLisandro Dalcin ierr = VecDestroy(&coordsNew);CHKERRQ(ierr); 6874d864a3eaSLisandro Dalcin ierr = DMDestroy(&cdmNew);CHKERRQ(ierr); 6875d864a3eaSLisandro Dalcin PetscFunctionReturn(0); 6876d864a3eaSLisandro Dalcin } 6877d864a3eaSLisandro Dalcin 68785dc8c3f7SMatthew G. Knepley /*@C 687990b157c4SStefano Zampini DMGetPeriodicity - Get the description of mesh periodicity 68805dc8c3f7SMatthew G. Knepley 6881f899ff85SJose E. Roman Input Parameter: 688290b157c4SStefano Zampini . dm - The DM object 688390b157c4SStefano Zampini 688490b157c4SStefano Zampini Output Parameters: 688590b157c4SStefano Zampini + per - Whether the DM is periodic or not 68865dc8c3f7SMatthew 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 68875dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 68885dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 68895dc8c3f7SMatthew G. Knepley 68905dc8c3f7SMatthew G. Knepley Level: developer 68915dc8c3f7SMatthew G. Knepley 68925dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 68935dc8c3f7SMatthew G. Knepley @*/ 689490b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd) 6895c6b900c6SMatthew G. Knepley { 6896c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6897c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 689890b157c4SStefano Zampini if (per) *per = dm->periodic; 6899c6b900c6SMatthew G. Knepley if (L) *L = dm->L; 6900c6b900c6SMatthew G. Knepley if (maxCell) *maxCell = dm->maxCell; 69015dc8c3f7SMatthew G. Knepley if (bd) *bd = dm->bdtype; 6902c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6903c6b900c6SMatthew G. Knepley } 6904c6b900c6SMatthew G. Knepley 69055dc8c3f7SMatthew G. Knepley /*@C 69065dc8c3f7SMatthew G. Knepley DMSetPeriodicity - Set the description of mesh periodicity 69075dc8c3f7SMatthew G. Knepley 69085dc8c3f7SMatthew G. Knepley Input Parameters: 69095dc8c3f7SMatthew G. Knepley + dm - The DM object 6910db2bf62eSStefano Zampini . per - Whether the DM is periodic or not. 6911db2bf62eSStefano 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. 69125dc8c3f7SMatthew G. Knepley . L - If we assume the mesh is a torus, this is the length of each coordinate 69135dc8c3f7SMatthew G. Knepley - bd - This describes the type of periodicity in each topological dimension 69145dc8c3f7SMatthew G. Knepley 6915db2bf62eSStefano 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. 6916db2bf62eSStefano Zampini 69175dc8c3f7SMatthew G. Knepley Level: developer 69185dc8c3f7SMatthew G. Knepley 69195dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity() 69205dc8c3f7SMatthew G. Knepley @*/ 692190b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[]) 6922c6b900c6SMatthew G. Knepley { 6923c6b900c6SMatthew G. Knepley PetscInt dim, d; 6924c6b900c6SMatthew G. Knepley PetscErrorCode ierr; 6925c6b900c6SMatthew G. Knepley 6926c6b900c6SMatthew G. Knepley PetscFunctionBegin; 6927c6b900c6SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 692890b157c4SStefano Zampini PetscValidLogicalCollectiveBool(dm,per,2); 6929412e9a14SMatthew G. Knepley if (maxCell) {PetscValidRealPointer(maxCell,3);} 6930412e9a14SMatthew G. Knepley if (L) {PetscValidRealPointer(L,4);} 6931412e9a14SMatthew G. Knepley if (bd) {PetscValidPointer(bd,5);} 69325dc8c3f7SMatthew G. Knepley ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr); 693390b157c4SStefano Zampini if (maxCell) { 6934412e9a14SMatthew G. Knepley if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);} 6935412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d]; 6936db2bf62eSStefano Zampini } else { /* remove maxCell information to disable automatic computation of localized vertices */ 6937db2bf62eSStefano Zampini ierr = PetscFree(dm->maxCell);CHKERRQ(ierr); 6938412e9a14SMatthew G. Knepley } 6939db2bf62eSStefano Zampini 6940412e9a14SMatthew G. Knepley if (L) { 6941412e9a14SMatthew G. Knepley if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);} 6942412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->L[d] = L[d]; 6943412e9a14SMatthew G. Knepley } 6944412e9a14SMatthew G. Knepley if (bd) { 6945412e9a14SMatthew G. Knepley if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);} 6946412e9a14SMatthew G. Knepley for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d]; 694790b157c4SStefano Zampini } 6948072d7d67SStefano Zampini dm->periodic = per; 6949c6b900c6SMatthew G. Knepley PetscFunctionReturn(0); 6950c6b900c6SMatthew G. Knepley } 6951c6b900c6SMatthew G. Knepley 69522e17dfb7SMatthew G. Knepley /*@ 69532e17dfb7SMatthew 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. 69542e17dfb7SMatthew G. Knepley 69552e17dfb7SMatthew G. Knepley Input Parameters: 69562e17dfb7SMatthew G. Knepley + dm - The DM 695765da65dcSMatthew G. Knepley . in - The input coordinate point (dim numbers) 695865da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i 69592e17dfb7SMatthew G. Knepley 69602e17dfb7SMatthew G. Knepley Output Parameter: 69612e17dfb7SMatthew G. Knepley . out - The localized coordinate point 69622e17dfb7SMatthew G. Knepley 69632e17dfb7SMatthew G. Knepley Level: developer 69642e17dfb7SMatthew G. Knepley 69652e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 69662e17dfb7SMatthew G. Knepley @*/ 696765da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[]) 69682e17dfb7SMatthew G. Knepley { 69692e17dfb7SMatthew G. Knepley PetscInt dim, d; 69702e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 69712e17dfb7SMatthew G. Knepley 69722e17dfb7SMatthew G. Knepley PetscFunctionBegin; 69732e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr); 69742e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 69752e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 69762e17dfb7SMatthew G. Knepley } else { 697765da65dcSMatthew G. Knepley if (endpoint) { 697865da65dcSMatthew G. Knepley for (d = 0; d < dim; ++d) { 6979da3333bfSMatthew 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)) { 6980da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1); 698165da65dcSMatthew G. Knepley } else { 6982da3333bfSMatthew G. Knepley out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 698365da65dcSMatthew G. Knepley } 698465da65dcSMatthew G. Knepley } 698565da65dcSMatthew G. Knepley } else { 69862e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 69871118d4bcSLisandro Dalcin out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]); 69882e17dfb7SMatthew G. Knepley } 69892e17dfb7SMatthew G. Knepley } 699065da65dcSMatthew G. Knepley } 69912e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 69922e17dfb7SMatthew G. Knepley } 69932e17dfb7SMatthew G. Knepley 69942e17dfb7SMatthew G. Knepley /* 69952e17dfb7SMatthew 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. 69962e17dfb7SMatthew G. Knepley 69972e17dfb7SMatthew G. Knepley Input Parameters: 69982e17dfb7SMatthew G. Knepley + dm - The DM 69992e17dfb7SMatthew G. Knepley . dim - The spatial dimension 70002e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 70012e17dfb7SMatthew G. Knepley - in - The input coordinate point (dim numbers) 70022e17dfb7SMatthew G. Knepley 70032e17dfb7SMatthew G. Knepley Output Parameter: 70042e17dfb7SMatthew G. Knepley . out - The localized coordinate point 70052e17dfb7SMatthew G. Knepley 70062e17dfb7SMatthew G. Knepley Level: developer 70072e17dfb7SMatthew G. Knepley 70082e17dfb7SMatthew 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 70092e17dfb7SMatthew G. Knepley 70102e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate() 70112e17dfb7SMatthew G. Knepley */ 70122e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 70132e17dfb7SMatthew G. Knepley { 70142e17dfb7SMatthew G. Knepley PetscInt d; 70152e17dfb7SMatthew G. Knepley 70162e17dfb7SMatthew G. Knepley PetscFunctionBegin; 70172e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 70182e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 70192e17dfb7SMatthew G. Knepley } else { 70202e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 7021908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) { 70222e17dfb7SMatthew G. Knepley out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 70232e17dfb7SMatthew G. Knepley } else { 70242e17dfb7SMatthew G. Knepley out[d] = in[d]; 70252e17dfb7SMatthew G. Knepley } 70262e17dfb7SMatthew G. Knepley } 70272e17dfb7SMatthew G. Knepley } 70282e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 70292e17dfb7SMatthew G. Knepley } 7030a5801f52SStefano Zampini 70312e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[]) 70322e17dfb7SMatthew G. Knepley { 70332e17dfb7SMatthew G. Knepley PetscInt d; 70342e17dfb7SMatthew G. Knepley 70352e17dfb7SMatthew G. Knepley PetscFunctionBegin; 70362e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 70372e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] = in[d]; 70382e17dfb7SMatthew G. Knepley } else { 70392e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 7040908eca10SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) { 70412e17dfb7SMatthew G. Knepley out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d]; 70422e17dfb7SMatthew G. Knepley } else { 70432e17dfb7SMatthew G. Knepley out[d] = in[d]; 70442e17dfb7SMatthew G. Knepley } 70452e17dfb7SMatthew G. Knepley } 70462e17dfb7SMatthew G. Knepley } 70472e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 70482e17dfb7SMatthew G. Knepley } 70492e17dfb7SMatthew G. Knepley 70502e17dfb7SMatthew G. Knepley /* 70512e17dfb7SMatthew 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. 70522e17dfb7SMatthew G. Knepley 70532e17dfb7SMatthew G. Knepley Input Parameters: 70542e17dfb7SMatthew G. Knepley + dm - The DM 70552e17dfb7SMatthew G. Knepley . dim - The spatial dimension 70562e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it 70572e17dfb7SMatthew G. Knepley . in - The input coordinate delta (dim numbers) 70582e17dfb7SMatthew G. Knepley - out - The input coordinate point (dim numbers) 70592e17dfb7SMatthew G. Knepley 70602e17dfb7SMatthew G. Knepley Output Parameter: 70612e17dfb7SMatthew G. Knepley . out - The localized coordinate in + out 70622e17dfb7SMatthew G. Knepley 70632e17dfb7SMatthew G. Knepley Level: developer 70642e17dfb7SMatthew G. Knepley 70652e17dfb7SMatthew 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 70662e17dfb7SMatthew G. Knepley 70672e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate() 70682e17dfb7SMatthew G. Knepley */ 70692e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[]) 70702e17dfb7SMatthew G. Knepley { 70712e17dfb7SMatthew G. Knepley PetscInt d; 70722e17dfb7SMatthew G. Knepley 70732e17dfb7SMatthew G. Knepley PetscFunctionBegin; 70742e17dfb7SMatthew G. Knepley if (!dm->maxCell) { 70752e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) out[d] += in[d]; 70762e17dfb7SMatthew G. Knepley } else { 70772e17dfb7SMatthew G. Knepley for (d = 0; d < dim; ++d) { 7078412e9a14SMatthew G. Knepley const PetscReal maxC = dm->maxCell[d]; 7079412e9a14SMatthew G. Knepley 7080412e9a14SMatthew G. Knepley if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) { 7081412e9a14SMatthew G. Knepley const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d]; 7082412e9a14SMatthew G. Knepley 7083412e9a14SMatthew G. Knepley if (PetscAbsScalar(newCoord - anchor[d]) > maxC) 708498921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%D-Coordinate %g more than %g away from anchor %g", d, (double) PetscRealPart(in[d]), (double) maxC, (double) PetscRealPart(anchor[d])); 7085412e9a14SMatthew G. Knepley out[d] += newCoord; 70862e17dfb7SMatthew G. Knepley } else { 70872e17dfb7SMatthew G. Knepley out[d] += in[d]; 70882e17dfb7SMatthew G. Knepley } 70892e17dfb7SMatthew G. Knepley } 70902e17dfb7SMatthew G. Knepley } 70912e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 70922e17dfb7SMatthew G. Knepley } 70932e17dfb7SMatthew G. Knepley 709436447a5eSToby Isaac /*@ 70958f700142SStefano Zampini DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process 70968f700142SStefano Zampini 70978f700142SStefano Zampini Not collective 709836447a5eSToby Isaac 709936447a5eSToby Isaac Input Parameter: 710036447a5eSToby Isaac . dm - The DM 710136447a5eSToby Isaac 710236447a5eSToby Isaac Output Parameter: 710336447a5eSToby Isaac areLocalized - True if localized 710436447a5eSToby Isaac 710536447a5eSToby Isaac Level: developer 710636447a5eSToby Isaac 71078f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity() 710836447a5eSToby Isaac @*/ 71098f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized) 711036447a5eSToby Isaac { 711136447a5eSToby Isaac DM cdm; 711236447a5eSToby Isaac PetscSection coordSection; 71132ccac677SMatthew G. Knepley PetscInt depth, cStart, cEnd, sStart, sEnd, c, dof; 711446a3a80fSLisandro Dalcin PetscBool isPlex, alreadyLocalized; 711536447a5eSToby Isaac PetscErrorCode ierr; 711636447a5eSToby Isaac 711736447a5eSToby Isaac PetscFunctionBegin; 711836447a5eSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7119534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 71208b09590cSToby Isaac *areLocalized = PETSC_FALSE; 712146a3a80fSLisandro Dalcin 712236447a5eSToby Isaac /* We need some generic way of refering to cells/vertices */ 712336447a5eSToby Isaac ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 712446a3a80fSLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr); 71259f7230bfSMatthew G. Knepley if (!isPlex) PetscFunctionReturn(0); 71262ccac677SMatthew G. Knepley ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr); 71272ccac677SMatthew G. Knepley if (!depth) PetscFunctionReturn(0); 712846a3a80fSLisandro Dalcin 71299f7230bfSMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 713046a3a80fSLisandro Dalcin ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr); 713136447a5eSToby Isaac ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr); 713236447a5eSToby Isaac alreadyLocalized = PETSC_FALSE; 713346a3a80fSLisandro Dalcin for (c = cStart; c < cEnd; ++c) { 713446a3a80fSLisandro Dalcin if (c < sStart || c >= sEnd) continue; 713536447a5eSToby Isaac ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr); 713646a3a80fSLisandro Dalcin if (dof) { alreadyLocalized = PETSC_TRUE; break; } 713736447a5eSToby Isaac } 71388f700142SStefano Zampini *areLocalized = alreadyLocalized; 713936447a5eSToby Isaac PetscFunctionReturn(0); 714036447a5eSToby Isaac } 714136447a5eSToby Isaac 71428f700142SStefano Zampini /*@ 71438f700142SStefano Zampini DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells 71448f700142SStefano Zampini 71458f700142SStefano Zampini Collective on dm 71468f700142SStefano Zampini 71478f700142SStefano Zampini Input Parameter: 71488f700142SStefano Zampini . dm - The DM 71498f700142SStefano Zampini 71508f700142SStefano Zampini Output Parameter: 71518f700142SStefano Zampini areLocalized - True if localized 71528f700142SStefano Zampini 71538f700142SStefano Zampini Level: developer 71548f700142SStefano Zampini 71558f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal() 71568f700142SStefano Zampini @*/ 71578f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized) 71588f700142SStefano Zampini { 71598f700142SStefano Zampini PetscBool localized; 71608f700142SStefano Zampini PetscErrorCode ierr; 71618f700142SStefano Zampini 71628f700142SStefano Zampini PetscFunctionBegin; 71638f700142SStefano Zampini PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7164534a8f05SLisandro Dalcin PetscValidBoolPointer(areLocalized, 2); 71658f700142SStefano Zampini ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr); 7166820f2d46SBarry Smith ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 71678f700142SStefano Zampini PetscFunctionReturn(0); 71688f700142SStefano Zampini } 716936447a5eSToby Isaac 71702e17dfb7SMatthew G. Knepley /*@ 7171492b8470SStefano Zampini DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces 71722e17dfb7SMatthew G. Knepley 71738f700142SStefano Zampini Collective on dm 71748f700142SStefano Zampini 71752e17dfb7SMatthew G. Knepley Input Parameter: 71762e17dfb7SMatthew G. Knepley . dm - The DM 71772e17dfb7SMatthew G. Knepley 71782e17dfb7SMatthew G. Knepley Level: developer 71792e17dfb7SMatthew G. Knepley 71808f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate() 71812e17dfb7SMatthew G. Knepley @*/ 71822e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm) 71832e17dfb7SMatthew G. Knepley { 71842e17dfb7SMatthew G. Knepley DM cdm; 71852e17dfb7SMatthew G. Knepley PetscSection coordSection, cSection; 71862e17dfb7SMatthew G. Knepley Vec coordinates, cVec; 71873e922f36SToby Isaac PetscScalar *coords, *coords2, *anchor, *localized; 71883e922f36SToby Isaac PetscInt Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize; 7189e0ae35bbSToby Isaac PetscBool alreadyLocalized, alreadyLocalizedGlobal; 71903e922f36SToby Isaac PetscInt maxHeight = 0, h; 71913e922f36SToby Isaac PetscInt *pStart = NULL, *pEnd = NULL; 71922e17dfb7SMatthew G. Knepley PetscErrorCode ierr; 71932e17dfb7SMatthew G. Knepley 71942e17dfb7SMatthew G. Knepley PetscFunctionBegin; 71952e17dfb7SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 719692c9c85fSStefano Zampini if (!dm->periodic) PetscFunctionReturn(0); 7197f7cbd40bSStefano Zampini ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr); 7198f7cbd40bSStefano Zampini if (alreadyLocalized) PetscFunctionReturn(0); 7199f7cbd40bSStefano Zampini 72002e17dfb7SMatthew G. Knepley /* We need some generic way of refering to cells/vertices */ 72012e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr); 72022e17dfb7SMatthew G. Knepley { 72032e17dfb7SMatthew G. Knepley PetscBool isplex; 72042e17dfb7SMatthew G. Knepley 72052e17dfb7SMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr); 72062e17dfb7SMatthew G. Knepley if (isplex) { 72072e17dfb7SMatthew G. Knepley ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr); 72083e922f36SToby Isaac ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr); 720969291d52SBarry Smith ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 72103e922f36SToby Isaac pEnd = &pStart[maxHeight + 1]; 72113e922f36SToby Isaac newStart = vStart; 72123e922f36SToby Isaac newEnd = vEnd; 72133e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 72143e922f36SToby Isaac ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr); 72153e922f36SToby Isaac newStart = PetscMin(newStart,pStart[h]); 72163e922f36SToby Isaac newEnd = PetscMax(newEnd,pEnd[h]); 72173e922f36SToby Isaac } 72182e17dfb7SMatthew G. Knepley } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM"); 72192e17dfb7SMatthew G. Knepley } 72202e17dfb7SMatthew G. Knepley ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr); 72212c71b3e2SJacob Faibussowitsch PetscCheckFalse(!coordinates,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector"); 72222e17dfb7SMatthew G. Knepley ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr); 72233e922f36SToby Isaac ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr); 7224e0ae35bbSToby Isaac ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr); 72253e922f36SToby Isaac 72262e17dfb7SMatthew G. Knepley ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr); 72272e17dfb7SMatthew G. Knepley ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr); 72282e17dfb7SMatthew G. Knepley ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr); 72292e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr); 72303e922f36SToby Isaac ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr); 72313e922f36SToby Isaac 723269291d52SBarry Smith ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 72333e922f36SToby Isaac localized = &anchor[bs]; 72343e922f36SToby Isaac alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE; 72353e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 72363e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 72373e922f36SToby Isaac 72383e922f36SToby Isaac for (c = cStart; c < cEnd; ++c) { 72393e922f36SToby Isaac PetscScalar *cellCoords = NULL; 72403e922f36SToby Isaac PetscInt b; 72413e922f36SToby Isaac 72423e922f36SToby Isaac if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE; 72433e922f36SToby Isaac ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 72443e922f36SToby Isaac for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 72453e922f36SToby Isaac for (d = 0; d < dof/bs; ++d) { 72463e922f36SToby Isaac ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr); 72473e922f36SToby Isaac for (b = 0; b < bs; b++) { 72483e922f36SToby Isaac if (cellCoords[d*bs + b] != localized[b]) break; 72493e922f36SToby Isaac } 72503e922f36SToby Isaac if (b < bs) break; 72513e922f36SToby Isaac } 72523e922f36SToby Isaac if (d < dof/bs) { 72533e922f36SToby Isaac if (c >= sStart && c < sEnd) { 72543e922f36SToby Isaac PetscInt cdof; 72553e922f36SToby Isaac 72563e922f36SToby Isaac ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr); 72573e922f36SToby Isaac if (cdof != dof) alreadyLocalized = PETSC_FALSE; 72583e922f36SToby Isaac } 72593e922f36SToby Isaac ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr); 72603e922f36SToby Isaac ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr); 72613e922f36SToby Isaac } 72623e922f36SToby Isaac ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 72633e922f36SToby Isaac } 72643e922f36SToby Isaac } 7265ffc4695bSBarry Smith ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr); 72663e922f36SToby Isaac if (alreadyLocalizedGlobal) { 726769291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 72683e922f36SToby Isaac ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 726969291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 72703e922f36SToby Isaac PetscFunctionReturn(0); 72713e922f36SToby Isaac } 72722e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 72732e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 72742e17dfb7SMatthew G. Knepley ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr); 72752e17dfb7SMatthew G. Knepley ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr); 72762e17dfb7SMatthew G. Knepley } 72772e17dfb7SMatthew G. Knepley ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr); 72782e17dfb7SMatthew G. Knepley ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr); 7279c2be7e5eSLisandro Dalcin ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr); 72802e17dfb7SMatthew G. Knepley ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr); 72812e17dfb7SMatthew G. Knepley ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr); 72822e17dfb7SMatthew G. Knepley ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr); 72832e17dfb7SMatthew G. Knepley ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr); 7284c2be7e5eSLisandro Dalcin ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 72852e17dfb7SMatthew G. Knepley ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr); 72862e17dfb7SMatthew G. Knepley for (v = vStart; v < vEnd; ++v) { 72872e17dfb7SMatthew G. Knepley ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr); 72882e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr); 72892e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, v, &off2);CHKERRQ(ierr); 72902e17dfb7SMatthew G. Knepley for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d]; 72912e17dfb7SMatthew G. Knepley } 72923e922f36SToby Isaac for (h = 0; h <= maxHeight; h++) { 72933e922f36SToby Isaac PetscInt cStart = pStart[h], cEnd = pEnd[h], c; 72943e922f36SToby Isaac 72952e17dfb7SMatthew G. Knepley for (c = cStart; c < cEnd; ++c) { 72962e17dfb7SMatthew G. Knepley PetscScalar *cellCoords = NULL; 72973e922f36SToby Isaac PetscInt b, cdof; 72982e17dfb7SMatthew G. Knepley 72993e922f36SToby Isaac ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr); 73003e922f36SToby Isaac if (!cdof) continue; 73012e17dfb7SMatthew G. Knepley ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 73022e17dfb7SMatthew G. Knepley ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr); 73032e17dfb7SMatthew G. Knepley for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b]; 73042e17dfb7SMatthew G. Knepley for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);} 73052e17dfb7SMatthew G. Knepley ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr); 73062e17dfb7SMatthew G. Knepley } 73073e922f36SToby Isaac } 730869291d52SBarry Smith ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr); 730969291d52SBarry Smith ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr); 7310c2be7e5eSLisandro Dalcin ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr); 73112e17dfb7SMatthew G. Knepley ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr); 73122e17dfb7SMatthew G. Knepley ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr); 73132e17dfb7SMatthew G. Knepley ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr); 73142e17dfb7SMatthew G. Knepley ierr = VecDestroy(&cVec);CHKERRQ(ierr); 73152e17dfb7SMatthew G. Knepley ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr); 73162e17dfb7SMatthew G. Knepley PetscFunctionReturn(0); 73172e17dfb7SMatthew G. Knepley } 73182e17dfb7SMatthew G. Knepley 7319e87bb0d3SMatthew G Knepley /*@ 73203a93e3b7SToby Isaac DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells 7321e87bb0d3SMatthew G Knepley 7322d083f849SBarry Smith Collective on v (see explanation below) 7323e87bb0d3SMatthew G Knepley 7324e87bb0d3SMatthew G Knepley Input Parameters: 7325e87bb0d3SMatthew G Knepley + dm - The DM 73266b867d5aSJose E. Roman - ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST 7327e87bb0d3SMatthew G Knepley 73286b867d5aSJose E. Roman Input/Output Parameters: 73296b867d5aSJose E. Roman + v - The Vec of points, on output contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used 73306b867d5aSJose E. Roman - cellSF - Points to either NULL, or a PetscSF with guesses for which cells contain each point; 73316b867d5aSJose E. Roman on output, the PetscSF containing the ranks and local indices of the containing points 73323a93e3b7SToby Isaac 7333e87bb0d3SMatthew G Knepley Level: developer 733461e3bb9bSMatthew G Knepley 733562a38674SMatthew G. Knepley Notes: 73363a93e3b7SToby Isaac To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator. 733762a38674SMatthew G. Knepley To do a search of all the cells in the distributed mesh, v should have the same communicator as dm. 73383a93e3b7SToby Isaac 73393a93e3b7SToby Isaac If *cellSF is NULL on input, a PetscSF will be created. 734062a38674SMatthew G. Knepley If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses. 73413a93e3b7SToby Isaac 73423a93e3b7SToby Isaac An array that maps each point to its containing cell can be obtained with 73433a93e3b7SToby Isaac 734462a38674SMatthew G. Knepley $ const PetscSFNode *cells; 734562a38674SMatthew G. Knepley $ PetscInt nFound; 7346a6216909SToby Isaac $ const PetscInt *found; 734762a38674SMatthew G. Knepley $ 7348a6216909SToby Isaac $ PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells); 73493a93e3b7SToby Isaac 73503a93e3b7SToby 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 73513a93e3b7SToby Isaac the index of the cell in its rank's local numbering. 73523a93e3b7SToby Isaac 735362a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType 735461e3bb9bSMatthew G Knepley @*/ 735562a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF) 7356e87bb0d3SMatthew G Knepley { 7357735aa83eSMatthew G Knepley PetscErrorCode ierr; 7358735aa83eSMatthew G Knepley 7359e87bb0d3SMatthew G Knepley PetscFunctionBegin; 7360e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7361e87bb0d3SMatthew G Knepley PetscValidHeaderSpecific(v,VEC_CLASSID,2); 7362e0fc9d1bSMatthew G. Knepley PetscValidPointer(cellSF,4); 73633a93e3b7SToby Isaac if (*cellSF) { 73643a93e3b7SToby Isaac PetscMPIInt result; 73653a93e3b7SToby Isaac 7366e0fc9d1bSMatthew G. Knepley PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4); 7367ffc4695bSBarry Smith ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr); 73682c71b3e2SJacob Faibussowitsch PetscCheckFalse(result != MPI_IDENT && result != MPI_CONGRUENT,PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's"); 7369e0fc9d1bSMatthew G. Knepley } else { 73703a93e3b7SToby Isaac ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr); 73713a93e3b7SToby Isaac } 73722c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->locatepoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM"); 737347a35634SPatrick Farrell ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 737462a38674SMatthew G. Knepley ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr); 737547a35634SPatrick Farrell ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr); 7376e87bb0d3SMatthew G Knepley PetscFunctionReturn(0); 7377e87bb0d3SMatthew G Knepley } 737814f150ffSMatthew G. Knepley 7379f4d763aaSMatthew G. Knepley /*@ 7380f4d763aaSMatthew G. Knepley DMGetOutputDM - Retrieve the DM associated with the layout for output 7381f4d763aaSMatthew G. Knepley 73828f700142SStefano Zampini Collective on dm 73838f700142SStefano Zampini 7384f4d763aaSMatthew G. Knepley Input Parameter: 7385f4d763aaSMatthew G. Knepley . dm - The original DM 7386f4d763aaSMatthew G. Knepley 7387f4d763aaSMatthew G. Knepley Output Parameter: 7388f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output 7389f4d763aaSMatthew G. Knepley 7390f4d763aaSMatthew G. Knepley Level: intermediate 7391f4d763aaSMatthew G. Knepley 7392e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection() 7393f4d763aaSMatthew G. Knepley @*/ 739414f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm) 739514f150ffSMatthew G. Knepley { 7396c26acbdeSMatthew G. Knepley PetscSection section; 73972d4e4a49SMatthew G. Knepley PetscBool hasConstraints, ghasConstraints; 739814f150ffSMatthew G. Knepley PetscErrorCode ierr; 739914f150ffSMatthew G. Knepley 740014f150ffSMatthew G. Knepley PetscFunctionBegin; 740114f150ffSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 740214f150ffSMatthew G. Knepley PetscValidPointer(odm,2); 740392fd8e1eSJed Brown ierr = DMGetLocalSection(dm, §ion);CHKERRQ(ierr); 7404c26acbdeSMatthew G. Knepley ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr); 7405ffc4695bSBarry Smith ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr); 74062d4e4a49SMatthew G. Knepley if (!ghasConstraints) { 7407c26acbdeSMatthew G. Knepley *odm = dm; 7408c26acbdeSMatthew G. Knepley PetscFunctionReturn(0); 7409c26acbdeSMatthew G. Knepley } 741014f150ffSMatthew G. Knepley if (!dm->dmBC) { 7411c26acbdeSMatthew G. Knepley PetscSection newSection, gsection; 741214f150ffSMatthew G. Knepley PetscSF sf; 741314f150ffSMatthew G. Knepley 741414f150ffSMatthew G. Knepley ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr); 7415e5e52638SMatthew G. Knepley ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr); 741614f150ffSMatthew G. Knepley ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr); 741792fd8e1eSJed Brown ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr); 741814f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr); 741914f150ffSMatthew G. Knepley ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr); 742015b58121SMatthew G. Knepley ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr); 7421e87a4003SBarry Smith ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr); 742214f150ffSMatthew G. Knepley ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr); 742314f150ffSMatthew G. Knepley } 742414f150ffSMatthew G. Knepley *odm = dm->dmBC; 742514f150ffSMatthew G. Knepley PetscFunctionReturn(0); 742614f150ffSMatthew G. Knepley } 7427f4d763aaSMatthew G. Knepley 7428f4d763aaSMatthew G. Knepley /*@ 7429cdb7a50dSMatthew G. Knepley DMGetOutputSequenceNumber - Retrieve the sequence number/value for output 7430f4d763aaSMatthew G. Knepley 7431f4d763aaSMatthew G. Knepley Input Parameter: 7432f4d763aaSMatthew G. Knepley . dm - The original DM 7433f4d763aaSMatthew G. Knepley 7434cdb7a50dSMatthew G. Knepley Output Parameters: 7435cdb7a50dSMatthew G. Knepley + num - The output sequence number 7436cdb7a50dSMatthew G. Knepley - val - The output sequence value 7437f4d763aaSMatthew G. Knepley 7438f4d763aaSMatthew G. Knepley Level: intermediate 7439f4d763aaSMatthew G. Knepley 7440f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7441f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7442f4d763aaSMatthew G. Knepley 7443f4d763aaSMatthew G. Knepley .seealso: VecView() 7444f4d763aaSMatthew G. Knepley @*/ 7445cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val) 7446f4d763aaSMatthew G. Knepley { 7447f4d763aaSMatthew G. Knepley PetscFunctionBegin; 7448f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7449534a8f05SLisandro Dalcin if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;} 7450534a8f05SLisandro Dalcin if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;} 7451f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 7452f4d763aaSMatthew G. Knepley } 7453f4d763aaSMatthew G. Knepley 7454f4d763aaSMatthew G. Knepley /*@ 7455cdb7a50dSMatthew G. Knepley DMSetOutputSequenceNumber - Set the sequence number/value for output 7456f4d763aaSMatthew G. Knepley 7457f4d763aaSMatthew G. Knepley Input Parameters: 7458f4d763aaSMatthew G. Knepley + dm - The original DM 7459cdb7a50dSMatthew G. Knepley . num - The output sequence number 7460cdb7a50dSMatthew G. Knepley - val - The output sequence value 7461f4d763aaSMatthew G. Knepley 7462f4d763aaSMatthew G. Knepley Level: intermediate 7463f4d763aaSMatthew G. Knepley 7464f4d763aaSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7465f4d763aaSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7466f4d763aaSMatthew G. Knepley 7467f4d763aaSMatthew G. Knepley .seealso: VecView() 7468f4d763aaSMatthew G. Knepley @*/ 7469cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val) 7470f4d763aaSMatthew G. Knepley { 7471f4d763aaSMatthew G. Knepley PetscFunctionBegin; 7472f4d763aaSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7473f4d763aaSMatthew G. Knepley dm->outputSequenceNum = num; 7474cdb7a50dSMatthew G. Knepley dm->outputSequenceVal = val; 7475cdb7a50dSMatthew G. Knepley PetscFunctionReturn(0); 7476cdb7a50dSMatthew G. Knepley } 7477cdb7a50dSMatthew G. Knepley 7478cdb7a50dSMatthew G. Knepley /*@C 7479cdb7a50dSMatthew G. Knepley DMOutputSequenceLoad - Retrieve the sequence value from a Viewer 7480cdb7a50dSMatthew G. Knepley 7481cdb7a50dSMatthew G. Knepley Input Parameters: 7482cdb7a50dSMatthew G. Knepley + dm - The original DM 7483cdb7a50dSMatthew G. Knepley . name - The sequence name 7484cdb7a50dSMatthew G. Knepley - num - The output sequence number 7485cdb7a50dSMatthew G. Knepley 7486cdb7a50dSMatthew G. Knepley Output Parameter: 7487cdb7a50dSMatthew G. Knepley . val - The output sequence value 7488cdb7a50dSMatthew G. Knepley 7489cdb7a50dSMatthew G. Knepley Level: intermediate 7490cdb7a50dSMatthew G. Knepley 7491cdb7a50dSMatthew G. Knepley Note: This is intended for output that should appear in sequence, for instance 7492cdb7a50dSMatthew G. Knepley a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system. 7493cdb7a50dSMatthew G. Knepley 7494cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView() 7495cdb7a50dSMatthew G. Knepley @*/ 7496cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val) 7497cdb7a50dSMatthew G. Knepley { 7498cdb7a50dSMatthew G. Knepley PetscBool ishdf5; 7499cdb7a50dSMatthew G. Knepley PetscErrorCode ierr; 7500cdb7a50dSMatthew G. Knepley 7501cdb7a50dSMatthew G. Knepley PetscFunctionBegin; 7502cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 7503cdb7a50dSMatthew G. Knepley PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 7504064a246eSJacob Faibussowitsch PetscValidRealPointer(val,5); 7505cdb7a50dSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr); 7506cdb7a50dSMatthew G. Knepley if (ishdf5) { 7507cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5) 7508cdb7a50dSMatthew G. Knepley PetscScalar value; 7509cdb7a50dSMatthew G. Knepley 751039d25373SMatthew G. Knepley ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr); 75114aeb217fSMatthew G. Knepley *val = PetscRealPart(value); 7512cdb7a50dSMatthew G. Knepley #endif 7513cdb7a50dSMatthew G. Knepley } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()"); 7514f4d763aaSMatthew G. Knepley PetscFunctionReturn(0); 7515f4d763aaSMatthew G. Knepley } 75168e4ac7eaSMatthew G. Knepley 75178e4ac7eaSMatthew G. Knepley /*@ 75188e4ac7eaSMatthew G. Knepley DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution 75198e4ac7eaSMatthew G. Knepley 75208e4ac7eaSMatthew G. Knepley Not collective 75218e4ac7eaSMatthew G. Knepley 75228e4ac7eaSMatthew G. Knepley Input Parameter: 75238e4ac7eaSMatthew G. Knepley . dm - The DM 75248e4ac7eaSMatthew G. Knepley 75258e4ac7eaSMatthew G. Knepley Output Parameter: 75268e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution 75278e4ac7eaSMatthew G. Knepley 75288e4ac7eaSMatthew G. Knepley Level: beginner 75298e4ac7eaSMatthew G. Knepley 75308e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate() 75318e4ac7eaSMatthew G. Knepley @*/ 75328e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural) 75338e4ac7eaSMatthew G. Knepley { 75348e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 75358e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7536534a8f05SLisandro Dalcin PetscValidBoolPointer(useNatural, 2); 75378e4ac7eaSMatthew G. Knepley *useNatural = dm->useNatural; 75388e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 75398e4ac7eaSMatthew G. Knepley } 75408e4ac7eaSMatthew G. Knepley 75418e4ac7eaSMatthew G. Knepley /*@ 75425d3b26e6SMatthew G. Knepley DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution 75438e4ac7eaSMatthew G. Knepley 75448e4ac7eaSMatthew G. Knepley Collective on dm 75458e4ac7eaSMatthew G. Knepley 75468e4ac7eaSMatthew G. Knepley Input Parameters: 75478e4ac7eaSMatthew G. Knepley + dm - The DM 75488e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution 75498e4ac7eaSMatthew G. Knepley 75505d3b26e6SMatthew G. Knepley Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM() 75515d3b26e6SMatthew G. Knepley 75528e4ac7eaSMatthew G. Knepley Level: beginner 75538e4ac7eaSMatthew G. Knepley 75545d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM() 75558e4ac7eaSMatthew G. Knepley @*/ 75568e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural) 75578e4ac7eaSMatthew G. Knepley { 75588e4ac7eaSMatthew G. Knepley PetscFunctionBegin; 75598e4ac7eaSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 75608833efb5SBlaise Bourdin PetscValidLogicalCollectiveBool(dm, useNatural, 2); 75618e4ac7eaSMatthew G. Knepley dm->useNatural = useNatural; 75628e4ac7eaSMatthew G. Knepley PetscFunctionReturn(0); 75638e4ac7eaSMatthew G. Knepley } 7564c58f1c22SToby Isaac 7565c58f1c22SToby Isaac /*@C 7566c58f1c22SToby Isaac DMCreateLabel - Create a label of the given name if it does not already exist 7567c58f1c22SToby Isaac 7568c58f1c22SToby Isaac Not Collective 7569c58f1c22SToby Isaac 7570c58f1c22SToby Isaac Input Parameters: 7571c58f1c22SToby Isaac + dm - The DM object 7572c58f1c22SToby Isaac - name - The label name 7573c58f1c22SToby Isaac 7574c58f1c22SToby Isaac Level: intermediate 7575c58f1c22SToby Isaac 7576c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7577c58f1c22SToby Isaac @*/ 7578c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[]) 7579c58f1c22SToby Isaac { 75805d80c0bfSVaclav Hapla PetscBool flg; 75815d80c0bfSVaclav Hapla DMLabel label; 7582c58f1c22SToby Isaac PetscErrorCode ierr; 7583c58f1c22SToby Isaac 7584c58f1c22SToby Isaac PetscFunctionBegin; 7585c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7586c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 75875d80c0bfSVaclav Hapla ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 7588c58f1c22SToby Isaac if (!flg) { 75895d80c0bfSVaclav Hapla ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 75905d80c0bfSVaclav Hapla ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 75915d80c0bfSVaclav Hapla ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 7592c58f1c22SToby Isaac } 7593c58f1c22SToby Isaac PetscFunctionReturn(0); 7594c58f1c22SToby Isaac } 7595c58f1c22SToby Isaac 7596c58f1c22SToby Isaac /*@C 75970fdc7489SMatthew Knepley DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index. 75980fdc7489SMatthew Knepley 75990fdc7489SMatthew Knepley Not Collective 76000fdc7489SMatthew Knepley 76010fdc7489SMatthew Knepley Input Parameters: 76020fdc7489SMatthew Knepley + dm - The DM object 76030fdc7489SMatthew Knepley . l - The index for the label 76040fdc7489SMatthew Knepley - name - The label name 76050fdc7489SMatthew Knepley 76060fdc7489SMatthew Knepley Level: intermediate 76070fdc7489SMatthew Knepley 76080fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 76090fdc7489SMatthew Knepley @*/ 76100fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[]) 76110fdc7489SMatthew Knepley { 76120fdc7489SMatthew Knepley DMLabelLink orig, prev = NULL; 76130fdc7489SMatthew Knepley DMLabel label; 76140fdc7489SMatthew Knepley PetscInt Nl, m; 76150fdc7489SMatthew Knepley PetscBool flg, match; 76160fdc7489SMatthew Knepley const char *lname; 76170fdc7489SMatthew Knepley PetscErrorCode ierr; 76180fdc7489SMatthew Knepley 76190fdc7489SMatthew Knepley PetscFunctionBegin; 76200fdc7489SMatthew Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7621064a246eSJacob Faibussowitsch PetscValidCharPointer(name, 3); 76220fdc7489SMatthew Knepley ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr); 76230fdc7489SMatthew Knepley if (!flg) { 76240fdc7489SMatthew Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr); 76250fdc7489SMatthew Knepley ierr = DMAddLabel(dm, label);CHKERRQ(ierr); 76260fdc7489SMatthew Knepley ierr = DMLabelDestroy(&label);CHKERRQ(ierr); 76270fdc7489SMatthew Knepley } 76280fdc7489SMatthew Knepley ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr); 76292c71b3e2SJacob Faibussowitsch PetscCheckFalse(l >= Nl,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl); 76300fdc7489SMatthew Knepley for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) { 76310fdc7489SMatthew Knepley ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr); 76320fdc7489SMatthew Knepley ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr); 76330fdc7489SMatthew Knepley if (match) break; 76340fdc7489SMatthew Knepley } 76350fdc7489SMatthew Knepley if (m == l) PetscFunctionReturn(0); 76360fdc7489SMatthew Knepley if (!m) dm->labels = orig->next; 76370fdc7489SMatthew Knepley else prev->next = orig->next; 76380fdc7489SMatthew Knepley if (!l) { 76390fdc7489SMatthew Knepley orig->next = dm->labels; 76400fdc7489SMatthew Knepley dm->labels = orig; 76410fdc7489SMatthew Knepley } else { 76420fdc7489SMatthew Knepley for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next); 76430fdc7489SMatthew Knepley orig->next = prev->next; 76440fdc7489SMatthew Knepley prev->next = orig; 76450fdc7489SMatthew Knepley } 76460fdc7489SMatthew Knepley PetscFunctionReturn(0); 76470fdc7489SMatthew Knepley } 76480fdc7489SMatthew Knepley 76490fdc7489SMatthew Knepley /*@C 7650c58f1c22SToby Isaac DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default 7651c58f1c22SToby Isaac 7652c58f1c22SToby Isaac Not Collective 7653c58f1c22SToby Isaac 7654c58f1c22SToby Isaac Input Parameters: 7655c58f1c22SToby Isaac + dm - The DM object 7656c58f1c22SToby Isaac . name - The label name 7657c58f1c22SToby Isaac - point - The mesh point 7658c58f1c22SToby Isaac 7659c58f1c22SToby Isaac Output Parameter: 7660c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label 7661c58f1c22SToby Isaac 7662c58f1c22SToby Isaac Level: beginner 7663c58f1c22SToby Isaac 7664c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS() 7665c58f1c22SToby Isaac @*/ 7666c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value) 7667c58f1c22SToby Isaac { 7668c58f1c22SToby Isaac DMLabel label; 7669c58f1c22SToby Isaac PetscErrorCode ierr; 7670c58f1c22SToby Isaac 7671c58f1c22SToby Isaac PetscFunctionBegin; 7672c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7673c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7674c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 76752c71b3e2SJacob Faibussowitsch PetscCheckFalse(!label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name); 7676c58f1c22SToby Isaac ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr); 7677c58f1c22SToby Isaac PetscFunctionReturn(0); 7678c58f1c22SToby Isaac } 7679c58f1c22SToby Isaac 7680c58f1c22SToby Isaac /*@C 7681c58f1c22SToby Isaac DMSetLabelValue - Add a point to a Sieve Label with given value 7682c58f1c22SToby Isaac 7683c58f1c22SToby Isaac Not Collective 7684c58f1c22SToby Isaac 7685c58f1c22SToby Isaac Input Parameters: 7686c58f1c22SToby Isaac + dm - The DM object 7687c58f1c22SToby Isaac . name - The label name 7688c58f1c22SToby Isaac . point - The mesh point 7689c58f1c22SToby Isaac - value - The label value for this point 7690c58f1c22SToby Isaac 7691c58f1c22SToby Isaac Output Parameter: 7692c58f1c22SToby Isaac 7693c58f1c22SToby Isaac Level: beginner 7694c58f1c22SToby Isaac 7695c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue() 7696c58f1c22SToby Isaac @*/ 7697c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 7698c58f1c22SToby Isaac { 7699c58f1c22SToby Isaac DMLabel label; 7700c58f1c22SToby Isaac PetscErrorCode ierr; 7701c58f1c22SToby Isaac 7702c58f1c22SToby Isaac PetscFunctionBegin; 7703c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7704c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7705c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7706c58f1c22SToby Isaac if (!label) { 7707c58f1c22SToby Isaac ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 7708c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7709c58f1c22SToby Isaac } 7710c58f1c22SToby Isaac ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr); 7711c58f1c22SToby Isaac PetscFunctionReturn(0); 7712c58f1c22SToby Isaac } 7713c58f1c22SToby Isaac 7714c58f1c22SToby Isaac /*@C 7715c58f1c22SToby Isaac DMClearLabelValue - Remove a point from a Sieve Label with given value 7716c58f1c22SToby Isaac 7717c58f1c22SToby Isaac Not Collective 7718c58f1c22SToby Isaac 7719c58f1c22SToby Isaac Input Parameters: 7720c58f1c22SToby Isaac + dm - The DM object 7721c58f1c22SToby Isaac . name - The label name 7722c58f1c22SToby Isaac . point - The mesh point 7723c58f1c22SToby Isaac - value - The label value for this point 7724c58f1c22SToby Isaac 7725c58f1c22SToby Isaac Output Parameter: 7726c58f1c22SToby Isaac 7727c58f1c22SToby Isaac Level: beginner 7728c58f1c22SToby Isaac 7729c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS() 7730c58f1c22SToby Isaac @*/ 7731c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value) 7732c58f1c22SToby Isaac { 7733c58f1c22SToby Isaac DMLabel label; 7734c58f1c22SToby Isaac PetscErrorCode ierr; 7735c58f1c22SToby Isaac 7736c58f1c22SToby Isaac PetscFunctionBegin; 7737c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7738c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7739c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7740c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7741c58f1c22SToby Isaac ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr); 7742c58f1c22SToby Isaac PetscFunctionReturn(0); 7743c58f1c22SToby Isaac } 7744c58f1c22SToby Isaac 7745c58f1c22SToby Isaac /*@C 7746c58f1c22SToby Isaac DMGetLabelSize - Get the number of different integer ids in a Label 7747c58f1c22SToby Isaac 7748c58f1c22SToby Isaac Not Collective 7749c58f1c22SToby Isaac 7750c58f1c22SToby Isaac Input Parameters: 7751c58f1c22SToby Isaac + dm - The DM object 7752c58f1c22SToby Isaac - name - The label name 7753c58f1c22SToby Isaac 7754c58f1c22SToby Isaac Output Parameter: 7755c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist 7756c58f1c22SToby Isaac 7757c58f1c22SToby Isaac Level: beginner 7758c58f1c22SToby Isaac 7759df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue() 7760c58f1c22SToby Isaac @*/ 7761c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size) 7762c58f1c22SToby Isaac { 7763c58f1c22SToby Isaac DMLabel label; 7764c58f1c22SToby Isaac PetscErrorCode ierr; 7765c58f1c22SToby Isaac 7766c58f1c22SToby Isaac PetscFunctionBegin; 7767c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7768c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7769534a8f05SLisandro Dalcin PetscValidIntPointer(size, 3); 7770c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7771c58f1c22SToby Isaac *size = 0; 7772c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7773c58f1c22SToby Isaac ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr); 7774c58f1c22SToby Isaac PetscFunctionReturn(0); 7775c58f1c22SToby Isaac } 7776c58f1c22SToby Isaac 7777c58f1c22SToby Isaac /*@C 7778c58f1c22SToby Isaac DMGetLabelIdIS - Get the integer ids in a label 7779c58f1c22SToby Isaac 7780c58f1c22SToby Isaac Not Collective 7781c58f1c22SToby Isaac 7782c58f1c22SToby Isaac Input Parameters: 7783c58f1c22SToby Isaac + mesh - The DM object 7784c58f1c22SToby Isaac - name - The label name 7785c58f1c22SToby Isaac 7786c58f1c22SToby Isaac Output Parameter: 7787c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist 7788c58f1c22SToby Isaac 7789c58f1c22SToby Isaac Level: beginner 7790c58f1c22SToby Isaac 7791c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize() 7792c58f1c22SToby Isaac @*/ 7793c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids) 7794c58f1c22SToby Isaac { 7795c58f1c22SToby Isaac DMLabel label; 7796c58f1c22SToby Isaac PetscErrorCode ierr; 7797c58f1c22SToby Isaac 7798c58f1c22SToby Isaac PetscFunctionBegin; 7799c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7800c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7801c58f1c22SToby Isaac PetscValidPointer(ids, 3); 7802c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7803c58f1c22SToby Isaac *ids = NULL; 7804dab2e251SBlaise Bourdin if (label) { 7805c58f1c22SToby Isaac ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr); 7806dab2e251SBlaise Bourdin } else { 7807dab2e251SBlaise Bourdin /* returning an empty IS */ 7808dab2e251SBlaise Bourdin ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr); 7809dab2e251SBlaise Bourdin } 7810c58f1c22SToby Isaac PetscFunctionReturn(0); 7811c58f1c22SToby Isaac } 7812c58f1c22SToby Isaac 7813c58f1c22SToby Isaac /*@C 7814c58f1c22SToby Isaac DMGetStratumSize - Get the number of points in a label stratum 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 - value - The stratum value 7822c58f1c22SToby Isaac 7823c58f1c22SToby Isaac Output Parameter: 7824c58f1c22SToby Isaac . size - The stratum size 7825c58f1c22SToby Isaac 7826c58f1c22SToby Isaac Level: beginner 7827c58f1c22SToby Isaac 7828c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds() 7829c58f1c22SToby Isaac @*/ 7830c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size) 7831c58f1c22SToby Isaac { 7832c58f1c22SToby Isaac DMLabel label; 7833c58f1c22SToby Isaac PetscErrorCode ierr; 7834c58f1c22SToby Isaac 7835c58f1c22SToby Isaac PetscFunctionBegin; 7836c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7837c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7838534a8f05SLisandro Dalcin PetscValidIntPointer(size, 4); 7839c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7840c58f1c22SToby Isaac *size = 0; 7841c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7842c58f1c22SToby Isaac ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr); 7843c58f1c22SToby Isaac PetscFunctionReturn(0); 7844c58f1c22SToby Isaac } 7845c58f1c22SToby Isaac 7846c58f1c22SToby Isaac /*@C 7847c58f1c22SToby Isaac DMGetStratumIS - Get the points in a label stratum 7848c58f1c22SToby Isaac 7849c58f1c22SToby Isaac Not Collective 7850c58f1c22SToby Isaac 7851c58f1c22SToby Isaac Input Parameters: 7852c58f1c22SToby Isaac + dm - The DM object 7853c58f1c22SToby Isaac . name - The label name 7854c58f1c22SToby Isaac - value - The stratum value 7855c58f1c22SToby Isaac 7856c58f1c22SToby Isaac Output Parameter: 7857c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value 7858c58f1c22SToby Isaac 7859c58f1c22SToby Isaac Level: beginner 7860c58f1c22SToby Isaac 7861c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize() 7862c58f1c22SToby Isaac @*/ 7863c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points) 7864c58f1c22SToby Isaac { 7865c58f1c22SToby Isaac DMLabel label; 7866c58f1c22SToby Isaac PetscErrorCode ierr; 7867c58f1c22SToby Isaac 7868c58f1c22SToby Isaac PetscFunctionBegin; 7869c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7870c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7871c58f1c22SToby Isaac PetscValidPointer(points, 4); 7872c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7873c58f1c22SToby Isaac *points = NULL; 7874c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7875c58f1c22SToby Isaac ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr); 7876c58f1c22SToby Isaac PetscFunctionReturn(0); 7877c58f1c22SToby Isaac } 7878c58f1c22SToby Isaac 78794de306b1SToby Isaac /*@C 78809044fa66SMatthew G. Knepley DMSetStratumIS - Set the points in a label stratum 78814de306b1SToby Isaac 78824de306b1SToby Isaac Not Collective 78834de306b1SToby Isaac 78844de306b1SToby Isaac Input Parameters: 78854de306b1SToby Isaac + dm - The DM object 78864de306b1SToby Isaac . name - The label name 78874de306b1SToby Isaac . value - The stratum value 78884de306b1SToby Isaac - points - The stratum points 78894de306b1SToby Isaac 78904de306b1SToby Isaac Level: beginner 78914de306b1SToby Isaac 78924de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize() 78934de306b1SToby Isaac @*/ 78944de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points) 78954de306b1SToby Isaac { 78964de306b1SToby Isaac DMLabel label; 78974de306b1SToby Isaac PetscErrorCode ierr; 78984de306b1SToby Isaac 78994de306b1SToby Isaac PetscFunctionBegin; 79004de306b1SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 79014de306b1SToby Isaac PetscValidCharPointer(name, 2); 79024de306b1SToby Isaac PetscValidPointer(points, 4); 79034de306b1SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 79044de306b1SToby Isaac if (!label) PetscFunctionReturn(0); 79054de306b1SToby Isaac ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr); 79064de306b1SToby Isaac PetscFunctionReturn(0); 79074de306b1SToby Isaac } 79084de306b1SToby Isaac 7909c58f1c22SToby Isaac /*@C 7910c58f1c22SToby Isaac DMClearLabelStratum - Remove all points from a stratum from a Sieve Label 7911c58f1c22SToby Isaac 7912c58f1c22SToby Isaac Not Collective 7913c58f1c22SToby Isaac 7914c58f1c22SToby Isaac Input Parameters: 7915c58f1c22SToby Isaac + dm - The DM object 7916c58f1c22SToby Isaac . name - The label name 7917c58f1c22SToby Isaac - value - The label value for this point 7918c58f1c22SToby Isaac 7919c58f1c22SToby Isaac Output Parameter: 7920c58f1c22SToby Isaac 7921c58f1c22SToby Isaac Level: beginner 7922c58f1c22SToby Isaac 7923c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue() 7924c58f1c22SToby Isaac @*/ 7925c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value) 7926c58f1c22SToby Isaac { 7927c58f1c22SToby Isaac DMLabel label; 7928c58f1c22SToby Isaac PetscErrorCode ierr; 7929c58f1c22SToby Isaac 7930c58f1c22SToby Isaac PetscFunctionBegin; 7931c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7932c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 7933c58f1c22SToby Isaac ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr); 7934c58f1c22SToby Isaac if (!label) PetscFunctionReturn(0); 7935c58f1c22SToby Isaac ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr); 7936c58f1c22SToby Isaac PetscFunctionReturn(0); 7937c58f1c22SToby Isaac } 7938c58f1c22SToby Isaac 7939c58f1c22SToby Isaac /*@ 7940c58f1c22SToby Isaac DMGetNumLabels - Return the number of labels defined by the mesh 7941c58f1c22SToby Isaac 7942c58f1c22SToby Isaac Not Collective 7943c58f1c22SToby Isaac 7944c58f1c22SToby Isaac Input Parameter: 7945c58f1c22SToby Isaac . dm - The DM object 7946c58f1c22SToby Isaac 7947c58f1c22SToby Isaac Output Parameter: 7948c58f1c22SToby Isaac . numLabels - the number of Labels 7949c58f1c22SToby Isaac 7950c58f1c22SToby Isaac Level: intermediate 7951c58f1c22SToby Isaac 7952c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7953c58f1c22SToby Isaac @*/ 7954c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels) 7955c58f1c22SToby Isaac { 79565d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7957c58f1c22SToby Isaac PetscInt n = 0; 7958c58f1c22SToby Isaac 7959c58f1c22SToby Isaac PetscFunctionBegin; 7960c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7961534a8f05SLisandro Dalcin PetscValidIntPointer(numLabels, 2); 7962c58f1c22SToby Isaac while (next) {++n; next = next->next;} 7963c58f1c22SToby Isaac *numLabels = n; 7964c58f1c22SToby Isaac PetscFunctionReturn(0); 7965c58f1c22SToby Isaac } 7966c58f1c22SToby Isaac 7967c58f1c22SToby Isaac /*@C 7968c58f1c22SToby Isaac DMGetLabelName - Return the name of nth label 7969c58f1c22SToby Isaac 7970c58f1c22SToby Isaac Not Collective 7971c58f1c22SToby Isaac 7972c58f1c22SToby Isaac Input Parameters: 7973c58f1c22SToby Isaac + dm - The DM object 7974c58f1c22SToby Isaac - n - the label number 7975c58f1c22SToby Isaac 7976c58f1c22SToby Isaac Output Parameter: 7977c58f1c22SToby Isaac . name - the label name 7978c58f1c22SToby Isaac 7979c58f1c22SToby Isaac Level: intermediate 7980c58f1c22SToby Isaac 7981c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 7982c58f1c22SToby Isaac @*/ 7983c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name) 7984c58f1c22SToby Isaac { 79855d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 7986c58f1c22SToby Isaac PetscInt l = 0; 7987d67d17b1SMatthew G. Knepley PetscErrorCode ierr; 7988c58f1c22SToby Isaac 7989c58f1c22SToby Isaac PetscFunctionBegin; 7990c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 7991c58f1c22SToby Isaac PetscValidPointer(name, 3); 7992c58f1c22SToby Isaac while (next) { 7993c58f1c22SToby Isaac if (l == n) { 7994d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr); 7995c58f1c22SToby Isaac PetscFunctionReturn(0); 7996c58f1c22SToby Isaac } 7997c58f1c22SToby Isaac ++l; 7998c58f1c22SToby Isaac next = next->next; 7999c58f1c22SToby Isaac } 800098921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 8001c58f1c22SToby Isaac } 8002c58f1c22SToby Isaac 8003c58f1c22SToby Isaac /*@C 8004c58f1c22SToby Isaac DMHasLabel - Determine whether the mesh has a label of a given name 8005c58f1c22SToby Isaac 8006c58f1c22SToby Isaac Not Collective 8007c58f1c22SToby Isaac 8008c58f1c22SToby Isaac Input Parameters: 8009c58f1c22SToby Isaac + dm - The DM object 8010c58f1c22SToby Isaac - name - The label name 8011c58f1c22SToby Isaac 8012c58f1c22SToby Isaac Output Parameter: 8013c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present 8014c58f1c22SToby Isaac 8015c58f1c22SToby Isaac Level: intermediate 8016c58f1c22SToby Isaac 8017c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8018c58f1c22SToby Isaac @*/ 8019c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel) 8020c58f1c22SToby Isaac { 80215d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8022d67d17b1SMatthew G. Knepley const char *lname; 8023c58f1c22SToby Isaac PetscErrorCode ierr; 8024c58f1c22SToby Isaac 8025c58f1c22SToby Isaac PetscFunctionBegin; 8026c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8027c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 8028534a8f05SLisandro Dalcin PetscValidBoolPointer(hasLabel, 3); 8029c58f1c22SToby Isaac *hasLabel = PETSC_FALSE; 8030c58f1c22SToby Isaac while (next) { 8031d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8032d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr); 8033c58f1c22SToby Isaac if (*hasLabel) break; 8034c58f1c22SToby Isaac next = next->next; 8035c58f1c22SToby Isaac } 8036c58f1c22SToby Isaac PetscFunctionReturn(0); 8037c58f1c22SToby Isaac } 8038c58f1c22SToby Isaac 8039c58f1c22SToby Isaac /*@C 8040c58f1c22SToby Isaac DMGetLabel - Return the label of a given name, or NULL 8041c58f1c22SToby Isaac 8042c58f1c22SToby Isaac Not Collective 8043c58f1c22SToby Isaac 8044c58f1c22SToby Isaac Input Parameters: 8045c58f1c22SToby Isaac + dm - The DM object 8046c58f1c22SToby Isaac - name - The label name 8047c58f1c22SToby Isaac 8048c58f1c22SToby Isaac Output Parameter: 8049c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 8050c58f1c22SToby Isaac 80516d7c9049SMatthew G. Knepley Note: Some of the default labels in a DMPlex will be 80526d7c9049SMatthew G. Knepley $ "depth" - Holds the depth (co-dimension) of each mesh point 80536d7c9049SMatthew G. Knepley $ "celltype" - Holds the topological type of each cell 80546d7c9049SMatthew G. Knepley $ "ghost" - If the DM is distributed with overlap, this marks the cells and faces in the overlap 80556d7c9049SMatthew G. Knepley $ "Cell Sets" - Mirrors the cell sets defined by GMsh and ExodusII 80566d7c9049SMatthew G. Knepley $ "Face Sets" - Mirrors the face sets defined by GMsh and ExodusII 80576d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh 80586d7c9049SMatthew G. Knepley 8059c58f1c22SToby Isaac Level: intermediate 8060c58f1c22SToby Isaac 80616d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType() 8062c58f1c22SToby Isaac @*/ 8063c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label) 8064c58f1c22SToby Isaac { 80655d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8066c58f1c22SToby Isaac PetscBool hasLabel; 8067d67d17b1SMatthew G. Knepley const char *lname; 8068c58f1c22SToby Isaac PetscErrorCode ierr; 8069c58f1c22SToby Isaac 8070c58f1c22SToby Isaac PetscFunctionBegin; 8071c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8072c58f1c22SToby Isaac PetscValidCharPointer(name, 2); 8073c58f1c22SToby Isaac PetscValidPointer(label, 3); 8074c58f1c22SToby Isaac *label = NULL; 8075c58f1c22SToby Isaac while (next) { 8076d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8077d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 8078c58f1c22SToby Isaac if (hasLabel) { 8079c58f1c22SToby Isaac *label = next->label; 8080c58f1c22SToby Isaac break; 8081c58f1c22SToby Isaac } 8082c58f1c22SToby Isaac next = next->next; 8083c58f1c22SToby Isaac } 8084c58f1c22SToby Isaac PetscFunctionReturn(0); 8085c58f1c22SToby Isaac } 8086c58f1c22SToby Isaac 8087c58f1c22SToby Isaac /*@C 8088c58f1c22SToby Isaac DMGetLabelByNum - Return the nth label 8089c58f1c22SToby Isaac 8090c58f1c22SToby Isaac Not Collective 8091c58f1c22SToby Isaac 8092c58f1c22SToby Isaac Input Parameters: 8093c58f1c22SToby Isaac + dm - The DM object 8094c58f1c22SToby Isaac - n - the label number 8095c58f1c22SToby Isaac 8096c58f1c22SToby Isaac Output Parameter: 8097c58f1c22SToby Isaac . label - the label 8098c58f1c22SToby Isaac 8099c58f1c22SToby Isaac Level: intermediate 8100c58f1c22SToby Isaac 8101c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8102c58f1c22SToby Isaac @*/ 8103c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label) 8104c58f1c22SToby Isaac { 81055d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8106c58f1c22SToby Isaac PetscInt l = 0; 8107c58f1c22SToby Isaac 8108c58f1c22SToby Isaac PetscFunctionBegin; 8109c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8110c58f1c22SToby Isaac PetscValidPointer(label, 3); 8111c58f1c22SToby Isaac while (next) { 8112c58f1c22SToby Isaac if (l == n) { 8113c58f1c22SToby Isaac *label = next->label; 8114c58f1c22SToby Isaac PetscFunctionReturn(0); 8115c58f1c22SToby Isaac } 8116c58f1c22SToby Isaac ++l; 8117c58f1c22SToby Isaac next = next->next; 8118c58f1c22SToby Isaac } 811998921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n); 8120c58f1c22SToby Isaac } 8121c58f1c22SToby Isaac 8122c58f1c22SToby Isaac /*@C 8123c58f1c22SToby Isaac DMAddLabel - Add the label to this mesh 8124c58f1c22SToby Isaac 8125c58f1c22SToby Isaac Not Collective 8126c58f1c22SToby Isaac 8127c58f1c22SToby Isaac Input Parameters: 8128c58f1c22SToby Isaac + dm - The DM object 8129c58f1c22SToby Isaac - label - The DMLabel 8130c58f1c22SToby Isaac 8131c58f1c22SToby Isaac Level: developer 8132c58f1c22SToby Isaac 8133c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8134c58f1c22SToby Isaac @*/ 8135c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label) 8136c58f1c22SToby Isaac { 81375d80c0bfSVaclav Hapla DMLabelLink l, *p, tmpLabel; 8138c58f1c22SToby Isaac PetscBool hasLabel; 8139d67d17b1SMatthew G. Knepley const char *lname; 81405d80c0bfSVaclav Hapla PetscBool flg; 8141c58f1c22SToby Isaac PetscErrorCode ierr; 8142c58f1c22SToby Isaac 8143c58f1c22SToby Isaac PetscFunctionBegin; 8144c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8145d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr); 8146d67d17b1SMatthew G. Knepley ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr); 81472c71b3e2SJacob Faibussowitsch PetscCheckFalse(hasLabel,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname); 8148c58f1c22SToby Isaac ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr); 8149c58f1c22SToby Isaac tmpLabel->label = label; 8150c58f1c22SToby Isaac tmpLabel->output = PETSC_TRUE; 81515d80c0bfSVaclav Hapla for (p=&dm->labels; (l=*p); p=&l->next) {} 81525d80c0bfSVaclav Hapla *p = tmpLabel; 815308f633c4SVaclav Hapla ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr); 81545d80c0bfSVaclav Hapla ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 81555d80c0bfSVaclav Hapla if (flg) dm->depthLabel = label; 8156ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr); 8157ba2698f1SMatthew G. Knepley if (flg) dm->celltypeLabel = label; 8158c58f1c22SToby Isaac PetscFunctionReturn(0); 8159c58f1c22SToby Isaac } 8160c58f1c22SToby Isaac 8161c58f1c22SToby Isaac /*@C 81624a7ee7d0SMatthew G. Knepley DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present 81634a7ee7d0SMatthew G. Knepley 81644a7ee7d0SMatthew G. Knepley Not Collective 81654a7ee7d0SMatthew G. Knepley 81664a7ee7d0SMatthew G. Knepley Input Parameters: 81674a7ee7d0SMatthew G. Knepley + dm - The DM object 81684a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute 81694a7ee7d0SMatthew G. Knepley 81704a7ee7d0SMatthew G. Knepley Note: Some of the default labels in a DMPlex will be 81714a7ee7d0SMatthew G. Knepley $ "depth" - Holds the depth (co-dimension) of each mesh point 81724a7ee7d0SMatthew G. Knepley $ "celltype" - Holds the topological type of each cell 81734a7ee7d0SMatthew G. Knepley $ "ghost" - If the DM is distributed with overlap, this marks the cells and faces in the overlap 81744a7ee7d0SMatthew G. Knepley $ "Cell Sets" - Mirrors the cell sets defined by GMsh and ExodusII 81754a7ee7d0SMatthew G. Knepley $ "Face Sets" - Mirrors the face sets defined by GMsh and ExodusII 81764a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh 81774a7ee7d0SMatthew G. Knepley 81784a7ee7d0SMatthew G. Knepley Level: intermediate 81794a7ee7d0SMatthew G. Knepley 81804a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType() 81814a7ee7d0SMatthew G. Knepley @*/ 81824a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label) 81834a7ee7d0SMatthew G. Knepley { 81844a7ee7d0SMatthew G. Knepley DMLabelLink next = dm->labels; 81854a7ee7d0SMatthew G. Knepley PetscBool hasLabel, flg; 81864a7ee7d0SMatthew G. Knepley const char *name, *lname; 81874a7ee7d0SMatthew G. Knepley PetscErrorCode ierr; 81884a7ee7d0SMatthew G. Knepley 81894a7ee7d0SMatthew G. Knepley PetscFunctionBegin; 81904a7ee7d0SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 81914a7ee7d0SMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 81924a7ee7d0SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr); 81934a7ee7d0SMatthew G. Knepley while (next) { 81944a7ee7d0SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 81954a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 81964a7ee7d0SMatthew G. Knepley if (hasLabel) { 81974a7ee7d0SMatthew G. Knepley ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr); 81984a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr); 81994a7ee7d0SMatthew G. Knepley if (flg) dm->depthLabel = label; 82004a7ee7d0SMatthew G. Knepley ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr); 82014a7ee7d0SMatthew G. Knepley if (flg) dm->celltypeLabel = label; 82024a7ee7d0SMatthew G. Knepley ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr); 82034a7ee7d0SMatthew G. Knepley next->label = label; 82044a7ee7d0SMatthew G. Knepley break; 82054a7ee7d0SMatthew G. Knepley } 82064a7ee7d0SMatthew G. Knepley next = next->next; 82074a7ee7d0SMatthew G. Knepley } 82084a7ee7d0SMatthew G. Knepley PetscFunctionReturn(0); 82094a7ee7d0SMatthew G. Knepley } 82104a7ee7d0SMatthew G. Knepley 82114a7ee7d0SMatthew G. Knepley /*@C 8212e5472504SVaclav Hapla DMRemoveLabel - Remove the label given by name from this mesh 8213c58f1c22SToby Isaac 8214c58f1c22SToby Isaac Not Collective 8215c58f1c22SToby Isaac 8216c58f1c22SToby Isaac Input Parameters: 8217c58f1c22SToby Isaac + dm - The DM object 8218c58f1c22SToby Isaac - name - The label name 8219c58f1c22SToby Isaac 8220c58f1c22SToby Isaac Output Parameter: 8221c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent 8222c58f1c22SToby Isaac 8223c58f1c22SToby Isaac Level: developer 8224c58f1c22SToby Isaac 8225e5472504SVaclav Hapla Notes: 8226e5472504SVaclav Hapla DMRemoveLabel(dm,name,NULL) removes the label from dm and calls 8227e5472504SVaclav Hapla DMLabelDestroy() on the label. 8228e5472504SVaclav Hapla 8229e5472504SVaclav Hapla DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT 8230e5472504SVaclav Hapla call DMLabelDestroy(). Instead, the label is returned and the user is 8231e5472504SVaclav Hapla responsible of calling DMLabelDestroy() at some point. 8232e5472504SVaclav Hapla 8233e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf() 8234c58f1c22SToby Isaac @*/ 8235c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label) 8236c58f1c22SToby Isaac { 823795d578d6SVaclav Hapla DMLabelLink link, *pnext; 8238c58f1c22SToby Isaac PetscBool hasLabel; 8239d67d17b1SMatthew G. Knepley const char *lname; 8240c58f1c22SToby Isaac PetscErrorCode ierr; 8241c58f1c22SToby Isaac 8242c58f1c22SToby Isaac PetscFunctionBegin; 8243c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8244e5472504SVaclav Hapla PetscValidCharPointer(name, 2); 8245e5472504SVaclav Hapla if (label) { 8246e5472504SVaclav Hapla PetscValidPointer(label, 3); 8247c58f1c22SToby Isaac *label = NULL; 8248e5472504SVaclav Hapla } 82495d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 825095d578d6SVaclav Hapla ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr); 8251d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr); 8252c58f1c22SToby Isaac if (hasLabel) { 825395d578d6SVaclav Hapla *pnext = link->next; /* Remove from list */ 8254c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr); 825595d578d6SVaclav Hapla if (hasLabel) dm->depthLabel = NULL; 8256ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr); 8257ba2698f1SMatthew G. Knepley if (hasLabel) dm->celltypeLabel = NULL; 825895d578d6SVaclav Hapla if (label) *label = link->label; 825995d578d6SVaclav Hapla else {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);} 826095d578d6SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 8261c58f1c22SToby Isaac break; 8262c58f1c22SToby Isaac } 8263c58f1c22SToby Isaac } 8264c58f1c22SToby Isaac PetscFunctionReturn(0); 8265c58f1c22SToby Isaac } 8266c58f1c22SToby Isaac 8267306894acSVaclav Hapla /*@ 8268306894acSVaclav Hapla DMRemoveLabelBySelf - Remove the label from this mesh 8269306894acSVaclav Hapla 8270306894acSVaclav Hapla Not Collective 8271306894acSVaclav Hapla 8272306894acSVaclav Hapla Input Parameters: 8273306894acSVaclav Hapla + dm - The DM object 8274876aa926SVaclav Hapla . label - The DMLabel to be removed from the DM 8275306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM? 8276306894acSVaclav Hapla 8277306894acSVaclav Hapla Level: developer 8278306894acSVaclav Hapla 8279306894acSVaclav Hapla Notes: 8280306894acSVaclav Hapla Only exactly the same instance is removed if found, name match is ignored. 8281306894acSVaclav Hapla If the DM has an exclusive reference to the label, it gets destroyed and 8282306894acSVaclav Hapla *label nullified. 8283306894acSVaclav Hapla 8284306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel() 8285306894acSVaclav Hapla @*/ 8286306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound) 8287306894acSVaclav Hapla { 828843e45a93SVaclav Hapla DMLabelLink link, *pnext; 8289306894acSVaclav Hapla PetscBool hasLabel = PETSC_FALSE; 8290306894acSVaclav Hapla PetscErrorCode ierr; 8291306894acSVaclav Hapla 8292306894acSVaclav Hapla PetscFunctionBegin; 8293306894acSVaclav Hapla PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8294306894acSVaclav Hapla PetscValidPointer(label, 2); 8295f39a9ae0SVaclav Hapla if (!*label && !failNotFound) PetscFunctionReturn(0); 8296306894acSVaclav Hapla PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2); 8297306894acSVaclav Hapla PetscValidLogicalCollectiveBool(dm,failNotFound,3); 82985d80c0bfSVaclav Hapla for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) { 829943e45a93SVaclav Hapla if (*label == link->label) { 8300306894acSVaclav Hapla hasLabel = PETSC_TRUE; 830143e45a93SVaclav Hapla *pnext = link->next; /* Remove from list */ 8302306894acSVaclav Hapla if (*label == dm->depthLabel) dm->depthLabel = NULL; 8303ba2698f1SMatthew G. Knepley if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL; 830443e45a93SVaclav Hapla if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */ 830543e45a93SVaclav Hapla ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr); 830643e45a93SVaclav Hapla ierr = PetscFree(link);CHKERRQ(ierr); 8307306894acSVaclav Hapla break; 8308306894acSVaclav Hapla } 8309306894acSVaclav Hapla } 83102c71b3e2SJacob Faibussowitsch PetscCheckFalse(!hasLabel && failNotFound,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM"); 8311306894acSVaclav Hapla PetscFunctionReturn(0); 8312306894acSVaclav Hapla } 8313306894acSVaclav Hapla 8314c58f1c22SToby Isaac /*@C 8315c58f1c22SToby Isaac DMGetLabelOutput - Get the output flag for a given label 8316c58f1c22SToby Isaac 8317c58f1c22SToby Isaac Not Collective 8318c58f1c22SToby Isaac 8319c58f1c22SToby Isaac Input Parameters: 8320c58f1c22SToby Isaac + dm - The DM object 8321c58f1c22SToby Isaac - name - The label name 8322c58f1c22SToby Isaac 8323c58f1c22SToby Isaac Output Parameter: 8324c58f1c22SToby Isaac . output - The flag for output 8325c58f1c22SToby Isaac 8326c58f1c22SToby Isaac Level: developer 8327c58f1c22SToby Isaac 8328c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8329c58f1c22SToby Isaac @*/ 8330c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output) 8331c58f1c22SToby Isaac { 83325d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8333d67d17b1SMatthew G. Knepley const char *lname; 8334c58f1c22SToby Isaac PetscErrorCode ierr; 8335c58f1c22SToby Isaac 8336c58f1c22SToby Isaac PetscFunctionBegin; 8337c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8338c58f1c22SToby Isaac PetscValidPointer(name, 2); 8339c58f1c22SToby Isaac PetscValidPointer(output, 3); 8340c58f1c22SToby Isaac while (next) { 8341c58f1c22SToby Isaac PetscBool flg; 8342c58f1c22SToby Isaac 8343d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8344d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 8345c58f1c22SToby Isaac if (flg) {*output = next->output; PetscFunctionReturn(0);} 8346c58f1c22SToby Isaac next = next->next; 8347c58f1c22SToby Isaac } 834898921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 8349c58f1c22SToby Isaac } 8350c58f1c22SToby Isaac 8351c58f1c22SToby Isaac /*@C 8352c58f1c22SToby Isaac DMSetLabelOutput - Set the output flag for a given label 8353c58f1c22SToby Isaac 8354c58f1c22SToby Isaac Not Collective 8355c58f1c22SToby Isaac 8356c58f1c22SToby Isaac Input Parameters: 8357c58f1c22SToby Isaac + dm - The DM object 8358c58f1c22SToby Isaac . name - The label name 8359c58f1c22SToby Isaac - output - The flag for output 8360c58f1c22SToby Isaac 8361c58f1c22SToby Isaac Level: developer 8362c58f1c22SToby Isaac 8363c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS() 8364c58f1c22SToby Isaac @*/ 8365c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output) 8366c58f1c22SToby Isaac { 83675d80c0bfSVaclav Hapla DMLabelLink next = dm->labels; 8368d67d17b1SMatthew G. Knepley const char *lname; 8369c58f1c22SToby Isaac PetscErrorCode ierr; 8370c58f1c22SToby Isaac 8371c58f1c22SToby Isaac PetscFunctionBegin; 8372c58f1c22SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8373534a8f05SLisandro Dalcin PetscValidCharPointer(name, 2); 8374c58f1c22SToby Isaac while (next) { 8375c58f1c22SToby Isaac PetscBool flg; 8376c58f1c22SToby Isaac 8377d67d17b1SMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr); 8378d67d17b1SMatthew G. Knepley ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr); 8379c58f1c22SToby Isaac if (flg) {next->output = output; PetscFunctionReturn(0);} 8380c58f1c22SToby Isaac next = next->next; 8381c58f1c22SToby Isaac } 838298921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name); 8383c58f1c22SToby Isaac } 8384c58f1c22SToby Isaac 8385c58f1c22SToby Isaac /*@ 8386c58f1c22SToby Isaac DMCopyLabels - Copy labels from one mesh to another with a superset of the points 8387c58f1c22SToby Isaac 8388d083f849SBarry Smith Collective on dmA 8389c58f1c22SToby Isaac 8390d8d19677SJose E. Roman Input Parameters: 83915d80c0bfSVaclav Hapla + dmA - The DM object with initial labels 83922cbb9b06SVaclav Hapla . dmB - The DM object to which labels are copied 83935d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES) 83942cbb9b06SVaclav Hapla . all - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE) 83952cbb9b06SVaclav Hapla - emode - How to behave when a DMLabel in the source and destination DMs with the same name is encountered (see DMCopyLabelsMode) 8396c58f1c22SToby Isaac 8397c58f1c22SToby Isaac Level: intermediate 8398c58f1c22SToby Isaac 83992cbb9b06SVaclav Hapla Notes: 84002cbb9b06SVaclav Hapla This is typically used when interpolating or otherwise adding to a mesh, or testing. 8401c58f1c22SToby Isaac 84022cbb9b06SVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode 8403c58f1c22SToby Isaac @*/ 84042cbb9b06SVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all, DMCopyLabelsMode emode) 8405c58f1c22SToby Isaac { 84062cbb9b06SVaclav Hapla DMLabel label, labelNew, labelOld; 8407c58f1c22SToby Isaac const char *name; 8408c58f1c22SToby Isaac PetscBool flg; 84095d80c0bfSVaclav Hapla DMLabelLink link; 84105d80c0bfSVaclav Hapla PetscErrorCode ierr; 8411c58f1c22SToby Isaac 84125d80c0bfSVaclav Hapla PetscFunctionBegin; 84135d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmA, DM_CLASSID, 1); 84145d80c0bfSVaclav Hapla PetscValidHeaderSpecific(dmB, DM_CLASSID, 2); 84155d80c0bfSVaclav Hapla PetscValidLogicalCollectiveEnum(dmA, mode,3); 84165d80c0bfSVaclav Hapla PetscValidLogicalCollectiveBool(dmA, all, 4); 84172c71b3e2SJacob Faibussowitsch PetscCheckFalse(mode==PETSC_USE_POINTER,PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects"); 84185d80c0bfSVaclav Hapla if (dmA == dmB) PetscFunctionReturn(0); 84195d80c0bfSVaclav Hapla for (link=dmA->labels; link; link=link->next) { 84205d80c0bfSVaclav Hapla label=link->label; 84215d80c0bfSVaclav Hapla ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr); 84225d80c0bfSVaclav Hapla if (!all) { 8423c58f1c22SToby Isaac ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr); 8424c58f1c22SToby Isaac if (flg) continue; 84257d5acc75SStefano Zampini ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr); 84267d5acc75SStefano Zampini if (flg) continue; 8427ba2698f1SMatthew G. Knepley ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr); 8428ba2698f1SMatthew G. Knepley if (flg) continue; 84295d80c0bfSVaclav Hapla } 84302cbb9b06SVaclav Hapla ierr = DMGetLabel(dmB, name, &labelOld);CHKERRQ(ierr); 84312cbb9b06SVaclav Hapla if (labelOld) { 84322cbb9b06SVaclav Hapla switch (emode) { 84332cbb9b06SVaclav Hapla case DM_COPY_LABELS_KEEP: 84342cbb9b06SVaclav Hapla continue; 84352cbb9b06SVaclav Hapla case DM_COPY_LABELS_REPLACE: 84362cbb9b06SVaclav Hapla ierr = DMRemoveLabelBySelf(dmB, &labelOld, PETSC_TRUE);CHKERRQ(ierr); 84372cbb9b06SVaclav Hapla break; 84382cbb9b06SVaclav Hapla case DM_COPY_LABELS_FAIL: 843998921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in destination DM", name); 84402cbb9b06SVaclav Hapla default: 844198921bdaSJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Unhandled DMCopyLabelsMode %d", emode); 84422cbb9b06SVaclav Hapla } 84432cbb9b06SVaclav Hapla } 84445d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) { 8445c58f1c22SToby Isaac ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr); 84465d80c0bfSVaclav Hapla } else { 84475d80c0bfSVaclav Hapla labelNew = label; 84485d80c0bfSVaclav Hapla } 8449c58f1c22SToby Isaac ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr); 84505d80c0bfSVaclav Hapla if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);} 8451c58f1c22SToby Isaac } 8452c58f1c22SToby Isaac PetscFunctionReturn(0); 8453c58f1c22SToby Isaac } 8454461a15a0SLisandro Dalcin 8455609dae6eSVaclav Hapla /*@C 8456609dae6eSVaclav Hapla DMCompareLabels - Compare labels of two DMPlex meshes 8457609dae6eSVaclav Hapla 84585efe38ccSVaclav Hapla Collective 8459609dae6eSVaclav Hapla 8460609dae6eSVaclav Hapla Input Parameters: 8461609dae6eSVaclav Hapla + dm0 - First DM object 8462609dae6eSVaclav Hapla - dm1 - Second DM object 8463609dae6eSVaclav Hapla 8464609dae6eSVaclav Hapla Output Parameters 84655efe38ccSVaclav Hapla + equal - (Optional) Flag whether labels of dm0 and dm1 are the same 8466609dae6eSVaclav Hapla - message - (Optional) Message describing the difference, or NULL if there is no difference 8467609dae6eSVaclav Hapla 8468609dae6eSVaclav Hapla Level: intermediate 8469609dae6eSVaclav Hapla 8470609dae6eSVaclav Hapla Notes: 84715efe38ccSVaclav Hapla The output flag equal is the same on all processes. 84725efe38ccSVaclav Hapla If it is passed as NULL and difference is found, an error is thrown on all processes. 84735efe38ccSVaclav Hapla Make sure to pass NULL on all processes. 8474609dae6eSVaclav Hapla 84755efe38ccSVaclav Hapla The output message is set independently on each rank. 84765efe38ccSVaclav Hapla It is set to NULL if no difference was found on the current rank. It must be freed by user. 84775efe38ccSVaclav Hapla If message is passed as NULL and difference is found, the difference description is printed to stderr in synchronized manner. 84785efe38ccSVaclav Hapla Make sure to pass NULL on all processes. 8479609dae6eSVaclav Hapla 8480609dae6eSVaclav Hapla Labels are matched by name. If the number of labels and their names are equal, 8481609dae6eSVaclav Hapla DMLabelCompare() is used to compare each pair of labels with the same name. 8482609dae6eSVaclav Hapla 8483609dae6eSVaclav Hapla Fortran Notes: 8484609dae6eSVaclav Hapla This function is currently not available from Fortran. 8485609dae6eSVaclav Hapla 8486609dae6eSVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode, DMLabelCompare() 8487609dae6eSVaclav Hapla @*/ 84885efe38ccSVaclav Hapla PetscErrorCode DMCompareLabels(DM dm0, DM dm1, PetscBool *equal, char **message) 8489609dae6eSVaclav Hapla { 84905efe38ccSVaclav Hapla PetscInt n, i; 8491609dae6eSVaclav Hapla char msg[PETSC_MAX_PATH_LEN] = ""; 84925efe38ccSVaclav Hapla PetscBool eq; 8493609dae6eSVaclav Hapla MPI_Comm comm; 84945efe38ccSVaclav Hapla PetscMPIInt rank; 8495609dae6eSVaclav Hapla PetscErrorCode ierr; 8496609dae6eSVaclav Hapla 8497609dae6eSVaclav Hapla PetscFunctionBegin; 8498609dae6eSVaclav Hapla PetscValidHeaderSpecific(dm0,DM_CLASSID,1); 8499609dae6eSVaclav Hapla PetscValidHeaderSpecific(dm1,DM_CLASSID,2); 8500609dae6eSVaclav Hapla PetscCheckSameComm(dm0,1,dm1,2); 85015efe38ccSVaclav Hapla if (equal) PetscValidBoolPointer(equal,3); 8502609dae6eSVaclav Hapla if (message) PetscValidPointer(message, 4); 8503609dae6eSVaclav Hapla ierr = PetscObjectGetComm((PetscObject)dm0, &comm);CHKERRQ(ierr); 85045efe38ccSVaclav Hapla ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 85055efe38ccSVaclav Hapla { 85065efe38ccSVaclav Hapla PetscInt n1; 85075efe38ccSVaclav Hapla 85085efe38ccSVaclav Hapla ierr = DMGetNumLabels(dm0, &n);CHKERRQ(ierr); 8509609dae6eSVaclav Hapla ierr = DMGetNumLabels(dm1, &n1);CHKERRQ(ierr); 85105efe38ccSVaclav Hapla eq = (PetscBool) (n == n1); 85115efe38ccSVaclav Hapla if (!eq) { 85125efe38ccSVaclav Hapla ierr = PetscSNPrintf(msg, sizeof(msg), "Number of labels in dm0 = %D != %D = Number of labels in dm1", n, n1);CHKERRQ(ierr); 8513609dae6eSVaclav Hapla } 85145efe38ccSVaclav Hapla ierr = MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 85155efe38ccSVaclav Hapla if (!eq) goto finish; 85165efe38ccSVaclav Hapla } 85175efe38ccSVaclav Hapla for (i=0; i<n; i++) { 8518609dae6eSVaclav Hapla DMLabel l0, l1; 8519609dae6eSVaclav Hapla const char *name; 8520609dae6eSVaclav Hapla char *msgInner; 8521609dae6eSVaclav Hapla 8522609dae6eSVaclav Hapla /* Ignore label order */ 8523609dae6eSVaclav Hapla ierr = DMGetLabelByNum(dm0, i, &l0);CHKERRQ(ierr); 8524609dae6eSVaclav Hapla ierr = PetscObjectGetName((PetscObject)l0, &name);CHKERRQ(ierr); 8525609dae6eSVaclav Hapla ierr = DMGetLabel(dm1, name, &l1);CHKERRQ(ierr); 8526609dae6eSVaclav Hapla if (!l1) { 8527609dae6eSVaclav Hapla ierr = PetscSNPrintf(msg, sizeof(msg), "Label \"%s\" (#%D in dm0) not found in dm1", name, i);CHKERRQ(ierr); 85285efe38ccSVaclav Hapla eq = PETSC_FALSE; 85295efe38ccSVaclav Hapla break; 8530609dae6eSVaclav Hapla } 85315efe38ccSVaclav Hapla ierr = DMLabelCompare(comm, l0, l1, &eq, &msgInner);CHKERRQ(ierr); 8532609dae6eSVaclav Hapla ierr = PetscStrncpy(msg, msgInner, sizeof(msg));CHKERRQ(ierr); 8533609dae6eSVaclav Hapla ierr = PetscFree(msgInner);CHKERRQ(ierr); 85345efe38ccSVaclav Hapla if (!eq) break; 8535609dae6eSVaclav Hapla } 85365efe38ccSVaclav Hapla ierr = MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 8537609dae6eSVaclav Hapla finish: 85385efe38ccSVaclav Hapla /* If message output arg not set, print to stderr */ 8539609dae6eSVaclav Hapla if (message) { 8540609dae6eSVaclav Hapla *message = NULL; 8541609dae6eSVaclav Hapla if (msg[0]) { 8542609dae6eSVaclav Hapla ierr = PetscStrallocpy(msg, message);CHKERRQ(ierr); 8543609dae6eSVaclav Hapla } 85445efe38ccSVaclav Hapla } else { 85455efe38ccSVaclav Hapla if (msg[0]) { 85465efe38ccSVaclav Hapla ierr = PetscSynchronizedFPrintf(comm, PETSC_STDERR, "[%d] %s\n", rank, msg);CHKERRQ(ierr); 8547609dae6eSVaclav Hapla } 85485efe38ccSVaclav Hapla ierr = PetscSynchronizedFlush(comm, PETSC_STDERR);CHKERRQ(ierr); 85495efe38ccSVaclav Hapla } 85505efe38ccSVaclav Hapla /* If same output arg not ser and labels are not equal, throw error */ 85515efe38ccSVaclav Hapla if (equal) *equal = eq; 85522c71b3e2SJacob Faibussowitsch else PetscCheckFalse(!eq,comm, PETSC_ERR_ARG_INCOMP, "DMLabels are not the same in dm0 and dm1"); 8553609dae6eSVaclav Hapla PetscFunctionReturn(0); 8554609dae6eSVaclav Hapla } 8555609dae6eSVaclav Hapla 8556461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value) 8557461a15a0SLisandro Dalcin { 8558461a15a0SLisandro Dalcin PetscErrorCode ierr; 8559609dae6eSVaclav Hapla 8560461a15a0SLisandro Dalcin PetscFunctionBegin; 8561461a15a0SLisandro Dalcin PetscValidPointer(label,2); 8562461a15a0SLisandro Dalcin if (!*label) { 8563461a15a0SLisandro Dalcin ierr = DMCreateLabel(dm, name);CHKERRQ(ierr); 8564461a15a0SLisandro Dalcin ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr); 8565461a15a0SLisandro Dalcin } 8566461a15a0SLisandro Dalcin ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr); 8567461a15a0SLisandro Dalcin PetscFunctionReturn(0); 8568461a15a0SLisandro Dalcin } 8569461a15a0SLisandro Dalcin 85700fdc7489SMatthew Knepley /* 85710fdc7489SMatthew Knepley Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would 85720fdc7489SMatthew Knepley like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every 85730fdc7489SMatthew Knepley (label, id) pair in the DM. 85740fdc7489SMatthew Knepley 85750fdc7489SMatthew Knepley However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to 85760fdc7489SMatthew Knepley each label. 85770fdc7489SMatthew Knepley */ 85780fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal) 85790fdc7489SMatthew Knepley { 85800fdc7489SMatthew Knepley DMUniversalLabel ul; 85810fdc7489SMatthew Knepley PetscBool *active; 85820fdc7489SMatthew Knepley PetscInt pStart, pEnd, p, Nl, l, m; 85830fdc7489SMatthew Knepley PetscErrorCode ierr; 85840fdc7489SMatthew Knepley 85850fdc7489SMatthew Knepley PetscFunctionBegin; 85860fdc7489SMatthew Knepley ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr); 85870fdc7489SMatthew Knepley ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr); 85880fdc7489SMatthew Knepley ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr); 85890fdc7489SMatthew Knepley ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr); 85900fdc7489SMatthew Knepley ul->Nl = 0; 85910fdc7489SMatthew Knepley for (l = 0; l < Nl; ++l) { 85920fdc7489SMatthew Knepley PetscBool isdepth, iscelltype; 85930fdc7489SMatthew Knepley const char *name; 85940fdc7489SMatthew Knepley 85950fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr); 85960fdc7489SMatthew Knepley ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr); 85970fdc7489SMatthew Knepley ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr); 85980fdc7489SMatthew Knepley active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE; 85990fdc7489SMatthew Knepley if (active[l]) ++ul->Nl; 86000fdc7489SMatthew Knepley } 86010fdc7489SMatthew 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); 86020fdc7489SMatthew Knepley ul->Nv = 0; 86030fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 86040fdc7489SMatthew Knepley DMLabel label; 86050fdc7489SMatthew Knepley PetscInt nv; 86060fdc7489SMatthew Knepley const char *name; 86070fdc7489SMatthew Knepley 86080fdc7489SMatthew Knepley if (!active[l]) continue; 86090fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr); 86100fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 86110fdc7489SMatthew Knepley ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr); 86120fdc7489SMatthew Knepley ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr); 86130fdc7489SMatthew Knepley ul->indices[m] = l; 86140fdc7489SMatthew Knepley ul->Nv += nv; 86150fdc7489SMatthew Knepley ul->offsets[m+1] = nv; 86160fdc7489SMatthew Knepley ul->bits[m+1] = PetscCeilReal(PetscLog2Real(nv+1)); 86170fdc7489SMatthew Knepley ++m; 86180fdc7489SMatthew Knepley } 86190fdc7489SMatthew Knepley for (l = 1; l <= ul->Nl; ++l) { 86200fdc7489SMatthew Knepley ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l]; 86210fdc7489SMatthew Knepley ul->bits[l] = ul->bits[l-1] + ul->bits[l]; 86220fdc7489SMatthew Knepley } 86230fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 86240fdc7489SMatthew Knepley PetscInt b; 86250fdc7489SMatthew Knepley 86260fdc7489SMatthew Knepley ul->masks[l] = 0; 86270fdc7489SMatthew Knepley for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b; 86280fdc7489SMatthew Knepley } 86290fdc7489SMatthew Knepley ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr); 86300fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 86310fdc7489SMatthew Knepley DMLabel label; 86320fdc7489SMatthew Knepley IS valueIS; 86330fdc7489SMatthew Knepley const PetscInt *varr; 86340fdc7489SMatthew Knepley PetscInt nv, v; 86350fdc7489SMatthew Knepley 86360fdc7489SMatthew Knepley if (!active[l]) continue; 86370fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 86380fdc7489SMatthew Knepley ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr); 86390fdc7489SMatthew Knepley ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr); 86400fdc7489SMatthew Knepley ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr); 86410fdc7489SMatthew Knepley for (v = 0; v < nv; ++v) { 86420fdc7489SMatthew Knepley ul->values[ul->offsets[m]+v] = varr[v]; 86430fdc7489SMatthew Knepley } 86440fdc7489SMatthew Knepley ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr); 86450fdc7489SMatthew Knepley ierr = ISDestroy(&valueIS);CHKERRQ(ierr); 86460fdc7489SMatthew Knepley ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr); 86470fdc7489SMatthew Knepley ++m; 86480fdc7489SMatthew Knepley } 86490fdc7489SMatthew Knepley ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr); 86500fdc7489SMatthew Knepley for (p = pStart; p < pEnd; ++p) { 86510fdc7489SMatthew Knepley PetscInt uval = 0; 86520fdc7489SMatthew Knepley PetscBool marked = PETSC_FALSE; 86530fdc7489SMatthew Knepley 86540fdc7489SMatthew Knepley for (l = 0, m = 0; l < Nl; ++l) { 86550fdc7489SMatthew Knepley DMLabel label; 86560649b39aSStefano Zampini PetscInt val, defval, loc, nv; 86570fdc7489SMatthew Knepley 86580fdc7489SMatthew Knepley if (!active[l]) continue; 86590fdc7489SMatthew Knepley ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr); 86600fdc7489SMatthew Knepley ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr); 86610fdc7489SMatthew Knepley ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr); 86620fdc7489SMatthew Knepley if (val == defval) {++m; continue;} 86630649b39aSStefano Zampini nv = ul->offsets[m+1]-ul->offsets[m]; 86640fdc7489SMatthew Knepley marked = PETSC_TRUE; 86650fdc7489SMatthew Knepley ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr); 86662c71b3e2SJacob Faibussowitsch PetscCheckFalse(loc < 0,PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val); 86670fdc7489SMatthew Knepley uval += (loc+1) << ul->bits[m]; 86680fdc7489SMatthew Knepley ++m; 86690fdc7489SMatthew Knepley } 86700fdc7489SMatthew Knepley if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);} 86710fdc7489SMatthew Knepley } 86720fdc7489SMatthew Knepley ierr = PetscFree(active);CHKERRQ(ierr); 86730fdc7489SMatthew Knepley *universal = ul; 86740fdc7489SMatthew Knepley PetscFunctionReturn(0); 86750fdc7489SMatthew Knepley } 86760fdc7489SMatthew Knepley 86770fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal) 86780fdc7489SMatthew Knepley { 86790fdc7489SMatthew Knepley PetscInt l; 86800fdc7489SMatthew Knepley PetscErrorCode ierr; 86810fdc7489SMatthew Knepley 86820fdc7489SMatthew Knepley PetscFunctionBegin; 86830fdc7489SMatthew Knepley for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);} 86840fdc7489SMatthew Knepley ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr); 86850fdc7489SMatthew Knepley ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr); 86860fdc7489SMatthew Knepley ierr = PetscFree((*universal)->values);CHKERRQ(ierr); 86870fdc7489SMatthew Knepley ierr = PetscFree(*universal);CHKERRQ(ierr); 86880fdc7489SMatthew Knepley *universal = NULL; 86890fdc7489SMatthew Knepley PetscFunctionReturn(0); 86900fdc7489SMatthew Knepley } 86910fdc7489SMatthew Knepley 86920fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel) 86930fdc7489SMatthew Knepley { 86940fdc7489SMatthew Knepley PetscFunctionBegin; 86950fdc7489SMatthew Knepley PetscValidPointer(ulabel, 2); 86960fdc7489SMatthew Knepley *ulabel = ul->label; 86970fdc7489SMatthew Knepley PetscFunctionReturn(0); 86980fdc7489SMatthew Knepley } 86990fdc7489SMatthew Knepley 87000fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm) 87010fdc7489SMatthew Knepley { 87020fdc7489SMatthew Knepley PetscInt Nl = ul->Nl, l; 87030fdc7489SMatthew Knepley PetscErrorCode ierr; 87040fdc7489SMatthew Knepley 87050fdc7489SMatthew Knepley PetscFunctionBegin; 8706064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(dm, DM_CLASSID, 3); 87070fdc7489SMatthew Knepley for (l = 0; l < Nl; ++l) { 87080fdc7489SMatthew Knepley if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);} 87090fdc7489SMatthew Knepley else {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);} 87100fdc7489SMatthew Knepley } 87110fdc7489SMatthew Knepley if (preserveOrder) { 87120fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 87130fdc7489SMatthew Knepley const char *name; 87140fdc7489SMatthew Knepley PetscBool match; 87150fdc7489SMatthew Knepley 87160fdc7489SMatthew Knepley ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr); 87170fdc7489SMatthew Knepley ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr); 87182c71b3e2SJacob Faibussowitsch PetscCheckFalse(!match,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]); 87190fdc7489SMatthew Knepley } 87200fdc7489SMatthew Knepley } 87210fdc7489SMatthew Knepley PetscFunctionReturn(0); 87220fdc7489SMatthew Knepley } 87230fdc7489SMatthew Knepley 87240fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value) 87250fdc7489SMatthew Knepley { 87260fdc7489SMatthew Knepley PetscInt l; 87270fdc7489SMatthew Knepley PetscErrorCode ierr; 87280fdc7489SMatthew Knepley 87290fdc7489SMatthew Knepley PetscFunctionBegin; 87300fdc7489SMatthew Knepley for (l = 0; l < ul->Nl; ++l) { 87310fdc7489SMatthew Knepley DMLabel label; 87320fdc7489SMatthew Knepley PetscInt lval = (value & ul->masks[l]) >> ul->bits[l]; 87330fdc7489SMatthew Knepley 87340fdc7489SMatthew Knepley if (lval) { 87350fdc7489SMatthew Knepley if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);} 87360fdc7489SMatthew Knepley else {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);} 87370fdc7489SMatthew Knepley ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr); 87380fdc7489SMatthew Knepley } 87390fdc7489SMatthew Knepley } 87400fdc7489SMatthew Knepley PetscFunctionReturn(0); 87410fdc7489SMatthew Knepley } 8742a8fb8f29SToby Isaac 8743a8fb8f29SToby Isaac /*@ 8744a8fb8f29SToby Isaac DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement 8745a8fb8f29SToby Isaac 8746a8fb8f29SToby Isaac Input Parameter: 8747a8fb8f29SToby Isaac . dm - The DM object 8748a8fb8f29SToby Isaac 8749a8fb8f29SToby Isaac Output Parameter: 8750a8fb8f29SToby Isaac . cdm - The coarse DM 8751a8fb8f29SToby Isaac 8752a8fb8f29SToby Isaac Level: intermediate 8753a8fb8f29SToby Isaac 8754a8fb8f29SToby Isaac .seealso: DMSetCoarseDM() 8755a8fb8f29SToby Isaac @*/ 8756a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm) 8757a8fb8f29SToby Isaac { 8758a8fb8f29SToby Isaac PetscFunctionBegin; 8759a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8760a8fb8f29SToby Isaac PetscValidPointer(cdm, 2); 8761a8fb8f29SToby Isaac *cdm = dm->coarseMesh; 8762a8fb8f29SToby Isaac PetscFunctionReturn(0); 8763a8fb8f29SToby Isaac } 8764a8fb8f29SToby Isaac 8765a8fb8f29SToby Isaac /*@ 8766a8fb8f29SToby Isaac DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement 8767a8fb8f29SToby Isaac 8768a8fb8f29SToby Isaac Input Parameters: 8769a8fb8f29SToby Isaac + dm - The DM object 8770a8fb8f29SToby Isaac - cdm - The coarse DM 8771a8fb8f29SToby Isaac 8772a8fb8f29SToby Isaac Level: intermediate 8773a8fb8f29SToby Isaac 8774a8fb8f29SToby Isaac .seealso: DMGetCoarseDM() 8775a8fb8f29SToby Isaac @*/ 8776a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm) 8777a8fb8f29SToby Isaac { 8778a8fb8f29SToby Isaac PetscErrorCode ierr; 8779a8fb8f29SToby Isaac 8780a8fb8f29SToby Isaac PetscFunctionBegin; 8781a8fb8f29SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8782a8fb8f29SToby Isaac if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2); 8783a8fb8f29SToby Isaac ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr); 8784a8fb8f29SToby Isaac ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr); 8785a8fb8f29SToby Isaac dm->coarseMesh = cdm; 8786a8fb8f29SToby Isaac PetscFunctionReturn(0); 8787a8fb8f29SToby Isaac } 8788a8fb8f29SToby Isaac 878988bdff64SToby Isaac /*@ 879088bdff64SToby Isaac DMGetFineDM - Get the fine mesh from which this was obtained by refinement 879188bdff64SToby Isaac 879288bdff64SToby Isaac Input Parameter: 879388bdff64SToby Isaac . dm - The DM object 879488bdff64SToby Isaac 879588bdff64SToby Isaac Output Parameter: 879688bdff64SToby Isaac . fdm - The fine DM 879788bdff64SToby Isaac 879888bdff64SToby Isaac Level: intermediate 879988bdff64SToby Isaac 880088bdff64SToby Isaac .seealso: DMSetFineDM() 880188bdff64SToby Isaac @*/ 880288bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm) 880388bdff64SToby Isaac { 880488bdff64SToby Isaac PetscFunctionBegin; 880588bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 880688bdff64SToby Isaac PetscValidPointer(fdm, 2); 880788bdff64SToby Isaac *fdm = dm->fineMesh; 880888bdff64SToby Isaac PetscFunctionReturn(0); 880988bdff64SToby Isaac } 881088bdff64SToby Isaac 881188bdff64SToby Isaac /*@ 881288bdff64SToby Isaac DMSetFineDM - Set the fine mesh from which this was obtained by refinement 881388bdff64SToby Isaac 881488bdff64SToby Isaac Input Parameters: 881588bdff64SToby Isaac + dm - The DM object 881688bdff64SToby Isaac - fdm - The fine DM 881788bdff64SToby Isaac 881888bdff64SToby Isaac Level: intermediate 881988bdff64SToby Isaac 882088bdff64SToby Isaac .seealso: DMGetFineDM() 882188bdff64SToby Isaac @*/ 882288bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm) 882388bdff64SToby Isaac { 882488bdff64SToby Isaac PetscErrorCode ierr; 882588bdff64SToby Isaac 882688bdff64SToby Isaac PetscFunctionBegin; 882788bdff64SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 882888bdff64SToby Isaac if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2); 882988bdff64SToby Isaac ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr); 883088bdff64SToby Isaac ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr); 883188bdff64SToby Isaac dm->fineMesh = fdm; 883288bdff64SToby Isaac PetscFunctionReturn(0); 883388bdff64SToby Isaac } 883488bdff64SToby Isaac 8835a6ba4734SToby Isaac /*=== DMBoundary code ===*/ 8836a6ba4734SToby Isaac 8837a6ba4734SToby Isaac /*@C 8838a6ba4734SToby Isaac DMAddBoundary - Add a boundary condition to the model 8839a6ba4734SToby Isaac 8840783e2ec8SMatthew G. Knepley Collective on dm 8841783e2ec8SMatthew G. Knepley 8842a6ba4734SToby Isaac Input Parameters: 88434c258f51SMatthew G. Knepley + dm - The DM, with a PetscDS that matches the problem being constrained 8844f971fd6bSMatthew G. Knepley . type - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 8845a6ba4734SToby Isaac . name - The BC name 884645480ffeSMatthew G. Knepley . label - The label defining constrained points 884745480ffeSMatthew G. Knepley . Nv - The number of DMLabel values for constrained points 884845480ffeSMatthew G. Knepley . values - An array of values for constrained points 8849a6ba4734SToby Isaac . field - The field to constrain 885045480ffeSMatthew G. Knepley . Nc - The number of constrained field components (0 will constrain all fields) 8851a6ba4734SToby Isaac . comps - An array of constrained component numbers 8852a6ba4734SToby Isaac . bcFunc - A pointwise function giving boundary values 885356cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL 8854a6ba4734SToby Isaac - ctx - An optional user context for bcFunc 8855a6ba4734SToby Isaac 885645480ffeSMatthew G. Knepley Output Parameter: 885745480ffeSMatthew G. Knepley . bd - (Optional) Boundary number 885845480ffeSMatthew G. Knepley 8859a6ba4734SToby Isaac Options Database Keys: 8860a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 8861a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 8862a6ba4734SToby Isaac 886356cf3b9cSMatthew G. Knepley Note: 886456cf3b9cSMatthew 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: 886556cf3b9cSMatthew G. Knepley 886656cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[]) 886756cf3b9cSMatthew G. Knepley 886856cf3b9cSMatthew G. Knepley If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is: 886956cf3b9cSMatthew G. Knepley 887056cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux, 887156cf3b9cSMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 887256cf3b9cSMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 887356cf3b9cSMatthew G. Knepley $ PetscReal time, const PetscReal x[], PetscScalar bcval[]) 887456cf3b9cSMatthew G. Knepley 887556cf3b9cSMatthew G. Knepley + dim - the spatial dimension 887656cf3b9cSMatthew G. Knepley . Nf - the number of fields 887756cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 887856cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 887956cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point 888056cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 888156cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 888256cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 888356cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 888456cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point 888556cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 888656cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 888756cf3b9cSMatthew G. Knepley . t - current time 888856cf3b9cSMatthew G. Knepley . x - coordinates of the current point 888956cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters 889056cf3b9cSMatthew G. Knepley . constants - constant parameters 889156cf3b9cSMatthew G. Knepley - bcval - output values at the current point 889256cf3b9cSMatthew G. Knepley 8893ed808b8fSJed Brown Level: intermediate 8894a6ba4734SToby Isaac 889545480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary() 8896a6ba4734SToby Isaac @*/ 889745480ffeSMatthew 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) 8898a6ba4734SToby Isaac { 8899e5e52638SMatthew G. Knepley PetscDS ds; 8900a6ba4734SToby Isaac PetscErrorCode ierr; 8901a6ba4734SToby Isaac 8902a6ba4734SToby Isaac PetscFunctionBegin; 8903a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8904783e2ec8SMatthew G. Knepley PetscValidLogicalCollectiveEnum(dm, type, 2); 890545480ffeSMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4); 890645480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nv, 5); 890745480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, field, 7); 890845480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(dm, Nc, 8); 8909e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 891045480ffeSMatthew G. Knepley ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr); 891145480ffeSMatthew G. Knepley ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr); 8912a6ba4734SToby Isaac PetscFunctionReturn(0); 8913a6ba4734SToby Isaac } 8914a6ba4734SToby Isaac 891545480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */ 8916e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm) 8917e6f8dbb6SToby Isaac { 8918e5e52638SMatthew G. Knepley PetscDS ds; 8919dff059c6SToby Isaac DMBoundary *lastnext; 8920e6f8dbb6SToby Isaac DSBoundary dsbound; 8921e6f8dbb6SToby Isaac PetscErrorCode ierr; 8922e6f8dbb6SToby Isaac 8923e6f8dbb6SToby Isaac PetscFunctionBegin; 8924e5e52638SMatthew G. Knepley ierr = DMGetDS(dm, &ds);CHKERRQ(ierr); 8925e5e52638SMatthew G. Knepley dsbound = ds->boundary; 892647a1f5adSToby Isaac if (dm->boundary) { 892747a1f5adSToby Isaac DMBoundary next = dm->boundary; 892847a1f5adSToby Isaac 892947a1f5adSToby Isaac /* quick check to see if the PetscDS has changed */ 893047a1f5adSToby Isaac if (next->dsboundary == dsbound) PetscFunctionReturn(0); 893147a1f5adSToby Isaac /* the PetscDS has changed: tear down and rebuild */ 893247a1f5adSToby Isaac while (next) { 893347a1f5adSToby Isaac DMBoundary b = next; 893447a1f5adSToby Isaac 893547a1f5adSToby Isaac next = b->next; 893647a1f5adSToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 8937a6ba4734SToby Isaac } 893847a1f5adSToby Isaac dm->boundary = NULL; 8939a6ba4734SToby Isaac } 894047a1f5adSToby Isaac 8941dff059c6SToby Isaac lastnext = &(dm->boundary); 8942e6f8dbb6SToby Isaac while (dsbound) { 8943e6f8dbb6SToby Isaac DMBoundary dmbound; 8944e6f8dbb6SToby Isaac 8945e6f8dbb6SToby Isaac ierr = PetscNew(&dmbound);CHKERRQ(ierr); 8946e6f8dbb6SToby Isaac dmbound->dsboundary = dsbound; 894745480ffeSMatthew G. Knepley dmbound->label = dsbound->label; 894847a1f5adSToby Isaac /* push on the back instead of the front so that it is in the same order as in the PetscDS */ 8949dff059c6SToby Isaac *lastnext = dmbound; 8950dff059c6SToby Isaac lastnext = &(dmbound->next); 8951dff059c6SToby Isaac dsbound = dsbound->next; 8952a6ba4734SToby Isaac } 8953a6ba4734SToby Isaac PetscFunctionReturn(0); 8954a6ba4734SToby Isaac } 8955a6ba4734SToby Isaac 8956a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd) 8957a6ba4734SToby Isaac { 8958b95f2879SToby Isaac DMBoundary b; 8959a6ba4734SToby Isaac PetscErrorCode ierr; 8960a6ba4734SToby Isaac 8961a6ba4734SToby Isaac PetscFunctionBegin; 8962a6ba4734SToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 8963534a8f05SLisandro Dalcin PetscValidBoolPointer(isBd, 3); 8964a6ba4734SToby Isaac *isBd = PETSC_FALSE; 8965e6f8dbb6SToby Isaac ierr = DMPopulateBoundary(dm);CHKERRQ(ierr); 8966b95f2879SToby Isaac b = dm->boundary; 8967a6ba4734SToby Isaac while (b && !(*isBd)) { 8968e6f8dbb6SToby Isaac DMLabel label = b->label; 8969e6f8dbb6SToby Isaac DSBoundary dsb = b->dsboundary; 8970a6ba4734SToby Isaac PetscInt i; 8971a6ba4734SToby Isaac 897245480ffeSMatthew G. Knepley if (label) { 897345480ffeSMatthew G. Knepley for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);} 8974a6ba4734SToby Isaac } 8975a6ba4734SToby Isaac b = b->next; 8976a6ba4734SToby Isaac } 8977a6ba4734SToby Isaac PetscFunctionReturn(0); 8978a6ba4734SToby Isaac } 89794d6f44ffSToby Isaac 89804d6f44ffSToby Isaac /*@C 8981a6e0b375SMatthew G. Knepley DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector. 8982a6e0b375SMatthew G. Knepley 8983a6e0b375SMatthew G. Knepley Collective on DM 89844d6f44ffSToby Isaac 89854d6f44ffSToby Isaac Input Parameters: 89864d6f44ffSToby Isaac + dm - The DM 89870709b2feSToby Isaac . time - The time 89884d6f44ffSToby Isaac . funcs - The coordinate functions to evaluate, one per field 89894d6f44ffSToby Isaac . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 89904d6f44ffSToby Isaac - mode - The insertion mode for values 89914d6f44ffSToby Isaac 89924d6f44ffSToby Isaac Output Parameter: 89934d6f44ffSToby Isaac . X - vector 89944d6f44ffSToby Isaac 89954d6f44ffSToby Isaac Calling sequence of func: 899677b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 89974d6f44ffSToby Isaac 89984d6f44ffSToby Isaac + dim - The spatial dimension 89998ec8862eSJed Brown . time - The time at which to sample 90004d6f44ffSToby Isaac . x - The coordinates 900177b739a6SMatthew Knepley . Nc - The number of components 90024d6f44ffSToby Isaac . u - The output field values 90034d6f44ffSToby Isaac - ctx - optional user-defined function context 90044d6f44ffSToby Isaac 90054d6f44ffSToby Isaac Level: developer 90064d6f44ffSToby Isaac 9007a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff() 90084d6f44ffSToby Isaac @*/ 90090709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X) 90104d6f44ffSToby Isaac { 90114d6f44ffSToby Isaac Vec localX; 90124d6f44ffSToby Isaac PetscErrorCode ierr; 90134d6f44ffSToby Isaac 90144d6f44ffSToby Isaac PetscFunctionBegin; 90154d6f44ffSToby Isaac PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 90164d6f44ffSToby Isaac ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 90170709b2feSToby Isaac ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 90184d6f44ffSToby Isaac ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 90194d6f44ffSToby Isaac ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 90204d6f44ffSToby Isaac ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 90214d6f44ffSToby Isaac PetscFunctionReturn(0); 90224d6f44ffSToby Isaac } 90234d6f44ffSToby Isaac 9024a6e0b375SMatthew G. Knepley /*@C 9025a6e0b375SMatthew G. Knepley DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector. 9026a6e0b375SMatthew G. Knepley 9027a6e0b375SMatthew G. Knepley Not collective 9028a6e0b375SMatthew G. Knepley 9029a6e0b375SMatthew G. Knepley Input Parameters: 9030a6e0b375SMatthew G. Knepley + dm - The DM 9031a6e0b375SMatthew G. Knepley . time - The time 9032a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 9033a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 9034a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9035a6e0b375SMatthew G. Knepley 9036a6e0b375SMatthew G. Knepley Output Parameter: 9037a6e0b375SMatthew G. Knepley . localX - vector 9038a6e0b375SMatthew G. Knepley 9039a6e0b375SMatthew G. Knepley Calling sequence of func: 904077b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 9041a6e0b375SMatthew G. Knepley 9042a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9043a6e0b375SMatthew G. Knepley . x - The coordinates 904477b739a6SMatthew Knepley . Nc - The number of components 9045a6e0b375SMatthew G. Knepley . u - The output field values 9046a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 9047a6e0b375SMatthew G. Knepley 9048a6e0b375SMatthew G. Knepley Level: developer 9049a6e0b375SMatthew G. Knepley 9050a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff() 9051a6e0b375SMatthew G. Knepley @*/ 90520709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX) 90534d6f44ffSToby Isaac { 90544d6f44ffSToby Isaac PetscErrorCode ierr; 90554d6f44ffSToby Isaac 90564d6f44ffSToby Isaac PetscFunctionBegin; 90574d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9058064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 90592c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectfunctionlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name); 90600709b2feSToby Isaac ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr); 90614d6f44ffSToby Isaac PetscFunctionReturn(0); 90624d6f44ffSToby Isaac } 90634d6f44ffSToby Isaac 9064a6e0b375SMatthew G. Knepley /*@C 9065a6e0b375SMatthew 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. 9066a6e0b375SMatthew G. Knepley 9067a6e0b375SMatthew G. Knepley Collective on DM 9068a6e0b375SMatthew G. Knepley 9069a6e0b375SMatthew G. Knepley Input Parameters: 9070a6e0b375SMatthew G. Knepley + dm - The DM 9071a6e0b375SMatthew G. Knepley . time - The time 9072a6e0b375SMatthew G. Knepley . label - The DMLabel selecting the portion of the mesh for projection 9073a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 9074a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 9075a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9076a6e0b375SMatthew G. Knepley 9077a6e0b375SMatthew G. Knepley Output Parameter: 9078a6e0b375SMatthew G. Knepley . X - vector 9079a6e0b375SMatthew G. Knepley 9080a6e0b375SMatthew G. Knepley Calling sequence of func: 908177b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 9082a6e0b375SMatthew G. Knepley 9083a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9084a6e0b375SMatthew G. Knepley . x - The coordinates 908577b739a6SMatthew Knepley . Nc - The number of components 9086a6e0b375SMatthew G. Knepley . u - The output field values 9087a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 9088a6e0b375SMatthew G. Knepley 9089a6e0b375SMatthew G. Knepley Level: developer 9090a6e0b375SMatthew G. Knepley 9091a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff() 9092a6e0b375SMatthew G. Knepley @*/ 90932c53366bSMatthew 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) 90942c53366bSMatthew G. Knepley { 90952c53366bSMatthew G. Knepley Vec localX; 90962c53366bSMatthew G. Knepley PetscErrorCode ierr; 90972c53366bSMatthew G. Knepley 90982c53366bSMatthew G. Knepley PetscFunctionBegin; 90992c53366bSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 91002c53366bSMatthew G. Knepley ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr); 91012c53366bSMatthew G. Knepley ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 91022c53366bSMatthew G. Knepley ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr); 91032c53366bSMatthew G. Knepley ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr); 91042c53366bSMatthew G. Knepley ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr); 91052c53366bSMatthew G. Knepley PetscFunctionReturn(0); 91062c53366bSMatthew G. Knepley } 91072c53366bSMatthew G. Knepley 9108a6e0b375SMatthew G. Knepley /*@C 9109a6e0b375SMatthew 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. 9110a6e0b375SMatthew G. Knepley 9111a6e0b375SMatthew G. Knepley Not collective 9112a6e0b375SMatthew G. Knepley 9113a6e0b375SMatthew G. Knepley Input Parameters: 9114a6e0b375SMatthew G. Knepley + dm - The DM 9115a6e0b375SMatthew G. Knepley . time - The time 9116a6e0b375SMatthew G. Knepley . label - The DMLabel selecting the portion of the mesh for projection 9117a6e0b375SMatthew G. Knepley . funcs - The coordinate functions to evaluate, one per field 9118a6e0b375SMatthew G. Knepley . ctxs - Optional array of contexts to pass to each coordinate function. ctxs itself may be null. 9119a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9120a6e0b375SMatthew G. Knepley 9121a6e0b375SMatthew G. Knepley Output Parameter: 9122a6e0b375SMatthew G. Knepley . localX - vector 9123a6e0b375SMatthew G. Knepley 9124a6e0b375SMatthew G. Knepley Calling sequence of func: 912577b739a6SMatthew Knepley $ func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx); 9126a6e0b375SMatthew G. Knepley 9127a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9128a6e0b375SMatthew G. Knepley . x - The coordinates 912977b739a6SMatthew Knepley . Nc - The number of components 9130a6e0b375SMatthew G. Knepley . u - The output field values 9131a6e0b375SMatthew G. Knepley - ctx - optional user-defined function context 9132a6e0b375SMatthew G. Knepley 9133a6e0b375SMatthew G. Knepley Level: developer 9134a6e0b375SMatthew G. Knepley 9135a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff() 9136a6e0b375SMatthew G. Knepley @*/ 91371c531cf8SMatthew 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) 91384d6f44ffSToby Isaac { 91394d6f44ffSToby Isaac PetscErrorCode ierr; 91404d6f44ffSToby Isaac 91414d6f44ffSToby Isaac PetscFunctionBegin; 91424d6f44ffSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9143064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 91442c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectfunctionlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name); 91451c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr); 91464d6f44ffSToby Isaac PetscFunctionReturn(0); 91474d6f44ffSToby Isaac } 91482716604bSToby Isaac 9149a6e0b375SMatthew G. Knepley /*@C 9150a6e0b375SMatthew G. Knepley DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector. 9151a6e0b375SMatthew G. Knepley 9152a6e0b375SMatthew G. Knepley Not collective 9153a6e0b375SMatthew G. Knepley 9154a6e0b375SMatthew G. Knepley Input Parameters: 9155a6e0b375SMatthew G. Knepley + dm - The DM 9156a6e0b375SMatthew G. Knepley . time - The time 9157a6e0b375SMatthew G. Knepley . localU - The input field vector 9158a6e0b375SMatthew G. Knepley . funcs - The functions to evaluate, one per field 9159a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9160a6e0b375SMatthew G. Knepley 9161a6e0b375SMatthew G. Knepley Output Parameter: 9162a6e0b375SMatthew G. Knepley . localX - The output vector 9163a6e0b375SMatthew G. Knepley 9164a6e0b375SMatthew G. Knepley Calling sequence of func: 9165a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9166a6e0b375SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9167a6e0b375SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9168a6e0b375SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9169a6e0b375SMatthew G. Knepley 9170a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9171a6e0b375SMatthew G. Knepley . Nf - The number of input fields 9172a6e0b375SMatthew G. Knepley . NfAux - The number of input auxiliary fields 9173a6e0b375SMatthew G. Knepley . uOff - The offset of each field in u[] 9174a6e0b375SMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9175a6e0b375SMatthew G. Knepley . u - The field values at this point in space 9176a6e0b375SMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9177a6e0b375SMatthew G. Knepley . u_x - The field derivatives at this point in space 9178a6e0b375SMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9179a6e0b375SMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9180a6e0b375SMatthew G. Knepley . a - The auxiliary field values at this point in space 9181a6e0b375SMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9182a6e0b375SMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9183a6e0b375SMatthew G. Knepley . t - The current time 9184a6e0b375SMatthew G. Knepley . x - The coordinates of this point 9185a6e0b375SMatthew G. Knepley . numConstants - The number of constants 9186a6e0b375SMatthew G. Knepley . constants - The value of each constant 9187a6e0b375SMatthew G. Knepley - f - The value of the function at this point in space 9188a6e0b375SMatthew G. Knepley 9189a6e0b375SMatthew 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. 9190a6e0b375SMatthew 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 9191a6e0b375SMatthew 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 9192a6e0b375SMatthew 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. 9193a6e0b375SMatthew G. Knepley 9194a6e0b375SMatthew G. Knepley Level: intermediate 9195a6e0b375SMatthew G. Knepley 9196a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9197a6e0b375SMatthew G. Knepley @*/ 91988c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU, 91998c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 92008c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 92018c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9202191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 92038c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 92048c6c5593SMatthew G. Knepley { 92058c6c5593SMatthew G. Knepley PetscErrorCode ierr; 92068c6c5593SMatthew G. Knepley 92078c6c5593SMatthew G. Knepley PetscFunctionBegin; 92088c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 92098c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localU,VEC_CLASSID,3); 92108c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(localX,VEC_CLASSID,6); 92112c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectfieldlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name); 92128c6c5593SMatthew G. Knepley ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr); 92138c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 92148c6c5593SMatthew G. Knepley } 92158c6c5593SMatthew G. Knepley 9216a6e0b375SMatthew G. Knepley /*@C 9217a6e0b375SMatthew 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. 9218a6e0b375SMatthew G. Knepley 9219a6e0b375SMatthew G. Knepley Not collective 9220a6e0b375SMatthew G. Knepley 9221a6e0b375SMatthew G. Knepley Input Parameters: 9222a6e0b375SMatthew G. Knepley + dm - The DM 9223a6e0b375SMatthew G. Knepley . time - The time 9224a6e0b375SMatthew G. Knepley . label - The DMLabel marking the portion of the domain to output 9225a6e0b375SMatthew G. Knepley . numIds - The number of label ids to use 9226a6e0b375SMatthew G. Knepley . ids - The label ids to use for marking 9227a6e0b375SMatthew G. Knepley . Nc - The number of components to set in the output, or PETSC_DETERMINE for all components 9228a6e0b375SMatthew G. Knepley . comps - The components to set in the output, or NULL for all components 9229a6e0b375SMatthew G. Knepley . localU - The input field vector 9230a6e0b375SMatthew G. Knepley . funcs - The functions to evaluate, one per field 9231a6e0b375SMatthew G. Knepley - mode - The insertion mode for values 9232a6e0b375SMatthew G. Knepley 9233a6e0b375SMatthew G. Knepley Output Parameter: 9234a6e0b375SMatthew G. Knepley . localX - The output vector 9235a6e0b375SMatthew G. Knepley 9236a6e0b375SMatthew G. Knepley Calling sequence of func: 9237a6e0b375SMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9238a6e0b375SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9239a6e0b375SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9240a6e0b375SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9241a6e0b375SMatthew G. Knepley 9242a6e0b375SMatthew G. Knepley + dim - The spatial dimension 9243a6e0b375SMatthew G. Knepley . Nf - The number of input fields 9244a6e0b375SMatthew G. Knepley . NfAux - The number of input auxiliary fields 9245a6e0b375SMatthew G. Knepley . uOff - The offset of each field in u[] 9246a6e0b375SMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9247a6e0b375SMatthew G. Knepley . u - The field values at this point in space 9248a6e0b375SMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9249a6e0b375SMatthew G. Knepley . u_x - The field derivatives at this point in space 9250a6e0b375SMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9251a6e0b375SMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9252a6e0b375SMatthew G. Knepley . a - The auxiliary field values at this point in space 9253a6e0b375SMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9254a6e0b375SMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9255a6e0b375SMatthew G. Knepley . t - The current time 9256a6e0b375SMatthew G. Knepley . x - The coordinates of this point 9257a6e0b375SMatthew G. Knepley . numConstants - The number of constants 9258a6e0b375SMatthew G. Knepley . constants - The value of each constant 9259a6e0b375SMatthew G. Knepley - f - The value of the function at this point in space 9260a6e0b375SMatthew G. Knepley 9261a6e0b375SMatthew 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. 9262a6e0b375SMatthew 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 9263a6e0b375SMatthew 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 9264a6e0b375SMatthew 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. 9265a6e0b375SMatthew G. Knepley 9266a6e0b375SMatthew G. Knepley Level: intermediate 9267a6e0b375SMatthew G. Knepley 9268a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9269a6e0b375SMatthew G. Knepley @*/ 92701c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 92718c6c5593SMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 92728c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 92738c6c5593SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9274191494d9SMatthew G. Knepley PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 92758c6c5593SMatthew G. Knepley InsertMode mode, Vec localX) 92768c6c5593SMatthew G. Knepley { 92778c6c5593SMatthew G. Knepley PetscErrorCode ierr; 92788c6c5593SMatthew G. Knepley 92798c6c5593SMatthew G. Knepley PetscFunctionBegin; 92808c6c5593SMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9281064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localU,VEC_CLASSID,8); 9282064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 92832c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name); 92841c531cf8SMatthew G. Knepley ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 92858c6c5593SMatthew G. Knepley PetscFunctionReturn(0); 92868c6c5593SMatthew G. Knepley } 92878c6c5593SMatthew G. Knepley 92882716604bSToby Isaac /*@C 9289ece3a9fcSMatthew 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. 9290ece3a9fcSMatthew G. Knepley 9291ece3a9fcSMatthew G. Knepley Not collective 9292ece3a9fcSMatthew G. Knepley 9293ece3a9fcSMatthew G. Knepley Input Parameters: 9294ece3a9fcSMatthew G. Knepley + dm - The DM 9295ece3a9fcSMatthew G. Knepley . time - The time 9296ece3a9fcSMatthew G. Knepley . label - The DMLabel marking the portion of the domain boundary to output 9297ece3a9fcSMatthew G. Knepley . numIds - The number of label ids to use 9298ece3a9fcSMatthew G. Knepley . ids - The label ids to use for marking 9299ece3a9fcSMatthew G. Knepley . Nc - The number of components to set in the output, or PETSC_DETERMINE for all components 9300ece3a9fcSMatthew G. Knepley . comps - The components to set in the output, or NULL for all components 9301ece3a9fcSMatthew G. Knepley . localU - The input field vector 9302ece3a9fcSMatthew G. Knepley . funcs - The functions to evaluate, one per field 9303ece3a9fcSMatthew G. Knepley - mode - The insertion mode for values 9304ece3a9fcSMatthew G. Knepley 9305ece3a9fcSMatthew G. Knepley Output Parameter: 9306ece3a9fcSMatthew G. Knepley . localX - The output vector 9307ece3a9fcSMatthew G. Knepley 9308ece3a9fcSMatthew G. Knepley Calling sequence of func: 9309ece3a9fcSMatthew G. Knepley $ func(PetscInt dim, PetscInt Nf, PetscInt NfAux, 9310ece3a9fcSMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 9311ece3a9fcSMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 9312ece3a9fcSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]); 9313ece3a9fcSMatthew G. Knepley 9314ece3a9fcSMatthew G. Knepley + dim - The spatial dimension 9315ece3a9fcSMatthew G. Knepley . Nf - The number of input fields 9316ece3a9fcSMatthew G. Knepley . NfAux - The number of input auxiliary fields 9317ece3a9fcSMatthew G. Knepley . uOff - The offset of each field in u[] 9318ece3a9fcSMatthew G. Knepley . uOff_x - The offset of each field in u_x[] 9319ece3a9fcSMatthew G. Knepley . u - The field values at this point in space 9320ece3a9fcSMatthew G. Knepley . u_t - The field time derivative at this point in space (or NULL) 9321ece3a9fcSMatthew G. Knepley . u_x - The field derivatives at this point in space 9322ece3a9fcSMatthew G. Knepley . aOff - The offset of each auxiliary field in u[] 9323ece3a9fcSMatthew G. Knepley . aOff_x - The offset of each auxiliary field in u_x[] 9324ece3a9fcSMatthew G. Knepley . a - The auxiliary field values at this point in space 9325ece3a9fcSMatthew G. Knepley . a_t - The auxiliary field time derivative at this point in space (or NULL) 9326ece3a9fcSMatthew G. Knepley . a_x - The auxiliary field derivatives at this point in space 9327ece3a9fcSMatthew G. Knepley . t - The current time 9328ece3a9fcSMatthew G. Knepley . x - The coordinates of this point 9329ece3a9fcSMatthew G. Knepley . n - The face normal 9330ece3a9fcSMatthew G. Knepley . numConstants - The number of constants 9331ece3a9fcSMatthew G. Knepley . constants - The value of each constant 9332ece3a9fcSMatthew G. Knepley - f - The value of the function at this point in space 9333ece3a9fcSMatthew G. Knepley 9334ece3a9fcSMatthew G. Knepley Note: 9335ece3a9fcSMatthew 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. 9336ece3a9fcSMatthew 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 9337ece3a9fcSMatthew 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 9338ece3a9fcSMatthew 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. 9339ece3a9fcSMatthew G. Knepley 9340ece3a9fcSMatthew G. Knepley Level: intermediate 9341ece3a9fcSMatthew G. Knepley 9342ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff() 9343ece3a9fcSMatthew G. Knepley @*/ 9344ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU, 9345ece3a9fcSMatthew G. Knepley void (**funcs)(PetscInt, PetscInt, PetscInt, 9346ece3a9fcSMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9347ece3a9fcSMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 9348ece3a9fcSMatthew G. Knepley PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), 9349ece3a9fcSMatthew G. Knepley InsertMode mode, Vec localX) 9350ece3a9fcSMatthew G. Knepley { 9351ece3a9fcSMatthew G. Knepley PetscErrorCode ierr; 9352ece3a9fcSMatthew G. Knepley 9353ece3a9fcSMatthew G. Knepley PetscFunctionBegin; 9354ece3a9fcSMatthew G. Knepley PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9355064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localU,VEC_CLASSID,8); 9356064a246eSJacob Faibussowitsch PetscValidHeaderSpecific(localX,VEC_CLASSID,11); 93572c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->projectbdfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name); 9358ece3a9fcSMatthew G. Knepley ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr); 9359ece3a9fcSMatthew G. Knepley PetscFunctionReturn(0); 9360ece3a9fcSMatthew G. Knepley } 9361ece3a9fcSMatthew G. Knepley 9362ece3a9fcSMatthew G. Knepley /*@C 93632716604bSToby Isaac DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h. 93642716604bSToby Isaac 93652716604bSToby Isaac Input Parameters: 93662716604bSToby Isaac + dm - The DM 93670709b2feSToby Isaac . time - The time 93682716604bSToby Isaac . funcs - The functions to evaluate for each field component 93692716604bSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9370574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 93712716604bSToby Isaac 93722716604bSToby Isaac Output Parameter: 93732716604bSToby Isaac . diff - The diff ||u - u_h||_2 93742716604bSToby Isaac 93752716604bSToby Isaac Level: developer 93762716604bSToby Isaac 93771189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 93782716604bSToby Isaac @*/ 93790709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff) 93802716604bSToby Isaac { 93812716604bSToby Isaac PetscErrorCode ierr; 93822716604bSToby Isaac 93832716604bSToby Isaac PetscFunctionBegin; 93842716604bSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9385b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 93862c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->computel2diff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name); 93870709b2feSToby Isaac ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 93882716604bSToby Isaac PetscFunctionReturn(0); 93892716604bSToby Isaac } 9390b698f381SToby Isaac 9391b698f381SToby Isaac /*@C 9392b698f381SToby Isaac DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h. 9393b698f381SToby Isaac 9394d083f849SBarry Smith Collective on dm 9395d083f849SBarry Smith 9396b698f381SToby Isaac Input Parameters: 9397b698f381SToby Isaac + dm - The DM 9398b698f381SToby Isaac , time - The time 9399b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component 9400b698f381SToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9401574a98acSMatthew G. Knepley . X - The coefficient vector u_h, a global vector 9402b698f381SToby Isaac - n - The vector to project along 9403b698f381SToby Isaac 9404b698f381SToby Isaac Output Parameter: 9405b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2 9406b698f381SToby Isaac 9407b698f381SToby Isaac Level: developer 9408b698f381SToby Isaac 9409b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff() 9410b698f381SToby Isaac @*/ 9411b698f381SToby 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) 9412b698f381SToby Isaac { 9413b698f381SToby Isaac PetscErrorCode ierr; 9414b698f381SToby Isaac 9415b698f381SToby Isaac PetscFunctionBegin; 9416b698f381SToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 9417b698f381SToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 94182c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->computel2gradientdiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name); 9419b698f381SToby Isaac ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr); 9420b698f381SToby Isaac PetscFunctionReturn(0); 9421b698f381SToby Isaac } 9422b698f381SToby Isaac 94232a16baeaSToby Isaac /*@C 94242a16baeaSToby Isaac DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components. 94252a16baeaSToby Isaac 9426d083f849SBarry Smith Collective on dm 9427d083f849SBarry Smith 94282a16baeaSToby Isaac Input Parameters: 94292a16baeaSToby Isaac + dm - The DM 94302a16baeaSToby Isaac . time - The time 94312a16baeaSToby Isaac . funcs - The functions to evaluate for each field component 94322a16baeaSToby Isaac . ctxs - Optional array of contexts to pass to each function, or NULL. 9433574a98acSMatthew G. Knepley - X - The coefficient vector u_h, a global vector 94342a16baeaSToby Isaac 94352a16baeaSToby Isaac Output Parameter: 94362a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2 94372a16baeaSToby Isaac 94382a16baeaSToby Isaac Level: developer 94392a16baeaSToby Isaac 94401189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff() 94412a16baeaSToby Isaac @*/ 94421189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[]) 94432a16baeaSToby Isaac { 94442a16baeaSToby Isaac PetscErrorCode ierr; 94452a16baeaSToby Isaac 94462a16baeaSToby Isaac PetscFunctionBegin; 94472a16baeaSToby Isaac PetscValidHeaderSpecific(dm,DM_CLASSID,1); 94482a16baeaSToby Isaac PetscValidHeaderSpecific(X,VEC_CLASSID,5); 94492c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->computel2fielddiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name); 94502a16baeaSToby Isaac ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr); 94512a16baeaSToby Isaac PetscFunctionReturn(0); 94522a16baeaSToby Isaac } 94532a16baeaSToby Isaac 9454df0b854cSToby Isaac /*@C 9455502a2867SDave May DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors 9456502a2867SDave May 9457502a2867SDave May Not Collective 9458502a2867SDave May 9459502a2867SDave May Input Parameter: 9460502a2867SDave May . dm - The DM 9461502a2867SDave May 94620a19bb7dSprj- Output Parameters: 94630a19bb7dSprj- + nranks - the number of neighbours 94640a19bb7dSprj- - ranks - the neighbors ranks 9465502a2867SDave May 9466502a2867SDave May Notes: 9467502a2867SDave May Do not free the array, it is freed when the DM is destroyed. 9468502a2867SDave May 9469502a2867SDave May Level: beginner 9470502a2867SDave May 9471dec1416fSJunchao Zhang .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks() 9472502a2867SDave May @*/ 9473502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[]) 9474502a2867SDave May { 9475502a2867SDave May PetscErrorCode ierr; 9476502a2867SDave May 9477502a2867SDave May PetscFunctionBegin; 9478502a2867SDave May PetscValidHeaderSpecific(dm,DM_CLASSID,1); 94792c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm->ops->getneighbors,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name); 9480502a2867SDave May ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr); 9481502a2867SDave May PetscFunctionReturn(0); 9482502a2867SDave May } 9483502a2867SDave May 9484531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */ 9485531c7667SBarry Smith 9486531c7667SBarry Smith /* 9487531c7667SBarry Smith Converts the input vector to a ghosted vector and then calls the standard coloring code. 9488531c7667SBarry Smith This has be a different function because it requires DM which is not defined in the Mat library 9489531c7667SBarry Smith */ 9490531c7667SBarry Smith PetscErrorCode MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx) 9491531c7667SBarry Smith { 9492531c7667SBarry Smith PetscErrorCode ierr; 9493531c7667SBarry Smith 9494531c7667SBarry Smith PetscFunctionBegin; 9495531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 9496531c7667SBarry Smith Vec x1local; 9497531c7667SBarry Smith DM dm; 9498531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 94992c71b3e2SJacob Faibussowitsch PetscCheckFalse(!dm,PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM"); 9500531c7667SBarry Smith ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr); 9501531c7667SBarry Smith ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 9502531c7667SBarry Smith ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr); 9503531c7667SBarry Smith x1 = x1local; 9504531c7667SBarry Smith } 9505531c7667SBarry Smith ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr); 9506531c7667SBarry Smith if (coloring->ctype == IS_COLORING_LOCAL) { 9507531c7667SBarry Smith DM dm; 9508531c7667SBarry Smith ierr = MatGetDM(J,&dm);CHKERRQ(ierr); 9509531c7667SBarry Smith ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr); 9510531c7667SBarry Smith } 9511531c7667SBarry Smith PetscFunctionReturn(0); 9512531c7667SBarry Smith } 9513531c7667SBarry Smith 9514531c7667SBarry Smith /*@ 9515531c7667SBarry Smith MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring 9516531c7667SBarry Smith 9517531c7667SBarry Smith Input Parameter: 9518531c7667SBarry Smith . coloring - the MatFDColoring object 9519531c7667SBarry Smith 952095452b02SPatrick Sanan Developer Notes: 952195452b02SPatrick Sanan this routine exists because the PETSc Mat library does not know about the DM objects 9522531c7667SBarry Smith 95231b266c99SBarry Smith Level: advanced 95241b266c99SBarry Smith 9525531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType 9526531c7667SBarry Smith @*/ 9527531c7667SBarry Smith PetscErrorCode MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring) 9528531c7667SBarry Smith { 9529531c7667SBarry Smith PetscFunctionBegin; 9530531c7667SBarry Smith coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM; 9531531c7667SBarry Smith PetscFunctionReturn(0); 9532531c7667SBarry Smith } 95338320bc6fSPatrick Sanan 95348320bc6fSPatrick Sanan /*@ 95358320bc6fSPatrick Sanan DMGetCompatibility - determine if two DMs are compatible 95368320bc6fSPatrick Sanan 95378320bc6fSPatrick Sanan Collective 95388320bc6fSPatrick Sanan 95398320bc6fSPatrick Sanan Input Parameters: 9540a5bc1bf3SBarry Smith + dm1 - the first DM 95418320bc6fSPatrick Sanan - dm2 - the second DM 95428320bc6fSPatrick Sanan 95438320bc6fSPatrick Sanan Output Parameters: 95448320bc6fSPatrick Sanan + compatible - whether or not the two DMs are compatible 95458320bc6fSPatrick Sanan - set - whether or not the compatible value was set 95468320bc6fSPatrick Sanan 95478320bc6fSPatrick Sanan Notes: 95488320bc6fSPatrick Sanan Two DMs are deemed compatible if they represent the same parallel decomposition 95493d862458SPatrick Sanan of the same topology. This implies that the section (field data) on one 95508320bc6fSPatrick Sanan "makes sense" with respect to the topology and parallel decomposition of the other. 95513d862458SPatrick Sanan Loosely speaking, compatible DMs represent the same domain and parallel 95523d862458SPatrick Sanan decomposition, but hold different data. 95538320bc6fSPatrick Sanan 95548320bc6fSPatrick Sanan Typically, one would confirm compatibility if intending to simultaneously iterate 95558320bc6fSPatrick Sanan over a pair of vectors obtained from different DMs. 95568320bc6fSPatrick Sanan 95578320bc6fSPatrick Sanan For example, two DMDA objects are compatible if they have the same local 95588320bc6fSPatrick Sanan and global sizes and the same stencil width. They can have different numbers 95598320bc6fSPatrick Sanan of degrees of freedom per node. Thus, one could use the node numbering from 95608320bc6fSPatrick Sanan either DM in bounds for a loop over vectors derived from either DM. 95618320bc6fSPatrick Sanan 95628320bc6fSPatrick Sanan Consider the operation of summing data living on a 2-dof DMDA to data living 95638320bc6fSPatrick Sanan on a 1-dof DMDA, which should be compatible, as in the following snippet. 95648320bc6fSPatrick Sanan .vb 95658320bc6fSPatrick Sanan ... 95668320bc6fSPatrick Sanan ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr); 95678320bc6fSPatrick Sanan if (set && compatible) { 95688320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 95698320bc6fSPatrick Sanan ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 95703d862458SPatrick Sanan ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr); 95718320bc6fSPatrick Sanan for (j=y; j<y+n; ++j) { 95728320bc6fSPatrick Sanan for (i=x; i<x+m, ++i) { 95738320bc6fSPatrick Sanan arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1]; 95748320bc6fSPatrick Sanan } 95758320bc6fSPatrick Sanan } 95768320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr); 95778320bc6fSPatrick Sanan ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr); 95788320bc6fSPatrick Sanan } else { 95798320bc6fSPatrick Sanan SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible"); 95808320bc6fSPatrick Sanan } 95818320bc6fSPatrick Sanan ... 95828320bc6fSPatrick Sanan .ve 95838320bc6fSPatrick Sanan 95848320bc6fSPatrick Sanan Checking compatibility might be expensive for a given implementation of DM, 95858320bc6fSPatrick Sanan or might be impossible to unambiguously confirm or deny. For this reason, 95868320bc6fSPatrick Sanan this function may decline to determine compatibility, and hence users should 95878320bc6fSPatrick Sanan always check the "set" output parameter. 95888320bc6fSPatrick Sanan 95898320bc6fSPatrick Sanan A DM is always compatible with itself. 95908320bc6fSPatrick Sanan 95918320bc6fSPatrick Sanan In the current implementation, DMs which live on "unequal" communicators 95928320bc6fSPatrick Sanan (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed 95938320bc6fSPatrick Sanan incompatible. 95948320bc6fSPatrick Sanan 95958320bc6fSPatrick Sanan This function is labeled "Collective," as information about all subdomains 95968320bc6fSPatrick Sanan is required on each rank. However, in DM implementations which store all this 95978320bc6fSPatrick Sanan information locally, this function may be merely "Logically Collective". 95988320bc6fSPatrick Sanan 95998320bc6fSPatrick Sanan Developer Notes: 96003d862458SPatrick Sanan Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B 96013d862458SPatrick Sanan iff B is compatible with A. Thus, this function checks the implementations 9602a5bc1bf3SBarry Smith of both dm and dmc (if they are of different types), attempting to determine 96038320bc6fSPatrick Sanan compatibility. It is left to DM implementers to ensure that symmetry is 96048320bc6fSPatrick Sanan preserved. The simplest way to do this is, when implementing type-specific 96053d862458SPatrick Sanan logic for this function, is to check for existing logic in the implementation 96063d862458SPatrick Sanan of other DM types and let *set = PETSC_FALSE if found. 96078320bc6fSPatrick Sanan 96088320bc6fSPatrick Sanan Level: advanced 96098320bc6fSPatrick Sanan 96103d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag() 96118320bc6fSPatrick Sanan @*/ 96128320bc6fSPatrick Sanan 9613a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set) 96148320bc6fSPatrick Sanan { 96158320bc6fSPatrick Sanan PetscErrorCode ierr; 96168320bc6fSPatrick Sanan PetscMPIInt compareResult; 96178320bc6fSPatrick Sanan DMType type,type2; 96188320bc6fSPatrick Sanan PetscBool sameType; 96198320bc6fSPatrick Sanan 96208320bc6fSPatrick Sanan PetscFunctionBegin; 9621a5bc1bf3SBarry Smith PetscValidHeaderSpecific(dm1,DM_CLASSID,1); 96228320bc6fSPatrick Sanan PetscValidHeaderSpecific(dm2,DM_CLASSID,2); 96238320bc6fSPatrick Sanan 96248320bc6fSPatrick Sanan /* Declare a DM compatible with itself */ 9625a5bc1bf3SBarry Smith if (dm1 == dm2) { 96268320bc6fSPatrick Sanan *set = PETSC_TRUE; 96278320bc6fSPatrick Sanan *compatible = PETSC_TRUE; 96288320bc6fSPatrick Sanan PetscFunctionReturn(0); 96298320bc6fSPatrick Sanan } 96308320bc6fSPatrick Sanan 96318320bc6fSPatrick Sanan /* Declare a DM incompatible with a DM that lives on an "unequal" 96328320bc6fSPatrick Sanan communicator. Note that this does not preclude compatibility with 96338320bc6fSPatrick Sanan DMs living on "congruent" or "similar" communicators, but this must be 96348320bc6fSPatrick Sanan determined by the implementation-specific logic */ 9635ffc4695bSBarry Smith ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr); 96368320bc6fSPatrick Sanan if (compareResult == MPI_UNEQUAL) { 96378320bc6fSPatrick Sanan *set = PETSC_TRUE; 96388320bc6fSPatrick Sanan *compatible = PETSC_FALSE; 96398320bc6fSPatrick Sanan PetscFunctionReturn(0); 96408320bc6fSPatrick Sanan } 96418320bc6fSPatrick Sanan 96428320bc6fSPatrick Sanan /* Pass to the implementation-specific routine, if one exists. */ 9643a5bc1bf3SBarry Smith if (dm1->ops->getcompatibility) { 9644a5bc1bf3SBarry Smith ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr); 9645b9d85ea2SLisandro Dalcin if (*set) PetscFunctionReturn(0); 96468320bc6fSPatrick Sanan } 96478320bc6fSPatrick Sanan 9648a5bc1bf3SBarry Smith /* If dm1 and dm2 are of different types, then attempt to check compatibility 96498320bc6fSPatrick Sanan with an implementation of this function from dm2 */ 9650a5bc1bf3SBarry Smith ierr = DMGetType(dm1,&type);CHKERRQ(ierr); 96518320bc6fSPatrick Sanan ierr = DMGetType(dm2,&type2);CHKERRQ(ierr); 96528320bc6fSPatrick Sanan ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr); 96538320bc6fSPatrick Sanan if (!sameType && dm2->ops->getcompatibility) { 9654a5bc1bf3SBarry Smith ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */ 96558320bc6fSPatrick Sanan } else { 96568320bc6fSPatrick Sanan *set = PETSC_FALSE; 96578320bc6fSPatrick Sanan } 96588320bc6fSPatrick Sanan PetscFunctionReturn(0); 96598320bc6fSPatrick Sanan } 9660c0f0dcc3SMatthew G. Knepley 9661c0f0dcc3SMatthew G. Knepley /*@C 9662c0f0dcc3SMatthew G. Knepley DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance. 9663c0f0dcc3SMatthew G. Knepley 9664c0f0dcc3SMatthew G. Knepley Logically Collective on DM 9665c0f0dcc3SMatthew G. Knepley 9666c0f0dcc3SMatthew G. Knepley Input Parameters: 9667c0f0dcc3SMatthew G. Knepley + DM - the DM 9668c0f0dcc3SMatthew G. Knepley . f - the monitor function 9669c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired) 9670c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL) 9671c0f0dcc3SMatthew G. Knepley 9672c0f0dcc3SMatthew G. Knepley Options Database Keys: 9673c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but 9674c0f0dcc3SMatthew G. Knepley does not cancel those set via the options database. 9675c0f0dcc3SMatthew G. Knepley 9676c0f0dcc3SMatthew G. Knepley Notes: 9677c0f0dcc3SMatthew G. Knepley Several different monitoring routines may be set by calling 9678c0f0dcc3SMatthew G. Knepley DMMonitorSet() multiple times; all will be called in the 9679c0f0dcc3SMatthew G. Knepley order in which they were set. 9680c0f0dcc3SMatthew G. Knepley 9681c0f0dcc3SMatthew G. Knepley Fortran Notes: 9682c0f0dcc3SMatthew G. Knepley Only a single monitor function can be set for each DM object 9683c0f0dcc3SMatthew G. Knepley 9684c0f0dcc3SMatthew G. Knepley Level: intermediate 9685c0f0dcc3SMatthew G. Knepley 9686c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel() 9687c0f0dcc3SMatthew G. Knepley @*/ 9688c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**)) 9689c0f0dcc3SMatthew G. Knepley { 9690c0f0dcc3SMatthew G. Knepley PetscInt m; 9691c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9692c0f0dcc3SMatthew G. Knepley 9693c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9694c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9695c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9696c0f0dcc3SMatthew G. Knepley PetscBool identical; 9697c0f0dcc3SMatthew G. Knepley 9698c0f0dcc3SMatthew G. Knepley ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr); 9699c0f0dcc3SMatthew G. Knepley if (identical) PetscFunctionReturn(0); 9700c0f0dcc3SMatthew G. Knepley } 97012c71b3e2SJacob Faibussowitsch PetscCheckFalse(dm->numbermonitors >= MAXDMMONITORS,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set"); 9702c0f0dcc3SMatthew G. Knepley dm->monitor[dm->numbermonitors] = f; 9703c0f0dcc3SMatthew G. Knepley dm->monitordestroy[dm->numbermonitors] = monitordestroy; 9704c0f0dcc3SMatthew G. Knepley dm->monitorcontext[dm->numbermonitors++] = (void *) mctx; 9705c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9706c0f0dcc3SMatthew G. Knepley } 9707c0f0dcc3SMatthew G. Knepley 9708c0f0dcc3SMatthew G. Knepley /*@ 9709c0f0dcc3SMatthew G. Knepley DMMonitorCancel - Clears all the monitor functions for a DM object. 9710c0f0dcc3SMatthew G. Knepley 9711c0f0dcc3SMatthew G. Knepley Logically Collective on DM 9712c0f0dcc3SMatthew G. Knepley 9713c0f0dcc3SMatthew G. Knepley Input Parameter: 9714c0f0dcc3SMatthew G. Knepley . dm - the DM 9715c0f0dcc3SMatthew G. Knepley 9716c0f0dcc3SMatthew G. Knepley Options Database Key: 9717c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired 9718c0f0dcc3SMatthew G. Knepley into a code by calls to DMonitorSet(), but does not cancel those 9719c0f0dcc3SMatthew G. Knepley set via the options database 9720c0f0dcc3SMatthew G. Knepley 9721c0f0dcc3SMatthew G. Knepley Notes: 9722c0f0dcc3SMatthew G. Knepley There is no way to clear one specific monitor from a DM object. 9723c0f0dcc3SMatthew G. Knepley 9724c0f0dcc3SMatthew G. Knepley Level: intermediate 9725c0f0dcc3SMatthew G. Knepley 9726c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet() 9727c0f0dcc3SMatthew G. Knepley @*/ 9728c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm) 9729c0f0dcc3SMatthew G. Knepley { 9730c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9731c0f0dcc3SMatthew G. Knepley PetscInt m; 9732c0f0dcc3SMatthew G. Knepley 9733c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9734c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9735c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9736c0f0dcc3SMatthew G. Knepley if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);} 9737c0f0dcc3SMatthew G. Knepley } 9738c0f0dcc3SMatthew G. Knepley dm->numbermonitors = 0; 9739c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9740c0f0dcc3SMatthew G. Knepley } 9741c0f0dcc3SMatthew G. Knepley 9742c0f0dcc3SMatthew G. Knepley /*@C 9743c0f0dcc3SMatthew G. Knepley DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 9744c0f0dcc3SMatthew G. Knepley 9745c0f0dcc3SMatthew G. Knepley Collective on DM 9746c0f0dcc3SMatthew G. Knepley 9747c0f0dcc3SMatthew G. Knepley Input Parameters: 9748c0f0dcc3SMatthew G. Knepley + dm - DM object you wish to monitor 9749c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking 9750c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done 9751c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor 9752c0f0dcc3SMatthew G. Knepley . monitor - the monitor function 9753c0f0dcc3SMatthew 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 9754c0f0dcc3SMatthew G. Knepley 9755c0f0dcc3SMatthew G. Knepley Output Parameter: 9756c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created 9757c0f0dcc3SMatthew G. Knepley 9758c0f0dcc3SMatthew G. Knepley Level: developer 9759c0f0dcc3SMatthew G. Knepley 9760c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 9761c0f0dcc3SMatthew G. Knepley PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 9762c0f0dcc3SMatthew G. Knepley PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 9763c0f0dcc3SMatthew G. Knepley PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 9764c0f0dcc3SMatthew G. Knepley PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 9765c0f0dcc3SMatthew G. Knepley PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 9766c0f0dcc3SMatthew G. Knepley PetscOptionsFList(), PetscOptionsEList() 9767c0f0dcc3SMatthew G. Knepley @*/ 9768c0f0dcc3SMatthew 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) 9769c0f0dcc3SMatthew G. Knepley { 9770c0f0dcc3SMatthew G. Knepley PetscViewer viewer; 9771c0f0dcc3SMatthew G. Knepley PetscViewerFormat format; 9772c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9773c0f0dcc3SMatthew G. Knepley 9774c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9775c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9776c0f0dcc3SMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr); 9777c0f0dcc3SMatthew G. Knepley if (*flg) { 9778c0f0dcc3SMatthew G. Knepley PetscViewerAndFormat *vf; 9779c0f0dcc3SMatthew G. Knepley 9780c0f0dcc3SMatthew G. Knepley ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr); 9781c0f0dcc3SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr); 9782c0f0dcc3SMatthew G. Knepley if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);} 9783c0f0dcc3SMatthew G. Knepley ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr); 9784c0f0dcc3SMatthew G. Knepley } 9785c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9786c0f0dcc3SMatthew G. Knepley } 9787c0f0dcc3SMatthew G. Knepley 9788c0f0dcc3SMatthew G. Knepley /*@ 9789c0f0dcc3SMatthew G. Knepley DMMonitor - runs the user provided monitor routines, if they exist 9790c0f0dcc3SMatthew G. Knepley 9791c0f0dcc3SMatthew G. Knepley Collective on DM 9792c0f0dcc3SMatthew G. Knepley 9793c0f0dcc3SMatthew G. Knepley Input Parameters: 9794c0f0dcc3SMatthew G. Knepley . dm - The DM 9795c0f0dcc3SMatthew G. Knepley 9796c0f0dcc3SMatthew G. Knepley Level: developer 9797c0f0dcc3SMatthew G. Knepley 9798c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet() 9799c0f0dcc3SMatthew G. Knepley @*/ 9800c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm) 9801c0f0dcc3SMatthew G. Knepley { 9802c0f0dcc3SMatthew G. Knepley PetscInt m; 9803c0f0dcc3SMatthew G. Knepley PetscErrorCode ierr; 9804c0f0dcc3SMatthew G. Knepley 9805c0f0dcc3SMatthew G. Knepley PetscFunctionBegin; 9806c0f0dcc3SMatthew G. Knepley if (!dm) PetscFunctionReturn(0); 9807c0f0dcc3SMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 9808c0f0dcc3SMatthew G. Knepley for (m = 0; m < dm->numbermonitors; ++m) { 9809c0f0dcc3SMatthew G. Knepley ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr); 9810c0f0dcc3SMatthew G. Knepley } 9811c0f0dcc3SMatthew G. Knepley PetscFunctionReturn(0); 9812c0f0dcc3SMatthew G. Knepley } 98132e4af2aeSMatthew G. Knepley 98142e4af2aeSMatthew G. Knepley /*@ 98152e4af2aeSMatthew G. Knepley DMComputeError - Computes the error assuming the user has given exact solution functions 98162e4af2aeSMatthew G. Knepley 98172e4af2aeSMatthew G. Knepley Collective on DM 98182e4af2aeSMatthew G. Knepley 98192e4af2aeSMatthew G. Knepley Input Parameters: 98202e4af2aeSMatthew G. Knepley + dm - The DM 98216b867d5aSJose E. Roman - sol - The solution vector 98222e4af2aeSMatthew G. Knepley 98236b867d5aSJose E. Roman Input/Output Parameter: 98246b867d5aSJose E. Roman . errors - An array of length Nf, the number of fields, or NULL for no output; on output 98256b867d5aSJose E. Roman contains the error in each field 98266b867d5aSJose E. Roman 98276b867d5aSJose E. Roman Output Parameter: 98286b867d5aSJose E. Roman . errorVec - A vector to hold the cellwise error (may be NULL) 98292e4af2aeSMatthew G. Knepley 98302e4af2aeSMatthew G. Knepley Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber(). 98312e4af2aeSMatthew G. Knepley 98322e4af2aeSMatthew G. Knepley Level: developer 98332e4af2aeSMatthew G. Knepley 98342e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber() 98352e4af2aeSMatthew G. Knepley @*/ 98362e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec) 98372e4af2aeSMatthew G. Knepley { 98382e4af2aeSMatthew G. Knepley PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *); 98392e4af2aeSMatthew G. Knepley void **ctxs; 98402e4af2aeSMatthew G. Knepley PetscReal time; 98412e4af2aeSMatthew G. Knepley PetscInt Nf, f, Nds, s; 98422e4af2aeSMatthew G. Knepley PetscErrorCode ierr; 98432e4af2aeSMatthew G. Knepley 98442e4af2aeSMatthew G. Knepley PetscFunctionBegin; 98452e4af2aeSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 98462e4af2aeSMatthew G. Knepley ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr); 98472e4af2aeSMatthew G. Knepley ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr); 98482e4af2aeSMatthew G. Knepley for (s = 0; s < Nds; ++s) { 98492e4af2aeSMatthew G. Knepley PetscDS ds; 98502e4af2aeSMatthew G. Knepley DMLabel label; 98512e4af2aeSMatthew G. Knepley IS fieldIS; 98522e4af2aeSMatthew G. Knepley const PetscInt *fields; 98532e4af2aeSMatthew G. Knepley PetscInt dsNf; 98542e4af2aeSMatthew G. Knepley 98552e4af2aeSMatthew G. Knepley ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr); 98562e4af2aeSMatthew G. Knepley ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr); 98572e4af2aeSMatthew G. Knepley if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);} 98582e4af2aeSMatthew G. Knepley for (f = 0; f < dsNf; ++f) { 98592e4af2aeSMatthew G. Knepley const PetscInt field = fields[f]; 98602e4af2aeSMatthew G. Knepley ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr); 98612e4af2aeSMatthew G. Knepley } 98622e4af2aeSMatthew G. Knepley if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);} 98632e4af2aeSMatthew G. Knepley } 98642e4af2aeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 98652c71b3e2SJacob Faibussowitsch PetscCheckFalse(!exactSol[f],PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "DS must contain exact solution functions in order to calculate error, missing for field %D", f); 98662e4af2aeSMatthew G. Knepley } 98672e4af2aeSMatthew G. Knepley ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr); 98682e4af2aeSMatthew G. Knepley if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);} 98692e4af2aeSMatthew G. Knepley if (errorVec) { 98702e4af2aeSMatthew G. Knepley DM edm; 98712e4af2aeSMatthew G. Knepley DMPolytopeType ct; 98722e4af2aeSMatthew G. Knepley PetscBool simplex; 98732e4af2aeSMatthew G. Knepley PetscInt dim, cStart, Nf; 98742e4af2aeSMatthew G. Knepley 98752e4af2aeSMatthew G. Knepley ierr = DMClone(dm, &edm);CHKERRQ(ierr); 98762e4af2aeSMatthew G. Knepley ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr); 98772e4af2aeSMatthew G. Knepley ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr); 98782e4af2aeSMatthew G. Knepley ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr); 98792e4af2aeSMatthew G. Knepley simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE; 98802e4af2aeSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 98812e4af2aeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 98822e4af2aeSMatthew G. Knepley PetscFE fe, efe; 98832e4af2aeSMatthew G. Knepley PetscQuadrature q; 98842e4af2aeSMatthew G. Knepley const char *name; 98852e4af2aeSMatthew G. Knepley 98862e4af2aeSMatthew G. Knepley ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr); 98872e4af2aeSMatthew G. Knepley ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr); 98882e4af2aeSMatthew G. Knepley ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr); 98892e4af2aeSMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr); 98902e4af2aeSMatthew G. Knepley ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr); 98912e4af2aeSMatthew G. Knepley ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr); 98922e4af2aeSMatthew G. Knepley ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr); 98932e4af2aeSMatthew G. Knepley ierr = PetscFEDestroy(&efe);CHKERRQ(ierr); 98942e4af2aeSMatthew G. Knepley } 98952e4af2aeSMatthew G. Knepley ierr = DMCreateDS(edm);CHKERRQ(ierr); 98962e4af2aeSMatthew G. Knepley 98971e1ea65dSPierre Jolivet ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr); 98982e4af2aeSMatthew G. Knepley ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr); 98992e4af2aeSMatthew G. Knepley ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr); 99002e4af2aeSMatthew G. Knepley ierr = DMDestroy(&edm);CHKERRQ(ierr); 99012e4af2aeSMatthew G. Knepley } 99022e4af2aeSMatthew G. Knepley ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr); 99032e4af2aeSMatthew G. Knepley PetscFunctionReturn(0); 99042e4af2aeSMatthew G. Knepley } 99059a2a23afSMatthew G. Knepley 99069a2a23afSMatthew G. Knepley /*@ 99079a2a23afSMatthew G. Knepley DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM 99089a2a23afSMatthew G. Knepley 99099a2a23afSMatthew G. Knepley Not collective 99109a2a23afSMatthew G. Knepley 99119a2a23afSMatthew G. Knepley Input Parameter: 99129a2a23afSMatthew G. Knepley . dm - The DM 99139a2a23afSMatthew G. Knepley 99149a2a23afSMatthew G. Knepley Output Parameter: 9915a5b23f4aSJose E. Roman . numAux - The number of auxiliary data vectors 99169a2a23afSMatthew G. Knepley 99179a2a23afSMatthew G. Knepley Level: advanced 99189a2a23afSMatthew G. Knepley 99199a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 99209a2a23afSMatthew G. Knepley @*/ 99219a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux) 99229a2a23afSMatthew G. Knepley { 99239a2a23afSMatthew G. Knepley PetscErrorCode ierr; 99249a2a23afSMatthew G. Knepley 99259a2a23afSMatthew G. Knepley PetscFunctionBegin; 99269a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 99279a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr); 99289a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 99299a2a23afSMatthew G. Knepley } 99309a2a23afSMatthew G. Knepley 99319a2a23afSMatthew G. Knepley /*@ 99329a2a23afSMatthew G. Knepley DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value 99339a2a23afSMatthew G. Knepley 99349a2a23afSMatthew G. Knepley Not collective 99359a2a23afSMatthew G. Knepley 99369a2a23afSMatthew G. Knepley Input Parameters: 99379a2a23afSMatthew G. Knepley + dm - The DM 99389a2a23afSMatthew G. Knepley . label - The DMLabel 99399a2a23afSMatthew G. Knepley - value - The label value indicating the region 99409a2a23afSMatthew G. Knepley 99419a2a23afSMatthew G. Knepley Output Parameter: 99429a2a23afSMatthew G. Knepley . aux - The Vec holding auxiliary field data 99439a2a23afSMatthew G. Knepley 994404c51a94SMatthew G. Knepley Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well. 994504c51a94SMatthew G. Knepley 99469a2a23afSMatthew G. Knepley Level: advanced 99479a2a23afSMatthew G. Knepley 99489a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec() 99499a2a23afSMatthew G. Knepley @*/ 99509a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux) 99519a2a23afSMatthew G. Knepley { 995204c51a94SMatthew G. Knepley PetscHashAuxKey key, wild = {NULL, 0}; 995304c51a94SMatthew G. Knepley PetscBool has; 99549a2a23afSMatthew G. Knepley PetscErrorCode ierr; 99559a2a23afSMatthew G. Knepley 99569a2a23afSMatthew G. Knepley PetscFunctionBegin; 99579a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 99589a2a23afSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 99599a2a23afSMatthew G. Knepley key.label = label; 99609a2a23afSMatthew G. Knepley key.value = value; 996104c51a94SMatthew G. Knepley ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr); 996204c51a94SMatthew G. Knepley if (has) {ierr = PetscHMapAuxGet(dm->auxData, key, aux);CHKERRQ(ierr);} 996304c51a94SMatthew G. Knepley else {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);} 99649a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 99659a2a23afSMatthew G. Knepley } 99669a2a23afSMatthew G. Knepley 99679a2a23afSMatthew G. Knepley /*@ 99689a2a23afSMatthew G. Knepley DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value 99699a2a23afSMatthew G. Knepley 99709a2a23afSMatthew G. Knepley Not collective 99719a2a23afSMatthew G. Knepley 99729a2a23afSMatthew G. Knepley Input Parameters: 99739a2a23afSMatthew G. Knepley + dm - The DM 99749a2a23afSMatthew G. Knepley . label - The DMLabel 99759a2a23afSMatthew G. Knepley . value - The label value indicating the region 99769a2a23afSMatthew G. Knepley - aux - The Vec holding auxiliary field data 99779a2a23afSMatthew G. Knepley 99789a2a23afSMatthew G. Knepley Level: advanced 99799a2a23afSMatthew G. Knepley 99809a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec() 99819a2a23afSMatthew G. Knepley @*/ 99829a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux) 99839a2a23afSMatthew G. Knepley { 99849a2a23afSMatthew G. Knepley Vec old; 99859a2a23afSMatthew G. Knepley PetscHashAuxKey key; 99869a2a23afSMatthew G. Knepley PetscErrorCode ierr; 99879a2a23afSMatthew G. Knepley 99889a2a23afSMatthew G. Knepley PetscFunctionBegin; 99899a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 99909a2a23afSMatthew G. Knepley if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2); 99919a2a23afSMatthew G. Knepley key.label = label; 99929a2a23afSMatthew G. Knepley key.value = value; 99939a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr); 99949a2a23afSMatthew G. Knepley ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr); 99959a2a23afSMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr); 99969a2a23afSMatthew G. Knepley if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);} 99979a2a23afSMatthew G. Knepley else {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);} 99989a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 99999a2a23afSMatthew G. Knepley } 100009a2a23afSMatthew G. Knepley 100019a2a23afSMatthew G. Knepley /*@C 100029a2a23afSMatthew G. Knepley DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM 100039a2a23afSMatthew G. Knepley 100049a2a23afSMatthew G. Knepley Not collective 100059a2a23afSMatthew G. Knepley 100069a2a23afSMatthew G. Knepley Input Parameter: 100079a2a23afSMatthew G. Knepley . dm - The DM 100089a2a23afSMatthew G. Knepley 100099a2a23afSMatthew G. Knepley Output Parameters: 100109a2a23afSMatthew G. Knepley + labels - The DMLabels for each Vec 100119a2a23afSMatthew G. Knepley - values - The label values for each Vec 100129a2a23afSMatthew G. Knepley 100139a2a23afSMatthew G. Knepley Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec(). 100149a2a23afSMatthew G. Knepley 100159a2a23afSMatthew G. Knepley Level: advanced 100169a2a23afSMatthew G. Knepley 100179a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 100189a2a23afSMatthew G. Knepley @*/ 100199a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[]) 100209a2a23afSMatthew G. Knepley { 100219a2a23afSMatthew G. Knepley PetscHashAuxKey *keys; 100229a2a23afSMatthew G. Knepley PetscInt n, i, off = 0; 100239a2a23afSMatthew G. Knepley PetscErrorCode ierr; 100249a2a23afSMatthew G. Knepley 100259a2a23afSMatthew G. Knepley PetscFunctionBegin; 100269a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 100279a2a23afSMatthew G. Knepley PetscValidPointer(labels, 2); 100289a2a23afSMatthew G. Knepley PetscValidPointer(values, 3); 100299a2a23afSMatthew G. Knepley ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr); 100309a2a23afSMatthew G. Knepley ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr); 100319a2a23afSMatthew G. Knepley ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr); 100329a2a23afSMatthew G. Knepley for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;} 100339a2a23afSMatthew G. Knepley ierr = PetscFree(keys);CHKERRQ(ierr); 100349a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 100359a2a23afSMatthew G. Knepley } 100369a2a23afSMatthew G. Knepley 100379a2a23afSMatthew G. Knepley /*@ 100389a2a23afSMatthew G. Knepley DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM 100399a2a23afSMatthew G. Knepley 100409a2a23afSMatthew G. Knepley Not collective 100419a2a23afSMatthew G. Knepley 100429a2a23afSMatthew G. Knepley Input Parameter: 100439a2a23afSMatthew G. Knepley . dm - The DM 100449a2a23afSMatthew G. Knepley 100459a2a23afSMatthew G. Knepley Output Parameter: 100469a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data 100479a2a23afSMatthew G. Knepley 100489a2a23afSMatthew G. Knepley Level: advanced 100499a2a23afSMatthew G. Knepley 100509a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec() 100519a2a23afSMatthew G. Knepley @*/ 100529a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew) 100539a2a23afSMatthew G. Knepley { 100549a2a23afSMatthew G. Knepley PetscErrorCode ierr; 100559a2a23afSMatthew G. Knepley 100569a2a23afSMatthew G. Knepley PetscFunctionBegin; 100579a2a23afSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 1); 100589a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr); 100599a2a23afSMatthew G. Knepley ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr); 100609a2a23afSMatthew G. Knepley PetscFunctionReturn(0); 100619a2a23afSMatthew G. Knepley } 10062b5a892a1SMatthew G. Knepley 10063b5a892a1SMatthew G. Knepley /*@C 10064b5a892a1SMatthew G. Knepley DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement 10065b5a892a1SMatthew G. Knepley 10066b5a892a1SMatthew G. Knepley Not collective 10067b5a892a1SMatthew G. Knepley 10068b5a892a1SMatthew G. Knepley Input Parameters: 10069b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10070b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces 10071b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces 10072b5a892a1SMatthew G. Knepley 10073b5a892a1SMatthew G. Knepley Output Parameters: 10074b5a892a1SMatthew G. Knepley + ornt - The orientation which will take the source arrangement to the target arrangement 10075b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found 10076b5a892a1SMatthew G. Knepley 10077b5a892a1SMatthew G. Knepley Level: advanced 10078b5a892a1SMatthew G. Knepley 10079b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation() 10080b5a892a1SMatthew G. Knepley @*/ 10081b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found) 10082b5a892a1SMatthew G. Knepley { 10083b5a892a1SMatthew G. Knepley const PetscInt cS = DMPolytopeTypeGetConeSize(ct); 10084b5a892a1SMatthew G. Knepley const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2; 10085b5a892a1SMatthew G. Knepley PetscInt o, c; 10086b5a892a1SMatthew G. Knepley 10087b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10088b5a892a1SMatthew G. Knepley if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);} 10089b5a892a1SMatthew G. Knepley for (o = -nO; o < nO; ++o) { 10090b5a892a1SMatthew G. Knepley const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o); 10091b5a892a1SMatthew G. Knepley 10092b5a892a1SMatthew G. Knepley for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break; 10093b5a892a1SMatthew G. Knepley if (c == cS) {*ornt = o; break;} 10094b5a892a1SMatthew G. Knepley } 10095b5a892a1SMatthew G. Knepley *found = o == nO ? PETSC_FALSE : PETSC_TRUE; 10096b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10097b5a892a1SMatthew G. Knepley } 10098b5a892a1SMatthew G. Knepley 10099b5a892a1SMatthew G. Knepley /*@C 10100b5a892a1SMatthew G. Knepley DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement 10101b5a892a1SMatthew G. Knepley 10102b5a892a1SMatthew G. Knepley Not collective 10103b5a892a1SMatthew G. Knepley 10104b5a892a1SMatthew G. Knepley Input Parameters: 10105b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10106b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces 10107b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces 10108b5a892a1SMatthew G. Knepley 10109b5a892a1SMatthew G. Knepley Output Parameters: 10110b5a892a1SMatthew G. Knepley . ornt - The orientation which will take the source arrangement to the target arrangement 10111b5a892a1SMatthew G. Knepley 10112b5a892a1SMatthew G. Knepley Note: This function will fail if no suitable orientation can be found. 10113b5a892a1SMatthew G. Knepley 10114b5a892a1SMatthew G. Knepley Level: advanced 10115b5a892a1SMatthew G. Knepley 10116b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation() 10117b5a892a1SMatthew G. Knepley @*/ 10118b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt) 10119b5a892a1SMatthew G. Knepley { 10120b5a892a1SMatthew G. Knepley PetscBool found; 10121b5a892a1SMatthew G. Knepley PetscErrorCode ierr; 10122b5a892a1SMatthew G. Knepley 10123b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10124b5a892a1SMatthew G. Knepley ierr = DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr); 101252c71b3e2SJacob Faibussowitsch PetscCheckFalse(!found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]); 10126b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10127b5a892a1SMatthew G. Knepley } 10128b5a892a1SMatthew G. Knepley 10129b5a892a1SMatthew G. Knepley /*@C 10130b5a892a1SMatthew G. Knepley DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement 10131b5a892a1SMatthew G. Knepley 10132b5a892a1SMatthew G. Knepley Not collective 10133b5a892a1SMatthew G. Knepley 10134b5a892a1SMatthew G. Knepley Input Parameters: 10135b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10136b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices 10137b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices 10138b5a892a1SMatthew G. Knepley 10139b5a892a1SMatthew G. Knepley Output Parameters: 10140b5a892a1SMatthew G. Knepley + ornt - The orientation which will take the source arrangement to the target arrangement 10141b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found 10142b5a892a1SMatthew G. Knepley 10143b5a892a1SMatthew G. Knepley Level: advanced 10144b5a892a1SMatthew G. Knepley 10145b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation() 10146b5a892a1SMatthew G. Knepley @*/ 10147b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found) 10148b5a892a1SMatthew G. Knepley { 10149b5a892a1SMatthew G. Knepley const PetscInt cS = DMPolytopeTypeGetNumVertices(ct); 10150b5a892a1SMatthew G. Knepley const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2; 10151b5a892a1SMatthew G. Knepley PetscInt o, c; 10152b5a892a1SMatthew G. Knepley 10153b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10154b5a892a1SMatthew G. Knepley if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);} 10155b5a892a1SMatthew G. Knepley for (o = -nO; o < nO; ++o) { 10156b5a892a1SMatthew G. Knepley const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o); 10157b5a892a1SMatthew G. Knepley 10158b5a892a1SMatthew G. Knepley for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break; 10159b5a892a1SMatthew G. Knepley if (c == cS) {*ornt = o; break;} 10160b5a892a1SMatthew G. Knepley } 10161b5a892a1SMatthew G. Knepley *found = o == nO ? PETSC_FALSE : PETSC_TRUE; 10162b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10163b5a892a1SMatthew G. Knepley } 10164b5a892a1SMatthew G. Knepley 10165b5a892a1SMatthew G. Knepley /*@C 10166b5a892a1SMatthew G. Knepley DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement 10167b5a892a1SMatthew G. Knepley 10168b5a892a1SMatthew G. Knepley Not collective 10169b5a892a1SMatthew G. Knepley 10170b5a892a1SMatthew G. Knepley Input Parameters: 10171b5a892a1SMatthew G. Knepley + ct - The DMPolytopeType 10172b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices 10173b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices 10174b5a892a1SMatthew G. Knepley 10175b5a892a1SMatthew G. Knepley Output Parameters: 10176b5a892a1SMatthew G. Knepley . ornt - The orientation which will take the source arrangement to the target arrangement 10177b5a892a1SMatthew G. Knepley 10178b5a892a1SMatthew G. Knepley Note: This function will fail if no suitable orientation can be found. 10179b5a892a1SMatthew G. Knepley 10180b5a892a1SMatthew G. Knepley Level: advanced 10181b5a892a1SMatthew G. Knepley 10182b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation() 10183b5a892a1SMatthew G. Knepley @*/ 10184b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt) 10185b5a892a1SMatthew G. Knepley { 10186b5a892a1SMatthew G. Knepley PetscBool found; 10187b5a892a1SMatthew G. Knepley PetscErrorCode ierr; 10188b5a892a1SMatthew G. Knepley 10189b5a892a1SMatthew G. Knepley PetscFunctionBegin; 10190b5a892a1SMatthew G. Knepley ierr = DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr); 101912c71b3e2SJacob Faibussowitsch PetscCheckFalse(!found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]); 10192b5a892a1SMatthew G. Knepley PetscFunctionReturn(0); 10193b5a892a1SMatthew G. Knepley } 10194012bc364SMatthew G. Knepley 10195012bc364SMatthew G. Knepley /*@C 10196012bc364SMatthew G. Knepley DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type 10197012bc364SMatthew G. Knepley 10198012bc364SMatthew G. Knepley Not collective 10199012bc364SMatthew G. Knepley 10200012bc364SMatthew G. Knepley Input Parameters: 10201012bc364SMatthew G. Knepley + ct - The DMPolytopeType 10202012bc364SMatthew G. Knepley - point - Coordinates of the point 10203012bc364SMatthew G. Knepley 10204012bc364SMatthew G. Knepley Output Parameters: 10205012bc364SMatthew G. Knepley . inside - Flag indicating whether the point is inside the reference cell of given type 10206012bc364SMatthew G. Knepley 10207012bc364SMatthew G. Knepley Level: advanced 10208012bc364SMatthew G. Knepley 10209012bc364SMatthew G. Knepley .seealso: DMLocatePoints() 10210012bc364SMatthew G. Knepley @*/ 10211012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside) 10212012bc364SMatthew G. Knepley { 10213012bc364SMatthew G. Knepley PetscReal sum = 0.0; 10214012bc364SMatthew G. Knepley PetscInt d; 10215012bc364SMatthew G. Knepley 10216012bc364SMatthew G. Knepley PetscFunctionBegin; 10217012bc364SMatthew G. Knepley *inside = PETSC_TRUE; 10218012bc364SMatthew G. Knepley switch (ct) { 10219012bc364SMatthew G. Knepley case DM_POLYTOPE_TRIANGLE: 10220012bc364SMatthew G. Knepley case DM_POLYTOPE_TETRAHEDRON: 10221012bc364SMatthew G. Knepley for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) { 10222012bc364SMatthew G. Knepley if (point[d] < -1.0) {*inside = PETSC_FALSE; break;} 10223012bc364SMatthew G. Knepley sum += point[d]; 10224012bc364SMatthew G. Knepley } 10225012bc364SMatthew G. Knepley if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;} 10226012bc364SMatthew G. Knepley break; 10227012bc364SMatthew G. Knepley case DM_POLYTOPE_QUADRILATERAL: 10228012bc364SMatthew G. Knepley case DM_POLYTOPE_HEXAHEDRON: 10229012bc364SMatthew G. Knepley for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) 10230012bc364SMatthew G. Knepley if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;} 10231012bc364SMatthew G. Knepley break; 10232012bc364SMatthew G. Knepley default: 1023398921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]); 10234012bc364SMatthew G. Knepley } 10235012bc364SMatthew G. Knepley PetscFunctionReturn(0); 10236012bc364SMatthew G. Knepley } 10237