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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DM/DMRemoveLabel.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMRemoveLabel</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/DM/DMRemoveLabel.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMRemoveLabel"><H1>DMRemoveLabel</H1></A>
Remove the label given by name from this mesh
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdm.h"
#include "petscdmlabel.h"
#include "petscds.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DM/DMRemoveLabel.html#DMRemoveLabel">DMRemoveLabel</A>(<A HREF="../DM/DM.html#DM">DM</A> dm, const char name[], <A HREF="../DM/DMLabel.html#DMLabel">DMLabel</A> *label)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dm </B></TD><TD>- The <A HREF="../DM/DM.html#DM">DM</A> object
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>name </B></TD><TD>- The label name
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>label </B></TD><TD>- The <A HREF="../DM/DMLabel.html#DMLabel">DMLabel</A>, or NULL if the label is absent
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../DM/DMRemoveLabel.html#DMRemoveLabel">DMRemoveLabel</A>(dm,name,NULL) removes the label from dm and calls
<A HREF="../DMLABEL/DMLabelDestroy.html#DMLabelDestroy">DMLabelDestroy</A>() on the label.
<P>
<A HREF="../DM/DMRemoveLabel.html#DMRemoveLabel">DMRemoveLabel</A>(dm,name,&label) removes the label from dm, but it DOES NOT
call <A HREF="../DMLABEL/DMLabelDestroy.html#DMLabelDestroy">DMLabelDestroy</A>(). Instead, the label is returned and the user is
responsible of calling <A HREF="../DMLABEL/DMLabelDestroy.html#DMLabelDestroy">DMLabelDestroy</A>() at some point.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DM/DMCreateLabel.html#DMCreateLabel">DMCreateLabel</A>(), <A HREF="../DM/DMHasLabel.html#DMHasLabel">DMHasLabel</A>(), <A HREF="../DM/DMGetLabel.html#DMGetLabel">DMGetLabel</A>(), <A HREF="../DM/DMGetLabelValue.html#DMGetLabelValue">DMGetLabelValue</A>(), <A HREF="../DM/DMSetLabelValue.html#DMSetLabelValue">DMSetLabelValue</A>(), <A HREF="../DMLABEL/DMLabelDestroy.html#DMLabelDestroy">DMLabelDestroy</A>(), <A HREF="../DM/DMRemoveLabelBySelf.html#DMRemoveLabelBySelf">DMRemoveLabelBySelf</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/interface/dm.c.html#DMRemoveLabel">src/dm/interface/dm.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/label/tutorials/ex1.c.html">src/dm/label/tutorials/ex1.c.html</A><BR>
<BR><A HREF="./index.html">Index of all DM 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>
|
