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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMSTAG/DMStagVecSplitToDMDA.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMStagVecSplitToDMDA</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/DMSTAG/DMStagVecSplitToDMDA.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMStagVecSplitToDMDA"><H1>DMStagVecSplitToDMDA</H1></A>
create a <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> and <A HREF="../Vec/Vec.html#Vec">Vec</A> from a DMStag and <A HREF="../Vec/Vec.html#Vec">Vec</A>
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMSTAG/DMStagVecSplitToDMDA.html#DMStagVecSplitToDMDA">DMStagVecSplitToDMDA</A>(<A HREF="../DM/DM.html#DM">DM</A> dm,<A HREF="../Vec/Vec.html#Vec">Vec</A> vec,<A HREF="../DMSTAG/DMStagStencilLocation.html#DMStagStencilLocation">DMStagStencilLocation</A> loc,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> c,<A HREF="../DM/DM.html#DM">DM</A> *pda,<A HREF="../Vec/Vec.html#Vec">Vec</A> *pdavec)
</PRE>
Logically Collective
<P>
High-level helper function which accepts a DMStag, a global vector, and location/dof,
and generates a corresponding <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> and <A HREF="../Vec/Vec.html#Vec">Vec</A>.
<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 DMStag object
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>vec</B></TD><TD>- <A HREF="../Vec/Vec.html#Vec">Vec</A> object associated with dm
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>loc </B></TD><TD>- which subgrid to extract (see <A HREF="../DMSTAG/DMStagStencilLocation.html#DMStagStencilLocation">DMStagStencilLocation</A>)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>c </B></TD><TD>- which component to extract (see note below)
</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>pda </B></TD><TD>- the new <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pdavec </B></TD><TD>- the new <A HREF="../Vec/Vec.html#Vec">Vec</A>
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
If a c value of -k is provided, the first k dof for that position are extracted,
padding with zero values if needbe. If a non-negative value is provided, a single
dof is extracted.
<P>
The caller is responsible for destroying the created <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> and <A HREF="../Vec/Vec.html#Vec">Vec</A>.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DMSTAG/DMSTAG.html#DMSTAG">DMSTAG</A>, <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A>, <A HREF="../DMSTAG/DMStagMigrateVec.html#DMStagMigrateVec">DMStagMigrateVec</A>(), <A HREF="../DMSTAG/DMStagCreateCompatibleDMStag.html#DMStagCreateCompatibleDMStag">DMStagCreateCompatibleDMStag</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/dm/impls/stag/stagda.c.html#DMStagVecSplitToDMDA">src/dm/impls/stag/stagda.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/impls/stag/tutorials/ex4.c.html">src/dm/impls/stag/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex6.c.html">src/dm/impls/stag/tutorials/ex6.c.html</A><BR>
<BR><A HREF="./index.html">Index of all DMSTAG 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>
|
