File: PetscViewerHDF5ReadSizes.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 (48 lines) | stat: -rw-r--r-- 3,399 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/IS/PetscViewerHDF5ReadSizes.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscViewerHDF5ReadSizes</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/IS/PetscViewerHDF5ReadSizes.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscViewerHDF5ReadSizes"><H1>PetscViewerHDF5ReadSizes</H1></A>
Read block size and global size of a vector (<A HREF="../Vec/Vec.html#Vec">Vec</A> or <A HREF="../IS/IS.html#IS">IS</A>) stored in an HDF5 file. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsclayoutdf5.h"   
#include "petscis.h"   
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../IS/PetscViewerHDF5ReadSizes.html#PetscViewerHDF5ReadSizes">PetscViewerHDF5ReadSizes</A>(<A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A> viewer, const char name[], <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *bs, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *N)
</PRE>
<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 HDF5 viewer
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>name   </B></TD><TD>- The dataset name
</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>bs     </B></TD><TD>- block size
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>N      </B></TD><TD>- global size
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The dataset is stored as an HDF5 dataspace with 1-4 dimensions in the order
1) # timesteps (optional), 2) # blocks, 3) # elements per block (optional), 4) real and imaginary part (only for complex).
<P>
The dataset can be stored as a 2D dataspace even if its blocksize is 1; see <A HREF="../Viewer/PetscViewerHDF5SetBaseDimension2.html#PetscViewerHDF5SetBaseDimension2">PetscViewerHDF5SetBaseDimension2</A>().
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Viewer/PetscViewerHDF5Open.html#PetscViewerHDF5Open">PetscViewerHDF5Open</A>(), <A HREF="../Vec/VecLoad.html#VecLoad">VecLoad</A>(), <A HREF="../IS/ISLoad.html#ISLoad">ISLoad</A>(), <A HREF="../Vec/VecGetSize.html#VecGetSize">VecGetSize</A>(), <A HREF="../IS/ISGetSize.html#ISGetSize">ISGetSize</A>(), <A HREF="../Viewer/PetscViewerHDF5SetBaseDimension2.html#PetscViewerHDF5SetBaseDimension2">PetscViewerHDF5SetBaseDimension2</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/vec/is/utils/hdf5io.c.html#PetscViewerHDF5ReadSizes">src/vec/is/utils/hdf5io.c</A>
<BR><A HREF="./index.html">Index of all IS 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>