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
59
60
61
62
63
64
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DT/PetscDSGetBoundary.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscDSGetBoundary</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/DT/PetscDSGetBoundary.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscDSGetBoundary"><H1>PetscDSGetBoundary</H1></A>
Add a boundary condition to the model
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscds.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DT/PetscDSGetBoundary.html#PetscDSGetBoundary">PetscDSGetBoundary</A>(<A HREF="../DM/PetscDS.html#PetscDS">PetscDS</A> ds, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> bd, <A HREF="../DM/DMBoundaryConditionType.html#DMBoundaryConditionType">DMBoundaryConditionType</A> *type, const char **name, const char **labelname, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *field, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *numcomps, const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> **comps, void (**func)(void), <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *numids, const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> **ids, void **ctx)
</PRE>
<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>ds </B></TD><TD>- The <A HREF="../DM/PetscDS.html#PetscDS">PetscDS</A> object
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bd </B></TD><TD>- The BC number
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>type </B></TD><TD>- The type of condition, e.g. <A HREF="../DM/DMBoundaryConditionType.html#DMBoundaryConditionType">DM_BC_ESSENTIAL</A>/<A HREF="../DM/DMBoundaryConditionType.html#DMBoundaryConditionType">DM_BC_ESSENTIAL_FIELD</A> (Dirichlet), or <A HREF="../DM/DMBoundaryConditionType.html#DMBoundaryConditionType">DM_BC_NATURAL</A> (Neumann)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>name </B></TD><TD>- The BC name
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>labelname </B></TD><TD>- The label defining constrained points
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>field </B></TD><TD>- The field to constrain
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>numcomps </B></TD><TD>- The number of constrained field components
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>comps </B></TD><TD>- An array of constrained component numbers
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bcFunc </B></TD><TD>- A pointwise function giving boundary values
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>numids </B></TD><TD>- The number of <A HREF="../DM/DMLabel.html#DMLabel">DMLabel</A> ids for constrained points
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ids </B></TD><TD>- An array of ids for constrained points
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- An optional user context for bcFunc
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-bc_<boundary name> <num> </B></TD><TD>- Overrides the boundary ids
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-bc_<boundary name>_comp <num> </B></TD><TD>- Overrides the boundary components
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DT/PetscDSAddBoundary.html#PetscDSAddBoundary">PetscDSAddBoundary</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/dt/interface/dtds.c.html#PetscDSGetBoundary">src/dm/dt/interface/dtds.c</A>
<BR><A HREF="./index.html">Index of all DT 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>
|
