From c3a32dde123042fb5bf21ec96a5c1635e0f23661 Mon Sep 17 00:00:00 2001
From: Trung Nguyen <ndactrung@gmail.com>
Date: Wed, 11 Jul 2018 00:21:49 -0500
Subject: [PATCH] Updated doc/body.txt for body rounded/polygon and
rounded/polyhedron
---
doc/src/body.txt | 79 ++++++++++++++++++++++++++++--------------------
1 file changed, 47 insertions(+), 32 deletions(-)
diff --git a/doc/src/body.txt b/doc/src/body.txt
index c272f48ad1..0e64e6ad5b 100644
--- a/doc/src/body.txt
+++ b/doc/src/body.txt
@@ -36,7 +36,7 @@ thus how they can be used to compute pairwise body/body or
bond/non-body (point particle) interactions. More details of each
style are described below.
-More styles ma be added in the future. See "Section
+More styles may be added in the future. See "Section
10.12"_Section_modify.html#mod_12 for details on how to add a new body
style to the code.
@@ -182,7 +182,7 @@ The {rounded/polygon} body style represents body particles as a 2d
polygon with a variable number of N vertices. This style can only be
used for 2d models; see the "boundary"_boundary.html command.
-NOTE: include a diagram of a a rounded polygon body particle
+NOTE: include a diagram of a rounded polygon body particle
Special cases for N = 1 (spheres) and N = 2 (rods) are also included.
One use of this body style is for 2d discrete element models, as
@@ -219,12 +219,11 @@ list 6 moments of inertia followed by the coordinates of the N
vertices (x1 to zN) as 3N values (with z = 0.0 for each), followed by
2N vertex indices corresponding to the end points of the N edges,
followed by a single diameter value = the rounded diameter of the
-circle that surrounds each vertex. These floating-point values can be
+circle that surrounds each vertex. The diameter value can be different
+for each body particle. These floating-point values can be
listed on as many lines as you wish; see the
"read_data"_read_data.html command for more details.
-NOTE: can the diameter value be different for each body particle?
-
The 6 moments of inertia (ixx,iyy,izz,ixy,ixz,iyz) should be the
values consistent with the current orientation of the rigid body
around its center of mass. The values are with respect to the
@@ -236,9 +235,9 @@ position of the particle is specified by the x,y,z values in the
{Atoms} section of the data file.
For example, the following information would specify a square particle
-whose edge length is sqrt(2):
-
-NOTE: oriented how?
+whose edge length is sqrt(2) and rounded diameter is 1.0 in length unit
+and initial orientation is determined from the 6 moments of inertia
+(ixx iyy izz ixy ixz iyz):
3 1 27
4
@@ -268,12 +267,12 @@ polyhedron with a variable number of N vertices, E edges and F faces.
This style can only be used for 3d models; see the
"boundary"_boundary.html command.
-NOTE: include a diagram of a a rounded polyhedron body particle
+NOTE: include a diagram of a rounded polyhedron body particle
-Special cases for N = 1 (spheres) and N = 2 (rods) are also valid.
+NOTE: 2d objects can also be specified as a special case, e.g.
+for a triangle, N = 3, E = 3 and F = 1.
-NOTE: can 2d objects also be specified as a special case, e.g. a
-triangle?
+Special cases for N = 1 (spheres) and N = 2 (rods) are also valid.
This body style is for 3d discrete element models, as described in
"Wang"_#Wang.
@@ -316,8 +315,9 @@ edges (E) and number of faces (F). The floating point line(s) list 6
moments of inertia followed by the coordinates of the N vertices (x1
to zN) as 3N values, followed by 2N vertex indices corresponding to
the end points of the E edges, then 4*F vertex indices defining F
-faces. The last value is the radius value = the rounded diameter of
-the sphere that surrounds each vertex. These floating-point values
+faces. The last value is the diameter value = the rounded diameter of
+the sphere that surrounds each vertex. The diameter value can be different
+for each body particle. These floating-point values
can be listed on as many lines as you wish; see the
"read_data"_read_data.html command for more details. Because the
maxmimum vertices per face is hard-coded to be 4
@@ -325,10 +325,9 @@ maxmimum vertices per face is hard-coded to be 4
split into triangles or quadrilaterals. For triangular faces, the
last vertex index should be set to -1.
-NOTE: is there some right-hand rule for the ordering of the 4 vertices
-within each face?
-
-NOTE: can the diameter value be different for each body particle?
+The ordering of the 4 vertices within a face should follow
+the right-hand rule so that the normal vector of the face points
+outwards from the center of mass.
The 6 moments of inertia (ixx,iyy,izz,ixy,ixz,iyz) should be the
values consistent with the current orientation of the rigid body
@@ -341,24 +340,40 @@ position of the particle is specified by the x,y,z values in the
{Atoms} section of the data file.
For example, the following information would specify a cubic particle
-whose edge length is 1.0:
-
-NOTE: oriented how?
-
-NOTE: fill in these values correctly
-
-3 1 27
-4
-1 1 4 0 0 0
--0.7071 -0.7071 0
--0.7071 0.7071 0
-0.7071 0.7071 0
-0.7071 -0.7071 0
+whose edge length is 2.0 and rounded diameter is 0.5 in length unit
+and initial orientation is determined from the 6 moments of inertia
+(ixx iyy izz ixy ixz iyz):
+
+1 3 79
+8 12 6
+0.667 0.667 0.667 0 0 0
+1 1 1
+1 -1 1
+-1 -1 1
+-1 1 1
+1 1 -1
+1 -1 -1
+-1 -1 -1
+-1 1 -1
0 1
1 2
2 3
3 0
-1.0 :pre
+4 5
+5 6
+6 7
+7 4
+0 4
+1 5
+2 6
+3 7
+0 1 2 3
+4 5 6 7
+0 1 5 4
+1 2 6 5
+2 3 7 6
+3 0 4 7
+0.5 :pre
:line
--
GitLab