/*@C
SlicedCreateGlobalVector - Creates a vector of the correct size to be gathered into
by the slice.
Collective on Sliced
Input Parameter:
. slice - the slice object
Output Parameters:
. gvec - the global vector
Level: advanced
Notes: Once this has been created you cannot add additional arrays or vectors to be packed.
.seealso SlicedDestroy(), SlicedCreate(), SlicedGetGlobalIndices()
@*/
PetscErrorCode PETSCDM_DLLEXPORT SlicedCreateGlobalVector(Sliced slice,Vec *gvec)
{
PetscErrorCode ierr;
PetscInt bs,cnt,i;
PetscFunctionBegin;
PetscValidHeaderSpecific(slice,DM_COOKIE,1);
PetscValidPointer(gvec,2);
*gvec = 0;
if (slice->globalvector) {
ierr = PetscObjectGetReference((PetscObject)slice->globalvector,&cnt);CHKERRQ(ierr);
if (cnt == 1) { /* Nobody else has a reference so we can just reference it and give it away */
*gvec = slice->globalvector;
ierr = PetscObjectReference((PetscObject)*gvec);CHKERRQ(ierr);
ierr = VecZeroEntries(*gvec);CHKERRQ(ierr);
} else { /* Someone else has a reference so we duplicate the global vector */
ierr = VecDuplicate(slice->globalvector,gvec);CHKERRQ(ierr);
}
} else {
bs = slice->bs;
/* VecCreateGhostBlock requires ghosted blocks to be given in terms of first entry, not block. Here, we munge the
* ghost array for this call, then put it back. */
for (i=0; i<slice->Nghosts; i++) slice->ghosts[i] *= bs;
ierr = VecCreateGhostBlock(((PetscObject)slice)->comm,bs,slice->n*bs,PETSC_DETERMINE,slice->Nghosts,slice->ghosts,&slice->globalvector);CHKERRQ(ierr);
for (i=0; i<slice->Nghosts; i++) slice->ghosts[i] /= bs;
*gvec = slice->globalvector;
ierr = PetscObjectReference((PetscObject)*gvec);CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
/*@
DMDACreateNaturalVector - Creates a parallel PETSc vector that
will hold vector values in the natural numbering, rather than in
the PETSc parallel numbering associated with the DMDA.
Collective
Input Parameter:
. da - the distributed array
Output Parameter:
. g - the distributed global vector
Level: developer
Note:
The output parameter, g, is a regular PETSc vector that should be destroyed
with a call to VecDestroy() when usage is finished.
The number of local entries in the vector on each process is the same
as in a vector created with DMCreateGlobalVector().
.keywords: distributed array, create, global, distributed, vector
.seealso: DMCreateLocalVector(), VecDuplicate(), VecDuplicateVecs(),
DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMGlobalToLocalBegin(),
DMGlobalToLocalEnd(), DMDALocalToGlobalBegin()
@*/
PetscErrorCode DMDACreateNaturalVector(DM da,Vec *g)
{
PetscErrorCode ierr;
PetscInt cnt;
DM_DA *dd = (DM_DA*)da->data;
PetscFunctionBegin;
PetscValidHeaderSpecificType(da,DM_CLASSID,1,DMDA);
PetscValidPointer(g,2);
if (dd->natural) {
ierr = PetscObjectGetReference((PetscObject)dd->natural,&cnt);CHKERRQ(ierr);
if (cnt == 1) { /* object is not currently used by anyone */
ierr = PetscObjectReference((PetscObject)dd->natural);CHKERRQ(ierr);
*g = dd->natural;
} else {
ierr = VecDuplicate(dd->natural,g);CHKERRQ(ierr);
}
} else { /* create the first version of this guy */
ierr = VecCreate(PetscObjectComm((PetscObject)da),g);CHKERRQ(ierr);
ierr = VecSetSizes(*g,dd->Nlocal,PETSC_DETERMINE);CHKERRQ(ierr);
ierr = VecSetBlockSize(*g, dd->w);CHKERRQ(ierr);
ierr = VecSetType(*g,da->vectype);CHKERRQ(ierr);
ierr = PetscObjectReference((PetscObject)*g);CHKERRQ(ierr);
dd->natural = *g;
}
PetscFunctionReturn(0);
}
/*@
ISDestroy - Destroys an index set.
Collective on IS
Input Parameters:
. is - the index set
Level: beginner
.seealso: ISCreateGeneral(), ISCreateStride(), ISCreateBlocked()
@*/
PetscErrorCode ISDestroy(IS *is)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!*is) PetscFunctionReturn(0);
PetscValidHeaderSpecific((*is),IS_CLASSID,1);
if (--((PetscObject)(*is))->refct > 0) {
*is = 0;
PetscFunctionReturn(0);
}
if ((*is)->complement) {
PetscInt refcnt;
ierr = PetscObjectGetReference((PetscObject)((*is)->complement), &refcnt);
CHKERRQ(ierr);
if (refcnt > 1) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Nonlocal IS has not been restored");
ierr = ISDestroy(&(*is)->complement);
CHKERRQ(ierr);
}
if ((*is)->ops->destroy) {
ierr = (*(*is)->ops->destroy)(*is);
CHKERRQ(ierr);
}
ierr = PetscLayoutDestroy(&(*is)->map);
CHKERRQ(ierr);
/* Destroy local representations of offproc data. */
ierr = PetscFree((*is)->total);
CHKERRQ(ierr);
ierr = PetscFree((*is)->nonlocal);
CHKERRQ(ierr);
ierr = PetscHeaderDestroy(is);
CHKERRQ(ierr);
PetscFunctionReturn(0);
}
/*@
ISRestoreNonlocalIS - Restore the IS obtained with ISGetNonlocalIS().
Not collective.
Input Parameter:
+ is - the index set
- complement - index set of is's nonlocal indices
Level: intermediate
Concepts: index sets^getting nonlocal indices
Concepts: index sets^restoring nonlocal indices
.seealso: ISGetNonlocalIS(), ISGetNonlocalIndices(), ISRestoreNonlocalIndices()
@*/
PetscErrorCode ISRestoreNonlocalIS(IS is, IS *complement)
{
PetscErrorCode ierr;
PetscInt refcnt;
PetscFunctionBegin;
PetscValidHeaderSpecific(is,IS_CLASSID,1);
PetscValidPointer(complement,2);
if (*complement != is->complement) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Complement IS being restored was not obtained with ISGetNonlocalIS()");
ierr = PetscObjectGetReference((PetscObject)(is->complement), &refcnt);CHKERRQ(ierr);
if (refcnt <= 1) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Duplicate call to ISRestoreNonlocalIS() detected");
ierr = PetscObjectDereference((PetscObject)(is->complement));CHKERRQ(ierr);
PetscFunctionReturn(0);
}
int main(int argc, char **argv)
{
MPI_Comm comm;
DM base, preForest, postForest;
PetscInt dim = 2;
PetscInt preCount, postCount;
Vec preVec, postVecTransfer, postVecExact;
PetscErrorCode (*funcs[1]) (PetscInt,PetscReal,const PetscReal [],PetscInt,PetscScalar [], void *) = {MultiaffineFunction};
void *ctxs[1] = {NULL};
const PetscInt cells[] = {3, 3, 3};
PetscReal diff, tol = PETSC_SMALL;
PetscBool linear = PETSC_FALSE;
PetscBool useFV = PETSC_FALSE;
PetscDS ds;
bc_func_ctx bcCtx;
DMLabel adaptLabel;
PetscErrorCode ierr;
ierr = PetscInitialize(&argc, &argv, NULL,help);if (ierr) return ierr;
comm = PETSC_COMM_WORLD;
ierr = PetscOptionsBegin(comm, "", "DMForestTransferVec() Test Options", "DMFOREST");CHKERRQ(ierr);
ierr = PetscOptionsInt("-dim", "The dimension (2 or 3)", "ex2.c", dim, &dim, NULL);CHKERRQ(ierr);
ierr = PetscOptionsBool("-linear","Transfer a simple linear function", "ex2.c", linear, &linear, NULL);CHKERRQ(ierr);
ierr = PetscOptionsBool("-use_fv","Use a finite volume approximation", "ex2.c", useFV, &useFV, NULL);CHKERRQ(ierr);
ierr = PetscOptionsEnd();CHKERRQ(ierr);
if (linear) {
funcs[0] = LinearFunction;
}
bcCtx.func = funcs[0];
bcCtx.dim = dim;
bcCtx.Nf = 1;
bcCtx.ctx = NULL;
/* the base mesh */
ierr = DMPlexCreateHexBoxMesh(comm, dim, cells, DM_BOUNDARY_NONE, DM_BOUNDARY_NONE, DM_BOUNDARY_NONE, &base);CHKERRQ(ierr);
if (useFV) {
PetscFV fv;
PetscLimiter limiter;
DM baseFV;
ierr = DMPlexConstructGhostCells(base,NULL,NULL,&baseFV);CHKERRQ(ierr);
ierr = DMDestroy(&base);CHKERRQ(ierr);
base = baseFV;
ierr = PetscFVCreate(comm, &fv);CHKERRQ(ierr);
ierr = PetscFVSetSpatialDimension(fv,dim);CHKERRQ(ierr);
ierr = PetscFVSetType(fv,PETSCFVLEASTSQUARES);CHKERRQ(ierr);
ierr = PetscFVSetNumComponents(fv,1);CHKERRQ(ierr);
ierr = PetscLimiterCreate(comm,&limiter);CHKERRQ(ierr);
ierr = PetscLimiterSetType(limiter,PETSCLIMITERNONE);CHKERRQ(ierr);
ierr = PetscFVSetLimiter(fv,limiter);CHKERRQ(ierr);
ierr = PetscLimiterDestroy(&limiter);CHKERRQ(ierr);
ierr = PetscFVSetFromOptions(fv);CHKERRQ(ierr);
ierr = DMSetField(base,0,(PetscObject)fv);CHKERRQ(ierr);
ierr = PetscFVDestroy(&fv);CHKERRQ(ierr);
} else {
PetscFE fe;
ierr = PetscFECreateDefault(base,dim,1,PETSC_FALSE,NULL,PETSC_DEFAULT,&fe);CHKERRQ(ierr);
ierr = DMSetField(base,0,(PetscObject)fe);CHKERRQ(ierr);
ierr = PetscFEDestroy(&fe);CHKERRQ(ierr);
}
{
PetscDS prob;
PetscInt comps[] = {0};
PetscInt ids[] = {1, 2, 3, 4, 5, 6};
ierr = DMGetDS(base,&prob);CHKERRQ(ierr);
ierr = PetscDSAddBoundary(prob,PETSC_TRUE, "bc", "marker", 0, 1, comps, useFV ? (void(*)()) bc_func_fv : (void(*)()) funcs[0], 2 * dim, ids, useFV ? (void *) &bcCtx : NULL);CHKERRQ(ierr);
}
ierr = AddIdentityLabel(base);CHKERRQ(ierr);
ierr = DMViewFromOptions(base,NULL,"-dm_base_view");CHKERRQ(ierr);
/* the pre adaptivity forest */
ierr = DMCreate(comm,&preForest);CHKERRQ(ierr);
ierr = DMSetType(preForest,(dim == 2) ? DMP4EST : DMP8EST);CHKERRQ(ierr);
ierr = DMGetDS(base,&ds);CHKERRQ(ierr);
ierr = DMSetDS(preForest,ds);CHKERRQ(ierr);
ierr = DMForestSetBaseDM(preForest,base);CHKERRQ(ierr);
ierr = DMForestSetMinimumRefinement(preForest,1);CHKERRQ(ierr);
ierr = DMForestSetInitialRefinement(preForest,1);CHKERRQ(ierr);
ierr = DMSetFromOptions(preForest);CHKERRQ(ierr);
ierr = DMSetUp(preForest);CHKERRQ(ierr);
ierr = DMViewFromOptions(preForest,NULL,"-dm_pre_view");CHKERRQ(ierr);
/* the pre adaptivity field */
ierr = DMCreateGlobalVector(preForest,&preVec);CHKERRQ(ierr);
ierr = DMProjectFunction(preForest,0.,funcs,ctxs,INSERT_VALUES,preVec);CHKERRQ(ierr);
ierr = VecViewFromOptions(preVec,NULL,"-vec_pre_view");CHKERRQ(ierr);
ierr = PetscObjectGetReference((PetscObject)preForest,&preCount);CHKERRQ(ierr);
/* adapt */
ierr = CreateAdaptivityLabel(preForest,&adaptLabel);CHKERRQ(ierr);
ierr = DMForestTemplate(preForest,comm,&postForest);CHKERRQ(ierr);
ierr = DMForestSetMinimumRefinement(postForest,0);CHKERRQ(ierr);
ierr = DMForestSetInitialRefinement(postForest,0);CHKERRQ(ierr);
ierr = DMForestSetAdaptivityLabel(postForest,adaptLabel);CHKERRQ(ierr);
ierr = DMLabelDestroy(&adaptLabel);CHKERRQ(ierr);
ierr = DMSetUp(postForest);CHKERRQ(ierr);
ierr = DMViewFromOptions(postForest,NULL,"-dm_post_view");CHKERRQ(ierr);
/* transfer */
ierr = DMCreateGlobalVector(postForest,&postVecTransfer);CHKERRQ(ierr);
ierr = DMForestTransferVec(preForest,preVec,postForest,postVecTransfer,PETSC_TRUE,0.0);CHKERRQ(ierr);
ierr = VecViewFromOptions(postVecTransfer,NULL,"-vec_post_transfer_view");CHKERRQ(ierr);
/* the exact post adaptivity field */
ierr = DMCreateGlobalVector(postForest,&postVecExact);CHKERRQ(ierr);
ierr = DMProjectFunction(postForest,0.,funcs,ctxs,INSERT_VALUES,postVecExact);CHKERRQ(ierr);
ierr = VecViewFromOptions(postVecExact,NULL,"-vec_post_exact_view");CHKERRQ(ierr);
/* compare */
ierr = VecAXPY(postVecTransfer,-1.,postVecExact);CHKERRQ(ierr);
ierr = VecViewFromOptions(postVecTransfer,NULL,"-vec_diff_view");CHKERRQ(ierr);
ierr = VecNorm(postVecTransfer,NORM_2,&diff);CHKERRQ(ierr);
/* output */
if (diff < tol) {
ierr = PetscPrintf(comm,"DMForestTransferVec() passes.\n");CHKERRQ(ierr);
} else {
ierr = PetscPrintf(comm,"DMForestTransferVec() fails with error %g and tolerance %g\n",diff,tol);CHKERRQ(ierr);
}
/* disconnect preForest from postForest */
ierr = DMForestSetAdaptivityForest(postForest,NULL);CHKERRQ(ierr);
ierr = PetscObjectGetReference((PetscObject)preForest,&postCount);CHKERRQ(ierr);
if (postCount != preCount) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Adaptation not memory neutral: reference count increase from %d to %d\n",preCount,postCount);
/* cleanup */
ierr = VecDestroy(&postVecExact);CHKERRQ(ierr);
ierr = VecDestroy(&postVecTransfer);CHKERRQ(ierr);
ierr = DMDestroy(&postForest);CHKERRQ(ierr);
ierr = VecDestroy(&preVec);CHKERRQ(ierr);
ierr = DMDestroy(&preForest);CHKERRQ(ierr);
ierr = DMDestroy(&base);CHKERRQ(ierr);
ierr = PetscFinalize();
return ierr;
}
