File: PetscViewerGLVisSetFields.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (61 lines) | stat: -rw-r--r-- 5,454 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
51
52
53
54
55
56
57
58
59
60
61
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Viewer/PetscViewerGLVisSetFields.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscViewerGLVisSetFields</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/Viewer/PetscViewerGLVisSetFields.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscViewerGLVisSetFields"><H1>PetscViewerGLVisSetFields</H1></A>
Sets the required information to visualize different fields from a vector. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscviewer.h" 
#include "petscsys.h"    
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Viewer/PetscViewerGLVisSetFields.html#PetscViewerGLVisSetFields">PetscViewerGLVisSetFields</A>(<A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A> viewer, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nf, const char* fec_type[], <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> dim[], <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>(*g2l)(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>,<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>[],void*), <A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> Vfield[], void* ctx, <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>(*destroyctx)(void*))
</PRE>
Logically Collective on <A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</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>viewer     </B></TD><TD>- the <A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nf         </B></TD><TD>- number of fields to be visualized
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fec_type   </B></TD><TD>- the type of finite element to be used to visualize the data (see FiniteElementCollection::Name() in MFEM)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dim        </B></TD><TD>- array of space dimension for field vectors (used to initialize the scene)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>g2lfields  </B></TD><TD>- User routine to compute the local field vectors to be visualized; <A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> is used in place of <A HREF="../Vec/Vec.html#Vec">Vec</A> on the prototype
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Vfield     </B></TD><TD>- array of work vectors, one for each field
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx        </B></TD><TD>- User context to store the relevant data to apply g2lfields
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>destroyctx </B></TD><TD>- Destroy function for userctx
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
g2lfields is called on the vector V to be visualized in order to extract the relevant dofs to be put in Vfield[], as
<PRE>
  g2lfields((<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>)V,nfields,(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>*)Vfield[],ctx).
</PRE>

For vector spaces, the block size of Vfield[i] represents the vector dimension. It misses the Fortran bindings.
The names of the Vfield vectors will be displayed in the window title.
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 PetscViewerGLVisOpen(), <A HREF="../Viewer/PetscViewerCreate.html#PetscViewerCreate">PetscViewerCreate</A>(), <A HREF="../Viewer/PetscViewerSetType.html#PetscViewerSetType">PetscViewerSetType</A>(), <A HREF="../Sys/PetscObjectSetName.html#PetscObjectSetName">PetscObjectSetName</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/sys/classes/viewer/impls/glvis/glvis.c.html#PetscViewerGLVisSetFields">src/sys/classes/viewer/impls/glvis/glvis.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex43.c.html">src/ksp/ksp/examples/tutorials/ex43.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/sys/classes/viewer/impls/glvis/glvis.c.html#PetscViewerGLVisSetFields_GLVis(PetscViewer viewer, PetscInt nfields, const char* fec_type[], PetscInt dim[], PetscErrorCode(*g2l)(PetscObject,PetscInt,PetscObject[],void*), PetscObject Vfield[], void* ctx, PetscErrorCode(*destroyctx)">PetscViewerGLVisSetFields_GLVis(PetscViewer viewer, PetscInt nfields, const char* fec_type[], PetscInt dim[], PetscErrorCode(*g2l)(PetscObject,PetscInt,PetscObject[],void*), PetscObject Vfield[], void* ctx, PetscErrorCode(*destroyctx) in src/sys/classes/viewer/impls/glvis/glvis.c</A><BR>
<BR><A HREF="./index.html">Index of all Viewer 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>