Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rjsheperd
rjsheperd committed Jan 11, 2025
1 parent dc3a05f commit 1a1b2c6
Show file tree
Hide file tree
Showing 378 changed files with 47,660 additions and 2,764 deletions.
128 changes: 128 additions & 0 deletions docs/_contain_8cpp.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
<!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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Behave: src/behave/Contain.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">Behave
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_f4e4da3920ec0a9cab000518c13815eb.html">behave</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">Contain.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>An implementation of the Fried and Fried containemnt model.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="_contain_8h_source.html">Contain.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_contain_force_8h_source.html">ContainForce.h</a>&quot;</code><br />
<code>#include &lt;math.h&gt;</code><br />
<code>#include &lt;stdarg.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;memory.h&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae71449b1cc6e6250b91f539153a7a0d3" id="r_ae71449b1cc6e6250b91f539153a7a0d3"><td class="memItemLeft" align="right" valign="top"><a id="ae71449b1cc6e6250b91f539153a7a0d3" name="ae71449b1cc6e6250b91f539153a7a0d3"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>M_PI</b>&#160;&#160;&#160;3.141592654</td></tr>
<tr class="memdesc:ae71449b1cc6e6250b91f539153a7a0d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">A well rounded number. <br /></td></tr>
<tr class="separator:ae71449b1cc6e6250b91f539153a7a0d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An implementation of the Fried and Fried containemnt model. </p>
<dl class="section author"><dt>Author</dt><dd>Copyright (C) 2006 by Collin D. Bevins. \license This is released under the GNU Public License 2. </dd></dl>
<p>This is a fire containment algorithm based upon the paper Fried, Jeremy S. and Fried, Burton D. 1995. <em>Simulating wildfire containment with realistic tactics.</em> and heavily adapted from the FCAT Fire Containment Algorithm Test Pascal program by Jeremy S. Fried (1991).</p>
<p>Primary assumptions are that the fire is growing under uniform fuel, terrain, and weather conditions, resulting in a steadily growing elliptical fire (except where contained).</p>
<p>Containment "tactics" may be either head or rear attack. Containment resources are evenly divided and applied to each flank.</p>
<p>All times (elapsed, resource arrival, containment time, etc) are from when the fire was first <b>reported</b>. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
134 changes: 134 additions & 0 deletions docs/_contain_8h.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<!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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Behave: src/behave/Contain.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">Behave
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_f4e4da3920ec0a9cab000518c13815eb.html">behave</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle"><div class="title">Contain.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>An implementation of Freid and Fried (friedfried1995) wildfire containment model.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="_contain_force_8h_source.html">ContainForce.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_contain_resource_8h_source.html">ContainResource.h</a>&quot;</code><br />
</div>
<p><a href="_contain_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sem_1_1_contain.html">Sem::Contain</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fire flank (half-a-fire) containment object. <a href="class_sem_1_1_contain.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An implementation of Freid and Fried (friedfried1995) wildfire containment model. </p>
<dl class="section author"><dt>Author</dt><dd>Copyright (C) 2006 by Collin D. Bevins. \license This is released under the GNU Public License 2. </dd></dl>
<p>This is a fire containment algorithm based upon the paper Fried, Jeremy S. and Fried, Burton D. 199?. Simulating wildfire containment with realistic tactics. and heavily adapted from the FCAT Fire Containment Algorithm Test Pascal program by Jeremy S. Fried (1991).</p>
<p>Primary assumptions are that the fire is growing under uniform fuel, terrain, and weather conditions, resulting in a steadily growing elliptical fire (except where contained).</p>
<p>Containment "tactics" may be either head or tail attack. Containment production rates apply to a single flank. One flank is simulated and the other is considered to be a mirror image.</p>
<p>All times (elapsed, resource arrival, containment time, etc) are from when the fire was first <b>REPORTED</b>.</p>
<p>Simulation proceeds according to some fixed distance step (to achieve the min-max step range) and ends when</p><ul>
<li>the fire is contained by 1 or more of the resources,</li>
<li>the fire overruns the resources (and there is no retry), or</li>
<li>all the resources are exhausted.</li>
</ul>
<p>Four 4 classes of objects are used</p>
<p>1 The ContainResource Class describes a single fire containment resource unit that can be dispatched to the fire, such as an engine crew, line crew, bulldozer, helicopter, airtanker, type I crew, etc. Attributes include arrival time at the fire, line production rate, and production duration. There is also a Flank attribute (if the application wishes to use two- flank simulation, which hasn't really been tried yet), which can also be used to "turn off" a resource by setting it to NeitherFlank.</p>
<p>2 The ContainForce Class is the collection of all ContainResources available for use on the fire.</p>
<p>3 The Contain Class includes just the core simulation methods needed to make a single simulation pass for a single flank ala Fried. It includes the initial fire conditions, attack tactics, simulation step size, and attack point at the current time step. The fire is assumed to grow in an elliptical shape, e.g., under uniform terrain, fuels, and weather throughout the attack.</p>
<p>4 The ContainSim Class has all the attributes to control multiple simulation passes (to achieve a desired number of perimeter points or to retry an attack after an initial failure), and accumulate perimeter points at each simulation step. It also has two Contain objects, one each for the left and right flanks. Currently only the left flank object is used and the right flank is presumed to be a mirror image of the left flank. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Loading

0 comments on commit 1a1b2c6

Please sign in to comment.