Skip to content

Commit

Permalink
Commiting Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Action committed Jun 27, 2024
1 parent 7974099 commit 0fc46fb
Show file tree
Hide file tree
Showing 640 changed files with 8,768 additions and 9,031 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jun 26 2024 19:13:02 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 Thu Jun 27 2024 00:45:38 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>
</ul>
</div>
</body>
Expand Down
108 changes: 54 additions & 54 deletions _abstract_c_lib_bmi_adapter_8hpp_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _aorc_forcing_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,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 Jun 26 2024 19:13:02 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 Thu Jun 27 2024 00:45:38 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>
</ul>
</div>
</body>
Expand Down
121 changes: 59 additions & 62 deletions _bmi___adapter_8hpp_source.html

Large diffs are not rendered by default.

738 changes: 369 additions & 369 deletions _bmi___c___adapter_8hpp_source.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions _bmi___c___formulation_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,14 +159,14 @@
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="preprocessor">#endif </span><span class="comment">//NGEN_BMI_C_FORMULATION_H</span></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html">realization::Bmi_C_Formulation</a></div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.hpp:13</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_a08e3342f5efce58c578b780cc95c0b5b"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#a08e3342f5efce58c578b780cc95c0b5b">realization::Bmi_C_Formulation::get_var_value_as_double</a></div><div class="ttdeci">double get_var_value_as_double(const int &amp;index, const std::string &amp;var_name) override</div><div class="ttdoc">Get value for some BMI model variable at a specific index.</div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.cpp:36</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_a4fb6082c7e0582543a1f42892569a858"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#a4fb6082c7e0582543a1f42892569a858">realization::Bmi_C_Formulation::is_bmi_input_variable</a></div><div class="ttdeci">bool is_bmi_input_variable(const std::string &amp;var_name) override</div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.cpp:79</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_a08e3342f5efce58c578b780cc95c0b5b"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#a08e3342f5efce58c578b780cc95c0b5b">realization::Bmi_C_Formulation::get_var_value_as_double</a></div><div class="ttdeci">double get_var_value_as_double(const int &amp;index, const std::string &amp;var_name) override</div><div class="ttdoc">Get value for some BMI model variable at a specific index.</div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.cpp:35</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_a4fb6082c7e0582543a1f42892569a858"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#a4fb6082c7e0582543a1f42892569a858">realization::Bmi_C_Formulation::is_bmi_input_variable</a></div><div class="ttdeci">bool is_bmi_input_variable(const std::string &amp;var_name) override</div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.cpp:78</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_a5511312775b6bc3481ff5ec282874e12"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#a5511312775b6bc3481ff5ec282874e12">realization::Bmi_C_Formulation::convert_model_time</a></div><div class="ttdeci">time_t convert_model_time(const double &amp;model_time) override</div><div class="ttdoc">Convert a time value from the model to an epoch time in seconds.</div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.hpp:39</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_a916aba6fc1f5e4d95c9fcd3f234a5bf0"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#a916aba6fc1f5e4d95c9fcd3f234a5bf0">realization::Bmi_C_Formulation::construct_model</a></div><div class="ttdeci">std::shared_ptr&lt; models::bmi::Bmi_Adapter &gt; construct_model(const geojson::PropertyMap &amp;properties) override</div><div class="ttdoc">Construct model and its shared pointer, potentially supplying input variable values from config.</div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.cpp:18</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_a95c328f3f7ebee638e0a36dc0874a898"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#a95c328f3f7ebee638e0a36dc0874a898">realization::Bmi_C_Formulation::get_var_value_as</a></div><div class="ttdeci">T get_var_value_as(time_step_t t_index, const std::string &amp;var_name)</div><div class="ttdoc">Get a value, converted to specified type, for an output variable at a time step.</div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.hpp:66</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___c___formulation_html_adf1873c11226bdff7098f16b717b9183"><div class="ttname"><a href="classrealization_1_1_bmi___c___formulation.html#adf1873c11226bdff7098f16b717b9183">realization::Bmi_C_Formulation::get_formulation_type</a></div><div class="ttdeci">std::string get_formulation_type() override</div><div class="ttdef"><b>Definition</b> Bmi_C_Formulation.cpp:8</div></div>
<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:89</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:84</div></div>
<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:88</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:83</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:27</div></div>
<div class="ttc" id="aclassrealization_1_1_bmi___module___formulation_html_acebac670059dec776623642295b94952"><div class="ttname"><a href="classrealization_1_1_bmi___module___formulation.html#acebac670059dec776623642295b94952">realization::Bmi_Module_Formulation::get_bmi_model</a></div><div class="ttdeci">std::shared_ptr&lt; models::bmi::Bmi_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.cpp:288</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:25</div></div>
Expand All @@ -179,7 +179,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 Wed Jun 26 2024 19:13:02 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 Thu Jun 27 2024 00:45:39 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>
</ul>
</div>
</body>
Expand Down
Loading

0 comments on commit 0fc46fb

Please sign in to comment.