Skip to content

Commit

Permalink
Commiting Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Action committed Jan 31, 2025
1 parent 8de6a16 commit 36764cc
Show file tree
Hide file tree
Showing 1,505 changed files with 100,426 additions and 96,322 deletions.
58 changes: 33 additions & 25 deletions _2github_2workspace_2include_2utilities_2mdarray_2mdarray_8hpp-example.html
View file

Large diffs are not rendered by default.

29 changes: 16 additions & 13 deletions _abstract_c_lib_bmi_adapter_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NGen: include/bmi/AbstractCLibBmiAdapter.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -33,28 +35,28 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
Expand All @@ -68,7 +70,7 @@
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_abstract_c_lib_bmi_adapter_8hpp_source.html',''); initResizable(); });
$(function(){initNavTree('_abstract_c_lib_bmi_adapter_8hpp_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
Expand Down Expand Up @@ -111,7 +113,7 @@
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html"> 9</a></span> <span class="keyword">class </span><a class="code hl_class" href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html">AbstractCLibBmiAdapter</a> : <span class="keyword">public</span> <a class="code hl_class" href="classmodels_1_1bmi_1_1_bmi___adapter.html">Bmi_Adapter</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_class" href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html">AbstractCLibBmiAdapter</a>(<span class="keyword">const</span> std::string &amp;type_name, std::string library_file_path, std::string <a class="code hl_variable" href="classmodels_1_1bmi_1_1_bmi___adapter.html#a32725cc98663e54694c90c8740e8e5dd">bmi_init_config</a>,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_function" href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#ad6ea3fcd5981c704fe75093a440f844e">AbstractCLibBmiAdapter</a>(<span class="keyword">const</span> std::string &amp;type_name, std::string library_file_path, std::string <a class="code hl_variable" href="classmodels_1_1bmi_1_1_bmi___adapter.html#a32725cc98663e54694c90c8740e8e5dd">bmi_init_config</a>,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">bool</span> has_fixed_time_step, std::string registration_func);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_function" href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#a2acdb60b764e84ddcb0426a5aa4c82e6">~AbstractCLibBmiAdapter</a>() <span class="keyword">override</span>;</div>
Expand Down Expand Up @@ -168,6 +170,7 @@
<div class="ttc" id="aclassmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter_html_a8c61e9b9324dff859901309b12037898"><div class="ttname"><a href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#a8c61e9b9324dff859901309b12037898">models::bmi::AbstractCLibBmiAdapter::dynamic_load_symbol</a></div><div class="ttdeci">void * dynamic_load_symbol(const std::string &amp;symbol_name, bool is_null_valid)</div><div class="ttdoc">Load and return the address of the given symbol from the loaded dynamic model shared library.</div><div class="ttdef"><b>Definition</b> AbstractCLibBmiAdapter.cpp:99</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter_html_abf7c98e446296bd7245a0872fcdba4db"><div class="ttname"><a href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#abf7c98e446296bd7245a0872fcdba4db">models::bmi::AbstractCLibBmiAdapter::get_bmi_registration_function</a></div><div class="ttdeci">const std::string &amp; get_bmi_registration_function()</div><div class="ttdef"><b>Definition</b> AbstractCLibBmiAdapter.hpp:96</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter_html_ad273a417c3b0d21e01b09c81d8c00d91"><div class="ttname"><a href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#ad273a417c3b0d21e01b09c81d8c00d91">models::bmi::AbstractCLibBmiAdapter::get_dyn_lib_handle</a></div><div class="ttdeci">const void * get_dyn_lib_handle()</div><div class="ttdef"><b>Definition</b> AbstractCLibBmiAdapter.hpp:100</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter_html_ad6ea3fcd5981c704fe75093a440f844e"><div class="ttname"><a href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#ad6ea3fcd5981c704fe75093a440f844e">models::bmi::AbstractCLibBmiAdapter::AbstractCLibBmiAdapter</a></div><div class="ttdeci">AbstractCLibBmiAdapter(const std::string &amp;type_name, std::string library_file_path, std::string bmi_init_config, bool has_fixed_time_step, std::string registration_func)</div><div class="ttdoc">Main public constructor.</div><div class="ttdef"><b>Definition</b> AbstractCLibBmiAdapter.cpp:12</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter_html_ad9c8e724b1cbb9fff6ec68dc1410ca8b"><div class="ttname"><a href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#ad9c8e724b1cbb9fff6ec68dc1410ca8b">models::bmi::AbstractCLibBmiAdapter::bmi_registration_function</a></div><div class="ttdeci">const std::string bmi_registration_function</div><div class="ttdoc">Name of the function that registers BMI struct's function pointers to the right module functions.</div><div class="ttdef"><b>Definition</b> AbstractCLibBmiAdapter.hpp:109</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter_html_aee6c52698d720f8cb2607e3b3409a516"><div class="ttname"><a href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#aee6c52698d720f8cb2607e3b3409a516">models::bmi::AbstractCLibBmiAdapter::dynamic_library_load</a></div><div class="ttdeci">void dynamic_library_load()</div><div class="ttdoc">Dynamically load and obtain this instance's handle to the shared library.</div><div class="ttdef"><b>Definition</b> AbstractCLibBmiAdapter.cpp:35</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html">models::bmi::Bmi_Adapter</a></div><div class="ttdoc">Abstract adapter interface for C++ classes to interact with the essential aspects of external models ...</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:17</div></div>
Expand All @@ -180,7 +183,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_7688c87f5c9cad4c135b176d94e89e38.html">bmi</a></li><li class="navelem"><b>AbstractCLibBmiAdapter.hpp</b></li>
<li class="footer">Generated on Wed Oct 16 2024 15:40:45 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
<li class="footer">Generated on Fri Jan 31 2025 15:10:12 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
26 changes: 14 additions & 12 deletions _aorc_forcing_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NGen: include/forcing/AorcForcing.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
Expand All @@ -33,28 +35,28 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
Expand All @@ -68,7 +70,7 @@
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_aorc_forcing_8hpp_source.html',''); initResizable(); });
$(function(){initNavTree('_aorc_forcing_8hpp_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
Expand Down Expand Up @@ -228,7 +230,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1a34ade7a8ced74dfa5d1494ffac178f.html">forcing</a></li><li class="navelem"><b>AorcForcing.hpp</b></li>
<li class="footer">Generated on Wed Oct 16 2024 15:40:45 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
<li class="footer">Generated on Fri Jan 31 2025 15:10:12 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
Loading

0 comments on commit 36764cc

Please sign in to comment.