petsc-3.10.4 2019-02-26
Report Typos and Errors

VecTaggerCreate

create a Vec tagger context. This object is used to control the tagging/selection of index sets based on the values in a vector. This is used, for example, in adaptive simulations when aspects are selected for refinement or coarsening. The primary intent is that the selected index sets are based purely on the values in the vector, though implementations that do not follow this intent are possible.

Synopsis

#include "petscvec.h" 
PetscErrorCode VecTaggerCreate(MPI_Comm comm,VecTagger *tagger)
Once a VecTagger is created (VecTaggerCreate()), optionally modified by options (VecTaggerSetFromOptions()), and set up (VecTaggerSetUp()), it is applied to vectors with VecTaggerComputeIS() to comute the selected index sets.

In many cases, the selection criteria for an index is whether the corresponding value falls within a collection of boxes: for this common case, VecTaggerCreateBoxes() can also be used to determine those boxes.

Provided implementations support tagging based on a box/interval of values (VECTAGGERABSOLUTE), based on a box of values of relative to the range of values present in the vector (VECTAGGERRELATIVE), based on where values fall in the cumulative distribution of values in the vector (VECTAGGERCDF), and based on unions (VECTAGGEROR) or intersections (VECTAGGERAND) of other criteria.

Collective

Input Arguments

comm -communicator on which the vec tagger will operate

Output Arguments

tagger -new Vec tagger context

See Also

VecTaggerSetBlockSize(), VecTaggerSetFromOptions(), VecTaggerSetUp(), VecTaggerComputeIS(), VecTaggerComputeBoxes(), VecTaggerDestroy()

Level

advanced

Location

src/vec/vec/utils/tagger/interface/tagger.c

Examples

src/vec/vec/utils/tagger/examples/tutorials/ex1.c.html
src/ts/examples/tutorials/ex11.c.html

Implementations

VecTaggerCreate_Absolute in src/vec/vec/utils/tagger/impls/absolute.c
VecTaggerCreate_And in src/vec/vec/utils/tagger/impls/and.c
VecTaggerCreate_AndOr in src/vec/vec/utils/tagger/impls/andor.c
VecTaggerCreate_CDF in src/vec/vec/utils/tagger/impls/cdf.c
VecTaggerCreate_Or in src/vec/vec/utils/tagger/impls/or.c
VecTaggerCreate_Relative in src/vec/vec/utils/tagger/impls/relative.c
VecTaggerCreate_Simple in src/vec/vec/utils/tagger/impls/simple.c

Index of all Vec routines
Table of Contents for all manual pages
Index of all manual pages