class_physics.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.20"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Richards fast slow: Physics Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <script type="text/x-mathjax-config">
  16. MathJax.Hub.Config({
  17. extensions: ["tex2jax.js"],
  18. jax: ["input/TeX","output/HTML-CSS"],
  19. });
  20. </script>
  21. <script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
  22. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 56px;">
  30. <td id="projectalign" style="padding-left: 0.5em;">
  31. <div id="projectname">Richards fast slow
  32. &#160;<span id="projectnumber">0.001</span>
  33. </div>
  34. </td>
  35. </tr>
  36. </tbody>
  37. </table>
  38. </div>
  39. <!-- end header part -->
  40. <!-- Generated by Doxygen 1.8.20 -->
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  44. /* @license-end */
  45. </script>
  46. <script type="text/javascript" src="menudata.js"></script>
  47. <script type="text/javascript" src="menu.js"></script>
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  50. $(function() {
  51. initMenu('',true,false,'search.php','Search');
  52. $(document).ready(function() { init_search(); });
  53. });
  54. /* @license-end */</script>
  55. <div id="main-nav"></div>
  56. <!-- window showing the filter options -->
  57. <div id="MSearchSelectWindow"
  58. onmouseover="return searchBox.OnSearchSelectShow()"
  59. onmouseout="return searchBox.OnSearchSelectHide()"
  60. onkeydown="return searchBox.OnSearchSelectKey(event)">
  61. </div>
  62. <!-- iframe showing the search results (closed by default) -->
  63. <div id="MSearchResultsWindow">
  64. <iframe src="javascript:void(0)" frameborder="0"
  65. name="MSearchResults" id="MSearchResults">
  66. </iframe>
  67. </div>
  68. </div><!-- top -->
  69. <div class="header">
  70. <div class="summary">
  71. <a href="#pub-methods">Public Member Functions</a> &#124;
  72. <a href="#pub-attribs">Public Attributes</a> &#124;
  73. <a href="class_physics-members.html">List of all members</a> </div>
  74. <div class="headertitle">
  75. <div class="title">Physics Class Reference</div> </div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p>The <a class="el" href="class_physics.html" title="The Physics class contains all physical parameters characterising the soil.">Physics</a> class contains all physical parameters characterising the soil.
  79. <a href="class_physics.html#details">More...</a></p>
  80. <p><code>#include &lt;<a class="el" href="physics_8hpp_source.html">physics.hpp</a>&gt;</code></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:a7ecf3b371b799eb43e7c9b8e59b251cd"><td class="memItemLeft" align="right" valign="top"><a id="a7ecf3b371b799eb43e7c9b8e59b251cd"></a>
  85. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a7ecf3b371b799eb43e7c9b8e59b251cd">s_BC</a> (double P)</td></tr>
  86. <tr class="memdesc:a7ecf3b371b799eb43e7c9b8e59b251cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Brooks and Corey saturation map. <br /></td></tr>
  87. <tr class="separator:a7ecf3b371b799eb43e7c9b8e59b251cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a0636c81bbfe75ad32f980aed005c5c18"><td class="memItemLeft" align="right" valign="top"><a id="a0636c81bbfe75ad32f980aed005c5c18"></a>
  89. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a0636c81bbfe75ad32f980aed005c5c18">ds_BC</a> (double P)</td></tr>
  90. <tr class="memdesc:a0636c81bbfe75ad32f980aed005c5c18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Brooks and Corey derivative of the saturation map. <br /></td></tr>
  91. <tr class="separator:a0636c81bbfe75ad32f980aed005c5c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ae7372da9f822cb4170b2dda36d524d62"><td class="memItemLeft" align="right" valign="top"><a id="ae7372da9f822cb4170b2dda36d524d62"></a>
  93. void()&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#ae7372da9f822cb4170b2dda36d524d62">s_ds_BC</a> (double P, double &amp;v, double &amp;dv)</td></tr>
  94. <tr class="memdesc:ae7372da9f822cb4170b2dda36d524d62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Brooks and Corey saturation and its derivative setter. <br /></td></tr>
  95. <tr class="separator:ae7372da9f822cb4170b2dda36d524d62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a74dea829cd454fb541bc6c6700d83824"><td class="memItemLeft" align="right" valign="top"><a id="a74dea829cd454fb541bc6c6700d83824"></a>
  97. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a74dea829cd454fb541bc6c6700d83824">kr_BC</a> (double P)</td></tr>
  98. <tr class="memdesc:a74dea829cd454fb541bc6c6700d83824"><td class="mdescLeft">&#160;</td><td class="mdescRight">Brooks and Corey relative conductivity map. <br /></td></tr>
  99. <tr class="separator:a74dea829cd454fb541bc6c6700d83824"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:af087f965a61b5bfe74ffe7270c6522e1"><td class="memItemLeft" align="right" valign="top"><a id="af087f965a61b5bfe74ffe7270c6522e1"></a>
  101. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#af087f965a61b5bfe74ffe7270c6522e1">dkr_BC</a> (double P)</td></tr>
  102. <tr class="memdesc:af087f965a61b5bfe74ffe7270c6522e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Brooks and Corey derivative of the relative conductivity map. <br /></td></tr>
  103. <tr class="separator:af087f965a61b5bfe74ffe7270c6522e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:acb5e0e5ae75a0e403c7d8830a62b436b"><td class="memItemLeft" align="right" valign="top"><a id="acb5e0e5ae75a0e403c7d8830a62b436b"></a>
  105. void()&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#acb5e0e5ae75a0e403c7d8830a62b436b">kr_dkr_BC</a> (double P, double &amp;v, double &amp;dv)</td></tr>
  106. <tr class="memdesc:acb5e0e5ae75a0e403c7d8830a62b436b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Brooks and Corey relative conductivity and its derivative setter. <br /></td></tr>
  107. <tr class="separator:acb5e0e5ae75a0e403c7d8830a62b436b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table><table class="memberdecls">
  109. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  110. Public Attributes</h2></td></tr>
  111. <tr class="memitem:a4c11513fe2acfc75582c051d27e72bbd"><td class="memItemLeft" align="right" valign="top"><a id="a4c11513fe2acfc75582c051d27e72bbd"></a>
  112. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a4c11513fe2acfc75582c051d27e72bbd">g</a></td></tr>
  113. <tr class="memdesc:a4c11513fe2acfc75582c051d27e72bbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gravity acceleration. <br /></td></tr>
  114. <tr class="separator:a4c11513fe2acfc75582c051d27e72bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a001776b79916d7a81a93a2e134cf779e"><td class="memItemLeft" align="right" valign="top"><a id="a001776b79916d7a81a93a2e134cf779e"></a>
  116. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a001776b79916d7a81a93a2e134cf779e">rho</a></td></tr>
  117. <tr class="memdesc:a001776b79916d7a81a93a2e134cf779e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fluid density. <br /></td></tr>
  118. <tr class="separator:a001776b79916d7a81a93a2e134cf779e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:aa58363bbb2feaf728ed6d31e05e7a957"><td class="memItemLeft" align="right" valign="top"><a id="aa58363bbb2feaf728ed6d31e05e7a957"></a>
  120. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#aa58363bbb2feaf728ed6d31e05e7a957">phi</a></td></tr>
  121. <tr class="memdesc:aa58363bbb2feaf728ed6d31e05e7a957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Porosity of the soil. <br /></td></tr>
  122. <tr class="separator:aa58363bbb2feaf728ed6d31e05e7a957"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ab1490c3d28e2576990646a6de56d358b"><td class="memItemLeft" align="right" valign="top"><a id="ab1490c3d28e2576990646a6de56d358b"></a>
  124. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#ab1490c3d28e2576990646a6de56d358b">k0</a></td></tr>
  125. <tr class="memdesc:ab1490c3d28e2576990646a6de56d358b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conductivity of the saturated soil. <br /></td></tr>
  126. <tr class="separator:ab1490c3d28e2576990646a6de56d358b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a5992a20f18d607ec172df4815c7299cc"><td class="memItemLeft" align="right" valign="top"><a id="a5992a20f18d607ec172df4815c7299cc"></a>
  128. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a5992a20f18d607ec172df4815c7299cc">nivrivsat</a></td></tr>
  129. <tr class="memdesc:a5992a20f18d607ec172df4815c7299cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Characterise the water pressure at the bottom of the overland water. <br /></td></tr>
  130. <tr class="separator:a5992a20f18d607ec172df4815c7299cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a65cddae93909986d331f5e592cde6dfe"><td class="memItemLeft" align="right" valign="top"><a id="a65cddae93909986d331f5e592cde6dfe"></a>
  132. double(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a65cddae93909986d331f5e592cde6dfe">s</a> )(double)</td></tr>
  133. <tr class="memdesc:a65cddae93909986d331f5e592cde6dfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the saturation in function of the pressure. <br /></td></tr>
  134. <tr class="separator:a65cddae93909986d331f5e592cde6dfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a354fbd584df73eead3873f188071c87a"><td class="memItemLeft" align="right" valign="top"><a id="a354fbd584df73eead3873f188071c87a"></a>
  136. double(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a354fbd584df73eead3873f188071c87a">ds</a> )(double)</td></tr>
  137. <tr class="memdesc:a354fbd584df73eead3873f188071c87a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the derivtive of the saturation in function of the pressure. <br /></td></tr>
  138. <tr class="separator:a354fbd584df73eead3873f188071c87a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:aec4d02772570ff1320e33f858f22875e"><td class="memItemLeft" align="right" valign="top"><a id="aec4d02772570ff1320e33f858f22875e"></a>
  140. void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#aec4d02772570ff1320e33f858f22875e">s_ds</a> )(double, double &amp;, double &amp;)</td></tr>
  141. <tr class="memdesc:aec4d02772570ff1320e33f858f22875e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the saturation and its derivative in function of the pressure. <br /></td></tr>
  142. <tr class="separator:aec4d02772570ff1320e33f858f22875e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:ad053182af1e0f57931f3eae4a181ba19"><td class="memItemLeft" align="right" valign="top"><a id="ad053182af1e0f57931f3eae4a181ba19"></a>
  144. double(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#ad053182af1e0f57931f3eae4a181ba19">kr</a> )(double)</td></tr>
  145. <tr class="memdesc:ad053182af1e0f57931f3eae4a181ba19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the relative conductivity in function of the pressure. <br /></td></tr>
  146. <tr class="separator:ad053182af1e0f57931f3eae4a181ba19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a26944c7092b333620c7698d38be78d84"><td class="memItemLeft" align="right" valign="top"><a id="a26944c7092b333620c7698d38be78d84"></a>
  148. double(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a26944c7092b333620c7698d38be78d84">dkr</a> )(double)</td></tr>
  149. <tr class="memdesc:a26944c7092b333620c7698d38be78d84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the derivtive of the relative conductivity in function of the pressure. <br /></td></tr>
  150. <tr class="separator:a26944c7092b333620c7698d38be78d84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:ac7d38942e7ab0a36439e271ad6643cd3"><td class="memItemLeft" align="right" valign="top"><a id="ac7d38942e7ab0a36439e271ad6643cd3"></a>
  152. void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#ac7d38942e7ab0a36439e271ad6643cd3">kr_dkr</a> )(double, double &amp;, double &amp;)</td></tr>
  153. <tr class="memdesc:ac7d38942e7ab0a36439e271ad6643cd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the relative conductivity and its derivative in function of the pressure. <br /></td></tr>
  154. <tr class="separator:ac7d38942e7ab0a36439e271ad6643cd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a8f03c01b41872e542b96c7c004802d5a"><td class="memItemLeft" align="right" valign="top"><a id="a8f03c01b41872e542b96c7c004802d5a"></a>
  156. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_physics.html#a8f03c01b41872e542b96c7c004802d5a">model_datas</a> [6]</td></tr>
  157. <tr class="memdesc:a8f03c01b41872e542b96c7c004802d5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Datas used to define the model. <br /></td></tr>
  158. <tr class="separator:a8f03c01b41872e542b96c7c004802d5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. </table>
  160. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  161. <div class="textblock"><p>The <a class="el" href="class_physics.html" title="The Physics class contains all physical parameters characterising the soil.">Physics</a> class contains all physical parameters characterising the soil. </p>
  162. <p class="definition">Definition at line <a class="el" href="physics_8hpp_source.html#l00024">24</a> of file <a class="el" href="physics_8hpp_source.html">physics.hpp</a>.</p>
  163. </div><hr/>The documentation for this class was generated from the following file:<ul>
  164. <li>src/<a class="el" href="physics_8hpp_source.html">physics.hpp</a></li>
  165. </ul>
  166. </div><!-- contents -->
  167. <!-- start footer part -->
  168. <hr class="footer"/><address class="footer"><small>
  169. Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
  170. </small></address>
  171. </body>
  172. </html>