580 lines
34 KiB
HTML
580 lines
34 KiB
HTML
<!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"> v0.6.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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&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> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">stroid::IO Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Mesh serialization and visualization helpers.
|
|
<a href="#details">More...</a></p>
|
|
<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  </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"> </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"> </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:ab854167b428c1a77597d9bb3a972b363" id="r_ab854167b428c1a77597d9bb3a972b363"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab854167b428c1a77597d9bb3a972b363">SaveStroidMesh</a> (const <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> &mesh, const std::string &filename, const std::string &comment="")</td></tr>
|
|
<tr class="separator:ab854167b428c1a77597d9bb3a972b363"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb567ddc70ff2d064c139dee87575830" id="r_aeb567ddc70ff2d064c139dee87575830"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb567ddc70ff2d064c139dee87575830">SaveMesh</a> (const mfem::Mesh &mesh, const std::string &filename)</td></tr>
|
|
<tr class="memdesc:aeb567ddc70ff2d064c139dee87575830"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:ad7721ff3eda0ad42365955ea33da2b0a" id="r_ad7721ff3eda0ad42365955ea33da2b0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad7721ff3eda0ad42365955ea33da2b0a">SaveMesh</a> (const <a class="el" href="structstroid_1_1_stroid_mesh.html">stroid::StroidMesh</a> &mesh, const std::string &filename)</td></tr>
|
|
<tr class="memdesc:ad7721ff3eda0ad42365955ea33da2b0a"><td class="mdescLeft"> </td><td class="mdescRight">Overload of SaveMesh which accepts a <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> type and will internally unpack it. <br /></td></tr>
|
|
<tr class="separator:ad7721ff3eda0ad42365955ea33da2b0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4c8bda7ab370e34376a7832fbf0951e" id="r_ab4c8bda7ab370e34376a7832fbf0951e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4c8bda7ab370e34376a7832fbf0951e">SaveVTU</a> (mfem::Mesh &mesh, const std::string &exportName)</td></tr>
|
|
<tr class="memdesc:ab4c8bda7ab370e34376a7832fbf0951e"><td class="mdescLeft"> </td><td class="mdescRight">Save a mesh as a ParaView VTU dataset. <br /></td></tr>
|
|
<tr class="separator:ab4c8bda7ab370e34376a7832fbf0951e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0fc8e0663da26ff11be71fb1b5a0b0e" id="r_ae0fc8e0663da26ff11be71fb1b5a0b0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0fc8e0663da26ff11be71fb1b5a0b0e">SaveVTU</a> (const <a class="el" href="structstroid_1_1_stroid_mesh.html">stroid::StroidMesh</a> &mesh, const std::string &exportName)</td></tr>
|
|
<tr class="memdesc:ae0fc8e0663da26ff11be71fb1b5a0b0e"><td class="mdescLeft"> </td><td class="mdescRight">Overload of SaveVTU which accepts a <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> type and will internally unpack it. <br /></td></tr>
|
|
<tr class="separator:ae0fc8e0663da26ff11be71fb1b5a0b0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7426b1e664be45cbf791167748d4feb8" id="r_a7426b1e664be45cbf791167748d4feb8"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< mfem::Mesh > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7426b1e664be45cbf791167748d4feb8">MakeConformingVisualizationMesh</a> (const mfem::Mesh &mesh)</td></tr>
|
|
<tr class="memdesc:a7426b1e664be45cbf791167748d4feb8"><td class="mdescLeft"> </td><td class="mdescRight">Make a display-only mesh copy with matching face subdivisions. This is purely for visualization and should not be used for any science goals. <br /></td></tr>
|
|
<tr class="separator:a7426b1e664be45cbf791167748d4feb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7bc6daa0f9ef8327355022363e1db3fb" id="r_a7bc6daa0f9ef8327355022363e1db3fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7bc6daa0f9ef8327355022363e1db3fb">ViewMesh</a> (mfem::Mesh &mesh, const std::string &title, <a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6e">VISUALIZATION_MODE</a> mode, const std::string &vishost, int visport, bool conforming_display=true)</td></tr>
|
|
<tr class="memdesc:a7bc6daa0f9ef8327355022363e1db3fb"><td class="mdescLeft"> </td><td class="mdescRight">Stream a mesh to a running GLVis server for interactive viewing. <br /></td></tr>
|
|
<tr class="separator:a7bc6daa0f9ef8327355022363e1db3fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6491a99d6d2859b2c098b94f2f8171d3" id="r_a6491a99d6d2859b2c098b94f2f8171d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6491a99d6d2859b2c098b94f2f8171d3">ViewMesh</a> (const <a class="el" href="structstroid_1_1_stroid_mesh.html">stroid::StroidMesh</a> &mesh, const std::string &title, <a class="el" href="#ad4048304d8a0c7075d2b2a6e465d0b6e">VISUALIZATION_MODE</a> mode, const std::string &vishost, int visport, bool conforming_display=true)</td></tr>
|
|
<tr class="separator:a6491a99d6d2859b2c098b94f2f8171d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a516d260163e0b6ac000b301b0b8cf4bb" id="r_a516d260163e0b6ac000b301b0b8cf4bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a516d260163e0b6ac000b301b0b8cf4bb">VisualizeFaceValence</a> (mfem::Mesh &mesh, const std::string &vishost, int visport, bool conforming_display=true)</td></tr>
|
|
<tr class="memdesc:a516d260163e0b6ac000b301b0b8cf4bb"><td class="mdescLeft"> </td><td class="mdescRight">Color boundary-adjacent elements by face valence (1=surface, 2=internal). Untagged elements are zero; elements touching several tagged faces use the maximum valence. Values are computed before display subdivision. <br /></td></tr>
|
|
<tr class="separator:a516d260163e0b6ac000b301b0b8cf4bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26155a525b34257a3eb2305e477b6bef" id="r_a26155a525b34257a3eb2305e477b6bef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a26155a525b34257a3eb2305e477b6bef">VisualizeFaceValence</a> (const <a class="el" href="structstroid_1_1_stroid_mesh.html">stroid::StroidMesh</a> &mesh, const std::string &vishost, int visport, bool conforming_display=true)</td></tr>
|
|
<tr class="separator:a26155a525b34257a3eb2305e477b6bef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20ae517986b9c27d23ef5f0ab704b247" id="r_a20ae517986b9c27d23ef5f0ab704b247"><td class="memItemLeft" align="right" valign="top">std::expected< <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a>, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a20ae517986b9c27d23ef5f0ab704b247">ParseStroidMesh</a> (std::istream &is)</td></tr>
|
|
<tr class="separator:a20ae517986b9c27d23ef5f0ab704b247"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f39dc149d5650468b579c76d00f991d" id="r_a3f39dc149d5650468b579c76d00f991d"><td class="memItemLeft" align="right" valign="top">std::expected< <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a>, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f39dc149d5650468b579c76d00f991d">LoadStroidMesh</a> (const std::string &filename)</td></tr>
|
|
<tr class="separator:a3f39dc149d5650468b579c76d00f991d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Mesh serialization and visualization helpers. </p>
|
|
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ad4048304d8a0c7075d2b2a6e465d0b6e" name="ad4048304d8a0c7075d2b2a6e465d0b6e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad4048304d8a0c7075d2b2a6e465d0b6e">◆ </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 </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 </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 </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="a3f39dc149d5650468b579c76d00f991d" name="a3f39dc149d5650468b579c76d00f991d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f39dc149d5650468b579c76d00f991d">◆ </a></span>LoadStroidMesh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::expected< <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a>, std::string > stroid::IO::LoadStroidMesh </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>filename</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7426b1e664be45cbf791167748d4feb8" name="a7426b1e664be45cbf791167748d4feb8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7426b1e664be45cbf791167748d4feb8">◆ </a></span>MakeConformingVisualizationMesh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr< mfem::Mesh > stroid::IO::MakeConformingVisualizationMesh </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const mfem::Mesh &</td> <td class="paramname"><span class="paramname"><em>mesh</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make a display-only mesh copy with matching face subdivisions. This is purely for visualization and should not be used for any science goals. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mesh</td><td>Source mesh whose geometry is to be displayed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Independently owned copy with no hanging faces. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a20ae517986b9c27d23ef5f0ab704b247" name="a20ae517986b9c27d23ef5f0ab704b247"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a20ae517986b9c27d23ef5f0ab704b247">◆ </a></span>ParseStroidMesh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::expected< <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a>, std::string > stroid::IO::ParseStroidMesh </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::istream &</td> <td class="paramname"><span class="paramname"><em>is</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeb567ddc70ff2d064c139dee87575830" name="aeb567ddc70ff2d064c139dee87575830"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb567ddc70ff2d064c139dee87575830">◆ </a></span>SaveMesh() <span class="overload">[1/2]</span></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 &</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 &</td> <td class="paramname"><span class="paramname"><em>filename</em></span> )</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="ad7721ff3eda0ad42365955ea33da2b0a" name="ad7721ff3eda0ad42365955ea33da2b0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7721ff3eda0ad42365955ea33da2b0a">◆ </a></span>SaveMesh() <span class="overload">[2/2]</span></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 <a class="el" href="structstroid_1_1_stroid_mesh.html">stroid::StroidMesh</a> &</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 &</td> <td class="paramname"><span class="paramname"><em>filename</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload of SaveMesh which accepts a <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> type and will internally unpack it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mesh</td><td><a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> to serialize. </td></tr>
|
|
<tr><td class="paramname">filename</td><td>Path to save to</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is a utility wrapper to save a <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> object in MFEM's native .mesh format. Data other than the mesh pointer in <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> <b>will not be saved</b> (e.g. the reference mesh, the number of refinement levels, etc..). If you need to serialize an entire <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> then please use the <a class="el" href="#ab854167b428c1a77597d9bb3a972b363">stroid::IO::SaveStroidMesh</a> function </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab854167b428c1a77597d9bb3a972b363" name="ab854167b428c1a77597d9bb3a972b363"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab854167b428c1a77597d9bb3a972b363">◆ </a></span>SaveStroidMesh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stroid::IO::SaveStroidMesh </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> &</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 &</td> <td class="paramname"><span class="paramname"><em>filename</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>comment</em></span><span class="paramdefsep"> = </span><span class="paramdefval">""</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae0fc8e0663da26ff11be71fb1b5a0b0e" name="ae0fc8e0663da26ff11be71fb1b5a0b0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0fc8e0663da26ff11be71fb1b5a0b0e">◆ </a></span>SaveVTU() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stroid::IO::SaveVTU </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structstroid_1_1_stroid_mesh.html">stroid::StroidMesh</a> &</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 &</td> <td class="paramname"><span class="paramname"><em>exportName</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload of SaveVTU which accepts a <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> type and will internally unpack it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mesh</td><td><a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> to serialize. </td></tr>
|
|
<tr><td class="paramname">filename</td><td>Path to save to</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is a utility wrapper to save a <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> object in MFEM's native .mesh format. Data other than the mesh pointer in <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> <b>will not be saved</b> (e.g. the reference mesh, the number of refinement levels, etc..). If you need to serialize an entire <a class="el" href="structstroid_1_1_stroid_mesh.html">StroidMesh</a> then please use the stroid::IO::SaveStroidVTU function </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab4c8bda7ab370e34376a7832fbf0951e" name="ab4c8bda7ab370e34376a7832fbf0951e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4c8bda7ab370e34376a7832fbf0951e">◆ </a></span>SaveVTU() <span class="overload">[2/2]</span></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 &</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 &</td> <td class="paramname"><span class="paramname"><em>exportName</em></span> )</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="a6491a99d6d2859b2c098b94f2f8171d3" name="a6491a99d6d2859b2c098b94f2f8171d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6491a99d6d2859b2c098b94f2f8171d3">◆ </a></span>ViewMesh() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stroid::IO::ViewMesh </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structstroid_1_1_stroid_mesh.html">stroid::StroidMesh</a> &</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 &</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 &</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>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>conforming_display</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7bc6daa0f9ef8327355022363e1db3fb" name="a7bc6daa0f9ef8327355022363e1db3fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7bc6daa0f9ef8327355022363e1db3fb">◆ </a></span>ViewMesh() <span class="overload">[2/2]</span></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 &</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 &</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 &</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>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>conforming_display</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> )</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>
|
|
<tr><td class="paramname">conforming_display</td><td>Refine a display-only copy at hanging interfaces to prevent GLVis tessellation gaps. Set false to inspect the original element layout, which can show rendering gaps on curved interfaces. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a26155a525b34257a3eb2305e477b6bef" name="a26155a525b34257a3eb2305e477b6bef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a26155a525b34257a3eb2305e477b6bef">◆ </a></span>VisualizeFaceValence() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stroid::IO::VisualizeFaceValence </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structstroid_1_1_stroid_mesh.html">stroid::StroidMesh</a> &</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 &</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>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>conforming_display</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a516d260163e0b6ac000b301b0b8cf4bb" name="a516d260163e0b6ac000b301b0b8cf4bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a516d260163e0b6ac000b301b0b8cf4bb">◆ </a></span>VisualizeFaceValence() <span class="overload">[2/2]</span></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 &</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 &</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>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>conforming_display</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Color boundary-adjacent elements by face valence (1=surface, 2=internal). Untagged elements are zero; elements touching several tagged faces use the maximum valence. Values are computed before display subdivision. </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>
|
|
<tr><td class="paramname">vishost</td><td>GLVis server host. </td></tr>
|
|
<tr><td class="paramname">visport</td><td>GLVis server port. </td></tr>
|
|
<tr><td class="paramname">conforming_display</td><td>Use the same display-only refinement as ViewMesh. </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>
|