mirror of
https://github.com/TREX-CoE/trexio.git
synced 2024-12-25 22:03:56 +01:00
Deploying to gh-pages from @ TREX-CoE/trexio@acff2de611 🚀
This commit is contained in:
parent
04c7f3cab4
commit
5d8d125fe6
@ -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-07 Fri 10:53 -->
|
<!-- 2022-01-07 Fri 10:59 -->
|
||||||
<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" />
|
||||||
<meta name=google-site-verification content=jdDnuP2rYGJVy8AHSd-8LkmOmvK_dyz5buZ98wilYII />
|
<meta name=google-site-verification content=jdDnuP2rYGJVy8AHSd-8LkmOmvK_dyz5buZ98wilYII />
|
||||||
@ -348,7 +348,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-07 Fri 10:53</p>
|
<p class="date">Created: 2022-01-07 Fri 10:59</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>
|
||||||
|
@ -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-07 Fri 10:53 -->
|
<!-- 2022-01-07 Fri 10:59 -->
|
||||||
<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="#org14ca8f6">1. Accessing sparse quantities</a>
|
<li><a href="#orgfd161ff">1. Accessing sparse quantities</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgffee137">1.1. Fortran</a>
|
<li><a href="#org3f9ee2d">1.1. Fortran</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgdcc44bc">1.1.1. Declare Temporary variables</a></li>
|
<li><a href="#orgbc33e4a">1.1.1. Declare Temporary variables</a></li>
|
||||||
<li><a href="#org41993cf">1.1.2. Obtain the name of the TREXIO file from the command line, and open it for reading</a></li>
|
<li><a href="#org2907677">1.1.2. Obtain the name of the TREXIO file from the command line, and open it for reading</a></li>
|
||||||
<li><a href="#org00c0f2b">1.1.3. Read the nuclear repulsion energy</a></li>
|
<li><a href="#org8db445c">1.1.3. Read the nuclear repulsion energy</a></li>
|
||||||
<li><a href="#orgbe7cf44">1.1.4. Read the number of molecular orbitals</a></li>
|
<li><a href="#org7153425">1.1.4. Read the number of molecular orbitals</a></li>
|
||||||
<li><a href="#orgc7eecd9">1.1.5. Allocate memory</a></li>
|
<li><a href="#org949f3ac">1.1.5. Allocate memory</a></li>
|
||||||
<li><a href="#org25cd75e">1.1.6. Read one-electron quantities</a></li>
|
<li><a href="#org18a6066">1.1.6. Read one-electron quantities</a></li>
|
||||||
<li><a href="#orga9871b0">1.1.7. Read two-electron quantities</a>
|
<li><a href="#orgdf7d111">1.1.7. Read two-electron quantities</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org72c4148">1.1.7.1. Electron repulsion integrals</a></li>
|
<li><a href="#org013932b">1.1.7.1. Electron repulsion integrals</a></li>
|
||||||
<li><a href="#orgb6f141c">1.1.7.2. Reduced density matrix</a></li>
|
<li><a href="#org0abcf69">1.1.7.2. Reduced density matrix</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org3479493">1.1.8. Compute the energy</a></li>
|
<li><a href="#org2812854">1.1.8. Compute the energy</a></li>
|
||||||
<li><a href="#org94a8a1e">1.1.9. Terminate</a></li>
|
<li><a href="#org13f38d4">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-org14ca8f6" class="outline-2">
|
<div id="outline-container-orgfd161ff" class="outline-2">
|
||||||
<h2 id="org14ca8f6"><span class="section-number-2">1</span> Accessing sparse quantities</h2>
|
<h2 id="orgfd161ff"><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-orgffee137" class="outline-3">
|
<div id="outline-container-org3f9ee2d" class="outline-3">
|
||||||
<h3 id="orgffee137"><span class="section-number-3">1.1</span> Fortran</h3>
|
<h3 id="org3f9ee2d"><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>
|
||||||
@ -413,8 +413,8 @@ One needs to read from the TREXIO file:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgdcc44bc" class="outline-4">
|
<div id="outline-container-orgbc33e4a" class="outline-4">
|
||||||
<h4 id="orgdcc44bc"><span class="section-number-4">1.1.1</span> Declare Temporary variables</h4>
|
<h4 id="orgbc33e4a"><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>
|
||||||
@ -429,8 +429,8 @@ One needs to read from the TREXIO file:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org41993cf" class="outline-4">
|
<div id="outline-container-org2907677" class="outline-4">
|
||||||
<h4 id="org41993cf"><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="org2907677"><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)
|
||||||
@ -446,8 +446,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_HDF5
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org00c0f2b" class="outline-4">
|
<div id="outline-container-org8db445c" class="outline-4">
|
||||||
<h4 id="org00c0f2b"><span class="section-number-4">1.1.3</span> Read the nuclear repulsion energy</h4>
|
<h4 id="org8db445c"><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)
|
||||||
@ -461,8 +461,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_HDF5
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgbe7cf44" class="outline-4">
|
<div id="outline-container-org7153425" class="outline-4">
|
||||||
<h4 id="orgbe7cf44"><span class="section-number-4">1.1.4</span> Read the number of molecular orbitals</h4>
|
<h4 id="org7153425"><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)
|
||||||
@ -476,8 +476,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_HDF5
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgc7eecd9" class="outline-4">
|
<div id="outline-container-org949f3ac" class="outline-4">
|
||||||
<h4 id="orgc7eecd9"><span class="section-number-4">1.1.5</span> Allocate memory</h4>
|
<h4 id="org949f3ac"><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) )
|
||||||
@ -489,8 +489,8 @@ W(:,:,:,:) = 0.d0
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org25cd75e" class="outline-4">
|
<div id="outline-container-org18a6066" class="outline-4">
|
||||||
<h4 id="org25cd75e"><span class="section-number-4">1.1.6</span> Read one-electron quantities</h4>
|
<h4 id="org18a6066"><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)
|
||||||
@ -522,8 +522,8 @@ rc = trexio_read_rdm_1e(f, D)
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga9871b0" class="outline-4">
|
<div id="outline-container-orgdf7d111" class="outline-4">
|
||||||
<h4 id="orga9871b0"><span class="section-number-4">1.1.7</span> Read two-electron quantities</h4>
|
<h4 id="orgdf7d111"><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
|
||||||
@ -539,8 +539,8 @@ to be protected in the critical section when modified.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org72c4148" class="outline-5">
|
<div id="outline-container-org013932b" class="outline-5">
|
||||||
<h5 id="org72c4148"><span class="section-number-5">1.1.7.1</span> Electron repulsion integrals</h5>
|
<h5 id="org013932b"><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)
|
||||||
@ -589,8 +589,8 @@ icount = BUFSIZE
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgb6f141c" class="outline-5">
|
<div id="outline-container-org0abcf69" class="outline-5">
|
||||||
<h5 id="orgb6f141c"><span class="section-number-5">1.1.7.2</span> Reduced density matrix</h5>
|
<h5 id="org0abcf69"><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)
|
||||||
@ -634,8 +634,8 @@ icount = bufsize
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3479493" class="outline-4">
|
<div id="outline-container-org2812854" class="outline-4">
|
||||||
<h4 id="org3479493"><span class="section-number-4">1.1.8</span> Compute the energy</h4>
|
<h4 id="org2812854"><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>
|
||||||
As \((n,m)\) 2D arrays are stored in memory as \((\n times m)\) 1D
|
As \((n,m)\) 2D arrays are stored in memory as \((\n times m)\) 1D
|
||||||
@ -669,8 +669,8 @@ E = E + E_nn
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org94a8a1e" class="outline-4">
|
<div id="outline-container-org13f38d4" class="outline-4">
|
||||||
<h4 id="org94a8a1e"><span class="section-number-4">1.1.9</span> Terminate</h4>
|
<h4 id="org13f38d4"><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 )
|
||||||
@ -685,7 +685,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-07 Fri 10:53</p>
|
<p class="date">Created: 2022-01-07 Fri 10:59</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>
|
||||||
|
@ -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-07 Fri 10:53 -->
|
<!-- 2022-01-07 Fri 10:59 -->
|
||||||
<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" />
|
||||||
<meta name=google-site-verification content=jdDnuP2rYGJVy8AHSd-8LkmOmvK_dyz5buZ98wilYII />
|
<meta name=google-site-verification content=jdDnuP2rYGJVy8AHSd-8LkmOmvK_dyz5buZ98wilYII />
|
||||||
@ -348,7 +348,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-07 Fri 10:53</p>
|
<p class="date">Created: 2022-01-07 Fri 10:59</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>
|
||||||
|
@ -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-07 Fri 10:53 -->
|
<!-- 2022-01-07 Fri 10:59 -->
|
||||||
<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>Front end API</title>
|
<title>Front end API</title>
|
||||||
@ -333,131 +333,131 @@ 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="#orgb75964e">1. Coding conventions</a>
|
<li><a href="#org1f42dad">1. Coding conventions</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org57022ad">1.1. Memory allocation</a></li>
|
<li><a href="#org420d6c1">1.1. Memory allocation</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orge5ca173">2. Front end</a>
|
<li><a href="#orgcdf88c5">2. Front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org373cd14">2.1. Error handling</a>
|
<li><a href="#orgbd8029a">2.1. Error handling</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org6d1694b">2.1.1. Decoding errors</a>
|
<li><a href="#org6d2dd1c">2.1.1. Decoding errors</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgdbdcd7c">2.1.1.1. C source code</a></li>
|
<li><a href="#orgac101b8">2.1.1.1. C source code</a></li>
|
||||||
<li><a href="#org3f5662e">2.1.1.2. Fortran interface</a></li>
|
<li><a href="#orgf143850">2.1.1.2. Fortran interface</a></li>
|
||||||
<li><a href="#org7743dc7">2.1.1.3. Python interface</a></li>
|
<li><a href="#org0138108">2.1.1.3. Python interface</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgd8b4e03">2.2. Back ends</a>
|
<li><a href="#orgde370e3">2.2. Back ends</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org08629e4">2.2.1. C</a></li>
|
<li><a href="#org59064d4">2.2.1. C</a></li>
|
||||||
<li><a href="#orgbd0c47b">2.2.2. Fortran</a></li>
|
<li><a href="#orga6dd3b9">2.2.2. Fortran</a></li>
|
||||||
<li><a href="#orgd675b6a">2.2.3. Python</a></li>
|
<li><a href="#orgde9eaac">2.2.3. Python</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orga075197">2.3. Read/write behavior</a></li>
|
<li><a href="#org005582c">2.3. Read/write behavior</a></li>
|
||||||
<li><a href="#org3371f3a">2.4. TREXIO file type</a>
|
<li><a href="#org54159a7">2.4. TREXIO file type</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orga90461d">2.4.1. TREXIO<sub>File</sub> Python class</a></li>
|
<li><a href="#org5c2b930">2.4.1. TREXIO<sub>File</sub> Python class</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgd30d76b">2.5. Polymorphism of the file handle</a></li>
|
<li><a href="#org5f408da">2.5. Polymorphism of the file handle</a></li>
|
||||||
<li><a href="#orgc1aabd5">2.6. File opening</a>
|
<li><a href="#orgf2b055a">2.6. File opening</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgf331d27">2.6.1. C</a></li>
|
<li><a href="#org777a8c9">2.6.1. C</a></li>
|
||||||
<li><a href="#org1a929c2">2.6.2. Fortran</a></li>
|
<li><a href="#orga4e2136">2.6.2. Fortran</a></li>
|
||||||
<li><a href="#org3b71f96">2.6.3. Python</a></li>
|
<li><a href="#org17026c9">2.6.3. Python</a></li>
|
||||||
<li><a href="#orgae53ec0">2.6.4. Zero-based versus one-based arrays of indices</a></li>
|
<li><a href="#orgb6f8fa7">2.6.4. Zero-based versus one-based arrays of indices</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org0cfd889">2.7. File closing</a>
|
<li><a href="#org54fb930">2.7. File closing</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org5b98c5f">2.7.1. C</a></li>
|
<li><a href="#orgcfd2c85">2.7.1. C</a></li>
|
||||||
<li><a href="#org8ed02ea">2.7.2. Fortran</a></li>
|
<li><a href="#org33208a4">2.7.2. Fortran</a></li>
|
||||||
<li><a href="#orgec3d0d5">2.7.3. Python</a></li>
|
<li><a href="#orgeb04f63">2.7.3. Python</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org30db73a">3. Templates for front end</a>
|
<li><a href="#orgb6be22b">3. Templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org2e3ff4f">3.1. Description</a></li>
|
<li><a href="#orgb46c957">3.1. Description</a></li>
|
||||||
<li><a href="#org5aadf18">3.2. Templates for front end has/read/write a single numerical attribute</a>
|
<li><a href="#org18db8d1">3.2. Templates for front end has/read/write a single numerical attribute</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org0376ca9">3.2.1. Introduction</a></li>
|
<li><a href="#org93b71c6">3.2.1. Introduction</a></li>
|
||||||
<li><a href="#orge919859">3.2.2. C templates for front end</a>
|
<li><a href="#orgfa7f415">3.2.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgcf9b472">3.2.2.1. Function declarations</a></li>
|
<li><a href="#org4e07a06">3.2.2.1. Function declarations</a></li>
|
||||||
<li><a href="#org5fdbf23">3.2.2.2. Source code for double precision functions</a></li>
|
<li><a href="#org6539816">3.2.2.2. Source code for double precision functions</a></li>
|
||||||
<li><a href="#org04f0514">3.2.2.3. Source code for single precision functions</a></li>
|
<li><a href="#orga8ad191">3.2.2.3. Source code for single precision functions</a></li>
|
||||||
<li><a href="#org484800d">3.2.2.4. Source code for default functions</a></li>
|
<li><a href="#orga47df8b">3.2.2.4. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orge08b82d">3.2.3. Fortran templates for front end</a></li>
|
<li><a href="#orgc1008e0">3.2.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#orgdeb1b54">3.2.4. Python templates for front end</a></li>
|
<li><a href="#org734b154">3.2.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org00230fa">3.3. Templates for front end has/read/write a dataset of numerical data</a>
|
<li><a href="#org0607313">3.3. Templates for front end has/read/write a dataset of numerical data</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgf5b7869">3.3.1. Introduction</a></li>
|
<li><a href="#org24dff52">3.3.1. Introduction</a></li>
|
||||||
<li><a href="#org404f78f">3.3.2. C templates for front end</a>
|
<li><a href="#org233bbeb">3.3.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org183b9b4">3.3.2.1. Function declarations</a></li>
|
<li><a href="#org0a85166">3.3.2.1. Function declarations</a></li>
|
||||||
<li><a href="#orga0d21c7">3.3.2.2. Source code for double precision functions</a></li>
|
<li><a href="#orgc5b2327">3.3.2.2. Source code for double precision functions</a></li>
|
||||||
<li><a href="#orgcff6249">3.3.2.3. Source code for single precision functions</a></li>
|
<li><a href="#orgcd80c5c">3.3.2.3. Source code for single precision functions</a></li>
|
||||||
<li><a href="#org2a31815">3.3.2.4. Source code for memory-safe functions</a></li>
|
<li><a href="#org316ada3">3.3.2.4. Source code for memory-safe functions</a></li>
|
||||||
<li><a href="#orgd897ffb">3.3.2.5. Source code for default functions</a></li>
|
<li><a href="#org07ea3b3">3.3.2.5. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgce511ca">3.3.3. Fortran templates for front end</a></li>
|
<li><a href="#org3222f78">3.3.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#org71349c9">3.3.4. Python templates for front end</a></li>
|
<li><a href="#orgb733819">3.3.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgc27f54a">3.4. Templates for front end has/read/write a dataset of sparse data</a>
|
<li><a href="#org064c06b">3.4. Templates for front end has/read/write a dataset of sparse data</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org82a2a0a">3.4.1. Introduction</a></li>
|
<li><a href="#org1ea1e70">3.4.1. Introduction</a></li>
|
||||||
<li><a href="#orga5e0491">3.4.2. C templates for front end</a>
|
<li><a href="#orge3a9eec">3.4.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgfb36010">3.4.2.1. Function declarations</a></li>
|
<li><a href="#org518c6f8">3.4.2.1. Function declarations</a></li>
|
||||||
<li><a href="#org3be1fd3">3.4.2.2. Source code for default functions</a></li>
|
<li><a href="#orgd9ecf4a">3.4.2.2. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org7f7d017">3.4.3. Fortran templates for front end</a></li>
|
<li><a href="#org45e6cef">3.4.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#orgf292f51">3.4.4. Python templates for front end</a></li>
|
<li><a href="#orga7e7aa3">3.4.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org8842b7c">3.5. Templates for front end has/read/write a dataset of strings</a>
|
<li><a href="#orge55d6c1">3.5. Templates for front end has/read/write a dataset of strings</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgdacbea8">3.5.1. Introduction</a></li>
|
<li><a href="#orgb0ad180">3.5.1. Introduction</a></li>
|
||||||
<li><a href="#org517fc93">3.5.2. C templates for front end</a>
|
<li><a href="#org98d39aa">3.5.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org533a030">3.5.2.1. Function declarations</a></li>
|
<li><a href="#org37a0752">3.5.2.1. Function declarations</a></li>
|
||||||
<li><a href="#org5817668">3.5.2.2. Source code for default functions</a></li>
|
<li><a href="#orgdfe738e">3.5.2.2. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgfb69c85">3.5.3. Fortran templates for front end</a></li>
|
<li><a href="#org3ebd5f9">3.5.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#orgf6f390c">3.5.4. Python templates for front end</a></li>
|
<li><a href="#org19b4d9e">3.5.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org6f1abee">3.6. Templates for front end has/read/write a single string attribute</a>
|
<li><a href="#org825ed85">3.6. Templates for front end has/read/write a single string attribute</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgf62bf77">3.6.1. Introduction</a></li>
|
<li><a href="#org970347a">3.6.1. Introduction</a></li>
|
||||||
<li><a href="#orgf0ddb6d">3.6.2. C templates for front end</a>
|
<li><a href="#orgdd5cf69">3.6.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org5c87aba">3.6.2.1. Function declarations</a></li>
|
<li><a href="#org47b3e25">3.6.2.1. Function declarations</a></li>
|
||||||
<li><a href="#orgd1a22c0">3.6.2.2. Source code for default functions</a></li>
|
<li><a href="#org0acd87e">3.6.2.2. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org751acbb">3.6.3. Fortran templates for front end</a></li>
|
<li><a href="#org37e265f">3.6.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#orgffd7ba4">3.6.4. Python templates for front end</a></li>
|
<li><a href="#orgaf1b596">3.6.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org919a881">4. Fortran helper/wrapper functions</a></li>
|
<li><a href="#org24d66f7">4. Fortran helper/wrapper functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@ -465,8 +465,8 @@ for the JavaScript code in this tag.
|
|||||||
break;
|
break;
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div id="outline-container-orgb75964e" class="outline-2">
|
<div id="outline-container-org1f42dad" class="outline-2">
|
||||||
<h2 id="orgb75964e"><span class="section-number-2">1</span> Coding conventions</h2>
|
<h2 id="org1f42dad"><span class="section-number-2">1</span> Coding conventions</h2>
|
||||||
<div class="outline-text-2" id="text-1">
|
<div class="outline-text-2" id="text-1">
|
||||||
<ul class="org-ul">
|
<ul class="org-ul">
|
||||||
<li>integer types will be defined using types given in <code>stdint.h</code></li>
|
<li>integer types will be defined using types given in <code>stdint.h</code></li>
|
||||||
@ -481,8 +481,8 @@ break;
|
|||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org57022ad" class="outline-3">
|
<div id="outline-container-org420d6c1" class="outline-3">
|
||||||
<h3 id="org57022ad"><span class="section-number-3">1.1</span> Memory allocation</h3>
|
<h3 id="org420d6c1"><span class="section-number-3">1.1</span> Memory allocation</h3>
|
||||||
<div class="outline-text-3" id="text-1-1">
|
<div class="outline-text-3" id="text-1-1">
|
||||||
<p>
|
<p>
|
||||||
Memory allocation of structures can be facilitated by using the
|
Memory allocation of structures can be facilitated by using the
|
||||||
@ -517,8 +517,8 @@ The maximum string size for the filenames is 4096 characters.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orge5ca173" class="outline-2">
|
<div id="outline-container-orgcdf88c5" class="outline-2">
|
||||||
<h2 id="orge5ca173"><span class="section-number-2">2</span> Front end</h2>
|
<h2 id="orgcdf88c5"><span class="section-number-2">2</span> Front end</h2>
|
||||||
<div class="outline-text-2" id="text-2">
|
<div class="outline-text-2" id="text-2">
|
||||||
<p>
|
<p>
|
||||||
All calls to TREXIO are thread-safe.
|
All calls to TREXIO are thread-safe.
|
||||||
@ -526,10 +526,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org373cd14" class="outline-3">
|
<div id="outline-container-orgbd8029a" class="outline-3">
|
||||||
<h3 id="org373cd14"><span class="section-number-3">2.1</span> Error handling</h3>
|
<h3 id="orgbd8029a"><span class="section-number-3">2.1</span> Error handling</h3>
|
||||||
<div class="outline-text-3" id="text-2-1">
|
<div class="outline-text-3" id="text-2-1">
|
||||||
<table id="org1ec8768" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org7d31a40" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -770,8 +770,8 @@ and the corresponding message are not propagated to the source code.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org6d1694b" class="outline-4">
|
<div id="outline-container-org6d2dd1c" class="outline-4">
|
||||||
<h4 id="org6d1694b"><span class="section-number-4">2.1.1</span> Decoding errors</h4>
|
<h4 id="org6d2dd1c"><span class="section-number-4">2.1.1</span> Decoding errors</h4>
|
||||||
<div class="outline-text-4" id="text-2-1-1">
|
<div class="outline-text-4" id="text-2-1-1">
|
||||||
<p>
|
<p>
|
||||||
The <code>trexio_string_of_error</code> converts an exit code into a string. The
|
The <code>trexio_string_of_error</code> converts an exit code into a string. The
|
||||||
@ -797,8 +797,8 @@ and the corresponding message are not propagated to the source code.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgdbdcd7c" class="outline-5">
|
<div id="outline-container-orgac101b8" class="outline-5">
|
||||||
<h5 id="orgdbdcd7c"><span class="section-number-5">2.1.1.1</span> C source code</h5>
|
<h5 id="orgac101b8"><span class="section-number-5">2.1.1.1</span> C source code</h5>
|
||||||
<div class="outline-text-5" id="text-2-1-1-1">
|
<div class="outline-text-5" id="text-2-1-1-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>*
|
<pre class="src src-c"><span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>*
|
||||||
@ -909,8 +909,8 @@ and the corresponding message are not propagated to the source code.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3f5662e" class="outline-5">
|
<div id="outline-container-orgf143850" class="outline-5">
|
||||||
<h5 id="org3f5662e"><span class="section-number-5">2.1.1.2</span> Fortran interface</h5>
|
<h5 id="orgf143850"><span class="section-number-5">2.1.1.2</span> Fortran interface</h5>
|
||||||
<div class="outline-text-5" id="text-2-1-1-2">
|
<div class="outline-text-5" id="text-2-1-1-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
||||||
@ -926,8 +926,8 @@ and the corresponding message are not propagated to the source code.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org7743dc7" class="outline-5">
|
<div id="outline-container-org0138108" class="outline-5">
|
||||||
<h5 id="org7743dc7"><span class="section-number-5">2.1.1.3</span> Python interface</h5>
|
<h5 id="org0138108"><span class="section-number-5">2.1.1.3</span> Python interface</h5>
|
||||||
<div class="outline-text-5" id="text-2-1-1-3">
|
<div class="outline-text-5" id="text-2-1-1-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">class</span> <span style="color: #228b22;">Error</span>(<span style="color: #228b22;">Exception</span>):
|
<pre class="src src-python"><span style="color: #a020f0;">class</span> <span style="color: #228b22;">Error</span>(<span style="color: #228b22;">Exception</span>):
|
||||||
@ -966,8 +966,8 @@ and the corresponding message are not propagated to the source code.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd8b4e03" class="outline-3">
|
<div id="outline-container-orgde370e3" class="outline-3">
|
||||||
<h3 id="orgd8b4e03"><span class="section-number-3">2.2</span> Back ends</h3>
|
<h3 id="orgde370e3"><span class="section-number-3">2.2</span> Back ends</h3>
|
||||||
<div class="outline-text-3" id="text-2-2">
|
<div class="outline-text-3" id="text-2-2">
|
||||||
<p>
|
<p>
|
||||||
TREXIO has several back ends:
|
TREXIO has several back ends:
|
||||||
@ -991,8 +991,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org08629e4" class="outline-4">
|
<div id="outline-container-org59064d4" class="outline-4">
|
||||||
<h4 id="org08629e4"><span class="section-number-4">2.2.1</span> C</h4>
|
<h4 id="org59064d4"><span class="section-number-4">2.2.1</span> C</h4>
|
||||||
<div class="outline-text-4" id="text-2-2-1">
|
<div class="outline-text-4" id="text-2-2-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: #228b22;">int32_t</span> <span style="color: #228b22;">back_end_t</span>;
|
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">back_end_t</span>;
|
||||||
@ -1035,8 +1035,8 @@ This is useful due to the fact that HDF5 back end can be disabled at configure s
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgbd0c47b" class="outline-4">
|
<div id="outline-container-orga6dd3b9" class="outline-4">
|
||||||
<h4 id="orgbd0c47b"><span class="section-number-4">2.2.2</span> Fortran</h4>
|
<h4 id="orga6dd3b9"><span class="section-number-4">2.2.2</span> Fortran</h4>
|
||||||
<div class="outline-text-4" id="text-2-2-2">
|
<div class="outline-text-4" id="text-2-2-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-f90"> <span style="color: #228b22;">integer</span>(trexio_backend), <span style="color: #a020f0;">parameter</span> ::<span style="color: #a0522d;"> TREXIO_HDF5 = 0</span>
|
<pre class="src src-f90"> <span style="color: #228b22;">integer</span>(trexio_backend), <span style="color: #a020f0;">parameter</span> ::<span style="color: #a0522d;"> TREXIO_HDF5 = 0</span>
|
||||||
@ -1062,8 +1062,8 @@ The function below is a Fortran interface for the aforementioned C-compatible <c
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd675b6a" class="outline-4">
|
<div id="outline-container-orgde9eaac" class="outline-4">
|
||||||
<h4 id="orgd675b6a"><span class="section-number-4">2.2.3</span> Python</h4>
|
<h4 id="orgde9eaac"><span class="section-number-4">2.2.3</span> Python</h4>
|
||||||
<div class="outline-text-4" id="text-2-2-3">
|
<div class="outline-text-4" id="text-2-2-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"># <span style="color: #b22222;">define TREXIO back ends</span>
|
<pre class="src src-python"># <span style="color: #b22222;">define TREXIO back ends</span>
|
||||||
@ -1077,8 +1077,8 @@ The function below is a Fortran interface for the aforementioned C-compatible <c
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga075197" class="outline-3">
|
<div id="outline-container-org005582c" class="outline-3">
|
||||||
<h3 id="orga075197"><span class="section-number-3">2.3</span> Read/write behavior</h3>
|
<h3 id="org005582c"><span class="section-number-3">2.3</span> Read/write behavior</h3>
|
||||||
<div class="outline-text-3" id="text-2-3">
|
<div class="outline-text-3" id="text-2-3">
|
||||||
<p>
|
<p>
|
||||||
Every time a reading function is called, the data is read from the
|
Every time a reading function is called, the data is read from the
|
||||||
@ -1106,8 +1106,8 @@ concurrent programs, the behavior is not specified.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org3371f3a" class="outline-3">
|
<div id="outline-container-org54159a7" class="outline-3">
|
||||||
<h3 id="org3371f3a"><span class="section-number-3">2.4</span> TREXIO file type</h3>
|
<h3 id="org54159a7"><span class="section-number-3">2.4</span> TREXIO file type</h3>
|
||||||
<div class="outline-text-3" id="text-2-4">
|
<div class="outline-text-3" id="text-2-4">
|
||||||
<p>
|
<p>
|
||||||
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users
|
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users
|
||||||
@ -1130,19 +1130,19 @@ TREXIO files will have as a first argument the TREXIO file handle.
|
|||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_s</span> {
|
<pre class="src src-c"><span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_s</span> {
|
||||||
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">file_name</span>[TREXIO_MAX_FILENAME_LENGTH];
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">file_name</span>[TREXIO_MAX_FILENAME_LENGTH];
|
||||||
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">version</span>[16];
|
|
||||||
<span style="color: #228b22;">pthread_mutex_t</span> <span style="color: #a0522d;">thread_lock</span>;
|
<span style="color: #228b22;">pthread_mutex_t</span> <span style="color: #a0522d;">thread_lock</span>;
|
||||||
<span style="color: #228b22;">back_end_t</span> <span style="color: #a0522d;">back_end</span>;
|
<span style="color: #228b22;">back_end_t</span> <span style="color: #a0522d;">back_end</span>;
|
||||||
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">mode</span>;
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">mode</span>;
|
||||||
<span style="color: #228b22;">bool</span> <span style="color: #a0522d;">one_based</span>;
|
<span style="color: #228b22;">bool</span> <span style="color: #a0522d;">one_based</span>;
|
||||||
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">version</span>[16];
|
||||||
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">padding</span>[6]; /* <span style="color: #b22222;">Ensures the proper alignment of back ends </span>*/
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">padding</span>[6]; /* <span style="color: #b22222;">Ensures the proper alignment of back ends </span>*/
|
||||||
};
|
};
|
||||||
</pre>
|
</pre>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga90461d" class="outline-4">
|
<div id="outline-container-org5c2b930" class="outline-4">
|
||||||
<h4 id="orga90461d"><span class="section-number-4">2.4.1</span> TREXIO<sub>File</sub> Python class</h4>
|
<h4 id="org5c2b930"><span class="section-number-4">2.4.1</span> TREXIO<sub>File</sub> Python class</h4>
|
||||||
<div class="outline-text-4" id="text-2-4-1">
|
<div class="outline-text-4" id="text-2-4-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">class</span> <span style="color: #228b22;">File</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">class</span> <span style="color: #228b22;">File</span>:
|
||||||
@ -1215,8 +1215,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd30d76b" class="outline-3">
|
<div id="outline-container-org5f408da" class="outline-3">
|
||||||
<h3 id="orgd30d76b"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
|
<h3 id="org5f408da"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
|
||||||
<div class="outline-text-3" id="text-2-5">
|
<div class="outline-text-3" id="text-2-5">
|
||||||
<p>
|
<p>
|
||||||
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
|
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
|
||||||
@ -1235,8 +1235,8 @@ corresponding types for all back ends can be safely casted to
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgc1aabd5" class="outline-3">
|
<div id="outline-container-orgf2b055a" class="outline-3">
|
||||||
<h3 id="orgc1aabd5"><span class="section-number-3">2.6</span> File opening</h3>
|
<h3 id="orgf2b055a"><span class="section-number-3">2.6</span> File opening</h3>
|
||||||
<div class="outline-text-3" id="text-2-6">
|
<div class="outline-text-3" id="text-2-6">
|
||||||
<p>
|
<p>
|
||||||
<code>trexio_open</code> creates a new TREXIO file or opens existing one.
|
<code>trexio_open</code> creates a new TREXIO file or opens existing one.
|
||||||
@ -1275,8 +1275,8 @@ renaming the <code>.txt</code> data files.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgf331d27" class="outline-4">
|
<div id="outline-container-org777a8c9" class="outline-4">
|
||||||
<h4 id="orgf331d27"><span class="section-number-4">2.6.1</span> C</h4>
|
<h4 id="org777a8c9"><span class="section-number-4">2.6.1</span> C</h4>
|
||||||
<div class="outline-text-4" id="text-2-6-1">
|
<div class="outline-text-4" id="text-2-6-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_t</span>*
|
<pre class="src src-c"><span style="color: #228b22;">trexio_t</span>*
|
||||||
@ -1463,8 +1463,8 @@ renaming the <code>.txt</code> data files.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org1a929c2" class="outline-4">
|
<div id="outline-container-orga4e2136" class="outline-4">
|
||||||
<h4 id="org1a929c2"><span class="section-number-4">2.6.2</span> Fortran</h4>
|
<h4 id="orga4e2136"><span class="section-number-4">2.6.2</span> Fortran</h4>
|
||||||
<div class="outline-text-4" id="text-2-6-2">
|
<div class="outline-text-4" id="text-2-6-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
||||||
@ -1482,8 +1482,8 @@ renaming the <code>.txt</code> data files.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3b71f96" class="outline-4">
|
<div id="outline-container-org17026c9" class="outline-4">
|
||||||
<h4 id="org3b71f96"><span class="section-number-4">2.6.3</span> Python</h4>
|
<h4 id="org17026c9"><span class="section-number-4">2.6.3</span> Python</h4>
|
||||||
<div class="outline-text-4" id="text-2-6-3">
|
<div class="outline-text-4" id="text-2-6-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">open</span>(file_name: <span style="color: #483d8b;">str</span>, mode: <span style="color: #483d8b;">str</span>, back_end: <span style="color: #483d8b;">int</span>):
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">open</span>(file_name: <span style="color: #483d8b;">str</span>, mode: <span style="color: #483d8b;">str</span>, back_end: <span style="color: #483d8b;">int</span>):
|
||||||
@ -1531,8 +1531,8 @@ renaming the <code>.txt</code> data files.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgae53ec0" class="outline-4">
|
<div id="outline-container-orgb6f8fa7" class="outline-4">
|
||||||
<h4 id="orgae53ec0"><span class="section-number-4">2.6.4</span> Zero-based versus one-based arrays of indices</h4>
|
<h4 id="orgb6f8fa7"><span class="section-number-4">2.6.4</span> Zero-based versus one-based arrays of indices</h4>
|
||||||
<div class="outline-text-4" id="text-2-6-4">
|
<div class="outline-text-4" id="text-2-6-4">
|
||||||
<p>
|
<p>
|
||||||
Because arrays are zero-based in Fortran, we need to set a flag to
|
Because arrays are zero-based in Fortran, we need to set a flag to
|
||||||
@ -1565,8 +1565,8 @@ know if we need to shift by 1 arrays of indices.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org0cfd889" class="outline-3">
|
<div id="outline-container-org54fb930" class="outline-3">
|
||||||
<h3 id="org0cfd889"><span class="section-number-3">2.7</span> File closing</h3>
|
<h3 id="org54fb930"><span class="section-number-3">2.7</span> File closing</h3>
|
||||||
<div class="outline-text-3" id="text-2-7">
|
<div class="outline-text-3" id="text-2-7">
|
||||||
<p>
|
<p>
|
||||||
<code>trexio_close</code> closes an existing <code>trexio_t</code> file.
|
<code>trexio_close</code> closes an existing <code>trexio_t</code> file.
|
||||||
@ -1583,8 +1583,8 @@ output:
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org5b98c5f" class="outline-4">
|
<div id="outline-container-orgcfd2c85" class="outline-4">
|
||||||
<h4 id="org5b98c5f"><span class="section-number-4">2.7.1</span> C</h4>
|
<h4 id="orgcfd2c85"><span class="section-number-4">2.7.1</span> C</h4>
|
||||||
<div class="outline-text-4" id="text-2-7-1">
|
<div class="outline-text-4" id="text-2-7-1">
|
||||||
<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>
|
||||||
@ -1665,8 +1665,8 @@ output:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8ed02ea" class="outline-4">
|
<div id="outline-container-org33208a4" class="outline-4">
|
||||||
<h4 id="org8ed02ea"><span class="section-number-4">2.7.2</span> Fortran</h4>
|
<h4 id="org33208a4"><span class="section-number-4">2.7.2</span> Fortran</h4>
|
||||||
<div class="outline-text-4" id="text-2-7-2">
|
<div class="outline-text-4" id="text-2-7-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
||||||
@ -1680,8 +1680,8 @@ output:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgec3d0d5" class="outline-4">
|
<div id="outline-container-orgeb04f63" class="outline-4">
|
||||||
<h4 id="orgec3d0d5"><span class="section-number-4">2.7.3</span> Python</h4>
|
<h4 id="orgeb04f63"><span class="section-number-4">2.7.3</span> Python</h4>
|
||||||
<div class="outline-text-4" id="text-2-7-3">
|
<div class="outline-text-4" id="text-2-7-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">close</span>(trexio_file):
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">close</span>(trexio_file):
|
||||||
@ -1703,12 +1703,12 @@ output:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org30db73a" class="outline-2">
|
<div id="outline-container-orgb6be22b" class="outline-2">
|
||||||
<h2 id="org30db73a"><span class="section-number-2">3</span> Templates for front end</h2>
|
<h2 id="orgb6be22b"><span class="section-number-2">3</span> Templates for front end</h2>
|
||||||
<div class="outline-text-2" id="text-3">
|
<div class="outline-text-2" id="text-3">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org2e3ff4f" class="outline-3">
|
<div id="outline-container-orgb46c957" class="outline-3">
|
||||||
<h3 id="org2e3ff4f"><span class="section-number-3">3.1</span> Description</h3>
|
<h3 id="orgb46c957"><span class="section-number-3">3.1</span> Description</h3>
|
||||||
<div class="outline-text-3" id="text-3-1">
|
<div class="outline-text-3" id="text-3-1">
|
||||||
<p>
|
<p>
|
||||||
Consider the following block of <code>trex.json</code>:
|
Consider the following block of <code>trex.json</code>:
|
||||||
@ -1929,12 +1929,12 @@ value will result in <code>TREXIO_INVALID_ARG_2</code> exit code.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org5aadf18" class="outline-3">
|
<div id="outline-container-org18db8d1" class="outline-3">
|
||||||
<h3 id="org5aadf18"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single numerical attribute</h3>
|
<h3 id="org18db8d1"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single numerical attribute</h3>
|
||||||
<div class="outline-text-3" id="text-3-2">
|
<div class="outline-text-3" id="text-3-2">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org0376ca9" class="outline-4">
|
<div id="outline-container-org93b71c6" class="outline-4">
|
||||||
<h4 id="org0376ca9"><span class="section-number-4">3.2.1</span> Introduction</h4>
|
<h4 id="org93b71c6"><span class="section-number-4">3.2.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-2-1">
|
<div class="outline-text-4" id="text-3-2-1">
|
||||||
<p>
|
<p>
|
||||||
This section concerns API calls related to numerical attributes,
|
This section concerns API calls related to numerical attributes,
|
||||||
@ -2005,8 +2005,8 @@ namely single value of int/float types.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orge919859" class="outline-4">
|
<div id="outline-container-orgfa7f415" class="outline-4">
|
||||||
<h4 id="orge919859"><span class="section-number-4">3.2.2</span> C templates for front end</h4>
|
<h4 id="orgfa7f415"><span class="section-number-4">3.2.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-2-2">
|
<div class="outline-text-4" id="text-3-2-2">
|
||||||
<p>
|
<p>
|
||||||
The <code>C</code> templates that correspond to each of the abovementioned
|
The <code>C</code> templates that correspond to each of the abovementioned
|
||||||
@ -2020,12 +2020,12 @@ precision (see Table above).
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgcf9b472" class="outline-5">
|
<div id="outline-container-org4e07a06" class="outline-5">
|
||||||
<h5 id="orgcf9b472"><span class="section-number-5">3.2.2.1</span> Function declarations</h5>
|
<h5 id="org4e07a06"><span class="section-number-5">3.2.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org5fdbf23" class="outline-5">
|
<div id="outline-container-org6539816" class="outline-5">
|
||||||
<h5 id="org5fdbf23"><span class="section-number-5">3.2.2.2</span> Source code for double precision functions</h5>
|
<h5 id="org6539816"><span class="section-number-5">3.2.2.2</span> Source code for double precision functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-2-2-2">
|
<div class="outline-text-5" id="text-3-2-2-2">
|
||||||
<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>
|
||||||
@ -2088,8 +2088,8 @@ precision (see Table above).
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org04f0514" class="outline-5">
|
<div id="outline-container-orga8ad191" class="outline-5">
|
||||||
<h5 id="org04f0514"><span class="section-number-5">3.2.2.3</span> Source code for single precision functions</h5>
|
<h5 id="orga8ad191"><span class="section-number-5">3.2.2.3</span> Source code for single precision functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-2-2-3">
|
<div class="outline-text-5" id="text-3-2-2-3">
|
||||||
<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>
|
||||||
@ -2164,8 +2164,8 @@ precision (see Table above).
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org484800d" class="outline-5">
|
<div id="outline-container-orga47df8b" class="outline-5">
|
||||||
<h5 id="org484800d"><span class="section-number-5">3.2.2.4</span> Source code for default functions</h5>
|
<h5 id="orga47df8b"><span class="section-number-5">3.2.2.4</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-2-2-4">
|
<div class="outline-text-5" id="text-3-2-2-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>
|
||||||
@ -2220,8 +2220,8 @@ precision (see Table above).
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orge08b82d" class="outline-4">
|
<div id="outline-container-orgc1008e0" class="outline-4">
|
||||||
<h4 id="orge08b82d"><span class="section-number-4">3.2.3</span> Fortran templates for front end</h4>
|
<h4 id="orgc1008e0"><span class="section-number-4">3.2.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-2-3">
|
<div class="outline-text-4" id="text-3-2-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
||||||
@ -2306,8 +2306,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgdeb1b54" class="outline-4">
|
<div id="outline-container-org734b154" class="outline-4">
|
||||||
<h4 id="orgdeb1b54"><span class="section-number-4">3.2.4</span> Python templates for front end</h4>
|
<h4 id="org734b154"><span class="section-number-4">3.2.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-2-4">
|
<div class="outline-text-4" id="text-3-2-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_num$(trexio_file, num_w: $group_num_py_dtype$) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_num$(trexio_file, num_w: $group_num_py_dtype$) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -2392,12 +2392,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org00230fa" class="outline-3">
|
<div id="outline-container-org0607313" class="outline-3">
|
||||||
<h3 id="org00230fa"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
|
<h3 id="org0607313"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
|
||||||
<div class="outline-text-3" id="text-3-3">
|
<div class="outline-text-3" id="text-3-3">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orgf5b7869" class="outline-4">
|
<div id="outline-container-org24dff52" class="outline-4">
|
||||||
<h4 id="orgf5b7869"><span class="section-number-4">3.3.1</span> Introduction</h4>
|
<h4 id="org24dff52"><span class="section-number-4">3.3.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-3-1">
|
<div class="outline-text-4" id="text-3-3-1">
|
||||||
<p>
|
<p>
|
||||||
This section concerns API calls related to datasets.
|
This section concerns API calls related to datasets.
|
||||||
@ -2479,8 +2479,8 @@ This section concerns API calls related to datasets.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org404f78f" class="outline-4">
|
<div id="outline-container-org233bbeb" class="outline-4">
|
||||||
<h4 id="org404f78f"><span class="section-number-4">3.3.2</span> C templates for front end</h4>
|
<h4 id="org233bbeb"><span class="section-number-4">3.3.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-3-2">
|
<div class="outline-text-4" id="text-3-3-2">
|
||||||
<p>
|
<p>
|
||||||
The C templates that correspond to each of the abovementioned functions can be found below.
|
The C templates that correspond to each of the abovementioned functions can be found below.
|
||||||
@ -2491,12 +2491,12 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org183b9b4" class="outline-5">
|
<div id="outline-container-org0a85166" class="outline-5">
|
||||||
<h5 id="org183b9b4"><span class="section-number-5">3.3.2.1</span> Function declarations</h5>
|
<h5 id="org0a85166"><span class="section-number-5">3.3.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga0d21c7" class="outline-5">
|
<div id="outline-container-orgc5b2327" class="outline-5">
|
||||||
<h5 id="orga0d21c7"><span class="section-number-5">3.3.2.2</span> Source code for double precision functions</h5>
|
<h5 id="orgc5b2327"><span class="section-number-5">3.3.2.2</span> Source code for double precision functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-3-2-2">
|
<div class="outline-text-5" id="text-3-3-2-2">
|
||||||
<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>
|
||||||
@ -2659,8 +2659,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgcff6249" class="outline-5">
|
<div id="outline-container-orgcd80c5c" class="outline-5">
|
||||||
<h5 id="orgcff6249"><span class="section-number-5">3.3.2.3</span> Source code for single precision functions</h5>
|
<h5 id="orgcd80c5c"><span class="section-number-5">3.3.2.3</span> Source code for single precision functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-3-2-3">
|
<div class="outline-text-5" id="text-3-3-2-3">
|
||||||
<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>
|
||||||
@ -2811,11 +2811,11 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org2a31815" class="outline-5">
|
<div id="outline-container-org316ada3" class="outline-5">
|
||||||
<h5 id="org2a31815"><span class="section-number-5">3.3.2.4</span> Source code for memory-safe functions</h5>
|
<h5 id="org316ada3"><span class="section-number-5">3.3.2.4</span> Source code for memory-safe functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-3-2-4">
|
<div class="outline-text-5" id="text-3-3-2-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c" id="org7d65c91"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span>;
|
<pre class="src src-c" id="org4af7168"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span>;
|
||||||
int64_t $group_dset_dim$ = 0;
|
int64_t $group_dset_dim$ = 0;
|
||||||
|
|
||||||
/* <span style="color: #b22222;">Error handling for this call is added by the generator </span>*/
|
/* <span style="color: #b22222;">Error handling for this call is added by the generator </span>*/
|
||||||
@ -2971,8 +2971,8 @@ rc = trexio_read_$group_dset_dim$_64(file, &($group_dset_dim$));
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd897ffb" class="outline-5">
|
<div id="outline-container-org07ea3b3" class="outline-5">
|
||||||
<h5 id="orgd897ffb"><span class="section-number-5">3.3.2.5</span> Source code for default functions</h5>
|
<h5 id="org07ea3b3"><span class="section-number-5">3.3.2.5</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-3-2-5">
|
<div class="outline-text-5" id="text-3-3-2-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>
|
||||||
@ -3047,8 +3047,8 @@ rc = trexio_read_$group_dset_dim$_64(file, &($group_dset_dim$));
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgce511ca" class="outline-4">
|
<div id="outline-container-org3222f78" class="outline-4">
|
||||||
<h4 id="orgce511ca"><span class="section-number-4">3.3.3</span> Fortran templates for front end</h4>
|
<h4 id="org3222f78"><span class="section-number-4">3.3.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-3-3">
|
<div class="outline-text-4" id="text-3-3-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
||||||
@ -3133,8 +3133,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org71349c9" class="outline-4">
|
<div id="outline-container-orgb733819" class="outline-4">
|
||||||
<h4 id="org71349c9"><span class="section-number-4">3.3.4</span> Python templates for front end</h4>
|
<h4 id="orgb733819"><span class="section-number-4">3.3.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-3-4">
|
<div class="outline-text-4" id="text-3-3-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file, dset_w) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file, dset_w) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -3329,12 +3329,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgc27f54a" class="outline-3">
|
<div id="outline-container-org064c06b" class="outline-3">
|
||||||
<h3 id="orgc27f54a"><span class="section-number-3">3.4</span> Templates for front end has/read/write a dataset of sparse data</h3>
|
<h3 id="org064c06b"><span class="section-number-3">3.4</span> Templates for front end has/read/write a dataset of sparse data</h3>
|
||||||
<div class="outline-text-3" id="text-3-4">
|
<div class="outline-text-3" id="text-3-4">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org82a2a0a" class="outline-4">
|
<div id="outline-container-org1ea1e70" class="outline-4">
|
||||||
<h4 id="org82a2a0a"><span class="section-number-4">3.4.1</span> Introduction</h4>
|
<h4 id="org1ea1e70"><span class="section-number-4">3.4.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-4-1">
|
<div class="outline-text-4" id="text-3-4-1">
|
||||||
<p>
|
<p>
|
||||||
Sparse data structures are used typically for large tensors such as
|
Sparse data structures are used typically for large tensors such as
|
||||||
@ -3495,16 +3495,16 @@ This section concerns API calls related to sparse data structures.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga5e0491" class="outline-4">
|
<div id="outline-container-orge3a9eec" class="outline-4">
|
||||||
<h4 id="orga5e0491"><span class="section-number-4">3.4.2</span> C templates for front end</h4>
|
<h4 id="orge3a9eec"><span class="section-number-4">3.4.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-4-2">
|
<div class="outline-text-4" id="text-3-4-2">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orgfb36010" class="outline-5">
|
<div id="outline-container-org518c6f8" class="outline-5">
|
||||||
<h5 id="orgfb36010"><span class="section-number-5">3.4.2.1</span> Function declarations</h5>
|
<h5 id="org518c6f8"><span class="section-number-5">3.4.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3be1fd3" class="outline-5">
|
<div id="outline-container-orgd9ecf4a" class="outline-5">
|
||||||
<h5 id="org3be1fd3"><span class="section-number-5">3.4.2.2</span> Source code for default functions</h5>
|
<h5 id="orgd9ecf4a"><span class="section-number-5">3.4.2.2</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-4-2-2">
|
<div class="outline-text-5" id="text-3-4-2-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_read_safe_$group_dset$</span>(<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>,
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_read_safe_$group_dset$</span>(<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>,
|
||||||
@ -3779,8 +3779,8 @@ This section concerns API calls related to sparse data structures.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org7f7d017" class="outline-4">
|
<div id="outline-container-org45e6cef" class="outline-4">
|
||||||
<h4 id="org7f7d017"><span class="section-number-4">3.4.3</span> Fortran templates for front end</h4>
|
<h4 id="org45e6cef"><span class="section-number-4">3.4.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-4-3">
|
<div class="outline-text-4" id="text-3-4-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
||||||
@ -3875,8 +3875,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgf292f51" class="outline-4">
|
<div id="outline-container-orga7e7aa3" class="outline-4">
|
||||||
<h4 id="orgf292f51"><span class="section-number-4">3.4.4</span> Python templates for front end</h4>
|
<h4 id="orga7e7aa3"><span class="section-number-4">3.4.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-4-4">
|
<div class="outline-text-4" id="text-3-4-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file: File, offset_file: <span style="color: #483d8b;">int</span>, buffer_size: <span style="color: #483d8b;">int</span>, indices: <span style="color: #483d8b;">list</span>, values: <span style="color: #483d8b;">list</span>) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file: File, offset_file: <span style="color: #483d8b;">int</span>, buffer_size: <span style="color: #483d8b;">int</span>, indices: <span style="color: #483d8b;">list</span>, values: <span style="color: #483d8b;">list</span>) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -4097,12 +4097,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8842b7c" class="outline-3">
|
<div id="outline-container-orge55d6c1" class="outline-3">
|
||||||
<h3 id="org8842b7c"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
|
<h3 id="orge55d6c1"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
|
||||||
<div class="outline-text-3" id="text-3-5">
|
<div class="outline-text-3" id="text-3-5">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orgdacbea8" class="outline-4">
|
<div id="outline-container-orgb0ad180" class="outline-4">
|
||||||
<h4 id="orgdacbea8"><span class="section-number-4">3.5.1</span> Introduction</h4>
|
<h4 id="orgb0ad180"><span class="section-number-4">3.5.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-5-1">
|
<div class="outline-text-4" id="text-3-5-1">
|
||||||
<p>
|
<p>
|
||||||
This section concerns API calls related to datasets of strings.
|
This section concerns API calls related to datasets of strings.
|
||||||
@ -4142,8 +4142,8 @@ This section concerns API calls related to datasets of strings.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org517fc93" class="outline-4">
|
<div id="outline-container-org98d39aa" class="outline-4">
|
||||||
<h4 id="org517fc93"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
|
<h4 id="org98d39aa"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-5-2">
|
<div class="outline-text-4" id="text-3-5-2">
|
||||||
<p>
|
<p>
|
||||||
First parameter is the <code>TREXIO</code> file handle. Second parameter is the variable to be written/read
|
First parameter is the <code>TREXIO</code> file handle. Second parameter is the variable to be written/read
|
||||||
@ -4151,12 +4151,12 @@ to/from the <code>TREXIO</code> file (except for <code>trexio_has_</code> functi
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org533a030" class="outline-5">
|
<div id="outline-container-org37a0752" class="outline-5">
|
||||||
<h5 id="org533a030"><span class="section-number-5">3.5.2.1</span> Function declarations</h5>
|
<h5 id="org37a0752"><span class="section-number-5">3.5.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org5817668" class="outline-5">
|
<div id="outline-container-orgdfe738e" class="outline-5">
|
||||||
<h5 id="org5817668"><span class="section-number-5">3.5.2.2</span> Source code for default functions</h5>
|
<h5 id="orgdfe738e"><span class="section-number-5">3.5.2.2</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-5-2-2">
|
<div class="outline-text-5" id="text-3-5-2-2">
|
||||||
<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>
|
||||||
@ -4406,8 +4406,8 @@ to/from the <code>TREXIO</code> file (except for <code>trexio_has_</code> functi
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgfb69c85" class="outline-4">
|
<div id="outline-container-org3ebd5f9" class="outline-4">
|
||||||
<h4 id="orgfb69c85"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
|
<h4 id="org3ebd5f9"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-5-3">
|
<div class="outline-text-4" id="text-3-5-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
||||||
@ -4503,8 +4503,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgf6f390c" class="outline-4">
|
<div id="outline-container-org19b4d9e" class="outline-4">
|
||||||
<h4 id="orgf6f390c"><span class="section-number-4">3.5.4</span> Python templates for front end</h4>
|
<h4 id="org19b4d9e"><span class="section-number-4">3.5.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-5-4">
|
<div class="outline-text-4" id="text-3-5-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file, dset_w: <span style="color: #483d8b;">list</span>) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file, dset_w: <span style="color: #483d8b;">list</span>) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -4620,12 +4620,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org6f1abee" class="outline-3">
|
<div id="outline-container-org825ed85" class="outline-3">
|
||||||
<h3 id="org6f1abee"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
|
<h3 id="org825ed85"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
|
||||||
<div class="outline-text-3" id="text-3-6">
|
<div class="outline-text-3" id="text-3-6">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orgf62bf77" class="outline-4">
|
<div id="outline-container-org970347a" class="outline-4">
|
||||||
<h4 id="orgf62bf77"><span class="section-number-4">3.6.1</span> Introduction</h4>
|
<h4 id="org970347a"><span class="section-number-4">3.6.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-6-1">
|
<div class="outline-text-4" id="text-3-6-1">
|
||||||
<p>
|
<p>
|
||||||
This section concerns API calls related to string attributes.
|
This section concerns API calls related to string attributes.
|
||||||
@ -4665,16 +4665,16 @@ This section concerns API calls related to string attributes.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgf0ddb6d" class="outline-4">
|
<div id="outline-container-orgdd5cf69" class="outline-4">
|
||||||
<h4 id="orgf0ddb6d"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
|
<h4 id="orgdd5cf69"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-6-2">
|
<div class="outline-text-4" id="text-3-6-2">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org5c87aba" class="outline-5">
|
<div id="outline-container-org47b3e25" class="outline-5">
|
||||||
<h5 id="org5c87aba"><span class="section-number-5">3.6.2.1</span> Function declarations</h5>
|
<h5 id="org47b3e25"><span class="section-number-5">3.6.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd1a22c0" class="outline-5">
|
<div id="outline-container-org0acd87e" class="outline-5">
|
||||||
<h5 id="orgd1a22c0"><span class="section-number-5">3.6.2.2</span> Source code for default functions</h5>
|
<h5 id="org0acd87e"><span class="section-number-5">3.6.2.2</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-6-2-2">
|
<div class="outline-text-5" id="text-3-6-2-2">
|
||||||
<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>
|
||||||
@ -4778,8 +4778,8 @@ This section concerns API calls related to string attributes.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org751acbb" class="outline-4">
|
<div id="outline-container-org37e265f" class="outline-4">
|
||||||
<h4 id="org751acbb"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
|
<h4 id="org37e265f"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-6-3">
|
<div class="outline-text-4" id="text-3-6-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
||||||
@ -4856,8 +4856,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgffd7ba4" class="outline-4">
|
<div id="outline-container-orgaf1b596" class="outline-4">
|
||||||
<h4 id="orgffd7ba4"><span class="section-number-4">3.6.4</span> Python templates for front end</h4>
|
<h4 id="orgaf1b596"><span class="section-number-4">3.6.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-6-4">
|
<div class="outline-text-4" id="text-3-6-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_str$(trexio_file, str_w: <span style="color: #483d8b;">str</span>) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_str$(trexio_file, str_w: <span style="color: #483d8b;">str</span>) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -4947,8 +4947,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org919a881" class="outline-2">
|
<div id="outline-container-org24d66f7" class="outline-2">
|
||||||
<h2 id="org919a881"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
|
<h2 id="org24d66f7"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
|
||||||
<div class="outline-text-2" id="text-4">
|
<div class="outline-text-2" id="text-4">
|
||||||
<p>
|
<p>
|
||||||
The function below adapts the original C-based <code>trexio_open</code> for Fortran.
|
The function below adapts the original C-based <code>trexio_open</code> for Fortran.
|
||||||
@ -5083,7 +5083,7 @@ two code are identical, i.e. if the <code>assert</code> statement pass.
|
|||||||
</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-07 Fri 10:53</p>
|
<p class="date">Created: 2022-01-07 Fri 10:59</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>
|
||||||
|
@ -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-07 Fri 10:53 -->
|
<!-- 2022-01-07 Fri 10:59 -->
|
||||||
<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="#org8e2f866">1. HDF5 back end</a>
|
<li><a href="#orgf242665">1. HDF5 back end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org532c95f">1.1. Template for HDF5 definitions</a></li>
|
<li><a href="#orgf3a8f26">1.1. Template for HDF5 definitions</a></li>
|
||||||
<li><a href="#org70f47f1">1.2. Template for HDF5 structures</a></li>
|
<li><a href="#org99c7e01">1.2. Template for HDF5 structures</a></li>
|
||||||
<li><a href="#orged6aa4c">1.3. Template for HDF5 init/deinit</a></li>
|
<li><a href="#orgd062364">1.3. Template for HDF5 init/deinit</a></li>
|
||||||
<li><a href="#org7b87d5e">1.4. Template for HDF5 has/read/write the numerical attribute</a></li>
|
<li><a href="#orgb54ff12">1.4. Template for HDF5 has/read/write the numerical attribute</a></li>
|
||||||
<li><a href="#orge577605">1.5. Template for HDF5 has/read/write the dataset of numerical data</a></li>
|
<li><a href="#org3ca7f3f">1.5. Template for HDF5 has/read/write the dataset of numerical data</a></li>
|
||||||
<li><a href="#org7e002e8">1.6. Template for HDF5 has/read/write the dataset of sparse data</a></li>
|
<li><a href="#orgf806735">1.6. Template for HDF5 has/read/write the dataset of sparse data</a></li>
|
||||||
<li><a href="#org60ed488">1.7. Template for HDF5 has/read/write the dataset of strings</a></li>
|
<li><a href="#org417a188">1.7. Template for HDF5 has/read/write the dataset of strings</a></li>
|
||||||
<li><a href="#org6902462">1.8. Template for HDF5 has/read/write the string attribute</a></li>
|
<li><a href="#org8a689b8">1.8. Template for HDF5 has/read/write the string attribute</a></li>
|
||||||
<li><a href="#orgd22a052">1.9. Helper functions</a></li>
|
<li><a href="#orge07d0c5">1.9. Helper functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8e2f866" class="outline-2">
|
<div id="outline-container-orgf242665" class="outline-2">
|
||||||
<h2 id="org8e2f866"><span class="section-number-2">1</span> HDF5 back end</h2>
|
<h2 id="orgf242665"><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-org532c95f" class="outline-3">
|
<div id="outline-container-orgf3a8f26" class="outline-3">
|
||||||
<h3 id="org532c95f"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
|
<h3 id="orgf3a8f26"><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-org70f47f1" class="outline-3">
|
<div id="outline-container-org99c7e01" class="outline-3">
|
||||||
<h3 id="org70f47f1"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
|
<h3 id="org99c7e01"><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> {
|
||||||
@ -360,8 +360,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
<div id="outline-container-orged6aa4c" class="outline-3">
|
<div id="outline-container-orgd062364" class="outline-3">
|
||||||
<h3 id="orged6aa4c"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
|
<h3 id="orgd062364"><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">
|
<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>
|
||||||
@ -441,8 +441,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org7b87d5e" class="outline-3">
|
<div id="outline-container-orgb54ff12" class="outline-3">
|
||||||
<h3 id="org7b87d5e"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write the numerical attribute</h3>
|
<h3 id="orgb54ff12"><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 +536,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orge577605" class="outline-3">
|
<div id="outline-container-org3ca7f3f" class="outline-3">
|
||||||
<h3 id="orge577605"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write the dataset of numerical data</h3>
|
<h3 id="org3ca7f3f"><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 +659,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org7e002e8" class="outline-3">
|
<div id="outline-container-orgf806735" class="outline-3">
|
||||||
<h3 id="org7e002e8"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write the dataset of sparse data</h3>
|
<h3 id="orgf806735"><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 +861,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-org60ed488" class="outline-3">
|
<div id="outline-container-org417a188" class="outline-3">
|
||||||
<h3 id="org60ed488"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write the dataset of strings</h3>
|
<h3 id="org417a188"><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 +1066,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-org6902462" class="outline-3">
|
<div id="outline-container-org8a689b8" class="outline-3">
|
||||||
<h3 id="org6902462"><span class="section-number-3">1.8</span> Template for HDF5 has/read/write the string attribute</h3>
|
<h3 id="org8a689b8"><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 +1189,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-orgd22a052" class="outline-3">
|
<div id="outline-container-orge07d0c5" class="outline-3">
|
||||||
<h3 id="orgd22a052"><span class="section-number-3">1.9</span> Helper functions</h3>
|
<h3 id="orge07d0c5"><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 +1452,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-07 Fri 10:53</p>
|
<p class="date">Created: 2022-01-07 Fri 10:59</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>
|
||||||
|
@ -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-07 Fri 10:53 -->
|
<!-- 2022-01-07 Fri 10:59 -->
|
||||||
<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="#org6f052bf">1. TEXT back end</a>
|
<li><a href="#org287b0ac">1. TEXT back end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org50d71cb">1.1. Template for group-related structures in text back end</a></li>
|
<li><a href="#orgb24e387">1.1. Template for group-related structures in text back end</a></li>
|
||||||
<li><a href="#org66715c9">1.2. Template for general structure in text back end</a></li>
|
<li><a href="#orge21f21d">1.2. Template for general structure in text back end</a></li>
|
||||||
<li><a href="#org84d3c98">1.3. Initialize function (constant part)</a></li>
|
<li><a href="#org18324dc">1.3. Initialize function (constant part)</a></li>
|
||||||
<li><a href="#org4aeb0b6">1.4. Deinitialize function (templated part)</a></li>
|
<li><a href="#orgde9aab1">1.4. Deinitialize function (templated part)</a></li>
|
||||||
<li><a href="#org2944414">1.5. Template for text read struct</a></li>
|
<li><a href="#orgebffde6">1.5. Template for text read struct</a></li>
|
||||||
<li><a href="#org9c81592">1.6. Template for text flush struct</a></li>
|
<li><a href="#org05071a1">1.6. Template for text flush struct</a></li>
|
||||||
<li><a href="#orge6cd222">1.7. Template for text free memory</a></li>
|
<li><a href="#orge20fc67">1.7. Template for text free memory</a></li>
|
||||||
<li><a href="#orgbb218ac">1.8. Template for has/read/write the numerical attribute</a></li>
|
<li><a href="#orgbf54103">1.8. Template for has/read/write the numerical attribute</a></li>
|
||||||
<li><a href="#orga8f1f60">1.9. Template for has/read/write the dataset of numerical data</a></li>
|
<li><a href="#org4f25518">1.9. Template for has/read/write the dataset of numerical data</a></li>
|
||||||
<li><a href="#org2257a75">1.10. Template for has/read/write the dataset of strings</a></li>
|
<li><a href="#org9cec2d8">1.10. Template for has/read/write the dataset of strings</a></li>
|
||||||
<li><a href="#org77680c7">1.11. Template for has/read/write the string attribute</a></li>
|
<li><a href="#orgfcbe287">1.11. Template for has/read/write the string attribute</a></li>
|
||||||
<li><a href="#orgf6fd2c1">1.12. Template for has/read/write the dataset of sparse data</a></li>
|
<li><a href="#org792ab8d">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-org6f052bf" class="outline-2">
|
<div id="outline-container-org287b0ac" class="outline-2">
|
||||||
<h2 id="org6f052bf"><span class="section-number-2">1</span> TEXT back end</h2>
|
<h2 id="org287b0ac"><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-org50d71cb" class="outline-3">
|
<div id="outline-container-orgb24e387" class="outline-3">
|
||||||
<h3 id="org50d71cb"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
|
<h3 id="orgb24e387"><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-org66715c9" class="outline-3">
|
<div id="outline-container-orge21f21d" class="outline-3">
|
||||||
<h3 id="org66715c9"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
|
<h3 id="orge21f21d"><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,8 +387,8 @@ The file is written when closed, or when the flush function is called.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org84d3c98" class="outline-3">
|
<div id="outline-container-org18324dc" class="outline-3">
|
||||||
<h3 id="org84d3c98"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
|
<h3 id="org18324dc"><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">
|
<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>
|
||||||
@ -519,8 +519,8 @@ The file is written when closed, or when the flush function is called.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org4aeb0b6" class="outline-3">
|
<div id="outline-container-orgde9aab1" class="outline-3">
|
||||||
<h3 id="org4aeb0b6"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
|
<h3 id="orgde9aab1"><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 +542,8 @@ The file is written when closed, or when the flush function is called.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org2944414" class="outline-3">
|
<div id="outline-container-orgebffde6" class="outline-3">
|
||||||
<h3 id="org2944414"><span class="section-number-3">1.5</span> Template for text read struct</h3>
|
<h3 id="orgebffde6"><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 +835,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org9c81592" class="outline-3">
|
<div id="outline-container-org05071a1" class="outline-3">
|
||||||
<h3 id="org9c81592"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
|
<h3 id="org05071a1"><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 +901,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orge6cd222" class="outline-3">
|
<div id="outline-container-orge20fc67" class="outline-3">
|
||||||
<h3 id="orge6cd222"><span class="section-number-3">1.7</span> Template for text free memory</h3>
|
<h3 id="orge20fc67"><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 +947,8 @@ Memory is allocated when reading. The following function frees memory.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgbb218ac" class="outline-3">
|
<div id="outline-container-orgbf54103" class="outline-3">
|
||||||
<h3 id="orgbb218ac"><span class="section-number-3">1.8</span> Template for has/read/write the numerical attribute</h3>
|
<h3 id="orgbf54103"><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 +1011,8 @@ Memory is allocated when reading. The following function frees memory.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga8f1f60" class="outline-3">
|
<div id="outline-container-org4f25518" class="outline-3">
|
||||||
<h3 id="orga8f1f60"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
|
<h3 id="org4f25518"><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 +1108,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org2257a75" class="outline-3">
|
<div id="outline-container-org9cec2d8" class="outline-3">
|
||||||
<h3 id="org2257a75"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
|
<h3 id="org9cec2d8"><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 +1210,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org77680c7" class="outline-3">
|
<div id="outline-container-orgfcbe287" class="outline-3">
|
||||||
<h3 id="org77680c7"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
|
<h3 id="orgfcbe287"><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 +1285,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orgf6fd2c1" class="outline-3">
|
<div id="outline-container-org792ab8d" class="outline-3">
|
||||||
<h3 id="orgf6fd2c1"><span class="section-number-3">1.12</span> Template for has/read/write the dataset of sparse data</h3>
|
<h3 id="org792ab8d"><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 +1563,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-07 Fri 10:53</p>
|
<p class="date">Created: 2022-01-07 Fri 10:59</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
116
trex.html
@ -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-07 Fri 10:53 -->
|
<!-- 2022-01-07 Fri 10:59 -->
|
||||||
<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="#org8bb565f">1. Metadata (metadata group)</a></li>
|
<li><a href="#orgd278ce2">1. Metadata (metadata group)</a></li>
|
||||||
<li><a href="#org2489f18">2. Electron (electron group)</a></li>
|
<li><a href="#org02743e6">2. Electron (electron group)</a></li>
|
||||||
<li><a href="#org8a1f5d4">3. Nucleus (nucleus group)</a></li>
|
<li><a href="#org87cbfe4">3. Nucleus (nucleus group)</a></li>
|
||||||
<li><a href="#orgc2ed4b5">4. Effective core potentials (ecp group)</a>
|
<li><a href="#org87d6028">4. Effective core potentials (ecp group)</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgae67bd7">4.1. Example</a></li>
|
<li><a href="#orge6db4dc">4.1. Example</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org86b6d8d">5. Basis set (basis group)</a>
|
<li><a href="#org72068da">5. Basis set (basis group)</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org22d1e8e">5.1. Example</a></li>
|
<li><a href="#org85dc101">5.1. Example</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgbef8b8f">6. Atomic orbitals (ao group)</a>
|
<li><a href="#orgfdeed0d">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="#orgd7a87c6">7. Molecular orbitals (mo group)</a>
|
<li><a href="#orgfd1ea84">7. Molecular orbitals (mo group)</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgb55fd46">7.1. One-electron integrals (<code>mo_1e_int</code> group)</a></li>
|
<li><a href="#org17cfba1">7.1. One-electron integrals (<code>mo_1e_int</code> group)</a></li>
|
||||||
<li><a href="#org49d6e1a">7.2. Two-electron integrals (<code>mo_2e_int</code> group)</a></li>
|
<li><a href="#orgdcb35b7">7.2. Two-electron integrals (<code>mo_2e_int</code> group)</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgd7c4653">8. <span class="todo TODO">TODO</span> Slater determinants</a></li>
|
<li><a href="#org3f2ac8a">8. <span class="todo TODO">TODO</span> Slater determinants</a></li>
|
||||||
<li><a href="#org5c16049">9. Reduced density matrices (rdm group)</a></li>
|
<li><a href="#org9cb4e81">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-org8bb565f" class="outline-2">
|
<div id="outline-container-orgd278ce2" class="outline-2">
|
||||||
<h2 id="org8bb565f"><span class="section-number-2">1</span> Metadata (metadata group)</h2>
|
<h2 id="orgd278ce2"><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="orgd757d7a" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orgf90192e" 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-org2489f18" class="outline-2">
|
<div id="outline-container-org02743e6" class="outline-2">
|
||||||
<h2 id="org2489f18"><span class="section-number-2">2</span> Electron (electron group)</h2>
|
<h2 id="org02743e6"><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 ↑ and ↓ electrons is fixed.
|
the number of ↑ and ↓ electrons is fixed.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="org837f96f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org92bf4bd" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -534,15 +534,15 @@ the number of ↑ and ↓ electrons is fixed.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8a1f5d4" class="outline-2">
|
<div id="outline-container-org87cbfe4" class="outline-2">
|
||||||
<h2 id="org8a1f5d4"><span class="section-number-2">3</span> Nucleus (nucleus group)</h2>
|
<h2 id="org87cbfe4"><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="orgaac6217" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org8b64ec4" 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-orgc2ed4b5" class="outline-2">
|
<div id="outline-container-org87d6028" class="outline-2">
|
||||||
<h2 id="orgc2ed4b5"><span class="section-number-2">4</span> Effective core potentials (ecp group)</h2>
|
<h2 id="org87d6028"><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="org2958310" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orged9a1ab" 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-orgae67bd7" class="outline-3">
|
<div id="outline-container-orge6db4dc" class="outline-3">
|
||||||
<h3 id="orgae67bd7"><span class="section-number-3">4.1</span> Example</h3>
|
<h3 id="orge6db4dc"><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-org86b6d8d" class="outline-2">
|
<div id="outline-container-org72068da" class="outline-2">
|
||||||
<h2 id="org86b6d8d"><span class="section-number-2">5</span> Basis set (basis group)</h2>
|
<h2 id="org72068da"><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="org8c4abda" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org2440c5f" 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-org22d1e8e" class="outline-3">
|
<div id="outline-container-org85dc101" class="outline-3">
|
||||||
<h3 id="org22d1e8e"><span class="section-number-3">5.1</span> Example</h3>
|
<h3 id="org85dc101"><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-orgbef8b8f" class="outline-2">
|
<div id="outline-container-orgfdeed0d" class="outline-2">
|
||||||
<h2 id="orgbef8b8f"><span class="section-number-2">6</span> Atomic orbitals (ao group)</h2>
|
<h2 id="orgfdeed0d"><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
|
||||||
@ -1081,13 +1081,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="#org86b6d8d">Basis set</a> section) to \(\mathcal{N}_{z^2}\), which is the
|
the <a href="#org72068da">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="org9f1eb96" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org0bffd8a" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1139,8 +1139,8 @@ introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\).
|
|||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org39f81ea" class="outline-3">
|
<div id="outline-container-orgc74c03d" class="outline-3">
|
||||||
<h3 id="ao_one_e"><a id="org39f81ea"></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="orgc74c03d"></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}}
|
||||||
@ -1158,7 +1158,7 @@ The one-electron integrals for a one-electron operator \(\hat{O}\) are
|
|||||||
over atomic orbitals.
|
over atomic orbitals.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="orgc16daeb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org1d7335e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1225,8 +1225,8 @@ over atomic orbitals.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org0b812d2" class="outline-3">
|
<div id="outline-container-orged0a7a2" class="outline-3">
|
||||||
<h3 id="ao_two_e"><a id="org0b812d2"></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="orged0a7a2"></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
|
||||||
@ -1247,7 +1247,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="org6629eac" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org04c4be4" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1287,10 +1287,10 @@ notation.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd7a87c6" class="outline-2">
|
<div id="outline-container-orgfd1ea84" class="outline-2">
|
||||||
<h2 id="orgd7a87c6"><span class="section-number-2">7</span> Molecular orbitals (mo group)</h2>
|
<h2 id="orgfd1ea84"><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="org0598085" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org3c6a587" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1356,8 +1356,8 @@ notation.
|
|||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgb55fd46" class="outline-3">
|
<div id="outline-container-org17cfba1" class="outline-3">
|
||||||
<h3 id="orgb55fd46"><span class="section-number-3">7.1</span> One-electron integrals (<code>mo_1e_int</code> group)</h3>
|
<h3 id="org17cfba1"><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
|
||||||
@ -1365,7 +1365,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="org97f3862" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org1106156" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1432,8 +1432,8 @@ the basis of molecular orbitals.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org49d6e1a" class="outline-3">
|
<div id="outline-container-orgdcb35b7" class="outline-3">
|
||||||
<h3 id="org49d6e1a"><span class="section-number-3">7.2</span> Two-electron integrals (<code>mo_2e_int</code> group)</h3>
|
<h3 id="orgdcb35b7"><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
|
||||||
@ -1441,7 +1441,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="orgfaa7f33" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org4353bbc" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1481,13 +1481,13 @@ the basis of molecular orbitals.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd7c4653" class="outline-2">
|
<div id="outline-container-org3f2ac8a" class="outline-2">
|
||||||
<h2 id="orgd7c4653"><span class="section-number-2">8</span> <span class="todo TODO">TODO</span> Slater determinants</h2>
|
<h2 id="org3f2ac8a"><span class="section-number-2">8</span> <span class="todo TODO">TODO</span> Slater determinants</h2>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org5c16049" class="outline-2">
|
<div id="outline-container-org9cb4e81" class="outline-2">
|
||||||
<h2 id="org5c16049"><span class="section-number-2">9</span> Reduced density matrices (rdm group)</h2>
|
<h2 id="org9cb4e81"><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">
|
||||||
<table id="orgb2760e3" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orga27b399" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1563,7 +1563,7 @@ the basis of molecular orbitals.
|
|||||||
</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-07 Fri 10:53</p>
|
<p class="date">Created: 2022-01-07 Fri 10:59</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>
|
||||||
|
Loading…
Reference in New Issue
Block a user