Skip to content

Commit

Permalink
Commiting Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Action committed Sep 21, 2023
1 parent 05cb9ec commit 8ae381e
Show file tree
Hide file tree
Showing 600 changed files with 3,340 additions and 3,565 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44: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.5 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion _abstract_c_lib_bmi_adapter_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,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_9058ef7c383dff996c678c5ba80ec03e.html">realizations</a></li><li class="navelem"><a class="el" href="dir_8dbd500a1ae0b3d23deb7285e2980d8b.html">catchment</a></li><li class="navelem"><b>AbstractCLibBmiAdapter.hpp</b></li>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion _aorc_forcing_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,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 Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
8 changes: 4 additions & 4 deletions _async_data_provider_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,17 +113,17 @@
<div class="ttc" id="aclassdata__access_1_1_async_data_provider_html"><div class="ttname"><a href="classdata__access_1_1_async_data_provider.html">data_access::AsyncDataProvider</a></div><div class="ttdef"><b>Definition:</b> AsyncDataProvider.hpp:9</div></div>
<div class="ttc" id="aclassdata__access_1_1_async_data_provider_html_a07a18c0c6876bd02685a78efea74365f"><div class="ttname"><a href="classdata__access_1_1_async_data_provider.html#a07a18c0c6876bd02685a78efea74365f">data_access::AsyncDataProvider::value_ready</a></div><div class="ttdeci">virtual bool value_ready(selection_type selector, const std::string &amp;variable_name, const time_t &amp;init_time, const long &amp;duration_s, const std::string &amp;output_units, ReSampleMethod m=SUM)=0</div></div>
<div class="ttc" id="aclassdata__access_1_1_async_data_provider_html_a31d15fd72f35c01c67c790f33f8aa2c1"><div class="ttname"><a href="classdata__access_1_1_async_data_provider.html#a31d15fd72f35c01c67c790f33f8aa2c1">data_access::AsyncDataProvider::request_value</a></div><div class="ttdeci">virtual void request_value(selection_type selector, const std::string &amp;variable_name, const time_t &amp;init_time, const long &amp;duration_s, const std::string &amp;output_units, ReSampleMethod m=SUM)=0</div></div>
<div class="ttc" id="aclassdata__access_1_1_data_provider_html"><div class="ttname"><a href="classdata__access_1_1_data_provider.html">data_access::DataProvider</a></div><div class="ttdef"><b>Definition:</b> DataProvider.hpp:24</div></div>
<div class="ttc" id="aclassdata__access_1_1_data_provider_html"><div class="ttname"><a href="classdata__access_1_1_data_provider.html">data_access::DataProvider</a></div><div class="ttdef"><b>Definition:</b> DataProvider.hpp:25</div></div>
<div class="ttc" id="anamespacedata__access_html"><div class="ttname"><a href="namespacedata__access.html">data_access</a></div><div class="ttdef"><b>Definition:</b> AorcForcing.hpp:75</div></div>
<div class="ttc" id="anamespacedata__access_html_a46435cb3579215dfdfffedc7833e43f9"><div class="ttname"><a href="namespacedata__access.html#a46435cb3579215dfdfffedc7833e43f9">data_access::ReSampleMethod</a></div><div class="ttdeci">ReSampleMethod</div><div class="ttdoc">An abstraction for classes that provides access to data.</div><div class="ttdef"><b>Definition:</b> DataProvider.hpp:16</div></div>
<div class="ttc" id="anamespacedata__access_html_a46435cb3579215dfdfffedc7833e43f9a52f32bc197123b0d24b5291d60af3186"><div class="ttname"><a href="namespacedata__access.html#a46435cb3579215dfdfffedc7833e43f9a52f32bc197123b0d24b5291d60af3186">data_access::SUM</a></div><div class="ttdeci">@ SUM</div><div class="ttdef"><b>Definition:</b> DataProvider.hpp:18</div></div>
<div class="ttc" id="anamespacedata__access_html_a46435cb3579215dfdfffedc7833e43f9"><div class="ttname"><a href="namespacedata__access.html#a46435cb3579215dfdfffedc7833e43f9">data_access::ReSampleMethod</a></div><div class="ttdeci">ReSampleMethod</div><div class="ttdoc">An abstraction for classes that provides access to data.</div><div class="ttdef"><b>Definition:</b> DataProvider.hpp:17</div></div>
<div class="ttc" id="anamespacedata__access_html_a46435cb3579215dfdfffedc7833e43f9a52f32bc197123b0d24b5291d60af3186"><div class="ttname"><a href="namespacedata__access.html#a46435cb3579215dfdfffedc7833e43f9a52f32bc197123b0d24b5291d60af3186">data_access::SUM</a></div><div class="ttdeci">@ SUM</div><div class="ttdef"><b>Definition:</b> DataProvider.hpp:19</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<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>AsyncDataProvider.hpp</b></li>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion _bmi___adapter_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,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_9058ef7c383dff996c678c5ba80ec03e.html">realizations</a></li><li class="navelem"><a class="el" href="dir_8dbd500a1ae0b3d23deb7285e2980d8b.html">catchment</a></li><li class="navelem"><b>Bmi_Adapter.hpp</b></li>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion _bmi___c___adapter_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,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_9058ef7c383dff996c678c5ba80ec03e.html">realizations</a></li><li class="navelem"><a class="el" href="dir_8dbd500a1ae0b3d23deb7285e2980d8b.html">catchment</a></li><li class="navelem"><b>Bmi_C_Adapter.hpp</b></li>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions _bmi___c___formulation_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_aee9b4fec8bd57a88b56e9e78691fa35d"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#aee9b4fec8bd57a88b56e9e78691fa35d">realization::Bmi_C_Formulation::is_model_initialized</a></div><div class="ttdeci">bool is_model_initialized() override</div><div class="ttdoc">Test whether backing model has run BMI Initialize.</div><div class="ttdef"><b>Definition:</b> Bmi_C_Formulation.cpp:196</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_afb5627a4faf940e0f25f58e0226145d4"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#afb5627a4faf940e0f25f58e0226145d4">realization::Bmi_C_Formulation::is_bmi_output_variable</a></div><div class="ttdeci">bool is_bmi_output_variable(const std::string &amp;var_name) override</div><div class="ttdef"><b>Definition:</b> Bmi_C_Formulation.cpp:191</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___module___formulation_html"><div class="ttname"><a href="classrealization_1_1_bmi___module___formulation.html">realization::Bmi_Module_Formulation</a></div><div class="ttdoc">Abstraction of a formulation with a single backing model object that implements the BMI.</div><div class="ttdef"><b>Definition:</b> Bmi_Module_Formulation.hpp:34</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___module___formulation_html_a01639b29fee1e578097326ce85cd0472"><div class="ttname"><a href="classrealization_1_1_bmi___module___formulation.html#a01639b29fee1e578097326ce85cd0472">realization::Bmi_Module_Formulation&lt; models::bmi::Bmi_C_Adapter &gt;::get_bmi_model</a></div><div class="ttdeci">std::shared_ptr&lt; models::bmi::Bmi_C_Adapter &gt; get_bmi_model()</div><div class="ttdoc">Get the backing model object implementing the BMI.</div><div class="ttdef"><b>Definition:</b> Bmi_Module_Formulation.hpp:461</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___module___formulation_html_a01639b29fee1e578097326ce85cd0472"><div class="ttname"><a href="classrealization_1_1_bmi___module___formulation.html#a01639b29fee1e578097326ce85cd0472">realization::Bmi_Module_Formulation&lt; models::bmi::Bmi_C_Adapter &gt;::get_bmi_model</a></div><div class="ttdeci">std::shared_ptr&lt; models::bmi::Bmi_C_Adapter &gt; get_bmi_model()</div><div class="ttdoc">Get the backing model object implementing the BMI.</div><div class="ttdef"><b>Definition:</b> Bmi_Module_Formulation.hpp:454</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___multi___formulation_html"><div class="ttname"><a href="classrealization_1_1_bmi___multi___formulation.html">realization::Bmi_Multi_Formulation</a></div><div class="ttdoc">Abstraction of a formulation with multiple backing model object that implements the BMI.</div><div class="ttdef"><b>Definition:</b> Bmi_Multi_Formulation.hpp:24</div></div>
<div class="ttc" id="aclassutils_1_1_stream_handler_html"><div class="ttname"><a href="classutils_1_1_stream_handler.html">utils::StreamHandler</a></div><div class="ttdoc">This class provides a copyable interface to a std::ostream or std::ostream like object that may not s...</div><div class="ttdef"><b>Definition:</b> StreamHandler.hpp:14</div></div>
<div class="ttc" id="anamespacegeojson_html_a6eabe3c674d580523aa920438fb82d34"><div class="ttname"><a href="namespacegeojson.html#a6eabe3c674d580523aa920438fb82d34">geojson::PropertyMap</a></div><div class="ttdeci">std::map&lt; std::string, JSONProperty &gt; PropertyMap</div><div class="ttdoc">Shorthand for a mapping between strings and properties.</div><div class="ttdef"><b>Definition:</b> JSONProperty.hpp:21</div></div>
Expand All @@ -183,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_9058ef7c383dff996c678c5ba80ec03e.html">realizations</a></li><li class="navelem"><a class="el" href="dir_8dbd500a1ae0b3d23deb7285e2980d8b.html">catchment</a></li><li class="navelem"><b>Bmi_C_Formulation.hpp</b></li>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion _bmi___cpp___adapter_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,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_9058ef7c383dff996c678c5ba80ec03e.html">realizations</a></li><li class="navelem"><a class="el" href="dir_8dbd500a1ae0b3d23deb7285e2980d8b.html">catchment</a></li><li class="navelem"><b>Bmi_Cpp_Adapter.hpp</b></li>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions _bmi___cpp___formulation_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@
<div class="ttc" id="aclassrealization_1_1_bmi___cpp___formulation_html_aecb41fc095d597150eebbbed9a46f912"><div class="ttname"><a href="classrealization_1_1_bmi___cpp___formulation.html#aecb41fc095d597150eebbbed9a46f912">realization::Bmi_Cpp_Formulation::get_output_header_line</a></div><div class="ttdeci">std::string get_output_header_line(std::string delimiter) override</div><div class="ttdoc">Get a header line appropriate for a file made up of entries from this type's implementation of get_ou...</div><div class="ttdef"><b>Definition:</b> Bmi_Cpp_Formulation.cpp:49</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___cpp___formulation_html_aef8ddd7a6fcbb99cff3bc829ffb12f8e"><div class="ttname"><a href="classrealization_1_1_bmi___cpp___formulation.html#aef8ddd7a6fcbb99cff3bc829ffb12f8e">realization::Bmi_Cpp_Formulation::is_model_initialized</a></div><div class="ttdeci">bool is_model_initialized() override</div><div class="ttdoc">Test whether the backing model has been initialize using the BMI standard Initialize function.</div><div class="ttdef"><b>Definition:</b> Bmi_Cpp_Formulation.cpp:195</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___module___formulation_html"><div class="ttname"><a href="classrealization_1_1_bmi___module___formulation.html">realization::Bmi_Module_Formulation</a></div><div class="ttdoc">Abstraction of a formulation with a single backing model object that implements the BMI.</div><div class="ttdef"><b>Definition:</b> Bmi_Module_Formulation.hpp:34</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___module___formulation_html_a01639b29fee1e578097326ce85cd0472"><div class="ttname"><a href="classrealization_1_1_bmi___module___formulation.html#a01639b29fee1e578097326ce85cd0472">realization::Bmi_Module_Formulation&lt; models::bmi::Bmi_Cpp_Adapter &gt;::get_bmi_model</a></div><div class="ttdeci">std::shared_ptr&lt; models::bmi::Bmi_Cpp_Adapter &gt; get_bmi_model()</div><div class="ttdoc">Get the backing model object implementing the BMI.</div><div class="ttdef"><b>Definition:</b> Bmi_Module_Formulation.hpp:461</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___module___formulation_html_a01639b29fee1e578097326ce85cd0472"><div class="ttname"><a href="classrealization_1_1_bmi___module___formulation.html#a01639b29fee1e578097326ce85cd0472">realization::Bmi_Module_Formulation&lt; models::bmi::Bmi_Cpp_Adapter &gt;::get_bmi_model</a></div><div class="ttdeci">std::shared_ptr&lt; models::bmi::Bmi_Cpp_Adapter &gt; get_bmi_model()</div><div class="ttdoc">Get the backing model object implementing the BMI.</div><div class="ttdef"><b>Definition:</b> Bmi_Module_Formulation.hpp:454</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___multi___formulation_html"><div class="ttname"><a href="classrealization_1_1_bmi___multi___formulation.html">realization::Bmi_Multi_Formulation</a></div><div class="ttdoc">Abstraction of a formulation with multiple backing model object that implements the BMI.</div><div class="ttdef"><b>Definition:</b> Bmi_Multi_Formulation.hpp:24</div></div>
<div class="ttc" id="aclassutils_1_1_stream_handler_html"><div class="ttname"><a href="classutils_1_1_stream_handler.html">utils::StreamHandler</a></div><div class="ttdoc">This class provides a copyable interface to a std::ostream or std::ostream like object that may not s...</div><div class="ttdef"><b>Definition:</b> StreamHandler.hpp:14</div></div>
<div class="ttc" id="anamespacegeojson_html_a6eabe3c674d580523aa920438fb82d34"><div class="ttname"><a href="namespacegeojson.html#a6eabe3c674d580523aa920438fb82d34">geojson::PropertyMap</a></div><div class="ttdeci">std::map&lt; std::string, JSONProperty &gt; PropertyMap</div><div class="ttdoc">Shorthand for a mapping between strings and properties.</div><div class="ttdef"><b>Definition:</b> JSONProperty.hpp:21</div></div>
Expand All @@ -180,7 +180,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_9058ef7c383dff996c678c5ba80ec03e.html">realizations</a></li><li class="navelem"><a class="el" href="dir_8dbd500a1ae0b3d23deb7285e2980d8b.html">catchment</a></li><li class="navelem"><b>Bmi_Cpp_Formulation.hpp</b></li>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion _bmi___formulation_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,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_9058ef7c383dff996c678c5ba80ec03e.html">realizations</a></li><li class="navelem"><a class="el" href="dir_8dbd500a1ae0b3d23deb7285e2980d8b.html">catchment</a></li><li class="navelem"><b>Bmi_Formulation.hpp</b></li>
<li class="footer">Generated on Thu Sep 21 2023 16:11:14 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.5 </li>
<li class="footer">Generated on Thu Sep 21 2023 16:44:46 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.5 </li>
</ul>
</div>
</body>
Expand Down
Loading

0 comments on commit 8ae381e

Please sign in to comment.