1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecTaggerCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>VecTaggerCreate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.10.3 v3.10.3 docs/manualpages/Vec/VecTaggerCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="VecTaggerCreate"><H1>VecTaggerCreate</H1></A>
create a <A HREF="../Vec/Vec.html#Vec">Vec</A> 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.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscvec.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Vec/VecTaggerCreate.html#VecTaggerCreate">VecTaggerCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../Vec/VecTagger.html#VecTagger">VecTagger</A> *tagger)
</PRE>
Once a <A HREF="../Vec/VecTagger.html#VecTagger">VecTagger</A> is created (<A HREF="../Vec/VecTaggerCreate.html#VecTaggerCreate">VecTaggerCreate</A>()), optionally modified by options (<A HREF="../Vec/VecTaggerSetFromOptions.html#VecTaggerSetFromOptions">VecTaggerSetFromOptions</A>()), and
set up (<A HREF="../Vec/VecTaggerSetUp.html#VecTaggerSetUp">VecTaggerSetUp</A>()), it is applied to vectors with <A HREF="../Vec/VecTaggerComputeIS.html#VecTaggerComputeIS">VecTaggerComputeIS</A>() to comute the selected index sets.
<P>
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.
<P>
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.
<P>
Collective
<P>
<H3><FONT COLOR="#CC3333">Input Arguments</FONT></H3>
<DT><B>comm </B> -communicator on which the vec tagger will operate
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Arguments</FONT></H3>
<DT><B>tagger </B> -new <A HREF="../Vec/Vec.html#Vec">Vec</A> tagger context
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Vec/VecTaggerSetBlockSize.html#VecTaggerSetBlockSize">VecTaggerSetBlockSize</A>(), <A HREF="../Vec/VecTaggerSetFromOptions.html#VecTaggerSetFromOptions">VecTaggerSetFromOptions</A>(), <A HREF="../Vec/VecTaggerSetUp.html#VecTaggerSetUp">VecTaggerSetUp</A>(), <A HREF="../Vec/VecTaggerComputeIS.html#VecTaggerComputeIS">VecTaggerComputeIS</A>(), <A HREF="../Vec/VecTaggerComputeBoxes.html#VecTaggerComputeBoxes">VecTaggerComputeBoxes</A>(), <A HREF="../Vec/VecTaggerDestroy.html#VecTaggerDestroy">VecTaggerDestroy</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/vec/vec/utils/tagger/interface/tagger.c.html#VecTaggerCreate">src/vec/vec/utils/tagger/interface/tagger.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/vec/vec/utils/tagger/examples/tutorials/ex1.c.html">src/vec/vec/utils/tagger/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex11.c.html">src/ts/examples/tutorials/ex11.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/vec/vec/utils/tagger/impls/absolute.c.html#VecTaggerCreate_Absolute">VecTaggerCreate_Absolute in src/vec/vec/utils/tagger/impls/absolute.c</A><BR>
<A HREF="../../../src/vec/vec/utils/tagger/impls/and.c.html#VecTaggerCreate_And">VecTaggerCreate_And in src/vec/vec/utils/tagger/impls/and.c</A><BR>
<A HREF="../../../src/vec/vec/utils/tagger/impls/andor.c.html#VecTaggerCreate_AndOr">VecTaggerCreate_AndOr in src/vec/vec/utils/tagger/impls/andor.c</A><BR>
<A HREF="../../../src/vec/vec/utils/tagger/impls/cdf.c.html#VecTaggerCreate_CDF">VecTaggerCreate_CDF in src/vec/vec/utils/tagger/impls/cdf.c</A><BR>
<A HREF="../../../src/vec/vec/utils/tagger/impls/or.c.html#VecTaggerCreate_Or">VecTaggerCreate_Or in src/vec/vec/utils/tagger/impls/or.c</A><BR>
<A HREF="../../../src/vec/vec/utils/tagger/impls/relative.c.html#VecTaggerCreate_Relative">VecTaggerCreate_Relative in src/vec/vec/utils/tagger/impls/relative.c</A><BR>
<A HREF="../../../src/vec/vec/utils/tagger/impls/simple.c.html#VecTaggerCreate_Simple">VecTaggerCreate_Simple in src/vec/vec/utils/tagger/impls/simple.c</A><BR>
<BR><A HREF="./index.html">Index of all Vec routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
