| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <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.7"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Zibra Effects: ZibraSmokeAndFireSolverParameters Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js.txt"></script>
- <script type="text/javascript" src="dynsections.js.txt"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js.txt"></script>
- <script type="text/javascript" src="search/search.js.txt"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">Zibra Effects
- </div>
- <div id="projectbrief">Real-time Simulated Visual Effects</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.7 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js.txt"></script>
- <script type="text/javascript" src="menu.js.txt"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <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>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-attribs">Public Attributes</a> |
- <a href="#pub-static-attribs">Static Public Attributes</a> |
- <a href="a00991.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">ZibraSmokeAndFireSolverParameters Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p>Component that contains smoke/fire physics behaviour parameters.
- <a href="a00994.html#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr class="memitem:ad3a855025d212c719d292cb6ce16bafc"><td class="memItemLeft" align="right" valign="top">Vector3 </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>
- <tr class="memdesc:ad3a855025d212c719d292cb6ce16bafc"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the gravity vector inside the volume. <br /></td></tr>
- <tr class="separator:ad3a855025d212c719d292cb6ce16bafc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaeb873fa44fbecff2ebeb95b0871e415"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#aaeb873fa44fbecff2ebeb95b0871e415">SmokeBuoyancy</a> = 0.0f</td></tr>
- <tr class="memdesc:aaeb873fa44fbecff2ebeb95b0871e415"><td class="mdescLeft"> </td><td class="mdescRight">Controls the strength of the buoyancy force applied to the smoke in the simulation. <br /></td></tr>
- <tr class="separator:aaeb873fa44fbecff2ebeb95b0871e415"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a59b4e65d490a0e891dd38312e718ddf1"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a59b4e65d490a0e891dd38312e718ddf1">HeatBuoyancy</a> = 0.5f</td></tr>
- <tr class="memdesc:a59b4e65d490a0e891dd38312e718ddf1"><td class="mdescLeft"> </td><td class="mdescRight">Determines the strength of the upward force applied to heat in the simulation. <br /></td></tr>
- <tr class="separator:a59b4e65d490a0e891dd38312e718ddf1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac6da9dedc2700689e9b7888cc5fcf9f8"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ac6da9dedc2700689e9b7888cc5fcf9f8">TempThreshold</a> = 0.18f</td></tr>
- <tr class="memdesc:ac6da9dedc2700689e9b7888cc5fcf9f8"><td class="mdescLeft"> </td><td class="mdescRight">Combustion threshold. As soon as fuel exceeds this threshold, fuel combustion reaction starts. <br /></td></tr>
- <tr class="separator:ac6da9dedc2700689e9b7888cc5fcf9f8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae740da185f94dd69f31bfcc5a28da7f8"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ae740da185f94dd69f31bfcc5a28da7f8">HeatEmission</a> = 0.078f</td></tr>
- <tr class="memdesc:ae740da185f94dd69f31bfcc5a28da7f8"><td class="mdescLeft"> </td><td class="mdescRight">Rate of heat emission from the combustion reaction of the fuel in the simulation. <br /></td></tr>
- <tr class="separator:ae740da185f94dd69f31bfcc5a28da7f8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a352824b3cf246e3b5e6d132d4626ecf7"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a352824b3cf246e3b5e6d132d4626ecf7">ReactionSpeed</a> = 0.1f</td></tr>
- <tr class="memdesc:a352824b3cf246e3b5e6d132d4626ecf7"><td class="mdescLeft"> </td><td class="mdescRight">Rate at which combustion reaction occurs in the simulation. <br /></td></tr>
- <tr class="separator:a352824b3cf246e3b5e6d132d4626ecf7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a20c587a478cfacd0c8ddf21730659308"><td class="memItemLeft" align="right" valign="top">float </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>
- <tr class="memdesc:a20c587a478cfacd0c8ddf21730659308"><td class="mdescLeft"> </td><td class="mdescRight">The velocity limit of smoke/fuel. <br /></td></tr>
- <tr class="separator:a20c587a478cfacd0c8ddf21730659308"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a987baafffb0159de6d47ef7ff1e1041e"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a987baafffb0159de6d47ef7ff1e1041e">MinimumVelocity</a> = 0.0f</td></tr>
- <tr class="memdesc:a987baafffb0159de6d47ef7ff1e1041e"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the min velocity inside the volume. <br /></td></tr>
- <tr class="separator:a987baafffb0159de6d47ef7ff1e1041e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a28afaad3316fa76faed5e38e5a5e2a87"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a28afaad3316fa76faed5e38e5a5e2a87">Sharpen</a> = 0.2f</td></tr>
- <tr class="memdesc:a28afaad3316fa76faed5e38e5a5e2a87"><td class="mdescLeft"> </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>
- <tr class="separator:a28afaad3316fa76faed5e38e5a5e2a87"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a458fbc89ca211a413c0a20e445c1310e"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a458fbc89ca211a413c0a20e445c1310e">SharpenThreshold</a> = 0.016f</td></tr>
- <tr class="memdesc:a458fbc89ca211a413c0a20e445c1310e"><td class="mdescLeft"> </td><td class="mdescRight">Threshold that differentiates between regions that need to be simulated more accurately. <br /></td></tr>
- <tr class="separator:a458fbc89ca211a413c0a20e445c1310e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a33457d6a2e6224e33862265cae43d7e8"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a33457d6a2e6224e33862265cae43d7e8">ColorDecay</a> = 0.01f</td></tr>
- <tr class="memdesc:a33457d6a2e6224e33862265cae43d7e8"><td class="mdescLeft"> </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>
- <tr class="separator:a33457d6a2e6224e33862265cae43d7e8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a001716b948208be6c6cd1e871c7cc1fa"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a001716b948208be6c6cd1e871c7cc1fa">VelocityDecay</a> = 0.005f</td></tr>
- <tr class="memdesc:a001716b948208be6c6cd1e871c7cc1fa"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the amount of velocity's fade off through volume. <br /></td></tr>
- <tr class="separator:a001716b948208be6c6cd1e871c7cc1fa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a417910ac454e34da772e1cb914446f98"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a417910ac454e34da772e1cb914446f98">PressureReuse</a> = 0.95f</td></tr>
- <tr class="memdesc:a417910ac454e34da772e1cb914446f98"><td class="mdescLeft"> </td><td class="mdescRight">Determines how much of the pressure data from previous simulation iteration gets reused to simulate current one. <br /></td></tr>
- <tr class="separator:a417910ac454e34da772e1cb914446f98"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac85398ce191195d8b67fb57859116477"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ac85398ce191195d8b67fb57859116477">PressureProjection</a> = 1.6f</td></tr>
- <tr class="memdesc:ac85398ce191195d8b67fb57859116477"><td class="mdescLeft"> </td><td class="mdescRight">Controls viscosity/turbulence. <br /></td></tr>
- <tr class="separator:ac85398ce191195d8b67fb57859116477"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a60333e5c1045b9f84dbb1d157394a690"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a60333e5c1045b9f84dbb1d157394a690">PressureSolveIterations</a> = 1</td></tr>
- <tr class="memdesc:a60333e5c1045b9f84dbb1d157394a690"><td class="mdescLeft"> </td><td class="mdescRight">The number of iterations used to compute the pressure. <br /></td></tr>
- <tr class="separator:a60333e5c1045b9f84dbb1d157394a690"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a311863b47409afb4a8f92d0317d81b1d"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a311863b47409afb4a8f92d0317d81b1d">PresetName</a> = ""</td></tr>
- <tr class="memdesc:a311863b47409afb4a8f92d0317d81b1d"><td class="mdescLeft"> </td><td class="mdescRight">Name for preset analytics. <br /></td></tr>
- <tr class="separator:a311863b47409afb4a8f92d0317d81b1d"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
- Static Public Attributes</h2></td></tr>
- <tr class="memitem:abdcae01c463505c8b136c7d79f23fbbc"><td class="memItemLeft" align="right" valign="top">const float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#abdcae01c463505c8b136c7d79f23fbbc">DEFAULT_MAX_VELOCITY</a> = 10.0f</td></tr>
- <tr class="memdesc:abdcae01c463505c8b136c7d79f23fbbc"><td class="mdescLeft"> </td><td class="mdescRight">Default max velocity inside the volume. <br /></td></tr>
- <tr class="separator:abdcae01c463505c8b136c7d79f23fbbc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5c65770c611863a6e9e7b82527a2d1f2"><td class="memItemLeft" align="right" valign="top">const float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#a5c65770c611863a6e9e7b82527a2d1f2">DEFAULT_VISCOSITY</a> = 0.392f</td></tr>
- <tr class="memdesc:a5c65770c611863a6e9e7b82527a2d1f2"><td class="mdescLeft"> </td><td class="mdescRight">Default velocity inside the volume. <br /></td></tr>
- <tr class="separator:a5c65770c611863a6e9e7b82527a2d1f2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad5b1c98de198f6556bb8b8feeb5e0c31"><td class="memItemLeft" align="right" valign="top">const float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00994.html#ad5b1c98de198f6556bb8b8feeb5e0c31">DEFAULT_GRAVITY</a> = -9.81f</td></tr>
- <tr class="memdesc:ad5b1c98de198f6556bb8b8feeb5e0c31"><td class="mdescLeft"> </td><td class="mdescRight">Default gravity inside the volume. <br /></td></tr>
- <tr class="separator:ad5b1c98de198f6556bb8b8feeb5e0c31"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Component that contains smoke/fire physics behaviour parameters. </p>
- <p>It doesn't execute anything by itself, it is used by ZibraSmokeAndFire instead. </p>
- <p>It's separated so you can save and apply presets for this component separately. </p>
- </div><h2 class="groupheader">Member Data Documentation</h2>
- <a id="abdcae01c463505c8b136c7d79f23fbbc" name="abdcae01c463505c8b136c7d79f23fbbc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abdcae01c463505c8b136c7d79f23fbbc">◆ </a></span>DEFAULT_MAX_VELOCITY</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const float DEFAULT_MAX_VELOCITY = 10.0f</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Default max velocity inside the volume. </p>
- </div>
- </div>
- <a id="a5c65770c611863a6e9e7b82527a2d1f2" name="a5c65770c611863a6e9e7b82527a2d1f2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5c65770c611863a6e9e7b82527a2d1f2">◆ </a></span>DEFAULT_VISCOSITY</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const float DEFAULT_VISCOSITY = 0.392f</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Default velocity inside the volume. </p>
- </div>
- </div>
- <a id="ad5b1c98de198f6556bb8b8feeb5e0c31" name="ad5b1c98de198f6556bb8b8feeb5e0c31"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad5b1c98de198f6556bb8b8feeb5e0c31">◆ </a></span>DEFAULT_GRAVITY</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const float DEFAULT_GRAVITY = -9.81f</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Default gravity inside the volume. </p>
- </div>
- </div>
- <a id="ad3a855025d212c719d292cb6ce16bafc" name="ad3a855025d212c719d292cb6ce16bafc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad3a855025d212c719d292cb6ce16bafc">◆ </a></span>Gravity</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Vector3 Gravity = new Vector3(0.0f, <a class="el" href="a00994.html#ad5b1c98de198f6556bb8b8feeb5e0c31">DEFAULT_GRAVITY</a>, 0.0f)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Specifies the gravity vector inside the volume. </p>
- </div>
- </div>
- <a id="aaeb873fa44fbecff2ebeb95b0871e415" name="aaeb873fa44fbecff2ebeb95b0871e415"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aaeb873fa44fbecff2ebeb95b0871e415">◆ </a></span>SmokeBuoyancy</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float SmokeBuoyancy = 0.0f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Controls the strength of the buoyancy force applied to the smoke in the simulation. </p>
- <p>Affects how quickly smoke rises or falls due to differences in density. </p>
- </div>
- </div>
- <a id="a59b4e65d490a0e891dd38312e718ddf1" name="a59b4e65d490a0e891dd38312e718ddf1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a59b4e65d490a0e891dd38312e718ddf1">◆ </a></span>HeatBuoyancy</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float HeatBuoyancy = 0.5f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Determines the strength of the upward force applied to heat in the simulation. </p>
- <p>Affects the speed at which hot gases rise. </p>
- </div>
- </div>
- <a id="ac6da9dedc2700689e9b7888cc5fcf9f8" name="ac6da9dedc2700689e9b7888cc5fcf9f8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac6da9dedc2700689e9b7888cc5fcf9f8">◆ </a></span>TempThreshold</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float TempThreshold = 0.18f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Combustion threshold. As soon as fuel exceeds this threshold, fuel combustion reaction starts. </p>
- </div>
- </div>
- <a id="ae740da185f94dd69f31bfcc5a28da7f8" name="ae740da185f94dd69f31bfcc5a28da7f8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae740da185f94dd69f31bfcc5a28da7f8">◆ </a></span>HeatEmission</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float HeatEmission = 0.078f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Rate of heat emission from the combustion reaction of the fuel in the simulation. </p>
- </div>
- </div>
- <a id="a352824b3cf246e3b5e6d132d4626ecf7" name="a352824b3cf246e3b5e6d132d4626ecf7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a352824b3cf246e3b5e6d132d4626ecf7">◆ </a></span>ReactionSpeed</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float ReactionSpeed = 0.1f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Rate at which combustion reaction occurs in the simulation. </p>
- </div>
- </div>
- <a id="a20c587a478cfacd0c8ddf21730659308" name="a20c587a478cfacd0c8ddf21730659308"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a20c587a478cfacd0c8ddf21730659308">◆ </a></span>MaximumVelocity</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float MaximumVelocity = <a class="el" href="a00994.html#abdcae01c463505c8b136c7d79f23fbbc">DEFAULT_MAX_VELOCITY</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The velocity limit of smoke/fuel. </p>
- </div>
- </div>
- <a id="a987baafffb0159de6d47ef7ff1e1041e" name="a987baafffb0159de6d47ef7ff1e1041e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a987baafffb0159de6d47ef7ff1e1041e">◆ </a></span>MinimumVelocity</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float MinimumVelocity = 0.0f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Specifies the min velocity inside the volume. </p>
- </div>
- </div>
- <a id="a28afaad3316fa76faed5e38e5a5e2a87" name="a28afaad3316fa76faed5e38e5a5e2a87"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a28afaad3316fa76faed5e38e5a5e2a87">◆ </a></span>Sharpen</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float Sharpen = 0.2f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Strength of sharpening effect in the simulation. Higher values correspond to more detailed simulation, but can lead to visible aliasing. </p>
- </div>
- </div>
- <a id="a458fbc89ca211a413c0a20e445c1310e" name="a458fbc89ca211a413c0a20e445c1310e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a458fbc89ca211a413c0a20e445c1310e">◆ </a></span>SharpenThreshold</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float SharpenThreshold = 0.016f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Threshold that differentiates between regions that need to be simulated more accurately. </p>
- <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>
- </div>
- </div>
- <a id="a33457d6a2e6224e33862265cae43d7e8" name="a33457d6a2e6224e33862265cae43d7e8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a33457d6a2e6224e33862265cae43d7e8">◆ </a></span>ColorDecay</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float ColorDecay = 0.01f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="a001716b948208be6c6cd1e871c7cc1fa" name="a001716b948208be6c6cd1e871c7cc1fa"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a001716b948208be6c6cd1e871c7cc1fa">◆ </a></span>VelocityDecay</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float VelocityDecay = 0.005f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Specifies the amount of velocity's fade off through volume. </p>
- </div>
- </div>
- <a id="a417910ac454e34da772e1cb914446f98" name="a417910ac454e34da772e1cb914446f98"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a417910ac454e34da772e1cb914446f98">◆ </a></span>PressureReuse</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float PressureReuse = 0.95f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Determines how much of the pressure data from previous simulation iteration gets reused to simulate current one. </p>
- <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>
- </div>
- </div>
- <a id="ac85398ce191195d8b67fb57859116477" name="ac85398ce191195d8b67fb57859116477"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac85398ce191195d8b67fb57859116477">◆ </a></span>PressureProjection</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float PressureProjection = 1.6f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Controls viscosity/turbulence. </p>
- <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>
- <p>To enforce physically correct behavior of the simulation this parameter needs to be set to 1.0. </p>
- <p>Simulation may become unstable when this is set too high. </p>
- </div>
- </div>
- <a id="a60333e5c1045b9f84dbb1d157394a690" name="a60333e5c1045b9f84dbb1d157394a690"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a60333e5c1045b9f84dbb1d157394a690">◆ </a></span>PressureSolveIterations</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int PressureSolveIterations = 1</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The number of iterations used to compute the pressure. </p>
- <p>Higher values correspond to more accurate simulation, but higher performance cost. </p>
- <p>Single iteration is sufficient for most cases. </p>
- </div>
- </div>
- <a id="a311863b47409afb4a8f92d0317d81b1d" name="a311863b47409afb4a8f92d0317d81b1d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a311863b47409afb4a8f92d0317d81b1d">◆ </a></span>PresetName</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string PresetName = ""</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Name for preset analytics. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>Assets/Plugins/Zibra/Smoke and Fire/Scripts/DataStructures/ZibraSmokeAndFireSolverParameters.cs</li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
- </small></address>
- </body>
- </html>
|