<a href="rad__option_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="l00018"></a><span class="lineno"> 18</span> <span class="comment">/** \brief Class containing all of the routines that are specific to computing </span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * The container and container_periodic classes are derived from this class,</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * and during the Voronoi cell computation, these routines are used to create</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="classvoro_1_1radius__mono.html"> 24</a></span> <span class="keyword">class </span><a class="code" href="classvoro_1_1radius__mono.html" title="Class containing all of the routines that are specific to computing the regular Voronoi tessellation...">radius_mono</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> /** This is called prior to computing a Voronoi cell for a</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * given particle to initialize any required constants.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * \param[in] ijk the block that the particle is within.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * \param[in] s the index of the particle within the block. */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /** Sets a required constant to be used when carrying out a</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /** Carries out a radius bounds check.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * \param[in] crs the radius squared to be tested.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * \param[in] mrs the current maximum distance to a Voronoi</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * \return True if particles at this radius could not possibly</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /** Adds the maximum radius squared to a given value.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * \param[in] rs the value to consider.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * \return The value with the radius squared added. */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /** Subtracts the radius squared of a particle from a given </span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * \param[in] rs the value to consider.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * \param[in] ijk the block that the particle is within.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * \param[in] q the index of the particle within the block. </span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * \return The value with the radius squared subtracted. */</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> /** Scales a plane displacement prior to use in the plane cutting</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * \param[in] ijk the block that the particle is within.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * \param[in] q the index of the particle within the block.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /** Scales a plane displacement prior to use in the plane</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * cutting algorithm, and also checks if it could possibly cut</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * the cell.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * \param[in,out] rs the plane displacement to be scaled.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * \param[in] mrs the current maximum distance to a Voronoi</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * \param[in] ijk the block that the particle is within.</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * \param[in] q the index of the particle within the block.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * \return True if the cell could possibly cut the cell, false</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/** \brief Class containing all of the routines that are specific to computing </span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * The container_poly and container_periodic_poly classes are derived from this</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * class, and during the Voronoi cell computation, these routines are used to</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="code" href="classvoro_1_1radius__poly.html"> 82</a></span> <span class="keyword">class </span><a class="code" href="classvoro_1_1radius__poly.html" title="Class containing all of the routines that are specific to computing the radical Voronoi tessellation...">radius_poly</a> {</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> /** The current maximum radius of any particle, used to</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * determine when to cut off the radical Voronoi computation.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /** The class constructor sets the maximum particle radius to</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * be zero. */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> /** This is called prior to computing a Voronoi cell for a</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * given particle to initialize any required constants.</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * \param[in] ijk the block that the particle is within.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * \param[in] s the index of the particle within the block. */</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /** Sets a required constant to be used when carrying out a</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> /** Carries out a radius bounds check.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * \param[in] crs the radius squared to be tested.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * \param[in] mrs the current maximum distance to a Voronoi</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * \return True if particles at this radius could not possibly</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> /** Adds the maximum radius squared to a given value.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * \param[in] rs the value to consider.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * \return The value with the radius squared added. */</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> /** Subtracts the radius squared of a particle from a given </span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * \param[in] rs the value to consider.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * \param[in] ijk the block that the particle is within.</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * \param[in] q the index of the particle within the block. </span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * \return The value with the radius squared subtracted. */</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /** Scales a plane displacement prior to use in the plane cutting</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * \param[in] ijk the block that the particle is within.</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * \param[in] q the index of the particle within the block.</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> /** Scales a plane displacement prior to use in the plane</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * cutting algorithm, and also checks if it could possibly cut</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * the cell.</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * \param[in,out] rs the plane displacement to be scaled.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * \param[in] mrs the current maximum distance to a Voronoi</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * \param[in] ijk the block that the particle is within.</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * \param[in] q the index of the particle within the block.</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * \return True if the cell could possibly cut the cell, false</span></div>