Page MenuHomec4science
Files F119276245

config_8h.html
No OneTemporary
Actions

File Metadata

Created
Wed, Jun 25, 19:23

config_8h.html
View Options

<!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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GooseFEM: GooseFEM/config.h File 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<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">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<script type="text/javascript" src="darkmode_toggle.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 id="projectrow">
<td id="projectalign">
<div id="projectname">GooseFEM<span id="projectnumber">&#160;1.4.1.dev2+g78f16df</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<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" 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');
$(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('config_8h.html',''); initResizable(); });
/* @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="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">config.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Basic configuration:
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;array&gt;</code><br />
<code>#include &lt;assert.h&gt;</code><br />
<code>#include &lt;cstdlib&gt;</code><br />
<code>#include &lt;iomanip&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;limits&gt;</code><br />
<code>#include &lt;math.h&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;numeric&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;xtensor/xadapt.hpp&gt;</code><br />
<code>#include &lt;xtensor/xarray.hpp&gt;</code><br />
<code>#include &lt;xtensor/xfixed.hpp&gt;</code><br />
<code>#include &lt;xtensor/xinfo.hpp&gt;</code><br />
<code>#include &lt;xtensor/xio.hpp&gt;</code><br />
<code>#include &lt;xtensor/xlayout.hpp&gt;</code><br />
<code>#include &lt;xtensor/xmath.hpp&gt;</code><br />
<code>#include &lt;xtensor/xnoalias.hpp&gt;</code><br />
<code>#include &lt;xtensor/xshape.hpp&gt;</code><br />
<code>#include &lt;xtensor/xsort.hpp&gt;</code><br />
<code>#include &lt;xtensor/xstrided_view.hpp&gt;</code><br />
<code>#include &lt;xtensor/xtensor.hpp&gt;</code><br />
<code>#include &lt;xtensor/xutils.hpp&gt;</code><br />
<code>#include &lt;xtensor/xview.hpp&gt;</code><br />
</div>
<p><a href="config_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceGooseFEM" id="r_namespaceGooseFEM"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM.html">GooseFEM</a></td></tr>
<tr class="memdesc:namespaceGooseFEM"><td class="mdescLeft">&#160;</td><td class="mdescRight">Toolbox to perform finite element computations. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceGooseFEM_1_1array__type" id="r_namespaceGooseFEM_1_1array__type"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM_1_1array__type.html">GooseFEM::array_type</a></td></tr>
<tr class="memdesc:namespaceGooseFEM_1_1array__type"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container type. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a391cf2265f217c503ef4c35e6422b409" id="r_a391cf2265f217c503ef4c35e6422b409"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a391cf2265f217c503ef4c35e6422b409">GOOSEFEM_ASSERT</a>(expr)</td></tr>
<tr class="memdesc:a391cf2265f217c503ef4c35e6422b409"><td class="mdescLeft">&#160;</td><td class="mdescRight">All assertions are implementation as:: <br /></td></tr>
<tr class="separator:a391cf2265f217c503ef4c35e6422b409"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab83a10086e0a82fcd0cb6c2d3d015534" id="r_ab83a10086e0a82fcd0cb6c2d3d015534"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab83a10086e0a82fcd0cb6c2d3d015534">GOOSEFEM_CHECK</a>(expr)&#160;&#160;&#160;GOOSEFEM_ASSERT_IMPL(expr, __FILE__, __LINE__, __FUNCTION__)</td></tr>
<tr class="memdesc:ab83a10086e0a82fcd0cb6c2d3d015534"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assertion that cannot be switched off. <br /></td></tr>
<tr class="separator:ab83a10086e0a82fcd0cb6c2d3d015534"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57e912a0860dacf27f1c506763b82816" id="r_a57e912a0860dacf27f1c506763b82816"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57e912a0860dacf27f1c506763b82816">GOOSEFEM_WIP_ASSERT</a>(expr)&#160;&#160;&#160;GOOSEFEM_ASSERT_IMPL(expr, __FILE__, __LINE__, __FUNCTION__)</td></tr>
<tr class="memdesc:a57e912a0860dacf27f1c506763b82816"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assertion that concerns temporary implementation limitations. <br /></td></tr>
<tr class="separator:a57e912a0860dacf27f1c506763b82816"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1cbf996d2494765c5a52eeec7be7dd0" id="r_ac1cbf996d2494765c5a52eeec7be7dd0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1cbf996d2494765c5a52eeec7be7dd0">GOOSEFEM_WARNING</a>(message)&#160;&#160;&#160;GOOSEFEM_WARNING_IMPL(message, __FILE__, __LINE__, __FUNCTION__)</td></tr>
<tr class="memdesc:ac1cbf996d2494765c5a52eeec7be7dd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">All warnings are implemented as:: <br /></td></tr>
<tr class="separator:ac1cbf996d2494765c5a52eeec7be7dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94444747f09785049006dcbde8e4ff85" id="r_a94444747f09785049006dcbde8e4ff85"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a94444747f09785049006dcbde8e4ff85">GOOSEFEM_WARNING_PYTHON</a>(message)</td></tr>
<tr class="memdesc:a94444747f09785049006dcbde8e4ff85"><td class="mdescLeft">&#160;</td><td class="mdescRight">All warnings specific to the Python API are implemented as:: <br /></td></tr>
<tr class="separator:a94444747f09785049006dcbde8e4ff85"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:adad35bf4db4c7eb54c25136f0f3d34d1" id="r_adad35bf4db4c7eb54c25136f0f3d34d1"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">typename</a> <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">T</a> , <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">size_t</a> N&gt; </td></tr>
<tr class="memitem:adad35bf4db4c7eb54c25136f0f3d34d1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">using</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM_1_1array__type.html#adad35bf4db4c7eb54c25136f0f3d34d1">GooseFEM::array_type::tensor</a> = xt::xtensor&lt;<a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">T</a>, <a class="el" href="namespaceGooseFEM.html#acb082fa83b6ad7cf3a04bd7a181cce81">N</a>&gt;</td></tr>
<tr class="memdesc:adad35bf4db4c7eb54c25136f0f3d34d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fixed (static) rank array. <br /></td></tr>
<tr class="separator:adad35bf4db4c7eb54c25136f0f3d34d1"><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>Basic configuration: </p>
<ul>
<li>Include general dependencies.</li>
<li>Define assertions.</li>
</ul>
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright 2017. Tom de Geus. All rights reserved. </dd></dl>
<dl class="section user"><dt>License: This project is released under the GNU Public License (GPLv3).</dt><dd></dd></dl>
<p class="definition">Definition in file <a class="el" href="config_8h_source.html">config.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a391cf2265f217c503ef4c35e6422b409" name="a391cf2265f217c503ef4c35e6422b409"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a391cf2265f217c503ef4c35e6422b409">&#9670;&#160;</a></span>GOOSEFEM_ASSERT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GOOSEFEM_ASSERT</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">expr</span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>All assertions are implementation as:: </p>
<pre class="fragment"> GOOSEFEM_ASSERT(...)
</pre><p> They can be enabled by:: </p><pre class="fragment"> #define GOOSEFEM_ENABLE_ASSERT
</pre><p> (before including <a class="el" href="namespaceGooseFEM.html" title="Toolbox to perform finite element computations.">GooseFEM</a>). The advantage is that:</p>
<ul>
<li>File and line-number are displayed if the assertion fails.</li>
<li><a class="el" href="namespaceGooseFEM.html" title="Toolbox to perform finite element computations.">GooseFEM</a>'s assertions can be enabled/disabled independently from those of other libraries.</li>
</ul>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td></td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00097">97</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="ab83a10086e0a82fcd0cb6c2d3d015534" name="ab83a10086e0a82fcd0cb6c2d3d015534"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab83a10086e0a82fcd0cb6c2d3d015534">&#9670;&#160;</a></span>GOOSEFEM_CHECK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GOOSEFEM_CHECK</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">expr</span></td><td>)</td>
<td>&#160;&#160;&#160;GOOSEFEM_ASSERT_IMPL(expr, __FILE__, __LINE__, __FUNCTION__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Assertion that cannot be switched off. </p>
<p>Implement assertion by:: </p><pre class="fragment"> GOOSEFEM_CHECK(...)
</pre> <dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td></td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00107">107</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="ac1cbf996d2494765c5a52eeec7be7dd0" name="ac1cbf996d2494765c5a52eeec7be7dd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1cbf996d2494765c5a52eeec7be7dd0">&#9670;&#160;</a></span>GOOSEFEM_WARNING</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GOOSEFEM_WARNING</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">message</span></td><td>)</td>
<td>&#160;&#160;&#160;GOOSEFEM_WARNING_IMPL(message, __FILE__, __LINE__, __FUNCTION__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>All warnings are implemented as:: </p>
<pre class="fragment"> GOOSEFEM_WARNING(...)
</pre><p> They can be disabled by:: </p><pre class="fragment"> #define GOOSEFEM_DISABLE_WARNING
</pre>
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00131">131</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="a94444747f09785049006dcbde8e4ff85" name="a94444747f09785049006dcbde8e4ff85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94444747f09785049006dcbde8e4ff85">&#9670;&#160;</a></span>GOOSEFEM_WARNING_PYTHON</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GOOSEFEM_WARNING_PYTHON</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">message</span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>All warnings specific to the Python API are implemented as:: </p>
<pre class="fragment"> GOOSEFEM_WARNING_PYTHON(...)
</pre><p> They can be enabled by:: </p><pre class="fragment"> #define GOOSEFEM_ENABLE_WARNING_PYTHON
</pre>
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00147">147</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="a57e912a0860dacf27f1c506763b82816" name="a57e912a0860dacf27f1c506763b82816"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57e912a0860dacf27f1c506763b82816">&#9670;&#160;</a></span>GOOSEFEM_WIP_ASSERT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GOOSEFEM_WIP_ASSERT</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">expr</span></td><td>)</td>
<td>&#160;&#160;&#160;GOOSEFEM_ASSERT_IMPL(expr, __FILE__, __LINE__, __FUNCTION__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Assertion that concerns temporary implementation limitations. </p>
<p>Implement assertion by:: </p><pre class="fragment"> GOOSEFEM_WIP_ASSERT(...)
</pre> <dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td></td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="config_8h_source.html#l00117">117</a> of file <a class="el" href="config_8h_source.html">config.h</a>.</p>
</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="dir_3769e65ebf8802393a9ec6629f7d9d6e.html">GooseFEM</a></li><li class="navelem"><a class="el" href="config_8h.html">config.h</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.10.0 </li>
</ul>
</div>
</body>
</html>

Event Timeline

c4science · Help