TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-12-25 22:03:56 +01:00
Code Issues Projects Releases Wiki Activity

Deploying to gh-pages from @ TREX-CoE/trexio@692f45ed7f 🚀

Browse Source
This commit is contained in:
scemama 2021-05-07 22:44:30 +00:00
parent a3fced3ea4
commit 89d39f92f9
5 changed files with 144 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-06 Thu 22:03 -->
<!-- 2021-05-07 Fri 22:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title>
@ -341,7 +341,7 @@ and bug reports should be submitted at
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-06 Thu 22:03</p>
<p class="date">Created: 2021-05-07 Fri 22:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

4
index.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-06 Thu 22:03 -->
<!-- 2021-05-07 Fri 22:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title>
@ -341,7 +341,7 @@ and bug reports should be submitted at
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-06 Thu 22:03</p>
<p class="date">Created: 2021-05-07 Fri 22:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

133
templator_front.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-06 Thu 22:03 -->
<!-- 2021-05-07 Fri 22:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Front end API</title>
@ -311,45 +311,45 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgcfd7c54">1. Coding conventions</a>
<li><a href="#orga9b3d12">1. Coding conventions</a>
<ul>
<li><a href="#org4c26947">1.1. Memory allocation</a></li>
<li><a href="#orgf51cf84">1.1. Memory allocation</a></li>
</ul>
</li>
<li><a href="#org6c81131">2. Front end</a>
<li><a href="#org2992887">2. Front end</a>
<ul>
<li><a href="#org6b73a70">2.1. Error handling</a></li>
<li><a href="#org0501b47">2.2. Back ends</a></li>
<li><a href="#org9970605">2.3. Read/write behavior</a></li>
<li><a href="#orge81a3ec">2.4. TREXIO file type</a></li>
<li><a href="#org6354d94">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org54f9d34">2.6. File opening</a></li>
<li><a href="#org435e167">2.7. File closing</a></li>
<li><a href="#org2a57e83">2.1. Error handling</a></li>
<li><a href="#org4280d8b">2.2. Back ends</a></li>
<li><a href="#orgd3f3e42">2.3. Read/write behavior</a></li>
<li><a href="#org68cee1b">2.4. TREXIO file type</a></li>
<li><a href="#orge2d0e66">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org84d0036">2.6. File opening</a></li>
<li><a href="#orgfbe194e">2.7. File closing</a></li>
</ul>
</li>
<li><a href="#orgcfa5728">3. Templates for front end</a>
<li><a href="#org6504270">3. Templates for front end</a>
<ul>
<li><a href="#orgd26c0b4">3.1. Templates for front end has/read/write a dimension</a>
<li><a href="#orgf572aa4">3.1. Templates for front end has/read/write a dimension</a>
<ul>
<li><a href="#org367f97e">3.1.1. C templates for front end</a></li>
<li><a href="#org1e4b73a">3.1.2. Fortran templates for front end</a></li>
<li><a href="#org438f96b">3.1.1. C templates for front end</a></li>
<li><a href="#org8276837">3.1.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#orgd4af1b8">3.2. Templates for front end has/read/write a dataset</a>
<li><a href="#org3e2b9c7">3.2. Templates for front end has/read/write a dataset</a>
<ul>
<li><a href="#org7ba6e39">3.2.1. C templates for front end</a></li>
<li><a href="#org4467760">3.2.2. Fortran templates for front end</a></li>
<li><a href="#orgddb79e8">3.2.1. C templates for front end</a></li>
<li><a href="#orgb692f07">3.2.2. Fortran templates for front end</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org8946e95">4. Fortran helper/wrapper functions</a></li>
<li><a href="#org9aed9ea">4. Fortran helper/wrapper functions</a></li>
</ul>
</div>
</div>
<div id="outline-container-orgcfd7c54" class="outline-2">
<h2 id="orgcfd7c54"><span class="section-number-2">1</span> Coding conventions</h2>
<div id="outline-container-orga9b3d12" class="outline-2">
<h2 id="orga9b3d12"><span class="section-number-2">1</span> Coding conventions</h2>
<div class="outline-text-2" id="text-1">
<ul class="org-ul">
<li>integer types will be defined using types given in <code>stdint.h</code></li>
@ -364,8 +364,8 @@ for the JavaScript code in this tag.
</ul>
</div>
<div id="outline-container-org4c26947" class="outline-3">
<h3 id="org4c26947"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div id="outline-container-orgf51cf84" class="outline-3">
<h3 id="orgf51cf84"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Memory allocation of structures can be facilitated by using the
@ -400,8 +400,8 @@ The maximum string size for the filenames is 4096 characters.
</div>
</div>
<div id="outline-container-org6c81131" class="outline-2">
<h2 id="org6c81131"><span class="section-number-2">2</span> Front end</h2>
<div id="outline-container-org2992887" class="outline-2">
<h2 id="org2992887"><span class="section-number-2">2</span> Front end</h2>
<div class="outline-text-2" id="text-2">
<p>
All calls to TREXIO are thread-safe.
@ -409,10 +409,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
</p>
</div>
<div id="outline-container-org6b73a70" class="outline-3">
<h3 id="org6b73a70"><span class="section-number-3">2.1</span> Error handling</h3>
<div id="outline-container-org2a57e83" class="outline-3">
<h3 id="org2a57e83"><span class="section-number-3">2.1</span> Error handling</h3>
<div class="outline-text-3" id="text-2-1">
<table id="org810158e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org0d36b30" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -694,8 +694,8 @@ The text strings are extracted from the previous table.
</div>
</div>
<div id="outline-container-org0501b47" class="outline-3">
<h3 id="org0501b47"><span class="section-number-3">2.2</span> Back ends</h3>
<div id="outline-container-org4280d8b" class="outline-3">
<h3 id="org4280d8b"><span class="section-number-3">2.2</span> Back ends</h3>
<div class="outline-text-3" id="text-2-2">
<p>
TREXIO has several back ends:
@ -725,8 +725,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div>
</div>
</div>
<div id="outline-container-org9970605" class="outline-3">
<h3 id="org9970605"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div id="outline-container-orgd3f3e42" class="outline-3">
<h3 id="orgd3f3e42"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div class="outline-text-3" id="text-2-3">
<p>
Every time a reading function is called, the data is read from the
@ -754,8 +754,8 @@ concurrent programs, the behavior is not specified.
</p>
</div>
</div>
<div id="outline-container-orge81a3ec" class="outline-3">
<h3 id="orge81a3ec"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div id="outline-container-org68cee1b" class="outline-3">
<h3 id="org68cee1b"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div class="outline-text-3" id="text-2-4">
<p>
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users
@ -787,8 +787,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div>
</div>
</div>
<div id="outline-container-org6354d94" class="outline-3">
<h3 id="org6354d94"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div id="outline-container-orge2d0e66" class="outline-3">
<h3 id="orge2d0e66"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div class="outline-text-3" id="text-2-5">
<p>
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
@ -807,8 +807,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org54f9d34" class="outline-3">
<h3 id="org54f9d34"><span class="section-number-3">2.6</span> File opening</h3>
<div id="outline-container-org84d0036" class="outline-3">
<h3 id="org84d0036"><span class="section-number-3">2.6</span> File opening</h3>
<div class="outline-text-3" id="text-2-6">
<p>
<code>trexio_open</code> creates a new TREXIO file or opens existing one.
@ -970,8 +970,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div>
</div>
<div id="outline-container-org435e167" class="outline-3">
<h3 id="org435e167"><span class="section-number-3">2.7</span> File closing</h3>
<div id="outline-container-orgfbe194e" class="outline-3">
<h3 id="orgfbe194e"><span class="section-number-3">2.7</span> File closing</h3>
<div class="outline-text-3" id="text-2-7">
<p>
<code>trexio_close</code> closes an existing <code>trexio_t</code> file.
@ -1070,8 +1070,8 @@ output:
</div>
</div>
<div id="outline-container-orgcfa5728" class="outline-2">
<h2 id="orgcfa5728"><span class="section-number-2">3</span> Templates for front end</h2>
<div id="outline-container-org6504270" class="outline-2">
<h2 id="org6504270"><span class="section-number-2">3</span> Templates for front end</h2>
<div class="outline-text-2" id="text-3">
<p>
Consider the following block of <code>trex.json</code>:
@ -1207,9 +1207,16 @@ each variable can be found below:
<td class="org-left">Double precision type of the dataset [Fortran]</td>
<td class="org-left"><code>real(8)</code></td>
</tr>
<tr>
<td class="org-left"><code>$group_dset_f_dims$</code></td>
<td class="org-left">Dimensions in Fortran</td>
<td class="org-left"><code>(:,:)</code></td>
</tr>
</tbody>
</table>
<p>
Note: parent group name is always added to the child objects upon
construction of TREXIO (e.g. <code>num</code> of <code>nucleus</code> group becomes
@ -1236,8 +1243,8 @@ or double precision for integer and floating point numbers.
</p>
</div>
<div id="outline-container-orgd26c0b4" class="outline-3">
<h3 id="orgd26c0b4"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3>
<div id="outline-container-orgf572aa4" class="outline-3">
<h3 id="orgf572aa4"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3>
<div class="outline-text-3" id="text-3-1">
<p>
This section concerns API calls related to dimensioning variables.
@ -1306,8 +1313,8 @@ This section concerns API calls related to dimensioning variables.
</table>
</div>
<div id="outline-container-org367f97e" class="outline-4">
<h4 id="org367f97e"><span class="section-number-4">3.1.1</span> C templates for front end</h4>
<div id="outline-container-org438f96b" class="outline-4">
<h4 id="org438f96b"><span class="section-number-4">3.1.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-1-1">
<p>
The <code>C</code> templates that correspond to each of the abovementioned
@ -1499,8 +1506,8 @@ precision (see Table above).
</div>
</div>
<div id="outline-container-org1e4b73a" class="outline-4">
<h4 id="org1e4b73a"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4>
<div id="outline-container-org8276837" class="outline-4">
<h4 id="org8276837"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-1-2">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
@ -1586,8 +1593,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-orgd4af1b8" class="outline-3">
<h3 id="orgd4af1b8"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3>
<div id="outline-container-org3e2b9c7" class="outline-3">
<h3 id="org3e2b9c7"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3>
<div class="outline-text-3" id="text-3-2">
<p>
This section concerns API calls related to datasets.
@ -1656,8 +1663,8 @@ This section concerns API calls related to datasets.
</table>
</div>
<div id="outline-container-org7ba6e39" class="outline-4">
<h4 id="org7ba6e39"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div id="outline-container-orgddb79e8" class="outline-4">
<h4 id="orgddb79e8"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-2-1">
<p>
The C templates that correspond to each of the abovementioned functions can be found below.
@ -1915,8 +1922,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div>
</div>
<div id="outline-container-org4467760" class="outline-4">
<h4 id="org4467760"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div id="outline-container-orgb692f07" class="outline-4">
<h4 id="orgb692f07"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-2-2">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -1928,7 +1935,7 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
<span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">trexio_write_$group$_$group_dset$_64</span><span style="color: #a0522d;"> </span><span style="color: #000000; background-color: #ffffff;">(trex_file, dset) bind(C)</span>
<span style="color: #a020f0;">use</span>, <span style="color: #a020f0;">intrinsic</span> :: <span style="color: #0000ff;">iso_c_binding</span>
<span style="color: #228b22;">integer</span>(8), <span style="color: #a020f0;">intent</span>(in), <span style="color: #a020f0;">value</span> ::<span style="color: #a0522d;"> trex_file</span>
$group_dset_f_dtype_double$, <span style="color: #a020f0;">intent</span>(in) :: dset(*)
$group_dset_f_dtype_double$, <span style="color: #a020f0;">intent</span>(in) :: dset$group_dset_f_dims$
<span style="color: #a020f0;">end function</span> <span style="color: #0000ff;">trexio_write_$group$_$group_dset$_64</span>
<span style="color: #a020f0;">end interface</span>
</pre>
@ -1939,7 +1946,7 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
<span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">trexio_read_$group$_$group_dset$_64</span><span style="color: #a0522d;"> </span><span style="color: #000000; background-color: #ffffff;">(trex_file, dset) bind(C)</span>
<span style="color: #a020f0;">use</span>, <span style="color: #a020f0;">intrinsic</span> :: <span style="color: #0000ff;">iso_c_binding</span>
<span style="color: #228b22;">integer</span>(8), <span style="color: #a020f0;">intent</span>(in), <span style="color: #a020f0;">value</span> ::<span style="color: #a0522d;"> trex_file</span>
$group_dset_f_dtype_double$, <span style="color: #a020f0;">intent</span>(out) :: dset(*)
$group_dset_f_dtype_double$, <span style="color: #a020f0;">intent</span>(out) :: dset$group_dset_f_dims$
<span style="color: #a020f0;">end function</span> <span style="color: #0000ff;">trexio_read_$group$_$group_dset$_64</span>
<span style="color: #a020f0;">end interface</span>
</pre>
@ -1950,7 +1957,7 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
<span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">trexio_write_$group$_$group_dset$_32</span><span style="color: #a0522d;"> </span><span style="color: #000000; background-color: #ffffff;">(trex_file, dset) bind(C)</span>
<span style="color: #a020f0;">use</span>, <span style="color: #a020f0;">intrinsic</span> :: <span style="color: #0000ff;">iso_c_binding</span>
<span style="color: #228b22;">integer</span>(8), <span style="color: #a020f0;">intent</span>(in), <span style="color: #a020f0;">value</span> ::<span style="color: #a0522d;"> trex_file</span>
$group_dset_f_dtype_single$, <span style="color: #a020f0;">intent</span>(in) :: dset(*)
$group_dset_f_dtype_single$, <span style="color: #a020f0;">intent</span>(in) :: dset$group_dset_f_dims$
<span style="color: #a020f0;">end function</span> <span style="color: #0000ff;">trexio_write_$group$_$group_dset$_32</span>
<span style="color: #a020f0;">end interface</span>
</pre>
@ -1961,7 +1968,7 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
<span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">trexio_read_$group$_$group_dset$_32</span><span style="color: #a0522d;"> </span><span style="color: #000000; background-color: #ffffff;">(trex_file, dset) bind(C)</span>
<span style="color: #a020f0;">use</span>, <span style="color: #a020f0;">intrinsic</span> :: <span style="color: #0000ff;">iso_c_binding</span>
<span style="color: #228b22;">integer</span>(8), <span style="color: #a020f0;">intent</span>(in), <span style="color: #a020f0;">value</span> ::<span style="color: #a0522d;"> trex_file</span>
$group_dset_f_dtype_single$, <span style="color: #a020f0;">intent</span>(out) :: dset(*)
$group_dset_f_dtype_single$, <span style="color: #a020f0;">intent</span>(out) :: dset$group_dset_f_dims$
<span style="color: #a020f0;">end function</span> <span style="color: #0000ff;">trexio_read_$group$_$group_dset$_32</span>
<span style="color: #a020f0;">end interface</span>
</pre>
@ -1972,7 +1979,7 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
<span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">trexio_write_$group$_$group_dset$</span><span style="color: #a0522d;"> </span><span style="color: #000000; background-color: #ffffff;">(trex_file, dset) bind(C)</span>
<span style="color: #a020f0;">use</span>, <span style="color: #a020f0;">intrinsic</span> :: <span style="color: #0000ff;">iso_c_binding</span>
<span style="color: #228b22;">integer</span>(8), <span style="color: #a020f0;">intent</span>(in), <span style="color: #a020f0;">value</span> ::<span style="color: #a0522d;"> trex_file</span>
$group_dset_f_dtype_double$, <span style="color: #a020f0;">intent</span>(in) :: dset(*)
$group_dset_f_dtype_double$, <span style="color: #a020f0;">intent</span>(in) :: dset$group_dset_f_dims$
<span style="color: #a020f0;">end function</span> <span style="color: #0000ff;">trexio_write_$group$_$group_dset$</span>
<span style="color: #a020f0;">end interface</span>
</pre>
@ -1983,7 +1990,7 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
<span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">trexio_read_$group$_$group_dset$</span><span style="color: #a0522d;"> </span><span style="color: #000000; background-color: #ffffff;">(trex_file, dset) bind(C)</span>
<span style="color: #a020f0;">use</span>, <span style="color: #a020f0;">intrinsic</span> :: <span style="color: #0000ff;">iso_c_binding</span>
<span style="color: #228b22;">integer</span>(8), <span style="color: #a020f0;">intent</span>(in), <span style="color: #a020f0;">value</span> ::<span style="color: #a0522d;"> trex_file</span>
$group_dset_f_dtype_double$, <span style="color: #a020f0;">intent</span>(out) :: dset(*)
$group_dset_f_dtype_double$, <span style="color: #a020f0;">intent</span>(out) :: dset$group_dset_f_dims$
<span style="color: #a020f0;">end function</span> <span style="color: #0000ff;">trexio_read_$group$_$group_dset$</span>
<span style="color: #a020f0;">end interface</span>
</pre>
@ -2003,8 +2010,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org8946e95" class="outline-2">
<h2 id="org8946e95"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div id="outline-container-org9aed9ea" class="outline-2">
<h2 id="org9aed9ea"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div class="outline-text-2" id="text-4">
<p>
The function below adapts the original C-based <code>trexio_open</code> for Fortran.
@ -2033,7 +2040,7 @@ Note, that Fortran interface calls the main <code>TREXIO</code> API, which is wr
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-06 Thu 22:03</p>
<p class="date">Created: 2021-05-07 Fri 22:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

40
templator_hdf5.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-06 Thu 22:03 -->
<!-- 2021-05-07 Fri 22:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HDF5 back end</title>
@ -311,25 +311,25 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org243cdfb">1. HDF5 back end</a>
<li><a href="#org37aeb2f">1. HDF5 back end</a>
<ul>
<li><a href="#orgd9425b9">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org1bf3183">1.2. Template for HDF5 structures</a></li>
<li><a href="#org5e3d8ce">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#orge75fdb9">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org693f20c">1.5. Template for HDF5 has/read/write a dataset</a></li>
<li><a href="#orgae6be5d">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org02a6284">1.2. Template for HDF5 structures</a></li>
<li><a href="#org2ca5d1e">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#orgbcfefe6">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org55daa80">1.5. Template for HDF5 has/read/write a dataset</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-org243cdfb" class="outline-2">
<h2 id="org243cdfb"><span class="section-number-2">1</span> HDF5 back end</h2>
<div id="outline-container-org37aeb2f" class="outline-2">
<h2 id="org37aeb2f"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-orgd9425b9" class="outline-3">
<h3 id="orgd9425b9"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div id="outline-container-orgae6be5d" class="outline-3">
<h3 id="orgae6be5d"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div class="outline-text-3" id="text-1-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#define</span> $GROUP$_GROUP_NAME <span style="color: #8b2252;">"$group$"</span>
@ -340,8 +340,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org1bf3183" class="outline-3">
<h3 id="org1bf3183"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div id="outline-container-org02a6284" class="outline-3">
<h3 id="org02a6284"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div class="outline-text-3" id="text-1-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_hdf5_s</span> {
@ -356,8 +356,8 @@ for the JavaScript code in this tag.
</div>
<div id="outline-container-org5e3d8ce" class="outline-3">
<h3 id="org5e3d8ce"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div id="outline-container-org2ca5d1e" class="outline-3">
<h3 id="org2ca5d1e"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div class="outline-text-3" id="text-1-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -440,8 +440,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orge75fdb9" class="outline-3">
<h3 id="orge75fdb9"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3>
<div id="outline-container-orgbcfefe6" class="outline-3">
<h3 id="orgbcfefe6"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3>
<div class="outline-text-3" id="text-1-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -563,8 +563,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org693f20c" class="outline-3">
<h3 id="org693f20c"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3>
<div id="outline-container-org55daa80" class="outline-3">
<h3 id="org55daa80"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3>
<div class="outline-text-3" id="text-1-5">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -698,7 +698,7 @@ for the JavaScript code in this tag.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-06 Thu 22:03</p>
<p class="date">Created: 2021-05-07 Fri 22:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

100
templator_text.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-06 Thu 22:03 -->
<!-- 2021-05-07 Fri 22:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TEXT back end</title>
@ -311,24 +311,24 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org8eb38b3">1. TEXT back end</a>
<li><a href="#org325b286">1. TEXT back end</a>
<ul>
<li><a href="#org12c3fce">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org70b2171">1.2. Template for general structure in text back end</a></li>
<li><a href="#org0693644">1.3. Initialize function (constant part)</a></li>
<li><a href="#orge747409">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org682fa21">1.5. Template for text read struct</a></li>
<li><a href="#org39949f0">1.6. Template for text flush struct</a></li>
<li><a href="#orgf1ff581">1.7. Template for text free memory</a></li>
<li><a href="#org01a2375">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#orgc5025b1">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org1496c2f">1.10. RDM struct (hard-coded)</a>
<li><a href="#org62ff6a5">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgef9577b">1.2. Template for general structure in text back end</a></li>
<li><a href="#orge215c0e">1.3. Initialize function (constant part)</a></li>
<li><a href="#org76811c7">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org2faf0f6">1.5. Template for text read struct</a></li>
<li><a href="#org78ef45d">1.6. Template for text flush struct</a></li>
<li><a href="#org48132e9">1.7. Template for text free memory</a></li>
<li><a href="#org3b467a7">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org175ffc7">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#orgb73d27e">1.10. RDM struct (hard-coded)</a>
<ul>
<li><a href="#org9c96847">1.10.1. Read the complete struct</a></li>
<li><a href="#org5c443c9">1.10.2. Flush the complete struct</a></li>
<li><a href="#orgdf973bd">1.10.3. Free memory</a></li>
<li><a href="#org4bbe337">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org54fe26e">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
<li><a href="#orge9f9527">1.10.1. Read the complete struct</a></li>
<li><a href="#org119e83b">1.10.2. Flush the complete struct</a></li>
<li><a href="#org4effdb1">1.10.3. Free memory</a></li>
<li><a href="#orgb657d2d">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#orge070ec4">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
</ul>
</li>
</ul>
@ -337,8 +337,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org8eb38b3" class="outline-2">
<h2 id="org8eb38b3"><span class="section-number-2">1</span> TEXT back end</h2>
<div id="outline-container-org325b286" class="outline-2">
<h2 id="org325b286"><span class="section-number-2">1</span> TEXT back end</h2>
<div class="outline-text-2" id="text-1">
<p>
The "file" produced by the text back end is a directory with one
@ -359,8 +359,8 @@ The file is written when closed, or when the flush function is called.
</p>
</div>
<div id="outline-container-org12c3fce" class="outline-3">
<h3 id="org12c3fce"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div id="outline-container-org62ff6a5" class="outline-3">
<h3 id="org62ff6a5"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div class="outline-text-3" id="text-1-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s {
@ -376,8 +376,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org70b2171" class="outline-3">
<h3 id="org70b2171"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div id="outline-container-orgef9577b" class="outline-3">
<h3 id="orgef9577b"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div class="outline-text-3" id="text-1-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">rdm_s</span> {
@ -403,8 +403,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org0693644" class="outline-3">
<h3 id="org0693644"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div id="outline-container-orge215c0e" class="outline-3">
<h3 id="orge215c0e"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div class="outline-text-3" id="text-1-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -509,8 +509,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-orge747409" class="outline-3">
<h3 id="orge747409"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div id="outline-container-org76811c7" class="outline-3">
<h3 id="org76811c7"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div class="outline-text-3" id="text-1-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -534,8 +534,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org682fa21" class="outline-3">
<h3 id="org682fa21"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div id="outline-container-org2faf0f6" class="outline-3">
<h3 id="org2faf0f6"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div class="outline-text-3" id="text-1-5">
<div class="org-src-container">
<pre class="src src-c">$group$_t*
@ -706,8 +706,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-org39949f0" class="outline-3">
<h3 id="org39949f0"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div id="outline-container-org78ef45d" class="outline-3">
<h3 id="org78ef45d"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div class="outline-text-3" id="text-1-6">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -766,8 +766,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-orgf1ff581" class="outline-3">
<h3 id="orgf1ff581"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div id="outline-container-org48132e9" class="outline-3">
<h3 id="org48132e9"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div class="outline-text-3" id="text-1-7">
<p>
Memory is allocated when reading. The following function frees memory.
@ -803,8 +803,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org01a2375" class="outline-3">
<h3 id="org01a2375"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3>
<div id="outline-container-org3b467a7" class="outline-3">
<h3 id="org3b467a7"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3>
<div class="outline-text-3" id="text-1-8">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -866,8 +866,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-orgc5025b1" class="outline-3">
<h3 id="orgc5025b1"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3>
<div id="outline-container-org175ffc7" class="outline-3">
<h3 id="org175ffc7"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3>
<div class="outline-text-3" id="text-1-9">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -964,12 +964,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org1496c2f" class="outline-3">
<h3 id="org1496c2f"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
<div id="outline-container-orgb73d27e" class="outline-3">
<h3 id="orgb73d27e"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
<div class="outline-text-3" id="text-1-10">
</div>
<div id="outline-container-org9c96847" class="outline-4">
<h4 id="org9c96847"><span class="section-number-4">1.10.1</span> Read the complete struct</h4>
<div id="outline-container-orge9f9527" class="outline-4">
<h4 id="orge9f9527"><span class="section-number-4">1.10.1</span> Read the complete struct</h4>
<div class="outline-text-4" id="text-1-10-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">rdm_t</span>* <span style="color: #0000ff;">trexio_text_read_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
@ -1064,8 +1064,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org5c443c9" class="outline-4">
<h4 id="org5c443c9"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4>
<div id="outline-container-org119e83b" class="outline-4">
<h4 id="org119e83b"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4>
<div class="outline-text-4" id="text-1-10-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_flush_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
@ -1108,8 +1108,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-orgdf973bd" class="outline-4">
<h4 id="orgdf973bd"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div id="outline-container-org4effdb1" class="outline-4">
<h4 id="org4effdb1"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div class="outline-text-4" id="text-1-10-3">
<p>
Memory is allocated when reading. The followig function frees memory.
@ -1145,8 +1145,8 @@ Memory is allocated when reading. The followig function frees memory.
</div>
</div>
<div id="outline-container-org4bbe337" class="outline-4">
<h4 id="org4bbe337"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div id="outline-container-orgb657d2d" class="outline-4">
<h4 id="orgb657d2d"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-10-4">
<p>
The <code>one_e</code> array is assumed allocated with the appropriate size.
@ -1212,8 +1212,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div>
</div>
<div id="outline-container-org54fe26e" class="outline-4">
<h4 id="org54fe26e"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div id="outline-container-orge070ec4" class="outline-4">
<h4 id="orge070ec4"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-10-5">
<p>
<code>two_e</code> is a sparse data structure, which can be too large to fit
@ -1321,7 +1321,7 @@ file for each sparse float structure.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-06 Thu 22:03</p>
<p class="date">Created: 2021-05-07 Fri 22:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>