Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F83077593
structvoro_1_1wall__plane.html
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Sun, Sep 15, 02:18
Size
14 KB
Mime Type
text/html
Expires
Tue, Sep 17, 02:18 (2 d)
Engine
blob
Format
Raw Data
Handle
20783014
Attached To
rLAMMPS lammps
structvoro_1_1wall__plane.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++: voro::wall_plane 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=
"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
class=
"current"
><a
href=
"annotated.html"
><span>
Data
 
Structures
</span></a></li>
<li><a
href=
"files.html"
><span>
Files
</span></a></li>
</ul>
</div>
<div
id=
"navrow2"
class=
"tabs2"
>
<ul
class=
"tablist"
>
<li><a
href=
"annotated.html"
><span>
Data
 
Structures
</span></a></li>
<li><a
href=
"hierarchy.html"
><span>
Class
 
Hierarchy
</span></a></li>
<li><a
href=
"functions.html"
><span>
Data
 
Fields
</span></a></li>
</ul>
</div>
<div
id=
"nav-path"
class=
"navpath"
>
<ul>
<li
class=
"navelem"
><b>
voro
</b></li><li
class=
"navelem"
><a
class=
"el"
href=
"structvoro_1_1wall__plane.html"
>
wall_plane
</a></li>
</ul>
</div>
</div>
<!-- top -->
<div
class=
"header"
>
<div
class=
"summary"
>
<a
href=
"#pub-methods"
>
Public Member Functions
</a>
</div>
<div
class=
"headertitle"
>
<div
class=
"title"
>
voro::wall_plane Struct Reference
</div>
</div>
</div>
<!--header-->
<div
class=
"contents"
>
<p>
A class representing a plane wall object.
<a
href=
"structvoro_1_1wall__plane.html#details"
>
More...
</a></p>
<p><code>
#include
<
<a
class=
"el"
href=
"wall_8hh_source.html"
>
wall.hh
</a>
>
</code></p>
<div
id=
"dynsection-0"
onclick=
"return toggleVisibility(this)"
class=
"dynheader closed"
style=
"cursor:pointer;"
>
<img
id=
"dynsection-0-trigger"
src=
"closed.png"
alt=
"+"
/>
Inheritance diagram for voro::wall_plane:
</div>
<div
id=
"dynsection-0-summary"
class=
"dynsummary"
style=
"display:block;"
>
</div>
<div
id=
"dynsection-0-content"
class=
"dyncontent"
style=
"display:none;"
>
<div
class=
"center"
>
<img
src=
"structvoro_1_1wall__plane.png"
usemap=
"#voro::wall_plane_map"
alt=
""
/>
<map
id=
"voro::wall_plane_map"
name=
"voro::wall_plane_map"
>
<area
href=
"classvoro_1_1wall.html"
title=
"Pure virtual class from which wall objects are derived."
alt=
"voro::wall"
shape=
"rect"
coords=
"0,0,104,24"
/>
</map>
</div></div>
<table
class=
"memberdecls"
>
<tr
class=
"heading"
><td
colspan=
"2"
><h2><a
name=
"pub-methods"
></a>
Public Member Functions
</h2></td></tr>
<tr
class=
"memitem:adb486dd12e7369e4791b625f362c4df2"
><td
class=
"memItemLeft"
align=
"right"
valign=
"top"
>
 
</td><td
class=
"memItemRight"
valign=
"bottom"
><a
class=
"el"
href=
"structvoro_1_1wall__plane.html#adb486dd12e7369e4791b625f362c4df2"
>
wall_plane
</a>
(double xc_, double yc_, double zc_, double ac_, int w_id_=-99)
</td></tr>
<tr
class=
"memitem:a8168f370f6817ccbd4870b1494b4321d"
><td
class=
"memItemLeft"
align=
"right"
valign=
"top"
>
bool
 
</td><td
class=
"memItemRight"
valign=
"bottom"
><a
class=
"el"
href=
"structvoro_1_1wall__plane.html#a8168f370f6817ccbd4870b1494b4321d"
>
point_inside
</a>
(double x, double y, double z)
</td></tr>
<tr
class=
"memitem:a8d2515cef30dbd7594a4403d502b4fe5"
><td
class=
"memTemplParams"
colspan=
"2"
>
template
<
class v_cell
>
</td></tr>
<tr
class=
"memitem:a8d2515cef30dbd7594a4403d502b4fe5"
><td
class=
"memTemplItemLeft"
align=
"right"
valign=
"top"
>
bool
 
</td><td
class=
"memTemplItemRight"
valign=
"bottom"
><a
class=
"el"
href=
"structvoro_1_1wall__plane.html#a8d2515cef30dbd7594a4403d502b4fe5"
>
cut_cell_base
</a>
(v_cell
&
c, double x, double y, double z)
</td></tr>
<tr
class=
"memitem:a879c5551eb1d97677b0b0651b7da0ddd"
><td
class=
"memItemLeft"
align=
"right"
valign=
"top"
>
bool
 
</td><td
class=
"memItemRight"
valign=
"bottom"
><a
class=
"el"
href=
"structvoro_1_1wall__plane.html#a879c5551eb1d97677b0b0651b7da0ddd"
>
cut_cell
</a>
(
<a
class=
"el"
href=
"classvoro_1_1voronoicell.html"
>
voronoicell
</a>
&
c, double x, double y, double z)
</td></tr>
<tr
class=
"memitem:ae2103d51a50887cea07671b4e8a0b713"
><td
class=
"memItemLeft"
align=
"right"
valign=
"top"
>
bool
 
</td><td
class=
"memItemRight"
valign=
"bottom"
><a
class=
"el"
href=
"structvoro_1_1wall__plane.html#ae2103d51a50887cea07671b4e8a0b713"
>
cut_cell
</a>
(
<a
class=
"el"
href=
"classvoro_1_1voronoicell__neighbor.html"
>
voronoicell_neighbor
</a>
&
c, double x, double y, double z)
</td></tr>
</table>
<hr/><a
name=
"details"
id=
"details"
></a><h2>
Detailed Description
</h2>
<div
class=
"textblock"
><p>
This class represents a single plane wall object.
</p>
<p>
Definition at line
<a
class=
"el"
href=
"wall_8hh_source.html#l00044"
>
44
</a>
of file
<a
class=
"el"
href=
"wall_8hh_source.html"
>
wall.hh
</a>
.
</p>
</div><hr/><h2>
Constructor
&
Destructor Documentation
</h2>
<a
class=
"anchor"
id=
"adb486dd12e7369e4791b625f362c4df2"
></a>
<div
class=
"memitem"
>
<div
class=
"memproto"
>
<table
class=
"mlabels"
>
<tr>
<td
class=
"mlabels-left"
>
<table
class=
"memname"
>
<tr>
<td
class=
"memname"
>
voro::wall_plane::wall_plane
</td>
<td>
(
</td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
xc_
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
yc_
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
zc_
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
ac_
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
int
 
</td>
<td
class=
"paramname"
><em>
w_id_
</em>
=
<code>
-99
</code>
 
</td>
</tr>
<tr>
<td></td>
<td>
)
</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>
Constructs a plane wall object.
</p>
<dl
class=
"params"
><dt>
Parameters:
</dt><dd>
<table
class=
"params"
>
<tr><td
class=
"paramdir"
>
[in]
</td><td
class=
"paramname"
>
(xc_,yc_,zc_)
</td><td>
a normal vector to the plane.
</td></tr>
<tr><td
class=
"paramdir"
>
[in]
</td><td
class=
"paramname"
>
ac_
</td><td>
a displacement along the normal vector.
</td></tr>
<tr><td
class=
"paramdir"
>
[in]
</td><td
class=
"paramname"
>
w_id_
</td><td>
an ID number to associate with the wall for neighbor tracking.
</td></tr>
</table>
</dd>
</dl>
<p>
Definition at line
<a
class=
"el"
href=
"wall_8hh_source.html#l00051"
>
51
</a>
of file
<a
class=
"el"
href=
"wall_8hh_source.html"
>
wall.hh
</a>
.
</p>
</div>
</div>
<hr/><h2>
Member Function Documentation
</h2>
<a
class=
"anchor"
id=
"a879c5551eb1d97677b0b0651b7da0ddd"
></a>
<div
class=
"memitem"
>
<div
class=
"memproto"
>
<table
class=
"mlabels"
>
<tr>
<td
class=
"mlabels-left"
>
<table
class=
"memname"
>
<tr>
<td
class=
"memname"
>
bool voro::wall_plane::cut_cell
</td>
<td>
(
</td>
<td
class=
"paramtype"
><a
class=
"el"
href=
"classvoro_1_1voronoicell.html"
>
voronoicell
</a>
& 
</td>
<td
class=
"paramname"
><em>
c
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
x
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
y
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
z
</em>
 
</td>
</tr>
<tr>
<td></td>
<td>
)
</td>
<td></td><td></td>
</tr>
</table>
</td>
<td
class=
"mlabels-right"
>
<span
class=
"mlabels"
><span
class=
"mlabel"
>
inline
</span><span
class=
"mlabel"
>
virtual
</span></span>
</td>
</tr>
</table>
</div><div
class=
"memdoc"
>
<p>
A pure virtual function for cutting a cell without neighbor-tracking with a wall.
</p>
<p>
Implements
<a
class=
"el"
href=
"classvoro_1_1wall.html#ab54b4c6d37223584f1fbf653d0b17d14"
>
voro::wall
</a>
.
</p>
<p>
Definition at line
<a
class=
"el"
href=
"wall_8hh_source.html#l00056"
>
56
</a>
of file
<a
class=
"el"
href=
"wall_8hh_source.html"
>
wall.hh
</a>
.
</p>
</div>
</div>
<a
class=
"anchor"
id=
"ae2103d51a50887cea07671b4e8a0b713"
></a>
<div
class=
"memitem"
>
<div
class=
"memproto"
>
<table
class=
"mlabels"
>
<tr>
<td
class=
"mlabels-left"
>
<table
class=
"memname"
>
<tr>
<td
class=
"memname"
>
bool voro::wall_plane::cut_cell
</td>
<td>
(
</td>
<td
class=
"paramtype"
><a
class=
"el"
href=
"classvoro_1_1voronoicell__neighbor.html"
>
voronoicell_neighbor
</a>
& 
</td>
<td
class=
"paramname"
><em>
c
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
x
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
y
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
z
</em>
 
</td>
</tr>
<tr>
<td></td>
<td>
)
</td>
<td></td><td></td>
</tr>
</table>
</td>
<td
class=
"mlabels-right"
>
<span
class=
"mlabels"
><span
class=
"mlabel"
>
inline
</span><span
class=
"mlabel"
>
virtual
</span></span>
</td>
</tr>
</table>
</div><div
class=
"memdoc"
>
<p>
A pure virtual function for cutting a cell with neighbor-tracking enabled with a wall.
</p>
<p>
Implements
<a
class=
"el"
href=
"classvoro_1_1wall.html#a1e246285ea5a5879e4370db9633e75a6"
>
voro::wall
</a>
.
</p>
<p>
Definition at line
<a
class=
"el"
href=
"wall_8hh_source.html#l00057"
>
57
</a>
of file
<a
class=
"el"
href=
"wall_8hh_source.html"
>
wall.hh
</a>
.
</p>
</div>
</div>
<a
class=
"anchor"
id=
"a8d2515cef30dbd7594a4403d502b4fe5"
></a>
<div
class=
"memitem"
>
<div
class=
"memproto"
>
<div
class=
"memtemplate"
>
template
<
class v_cell
>
</div>
<table
class=
"memname"
>
<tr>
<td
class=
"memname"
>
bool voro::wall_plane::cut_cell_base
</td>
<td>
(
</td>
<td
class=
"paramtype"
>
v_cell
& 
</td>
<td
class=
"paramname"
><em>
c
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
x
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
y
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
z
</em>
 
</td>
</tr>
<tr>
<td></td>
<td>
)
</td>
<td></td><td></td>
</tr>
</table>
</div><div
class=
"memdoc"
>
<p>
Cuts a cell by the plane wall object.
</p>
<dl
class=
"params"
><dt>
Parameters:
</dt><dd>
<table
class=
"params"
>
<tr><td
class=
"paramdir"
>
[in,out]
</td><td
class=
"paramname"
>
c
</td><td>
the Voronoi cell to be cut.
</td></tr>
<tr><td
class=
"paramdir"
>
[in]
</td><td
class=
"paramname"
>
(x,y,z)
</td><td>
the location of the Voronoi cell.
</td></tr>
</table>
</dd>
</dl>
<dl
class=
"section return"
><dt>
Returns:
</dt><dd>
True if the cell still exists, false if the cell is deleted.
</dd></dl>
<p>
Definition at line
<a
class=
"el"
href=
"wall_8cc_source.html#l00050"
>
50
</a>
of file
<a
class=
"el"
href=
"wall_8cc_source.html"
>
wall.cc
</a>
.
</p>
</div>
</div>
<a
class=
"anchor"
id=
"a8168f370f6817ccbd4870b1494b4321d"
></a>
<div
class=
"memitem"
>
<div
class=
"memproto"
>
<table
class=
"mlabels"
>
<tr>
<td
class=
"mlabels-left"
>
<table
class=
"memname"
>
<tr>
<td
class=
"memname"
>
bool voro::wall_plane::point_inside
</td>
<td>
(
</td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
x
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
y
</em>
,
</td>
</tr>
<tr>
<td
class=
"paramkey"
></td>
<td></td>
<td
class=
"paramtype"
>
double
 
</td>
<td
class=
"paramname"
><em>
z
</em>
 
</td>
</tr>
<tr>
<td></td>
<td>
)
</td>
<td></td><td></td>
</tr>
</table>
</td>
<td
class=
"mlabels-right"
>
<span
class=
"mlabels"
><span
class=
"mlabel"
>
virtual
</span></span>
</td>
</tr>
</table>
</div><div
class=
"memdoc"
>
<p>
Tests to see whether a point is inside the plane wall object.
</p>
<dl
class=
"params"
><dt>
Parameters:
</dt><dd>
<table
class=
"params"
>
<tr><td
class=
"paramdir"
>
[in]
</td><td
class=
"paramname"
>
(x,y,z)
</td><td>
the vector to test.
</td></tr>
</table>
</dd>
</dl>
<dl
class=
"section return"
><dt>
Returns:
</dt><dd>
True if the point is inside, false if the point is outside.
</dd></dl>
<p>
Implements
<a
class=
"el"
href=
"classvoro_1_1wall.html#ae49edf1ae1036be9ffaa5c2bd7fcd82d"
>
voro::wall
</a>
.
</p>
<p>
Definition at line
<a
class=
"el"
href=
"wall_8cc_source.html#l00041"
>
41
</a>
of file
<a
class=
"el"
href=
"wall_8cc_source.html"
>
wall.cc
</a>
.
</p>
</div>
</div>
<hr/>
The documentation for this struct was generated from the following files:
<ul>
<li><a
class=
"el"
href=
"wall_8hh_source.html"
>
wall.hh
</a></li>
<li><a
class=
"el"
href=
"wall_8cc_source.html"
>
wall.cc
</a></li>
</ul>
</div>
<!-- contents -->
<!-- start footer part -->
<hr
class=
"footer"
/><address
class=
"footer"
><small>
Generated on Fri Jul 27 2012 21:53:31 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>
Event Timeline
Log In to Comment