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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMSWARM/DMSwarmVectorDefineField.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMSwarmVectorDefineField</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/DMSWARM/DMSwarmVectorDefineField.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMSwarmVectorDefineField"><H1>DMSwarmVectorDefineField</H1></A>
Sets the field from which to define a <A HREF="../Vec/Vec.html#Vec">Vec</A> object when <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>(), or <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>() is called
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmswarm.h"
PETSC_EXTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMSWARM/DMSwarmVectorDefineField.html#DMSwarmVectorDefineField">DMSwarmVectorDefineField</A>(<A HREF="../DM/DM.html#DM">DM</A> dm,const char fieldname[])
</PRE>
Collective on <A HREF="../DM/DM.html#DM">DM</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>- a DMSwarm
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fieldname </B></TD><TD>- the textual name given to a registered field
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<P>
The field with name fieldname must be defined as having a data type of <A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A>.
<P>
This function must be called prior to calling <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>(), <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>().
Mutiple calls to <A HREF="../DMSWARM/DMSwarmVectorDefineField.html#DMSwarmVectorDefineField">DMSwarmVectorDefineField</A>() are permitted.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DMSWARM/DMSwarmRegisterPetscDatatypeField.html#DMSwarmRegisterPetscDatatypeField">DMSwarmRegisterPetscDatatypeField</A>(), <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>(), <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/swarm/swarm.c.html#DMSwarmVectorDefineField">src/dm/impls/swarm/swarm.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/examples/tutorials/swarm_ex1.c.html">src/dm/examples/tutorials/swarm_ex1.c.html</A><BR>
<A HREF="../../../src/dm/examples/tutorials/swarm_ex2.c.html">src/dm/examples/tutorials/swarm_ex2.c.html</A><BR>
<BR><A HREF="./index.html">Index of all DMSWARM 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>
|
