Skip to content

Commit

Permalink
doxygen update
Browse files Browse the repository at this point in the history
  • Loading branch information
@gsjaardema
gsjaardema committed Mar 1, 2024
1 parent 5e14ae4 commit 7195388
Show file tree
Hide file tree
Showing 21 changed files with 9,401 additions and 9,402 deletions.
2 changes: 1 addition & 1 deletion apr_html/CustomDoxygen.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ table.directory {
line-height: 36px;
background-color: #7fbdff;
}
/* item list on botton left */
/* item list on bottom left */

.navpath li.navelem a {
height: 32px;
Expand Down
2 changes: 1 addition & 1 deletion html/CustomDoxygen.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ table.directory {
line-height: 36px;
background-color: #7fbdff;
}
/* item list on botton left */
/* item list on bottom left */

.navpath li.navelem a {
height: 32px;
Expand Down
2 changes: 1 addition & 1 deletion ioss_html/CustomDoxygen.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ table.directory {
line-height: 36px;
background-color: #7fbdff;
}
/* item list on botton left */
/* item list on bottom left */

.navpath li.navelem a {
height: 32px;
Expand Down
4 changes: 2 additions & 2 deletions ioss_html/Ioss__ScopeGuard_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> </div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Ret, <span class="keyword">class</span> Obj1, <span class="keyword">class</span> Obj2, <span class="keyword">typename</span> P1a, <span class="keyword">typename</span> P1b&gt;</div>
<div class="foldopen" id="foldopen00213" data-start="{" data-end="}">
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"><a class="line" href="namespaceIoss.html#aff78f8df4e96c2eb25aa3197a41af874"> 213</a></span> <span class="keyword">inline</span> <a class="code hl_class" href="classIoss_1_1ObjScopeGuardImpl1.html">ObjScopeGuardImpl1</a>&lt;Obj1, Ret (Obj2::*)(P1a), P1b&gt; <a class="code hl_function" href="namespaceIoss.html#ae36ce2e25110a5d2c6acda85ae74d9ff">MakeGuard</a>(Ret (Obj2::*memFun)(P1a),</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"><a class="line" href="namespaceIoss.html#aff78f8df4e96c2eb25aa3197a41af874"> 213</a></span> <span class="keyword">inline</span> <a class="code hl_class" href="classIoss_1_1ObjScopeGuardImpl1.html">ObjScopeGuardImpl1</a>&lt;Obj1, Ret (Obj2::*)(P1a), P1b&gt; <a class="code hl_function" href="namespaceIoss.html#ae36ce2e25110a5d2c6acda85ae74d9ff">MakeGuard</a>(Ret (Obj2::*memFun)(P1a),</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> Obj1 &amp;obj, P1b p1)</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> {</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> <span class="keywordflow">return</span> <a class="code hl_class" href="classIoss_1_1ObjScopeGuardImpl1.html">ObjScopeGuardImpl1</a>&lt;Obj1, Ret (Obj2::*)(P1a), P1b&gt;<a class="code hl_function" href="namespaceIoss.html#a8401d292f31730706ffa08d62566af8c">::MakeObjGuard</a>(obj, memFun, p1);</div>
Expand All @@ -368,7 +368,7 @@
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> </div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Ret, <span class="keyword">class</span> Obj1, <span class="keyword">class</span> Obj2, <span class="keyword">typename</span> P1a, <span class="keyword">typename</span> P1b&gt;</div>
<div class="foldopen" id="foldopen00220" data-start="{" data-end="}">
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"><a class="line" href="namespaceIoss.html#ab50edb976e91c7dab58af7d4db08dcaf"> 220</a></span> <span class="keyword">inline</span> <a class="code hl_class" href="classIoss_1_1ObjScopeGuardImpl1.html">ObjScopeGuardImpl1</a>&lt;Obj1, Ret (Obj2::*)(P1a), P1b&gt; <a class="code hl_function" href="namespaceIoss.html#ae36ce2e25110a5d2c6acda85ae74d9ff">MakeGuard</a>(Ret (Obj2::*memFun)(P1a),</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"><a class="line" href="namespaceIoss.html#ab50edb976e91c7dab58af7d4db08dcaf"> 220</a></span> <span class="keyword">inline</span> <a class="code hl_class" href="classIoss_1_1ObjScopeGuardImpl1.html">ObjScopeGuardImpl1</a>&lt;Obj1, Ret (Obj2::*)(P1a), P1b&gt; <a class="code hl_function" href="namespaceIoss.html#ae36ce2e25110a5d2c6acda85ae74d9ff">MakeGuard</a>(Ret (Obj2::*memFun)(P1a),</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> Obj1 *obj, P1b p1)</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> {</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> <span class="keywordflow">return</span> <a class="code hl_class" href="classIoss_1_1ObjScopeGuardImpl1.html">ObjScopeGuardImpl1</a>&lt;Obj1, Ret (Obj2::*)(P1a), P1b&gt;<a class="code hl_function" href="namespaceIoss.html#a8401d292f31730706ffa08d62566af8c">::MakeObjGuard</a>(*obj, memFun, p1);</div>
Expand Down
2 changes: 1 addition & 1 deletion ioss_html/Ioss__ZoneConnectivity_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <a class="code hl_typedef" href="namespaceIoss.html#ab8228ae25e9448cae504638c2b6be88a">Ioss::IJK_t</a> transform(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceIoss.html#ab8228ae25e9448cae504638c2b6be88a">Ioss::IJK_t</a> &amp;index_1) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <a class="code hl_typedef" href="namespaceIoss.html#ab8228ae25e9448cae504638c2b6be88a">Ioss::IJK_t</a> inverse_transform(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceIoss.html#ab8228ae25e9448cae504638c2b6be88a">Ioss::IJK_t</a> &amp;index_1) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> std::vector&lt;int&gt; get_range(<span class="keywordtype">int</span> ordinal) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> std::vector&lt;int&gt; get_range(<span class="keywordtype">int</span> ordinal) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/* COMPARE two ZoneConnectivity objects */</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code hl_struct" href="structIoss_1_1ZoneConnectivity.html">Ioss::ZoneConnectivity</a> &amp;rhs) <span class="keyword">const</span>;</div>
Expand Down
4 changes: 1 addition & 3 deletions ioss_html/classIOShell_1_1Interface.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,6 @@
<tr class="memdesc:acf9c2531165559c5139d89879f1072fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">If non-empty, then it is a list of times that should be transferred to the output file. <br /></td></tr>
<tr class="separator:acf9c2531165559c5139d89879f1072fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7da8b38c47b8f1a0cfb6e6c514dea548" id="r_a7da8b38c47b8f1a0cfb6e6c514dea548"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="namespacestd.html#af182ebdbfb7c2efe51f4ef6cf59862b5">std::string</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7da8b38c47b8f1a0cfb6e6c514dea548">omitted_blocks</a> {}</td></tr>
<tr class="memdesc:a7da8b38c47b8f1a0cfb6e6c514dea548"><td class="mdescLeft">&#160;</td><td class="mdescRight">If non-empty, then it is a list of element blocks that should be omitted from the output file. <br /></td></tr>
<tr class="separator:a7da8b38c47b8f1a0cfb6e6c514dea548"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07d33285a42685b05117805847929080" id="r_a07d33285a42685b05117805847929080"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07d33285a42685b05117805847929080">split_times</a> {0}</td></tr>
<tr class="separator:a07d33285a42685b05117805847929080"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -873,8 +872,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7da8b38c47b8f1a0cfb6e6c5
</tr>
</table>
</div><div class="memdoc">

<p>If non-empty, then it is a list of element blocks that should be omitted from the output file. </p>
<p>If non-empty, then it is a list of element blocks that should be omitted from the output file </p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion ioss_html/classIoex_1_1BaseDatabaseIO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2207,7 +2207,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4da38f8804fe43eed717bec7
<p>int local_position = elemMap.reverse[ElementMap[i+1]] (the elemMap.map and elemMap.reverse are 1-based)</p>
<p>But, this assumes 1..numel elements are being output at the same time; we are actually outputting a blocks worth of elements at a time, so we need to consider the block offsets. So... local-in-block position 'i' is index 'eb_offset+i' in 'elemMap.map' and the 'local_position' within the element blocks data arrays is 'local_position-eb_offset'. With this, the position within the data array of this element block is:</p>
<p>int eb_position = elemMap.reverse[elemMap.map[eb_offset+i+1]]-eb_offset-1</p>
<p>To determine which map to update on a call to this function, we use the following hueristics: &ndash; If the database state is '<a class="el" href="namespaceIoss.html#a02dbd3bfbd7f633e636c8c0c385c4a34aaeed43f1d972e32272a554f2a8ff682d">Ioss::STATE_MODEL</a>:', then update the 'elemMap.reverse'. &ndash; If the database state is not <a class="el" href="namespaceIoss.html#a02dbd3bfbd7f633e636c8c0c385c4a34aaeed43f1d972e32272a554f2a8ff682d">Ioss::STATE_MODEL</a>, then leave the 'elemMap.reverse' alone since it corresponds to the information already written to the database. [May want to add a Ioss::STATE_REDEFINE_MODEL] &ndash; Always update elemMap.map to match the passed in 'ids' array.</p>
<p>To determine which map to update on a call to this function, we use the following heuristics: &ndash; If the database state is '<a class="el" href="namespaceIoss.html#a02dbd3bfbd7f633e636c8c0c385c4a34aaeed43f1d972e32272a554f2a8ff682d">Ioss::STATE_MODEL</a>:', then update the 'elemMap.reverse'. &ndash; If the database state is not <a class="el" href="namespaceIoss.html#a02dbd3bfbd7f633e636c8c0c385c4a34aaeed43f1d972e32272a554f2a8ff682d">Ioss::STATE_MODEL</a>, then leave the 'elemMap.reverse' alone since it corresponds to the information already written to the database. [May want to add a Ioss::STATE_REDEFINE_MODEL] &ndash; Always update elemMap.map to match the passed in 'ids' array.</p>
<p>NOTE: the maps are built an element block at a time... NOTE: The mapping is done on TRANSIENT fields only; MODEL fields should be in the original order...</p>

</div>
Expand Down
2 changes: 1 addition & 1 deletion ioss_html/classIoex_1_1DatabaseIO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2260,7 +2260,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a69bfcc7aea9bebf00b3d6caf
<p>So, there will be two maps the 'nodeMap.map' map is a 'direct lookup' map which maps current local position to global id and the 'nodeMap.reverse' is an associative lookup which maps the global id to 'original local'. There is also a 'nodeMap.reorder' which is direct lookup and maps current local position to original local.</p>
<p>The ids coming in are the global ids; their position is the "local id-1" (That is, data[0] contains the global id of local node 1 in this node block).</p>
<p>int local_position = nodeMap.reverse[NodeMap[i+1]] (the nodeMap.map and nodeMap.reverse are 1-based)</p>
<p>To determine which map to update on a call to this function, we use the following hueristics: &ndash; If the database state is 'STATE_MODEL:', then update the 'nodeMap.reverse' and 'nodeMap.map'</p>
<p>To determine which map to update on a call to this function, we use the following heuristics: &ndash; If the database state is 'STATE_MODEL:', then update the 'nodeMap.reverse' and 'nodeMap.map'</p>
<p>&ndash; If the database state is not STATE_MODEL, then leave the 'nodeMap.reverse' and 'nodeMap.map' alone since they correspond to the information already written to the database. [May want to add a STATE_REDEFINE_MODEL]</p>
<p>&ndash; In both cases, update the nodeMap.reorder</p>
<p>NOTE: The mapping is done on TRANSIENT fields only; MODEL fields should be in the original order...</p>
Expand Down
2 changes: 1 addition & 1 deletion ioss_html/classIoexnl_1_1BaseDatabaseIO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1475,7 +1475,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3994c805cc1b657d6dd410f2
<p>int local_position = elemMap.reverse[ElementMap[i+1]] (the elemMap.map and elemMap.reverse are 1-based)</p>
<p>But, this assumes 1..numel elements are being output at the same time; we are actually outputting a blocks worth of elements at a time, so we need to consider the block offsets. So... local-in-block position 'i' is index 'eb_offset+i' in 'elemMap.map' and the 'local_position' within the element blocks data arrays is 'local_position-eb_offset'. With this, the position within the data array of this element block is:</p>
<p>int eb_position = elemMap.reverse[elemMap.map[eb_offset+i+1]]-eb_offset-1</p>
<p>To determine which map to update on a call to this function, we use the following hueristics: &ndash; If the database state is '<a class="el" href="namespaceIoss.html#a02dbd3bfbd7f633e636c8c0c385c4a34aaeed43f1d972e32272a554f2a8ff682d">Ioss::STATE_MODEL</a>:', then update the 'elemMap.reverse'. &ndash; If the database state is not <a class="el" href="namespaceIoss.html#a02dbd3bfbd7f633e636c8c0c385c4a34aaeed43f1d972e32272a554f2a8ff682d">Ioss::STATE_MODEL</a>, then leave the 'elemMap.reverse' alone since it corresponds to the information already written to the database. [May want to add a Ioss::STATE_REDEFINE_MODEL] &ndash; Always update elemMap.map to match the passed in 'ids' array.</p>
<p>To determine which map to update on a call to this function, we use the following heuristics: &ndash; If the database state is '<a class="el" href="namespaceIoss.html#a02dbd3bfbd7f633e636c8c0c385c4a34aaeed43f1d972e32272a554f2a8ff682d">Ioss::STATE_MODEL</a>:', then update the 'elemMap.reverse'. &ndash; If the database state is not <a class="el" href="namespaceIoss.html#a02dbd3bfbd7f633e636c8c0c385c4a34aaeed43f1d972e32272a554f2a8ff682d">Ioss::STATE_MODEL</a>, then leave the 'elemMap.reverse' alone since it corresponds to the information already written to the database. [May want to add a Ioss::STATE_REDEFINE_MODEL] &ndash; Always update elemMap.map to match the passed in 'ids' array.</p>
<p>NOTE: the maps are built an element block at a time... NOTE: The mapping is done on TRANSIENT fields only; MODEL fields should be in the original order...</p>

</div>
Expand Down
2 changes: 1 addition & 1 deletion ioss_html/classIoexnl_1_1DatabaseIO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1604,7 +1604,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7f7d5588c9b32c0f6e2b598e
<p>So, there will be two maps the 'nodeMap.map' map is a 'direct lookup' map which maps current local position to global id and the 'nodeMap.reverse' is an associative lookup which maps the global id to 'original local'. There is also a 'nodeMap.reorder' which is direct lookup and maps current local position to original local.</p>
<p>The ids coming in are the global ids; their position is the "local id-1" (That is, data[0] contains the global id of local node 1 in this node block).</p>
<p>int local_position = nodeMap.reverse[NodeMap[i+1]] (the nodeMap.map and nodeMap.reverse are 1-based)</p>
<p>To determine which map to update on a call to this function, we use the following hueristics: &ndash; If the database state is 'STATE_MODEL:', then update the 'nodeMap.reverse' and 'nodeMap.map'</p>
<p>To determine which map to update on a call to this function, we use the following heuristics: &ndash; If the database state is 'STATE_MODEL:', then update the 'nodeMap.reverse' and 'nodeMap.map'</p>
<p>&ndash; If the database state is not STATE_MODEL, then leave the 'nodeMap.reverse' and 'nodeMap.map' alone since they correspond to the information already written to the database. [May want to add a STATE_REDEFINE_MODEL]</p>
<p>&ndash; In both cases, update the nodeMap.reorder</p>
<p>NOTE: The mapping is done on TRANSIENT fields only; MODEL fields should be in the original order...</p>
Expand Down
2 changes: 1 addition & 1 deletion ioss_html/io__info__main_8C.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@
<code>#include &lt;ostream&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &quot;<a class="el" href="Ioss__ScopeGuard_8h_source.html">Ioss_ScopeGuard.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="Ionit__Initializer_8h_source.html">Ionit_Initializer.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="Ioss__IOFactory_8h_source.html">Ioss_IOFactory.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="Ioss__ScopeGuard_8h_source.html">Ioss_ScopeGuard.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="Ioss__Utils_8h_source.html">Ioss_Utils.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="info__interface_8h_source.html">info_interface.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="io__info_8h_source.html">io_info.h</a>&quot;</code><br />
Expand Down
Loading

0 comments on commit 7195388

Please sign in to comment.