<html xmlns="http://www.w3.org/1999/xhtml">

<script async src="https://www.googletagmanager.com/gtag/js?id=G-SY496B9L99"></script>

window.dataLayer = window.dataLayer || [];

function gtag(){dataLayer.push(arguments);}

gtag('js', new Date());

gtag('config', 'G-SY496B9L99');

<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

<meta http-equiv="X-UA-Compatible" content="IE=9"/>

<meta name="generator" content="Doxygen 1.16.1"/>

<meta name="viewport" content="width=device-width, initial-scale=1"/>

<title>MFC: Graph Legend</title>

<meta name="description" content="Graph Legend — MFC documentation. Open-source exascale multiphase flow solver." />

<meta name="keywords" content="exascale, fluid dynamics, cfd, computational fluid dynamics, compressible, hpc, bryngelson, colonius, subgrid, multiphase, frontier, summit, el capitan, aurora, amd gpu, gpu, nvidia"/>

<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="navtreedata.js"></script>

<script type="text/javascript" src="navtree.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>

<script type="text/x-mathjax-config">

extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],

jax: ["input/TeX","output/HTML-CSS"],

extensions: ["tex2jax.js"],

jax: ["input/TeX", "output/HTML-CSS"],

tex2jax: {

inlineMath: [ ['$', '$'], ["\\(","\\)"] ],

displayMath: [ ['$$','$$'], ["\\[","\\]"] ],

processEscapes: true,

ignoreClass: "line" // Ignore code blocks: https://web.archive.org/web/20120430100225/http://www.mathjax.org/docs/1.1/options/tex2jax.html

},

"HTML-CSS": {

fonts: ["TeX"]

}

<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>

<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link rel="shortcut icon" href="icon.ico" type="image/x-icon" />

<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>

<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>

<link href="custom.css" rel="stylesheet" type="text/css"/>

<div id="top"><!-- do not remove this div, it is closed by doxygen! -->

<div id="titlearea">

<table cellspacing="0" cellpadding="0">

<tbody>

<tr style="height: 56px;">

<td id="projectlogo"><img alt="Logo" src="icon.ico"/></td>

<td id="projectalign" style="padding-left: 0.5em;">

<div id="projectname">MFC

</div>

<div id="projectbrief">Exascale flow solver</div>

</td>

</tr>

</tbody>

document.addEventListener('DOMContentLoaded', function() {

var nav = document.createElement('div');

nav.id = 'mfc-nav';

var items = [

['../documentation/index.html', 'documentation', 'User Guide'],

['../api/index.html', 'api', 'API Documentation']

];

var path = window.location.pathname;

var apiPaths = ['/api/', '/pre_process/', '/simulation/', '/post_process/'];

for (var i = 0; i < items.length; i++) {

var a = document.createElement('a');

a.href = items[i][0];

a.textContent = items[i][2];

if (items[i][1] === 'api') {

for (var j = 0; j < apiPaths.length; j++) {

if (path.indexOf(apiPaths[j]) !== -1) { a.className = 'active'; break; }

}

} else {

if (path.indexOf('/' + items[i][1] + '/') !== -1) a.className = 'active';

}

nav.appendChild(a);

}

var sideNav = document.getElementById('side-nav');

if (sideNav) sideNav.insertBefore(nav, sideNav.firstChild);

<script type="text/javascript">

var searchBox = new SearchBox("searchBox", "search/",'.html');

<script type="text/javascript">

$(function() { codefold.init(); });

<script type="text/javascript" src="menudata.js"></script>

<script type="text/javascript" src="menu.js"></script>

<script type="text/javascript">

$(function() {

initMenu('',true,false,'search.php','Search',true);

$(function() { init_search(); });

<div id="main-nav"></div>

<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>

<script type="text/javascript">

$(function(){initNavTree('graph_legend.html','',''); });

<div id="container">

<div id="doc-content">

<div id="MSearchSelectWindow"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

onkeydown="return searchBox.OnSearchSelectKey(event)">

<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 class="header">

<div class="headertitle"><div class="title">Graph Legend</div></div>

<div class="contents">

<p>This page explains how to interpret the graphs that are generated by doxygen.</p>

<p>Consider the following example: </p><div class="fragment"><div class="line"><span class="comment">/*! Invisible class because of truncation */</span></div>

<div class="line"><span class="keyword">class </span>Invisible { };</div>

<div class="line"><span class="comment"></span> </div>

<div class="line"><span class="comment">/*! Truncated class, inheritance relation is hidden */</span></div>

<div class="line"><span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };</div>

<div class="line"> </div>

<div class="line"><span class="comment">/* Class not documented with doxygen comments */</span></div>

<div class="line"><span class="keyword">class </span>Undocumented { };</div>

<div class="line"><span class="comment"></span> </div>

<div class="line"><span class="comment">/*! Class that is inherited using public inheritance */</span></div>

<div class="line"><span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };</div>

<div class="line"><span class="comment"></span> </div>

<div class="line"><span class="comment">/*! A template class */</span></div>

<div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };</div>

<div class="line"><span class="comment"></span> </div>

<div class="line"><span class="comment">/*! Class that is inherited using protected inheritance */</span></div>

<div class="line"><span class="keyword">class </span>ProtectedBase { };</div>

<div class="line"><span class="comment"></span> </div>

<div class="line"><span class="comment">/*! Class that is inherited using private inheritance */</span></div>

<div class="line"><span class="keyword">class </span>PrivateBase { };</div>

<div class="line"><span class="comment"></span> </div>

<div class="line"><span class="comment">/*! Class that is used by the Inherited class */</span></div>

<div class="line"><span class="keyword">class </span>Used { };</div>

<div class="line"><span class="comment"></span> </div>

<div class="line"><span class="comment">/*! Super class that inherits a number of other classes */</span></div>

<div class="line"><span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,</div>

<div class="line"> <span class="keyword">protected</span> ProtectedBase,</div>

<div class="line"> <span class="keyword">private</span> PrivateBase,</div>

<div class="line"> <span class="keyword">public</span> Undocumented,</div>

<div class="line"> <span class="keyword">public</span> Templ&lt;int&gt;</div>

<div class="line">{</div>

<div class="line"> <span class="keyword">private</span>:</div>

<div class="line"> Used *m_usedClass;</div>

<div class="line">};</div>

</div><!-- fragment --><p> This will result in the following graph:</p>

<center><iframe scrolling="no" loading="lazy" frameborder="0" src="graph_legend.svg" width="720" height="224"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></center><p>The boxes in the above graph have the following meaning: </p>

A filled gray box represents the struct or class for which the graph is generated. </li>

A box with a black border denotes a documented struct or class. </li>

A box with a gray border denotes an undocumented struct or class. </li>

A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries. </li>

<p>The arrows have the following meaning: </p>

A blue arrow is used to visualize a public inheritance relation between two classes. </li>

A dark green arrow is used for protected inheritance. </li>

A dark red arrow is used for private inheritance. </li>

A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible. </li>

A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance. </li>

<div id="nav-path" class="navpath">

<ul></ul>