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

Deploying to gh-pages from @ TREX-CoE/trexio@51c43fe1ac 🚀

Browse Source
This commit is contained in:
scemama 2022-01-19 14:14:51 +00:00
parent 9e20f88e48
commit 6eb2366a6f
7 changed files with 589 additions and 435 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"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2022-01-17 Mon 18:16 --> <!-- 2022-01-19 Wed 14:14 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title> <title>TREXIO source code documentation</title>
@ -347,7 +347,7 @@ and bug reports should be submitted at
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2022-01-17 Mon 18:16</p> <p class="date">Created: 2022-01-19 Wed 14:14</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

82
examples.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2022-01-17 Mon 18:16 --> <!-- 2022-01-19 Wed 14:14 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Examples</title> <title>Examples</title>
@ -333,24 +333,24 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org67c71c7">1. Accessing sparse quantities</a> <li><a href="#org75b2c38">1. Accessing sparse quantities</a>
<ul> <ul>
<li><a href="#orgc08e4a1">1.1. Fortran</a> <li><a href="#org37d0c6c">1.1. Fortran</a>
<ul> <ul>
<li><a href="#org1f2dbb8">1.1.1. Declare Temporary variables</a></li> <li><a href="#orgd2f9ff3">1.1.1. Declare Temporary variables</a></li>
<li><a href="#org3d8c1f3">1.1.2. Obtain the name of the TREXIO file from the command line, and open it for reading</a></li> <li><a href="#org8b2ea29">1.1.2. Obtain the name of the TREXIO file from the command line, and open it for reading</a></li>
<li><a href="#org6924260">1.1.3. Read the nuclear repulsion energy</a></li> <li><a href="#org9e10acb">1.1.3. Read the nuclear repulsion energy</a></li>
<li><a href="#orgd18e4be">1.1.4. Read the number of molecular orbitals</a></li> <li><a href="#org7d4dcfc">1.1.4. Read the number of molecular orbitals</a></li>
<li><a href="#org7de3074">1.1.5. Allocate memory</a></li> <li><a href="#org5206209">1.1.5. Allocate memory</a></li>
<li><a href="#org38d877c">1.1.6. Read one-electron quantities</a></li> <li><a href="#orgea48bc8">1.1.6. Read one-electron quantities</a></li>
<li><a href="#orge2d8e2c">1.1.7. Read two-electron quantities</a> <li><a href="#org3a110f0">1.1.7. Read two-electron quantities</a>
<ul> <ul>
<li><a href="#org77b645d">1.1.7.1. Electron repulsion integrals</a></li> <li><a href="#orgfeca6e5">1.1.7.1. Electron repulsion integrals</a></li>
<li><a href="#org8e79657">1.1.7.2. Reduced density matrix</a></li> <li><a href="#orga18a1cb">1.1.7.2. Reduced density matrix</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org1839a31">1.1.8. Compute the energy</a></li> <li><a href="#org2818d5e">1.1.8. Compute the energy</a></li>
<li><a href="#orge6f7009">1.1.9. Terminate</a></li> <li><a href="#org6684f3a">1.1.9. Terminate</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -360,12 +360,12 @@ for the JavaScript code in this tag.
</div> </div>
<div id="outline-container-org67c71c7" class="outline-2"> <div id="outline-container-org75b2c38" class="outline-2">
<h2 id="org67c71c7"><span class="section-number-2">1</span> Accessing sparse quantities</h2> <h2 id="org75b2c38"><span class="section-number-2">1</span> Accessing sparse quantities</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
</div> </div>
<div id="outline-container-orgc08e4a1" class="outline-3"> <div id="outline-container-org37d0c6c" class="outline-3">
<h3 id="orgc08e4a1"><span class="section-number-3">1.1</span> Fortran</h3> <h3 id="org37d0c6c"><span class="section-number-3">1.1</span> Fortran</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">program</span> <span style="color: #0000ff;">print_energy</span> <pre class="src src-f90"><span style="color: #a020f0;">program</span> <span style="color: #0000ff;">print_energy</span>
@ -411,8 +411,8 @@ One needs to read from the TREXIO file:
</div> </div>
</div> </div>
<div id="outline-container-org1f2dbb8" class="outline-4"> <div id="outline-container-orgd2f9ff3" class="outline-4">
<h4 id="org1f2dbb8"><span class="section-number-4">1.1.1</span> Declare Temporary variables</h4> <h4 id="orgd2f9ff3"><span class="section-number-4">1.1.1</span> Declare Temporary variables</h4>
<div class="outline-text-4" id="text-1-1-1"> <div class="outline-text-4" id="text-1-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"><span style="color: #228b22;">integer</span> ::<span style="color: #a0522d;"> i, j, k, l, m</span> <pre class="src src-f90"><span style="color: #228b22;">integer</span> ::<span style="color: #a0522d;"> i, j, k, l, m</span>
@ -427,8 +427,8 @@ One needs to read from the TREXIO file:
</div> </div>
</div> </div>
<div id="outline-container-org3d8c1f3" class="outline-4"> <div id="outline-container-org8b2ea29" class="outline-4">
<h4 id="org3d8c1f3"><span class="section-number-4">1.1.2</span> Obtain the name of the TREXIO file from the command line, and open it for reading</h4> <h4 id="org8b2ea29"><span class="section-number-4">1.1.2</span> Obtain the name of the TREXIO file from the command line, and open it for reading</h4>
<div class="outline-text-4" id="text-1-1-2"> <div class="outline-text-4" id="text-1-1-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">call</span> <span style="color: #0000ff;">getarg</span>(1, filename) <pre class="src src-f90"><span style="color: #a020f0;">call</span> <span style="color: #0000ff;">getarg</span>(1, filename)
@ -444,8 +444,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_HDF5
</div> </div>
</div> </div>
<div id="outline-container-org6924260" class="outline-4"> <div id="outline-container-org9e10acb" class="outline-4">
<h4 id="org6924260"><span class="section-number-4">1.1.3</span> Read the nuclear repulsion energy</h4> <h4 id="org9e10acb"><span class="section-number-4">1.1.3</span> Read the nuclear repulsion energy</h4>
<div class="outline-text-4" id="text-1-1-3"> <div class="outline-text-4" id="text-1-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90">rc = trexio_read_nucleus_repulsion(f, E_nn) <pre class="src src-f90">rc = trexio_read_nucleus_repulsion(f, E_nn)
@ -459,8 +459,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_HDF5
</div> </div>
</div> </div>
<div id="outline-container-orgd18e4be" class="outline-4"> <div id="outline-container-org7d4dcfc" class="outline-4">
<h4 id="orgd18e4be"><span class="section-number-4">1.1.4</span> Read the number of molecular orbitals</h4> <h4 id="org7d4dcfc"><span class="section-number-4">1.1.4</span> Read the number of molecular orbitals</h4>
<div class="outline-text-4" id="text-1-1-4"> <div class="outline-text-4" id="text-1-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90">rc = trexio_read_mo_num(f, n) <pre class="src src-f90">rc = trexio_read_mo_num(f, n)
@ -474,8 +474,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_HDF5
</div> </div>
</div> </div>
<div id="outline-container-org7de3074" class="outline-4"> <div id="outline-container-org5206209" class="outline-4">
<h4 id="org7de3074"><span class="section-number-4">1.1.5</span> Allocate memory</h4> <h4 id="org5206209"><span class="section-number-4">1.1.5</span> Allocate memory</h4>
<div class="outline-text-4" id="text-1-1-5"> <div class="outline-text-4" id="text-1-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">allocate</span>( D(n,n), h0(n,n) ) <pre class="src src-f90"><span style="color: #a020f0;">allocate</span>( D(n,n), h0(n,n) )
@ -487,8 +487,8 @@ W(:,:,:,:) = 0.d0
</div> </div>
</div> </div>
<div id="outline-container-org38d877c" class="outline-4"> <div id="outline-container-orgea48bc8" class="outline-4">
<h4 id="org38d877c"><span class="section-number-4">1.1.6</span> Read one-electron quantities</h4> <h4 id="orgea48bc8"><span class="section-number-4">1.1.6</span> Read one-electron quantities</h4>
<div class="outline-text-4" id="text-1-1-6"> <div class="outline-text-4" id="text-1-1-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90">rc = trexio_has_mo_1e_int_core_hamiltonian(f) <pre class="src src-f90">rc = trexio_has_mo_1e_int_core_hamiltonian(f)
@ -520,8 +520,8 @@ rc = trexio_read_rdm_1e(f, D)
</div> </div>
</div> </div>
<div id="outline-container-orge2d8e2c" class="outline-4"> <div id="outline-container-org3a110f0" class="outline-4">
<h4 id="orge2d8e2c"><span class="section-number-4">1.1.7</span> Read two-electron quantities</h4> <h4 id="org3a110f0"><span class="section-number-4">1.1.7</span> Read two-electron quantities</h4>
<div class="outline-text-4" id="text-1-1-7"> <div class="outline-text-4" id="text-1-1-7">
<p> <p>
Reading is done with OpenMP. Each thread reads its own buffer, and Reading is done with OpenMP. Each thread reads its own buffer, and
@ -537,8 +537,8 @@ to be protected in the critical section when modified.
</p> </p>
</div> </div>
<div id="outline-container-org77b645d" class="outline-5"> <div id="outline-container-orgfeca6e5" class="outline-5">
<h5 id="org77b645d"><span class="section-number-5">1.1.7.1</span> Electron repulsion integrals</h5> <h5 id="orgfeca6e5"><span class="section-number-5">1.1.7.1</span> Electron repulsion integrals</h5>
<div class="outline-text-5" id="text-1-1-7-1"> <div class="outline-text-5" id="text-1-1-7-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90">rc = trexio_has_mo_2e_int_eri(f) <pre class="src src-f90">rc = trexio_has_mo_2e_int_eri(f)
@ -587,8 +587,8 @@ icount = BUFSIZE
</div> </div>
</div> </div>
<div id="outline-container-org8e79657" class="outline-5"> <div id="outline-container-orga18a1cb" class="outline-5">
<h5 id="org8e79657"><span class="section-number-5">1.1.7.2</span> Reduced density matrix</h5> <h5 id="orga18a1cb"><span class="section-number-5">1.1.7.2</span> Reduced density matrix</h5>
<div class="outline-text-5" id="text-1-1-7-2"> <div class="outline-text-5" id="text-1-1-7-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90">rc = trexio_has_rdm_2e(f) <pre class="src src-f90">rc = trexio_has_rdm_2e(f)
@ -632,8 +632,8 @@ icount = bufsize
</div> </div>
</div> </div>
<div id="outline-container-org1839a31" class="outline-4"> <div id="outline-container-org2818d5e" class="outline-4">
<h4 id="org1839a31"><span class="section-number-4">1.1.8</span> Compute the energy</h4> <h4 id="org2818d5e"><span class="section-number-4">1.1.8</span> Compute the energy</h4>
<div class="outline-text-4" id="text-1-1-8"> <div class="outline-text-4" id="text-1-1-8">
<p> <p>
When the orbitals are real, we can use When the orbitals are real, we can use
@ -679,8 +679,8 @@ E = E + E_nn
</div> </div>
</div> </div>
<div id="outline-container-orge6f7009" class="outline-4"> <div id="outline-container-org6684f3a" class="outline-4">
<h4 id="orge6f7009"><span class="section-number-4">1.1.9</span> Terminate</h4> <h4 id="org6684f3a"><span class="section-number-4">1.1.9</span> Terminate</h4>
<div class="outline-text-4" id="text-1-1-9"> <div class="outline-text-4" id="text-1-1-9">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"> <span style="color: #a020f0;">deallocate</span>( D, h0, G, W ) <pre class="src src-f90"> <span style="color: #a020f0;">deallocate</span>( D, h0, G, W )
@ -695,7 +695,7 @@ E = E + E_nn
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2022-01-17 Mon 18:16</p> <p class="date">Created: 2022-01-19 Wed 14:14</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

4
index.html
View File

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

591
templator_front.html
View File

File diff suppressed because it is too large Load Diff

87
templator_hdf5.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2022-01-17 Mon 18:15 --> <!-- 2022-01-19 Wed 14:14 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HDF5 back end</title> <title>HDF5 back end</title>
@ -311,29 +311,29 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org3966719">1. HDF5 back end</a> <li><a href="#org4438431">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#orgb4cea03">1.1. Template for HDF5 definitions</a></li> <li><a href="#org1958bc0">1.1. Template for HDF5 definitions</a></li>
<li><a href="#orgbfa94e1">1.2. Template for HDF5 structures</a></li> <li><a href="#org350a4d1">1.2. Template for HDF5 structures</a></li>
<li><a href="#orgabc2887">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#orgcca016e">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org4fd2221">1.4. Template for HDF5 has/read/write the numerical attribute</a></li> <li><a href="#org78c81aa">1.4. Template for HDF5 has/read/write the numerical attribute</a></li>
<li><a href="#orgf87e32d">1.5. Template for HDF5 has/read/write the dataset of numerical data</a></li> <li><a href="#orgedf01d9">1.5. Template for HDF5 has/read/write the dataset of numerical data</a></li>
<li><a href="#org334aa83">1.6. Template for HDF5 has/read/write the dataset of sparse data</a></li> <li><a href="#org48f906c">1.6. Template for HDF5 has/read/write the dataset of sparse data</a></li>
<li><a href="#org1e41326">1.7. Template for HDF5 has/read/write the dataset of strings</a></li> <li><a href="#orgec1d4a4">1.7. Template for HDF5 has/read/write the dataset of strings</a></li>
<li><a href="#org3cc6816">1.8. Template for HDF5 has/read/write the string attribute</a></li> <li><a href="#org5fd61de">1.8. Template for HDF5 has/read/write the string attribute</a></li>
<li><a href="#orgfbded59">1.9. Helper functions</a></li> <li><a href="#org015cf01">1.9. Helper functions</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org3966719" class="outline-2"> <div id="outline-container-org4438431" class="outline-2">
<h2 id="org3966719"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="org4438431"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
</div> </div>
<div id="outline-container-orgb4cea03" class="outline-3"> <div id="outline-container-org1958bc0" class="outline-3">
<h3 id="orgb4cea03"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="org1958bc0"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <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> <pre class="src src-c"><span style="color: #483d8b;">#define</span> $GROUP$_GROUP_NAME <span style="color: #8b2252;">"$group$"</span>
@ -345,8 +345,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orgbfa94e1" class="outline-3"> <div id="outline-container-org350a4d1" class="outline-3">
<h3 id="orgbfa94e1"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="org350a4d1"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<div class="org-src-container"> <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> { <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> {
@ -359,10 +359,26 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orgcca016e" class="outline-3">
<div id="outline-container-orgabc2887" class="outline-3"> <h3 id="orgcca016e"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<h3 id="orgabc2887"><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="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>
<span style="color: #0000ff;">trexio_hdf5_inquire</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">file_name</span>)
{
/* <span style="color: #b22222;">H5Fis_hdf5 determines whether file is in HDF5 format </span>*/
<span style="color: #228b22;">htri_t</span> <span style="color: #a0522d;">rc</span> = H5Fis_hdf5(file_name);
<span style="color: #a020f0;">if</span> (rc &gt; 0 ) {
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS; //<span style="color: #b22222;">exists and HDF5</span>
} <span style="color: #a020f0;">else</span> <span style="color: #a020f0;">if</span> (rc == 0) {
<span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR; //<span style="color: #b22222;">exists but not HDF5</span>
} <span style="color: #a020f0;">else</span> {
<span style="color: #a020f0;">return</span> TREXIO_FAILURE; //<span style="color: #b22222;">does not exist or function fails</span>
}
}
</pre>
</div>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
<span style="color: #0000ff;">trexio_hdf5_init</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>) <span style="color: #0000ff;">trexio_hdf5_init</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
@ -420,8 +436,11 @@ for the JavaScript code in this tag.
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS; <span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
} }
</pre>
</div>
<span style="color: #228b22;">trexio_exit_code</span> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
<span style="color: #0000ff;">trexio_hdf5_deinit</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>) <span style="color: #0000ff;">trexio_hdf5_deinit</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
{ {
@ -441,8 +460,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-org4fd2221" class="outline-3"> <div id="outline-container-org78c81aa" class="outline-3">
<h3 id="org4fd2221"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write the numerical attribute</h3> <h3 id="org78c81aa"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write the numerical attribute</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -536,8 +555,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orgf87e32d" class="outline-3"> <div id="outline-container-orgedf01d9" class="outline-3">
<h3 id="orgf87e32d"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write the dataset of numerical data</h3> <h3 id="orgedf01d9"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write the dataset of numerical data</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -659,8 +678,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-org334aa83" class="outline-3"> <div id="outline-container-org48f906c" class="outline-3">
<h3 id="org334aa83"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write the dataset of sparse data</h3> <h3 id="org48f906c"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write the dataset of sparse data</h3>
<div class="outline-text-3" id="text-1-6"> <div class="outline-text-3" id="text-1-6">
<p> <p>
Sparse data is stored using extensible datasets of HDF5. Extensibility is required Sparse data is stored using extensible datasets of HDF5. Extensibility is required
@ -861,8 +880,8 @@ due to the fact that the sparse data will be written in chunks of user-defined s
</div> </div>
</div> </div>
<div id="outline-container-org1e41326" class="outline-3"> <div id="outline-container-orgec1d4a4" class="outline-3">
<h3 id="org1e41326"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write the dataset of strings</h3> <h3 id="orgec1d4a4"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write the dataset of strings</h3>
<div class="outline-text-3" id="text-1-7"> <div class="outline-text-3" id="text-1-7">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1066,8 +1085,8 @@ due to the fact that the sparse data will be written in chunks of user-defined s
</div> </div>
</div> </div>
<div id="outline-container-org3cc6816" class="outline-3"> <div id="outline-container-org5fd61de" class="outline-3">
<h3 id="org3cc6816"><span class="section-number-3">1.8</span> Template for HDF5 has/read/write the string attribute</h3> <h3 id="org5fd61de"><span class="section-number-3">1.8</span> Template for HDF5 has/read/write the string attribute</h3>
<div class="outline-text-3" id="text-1-8"> <div class="outline-text-3" id="text-1-8">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1189,8 +1208,8 @@ due to the fact that the sparse data will be written in chunks of user-defined s
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orgfbded59" class="outline-3"> <div id="outline-container-org015cf01" class="outline-3">
<h3 id="orgfbded59"><span class="section-number-3">1.9</span> Helper functions</h3> <h3 id="org015cf01"><span class="section-number-3">1.9</span> Helper functions</h3>
<div class="outline-text-3" id="text-1-9"> <div class="outline-text-3" id="text-1-9">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1452,7 +1471,7 @@ due to the fact that the sparse data will be written in chunks of user-defined s
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2022-01-17 Mon 18:15</p> <p class="date">Created: 2022-01-19 Wed 14:14</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

138
templator_text.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2022-01-17 Mon 18:15 --> <!-- 2022-01-19 Wed 14:14 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TEXT back end</title> <title>TEXT back end</title>
@ -311,28 +311,28 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org0728860">1. TEXT back end</a> <li><a href="#org17568bb">1. TEXT back end</a>
<ul> <ul>
<li><a href="#orgca864f4">1.1. Template for group-related structures in text back end</a></li> <li><a href="#orgbb8c185">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org193aeba">1.2. Template for general structure in text back end</a></li> <li><a href="#org87605e2">1.2. Template for general structure in text back end</a></li>
<li><a href="#org772ba16">1.3. Initialize function (constant part)</a></li> <li><a href="#org442551a">1.3. Initialize function (constant part)</a></li>
<li><a href="#org764b1fd">1.4. Deinitialize function (templated part)</a></li> <li><a href="#org1add6dc">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org3b0d3ec">1.5. Template for text read struct</a></li> <li><a href="#org4439449">1.5. Template for text read struct</a></li>
<li><a href="#orga1e0ffc">1.6. Template for text flush struct</a></li> <li><a href="#org861ce51">1.6. Template for text flush struct</a></li>
<li><a href="#orgf719c57">1.7. Template for text free memory</a></li> <li><a href="#org702c230">1.7. Template for text free memory</a></li>
<li><a href="#org3603e92">1.8. Template for has/read/write the numerical attribute</a></li> <li><a href="#orga4611ab">1.8. Template for has/read/write the numerical attribute</a></li>
<li><a href="#orgab74cab">1.9. Template for has/read/write the dataset of numerical data</a></li> <li><a href="#org128508e">1.9. Template for has/read/write the dataset of numerical data</a></li>
<li><a href="#org3aed1f9">1.10. Template for has/read/write the dataset of strings</a></li> <li><a href="#org436b948">1.10. Template for has/read/write the dataset of strings</a></li>
<li><a href="#org4630648">1.11. Template for has/read/write the string attribute</a></li> <li><a href="#org74bb03c">1.11. Template for has/read/write the string attribute</a></li>
<li><a href="#orgdff8e78">1.12. Template for has/read/write the dataset of sparse data</a></li> <li><a href="#org9bf3459">1.12. Template for has/read/write the dataset of sparse data</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org0728860" class="outline-2"> <div id="outline-container-org17568bb" class="outline-2">
<h2 id="org0728860"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="org17568bb"><span class="section-number-2">1</span> TEXT back end</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The "file" produced by the text back end is a directory with one The "file" produced by the text back end is a directory with one
@ -353,8 +353,8 @@ The file is written when closed, or when the flush function is called.
</p> </p>
</div> </div>
<div id="outline-container-orgca864f4" class="outline-3"> <div id="outline-container-orgbb8c185" class="outline-3">
<h3 id="orgca864f4"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="orgbb8c185"><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="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s { <pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s {
@ -373,8 +373,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-org193aeba" class="outline-3"> <div id="outline-container-org87605e2" class="outline-3">
<h3 id="org193aeba"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="org87605e2"><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="outline-text-3" id="text-1-2">
<div class="org-src-container"> <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_text_s</span> { <pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_text_s</span> {
@ -387,9 +387,33 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-org772ba16" class="outline-3"> <div id="outline-container-org442551a" class="outline-3">
<h3 id="org772ba16"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="org442551a"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div class="outline-text-3" id="text-1-3"> <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>
<span style="color: #0000ff;">trexio_text_inquire</span> (<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">file_name</span>)
{
/* <span style="color: #b22222;">Check if the file with "file_name" exists and that it is a directory </span>*/
<span style="color: #a020f0;">struct</span> <span style="color: #228b22;">stat</span> <span style="color: #a0522d;">st</span>;
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc</span> = stat(file_name, &amp;st);
<span style="color: #228b22;">bool</span> <span style="color: #a0522d;">file_exists</span> = rc == 0;
<span style="color: #a020f0;">if</span> (file_exists) {
<span style="color: #228b22;">bool</span> <span style="color: #a0522d;">is_a_directory</span> = st.st_mode &amp; S_IFDIR;
<span style="color: #a020f0;">if</span> (!is_a_directory) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
} <span style="color: #a020f0;">else</span> {
<span style="color: #a020f0;">return</span> TREXIO_FAILURE;
}
}
</pre>
</div>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
<span style="color: #0000ff;">trexio_text_init</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>) <span style="color: #0000ff;">trexio_text_init</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
@ -402,30 +426,19 @@ The file is written when closed, or when the flush function is called.
/* <span style="color: #b22222;">Put all pointers to NULL but leave parent untouched </span>*/ /* <span style="color: #b22222;">Put all pointers to NULL but leave parent untouched </span>*/
memset(&amp;(f-&gt;parent)+1,0,<span style="color: #a020f0;">sizeof</span>(trexio_text_t)-<span style="color: #a020f0;">sizeof</span>(trexio_t)); memset(&amp;(f-&gt;parent)+1,0,<span style="color: #a020f0;">sizeof</span>(trexio_text_t)-<span style="color: #a020f0;">sizeof</span>(trexio_t));
/* <span style="color: #b22222;">If directory doesn't exist, create it in write mode </span>*/ /* <span style="color: #b22222;">Check if directory exists </span>*/
<span style="color: #a020f0;">struct</span> <span style="color: #228b22;">stat</span> <span style="color: #a0522d;">st</span>; <span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span>;
rc = trexio_text_inquire(file-&gt;file_name);
/* <span style="color: #b22222;">TREXIO file exists but is not a directory </span>*/
<span style="color: #a020f0;">if</span> (rc == TREXIO_FILE_ERROR) <span style="color: #a020f0;">return</span> rc;
/* <span style="color: #b22222;">If directory does not exist - create it in write mode </span>*/
<span style="color: #a020f0;">if</span> (rc == TREXIO_FAILURE) {
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc</span> = stat(file-&gt;file_name, &amp;st); <span style="color: #a020f0;">if</span> (file-&gt;mode == <span style="color: #8b2252;">'r'</span>) <span style="color: #a020f0;">return</span> TREXIO_READONLY;
<span style="color: #228b22;">bool</span> <span style="color: #a0522d;">file_exists</span> = rc == 0; <span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc_dir</span> = mkdir(file-&gt;file_name, 0777);
<span style="color: #a020f0;">if</span> (rc_dir != 0) <span style="color: #a020f0;">return</span> TREXIO_ERRNO;
<span style="color: #a020f0;">if</span> (file_exists) {
<span style="color: #228b22;">bool</span> <span style="color: #a0522d;">is_a_directory</span> = st.st_mode &amp; S_IFDIR;
<span style="color: #a020f0;">if</span> (!is_a_directory) {
<span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
}
} <span style="color: #a020f0;">else</span> {
<span style="color: #a020f0;">if</span> (file-&gt;mode == <span style="color: #8b2252;">'r'</span>) {
<span style="color: #a020f0;">return</span> TREXIO_READONLY;
}
rc = mkdir(file-&gt;file_name, 0777);
<span style="color: #a020f0;">if</span> (rc != 0) {
<span style="color: #a020f0;">return</span> TREXIO_ERRNO;
}
} }
/* <span style="color: #b22222;">Create the lock file in the directory </span>*/ /* <span style="color: #b22222;">Create the lock file in the directory </span>*/
@ -491,7 +504,6 @@ The file is written when closed, or when the flush function is called.
</pre> </pre>
</div> </div>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
<span style="color: #0000ff;">trexio_text_unlock</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>) <span style="color: #0000ff;">trexio_text_unlock</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
@ -519,8 +531,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-org764b1fd" class="outline-3"> <div id="outline-container-org1add6dc" class="outline-3">
<h3 id="org764b1fd"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="org1add6dc"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -542,8 +554,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-org3b0d3ec" class="outline-3"> <div id="outline-container-org4439449" class="outline-3">
<h3 id="org3b0d3ec"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="org4439449"><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="outline-text-3" id="text-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">$group$_t* <pre class="src src-c">$group$_t*
@ -835,8 +847,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-orga1e0ffc" class="outline-3"> <div id="outline-container-org861ce51" class="outline-3">
<h3 id="orga1e0ffc"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="org861ce51"><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="outline-text-3" id="text-1-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -901,8 +913,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-orgf719c57" class="outline-3"> <div id="outline-container-org702c230" class="outline-3">
<h3 id="orgf719c57"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="org702c230"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div class="outline-text-3" id="text-1-7"> <div class="outline-text-3" id="text-1-7">
<p> <p>
Memory is allocated when reading. The following function frees memory. Memory is allocated when reading. The following function frees memory.
@ -947,8 +959,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org3603e92" class="outline-3"> <div id="outline-container-orga4611ab" class="outline-3">
<h3 id="org3603e92"><span class="section-number-3">1.8</span> Template for has/read/write the numerical attribute</h3> <h3 id="orga4611ab"><span class="section-number-3">1.8</span> Template for has/read/write the numerical attribute</h3>
<div class="outline-text-3" id="text-1-8"> <div class="outline-text-3" id="text-1-8">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1011,8 +1023,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-orgab74cab" class="outline-3"> <div id="outline-container-org128508e" class="outline-3">
<h3 id="orgab74cab"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3> <h3 id="org128508e"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
<div class="outline-text-3" id="text-1-9"> <div class="outline-text-3" id="text-1-9">
<p> <p>
The <code>group_dset</code> array is assumed allocated with the appropriate size. The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -1108,8 +1120,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org3aed1f9" class="outline-3"> <div id="outline-container-org436b948" class="outline-3">
<h3 id="org3aed1f9"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3> <h3 id="org436b948"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
<div class="outline-text-3" id="text-1-10"> <div class="outline-text-3" id="text-1-10">
<p> <p>
The <code>group_dset</code> array is assumed allocated with the appropriate size. The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -1210,8 +1222,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org4630648" class="outline-3"> <div id="outline-container-org74bb03c" class="outline-3">
<h3 id="org4630648"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3> <h3 id="org74bb03c"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
<div class="outline-text-3" id="text-1-11"> <div class="outline-text-3" id="text-1-11">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1285,8 +1297,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orgdff8e78" class="outline-3"> <div id="outline-container-org9bf3459" class="outline-3">
<h3 id="orgdff8e78"><span class="section-number-3">1.12</span> Template for has/read/write the dataset of sparse data</h3> <h3 id="org9bf3459"><span class="section-number-3">1.12</span> Template for has/read/write the dataset of sparse data</h3>
<div class="outline-text-3" id="text-1-12"> <div class="outline-text-3" id="text-1-12">
<p> <p>
Each sparse array is stored in a separate <code>.txt</code> file due to the fact that sparse I/O has to be decoupled Each sparse array is stored in a separate <code>.txt</code> file due to the fact that sparse I/O has to be decoupled
@ -1563,7 +1575,7 @@ User provides indices and values of the sparse array as two separate variables.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2022-01-17 Mon 18:15</p> <p class="date">Created: 2022-01-19 Wed 14:14</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

116
trex.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2022-01-17 Mon 18:16 --> <!-- 2022-01-19 Wed 14:14 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREX Configuration file</title> <title>TREX Configuration file</title>
@ -333,33 +333,33 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org75f87e8">1. Metadata (metadata group)</a></li> <li><a href="#org6e120d8">1. Metadata (metadata group)</a></li>
<li><a href="#orgbe9dae4">2. Electron (electron group)</a></li> <li><a href="#org858726b">2. Electron (electron group)</a></li>
<li><a href="#org620cd51">3. Nucleus (nucleus group)</a></li> <li><a href="#org254fcc8">3. Nucleus (nucleus group)</a></li>
<li><a href="#orgc153f72">4. Effective core potentials (ecp group)</a> <li><a href="#org0e12f81">4. Effective core potentials (ecp group)</a>
<ul> <ul>
<li><a href="#org545e12b">4.1. Example</a></li> <li><a href="#orgbae9d48">4.1. Example</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgd447554">5. Basis set (basis group)</a> <li><a href="#org9f84cce">5. Basis set (basis group)</a>
<ul> <ul>
<li><a href="#org933e3ee">5.1. Example</a></li> <li><a href="#org5700d51">5.1. Example</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgab737e0">6. Atomic orbitals (ao group)</a> <li><a href="#org89ea381">6. Atomic orbitals (ao group)</a>
<ul> <ul>
<li><a href="#ao_one_e">6.1. One-electron integrals (<code>ao_1e_int</code> group)</a></li> <li><a href="#ao_one_e">6.1. One-electron integrals (<code>ao_1e_int</code> group)</a></li>
<li><a href="#ao_two_e">6.2. Two-electron integrals (<code>ao_2e_int</code> group)</a></li> <li><a href="#ao_two_e">6.2. Two-electron integrals (<code>ao_2e_int</code> group)</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org8cc55bf">7. Molecular orbitals (mo group)</a> <li><a href="#org93d33f6">7. Molecular orbitals (mo group)</a>
<ul> <ul>
<li><a href="#org8113b6b">7.1. One-electron integrals (<code>mo_1e_int</code> group)</a></li> <li><a href="#org649f29f">7.1. One-electron integrals (<code>mo_1e_int</code> group)</a></li>
<li><a href="#orgefc0cea">7.2. Two-electron integrals (<code>mo_2e_int</code> group)</a></li> <li><a href="#org6025c81">7.2. Two-electron integrals (<code>mo_2e_int</code> group)</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgf0ed2d5">8. <span class="todo TODO">TODO</span> Slater determinants</a></li> <li><a href="#orgc7fb7ad">8. <span class="todo TODO">TODO</span> Slater determinants</a></li>
<li><a href="#orgfca3754">9. Reduced density matrices (rdm group)</a></li> <li><a href="#org2233d8d">9. Reduced density matrices (rdm group)</a></li>
</ul> </ul>
</div> </div>
</div> </div>
@ -409,8 +409,8 @@ fetched using multiple function calls to perform I/O on buffers.
</p> </p>
<div id="outline-container-org75f87e8" class="outline-2"> <div id="outline-container-org6e120d8" class="outline-2">
<h2 id="org75f87e8"><span class="section-number-2">1</span> Metadata (metadata group)</h2> <h2 id="org6e120d8"><span class="section-number-2">1</span> Metadata (metadata group)</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
As we expect our files to be archived in open-data repositories, we As we expect our files to be archived in open-data repositories, we
@ -420,7 +420,7 @@ which have participated to the creation of the file, a list of
authors of the file, and a textual description. authors of the file, and a textual description.
</p> </p>
<table id="org1576189" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org8831fdd" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -487,15 +487,15 @@ authors of the file, and a textual description.
</div> </div>
</div> </div>
<div id="outline-container-orgbe9dae4" class="outline-2"> <div id="outline-container-org858726b" class="outline-2">
<h2 id="orgbe9dae4"><span class="section-number-2">2</span> Electron (electron group)</h2> <h2 id="org858726b"><span class="section-number-2">2</span> Electron (electron group)</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
We consider wave functions expressed in the spin-free formalism, where We consider wave functions expressed in the spin-free formalism, where
the number of &uarr; and &darr; electrons is fixed. the number of &uarr; and &darr; electrons is fixed.
</p> </p>
<table id="org0d492f2" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orga717694" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -534,15 +534,15 @@ the number of &uarr; and &darr; electrons is fixed.
</div> </div>
</div> </div>
<div id="outline-container-org620cd51" class="outline-2"> <div id="outline-container-org254fcc8" class="outline-2">
<h2 id="org620cd51"><span class="section-number-2">3</span> Nucleus (nucleus group)</h2> <h2 id="org254fcc8"><span class="section-number-2">3</span> Nucleus (nucleus group)</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
The nuclei are considered as fixed point charges. Coordinates are The nuclei are considered as fixed point charges. Coordinates are
given in Cartesian \((x,y,z)\) format. given in Cartesian \((x,y,z)\) format.
</p> </p>
<table id="orgaed0075" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orga899068" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -609,8 +609,8 @@ given in Cartesian \((x,y,z)\) format.
</div> </div>
</div> </div>
<div id="outline-container-orgc153f72" class="outline-2"> <div id="outline-container-org0e12f81" class="outline-2">
<h2 id="orgc153f72"><span class="section-number-2">4</span> Effective core potentials (ecp group)</h2> <h2 id="org0e12f81"><span class="section-number-2">4</span> Effective core potentials (ecp group)</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
An effective core potential (ECP) \(V_A^{\text{ECP}}\) replacing the An effective core potential (ECP) \(V_A^{\text{ECP}}\) replacing the
@ -643,7 +643,7 @@ The functions \(V_{A\ell}\) are parameterized as:
See <a href="http://dx.doi.org/10.1063/1.4984046">http://dx.doi.org/10.1063/1.4984046</a> or <a href="https://doi.org/10.1063/1.5121006">https://doi.org/10.1063/1.5121006</a> for more info. See <a href="http://dx.doi.org/10.1063/1.4984046">http://dx.doi.org/10.1063/1.4984046</a> or <a href="https://doi.org/10.1063/1.5121006">https://doi.org/10.1063/1.5121006</a> for more info.
</p> </p>
<table id="org8ad6585" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org3f33091" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -741,8 +741,8 @@ The latter causes issues when written before <code>ang_mom</code> in the TREXIO
</p> </p>
</div> </div>
<div id="outline-container-org545e12b" class="outline-3"> <div id="outline-container-orgbae9d48" class="outline-3">
<h3 id="org545e12b"><span class="section-number-3">4.1</span> Example</h3> <h3 id="orgbae9d48"><span class="section-number-3">4.1</span> Example</h3>
<div class="outline-text-3" id="text-4-1"> <div class="outline-text-3" id="text-4-1">
<p> <p>
For example, consider H<sub>2</sub> molecule with the following For example, consider H<sub>2</sub> molecule with the following
@ -805,8 +805,8 @@ power = [
</div> </div>
</div> </div>
<div id="outline-container-orgd447554" class="outline-2"> <div id="outline-container-org9f84cce" class="outline-2">
<h2 id="orgd447554"><span class="section-number-2">5</span> Basis set (basis group)</h2> <h2 id="org9f84cce"><span class="section-number-2">5</span> Basis set (basis group)</h2>
<div class="outline-text-2" id="text-5"> <div class="outline-text-2" id="text-5">
<p> <p>
We consider here basis functions centered on nuclei. Hence, we enable We consider here basis functions centered on nuclei. Hence, we enable
@ -859,7 +859,7 @@ If the the basis function is not considered normalized, \(\mathcal{N}_s=1\).
All the basis set parameters are stored in one-dimensional arrays: All the basis set parameters are stored in one-dimensional arrays:
</p> </p>
<table id="orgf1b00b2" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgaecd40e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -953,8 +953,8 @@ All the basis set parameters are stored in one-dimensional arrays:
</table> </table>
</div> </div>
<div id="outline-container-org933e3ee" class="outline-3"> <div id="outline-container-org5700d51" class="outline-3">
<h3 id="org933e3ee"><span class="section-number-3">5.1</span> Example</h3> <h3 id="org5700d51"><span class="section-number-3">5.1</span> Example</h3>
<div class="outline-text-3" id="text-5-1"> <div class="outline-text-3" id="text-5-1">
<p> <p>
For example, consider H<sub>2</sub> with the following basis set (in GAMESS For example, consider H<sub>2</sub> with the following basis set (in GAMESS
@ -1032,8 +1032,8 @@ prim_factor =
</div> </div>
</div> </div>
<div id="outline-container-orgab737e0" class="outline-2"> <div id="outline-container-org89ea381" class="outline-2">
<h2 id="orgab737e0"><span class="section-number-2">6</span> Atomic orbitals (ao group)</h2> <h2 id="org89ea381"><span class="section-number-2">6</span> Atomic orbitals (ao group)</h2>
<div class="outline-text-2" id="text-6"> <div class="outline-text-2" id="text-6">
<p> <p>
Going from the atomic basis set to AOs implies a systematic Going from the atomic basis set to AOs implies a systematic
@ -1085,13 +1085,13 @@ shell, as in the GAMESS convention where
<p> <p>
In such a case, one should set the normalization of the shell (in In such a case, one should set the normalization of the shell (in
the <a href="#orgd447554">Basis set</a> section) to \(\mathcal{N}_{z^2}\), which is the the <a href="#org9f84cce">Basis set</a> section) to \(\mathcal{N}_{z^2}\), which is the
normalization factor of the atomic orbitals in spherical coordinates. normalization factor of the atomic orbitals in spherical coordinates.
The normalization factor of the \(xy\) function which should be The normalization factor of the \(xy\) function which should be
introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\). introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\).
</p> </p>
<table id="org9b679f4" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org8de9d9d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1143,8 +1143,8 @@ introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\).
</table> </table>
</div> </div>
<div id="outline-container-org08cb618" class="outline-3"> <div id="outline-container-orgb224246" class="outline-3">
<h3 id="ao_one_e"><a id="org08cb618"></a><span class="section-number-3">6.1</span> One-electron integrals (<code>ao_1e_int</code> group)</h3> <h3 id="ao_one_e"><a id="orgb224246"></a><span class="section-number-3">6.1</span> One-electron integrals (<code>ao_1e_int</code> group)</h3>
<div class="outline-text-3" id="text-ao_one_e"> <div class="outline-text-3" id="text-ao_one_e">
<ul class="org-ul"> <ul class="org-ul">
<li>\[ \hat{V}_{\text{ne}} = \sum_{A=1}^{N_\text{nucl}} <li>\[ \hat{V}_{\text{ne}} = \sum_{A=1}^{N_\text{nucl}}
@ -1162,7 +1162,7 @@ The one-electron integrals for a one-electron operator \(\hat{O}\) are
over atomic orbitals. over atomic orbitals.
</p> </p>
<table id="org18971b6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org39e9155" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1229,8 +1229,8 @@ over atomic orbitals.
</div> </div>
</div> </div>
<div id="outline-container-orge73fb15" class="outline-3"> <div id="outline-container-org60161cf" class="outline-3">
<h3 id="ao_two_e"><a id="orge73fb15"></a><span class="section-number-3">6.2</span> Two-electron integrals (<code>ao_2e_int</code> group)</h3> <h3 id="ao_two_e"><a id="org60161cf"></a><span class="section-number-3">6.2</span> Two-electron integrals (<code>ao_2e_int</code> group)</h3>
<div class="outline-text-3" id="text-ao_two_e"> <div class="outline-text-3" id="text-ao_two_e">
<p> <p>
The two-electron integrals for a two-electron operator \(\hat{O}\) are The two-electron integrals for a two-electron operator \(\hat{O}\) are
@ -1251,7 +1251,7 @@ notation.
\mathbf{r}_j \vert)}{\vert \mathbf{r}_i - \mathbf{r}_j \vert} \] : electron-electron long range potential</li> \mathbf{r}_j \vert)}{\vert \mathbf{r}_i - \mathbf{r}_j \vert} \] : electron-electron long range potential</li>
</ul> </ul>
<table id="orge666d13" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgc4c4e81" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1291,10 +1291,10 @@ notation.
</div> </div>
</div> </div>
<div id="outline-container-org8cc55bf" class="outline-2"> <div id="outline-container-org93d33f6" class="outline-2">
<h2 id="org8cc55bf"><span class="section-number-2">7</span> Molecular orbitals (mo group)</h2> <h2 id="org93d33f6"><span class="section-number-2">7</span> Molecular orbitals (mo group)</h2>
<div class="outline-text-2" id="text-7"> <div class="outline-text-2" id="text-7">
<table id="orgc125343" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org94d624b" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1360,8 +1360,8 @@ notation.
</table> </table>
</div> </div>
<div id="outline-container-org8113b6b" class="outline-3"> <div id="outline-container-org649f29f" class="outline-3">
<h3 id="org8113b6b"><span class="section-number-3">7.1</span> One-electron integrals (<code>mo_1e_int</code> group)</h3> <h3 id="org649f29f"><span class="section-number-3">7.1</span> One-electron integrals (<code>mo_1e_int</code> group)</h3>
<div class="outline-text-3" id="text-7-1"> <div class="outline-text-3" id="text-7-1">
<p> <p>
The operators as the same as those defined in the The operators as the same as those defined in the
@ -1369,7 +1369,7 @@ The operators as the same as those defined in the
the basis of molecular orbitals. the basis of molecular orbitals.
</p> </p>
<table id="org2a44911" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgf52cad7" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1436,8 +1436,8 @@ the basis of molecular orbitals.
</div> </div>
</div> </div>
<div id="outline-container-orgefc0cea" class="outline-3"> <div id="outline-container-org6025c81" class="outline-3">
<h3 id="orgefc0cea"><span class="section-number-3">7.2</span> Two-electron integrals (<code>mo_2e_int</code> group)</h3> <h3 id="org6025c81"><span class="section-number-3">7.2</span> Two-electron integrals (<code>mo_2e_int</code> group)</h3>
<div class="outline-text-3" id="text-7-2"> <div class="outline-text-3" id="text-7-2">
<p> <p>
The operators as the same as those defined in the The operators as the same as those defined in the
@ -1445,7 +1445,7 @@ The operators as the same as those defined in the
the basis of molecular orbitals. the basis of molecular orbitals.
</p> </p>
<table id="org29aa490" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgca42536" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1485,11 +1485,11 @@ the basis of molecular orbitals.
</div> </div>
</div> </div>
<div id="outline-container-orgf0ed2d5" class="outline-2"> <div id="outline-container-orgc7fb7ad" class="outline-2">
<h2 id="orgf0ed2d5"><span class="section-number-2">8</span> <span class="todo TODO">TODO</span> Slater determinants</h2> <h2 id="orgc7fb7ad"><span class="section-number-2">8</span> <span class="todo TODO">TODO</span> Slater determinants</h2>
</div> </div>
<div id="outline-container-orgfca3754" class="outline-2"> <div id="outline-container-org2233d8d" class="outline-2">
<h2 id="orgfca3754"><span class="section-number-2">9</span> Reduced density matrices (rdm group)</h2> <h2 id="org2233d8d"><span class="section-number-2">9</span> Reduced density matrices (rdm group)</h2>
<div class="outline-text-2" id="text-9"> <div class="outline-text-2" id="text-9">
<p> <p>
The reduced density matrices are defined in the basis of molecular The reduced density matrices are defined in the basis of molecular
@ -1542,7 +1542,7 @@ The total energy can be computed as:
\] \]
</p> </p>
<table id="orgf5bd757" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgd6c692a" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1625,7 +1625,7 @@ The total energy can be computed as:
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2022-01-17 Mon 18:16</p> <p class="date">Created: 2022-01-19 Wed 14:14</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>