VecTaggerCreate#

create a VecTagger context.

Synopsis#

#include "petscvec.h" 
PetscErrorCode VecTaggerCreate(MPI_Comm comm, VecTagger *tagger)

Collective

Input Parameter#

comm - communicator on which the VecTagger will operate

Output Parameter#

tagger - new Vec tagger context

Notes#

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.

Once a VecTagger is created (VecTaggerCreate()), optionally modified by options (VecTaggerSetFromOptions()), and set up (VecTaggerSetUp()), it is applied to vectors with VecTaggerComputeIS() to compute the selected index sets.

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.