Page MenuHomec4science
Files F119395692

version_8h.html
No OneTemporary
Actions

File Metadata

Created
Thu, Jun 26, 13:25

version_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/version.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('version_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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">version.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Version information.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="config_8h_source.html">config.h</a>&quot;</code><br />
</div>
<p><a href="version_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>
</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:ac0aa5c2e2f5cf19640e4a8eee5d3f552" id="r_ac0aa5c2e2f5cf19640e4a8eee5d3f552"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac0aa5c2e2f5cf19640e4a8eee5d3f552">GOOSEFEM_VERSION</a>&#160;&#160;&#160;&quot;@PROJECT_VERSION@&quot;</td></tr>
<tr class="memdesc:ac0aa5c2e2f5cf19640e4a8eee5d3f552"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current version. <br /></td></tr>
<tr class="separator:ac0aa5c2e2f5cf19640e4a8eee5d3f552"><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:a022c22b8131b0958dbf07d86ae08af16" id="r_a022c22b8131b0958dbf07d86ae08af16"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM.html#a022c22b8131b0958dbf07d86ae08af16">GooseFEM::version</a> ()</td></tr>
<tr class="memdesc:a022c22b8131b0958dbf07d86ae08af16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return version string, e.g. <br /></td></tr>
<tr class="separator:a022c22b8131b0958dbf07d86ae08af16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2657752229dbc35738f1971cfa363b1" id="r_ae2657752229dbc35738f1971cfa363b1"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGooseFEM.html#ae2657752229dbc35738f1971cfa363b1">GooseFEM::version_dependencies</a> ()</td></tr>
<tr class="memdesc:ae2657752229dbc35738f1971cfa363b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return versions of this library and of all of its dependencies. <br /></td></tr>
<tr class="separator:ae2657752229dbc35738f1971cfa363b1"><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>Version information. </p>
<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="version_8h_source.html">version.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ac0aa5c2e2f5cf19640e4a8eee5d3f552" name="ac0aa5c2e2f5cf19640e4a8eee5d3f552"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0aa5c2e2f5cf19640e4a8eee5d3f552">&#9670;&#160;</a></span>GOOSEFEM_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GOOSEFEM_VERSION&#160;&#160;&#160;&quot;@PROJECT_VERSION@&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current version. </p>
<p>Either:</p>
<ul>
<li>Configure using CMake at install time. Internally uses:: <pre class="fragment"> python -c "from setuptools_scm import get_version; print(get_version())"
</pre></li>
<li>Define externally using:: <pre class="fragment"> MYVERSION=`python -c "from setuptools_scm import get_version; print(get_version())"`
-DGOOSEFEM_VERSION="$MYVERSION"
</pre> From the root of this project. This is what <code>setup.py</code> does.</li>
</ul>
<p>Note that both <code>CMakeLists.txt</code> and <code>setup.py</code> will construct the version using <code>setuptools_scm</code>. Tip: use the environment variable <code>SETUPTOOLS_SCM_PRETEND_VERSION</code> to overwrite the automatic version. </p>
<p class="definition">Definition at line <a class="el" href="version_8h_source.html#l00035">35</a> of file <a class="el" href="version_8h_source.html">version.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="version_8h.html">version.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