tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt for version v0.7.1_rc2

Browse Source
This commit is contained in:
Emily M. Boudreaux
2025-11-28 09:46:00 -05:00
parent 033c5a083d
commit a472dc5214
2480 changed files with 231104 additions and 76191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

459
docs/html/structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html Normal file
View File

@@ -0,0 +1,459 @@
<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::engine::MultiscalePartitioningEngineView::QSEGroup Struct 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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.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">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::engine::MultiscalePartitioningEngineView::QSEGroup Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Struct representing a QSE group.
<a href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for gridfire::engine::MultiscalePartitioningEngineView::QSEGroup:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup__coll__graph.svg" width="230" height="271"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac9f99ea2754b419d030e92c314fba4ed" id="r_ac9f99ea2754b419d030e92c314fba4ed"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#ac9f99ea2754b419d030e92c314fba4ed">operator&lt;</a> (const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;other) const</td></tr>
<tr class="memdesc:ac9f99ea2754b419d030e92c314fba4ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Less-than operator for <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a>, used for sorting. <br /></td></tr>
<tr class="separator:ac9f99ea2754b419d030e92c314fba4ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc1710fde415de7a337dbec664b16e45" id="r_adc1710fde415de7a337dbec664b16e45"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#adc1710fde415de7a337dbec664b16e45">operator&gt;</a> (const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;other) const</td></tr>
<tr class="memdesc:adc1710fde415de7a337dbec664b16e45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Greater-than operator for <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a>. <br /></td></tr>
<tr class="separator:adc1710fde415de7a337dbec664b16e45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a846d372046454aa0ff97a4c83d85b96d" id="r_a846d372046454aa0ff97a4c83d85b96d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a846d372046454aa0ff97a4c83d85b96d">operator==</a> (const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;other) const</td></tr>
<tr class="memdesc:a846d372046454aa0ff97a4c83d85b96d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality operator for <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a>. <br /></td></tr>
<tr class="separator:a846d372046454aa0ff97a4c83d85b96d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ec476b65fcedc5e4eb603a18037bf25" id="r_a5ec476b65fcedc5e4eb603a18037bf25"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a5ec476b65fcedc5e4eb603a18037bf25">operator!=</a> (const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;other) const</td></tr>
<tr class="memdesc:a5ec476b65fcedc5e4eb603a18037bf25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inequality operator for <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a>. <br /></td></tr>
<tr class="separator:a5ec476b65fcedc5e4eb603a18037bf25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa56ff69de9025ce559202c06f95f8b6b" id="r_aa56ff69de9025ce559202c06f95f8b6b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#aa56ff69de9025ce559202c06f95f8b6b">toString</a> (bool verbose) const</td></tr>
<tr class="separator:aa56ff69de9025ce559202c06f95f8b6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64018f4dd6c225b0790a0fd4065a0972" id="r_a64018f4dd6c225b0790a0fd4065a0972"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a64018f4dd6c225b0790a0fd4065a0972">contains</a> (const fourdst::atomic::Species &amp;species) const</td></tr>
<tr class="memdesc:a64018f4dd6c225b0790a0fd4065a0972"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html">QSESolver</a> Member Functions ///. <br /></td></tr>
<tr class="separator:a64018f4dd6c225b0790a0fd4065a0972"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a553a39a2a8e6cea1d6f849cb7097fee6" id="r_a553a39a2a8e6cea1d6f849cb7097fee6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a553a39a2a8e6cea1d6f849cb7097fee6">containsAlgebraic</a> (const fourdst::atomic::Species &amp;species) const</td></tr>
<tr class="separator:a553a39a2a8e6cea1d6f849cb7097fee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa65229a4974b74ce4fc3f7c0544fbe91" id="r_aa65229a4974b74ce4fc3f7c0544fbe91"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#aa65229a4974b74ce4fc3f7c0544fbe91">containsSeed</a> (const fourdst::atomic::Species &amp;species) const</td></tr>
<tr class="separator:aa65229a4974b74ce4fc3f7c0544fbe91"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a7f4715e3f2f2b6cc35a94f0f4105db30" id="r_a7f4715e3f2f2b6cc35a94f0f4105db30"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a7f4715e3f2f2b6cc35a94f0f4105db30">is_in_equilibrium</a> = false</td></tr>
<tr class="memdesc:a7f4715e3f2f2b6cc35a94f0f4105db30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag set by flux analysis. <br /></td></tr>
<tr class="separator:a7f4715e3f2f2b6cc35a94f0f4105db30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d706c8d2a49910135d7c599ce645a9e" id="r_a4d706c8d2a49910135d7c599ce645a9e"><td class="memItemLeft" align="right" valign="top">std::set&lt; fourdst::atomic::Species &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a4d706c8d2a49910135d7c599ce645a9e">algebraic_species</a></td></tr>
<tr class="memdesc:a4d706c8d2a49910135d7c599ce645a9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Algebraic species in this group. <br /></td></tr>
<tr class="separator:a4d706c8d2a49910135d7c599ce645a9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9434050b990ecfa0459feebff3047ee2" id="r_a9434050b990ecfa0459feebff3047ee2"><td class="memItemLeft" align="right" valign="top">std::set&lt; fourdst::atomic::Species &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a9434050b990ecfa0459feebff3047ee2">seed_species</a></td></tr>
<tr class="memdesc:a9434050b990ecfa0459feebff3047ee2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dynamic species in this group. <br /></td></tr>
<tr class="separator:a9434050b990ecfa0459feebff3047ee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb89ee3a7eaaadba05b6e08a22f2e5d6" id="r_abb89ee3a7eaaadba05b6e08a22f2e5d6"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#abb89ee3a7eaaadba05b6e08a22f2e5d6">mean_timescale</a></td></tr>
<tr class="memdesc:abb89ee3a7eaaadba05b6e08a22f2e5d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mean timescale of the group. <br /></td></tr>
<tr class="separator:abb89ee3a7eaaadba05b6e08a22f2e5d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a37b41341696a780dbeee850919a56bf2" id="r_a37b41341696a780dbeee850919a56bf2"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html#a37b41341696a780dbeee850919a56bf2">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;group)</td></tr>
<tr class="separator:a37b41341696a780dbeee850919a56bf2"><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>Struct representing a QSE group. </p>
<dl class="section user"><dt>Purpose</dt><dd>A container to hold all information about a set of species that are potentially in quasi-steady-state equilibrium with each other. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a64018f4dd6c225b0790a0fd4065a0972" name="a64018f4dd6c225b0790a0fd4065a0972"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64018f4dd6c225b0790a0fd4065a0972">&#9670;&#160;</a></span>contains()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::contains </td>
<td>(</td>
<td class="paramtype">const fourdst::atomic::Species &amp;&#160;</td>
<td class="paramname"><em>species</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSESolver.html">QSESolver</a> Member Functions ///. </p>
</div>
</div>
<a id="a553a39a2a8e6cea1d6f849cb7097fee6" name="a553a39a2a8e6cea1d6f849cb7097fee6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a553a39a2a8e6cea1d6f849cb7097fee6">&#9670;&#160;</a></span>containsAlgebraic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::containsAlgebraic </td>
<td>(</td>
<td class="paramtype">const fourdst::atomic::Species &amp;&#160;</td>
<td class="paramname"><em>species</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa65229a4974b74ce4fc3f7c0544fbe91" name="aa65229a4974b74ce4fc3f7c0544fbe91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa65229a4974b74ce4fc3f7c0544fbe91">&#9670;&#160;</a></span>containsSeed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::containsSeed </td>
<td>(</td>
<td class="paramtype">const fourdst::atomic::Species &amp;&#160;</td>
<td class="paramname"><em>species</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5ec476b65fcedc5e4eb603a18037bf25" name="a5ec476b65fcedc5e4eb603a18037bf25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ec476b65fcedc5e4eb603a18037bf25">&#9670;&#160;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inequality operator for <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a> to compare to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the sets of species indices are not identical. </dd></dl>
</div>
</div>
<a id="ac9f99ea2754b419d030e92c314fba4ed" name="ac9f99ea2754b419d030e92c314fba4ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9f99ea2754b419d030e92c314fba4ed">&#9670;&#160;</a></span>operator&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::operator&lt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Less-than operator for <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a>, used for sorting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a> to compare to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if this group's mean timescale is less than the other's. </dd></dl>
</div>
</div>
<a id="a846d372046454aa0ff97a4c83d85b96d" name="a846d372046454aa0ff97a4c83d85b96d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a846d372046454aa0ff97a4c83d85b96d">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Equality operator for <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a>. </p>
<p><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a> Member Functions ///.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a> to compare to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the sets of species indices are identical. </dd></dl>
</div>
</div>
<a id="adc1710fde415de7a337dbec664b16e45" name="adc1710fde415de7a337dbec664b16e45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc1710fde415de7a337dbec664b16e45">&#9670;&#160;</a></span>operator&gt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::operator&gt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Greater-than operator for <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html" title="Struct representing a QSE group.">QSEGroup</a> to compare to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if this group's mean timescale is greater than the other's. </dd></dl>
</div>
</div>
<a id="aa56ff69de9025ce559202c06f95f8b6b" name="aa56ff69de9025ce559202c06f95f8b6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa56ff69de9025ce559202c06f95f8b6b">&#9670;&#160;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::toString </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>verbose</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a37b41341696a780dbeee850919a56bf2" name="a37b41341696a780dbeee850919a56bf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37b41341696a780dbeee850919a56bf2">&#9670;&#160;</a></span>operator&lt;&lt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a> &amp;&#160;</td>
<td class="paramname"><em>group</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4d706c8d2a49910135d7c599ce645a9e" name="a4d706c8d2a49910135d7c599ce645a9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d706c8d2a49910135d7c599ce645a9e">&#9670;&#160;</a></span>algebraic_species</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::set&lt;fourdst::atomic::Species&gt; gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::algebraic_species</td>
</tr>
</table>
</div><div class="memdoc">
<p>Algebraic species in this group. </p>
</div>
</div>
<a id="a7f4715e3f2f2b6cc35a94f0f4105db30" name="a7f4715e3f2f2b6cc35a94f0f4105db30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f4715e3f2f2b6cc35a94f0f4105db30">&#9670;&#160;</a></span>is_in_equilibrium</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::is_in_equilibrium = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag set by flux analysis. </p>
</div>
</div>
<a id="abb89ee3a7eaaadba05b6e08a22f2e5d6" name="abb89ee3a7eaaadba05b6e08a22f2e5d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb89ee3a7eaaadba05b6e08a22f2e5d6">&#9670;&#160;</a></span>mean_timescale</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::mean_timescale</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mean timescale of the group. </p>
</div>
</div>
<a id="a9434050b990ecfa0459feebff3047ee2" name="a9434050b990ecfa0459feebff3047ee2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9434050b990ecfa0459feebff3047ee2">&#9670;&#160;</a></span>seed_species</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::set&lt;fourdst::atomic::Species&gt; gridfire::engine::MultiscalePartitioningEngineView::QSEGroup::seed_species</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dynamic species in this group. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>src/include/gridfire/engine/views/<a class="el" href="engine__multiscale_8h.html">engine_multiscale.h</a></li>
<li>src/lib/engine/views/<a class="el" href="engine__multiscale_8cpp.html">engine_multiscale.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1engine.html">engine</a></li><li class="navelem"><a class="el" href="classgridfire_1_1engine_1_1MultiscalePartitioningEngineView.html">MultiscalePartitioningEngineView</a></li><li class="navelem"><a class="el" href="structgridfire_1_1engine_1_1MultiscalePartitioningEngineView_1_1QSEGroup.html">QSEGroup</a></li>
<li class="footer">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.8 </li>
</ul>
</div>
</body>
</html>