petsc-3.14.6 2021-03-30

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

Level

advanced

VecTaggerCreate

Synopsis

Input Arguments

Output Arguments

See Also

Level

Location

Examples

Implementations