File: DMDAGetFieldName.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (50 lines) | stat: -rw-r--r-- 3,338 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMDA/DMDAGetFieldName.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMDAGetFieldName</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/DMDA/DMDAGetFieldName.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMDAGetFieldName"><H1>DMDAGetFieldName</H1></A>
Gets the names of individual field components in multicomponent vectors associated with a <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A>. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmda.h"   
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../DMDA/DMDAGetFieldName.html#DMDAGetFieldName">DMDAGetFieldName</A>(<A HREF="../DM/DM.html#DM">DM</A> da,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nf,const char **name)
</PRE>
Not collective; name will contain a common value
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>da </B></TD><TD>- the distributed array
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nf </B></TD><TD>- field number for the <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> (0, 1, ... dof-1), where dof indicates the
number of degrees of freedom per node within the <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A>
</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>names </B></TD><TD>- the name of the field (component)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
It must be called after having called <A HREF="../DM/DMSetUp.html#DMSetUp">DMSetUp</A>().
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DMDA/DMDASetFieldName.html#DMDASetFieldName">DMDASetFieldName</A>(), <A HREF="../DMDA/DMDASetCoordinateName.html#DMDASetCoordinateName">DMDASetCoordinateName</A>(), <A HREF="../DMDA/DMDAGetCoordinateName.html#DMDAGetCoordinateName">DMDAGetCoordinateName</A>(), <A HREF="../DM/DMSetUp.html#DMSetUp">DMSetUp</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/da/dacorn.c.html#DMDAGetFieldName">src/dm/impls/da/dacorn.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/tutorials/ex42.c.html">src/ksp/ksp/tutorials/ex42.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex43.c.html">src/ksp/ksp/tutorials/ex43.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex49.c.html">src/ksp/ksp/tutorials/ex49.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex14.c.html">src/ts/tutorials/ex14.c.html</A><BR>
<BR><A HREF="./index.html">Index of all DMDA 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>