tboudreaux/stroid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
stroid/docs/html/namespacestroid_1_1_i_o.html

313 lines
16 KiB
HTML
Raw Permalink Blame History

<!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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stroid: stroid::IO Namespace Reference</title>
<link rel="icon" href="Logo.png" type="image/x-icon" />
<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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<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" />
<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="projectlogo"><img alt="Logo" src="Logo.png"/></td>
<td id="projectalign">
<div id="projectname">stroid<span id="projectnumber">&#160;v0.1.0</span>
</div>
<div id="projectbrief">Multi-block curvilinear mesh generation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<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',true);
$(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 */
$(function(){initNavTree('namespacestroid_1_1_i_o.html',''); initResizable(true); });
/* @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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">stroid::IO Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ad4048304d8a0c7075d2b2a6e465d0b6e" id="r_ad4048304d8a0c7075d2b2a6e465d0b6e"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6e">VISUALIZATION_MODE</a> : uint8_t { <a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6eab50339a10e1de285ac99d4c3990b8693">NONE</a>
, <a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf">ELEMENT_ID</a>
, <a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6eaee96e14c2b71bd59252006289ba464cf">BOUNDARY_ELEMENT_ID</a>
}</td></tr>
<tr class="memdesc:ad4048304d8a0c7075d2b2a6e465d0b6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visualization modes for GLVis display. <a href="#ad4048304d8a0c7075d2b2a6e465d0b6e">More...</a><br /></td></tr>
<tr class="separator:ad4048304d8a0c7075d2b2a6e465d0b6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aeb567ddc70ff2d064c139dee87575830" id="r_aeb567ddc70ff2d064c139dee87575830"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb567ddc70ff2d064c139dee87575830">SaveMesh</a> (const mfem::Mesh &amp;mesh, const std::string &amp;filename)</td></tr>
<tr class="memdesc:aeb567ddc70ff2d064c139dee87575830"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save a mesh to MFEM's native <code>.mesh</code> format. <br /></td></tr>
<tr class="separator:aeb567ddc70ff2d064c139dee87575830"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4c8bda7ab370e34376a7832fbf0951e" id="r_ab4c8bda7ab370e34376a7832fbf0951e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4c8bda7ab370e34376a7832fbf0951e">SaveVTU</a> (mfem::Mesh &amp;mesh, const std::string &amp;exportName)</td></tr>
<tr class="memdesc:ab4c8bda7ab370e34376a7832fbf0951e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save a mesh as a ParaView VTU dataset. <br /></td></tr>
<tr class="separator:ab4c8bda7ab370e34376a7832fbf0951e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a496f5c16eaffda5922a0b96c1f525dab" id="r_a496f5c16eaffda5922a0b96c1f525dab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a496f5c16eaffda5922a0b96c1f525dab">ViewMesh</a> (mfem::Mesh &amp;mesh, const std::string &amp;title, <a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6e">VISUALIZATION_MODE</a> mode, const std::string &amp;vishost, int visport)</td></tr>
<tr class="memdesc:a496f5c16eaffda5922a0b96c1f525dab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stream a mesh to a running GLVis server for interactive viewing. <br /></td></tr>
<tr class="separator:a496f5c16eaffda5922a0b96c1f525dab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8100e130b3a49fdee48bc3c4d4e63963" id="r_a8100e130b3a49fdee48bc3c4d4e63963"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8100e130b3a49fdee48bc3c4d4e63963">VisualizeFaceValence</a> (mfem::Mesh &amp;mesh)</td></tr>
<tr class="memdesc:a8100e130b3a49fdee48bc3c4d4e63963"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visualize boundary face valence (1=surface, 2=internal). <br /></td></tr>
<tr class="separator:a8100e130b3a49fdee48bc3c4d4e63963"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ad4048304d8a0c7075d2b2a6e465d0b6e" name="ad4048304d8a0c7075d2b2a6e465d0b6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4048304d8a0c7075d2b2a6e465d0b6e">&#9670;&#160;</a></span>VISUALIZATION_MODE</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6e">stroid::IO::VISUALIZATION_MODE</a> : uint8_t</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel strong">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Visualization modes for GLVis display. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad4048304d8a0c7075d2b2a6e465d0b6eab50339a10e1de285ac99d4c3990b8693" name="ad4048304d8a0c7075d2b2a6e465d0b6eab50339a10e1de285ac99d4c3990b8693"></a>NONE&#160;</td><td class="fielddoc"><p>No attribute visualization (default rendering). </p>
</td></tr>
<tr><td class="fieldname"><a id="ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf" name="ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf"></a>ELEMENT_ID&#160;</td><td class="fielddoc"><p>Color elements by their element attribute/ID. </p>
</td></tr>
<tr><td class="fieldname"><a id="ad4048304d8a0c7075d2b2a6e465d0b6eaee96e14c2b71bd59252006289ba464cf" name="ad4048304d8a0c7075d2b2a6e465d0b6eaee96e14c2b71bd59252006289ba464cf"></a>BOUNDARY_ELEMENT_ID&#160;</td><td class="fielddoc"><p>Color boundary-adjacent elements by boundary attribute/ID. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aeb567ddc70ff2d064c139dee87575830" name="aeb567ddc70ff2d064c139dee87575830"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb567ddc70ff2d064c139dee87575830">&#9670;&#160;</a></span>SaveMesh()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stroid::IO::SaveMesh </td>
<td>(</td>
<td class="paramtype">const mfem::Mesh &amp;</td> <td class="paramname"><span class="paramname"><em>mesh</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>filename</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Save a mesh to MFEM's native <code>.mesh</code> format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mesh</td><td>Mesh to serialize. </td></tr>
<tr><td class="paramname">filename</td><td>Output path (including extension). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab4c8bda7ab370e34376a7832fbf0951e" name="ab4c8bda7ab370e34376a7832fbf0951e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4c8bda7ab370e34376a7832fbf0951e">&#9670;&#160;</a></span>SaveVTU()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stroid::IO::SaveVTU </td>
<td>(</td>
<td class="paramtype">mfem::Mesh &amp;</td> <td class="paramname"><span class="paramname"><em>mesh</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>exportName</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Save a mesh as a ParaView VTU dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mesh</td><td>Mesh to export. </td></tr>
<tr><td class="paramname">exportName</td><td>Output base name (ParaView will add extensions). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a496f5c16eaffda5922a0b96c1f525dab" name="a496f5c16eaffda5922a0b96c1f525dab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a496f5c16eaffda5922a0b96c1f525dab">&#9670;&#160;</a></span>ViewMesh()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stroid::IO::ViewMesh </td>
<td>(</td>
<td class="paramtype">mfem::Mesh &amp;</td> <td class="paramname"><span class="paramname"><em>mesh</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>title</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6e">VISUALIZATION_MODE</a></td> <td class="paramname"><span class="paramname"><em>mode</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>vishost</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>visport</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Stream a mesh to a running GLVis server for interactive viewing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mesh</td><td>Mesh to display. </td></tr>
<tr><td class="paramname">title</td><td>Window title shown in GLVis. </td></tr>
<tr><td class="paramname">mode</td><td>Attribute visualization mode. </td></tr>
<tr><td class="paramname">vishost</td><td>GLVis server host. </td></tr>
<tr><td class="paramname">visport</td><td>GLVis server port. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8100e130b3a49fdee48bc3c4d4e63963" name="a8100e130b3a49fdee48bc3c4d4e63963"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8100e130b3a49fdee48bc3c4d4e63963">&#9670;&#160;</a></span>VisualizeFaceValence()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stroid::IO::VisualizeFaceValence </td>
<td>(</td>
<td class="paramtype">mfem::Mesh &amp;</td> <td class="paramname"><span class="paramname"><em>mesh</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Visualize boundary face valence (1=surface, 2=internal). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mesh</td><td>Mesh whose boundary faces are inspected. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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="namespacestroid.html">stroid</a></li><li class="navelem"><a class="el" href="namespacestroid_1_1_i_o.html">IO</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.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink