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
|
<!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/PetscViewerHDF5SetBaseDimension2.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscViewerHDF5SetBaseDimension2</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/PetscViewerHDF5SetBaseDimension2.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscViewerHDF5SetBaseDimension2"><H1>PetscViewerHDF5SetBaseDimension2</H1></A>
Vectors of 1 dimension (i.e. bs/dof is 1) will be saved in the HDF5 file with a dimension of 2.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h"
#include "petscviewerhdf5.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Viewer/PetscViewerHDF5SetBaseDimension2.html#PetscViewerHDF5SetBaseDimension2">PetscViewerHDF5SetBaseDimension2</A>(<A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A> viewer,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> flg)
</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>; if it is not hdf5 then this command is ignored
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>flg </B></TD><TD>- if <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> the vector will always have at least a dimension of 2 even if that first dimension is of size 1
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database</FONT></H3>
<DT><B>-viewer_hdf5_base_dimension2 </B> -turns on (true) or off (false) using a dimension of 2 in the HDF5 file even if the bs/dof of the vector is 1
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Setting this option allegedly makes code that reads the HDF5 in easier since they do not have a "special case" of a bs/dof
of one when the dimension is lower. Others think the option is crazy.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Viewer/PetscViewerFileSetMode.html#PetscViewerFileSetMode">PetscViewerFileSetMode</A>(), <A HREF="../Viewer/PetscViewerCreate.html#PetscViewerCreate">PetscViewerCreate</A>(), <A HREF="../Viewer/PetscViewerSetType.html#PetscViewerSetType">PetscViewerSetType</A>(), <A HREF="../Viewer/PetscViewerBinaryOpen.html#PetscViewerBinaryOpen">PetscViewerBinaryOpen</A>()
<BR>
<P>
<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/hdf5/hdf5v.c.html#PetscViewerHDF5SetBaseDimension2">src/sys/classes/viewer/impls/hdf5/hdf5v.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/examples/tutorials/ex9.c.html">src/dm/examples/tutorials/ex9.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/sys/classes/viewer/impls/hdf5/hdf5v.c.html#PetscViewerHDF5SetBaseDimension2_HDF5">PetscViewerHDF5SetBaseDimension2_HDF5 in src/sys/classes/viewer/impls/hdf5/hdf5v.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>
|
