343 lines
17 KiB
HTML
343 lines
17 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::Options 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
|
|
 <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 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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_options.html">Options</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structfea_1_1_options-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fea::Options Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Provides a method for customizing the finite element analysis.
|
|
<a href="structfea_1_1_options.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="options_8h_source.html">options.h</a>></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:a807e228c27c1354d786c712a0c792605"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#a807e228c27c1354d786c712a0c792605">Options</a> ()</td></tr>
|
|
<tr class="memdesc:a807e228c27c1354d786c712a0c792605"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a807e228c27c1354d786c712a0c792605">More...</a><br /></td></tr>
|
|
<tr class="separator:a807e228c27c1354d786c712a0c792605"><td class="memSeparator" colspan="2"> </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:ad52313d1d4af202ae7bf382c2a6bf50e"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#ad52313d1d4af202ae7bf382c2a6bf50e">epsilon</a></td></tr>
|
|
<tr class="separator:ad52313d1d4af202ae7bf382c2a6bf50e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac706e54de8b207be5b87ae903b526b9"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#aac706e54de8b207be5b87ae903b526b9">csv_precision</a></td></tr>
|
|
<tr class="separator:aac706e54de8b207be5b87ae903b526b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae4f2d3372cb1539ef13272c8491c3b5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#aae4f2d3372cb1539ef13272c8491c3b5">csv_delimiter</a></td></tr>
|
|
<tr class="separator:aae4f2d3372cb1539ef13272c8491c3b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d053be484e4c5a79d0eab2447883823"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#a1d053be484e4c5a79d0eab2447883823">save_nodal_displacements</a></td></tr>
|
|
<tr class="separator:a1d053be484e4c5a79d0eab2447883823"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ef9cc3bf01c181a3cf34fc4451cd4e9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#a7ef9cc3bf01c181a3cf34fc4451cd4e9">save_nodal_forces</a></td></tr>
|
|
<tr class="separator:a7ef9cc3bf01c181a3cf34fc4451cd4e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a8d38f369c7c5969863915273d26484"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#a7a8d38f369c7c5969863915273d26484">save_tie_forces</a></td></tr>
|
|
<tr class="separator:a7a8d38f369c7c5969863915273d26484"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7fc006a76a6edea968fb6e5b63e0b56d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#a7fc006a76a6edea968fb6e5b63e0b56d">verbose</a></td></tr>
|
|
<tr class="separator:a7fc006a76a6edea968fb6e5b63e0b56d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade08eb8049e28924b16f62aa177ae4d8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#ade08eb8049e28924b16f62aa177ae4d8">save_report</a></td></tr>
|
|
<tr class="separator:ade08eb8049e28924b16f62aa177ae4d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84913bcab0fd1bcdc1fe494f9c48fd79"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#a84913bcab0fd1bcdc1fe494f9c48fd79">nodal_displacements_filename</a></td></tr>
|
|
<tr class="separator:a84913bcab0fd1bcdc1fe494f9c48fd79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6b7ccda4984e4160c6cdbcefa496a26"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#ad6b7ccda4984e4160c6cdbcefa496a26">nodal_forces_filename</a></td></tr>
|
|
<tr class="separator:ad6b7ccda4984e4160c6cdbcefa496a26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2e6f3775305271dd59162452e26de47"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#ac2e6f3775305271dd59162452e26de47">tie_forces_filename</a></td></tr>
|
|
<tr class="separator:ac2e6f3775305271dd59162452e26de47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cb6bd0d7f4c5a684143324c65d31973"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structfea_1_1_options.html#a7cb6bd0d7f4c5a684143324c65d31973">report_filename</a></td></tr>
|
|
<tr class="separator:a7cb6bd0d7f4c5a684143324c65d31973"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Provides a method for customizing the finite element analysis. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a807e228c27c1354d786c712a0c792605"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">fea::Options::Options </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>This tries to set up reasonable defaults for analysis. It is recommended that the user read and overwrite the defaults based on the information desired from the analysis. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="aae4f2d3372cb1539ef13272c8491c3b5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string fea::Options::csv_delimiter</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Delimiter to use when saving nodal forces and displacements if either <code>save_nodal_displacements</code> or <code>save_nodal_forces</code> is set to <code>true</code>. Default = ",". </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aac706e54de8b207be5b87ae903b526b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int fea::Options::csv_precision</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Number of decimal places to use when saving nodal forces and displacements if either <code>save_nodal_displacements</code> or <code>save_nodal_forces</code> is set to <code>true</code>. Default = 14. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad52313d1d4af202ae7bf382c2a6bf50e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double fea::Options::epsilon</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Values of forces and nodal displacements which have a magnitude less than <code>epsilon</code> will be rounded to 0.0. Default = <code>1e-14</code>. This is a simple way to deal with machine precision when doing calculations. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a84913bcab0fd1bcdc1fe494f9c48fd79"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string fea::Options::nodal_displacements_filename</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>File name to save the nodal displacements to when <code>save_nodal_displacements == true</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad6b7ccda4984e4160c6cdbcefa496a26"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string fea::Options::nodal_forces_filename</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>File name to save the nodal forces to when <code>save_nodal_forces == true</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7cb6bd0d7f4c5a684143324c65d31973"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string fea::Options::report_filename</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>File name to save the nodal forces to when <code>save_report == true</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1d053be484e4c5a79d0eab2447883823"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fea::Options::save_nodal_displacements</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies if the nodal displacements should be saved to a file. Default = <code>false</code>. If <code>true</code> the nodal displacements will be saved to the file indicated by <code>nodal_displacements_filename</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7ef9cc3bf01c181a3cf34fc4451cd4e9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fea::Options::save_nodal_forces</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies if the nodal forces should be saved to a file. Default = <code>false</code>. If <code>true</code> the nodal forces will be saved to the file indicated by <code>nodal_forces_filename</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ade08eb8049e28924b16f62aa177ae4d8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fea::Options::save_report</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies if a text file should be written detailing information on the analysis. Default = <code>false</code>. If <code>true</code> the a report will be saved to the file indicated by <code>report_filename</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7a8d38f369c7c5969863915273d26484"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fea::Options::save_tie_forces</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies if the forces associated with tie elements should be saved to a file. Default = <code>false</code>. If <code>true</code> the tie forces will be saved to the file indicated by <code>tie_forces_filename</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac2e6f3775305271dd59162452e26de47"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string fea::Options::tie_forces_filename</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>File name to save the nodal forces to when <code>save_tie_forces == true</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7fc006a76a6edea968fb6e5b63e0b56d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fea::Options::verbose</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies if progress of the analysis should be written to std::cout. Default = <code>false</code>. If <code>true</code> information on current step and time taken per step will be reported. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>include/<a class="el" href="options_8h_source.html">options.h</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  <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>
|