a00994.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503
  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" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.7"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Zibra Effects: ZibraSmokeAndFireSolverParameters Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js.txt"></script>
  11. <script type="text/javascript" src="dynsections.js.txt"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js.txt"></script>
  14. <script type="text/javascript" src="search/search.js.txt"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr id="projectrow">
  23. <td id="projectalign">
  24. <div id="projectname">Zibra Effects
  25. </div>
  26. <div id="projectbrief">Real-time Simulated Visual Effects</div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.7 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js.txt"></script>
  40. <script type="text/javascript" src="menu.js.txt"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. <div id="nav-path" class="navpath">
  70. <ul>
  71. <li class="navelem"><a class="el" href="a00335.html">com</a></li><li class="navelem"><a class="el" href="a00336.html">zibra</a></li><li class="navelem"><a class="el" href="a00360.html">smoke_and_fire</a></li><li class="navelem"><a class="el" href="a00361.html">DataStructures</a></li><li class="navelem"><a class="el" href="a00994.html">ZibraSmokeAndFireSolverParameters</a></li> </ul>
  72. </div>
  73. </div><!-- top -->
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#pub-attribs">Public Attributes</a> &#124;
  77. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  78. <a href="a00991.html">List of all members</a> </div>
  79. <div class="headertitle"><div class="title">ZibraSmokeAndFireSolverParameters Class Reference</div></div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Component that contains smoke/fire physics behaviour parameters.
  83. <a href="a00994.html#details">More...</a></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  86. Public Attributes</h2></td></tr>
  87. <tr class="memitem:ad3a855025d212c719d292cb6ce16bafc"><td class="memItemLeft" align="right" valign="top">Vector3&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ad3a855025d212c719d292cb6ce16bafc">Gravity</a> = new Vector3(0.0f, <a class="el" href="a00994.html#ad5b1c98de198f6556bb8b8feeb5e0c31">DEFAULT_GRAVITY</a>, 0.0f)</td></tr>
  88. <tr class="memdesc:ad3a855025d212c719d292cb6ce16bafc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the gravity vector inside the volume. <br /></td></tr>
  89. <tr class="separator:ad3a855025d212c719d292cb6ce16bafc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:aaeb873fa44fbecff2ebeb95b0871e415"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#aaeb873fa44fbecff2ebeb95b0871e415">SmokeBuoyancy</a> = 0.0f</td></tr>
  91. <tr class="memdesc:aaeb873fa44fbecff2ebeb95b0871e415"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls the strength of the buoyancy force applied to the smoke in the simulation. <br /></td></tr>
  92. <tr class="separator:aaeb873fa44fbecff2ebeb95b0871e415"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a59b4e65d490a0e891dd38312e718ddf1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a59b4e65d490a0e891dd38312e718ddf1">HeatBuoyancy</a> = 0.5f</td></tr>
  94. <tr class="memdesc:a59b4e65d490a0e891dd38312e718ddf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the strength of the upward force applied to heat in the simulation. <br /></td></tr>
  95. <tr class="separator:a59b4e65d490a0e891dd38312e718ddf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ac6da9dedc2700689e9b7888cc5fcf9f8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ac6da9dedc2700689e9b7888cc5fcf9f8">TempThreshold</a> = 0.18f</td></tr>
  97. <tr class="memdesc:ac6da9dedc2700689e9b7888cc5fcf9f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combustion threshold. As soon as fuel exceeds this threshold, fuel combustion reaction starts. <br /></td></tr>
  98. <tr class="separator:ac6da9dedc2700689e9b7888cc5fcf9f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ae740da185f94dd69f31bfcc5a28da7f8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ae740da185f94dd69f31bfcc5a28da7f8">HeatEmission</a> = 0.078f</td></tr>
  100. <tr class="memdesc:ae740da185f94dd69f31bfcc5a28da7f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rate of heat emission from the combustion reaction of the fuel in the simulation. <br /></td></tr>
  101. <tr class="separator:ae740da185f94dd69f31bfcc5a28da7f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a352824b3cf246e3b5e6d132d4626ecf7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a352824b3cf246e3b5e6d132d4626ecf7">ReactionSpeed</a> = 0.1f</td></tr>
  103. <tr class="memdesc:a352824b3cf246e3b5e6d132d4626ecf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rate at which combustion reaction occurs in the simulation. <br /></td></tr>
  104. <tr class="separator:a352824b3cf246e3b5e6d132d4626ecf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a20c587a478cfacd0c8ddf21730659308"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a20c587a478cfacd0c8ddf21730659308">MaximumVelocity</a> = <a class="el" href="a00994.html#abdcae01c463505c8b136c7d79f23fbbc">DEFAULT_MAX_VELOCITY</a></td></tr>
  106. <tr class="memdesc:a20c587a478cfacd0c8ddf21730659308"><td class="mdescLeft">&#160;</td><td class="mdescRight">The velocity limit of smoke/fuel. <br /></td></tr>
  107. <tr class="separator:a20c587a478cfacd0c8ddf21730659308"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a987baafffb0159de6d47ef7ff1e1041e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a987baafffb0159de6d47ef7ff1e1041e">MinimumVelocity</a> = 0.0f</td></tr>
  109. <tr class="memdesc:a987baafffb0159de6d47ef7ff1e1041e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the min velocity inside the volume. <br /></td></tr>
  110. <tr class="separator:a987baafffb0159de6d47ef7ff1e1041e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a28afaad3316fa76faed5e38e5a5e2a87"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a28afaad3316fa76faed5e38e5a5e2a87">Sharpen</a> = 0.2f</td></tr>
  112. <tr class="memdesc:a28afaad3316fa76faed5e38e5a5e2a87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strength of sharpening effect in the simulation. Higher values correspond to more detailed simulation, but can lead to visible aliasing. <br /></td></tr>
  113. <tr class="separator:a28afaad3316fa76faed5e38e5a5e2a87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a458fbc89ca211a413c0a20e445c1310e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a458fbc89ca211a413c0a20e445c1310e">SharpenThreshold</a> = 0.016f</td></tr>
  115. <tr class="memdesc:a458fbc89ca211a413c0a20e445c1310e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Threshold that differentiates between regions that need to be simulated more accurately. <br /></td></tr>
  116. <tr class="separator:a458fbc89ca211a413c0a20e445c1310e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a33457d6a2e6224e33862265cae43d7e8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a33457d6a2e6224e33862265cae43d7e8">ColorDecay</a> = 0.01f</td></tr>
  118. <tr class="memdesc:a33457d6a2e6224e33862265cae43d7e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This parameter is responsible for reducing the optical density of smoke with time. In case of the fire simulation mode this parameter is also responsible for controlling temperature decay. <br /></td></tr>
  119. <tr class="separator:a33457d6a2e6224e33862265cae43d7e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a001716b948208be6c6cd1e871c7cc1fa"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a001716b948208be6c6cd1e871c7cc1fa">VelocityDecay</a> = 0.005f</td></tr>
  121. <tr class="memdesc:a001716b948208be6c6cd1e871c7cc1fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the amount of velocity's fade off through volume. <br /></td></tr>
  122. <tr class="separator:a001716b948208be6c6cd1e871c7cc1fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a417910ac454e34da772e1cb914446f98"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a417910ac454e34da772e1cb914446f98">PressureReuse</a> = 0.95f</td></tr>
  124. <tr class="memdesc:a417910ac454e34da772e1cb914446f98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how much of the pressure data from previous simulation iteration gets reused to simulate current one. <br /></td></tr>
  125. <tr class="separator:a417910ac454e34da772e1cb914446f98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ac85398ce191195d8b67fb57859116477"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ac85398ce191195d8b67fb57859116477">PressureProjection</a> = 1.6f</td></tr>
  127. <tr class="memdesc:ac85398ce191195d8b67fb57859116477"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls viscosity/turbulence. <br /></td></tr>
  128. <tr class="separator:ac85398ce191195d8b67fb57859116477"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a60333e5c1045b9f84dbb1d157394a690"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a60333e5c1045b9f84dbb1d157394a690">PressureSolveIterations</a> = 1</td></tr>
  130. <tr class="memdesc:a60333e5c1045b9f84dbb1d157394a690"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of iterations used to compute the pressure. <br /></td></tr>
  131. <tr class="separator:a60333e5c1045b9f84dbb1d157394a690"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a311863b47409afb4a8f92d0317d81b1d"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a311863b47409afb4a8f92d0317d81b1d">PresetName</a> = &quot;&quot;</td></tr>
  133. <tr class="memdesc:a311863b47409afb4a8f92d0317d81b1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name for preset analytics. <br /></td></tr>
  134. <tr class="separator:a311863b47409afb4a8f92d0317d81b1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table><table class="memberdecls">
  136. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  137. Static Public Attributes</h2></td></tr>
  138. <tr class="memitem:abdcae01c463505c8b136c7d79f23fbbc"><td class="memItemLeft" align="right" valign="top">const float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#abdcae01c463505c8b136c7d79f23fbbc">DEFAULT_MAX_VELOCITY</a> = 10.0f</td></tr>
  139. <tr class="memdesc:abdcae01c463505c8b136c7d79f23fbbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default max velocity inside the volume. <br /></td></tr>
  140. <tr class="separator:abdcae01c463505c8b136c7d79f23fbbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a5c65770c611863a6e9e7b82527a2d1f2"><td class="memItemLeft" align="right" valign="top">const float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a5c65770c611863a6e9e7b82527a2d1f2">DEFAULT_VISCOSITY</a> = 0.392f</td></tr>
  142. <tr class="memdesc:a5c65770c611863a6e9e7b82527a2d1f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default velocity inside the volume. <br /></td></tr>
  143. <tr class="separator:a5c65770c611863a6e9e7b82527a2d1f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ad5b1c98de198f6556bb8b8feeb5e0c31"><td class="memItemLeft" align="right" valign="top">const float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ad5b1c98de198f6556bb8b8feeb5e0c31">DEFAULT_GRAVITY</a> = -9.81f</td></tr>
  145. <tr class="memdesc:ad5b1c98de198f6556bb8b8feeb5e0c31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default gravity inside the volume. <br /></td></tr>
  146. <tr class="separator:ad5b1c98de198f6556bb8b8feeb5e0c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table>
  148. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  149. <div class="textblock"><p>Component that contains smoke/fire physics behaviour parameters. </p>
  150. <p>It doesn't execute anything by itself, it is used by ZibraSmokeAndFire instead. </p>
  151. <p>It's separated so you can save and apply presets for this component separately. </p>
  152. </div><h2 class="groupheader">Member Data Documentation</h2>
  153. <a id="abdcae01c463505c8b136c7d79f23fbbc" name="abdcae01c463505c8b136c7d79f23fbbc"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#abdcae01c463505c8b136c7d79f23fbbc">&#9670;&#160;</a></span>DEFAULT_MAX_VELOCITY</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">const float DEFAULT_MAX_VELOCITY = 10.0f</td>
  163. </tr>
  164. </table>
  165. </td>
  166. <td class="mlabels-right">
  167. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Default max velocity inside the volume. </p>
  172. </div>
  173. </div>
  174. <a id="a5c65770c611863a6e9e7b82527a2d1f2" name="a5c65770c611863a6e9e7b82527a2d1f2"></a>
  175. <h2 class="memtitle"><span class="permalink"><a href="#a5c65770c611863a6e9e7b82527a2d1f2">&#9670;&#160;</a></span>DEFAULT_VISCOSITY</h2>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="mlabels">
  179. <tr>
  180. <td class="mlabels-left">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">const float DEFAULT_VISCOSITY = 0.392f</td>
  184. </tr>
  185. </table>
  186. </td>
  187. <td class="mlabels-right">
  188. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Default velocity inside the volume. </p>
  193. </div>
  194. </div>
  195. <a id="ad5b1c98de198f6556bb8b8feeb5e0c31" name="ad5b1c98de198f6556bb8b8feeb5e0c31"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#ad5b1c98de198f6556bb8b8feeb5e0c31">&#9670;&#160;</a></span>DEFAULT_GRAVITY</h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="mlabels">
  200. <tr>
  201. <td class="mlabels-left">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">const float DEFAULT_GRAVITY = -9.81f</td>
  205. </tr>
  206. </table>
  207. </td>
  208. <td class="mlabels-right">
  209. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Default gravity inside the volume. </p>
  214. </div>
  215. </div>
  216. <a id="ad3a855025d212c719d292cb6ce16bafc" name="ad3a855025d212c719d292cb6ce16bafc"></a>
  217. <h2 class="memtitle"><span class="permalink"><a href="#ad3a855025d212c719d292cb6ce16bafc">&#9670;&#160;</a></span>Gravity</h2>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">Vector3 Gravity = new Vector3(0.0f, <a class="el" href="a00994.html#ad5b1c98de198f6556bb8b8feeb5e0c31">DEFAULT_GRAVITY</a>, 0.0f)</td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Specifies the gravity vector inside the volume. </p>
  227. </div>
  228. </div>
  229. <a id="aaeb873fa44fbecff2ebeb95b0871e415" name="aaeb873fa44fbecff2ebeb95b0871e415"></a>
  230. <h2 class="memtitle"><span class="permalink"><a href="#aaeb873fa44fbecff2ebeb95b0871e415">&#9670;&#160;</a></span>SmokeBuoyancy</h2>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">float SmokeBuoyancy = 0.0f</td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <p>Controls the strength of the buoyancy force applied to the smoke in the simulation. </p>
  240. <p>Affects how quickly smoke rises or falls due to differences in density. </p>
  241. </div>
  242. </div>
  243. <a id="a59b4e65d490a0e891dd38312e718ddf1" name="a59b4e65d490a0e891dd38312e718ddf1"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#a59b4e65d490a0e891dd38312e718ddf1">&#9670;&#160;</a></span>HeatBuoyancy</h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">float HeatBuoyancy = 0.5f</td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>Determines the strength of the upward force applied to heat in the simulation. </p>
  254. <p>Affects the speed at which hot gases rise. </p>
  255. </div>
  256. </div>
  257. <a id="ac6da9dedc2700689e9b7888cc5fcf9f8" name="ac6da9dedc2700689e9b7888cc5fcf9f8"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#ac6da9dedc2700689e9b7888cc5fcf9f8">&#9670;&#160;</a></span>TempThreshold</h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">float TempThreshold = 0.18f</td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Combustion threshold. As soon as fuel exceeds this threshold, fuel combustion reaction starts. </p>
  268. </div>
  269. </div>
  270. <a id="ae740da185f94dd69f31bfcc5a28da7f8" name="ae740da185f94dd69f31bfcc5a28da7f8"></a>
  271. <h2 class="memtitle"><span class="permalink"><a href="#ae740da185f94dd69f31bfcc5a28da7f8">&#9670;&#160;</a></span>HeatEmission</h2>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">float HeatEmission = 0.078f</td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>Rate of heat emission from the combustion reaction of the fuel in the simulation. </p>
  281. </div>
  282. </div>
  283. <a id="a352824b3cf246e3b5e6d132d4626ecf7" name="a352824b3cf246e3b5e6d132d4626ecf7"></a>
  284. <h2 class="memtitle"><span class="permalink"><a href="#a352824b3cf246e3b5e6d132d4626ecf7">&#9670;&#160;</a></span>ReactionSpeed</h2>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="memname">
  288. <tr>
  289. <td class="memname">float ReactionSpeed = 0.1f</td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>Rate at which combustion reaction occurs in the simulation. </p>
  294. </div>
  295. </div>
  296. <a id="a20c587a478cfacd0c8ddf21730659308" name="a20c587a478cfacd0c8ddf21730659308"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#a20c587a478cfacd0c8ddf21730659308">&#9670;&#160;</a></span>MaximumVelocity</h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname">float MaximumVelocity = <a class="el" href="a00994.html#abdcae01c463505c8b136c7d79f23fbbc">DEFAULT_MAX_VELOCITY</a></td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>The velocity limit of smoke/fuel. </p>
  307. </div>
  308. </div>
  309. <a id="a987baafffb0159de6d47ef7ff1e1041e" name="a987baafffb0159de6d47ef7ff1e1041e"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#a987baafffb0159de6d47ef7ff1e1041e">&#9670;&#160;</a></span>MinimumVelocity</h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">float MinimumVelocity = 0.0f</td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Specifies the min velocity inside the volume. </p>
  320. </div>
  321. </div>
  322. <a id="a28afaad3316fa76faed5e38e5a5e2a87" name="a28afaad3316fa76faed5e38e5a5e2a87"></a>
  323. <h2 class="memtitle"><span class="permalink"><a href="#a28afaad3316fa76faed5e38e5a5e2a87">&#9670;&#160;</a></span>Sharpen</h2>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname">float Sharpen = 0.2f</td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Strength of sharpening effect in the simulation. Higher values correspond to more detailed simulation, but can lead to visible aliasing. </p>
  333. </div>
  334. </div>
  335. <a id="a458fbc89ca211a413c0a20e445c1310e" name="a458fbc89ca211a413c0a20e445c1310e"></a>
  336. <h2 class="memtitle"><span class="permalink"><a href="#a458fbc89ca211a413c0a20e445c1310e">&#9670;&#160;</a></span>SharpenThreshold</h2>
  337. <div class="memitem">
  338. <div class="memproto">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname">float SharpenThreshold = 0.016f</td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <p>Threshold that differentiates between regions that need to be simulated more accurately. </p>
  346. <p>This threshold is based on the average velocity of the gas. Lower values correspond to larger volume inside the simulation getting simulated more precisely but higher performance cost. </p>
  347. </div>
  348. </div>
  349. <a id="a33457d6a2e6224e33862265cae43d7e8" name="a33457d6a2e6224e33862265cae43d7e8"></a>
  350. <h2 class="memtitle"><span class="permalink"><a href="#a33457d6a2e6224e33862265cae43d7e8">&#9670;&#160;</a></span>ColorDecay</h2>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">float ColorDecay = 0.01f</td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <p>This parameter is responsible for reducing the optical density of smoke with time. In case of the fire simulation mode this parameter is also responsible for controlling temperature decay. </p>
  360. </div>
  361. </div>
  362. <a id="a001716b948208be6c6cd1e871c7cc1fa" name="a001716b948208be6c6cd1e871c7cc1fa"></a>
  363. <h2 class="memtitle"><span class="permalink"><a href="#a001716b948208be6c6cd1e871c7cc1fa">&#9670;&#160;</a></span>VelocityDecay</h2>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname">float VelocityDecay = 0.005f</td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. <p>Specifies the amount of velocity's fade off through volume. </p>
  373. </div>
  374. </div>
  375. <a id="a417910ac454e34da772e1cb914446f98" name="a417910ac454e34da772e1cb914446f98"></a>
  376. <h2 class="memtitle"><span class="permalink"><a href="#a417910ac454e34da772e1cb914446f98">&#9670;&#160;</a></span>PressureReuse</h2>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">float PressureReuse = 0.95f</td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Determines how much of the pressure data from previous simulation iteration gets reused to simulate current one. </p>
  386. <p>This threshold is based on the average velocity of the gas. Lower values correspond to larger volume inside the simulation getting simulated more precisely but higher performance cost. </p>
  387. </div>
  388. </div>
  389. <a id="ac85398ce191195d8b67fb57859116477" name="ac85398ce191195d8b67fb57859116477"></a>
  390. <h2 class="memtitle"><span class="permalink"><a href="#ac85398ce191195d8b67fb57859116477">&#9670;&#160;</a></span>PressureProjection</h2>
  391. <div class="memitem">
  392. <div class="memproto">
  393. <table class="memname">
  394. <tr>
  395. <td class="memname">float PressureProjection = 1.6f</td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Controls viscosity/turbulence. </p>
  400. <p>Values lower than 1.0 will result in the volume behaving more viscous. Values higher than 1.0 will enhance the turbulent behavior of the volume. </p>
  401. <p>To enforce physically correct behavior of the simulation this parameter needs to be set to 1.0. </p>
  402. <p>Simulation may become unstable when this is set too high. </p>
  403. </div>
  404. </div>
  405. <a id="a60333e5c1045b9f84dbb1d157394a690" name="a60333e5c1045b9f84dbb1d157394a690"></a>
  406. <h2 class="memtitle"><span class="permalink"><a href="#a60333e5c1045b9f84dbb1d157394a690">&#9670;&#160;</a></span>PressureSolveIterations</h2>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname">int PressureSolveIterations = 1</td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p>The number of iterations used to compute the pressure. </p>
  416. <p>Higher values correspond to more accurate simulation, but higher performance cost. </p>
  417. <p>Single iteration is sufficient for most cases. </p>
  418. </div>
  419. </div>
  420. <a id="a311863b47409afb4a8f92d0317d81b1d" name="a311863b47409afb4a8f92d0317d81b1d"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#a311863b47409afb4a8f92d0317d81b1d">&#9670;&#160;</a></span>PresetName</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">string PresetName = &quot;&quot;</td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <p>Name for preset analytics. </p>
  431. </div>
  432. </div>
  433. <hr/>The documentation for this class was generated from the following file:<ul>
  434. <li>Assets/Plugins/Zibra/Smoke and Fire/Scripts/DataStructures/ZibraSmokeAndFireSolverParameters.cs</li>
  435. </ul>
  436. </div><!-- contents -->
  437. <!-- start footer part -->
  438. <hr class="footer"/><address class="footer"><small>
  439. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
  440. </small></address>
  441. </body>
  442. </html>