1
0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-12-25 13:53:55 +01:00

Deploying to gh-pages from @ TREX-CoE/trexio@3a4e737630 🚀

This commit is contained in:
q-posev 2021-06-23 15:06:22 +00:00
parent d741d19a5d
commit 0699807d0c
7 changed files with 240 additions and 240 deletions

View File

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

View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-22 Tue 20:32 -->
<!-- 2021-06-23 Wed 15:06 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>&lrm;</title>
@ -232,8 +232,8 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org669d292">1. Text back end</a></li>
<li><a href="#org6e3b15f">2. HDF5 Back end</a></li>
<li><a href="#orga7989e2">1. Text back end</a></li>
<li><a href="#org31bbd41">2. HDF5 Back end</a></li>
</ul>
</div>
</div>
@ -241,8 +241,8 @@ for the JavaScript code in this tag.
See templator<sub>front.org</sub>
</p>
<div id="outline-container-org669d292" class="outline-2">
<h2 id="org669d292"><span class="section-number-2">1</span> Text back end</h2>
<div id="outline-container-orga7989e2" class="outline-2">
<h2 id="orga7989e2"><span class="section-number-2">1</span> Text back end</h2>
<div class="outline-text-2" id="text-1">
<p>
As the size of the dataset should be extensible, the simplest
@ -256,8 +256,8 @@ The offset can be used with <code>fseek(69L*offset, SEEK_SET)</code>
</div>
</div>
<div id="outline-container-org6e3b15f" class="outline-2">
<h2 id="org6e3b15f"><span class="section-number-2">2</span> HDF5 Back end</h2>
<div id="outline-container-org31bbd41" class="outline-2">
<h2 id="org31bbd41"><span class="section-number-2">2</span> HDF5 Back end</h2>
<div class="outline-text-2" id="text-2">
<p>
We need to declare the number of rows of the dataset as
@ -278,7 +278,7 @@ If the offset+num &gt; nmax, we need to extend the dataset.
</div>
</div>
<div id="postamble" class="status">
<p class="date">Created: 2021-06-22 Tue 20:32</p>
<p class="date">Created: 2021-06-23 Wed 15:06</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

View File

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

View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-22 Tue 20:32 -->
<!-- 2021-06-23 Wed 15:06 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Front end API</title>
@ -333,61 +333,61 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org8666d98">1. Coding conventions</a>
<li><a href="#org4ba59f6">1. Coding conventions</a>
<ul>
<li><a href="#orge6c2bb4">1.1. Memory allocation</a></li>
<li><a href="#org3a2483f">1.1. Memory allocation</a></li>
</ul>
</li>
<li><a href="#org9257f5e">2. Front end</a>
<li><a href="#orgb36effe">2. Front end</a>
<ul>
<li><a href="#org4fbe34f">2.1. Error handling</a></li>
<li><a href="#org93f2d92">2.2. Back ends</a></li>
<li><a href="#org771d809">2.3. Read/write behavior</a></li>
<li><a href="#orgc16ca33">2.4. TREXIO file type</a></li>
<li><a href="#org00a6f6c">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org4a11d39">2.6. File opening</a></li>
<li><a href="#org7fa48e9">2.7. File closing</a></li>
<li><a href="#org1092c9f">2.1. Error handling</a></li>
<li><a href="#org2894365">2.2. Back ends</a></li>
<li><a href="#org78b0199">2.3. Read/write behavior</a></li>
<li><a href="#org11bebb5">2.4. TREXIO file type</a></li>
<li><a href="#orgc335ac6">2.5. Polymorphism of the file handle</a></li>
<li><a href="#orgb9d6cc8">2.6. File opening</a></li>
<li><a href="#orgcb9b827">2.7. File closing</a></li>
</ul>
</li>
<li><a href="#org9e9ceb0">3. Templates for front end</a>
<li><a href="#org526f884">3. Templates for front end</a>
<ul>
<li><a href="#orgb355e46">3.1. Description</a></li>
<li><a href="#org1e00480">3.2. Templates for front end has/read/write a single dimensioning variable</a>
<li><a href="#org4542d05">3.1. Description</a></li>
<li><a href="#orgb4276e2">3.2. Templates for front end has/read/write a single dimensioning variable</a>
<ul>
<li><a href="#orgfb31c9c">3.2.1. C templates for front end</a></li>
<li><a href="#orgb372859">3.2.2. Fortran templates for front end</a></li>
<li><a href="#orge59b033">3.2.1. C templates for front end</a></li>
<li><a href="#orgbcabf6b">3.2.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#orgde36d9e">3.3. Templates for front end has/read/write a dataset of numerical data</a>
<li><a href="#orgbbafe52">3.3. Templates for front end has/read/write a dataset of numerical data</a>
<ul>
<li><a href="#org58f704b">3.3.1. C templates for front end</a></li>
<li><a href="#org454e011">3.3.2. Fortran templates for front end</a></li>
<li><a href="#org05016c0">3.3.1. C templates for front end</a></li>
<li><a href="#org2fb6840">3.3.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#orga3691f4">3.4. Sparse data structures</a></li>
<li><a href="#orgabdfca4">3.5. Templates for front end has/read/write a dataset of strings</a>
<li><a href="#org8f8d7ff">3.4. Sparse data structures</a></li>
<li><a href="#org7ebf3df">3.5. Templates for front end has/read/write a dataset of strings</a>
<ul>
<li><a href="#org88aadc3">3.5.1. Introduction</a></li>
<li><a href="#orga58341a">3.5.2. C templates for front end</a></li>
<li><a href="#org0210dc2">3.5.3. Fortran templates for front end</a></li>
<li><a href="#org52665b1">3.5.1. Introduction</a></li>
<li><a href="#org1b9fc56">3.5.2. C templates for front end</a></li>
<li><a href="#org3ed7538">3.5.3. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org1113730">3.6. Templates for front end has/read/write a single string attribute</a>
<li><a href="#org3db11da">3.6. Templates for front end has/read/write a single string attribute</a>
<ul>
<li><a href="#org00c55c0">3.6.1. Introduction</a></li>
<li><a href="#orgb00afa8">3.6.2. C templates for front end</a></li>
<li><a href="#org6cf2f25">3.6.3. Fortran templates for front end</a></li>
<li><a href="#org67c2f6a">3.6.1. Introduction</a></li>
<li><a href="#org447d1c1">3.6.2. C templates for front end</a></li>
<li><a href="#org890b66d">3.6.3. Fortran templates for front end</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org945ebd6">4. Fortran helper/wrapper functions</a></li>
<li><a href="#org0500bfe">4. Fortran helper/wrapper functions</a></li>
</ul>
</div>
</div>
<div id="outline-container-org8666d98" class="outline-2">
<h2 id="org8666d98"><span class="section-number-2">1</span> Coding conventions</h2>
<div id="outline-container-org4ba59f6" class="outline-2">
<h2 id="org4ba59f6"><span class="section-number-2">1</span> Coding conventions</h2>
<div class="outline-text-2" id="text-1">
<ul class="org-ul">
<li>integer types will be defined using types given in <code>stdint.h</code></li>
@ -402,8 +402,8 @@ for the JavaScript code in this tag.
</ul>
</div>
<div id="outline-container-orge6c2bb4" class="outline-3">
<h3 id="orge6c2bb4"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div id="outline-container-org3a2483f" class="outline-3">
<h3 id="org3a2483f"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Memory allocation of structures can be facilitated by using the
@ -438,8 +438,8 @@ The maximum string size for the filenames is 4096 characters.
</div>
</div>
<div id="outline-container-org9257f5e" class="outline-2">
<h2 id="org9257f5e"><span class="section-number-2">2</span> Front end</h2>
<div id="outline-container-orgb36effe" class="outline-2">
<h2 id="orgb36effe"><span class="section-number-2">2</span> Front end</h2>
<div class="outline-text-2" id="text-2">
<p>
All calls to TREXIO are thread-safe.
@ -447,10 +447,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
</p>
</div>
<div id="outline-container-org4fbe34f" class="outline-3">
<h3 id="org4fbe34f"><span class="section-number-3">2.1</span> Error handling</h3>
<div id="outline-container-org1092c9f" class="outline-3">
<h3 id="org1092c9f"><span class="section-number-3">2.1</span> Error handling</h3>
<div class="outline-text-3" id="text-2-1">
<table id="orgf5c43a6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgbbf948f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -750,8 +750,8 @@ The text strings are extracted from the previous table.
</div>
</div>
<div id="outline-container-org93f2d92" class="outline-3">
<h3 id="org93f2d92"><span class="section-number-3">2.2</span> Back ends</h3>
<div id="outline-container-org2894365" class="outline-3">
<h3 id="org2894365"><span class="section-number-3">2.2</span> Back ends</h3>
<div class="outline-text-3" id="text-2-2">
<p>
TREXIO has several back ends:
@ -783,8 +783,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div>
</div>
</div>
<div id="outline-container-org771d809" class="outline-3">
<h3 id="org771d809"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div id="outline-container-org78b0199" class="outline-3">
<h3 id="org78b0199"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div class="outline-text-3" id="text-2-3">
<p>
Every time a reading function is called, the data is read from the
@ -812,8 +812,8 @@ concurrent programs, the behavior is not specified.
</p>
</div>
</div>
<div id="outline-container-orgc16ca33" class="outline-3">
<h3 id="orgc16ca33"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div id="outline-container-org11bebb5" class="outline-3">
<h3 id="org11bebb5"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div class="outline-text-3" id="text-2-4">
<p>
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users
@ -846,8 +846,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div>
</div>
</div>
<div id="outline-container-org00a6f6c" class="outline-3">
<h3 id="org00a6f6c"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div id="outline-container-orgc335ac6" class="outline-3">
<h3 id="orgc335ac6"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div class="outline-text-3" id="text-2-5">
<p>
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
@ -866,8 +866,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org4a11d39" class="outline-3">
<h3 id="org4a11d39"><span class="section-number-3">2.6</span> File opening</h3>
<div id="outline-container-orgb9d6cc8" class="outline-3">
<h3 id="orgb9d6cc8"><span class="section-number-3">2.6</span> File opening</h3>
<div class="outline-text-3" id="text-2-6">
<p>
<code>trexio_open</code> creates a new TREXIO file or opens existing one.
@ -1058,8 +1058,8 @@ know if we need to shift by 1 arrays of indices.
</div>
</div>
<div id="outline-container-org7fa48e9" class="outline-3">
<h3 id="org7fa48e9"><span class="section-number-3">2.7</span> File closing</h3>
<div id="outline-container-orgcb9b827" class="outline-3">
<h3 id="orgcb9b827"><span class="section-number-3">2.7</span> File closing</h3>
<div class="outline-text-3" id="text-2-7">
<p>
<code>trexio_close</code> closes an existing <code>trexio_t</code> file.
@ -1155,12 +1155,12 @@ output:
</div>
</div>
<div id="outline-container-org9e9ceb0" class="outline-2">
<h2 id="org9e9ceb0"><span class="section-number-2">3</span> Templates for front end</h2>
<div id="outline-container-org526f884" class="outline-2">
<h2 id="org526f884"><span class="section-number-2">3</span> Templates for front end</h2>
<div class="outline-text-2" id="text-3">
</div>
<div id="outline-container-orgb355e46" class="outline-3">
<h3 id="orgb355e46"><span class="section-number-3">3.1</span> Description</h3>
<div id="outline-container-org4542d05" class="outline-3">
<h3 id="org4542d05"><span class="section-number-3">3.1</span> Description</h3>
<div class="outline-text-3" id="text-3-1">
<p>
Consider the following block of <code>trex.json</code>:
@ -1350,8 +1350,8 @@ or double precision for integer and floating point numbers.
</div>
</div>
<div id="outline-container-org1e00480" class="outline-3">
<h3 id="org1e00480"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single dimensioning variable</h3>
<div id="outline-container-orgb4276e2" class="outline-3">
<h3 id="orgb4276e2"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single dimensioning variable</h3>
<div class="outline-text-3" id="text-3-2">
<p>
This section concerns API calls related to dimensioning variables.
@ -1420,8 +1420,8 @@ This section concerns API calls related to dimensioning variables.
</table>
</div>
<div id="outline-container-orgfb31c9c" class="outline-4">
<h4 id="orgfb31c9c"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div id="outline-container-orge59b033" class="outline-4">
<h4 id="orge59b033"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-2-1">
<p>
The <code>C</code> templates that correspond to each of the abovementioned
@ -1610,8 +1610,8 @@ precision (see Table above).
</div>
</div>
<div id="outline-container-orgb372859" class="outline-4">
<h4 id="orgb372859"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div id="outline-container-orgbcabf6b" class="outline-4">
<h4 id="orgbcabf6b"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-2-2">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
@ -1697,8 +1697,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-orgde36d9e" class="outline-3">
<h3 id="orgde36d9e"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
<div id="outline-container-orgbbafe52" class="outline-3">
<h3 id="orgbbafe52"><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">
<p>
This section concerns API calls related to datasets.
@ -1767,8 +1767,8 @@ This section concerns API calls related to datasets.
</table>
</div>
<div id="outline-container-org58f704b" class="outline-4">
<h4 id="org58f704b"><span class="section-number-4">3.3.1</span> C templates for front end</h4>
<div id="outline-container-org05016c0" class="outline-4">
<h4 id="org05016c0"><span class="section-number-4">3.3.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-3-1">
<p>
The C templates that correspond to each of the abovementioned functions can be found below.
@ -2087,8 +2087,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div>
</div>
<div id="outline-container-org454e011" class="outline-4">
<h4 id="org454e011"><span class="section-number-4">3.3.2</span> Fortran templates for front end</h4>
<div id="outline-container-org2fb6840" class="outline-4">
<h4 id="org2fb6840"><span class="section-number-4">3.3.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-3-2">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -2174,8 +2174,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-orga3691f4" class="outline-3">
<h3 id="orga3691f4"><span class="section-number-3">3.4</span> Sparse data structures</h3>
<div id="outline-container-org8f8d7ff" class="outline-3">
<h3 id="org8f8d7ff"><span class="section-number-3">3.4</span> Sparse data structures</h3>
<div class="outline-text-3" id="text-3-4">
<p>
Sparse data structures are used typically for large tensors such as
@ -2316,12 +2316,12 @@ For the values,
</div>
</div>
<div id="outline-container-orgabdfca4" class="outline-3">
<h3 id="orgabdfca4"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
<div id="outline-container-org7ebf3df" class="outline-3">
<h3 id="org7ebf3df"><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>
<div id="outline-container-org88aadc3" class="outline-4">
<h4 id="org88aadc3"><span class="section-number-4">3.5.1</span> Introduction</h4>
<div id="outline-container-org52665b1" class="outline-4">
<h4 id="org52665b1"><span class="section-number-4">3.5.1</span> Introduction</h4>
<div class="outline-text-4" id="text-3-5-1">
<p>
This section concerns API calls related to datasets of strings.
@ -2361,8 +2361,8 @@ This section concerns API calls related to datasets of strings.
</div>
</div>
<div id="outline-container-orga58341a" class="outline-4">
<h4 id="orga58341a"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
<div id="outline-container-org1b9fc56" class="outline-4">
<h4 id="org1b9fc56"><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">
<p>
First parameter is the <code>TREXIO</code> file handle. Second parameter is the variable to be written/read
@ -2605,8 +2605,8 @@ to/from the <code>TREXIO</code> file (except for <code>trexio_has_</code> functi
</div>
</div>
<div id="outline-container-org0210dc2" class="outline-4">
<h4 id="org0210dc2"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
<div id="outline-container-org3ed7538" class="outline-4">
<h4 id="org3ed7538"><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">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -2703,12 +2703,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org1113730" class="outline-3">
<h3 id="org1113730"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
<div id="outline-container-org3db11da" class="outline-3">
<h3 id="org3db11da"><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>
<div id="outline-container-org00c55c0" class="outline-4">
<h4 id="org00c55c0"><span class="section-number-4">3.6.1</span> Introduction</h4>
<div id="outline-container-org67c2f6a" class="outline-4">
<h4 id="org67c2f6a"><span class="section-number-4">3.6.1</span> Introduction</h4>
<div class="outline-text-4" id="text-3-6-1">
<p>
This section concerns API calls related to string attributes.
@ -2748,8 +2748,8 @@ This section concerns API calls related to string attributes.
</div>
</div>
<div id="outline-container-orgb00afa8" class="outline-4">
<h4 id="orgb00afa8"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
<div id="outline-container-org447d1c1" class="outline-4">
<h4 id="org447d1c1"><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="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -2849,8 +2849,8 @@ This section concerns API calls related to string attributes.
</div>
</div>
<div id="outline-container-org6cf2f25" class="outline-4">
<h4 id="org6cf2f25"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
<div id="outline-container-org890b66d" class="outline-4">
<h4 id="org890b66d"><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">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
@ -2929,8 +2929,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org945ebd6" class="outline-2">
<h2 id="org945ebd6"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div id="outline-container-org0500bfe" class="outline-2">
<h2 id="org0500bfe"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div class="outline-text-2" id="text-4">
<p>
The function below adapts the original C-based <code>trexio_open</code> for Fortran.
@ -3064,7 +3064,7 @@ two code are identical, i.e. if the <code>assert</code> statement pass.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-22 Tue 20:32</p>
<p class="date">Created: 2021-06-23 Wed 15:06</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-22 Tue 20:32 -->
<!-- 2021-06-23 Wed 15:06 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HDF5 back end</title>
@ -311,27 +311,27 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgaed42d9">1. HDF5 back end</a>
<li><a href="#orgfd87900">1. HDF5 back end</a>
<ul>
<li><a href="#orga63cd3e">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org77867da">1.2. Template for HDF5 structures</a></li>
<li><a href="#org595f8f6">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org158ffac">1.4. Template for HDF5 has/read/write a single dimensioning variable</a></li>
<li><a href="#orga702a5a">1.5. Template for HDF5 has/read/write a dataset of numerical data</a></li>
<li><a href="#org45c67c1">1.6. Template for HDF5 has/read/write a dataset of strings</a></li>
<li><a href="#orgd1d2c79">1.7. Template for HDF5 has/read/write a single string attribute</a></li>
<li><a href="#org24d8fd8">1.1. Template for HDF5 definitions</a></li>
<li><a href="#orgb85053e">1.2. Template for HDF5 structures</a></li>
<li><a href="#org03637f4">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org3302909">1.4. Template for HDF5 has/read/write a single dimensioning variable</a></li>
<li><a href="#org20cce53">1.5. Template for HDF5 has/read/write a dataset of numerical data</a></li>
<li><a href="#org994bd9b">1.6. Template for HDF5 has/read/write a dataset of strings</a></li>
<li><a href="#org50eafa0">1.7. Template for HDF5 has/read/write a single string attribute</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgaed42d9" class="outline-2">
<h2 id="orgaed42d9"><span class="section-number-2">1</span> HDF5 back end</h2>
<div id="outline-container-orgfd87900" class="outline-2">
<h2 id="orgfd87900"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-orga63cd3e" class="outline-3">
<h3 id="orga63cd3e"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div id="outline-container-org24d8fd8" class="outline-3">
<h3 id="org24d8fd8"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div class="outline-text-3" id="text-1-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#define</span> $GROUP$_GROUP_NAME <span style="color: #8b2252;">"$group$"</span>
@ -343,8 +343,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org77867da" class="outline-3">
<h3 id="org77867da"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div id="outline-container-orgb85053e" class="outline-3">
<h3 id="orgb85053e"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div class="outline-text-3" id="text-1-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_hdf5_s</span> {
@ -359,8 +359,8 @@ for the JavaScript code in this tag.
</div>
<div id="outline-container-org595f8f6" class="outline-3">
<h3 id="org595f8f6"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div id="outline-container-org03637f4" class="outline-3">
<h3 id="org03637f4"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div class="outline-text-3" id="text-1-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -440,8 +440,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org158ffac" class="outline-3">
<h3 id="org158ffac"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a single dimensioning variable</h3>
<div id="outline-container-org3302909" class="outline-3">
<h3 id="org3302909"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a single dimensioning variable</h3>
<div class="outline-text-3" id="text-1-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -557,8 +557,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orga702a5a" class="outline-3">
<h3 id="orga702a5a"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset of numerical data</h3>
<div id="outline-container-org20cce53" class="outline-3">
<h3 id="org20cce53"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset of numerical data</h3>
<div class="outline-text-3" id="text-1-5">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -687,8 +687,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org45c67c1" class="outline-3">
<h3 id="org45c67c1"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write a dataset of strings</h3>
<div id="outline-container-org994bd9b" class="outline-3">
<h3 id="org994bd9b"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write a dataset of strings</h3>
<div class="outline-text-3" id="text-1-6">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -892,8 +892,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orgd1d2c79" class="outline-3">
<h3 id="orgd1d2c79"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write a single string attribute</h3>
<div id="outline-container-org50eafa0" class="outline-3">
<h3 id="org50eafa0"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write a single string attribute</h3>
<div class="outline-text-3" id="text-1-7">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1020,7 +1020,7 @@ for the JavaScript code in this tag.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-22 Tue 20:32</p>
<p class="date">Created: 2021-06-23 Wed 15:06</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-22 Tue 20:32 -->
<!-- 2021-06-23 Wed 15:06 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TEXT back end</title>
@ -311,26 +311,26 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org67d8a15">1. TEXT back end</a>
<li><a href="#org0420ddb">1. TEXT back end</a>
<ul>
<li><a href="#orgc4e0e70">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgc4ca588">1.2. Template for general structure in text back end</a></li>
<li><a href="#org04d06cb">1.3. Initialize function (constant part)</a></li>
<li><a href="#org26d0e21">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#orge9141ef">1.5. Template for text read struct</a></li>
<li><a href="#orga04f98c">1.6. Template for text flush struct</a></li>
<li><a href="#org4b0a49c">1.7. Template for text free memory</a></li>
<li><a href="#orga9f8b7e">1.8. Template for has/read/write the num attribute</a></li>
<li><a href="#org42adf76">1.9. Template for has/read/write the dataset of numerical data</a></li>
<li><a href="#org210c59d">1.10. Template for has/read/write the dataset of strings</a></li>
<li><a href="#org7933579">1.11. Template for has/read/write the string attribute</a></li>
<li><a href="#org85cb9f0">1.12. RDM struct (hard-coded)</a>
<li><a href="#org034b94e">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org9b282a4">1.2. Template for general structure in text back end</a></li>
<li><a href="#org2cdfb4b">1.3. Initialize function (constant part)</a></li>
<li><a href="#org3a5475b">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org4c2e88d">1.5. Template for text read struct</a></li>
<li><a href="#orgf808296">1.6. Template for text flush struct</a></li>
<li><a href="#org1a39ae7">1.7. Template for text free memory</a></li>
<li><a href="#org23d3583">1.8. Template for has/read/write the num attribute</a></li>
<li><a href="#orga3e5a70">1.9. Template for has/read/write the dataset of numerical data</a></li>
<li><a href="#org4eba068">1.10. Template for has/read/write the dataset of strings</a></li>
<li><a href="#orgf2e02be">1.11. Template for has/read/write the string attribute</a></li>
<li><a href="#org3694ef2">1.12. RDM struct (hard-coded)</a>
<ul>
<li><a href="#orgcc5ce1b">1.12.1. Read the complete struct</a></li>
<li><a href="#org5a08975">1.12.2. Flush the complete struct</a></li>
<li><a href="#org8fa2a37">1.12.3. Free memory</a></li>
<li><a href="#orgde85e26">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#orge642eda">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
<li><a href="#org9270217">1.12.1. Read the complete struct</a></li>
<li><a href="#org14943f1">1.12.2. Flush the complete struct</a></li>
<li><a href="#org1d765a3">1.12.3. Free memory</a></li>
<li><a href="#orgb98b7bc">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org84e9ae9">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
</ul>
</li>
</ul>
@ -339,8 +339,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org67d8a15" class="outline-2">
<h2 id="org67d8a15"><span class="section-number-2">1</span> TEXT back end</h2>
<div id="outline-container-org0420ddb" class="outline-2">
<h2 id="org0420ddb"><span class="section-number-2">1</span> TEXT back end</h2>
<div class="outline-text-2" id="text-1">
<p>
The "file" produced by the text back end is a directory with one
@ -361,8 +361,8 @@ The file is written when closed, or when the flush function is called.
</p>
</div>
<div id="outline-container-orgc4e0e70" class="outline-3">
<h3 id="orgc4e0e70"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div id="outline-container-org034b94e" class="outline-3">
<h3 id="org034b94e"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div class="outline-text-3" id="text-1-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s {
@ -380,8 +380,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-orgc4ca588" class="outline-3">
<h3 id="orgc4ca588"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div id="outline-container-org9b282a4" class="outline-3">
<h3 id="org9b282a4"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div class="outline-text-3" id="text-1-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">rdm_s</span> {
@ -407,8 +407,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org04d06cb" class="outline-3">
<h3 id="org04d06cb"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div id="outline-container-org2cdfb4b" class="outline-3">
<h3 id="org2cdfb4b"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div class="outline-text-3" id="text-1-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -509,8 +509,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org26d0e21" class="outline-3">
<h3 id="org26d0e21"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div id="outline-container-org3a5475b" class="outline-3">
<h3 id="org3a5475b"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div class="outline-text-3" id="text-1-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -535,8 +535,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-orge9141ef" class="outline-3">
<h3 id="orge9141ef"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div id="outline-container-org4c2e88d" class="outline-3">
<h3 id="org4c2e88d"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div class="outline-text-3" id="text-1-5">
<div class="org-src-container">
<pre class="src src-c">$group$_t*
@ -807,8 +807,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-orga04f98c" class="outline-3">
<h3 id="orga04f98c"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div id="outline-container-orgf808296" class="outline-3">
<h3 id="orgf808296"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div class="outline-text-3" id="text-1-6">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -872,8 +872,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-org4b0a49c" class="outline-3">
<h3 id="org4b0a49c"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div id="outline-container-org1a39ae7" class="outline-3">
<h3 id="org1a39ae7"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div class="outline-text-3" id="text-1-7">
<p>
Memory is allocated when reading. The following function frees memory.
@ -918,8 +918,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-orga9f8b7e" class="outline-3">
<h3 id="orga9f8b7e"><span class="section-number-3">1.8</span> Template for has/read/write the num attribute</h3>
<div id="outline-container-org23d3583" class="outline-3">
<h3 id="org23d3583"><span class="section-number-3">1.8</span> Template for has/read/write the num attribute</h3>
<div class="outline-text-3" id="text-1-8">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -981,8 +981,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org42adf76" class="outline-3">
<h3 id="org42adf76"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
<div id="outline-container-orga3e5a70" class="outline-3">
<h3 id="orga3e5a70"><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">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -1078,8 +1078,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-org210c59d" class="outline-3">
<h3 id="org210c59d"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
<div id="outline-container-org4eba068" class="outline-3">
<h3 id="org4eba068"><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">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -1181,8 +1181,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-org7933579" class="outline-3">
<h3 id="org7933579"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
<div id="outline-container-orgf2e02be" class="outline-3">
<h3 id="orgf2e02be"><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="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1256,12 +1256,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-org85cb9f0" class="outline-3">
<h3 id="org85cb9f0"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
<div id="outline-container-org3694ef2" class="outline-3">
<h3 id="org3694ef2"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
<div class="outline-text-3" id="text-1-12">
</div>
<div id="outline-container-orgcc5ce1b" class="outline-4">
<h4 id="orgcc5ce1b"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
<div id="outline-container-org9270217" class="outline-4">
<h4 id="org9270217"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
<div class="outline-text-4" id="text-1-12-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">rdm_t</span>* <span style="color: #0000ff;">trexio_text_read_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
@ -1356,8 +1356,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org5a08975" class="outline-4">
<h4 id="org5a08975"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
<div id="outline-container-org14943f1" class="outline-4">
<h4 id="org14943f1"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
<div class="outline-text-4" id="text-1-12-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_flush_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
@ -1399,8 +1399,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org8fa2a37" class="outline-4">
<h4 id="org8fa2a37"><span class="section-number-4">1.12.3</span> Free memory</h4>
<div id="outline-container-org1d765a3" class="outline-4">
<h4 id="org1d765a3"><span class="section-number-4">1.12.3</span> Free memory</h4>
<div class="outline-text-4" id="text-1-12-3">
<p>
Memory is allocated when reading. The followig function frees memory.
@ -1436,8 +1436,8 @@ Memory is allocated when reading. The followig function frees memory.
</div>
</div>
<div id="outline-container-orgde85e26" class="outline-4">
<h4 id="orgde85e26"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div id="outline-container-orgb98b7bc" class="outline-4">
<h4 id="orgb98b7bc"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-12-4">
<p>
The <code>one_e</code> array is assumed allocated with the appropriate size.
@ -1503,8 +1503,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div>
</div>
<div id="outline-container-orge642eda" class="outline-4">
<h4 id="orge642eda"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div id="outline-container-org84e9ae9" class="outline-4">
<h4 id="org84e9ae9"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-12-5">
<p>
<code>two_e</code> is a sparse data structure, which can be too large to fit
@ -1612,7 +1612,7 @@ file for each sparse float structure.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-22 Tue 20:32</p>
<p class="date">Created: 2021-06-23 Wed 15:06</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

118
trex.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-22 Tue 20:32 -->
<!-- 2021-06-23 Wed 15:06 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREX Configuration file</title>
@ -333,28 +333,28 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgc08a996">1. Metadata</a></li>
<li><a href="#orgfc6802e">2. Electron</a></li>
<li><a href="#org89ad5cd">3. Nucleus</a></li>
<li><a href="#orgb4ac0b7">4. <span class="todo TODO">TODO</span> Effective core potentials</a></li>
<li><a href="#org86016e6">5. Basis set</a></li>
<li><a href="#org96b16b7">6. Atomic orbitals</a>
<li><a href="#orgc69aba8">1. Metadata</a></li>
<li><a href="#orge9c220d">2. Electron</a></li>
<li><a href="#org7fdd5bd">3. Nucleus</a></li>
<li><a href="#org07bb9e9">4. <span class="todo TODO">TODO</span> Effective core potentials</a></li>
<li><a href="#org5acfaf2">5. Basis set</a></li>
<li><a href="#org4e48793">6. Atomic orbitals</a>
<ul>
<li><a href="#ao_one_e">6.1. One-electron integrals</a></li>
<li><a href="#ao_two_e">6.2. Two-electron integrals</a></li>
</ul>
</li>
<li><a href="#org2f3ed38">7. Molecular orbitals</a>
<li><a href="#org28b0480">7. Molecular orbitals</a>
<ul>
<li><a href="#org72bc6af">7.1. One-electron integrals</a></li>
<li><a href="#orgd1fde5a">7.2. Two-electron integrals</a></li>
<li><a href="#org6b0f44b">7.1. One-electron integrals</a></li>
<li><a href="#org2483cde">7.2. Two-electron integrals</a></li>
</ul>
</li>
<li><a href="#org22ac68f">8. <span class="todo TODO">TODO</span> Slater determinants</a></li>
<li><a href="#org177ee41">9. <span class="todo TODO">TODO</span> Reduced density matrices</a></li>
<li><a href="#orgbbdb680">10. Appendix</a>
<li><a href="#org61147f9">8. <span class="todo TODO">TODO</span> Slater determinants</a></li>
<li><a href="#orgdeae482">9. <span class="todo TODO">TODO</span> Reduced density matrices</a></li>
<li><a href="#orgfa07ec8">10. Appendix</a>
<ul>
<li><a href="#orgca98b95">10.1. Python script from table to json</a></li>
<li><a href="#orgc6fdc80">10.1. Python script from table to json</a></li>
</ul>
</li>
</ul>
@ -379,8 +379,8 @@ arrays are 0-base. Hence, we introduce the <code>index</code> type which is an
</pre>
</div>
<div id="outline-container-orgc08a996" class="outline-2">
<h2 id="orgc08a996"><span class="section-number-2">1</span> Metadata</h2>
<div id="outline-container-orgc69aba8" class="outline-2">
<h2 id="orgc69aba8"><span class="section-number-2">1</span> Metadata</h2>
<div class="outline-text-2" id="text-1">
<p>
As we expect our files to be archived in open-data repositories, we
@ -390,7 +390,7 @@ which have participated to the creation of the file, a list of
authors of the file, and a textual description.
</p>
<table id="orgee436b4" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgab02808" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -442,15 +442,15 @@ authors of the file, and a textual description.
</div>
</div>
<div id="outline-container-orgfc6802e" class="outline-2">
<h2 id="orgfc6802e"><span class="section-number-2">2</span> Electron</h2>
<div id="outline-container-orge9c220d" class="outline-2">
<h2 id="orge9c220d"><span class="section-number-2">2</span> Electron</h2>
<div class="outline-text-2" id="text-2">
<p>
We consider wave functions expressed in the spin-free formalism, where
the number of &uarr; and &darr; electrons is fixed.
</p>
<table id="orgee69920" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orge16efd9" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -481,15 +481,15 @@ the number of &uarr; and &darr; electrons is fixed.
</div>
</div>
<div id="outline-container-org89ad5cd" class="outline-2">
<h2 id="org89ad5cd"><span class="section-number-2">3</span> Nucleus</h2>
<div id="outline-container-org7fdd5bd" class="outline-2">
<h2 id="org7fdd5bd"><span class="section-number-2">3</span> Nucleus</h2>
<div class="outline-text-2" id="text-3">
<p>
The nuclei are considered as fixed point charges. Coordinates are
given in Cartesian \((x,y,z)\) format.
</p>
<table id="org9732f69" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org03dd9c1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -541,8 +541,8 @@ given in Cartesian \((x,y,z)\) format.
</div>
</div>
<div id="outline-container-orgb4ac0b7" class="outline-2">
<h2 id="orgb4ac0b7"><span class="section-number-2">4</span> <span class="todo TODO">TODO</span> Effective core potentials</h2>
<div id="outline-container-org07bb9e9" class="outline-2">
<h2 id="org07bb9e9"><span class="section-number-2">4</span> <span class="todo TODO">TODO</span> Effective core potentials</h2>
<div class="outline-text-2" id="text-4">
<p>
An effective core potential (ECP) \(V_A^{\text{pp}}\) replacing the
@ -587,7 +587,7 @@ letters are parameters.
<li>\(\hat{V}_\text{ecp,nl} = \sum_A \hat{V}_A^{\text{nl}}\) : non-local component</li>
</ul>
<table id="org0701dfb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgde369f9" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -688,8 +688,8 @@ letters are parameters.
</div>
</div>
<div id="outline-container-org86016e6" class="outline-2">
<h2 id="org86016e6"><span class="section-number-2">5</span> Basis set</h2>
<div id="outline-container-org5acfaf2" class="outline-2">
<h2 id="org5acfaf2"><span class="section-number-2">5</span> Basis set</h2>
<div class="outline-text-2" id="text-5">
<p>
We consider here basis functions centered on nuclei. Hence, we enable
@ -742,7 +742,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:
</p>
<table id="org5968aad" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org150753e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -903,8 +903,8 @@ prim_factor =
</div>
</div>
<div id="outline-container-org96b16b7" class="outline-2">
<h2 id="org96b16b7"><span class="section-number-2">6</span> Atomic orbitals</h2>
<div id="outline-container-org4e48793" class="outline-2">
<h2 id="org4e48793"><span class="section-number-2">6</span> Atomic orbitals</h2>
<div class="outline-text-2" id="text-6">
<p>
Going from the atomic basis set to AOs implies a systematic
@ -952,13 +952,13 @@ shell, as in the GAMESS convention where
<p>
In such a case, one should set the normalization of the shell (in
the <a href="#org86016e6">Basis set</a> section) to \(\mathcal{N}_{z^2}\), which is the
the <a href="#org5acfaf2">Basis set</a> section) to \(\mathcal{N}_{z^2}\), which is the
normalization factor of the atomic orbitals in spherical coordinates.
The normalization factor of the \(xy\) function which should be
introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\).
</p>
<table id="orgba83541" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org9c37223" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1002,8 +1002,8 @@ introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\).
</table>
</div>
<div id="outline-container-orge8be744" class="outline-3">
<h3 id="ao_one_e"><a id="orge8be744"></a><span class="section-number-3">6.1</span> One-electron integrals</h3>
<div id="outline-container-org4282c0a" class="outline-3">
<h3 id="ao_one_e"><a id="org4282c0a"></a><span class="section-number-3">6.1</span> One-electron integrals</h3>
<div class="outline-text-3" id="text-ao_one_e">
<ul class="org-ul">
<li>\[ \hat{V}_{\text{ne}} = \sum_{A=1}^{N_\text{nucl}}
@ -1021,7 +1021,7 @@ The one-electron integrals for a one-electron operator \(\hat{O}\) are
over atomic orbitals.
</p>
<table id="org8a5916c" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgfd250fb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1080,8 +1080,8 @@ over atomic orbitals.
</div>
</div>
<div id="outline-container-org1337252" class="outline-3">
<h3 id="ao_two_e"><a id="org1337252"></a><span class="section-number-3">6.2</span> Two-electron integrals</h3>
<div id="outline-container-orgb87a6b2" class="outline-3">
<h3 id="ao_two_e"><a id="orgb87a6b2"></a><span class="section-number-3">6.2</span> Two-electron integrals</h3>
<div class="outline-text-3" id="text-ao_two_e">
<p>
The two-electron integrals for a two-electron operator \(\hat{O}\) are
@ -1102,7 +1102,7 @@ notation.
\mathbf{r}_j \vert)}{\vert \mathbf{r}_i - \mathbf{r}_j \vert} \] : electron-electron long range potential</li>
</ul>
<table id="org9db7635" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org9199bf6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1134,10 +1134,10 @@ notation.
</div>
</div>
<div id="outline-container-org2f3ed38" class="outline-2">
<h2 id="org2f3ed38"><span class="section-number-2">7</span> Molecular orbitals</h2>
<div id="outline-container-org28b0480" class="outline-2">
<h2 id="org28b0480"><span class="section-number-2">7</span> Molecular orbitals</h2>
<div class="outline-text-2" id="text-7">
<table id="org2e94a16" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org28d33ce" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1195,8 +1195,8 @@ notation.
</table>
</div>
<div id="outline-container-org72bc6af" class="outline-3">
<h3 id="org72bc6af"><span class="section-number-3">7.1</span> One-electron integrals</h3>
<div id="outline-container-org6b0f44b" class="outline-3">
<h3 id="org6b0f44b"><span class="section-number-3">7.1</span> One-electron integrals</h3>
<div class="outline-text-3" id="text-7-1">
<p>
The operators as the same as those defined in the
@ -1204,7 +1204,7 @@ The operators as the same as those defined in the
the basis of molecular orbitals.
</p>
<table id="org7bc73bb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org2d56da4" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1263,8 +1263,8 @@ the basis of molecular orbitals.
</div>
</div>
<div id="outline-container-orgd1fde5a" class="outline-3">
<h3 id="orgd1fde5a"><span class="section-number-3">7.2</span> Two-electron integrals</h3>
<div id="outline-container-org2483cde" class="outline-3">
<h3 id="org2483cde"><span class="section-number-3">7.2</span> Two-electron integrals</h3>
<div class="outline-text-3" id="text-7-2">
<p>
The operators as the same as those defined in the
@ -1272,7 +1272,7 @@ The operators as the same as those defined in the
the basis of molecular orbitals.
</p>
<table id="org35a9ecf" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgfe898d6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1304,13 +1304,13 @@ the basis of molecular orbitals.
</div>
</div>
<div id="outline-container-org22ac68f" class="outline-2">
<h2 id="org22ac68f"><span class="section-number-2">8</span> <span class="todo TODO">TODO</span> Slater determinants</h2>
<div id="outline-container-org61147f9" class="outline-2">
<h2 id="org61147f9"><span class="section-number-2">8</span> <span class="todo TODO">TODO</span> Slater determinants</h2>
</div>
<div id="outline-container-org177ee41" class="outline-2">
<h2 id="org177ee41"><span class="section-number-2">9</span> <span class="todo TODO">TODO</span> Reduced density matrices</h2>
<div id="outline-container-orgdeae482" class="outline-2">
<h2 id="orgdeae482"><span class="section-number-2">9</span> <span class="todo TODO">TODO</span> Reduced density matrices</h2>
<div class="outline-text-2" id="text-9">
<table id="orgdbd98ae" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgfb13fa8" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1349,15 +1349,15 @@ the basis of molecular orbitals.
</div>
</div>
<div id="outline-container-orgbbdb680" class="outline-2">
<h2 id="orgbbdb680"><span class="section-number-2">10</span> Appendix</h2>
<div id="outline-container-orgfa07ec8" class="outline-2">
<h2 id="orgfa07ec8"><span class="section-number-2">10</span> Appendix</h2>
<div class="outline-text-2" id="text-10">
</div>
<div id="outline-container-orgca98b95" class="outline-3">
<h3 id="orgca98b95"><span class="section-number-3">10.1</span> Python script from table to json</h3>
<div id="outline-container-orgc6fdc80" class="outline-3">
<h3 id="orgc6fdc80"><span class="section-number-3">10.1</span> Python script from table to json</h3>
<div class="outline-text-3" id="text-10-1">
<div class="org-src-container">
<pre class="src src-python" id="org059451c"><span style="color: #a020f0;">print</span>(<span style="color: #8b2252;">"""#+begin_src python :tangle trex.json"""</span>)
<pre class="src src-python" id="orgd93fdd8"><span style="color: #a020f0;">print</span>(<span style="color: #8b2252;">"""#+begin_src python :tangle trex.json"""</span>)
<span style="color: #a020f0;">print</span>(<span style="color: #8b2252;">""" "%s": {"""</span>%(title))
<span style="color: #a0522d;">indent</span> = <span style="color: #8b2252;">" "</span>
<span style="color: #a0522d;">f1</span> = 0 ; <span style="color: #a0522d;">f2</span> = 0 ; <span style="color: #a0522d;">f3</span> = 0
@ -1416,7 +1416,7 @@ the basis of molecular orbitals.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-22 Tue 20:32</p>
<p class="date">Created: 2021-06-23 Wed 15:06</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>