147 lines
21 KiB
HTML
147 lines
21 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>H5Part: H5Part.h Source File</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
|
<h1>H5Part.h</h1><a href="H5Part_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef _H5Part_H_</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define _H5Part_H_</span>
|
|
<a name="l00003"></a>00003 <span class="preprocessor"></span>
|
|
<a name="l00004"></a>00004 <span class="preprocessor">#include <hdf5.h></span>
|
|
<a name="l00005"></a>00005 <span class="preprocessor">#ifdef PARALLEL_IO</span>
|
|
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="preprocessor">#include <mpi.h></span>
|
|
<a name="l00007"></a>00007 <span class="preprocessor">#endif</span>
|
|
<a name="l00008"></a>00008 <span class="preprocessor"></span>
|
|
<a name="l00016"></a><a class="code" href="structH5PartFile.html">00016</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structH5PartFile.html">H5PartFile</a> {
|
|
<a name="l00017"></a><a class="code" href="structH5PartFile.html#o0">00017</a> hid_t <a class="code" href="structH5PartFile.html#o0">file</a>;
|
|
<a name="l00018"></a><a class="code" href="structH5PartFile.html#o1">00018</a> <span class="keywordtype">int</span> <a class="code" href="structH5PartFile.html#o1">timestep</a>;
|
|
<a name="l00019"></a>00019
|
|
<a name="l00020"></a><a class="code" href="structH5PartFile.html#o2">00020</a> hid_t <a class="code" href="structH5PartFile.html#o2">timegroup</a>;
|
|
<a name="l00021"></a><a class="code" href="structH5PartFile.html#o3">00021</a> hid_t <a class="code" href="structH5PartFile.html#o3">properties</a>;
|
|
<a name="l00022"></a><a class="code" href="structH5PartFile.html#o4">00022</a> hsize_t <a class="code" href="structH5PartFile.html#o4">nparticles</a>;
|
|
<a name="l00023"></a><a class="code" href="structH5PartFile.html#o5">00023</a> hid_t <a class="code" href="structH5PartFile.html#o5">shape</a>;
|
|
<a name="l00024"></a><a class="code" href="structH5PartFile.html#o6">00024</a> <span class="keywordtype">unsigned</span> <a class="code" href="structH5PartFile.html#o6">mode</a>;
|
|
<a name="l00025"></a><a class="code" href="structH5PartFile.html#o7">00025</a> <span class="keywordtype">int</span> <a class="code" href="structH5PartFile.html#o7">maxstep</a>;
|
|
<a name="l00026"></a><a class="code" href="structH5PartFile.html#o8">00026</a> hid_t <a class="code" href="structH5PartFile.html#o8">xfer_prop</a>,<a class="code" href="structH5PartFile.html#o9">create_prop</a>,<a class="code" href="structH5PartFile.html#o10">access_prop</a>;
|
|
<a name="l00027"></a><a class="code" href="structH5PartFile.html#o12">00027</a> hid_t <a class="code" href="structH5PartFile.html#o11">diskshape</a>,<a class="code" href="structH5PartFile.html#o12">memshape</a>; <span class="comment">/* for parallel I/O (this is on-disk) H5S_ALL </span>
|
|
<a name="l00028"></a>00028 <span class="comment"> if serial I/O */</span>
|
|
<a name="l00029"></a><a class="code" href="structH5PartFile.html#o13">00029</a> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="structH5PartFile.html#o13">viewstart</a>,<a class="code" href="structH5PartFile.html#o14">viewend</a>; <span class="comment">/* -1 if no view is available: A "view" looks at a subset of the data. */</span>
|
|
<a name="l00030"></a>00030
|
|
<a name="l00031"></a>00031 <span class="preprocessor">#ifdef PARALLEL_IO</span>
|
|
<a name="l00032"></a>00032 <span class="preprocessor"></span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *pnparticles; <span class="comment">/* the number of particles in each processor.</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> With respect to the "VIEW", these numbers</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> can be regarded as non-overlapping subsections</span>
|
|
<a name="l00035"></a>00035 <span class="comment"> of the particle array stored in the file.</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> So they can be used to compute the offset of</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> the view for each processor */</span>
|
|
<a name="l00038"></a>00038 MPI_Comm comm;
|
|
<a name="l00039"></a>00039 <span class="keywordtype">int</span> nprocs,myproc;
|
|
<a name="l00040"></a>00040 <span class="preprocessor">#endif</span>
|
|
<a name="l00041"></a>00041 <span class="preprocessor"></span>}<a class="code" href="structH5PartFile.html">H5PartFile</a>;
|
|
<a name="l00042"></a>00042
|
|
<a name="l00043"></a><a class="code" href="H5Part_8h.html#a0">00043</a> <span class="preprocessor">#define H5PART_READ 0x01</span>
|
|
<a name="l00044"></a><a class="code" href="H5Part_8h.html#a1">00044</a> <span class="preprocessor"></span><span class="preprocessor">#define H5PART_WRITE 0x02</span>
|
|
<a name="l00045"></a>00045 <span class="preprocessor"></span>
|
|
<a name="l00046"></a>00046 <span class="comment">/*========== File Opening/Closing ===============*/</span>
|
|
<a name="l00047"></a>00047 <span class="preprocessor">#ifdef PARALLEL_IO</span>
|
|
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#include <mpi.h></span>
|
|
<a name="l00049"></a>00049 <a class="code" href="structH5PartFile.html">H5PartFile</a> *<a class="code" href="H5Part_8c.html#a3">H5PartOpenFileParallel</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename,
|
|
<a name="l00050"></a>00050 <span class="keywordtype">unsigned</span> flags,
|
|
<a name="l00051"></a>00051 MPI_Comm communicator);
|
|
<a name="l00052"></a>00052 <span class="preprocessor">#endif</span>
|
|
<a name="l00053"></a><a class="code" href="H5Part_8h.html#a2">00053</a> <span class="preprocessor"></span><span class="preprocessor">#define H5PartOpenFileSerial(x,y) H5PartOpenFile(x,y)</span>
|
|
<a name="l00054"></a>00054 <span class="preprocessor"></span>
|
|
<a name="l00055"></a>00055 <a class="code" href="structH5PartFile.html">H5PartFile</a> *<a class="code" href="H5Part_8c.html#a4">H5PartOpenFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="comment">/* name of datafile */</span>
|
|
<a name="l00056"></a>00056 <span class="keywordtype">unsigned</span> flags); <span class="comment">/* H5PART_READ | H5PART_WRITE */</span>
|
|
<a name="l00057"></a>00057 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a5">H5PartFileIsValid</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f);
|
|
<a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="H5Part_8c.html#a6">H5PartCloseFile</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f);
|
|
<a name="l00059"></a>00059
|
|
<a name="l00060"></a>00060
|
|
<a name="l00061"></a>00061 <span class="comment">/*============== File Writing Functions ==================== */</span>
|
|
<a name="l00062"></a>00062 <span class="keywordtype">void</span> <a class="code" href="H5Part_8c.html#a7">H5PartSetNumParticles</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">long</span> <span class="keywordtype">long</span> nparticles);
|
|
<a name="l00063"></a>00063 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a8">H5PartWriteDataFloat64</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,<span class="keywordtype">double</span> *array);
|
|
<a name="l00064"></a>00064 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a9">H5PartWriteDataInt64</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,<span class="keywordtype">long</span> <span class="keywordtype">long</span> *array);
|
|
<a name="l00065"></a>00065
|
|
<a name="l00066"></a>00066 <span class="comment">/*================== File Reading Routines =================*/</span>
|
|
<a name="l00067"></a>00067 <span class="keywordtype">void</span> <a class="code" href="H5Part_8c.html#a24">H5PartSetStep</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f, <span class="comment">/* file handle */</span>
|
|
<a name="l00068"></a>00068 <span class="keywordtype">int</span> step); <span class="comment">/* current timestep to select (0 to n-1) */</span>
|
|
<a name="l00069"></a>00069 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a27">H5PartGetNumSteps</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f);
|
|
<a name="l00070"></a>00070 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a28">H5PartGetNumDatasets</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f);
|
|
<a name="l00071"></a>00071 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a29">H5PartGetDatasetName</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">int</span> index,<span class="keywordtype">char</span> *name,<span class="keywordtype">int</span> maxlen);
|
|
<a name="l00072"></a>00072 <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="H5Part_8c.html#a33">H5PartGetNumParticles</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f);
|
|
<a name="l00073"></a>00073 <span class="keywordtype">void</span> <a class="code" href="H5Part_8c.html#a34">H5PartSetView</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">long</span> <span class="keywordtype">long</span> start,<span class="keywordtype">long</span> <span class="keywordtype">long</span> end);
|
|
<a name="l00074"></a><a class="code" href="H5Part_8h.html#a3">00074</a> <span class="preprocessor">#define H5PartResetView(f) H5PartSetView(f,-1,-1)</span>
|
|
<a name="l00075"></a><a class="code" href="H5Part_8h.html#a4">00075</a> <span class="preprocessor"></span><span class="preprocessor">#define H5PartHasView(f) ((f->viewstart<0||f->viewend<0)?0:1)</span>
|
|
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a35">H5PartGetView</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">long</span> <span class="keywordtype">long</span> *start,<span class="keywordtype">long</span> <span class="keywordtype">long</span> *end);
|
|
<a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="H5Part_8c.html#a36">H5PartSetCanonicalView</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f);
|
|
<a name="l00078"></a>00078
|
|
<a name="l00079"></a>00079 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a37">H5PartReadDataFloat64</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,
|
|
<a name="l00080"></a>00080 <span class="keywordtype">char</span> *name, <span class="comment">/* name of the array to read</span>
|
|
<a name="l00081"></a>00081 <span class="comment"> "x"=position in x direction (y,z)</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> "vx"=velocity in x directio (y,z)</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> "px"=position in x dir (y,z) */</span>
|
|
<a name="l00084"></a>00084 <span class="keywordtype">double</span> *array); <span class="comment">/* array to read data into */</span>
|
|
<a name="l00085"></a>00085 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a38">H5PartReadDataInt64</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,
|
|
<a name="l00086"></a>00086 <span class="keywordtype">char</span> *name, <span class="comment">/* name of the array to read</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> "x"=position in x direction (y,z)</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> "vx"=velocity in x directio (y,z)</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> "px"=position in x dir (y,z) */</span>
|
|
<a name="l00090"></a>00090 <span class="keywordtype">long</span> <span class="keywordtype">long</span> *array); <span class="comment">/* array to read data into */</span>
|
|
<a name="l00091"></a>00091
|
|
<a name="l00092"></a>00092 <span class="comment">/* the following is a back-door for extensions to the data writing */</span>
|
|
<a name="l00093"></a>00093 <span class="preprocessor">#if 0</span>
|
|
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="keywordtype">int</span> H5PartReadData(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,<span class="keywordtype">void</span> *array,hid_t type);
|
|
<a name="l00095"></a>00095 <span class="keywordtype">int</span> H5PartWriteData(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,<span class="keywordtype">void</span> *array,hid_t type);
|
|
<a name="l00096"></a>00096 <span class="preprocessor">#endif</span>
|
|
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a39">H5PartReadParticleStep</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f, <span class="comment">/* filehandle */</span>
|
|
<a name="l00098"></a>00098 <span class="keywordtype">int</span> step, <span class="comment">/* selects timestep to read from*/</span>
|
|
<a name="l00099"></a>00099 <span class="keywordtype">double</span> *x,<span class="keywordtype">double</span> *y,<span class="keywordtype">double</span> *z, <span class="comment">/* particle positions */</span>
|
|
<a name="l00100"></a>00100 <span class="keywordtype">double</span> *px,<span class="keywordtype">double</span> *py,<span class="keywordtype">double</span> *pz, <span class="comment">/* particle momenta */</span>
|
|
<a name="l00101"></a>00101 <span class="keywordtype">long</span> <span class="keywordtype">long</span> *<span class="keywordtype">id</span>); <span class="comment">/* and phase */</span>
|
|
<a name="l00102"></a>00102 <span class="comment">/**********==============Attributes Interface============***************/</span>
|
|
<a name="l00103"></a>00103 <span class="comment">/* currently there is file attributes: Attributes bound to the file</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> and step attributes which are bound to the current timestep. You </span>
|
|
<a name="l00105"></a>00105 <span class="comment"> must set the timestep explicitly before writing the attributes (just</span>
|
|
<a name="l00106"></a>00106 <span class="comment"> as you must do when you write a new dataset. Currently there are no</span>
|
|
<a name="l00107"></a>00107 <span class="comment"> attributes that are bound to a particular data array, but this could</span>
|
|
<a name="l00108"></a>00108 <span class="comment"> easily be done if required.</span>
|
|
<a name="l00109"></a>00109 <span class="comment">*/</span>
|
|
<a name="l00110"></a>00110 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a12">H5PartWriteStepAttrib</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,
|
|
<a name="l00111"></a>00111 hid_t type,<span class="keywordtype">void</span> *attrib,<span class="keywordtype">int</span> nelem);
|
|
<a name="l00112"></a>00112 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a14">H5PartWriteFileAttrib</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,
|
|
<a name="l00113"></a>00113 hid_t type,<span class="keywordtype">void</span> *attrib,<span class="keywordtype">int</span> nelem);
|
|
<a name="l00114"></a>00114 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a13">H5PartWriteAttrib</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,
|
|
<a name="l00115"></a>00115 hid_t type,<span class="keywordtype">void</span> *attrib,<span class="keywordtype">int</span> nelem); <span class="comment">/* this should be deprecated */</span>
|
|
<a name="l00116"></a>00116
|
|
<a name="l00117"></a>00117 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a10">H5PartWriteFileAttribString</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,
|
|
<a name="l00118"></a>00118 <span class="keywordtype">char</span> *attrib);
|
|
<a name="l00119"></a>00119 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a11">H5PartWriteStepAttribString</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,
|
|
<a name="l00120"></a>00120 <span class="keywordtype">char</span> *attrib);
|
|
<a name="l00121"></a>00121 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a16">H5PartGetNumStepAttribs</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f); <span class="comment">/* for current filestep */</span>
|
|
<a name="l00122"></a>00122 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a17">H5PartGetNumFileAttribs</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f);
|
|
<a name="l00123"></a>00123 <span class="keywordtype">void</span> <a class="code" href="H5Part_8c.html#a19">H5PartGetStepAttribInfo</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">int</span> idx,
|
|
<a name="l00124"></a>00124 <span class="keywordtype">char</span> *name,size_t maxnamelen,
|
|
<a name="l00125"></a>00125 hid_t *type,<span class="keywordtype">int</span> *nelem);
|
|
<a name="l00126"></a>00126 <span class="keywordtype">void</span> <a class="code" href="H5Part_8c.html#a20">H5PartGetFileAttribInfo</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">int</span> idx,
|
|
<a name="l00127"></a>00127 <span class="keywordtype">char</span> *name,size_t maxnamelen,
|
|
<a name="l00128"></a>00128 hid_t *type,<span class="keywordtype">int</span> *nelem);
|
|
<a name="l00129"></a>00129 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a21">H5PartReadStepAttrib</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,<span class="keywordtype">void</span> *data);
|
|
<a name="l00130"></a>00130 <span class="keywordtype">void</span> <a class="code" href="H5Part_8c.html#a22">H5PartReadAttrib</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,<span class="keywordtype">void</span> *data);
|
|
<a name="l00131"></a>00131 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a23">H5PartReadFileAttrib</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *name,<span class="keywordtype">void</span> *data);
|
|
<a name="l00132"></a>00132
|
|
<a name="l00133"></a>00133
|
|
<a name="l00134"></a>00134 <span class="comment">/**************** File Stashing Interfaces *************************/</span>
|
|
<a name="l00135"></a>00135 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a42">H5PartStashFile</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">char</span> *filename);
|
|
<a name="l00136"></a>00136 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a43">H5PartUnstashFile</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f, <span class="keywordtype">char</span> *filename, <span class="keywordtype">char</span> *outputpath); <span class="comment">/* outputpath can be null for cwd */</span>
|
|
<a name="l00137"></a>00137 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a44">H5PartGetNumStashFiles</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f);
|
|
<a name="l00138"></a>00138 <span class="keywordtype">int</span> <a class="code" href="H5Part_8c.html#a45">H5PartFileGetStashFileName</a>(<a class="code" href="structH5PartFile.html">H5PartFile</a> *f,<span class="keywordtype">int</span> nameindex,<span class="keywordtype">char</span> *filename,<span class="keywordtype">int</span> maxnamelen);
|
|
<a name="l00139"></a>00139
|
|
<a name="l00140"></a>00140
|
|
<a name="l00141"></a>00141 <span class="preprocessor">#endif</span>
|
|
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Jan 31 11:52:45 2006 for H5Part by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
|
|
</body>
|
|
</html>
|