threed-beam-fea/docs/html/structfea_1_1_summary.html

438 lines
22 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<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.8.9.1"/>
<title>3D Beam Finite Element Code: fea::Summary 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="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/javascript">
$(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo_64x64.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">3D Beam Finite Element Code
&#160;<span id="projectnumber">1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefea.html">fea</a></li><li class="navelem"><a class="el" href="structfea_1_1_summary.html">Summary</a></li> </ul>
</div>
</div><!-- top -->
<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="structfea_1_1_summary-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fea::Summary Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Contains the results of an analysis after calling <code><a class="el" href="namespacefea.html#a995a678cf119fb20772312ccfdbec991" title="Solves the finite element analysis defined by the input Job, boundary conditions, and prescribed noda...">fea::solve</a></code>.
<a href="structfea_1_1_summary.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="summary_8h_source.html">summary.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a85ab0822e46fd5d6ac119ef670e08e4e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a85ab0822e46fd5d6ac119ef670e08e4e">Summary</a> ()</td></tr>
<tr class="separator:a85ab0822e46fd5d6ac119ef670e08e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1880ea430b8b0ed28e09cefd7880a7a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#ad1880ea430b8b0ed28e09cefd7880a7a">FullReport</a> () const </td></tr>
<tr class="memdesc:ad1880ea430b8b0ed28e09cefd7880a7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a message containing the results of the analysis. <a href="#ad1880ea430b8b0ed28e09cefd7880a7a">More...</a><br /></td></tr>
<tr class="separator:ad1880ea430b8b0ed28e09cefd7880a7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a37e4d55928271b4c0fbf0dec97888de0"><td class="memItemLeft" align="right" valign="top">long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a37e4d55928271b4c0fbf0dec97888de0">total_time_in_ms</a></td></tr>
<tr class="separator:a37e4d55928271b4c0fbf0dec97888de0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d3dac2d732621393211cda5cad342c7"><td class="memItemLeft" align="right" valign="top">long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a8d3dac2d732621393211cda5cad342c7">assembly_time_in_ms</a></td></tr>
<tr class="separator:a8d3dac2d732621393211cda5cad342c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a433a0565c3650f0c564a23f32def5c25"><td class="memItemLeft" align="right" valign="top">long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a433a0565c3650f0c564a23f32def5c25">preprocessing_time_in_ms</a></td></tr>
<tr class="separator:a433a0565c3650f0c564a23f32def5c25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6706e54edf06a1f9eb344303c879bba"><td class="memItemLeft" align="right" valign="top">long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#af6706e54edf06a1f9eb344303c879bba">factorization_time_in_ms</a></td></tr>
<tr class="separator:af6706e54edf06a1f9eb344303c879bba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f04208347e3d8e02dd3aeb18e40cc1a"><td class="memItemLeft" align="right" valign="top">long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a3f04208347e3d8e02dd3aeb18e40cc1a">solve_time_in_ms</a></td></tr>
<tr class="separator:a3f04208347e3d8e02dd3aeb18e40cc1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fb2676aa71313a8b030532f9960abed"><td class="memItemLeft" align="right" valign="top">long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a0fb2676aa71313a8b030532f9960abed">nodal_forces_solve_time_in_ms</a></td></tr>
<tr class="separator:a0fb2676aa71313a8b030532f9960abed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50eb11c9ac985bfef6458fa40eb2c060"><td class="memItemLeft" align="right" valign="top">long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a50eb11c9ac985bfef6458fa40eb2c060">tie_forces_solve_time_in_ms</a></td></tr>
<tr class="separator:a50eb11c9ac985bfef6458fa40eb2c060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5675d3c98aa0aa000644f54d8b8a362f"><td class="memItemLeft" align="right" valign="top">long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a5675d3c98aa0aa000644f54d8b8a362f">file_save_time_in_ms</a></td></tr>
<tr class="separator:a5675d3c98aa0aa000644f54d8b8a362f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01bca53d421f7d862f21311a3f1c4589"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a01bca53d421f7d862f21311a3f1c4589">num_nodes</a></td></tr>
<tr class="separator:a01bca53d421f7d862f21311a3f1c4589"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a456814a72ac4fa826015ee73b59781cd"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a456814a72ac4fa826015ee73b59781cd">num_elems</a></td></tr>
<tr class="separator:a456814a72ac4fa826015ee73b59781cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af17888d1299ec744967578bc5e266b7f"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#af17888d1299ec744967578bc5e266b7f">num_bcs</a></td></tr>
<tr class="separator:af17888d1299ec744967578bc5e266b7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0404946b2b75bf763c0f3c91f58d4f70"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a0404946b2b75bf763c0f3c91f58d4f70">num_forces</a></td></tr>
<tr class="separator:a0404946b2b75bf763c0f3c91f58d4f70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37344cf743eed220f9e05fd967f2a481"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a37344cf743eed220f9e05fd967f2a481">num_ties</a></td></tr>
<tr class="separator:a37344cf743eed220f9e05fd967f2a481"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab13e993717d979eb4c271242c126ef5b"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#ab13e993717d979eb4c271242c126ef5b">num_eqns</a></td></tr>
<tr class="separator:ab13e993717d979eb4c271242c126ef5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad05822565a41e374c77f84c6c3b358b2"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; double &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#ad05822565a41e374c77f84c6c3b358b2">nodal_displacements</a></td></tr>
<tr class="separator:ad05822565a41e374c77f84c6c3b358b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9858284f86514f1d7922bc7c458da385"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; double &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#a9858284f86514f1d7922bc7c458da385">nodal_forces</a></td></tr>
<tr class="separator:a9858284f86514f1d7922bc7c458da385"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1822f670a2d6bfbf76f042a0cb544ff"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; double &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_summary.html#af1822f670a2d6bfbf76f042a0cb544ff">tie_forces</a></td></tr>
<tr class="separator:af1822f670a2d6bfbf76f042a0cb544ff"><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>Contains the results of an analysis after calling <code><a class="el" href="namespacefea.html#a995a678cf119fb20772312ccfdbec991" title="Solves the finite element analysis defined by the input Job, boundary conditions, and prescribed noda...">fea::solve</a></code>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a85ab0822e46fd5d6ac119ef670e08e4e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">fea::Summary::Summary </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad1880ea430b8b0ed28e09cefd7880a7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string fea::Summary::FullReport </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a message containing the results of the analysis. </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="structfea_1_1_summary_ad1880ea430b8b0ed28e09cefd7880a7a_icgraph.png" border="0" usemap="#structfea_1_1_summary_ad1880ea430b8b0ed28e09cefd7880a7a_icgraph" alt=""/></div>
<map name="structfea_1_1_summary_ad1880ea430b8b0ed28e09cefd7880a7a_icgraph" id="structfea_1_1_summary_ad1880ea430b8b0ed28e09cefd7880a7a_icgraph">
</map>
</div>
</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a8d3dac2d732621393211cda5cad342c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long long fea::Summary::assembly_time_in_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time it took to assemble the global stiffness matrix. </p>
</div>
</div>
<a class="anchor" id="af6706e54edf06a1f9eb344303c879bba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long long fea::Summary::factorization_time_in_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time to compute the factors of the coefficient matrix. </p>
</div>
</div>
<a class="anchor" id="a5675d3c98aa0aa000644f54d8b8a362f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long long fea::Summary::file_save_time_in_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time to compute the nodal forces. Does not include the time to save the summary itself if <code><a class="el" href="structfea_1_1_options.html#ade08eb8049e28924b16f62aa177ae4d8">Options::save_report</a> == true</code> since all data must be computed prior to saving the report. </p>
</div>
</div>
<a class="anchor" id="ad05822565a41e374c77f84c6c3b358b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::vector&lt;double&gt; &gt; fea::Summary::nodal_displacements</td>
</tr>
</table>
</div><div class="memdoc">
<p>The resultant nodal displacement from the FE analysis. <code>nodal_displacements</code> is a 2D vector where each row correspond to a node, and the columns correspond to <code>[d_x, d_y, d_z, theta_x, theta_y, theta_z]</code> </p>
</div>
</div>
<a class="anchor" id="a9858284f86514f1d7922bc7c458da385"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::vector&lt;double&gt; &gt; fea::Summary::nodal_forces</td>
</tr>
</table>
</div><div class="memdoc">
<p>The resultant nodal forces from the FE analysis. <code>nodal_displacements</code> is a 2D vector where each row correspond to a node, and the columns correspond to <code>[f_x, f_y, f_z, m_x, m_y, m_z]</code> </p>
</div>
</div>
<a class="anchor" id="a0fb2676aa71313a8b030532f9960abed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long long fea::Summary::nodal_forces_solve_time_in_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time to compute the nodal forces. </p>
</div>
</div>
<a class="anchor" id="af17888d1299ec744967578bc5e266b7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long fea::Summary::num_bcs</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of boundary conditions in the analysis. </p>
</div>
</div>
<a class="anchor" id="a456814a72ac4fa826015ee73b59781cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long fea::Summary::num_elems</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of elements in the analysis. </p>
</div>
</div>
<a class="anchor" id="ab13e993717d979eb4c271242c126ef5b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long fea::Summary::num_eqns</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of equation constraints in the analysis. </p>
</div>
</div>
<a class="anchor" id="a0404946b2b75bf763c0f3c91f58d4f70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long fea::Summary::num_forces</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of prescribed forces in the analysis. </p>
</div>
</div>
<a class="anchor" id="a01bca53d421f7d862f21311a3f1c4589"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long fea::Summary::num_nodes</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of nodes in the analysis. </p>
</div>
</div>
<a class="anchor" id="a37344cf743eed220f9e05fd967f2a481"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long fea::Summary::num_ties</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of tie constraints in the analysis. </p>
</div>
</div>
<a class="anchor" id="a433a0565c3650f0c564a23f32def5c25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long long fea::Summary::preprocessing_time_in_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time to reorder the nonzero elements of the the global stiffness matrix, such that the factorization step creates less fill-in. </p>
</div>
</div>
<a class="anchor" id="a3f04208347e3d8e02dd3aeb18e40cc1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long long fea::Summary::solve_time_in_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time to compute the solution of the linear system. </p>
</div>
</div>
<a class="anchor" id="af1822f670a2d6bfbf76f042a0cb544ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::vector&lt;double&gt; &gt; fea::Summary::tie_forces</td>
</tr>
</table>
</div><div class="memdoc">
<p>The resultant forces associated with ties between nodes. <code>tie_forces</code> is a 2D vector where each row correspond to a tie, and the columns correspond to <code>[f_x, f_y, f_z, f_rot_x, f_rot_y, f_rot_z]</code> </p>
</div>
</div>
<a class="anchor" id="a50eb11c9ac985bfef6458fa40eb2c060"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long long fea::Summary::tie_forces_solve_time_in_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time to compute the nodal forces. </p>
</div>
</div>
<a class="anchor" id="a37e4d55928271b4c0fbf0dec97888de0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long long fea::Summary::total_time_in_ms</td>
</tr>
</table>
</div><div class="memdoc">
<p>The total time of the FE analysis. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>include/<a class="el" href="summary_8h_source.html">summary.h</a></li>
<li>src/<a class="el" href="summary_8cpp.html">summary.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 3 2016 22:38:16 for 3D Beam Finite Element Code by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>