yade-dev team mailing list archive
-
yade-dev team
-
Mailing list archive
-
Message #12563
[Branch ~yade-pkg/yade/git-trunk] Rev 3807: improved documentation
------------------------------------------------------------
revno: 3807
committer: Klaus Thoeni <klaus.thoeni@xxxxxxxxx>
timestamp: Fri 2016-03-11 05:21:52 +1100
message:
improved documentation
modified:
pkg/common/Grid.hpp
py/gridpfacet.py
--
lp:yade
https://code.launchpad.net/~yade-pkg/yade/git-trunk
Your team Yade developers is subscribed to branch lp:yade.
To unsubscribe from this branch go to https://code.launchpad.net/~yade-pkg/yade/git-trunk/+edit-subscription
=== modified file 'pkg/common/Grid.hpp'
--- pkg/common/Grid.hpp 2015-12-21 10:50:07 +0000
+++ pkg/common/Grid.hpp 2016-03-10 18:21:52 +0000
@@ -41,12 +41,12 @@
Real getLength();
Vector3r getSegment();
void addPFacet(shared_ptr<Body> PF);
- YADE_CLASS_BASE_DOC_ATTRS_CTOR_PY(GridConnection,Sphere,"GridConnection shape. Component of a grid designed to link two :yref:`GridNodes<GridNode>`. It's highly recommended to use utils.gridConnection(...) to generate correct :yref:`GridConnections<GridConnection>`.",
+ YADE_CLASS_BASE_DOC_ATTRS_CTOR_PY(GridConnection,Sphere,"GridConnection shape (see [Effeindzourou2016]_, [Bourrier2013]_). Component of a grid designed to link two :yref:`GridNodes<GridNode>`. It is highly recommended to use :yref:`yade.gridpfacet.gridConnection` to generate correct :yref:`GridConnections<GridConnection>`.",
((shared_ptr<Body> , node1 , ,,"First :yref:`Body` the GridConnection is connected to."))
((shared_ptr<Body> , node2 , ,,"Second :yref:`Body` the GridConnection is connected to."))
((bool, periodic, false,,"true if two nodes from different periods are connected."))
((vector<shared_ptr<Body> >,pfacetList,,,"List of :yref:`PFacet<PFacet>` the GridConnection is connected to."))
- ((Vector3i , cellDist , Vector3i(0,0,0),,"missing doc :(")),
+ ((Vector3i , cellDist , Vector3i(0,0,0),,"Distance of bodies in cell size units, if using periodic boundary conditions. Note that periodic boundary conditions for GridConnections have not yet been fully implemented.")),
createIndex();, /*ctor*/
/*py*/
.def("addPFacet",&GridConnection::addPFacet,(boost::python::arg("Body")),"Add a PFacet to the GridConnection.")
@@ -61,8 +61,8 @@
virtual ~GridNode();
void addConnection(shared_ptr<Body> GC);
void addPFacet(shared_ptr<Body> PF);
- YADE_CLASS_BASE_DOC_ATTRS_CTOR_PY(GridNode,Sphere,"GridNode shape, component of a grid.\nTo create a Grid, place the nodes first, they will define the spacial discretisation of it. It's highly recommended to use utils.gridNode(...) to generate correct :yref:`GridNodes<GridNode>`. Note that the GridNodes should only be in an Interaction with other GridNodes. The Sphere-Grid contact is only handled by the :yref:`GridConnections<GridConnection>`.",
- ((vector<shared_ptr<Body> >,pfacetList,,,"List of :yref:`PFacet<PFacet>` the GridConnection is connected to."))
+ YADE_CLASS_BASE_DOC_ATTRS_CTOR_PY(GridNode,Sphere,"GridNode shape, component of a grid.\nTo create a Grid, place the nodes first, they will define the spacial discretisation of it. It is highly recommended to use :yref:`yade.gridpfacet.gridNode` to generate correct :yref:`GridNodes<GridNode>`. Note that the GridNodes should only be in an Interaction with other GridNodes. The Sphere-Grid contact is only handled by the :yref:`GridConnections<GridConnection>`.",
+ ((vector<shared_ptr<Body> >,pfacetList,,,"List of :yref:`PFacets<PFacet>` the GridConnection is connected to."))
((vector<shared_ptr<Body> >,ConnList,,,"List of :yref:`GridConnections<GridConnection>` the GridNode is connected to.")),
/*ctor*/
createIndex();,
@@ -74,7 +74,9 @@
};
REGISTER_SERIALIZABLE(GridNode);
-//!################## PFacet SHAPES #####################
+
+//!################## PFacet SHAPE #####################
+
class PFacet : public Shape {
public:
@@ -83,12 +85,12 @@
Vector3r ne[3];
/// Inscribing cirle radius
Real icr;
- /// Length of the vertice vectors
+ /// Length of the vertice vectors
Real vl[3];
/// Unit vertice vectors
Vector3r vu[3];
- YADE_CLASS_BASE_DOC_ATTRS_CTOR(PFacet,Shape,"PFacet (particle facet) geometry.",
+ YADE_CLASS_BASE_DOC_ATTRS_CTOR(PFacet,Shape,"PFacet (particle facet) geometry (see [Effeindzourou2016]_, [Effeindzourou2015a]_). It is highly recommended to use the helper functions in :yref:`yade.gridpfacet` (e.g., gridpfacet.pfacetCreator1-4) to generate correct :yref:`PFacet<PFacet>` elements.",
((shared_ptr<Body> , node1 , ,,"First :yref:`Body` the Pfacet is connected to."))
((shared_ptr<Body> , node2 , ,,"Second :yref:`Body` the Pfacet is connected to."))
((shared_ptr<Body> , node3 , ,,"third :yref:`Body` the Pfacet is connected to."))
@@ -98,7 +100,7 @@
((Vector3r,normal,Vector3r(NaN,NaN,NaN),(Attr::readonly | Attr::noSave),"PFacet's normal (in local coordinate system)"))
((Real,radius,-1,,"PFacet's radius"))
((Real,area,NaN,(Attr::readonly | Attr::noSave),"PFacet's area"))
- ((Vector3i , cellDist , Vector3i(0,0,0),,"missing doc :("))
+ ((Vector3i , cellDist , Vector3i(0,0,0),,"Distance of bodies in cell size units, if using periodic boundary conditions. Note that periodic boundary conditions for PFacets have not yet been fully implemented."))
,
/* ctor */ createIndex();
);
@@ -107,6 +109,8 @@
REGISTER_CLASS_INDEX(PFacet,Shape);
};
REGISTER_SERIALIZABLE(PFacet);
+
+
//!################## Contact Geometry #####################
//! O-O
=== modified file 'py/gridpfacet.py'
--- py/gridpfacet.py 2015-12-15 12:57:49 +0000
+++ py/gridpfacet.py 2016-03-10 18:21:52 +0000
@@ -6,7 +6,21 @@
# 2015 © Klaus Thoeni <klaus.thoeni@xxxxxxxxx>
"""
-Helper functions for creating cylinders, grids and membranes.
+Helper functions for creating cylinders, grids and membranes. For more details on this type of elements see [Effeindzourou2016]_, [Effeindzourou2015a]_, [Bourrier2013]_,.
+
+For examples using :yref:`GridConnections<GridConnection>`, see
+
+* :ysrc:`examples/grids/CohesiveGridConnectionSphere.py`
+* :ysrc:`examples/grids/GridConnection_Spring.py`
+* :ysrc:`examples/grids/Simple_Grid_Falling.py`
+* :ysrc:`examples/grids/Simple_GridConnection_Falling.py`
+
+For examples using :yref:`PFacets<PFacet>`, see
+
+* :ysrc:`examples/pfacet/gts-pfacet.py`
+* :ysrc:`examples/pfacet/mesh-pfacet.py`
+* :ysrc:`examples/pfacet/pfacetcreators.py`
+
"""
import math,random,doctest,geom,numpy
