common_8hh_source.html
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Wed, Nov 27, 23:00

common_8hh_source.html
View Options

	<!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"/>
	<title>Voro++: common.hh Source File</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="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 style="padding-left: 0.5em;">
	<div id="projectname">Voro++
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.8.1.1 -->
	<div id="navrow1" class="tabs">
	<ul class="tablist">
	<li><a href="index.html"><span>Main Page</span></a></li>
	<li><a href="annotated.html"><span>Data Structures</span></a></li>
	<li class="current"><a href="files.html"><span>Files</span></a></li>
	</ul>
	</div>
	<div id="navrow2" class="tabs2">
	<ul class="tablist">
	<li><a href="files.html"><span>File List</span></a></li>
	<li><a href="globals.html"><span>Globals</span></a></li>
	</ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="headertitle">
	<div class="title">common.hh</div> </div>
	</div><!--header-->
	<div class="contents">
	<a href="common_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Voro++, a 3D cell-based Voronoi library</span></div>
	<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div>
	<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Author : Chris H. Rycroft (LBL / UC Berkeley)</span></div>
	<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Email : chr@alum.mit.edu</span></div>
	<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// Date : August 30th 2011</span></div>
	<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div>
	<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/** \file common.hh</span></div>
	<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * \brief Header file for the small helper functions. */</span></div>
	<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
	<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef VOROPP_COMMON_HH</span></div>
	<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define VOROPP_COMMON_HH</span></div>
	<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div>
	<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <cstdio></span></div>
	<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <cstdlib></span></div>
	<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <vector></span></div>
	<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
	<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "<a class="code" href="config_8hh.html" title="Master configuration file for setting various compile-time options.">config.hh</a>"</span></div>
	<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
	<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>voro {</div>
	<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div>
	<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/** \brief Function for printing fatal error messages and exiting.</span></div>
	<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div>
	<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * Function for printing fatal error messages and exiting.</span></div>
	<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * \param[in] p a pointer to the message to print.</span></div>
	<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * \param[in] status the status code to return with. */</span></div>
	<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> voro_fatal_error(<span class="keyword">const</span> <span class="keywordtype">char</span> *p,<span class="keywordtype">int</span> status) {</div>
	<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  fprintf(stderr,<span class="stringliteral">"voro++: %s\n"</span>,p);</div>
	<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  exit(status);</div>
	<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> }</div>
	<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span></div>
	<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/** \brief Prints a vector of positions.</span></div>
	<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> *</span></div>
	<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * Prints a vector of positions as bracketed triplets.</span></div>
	<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * \param[in] v the vector to print.</span></div>
	<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * \param[in] fp the file stream to print to. */</span></div>
	<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> voro_print_positions(std::vector<double> &v,FILE *fp=stdout) {</div>
	<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">if</span>(v.size()>0) {</div>
	<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  fprintf(fp,<span class="stringliteral">"(%g,%g,%g)"</span>,v[0],v[1],v[2]);</div>
	<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> k=3;(<span class="keywordtype">unsigned</span> int) k<v.size();k+=3) {</div>
	<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  fprintf(fp,<span class="stringliteral">" (%g,%g,%g)"</span>,v[k],v[k+1],v[k+2]);</div>
	<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div>
	<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div>
	<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> }</div>
	<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div>
	<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/** \brief Opens a file and checks the operation was successful.</span></div>
	<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> *</span></div>
	<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * Opens a file, and checks the return value to ensure that the operation</span></div>
	<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * was successful.</span></div>
	<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * \param[in] filename the file to open.</span></div>
	<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * \param[in] mode the cstdio fopen mode to use.</span></div>
	<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * \return The file handle. */</span></div>
	<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">inline</span> FILE* safe_fopen(<span class="keyword">const</span> <span class="keywordtype">char</span> filename,<span class="keyword">const</span> <span class="keywordtype">char</span> mode) {</div>
	<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  FILE *fp=fopen(filename,mode);</div>
	<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">if</span>(fp==NULL) {</div>
	<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  fprintf(stderr,<span class="stringliteral">"voro++: Unable to open file '%s'\n"</span>,filename);</div>
	<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  exit(<a class="code" href="config_8hh.html#a8de7f106cac2556a67bcc61bd364ed38">VOROPP_FILE_ERROR</a>);</div>
	<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div>
	<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> fp;</div>
	<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }</div>
	<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
	<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">void</span> voro_print_vector(std::vector<int> &v,FILE *fp=stdout);</div>
	<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">void</span> voro_print_vector(std::vector<double> &v,FILE *fp=stdout);</div>
	<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">void</span> voro_print_face_vertices(std::vector<int> &v,FILE *fp=stdout);</div>
	<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
	<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div>
	<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
	<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif</span></div>
	</div><!-- fragment --></div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated on Fri Jul 27 2012 21:53:30 for Voro++ by  <a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/>
	</a> 1.8.1.1
	</small></address>
	</body>
	</html>

common_8hh_source.htmlNo OneTemporaryActions

File Metadata

common_8hh_source.htmlView Options

Event Timeline

common_8hh_source.html
No OneTemporary
Actions

common_8hh_source.html
View Options