yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 2527
committer: Bruno Chareyre <bruno.chareyre@xxxxxxxxxxx>
branch nick: yade
timestamp: Tue 2010-11-02 18:40:46 +0100
message:
  - add example commands in docstring.
modified:
  pkg/dem/TesselationWrapper.hpp


--
lp:yade
https://code.launchpad.net/~yade-dev/yade/trunk

Your team Yade developers is subscribed to branch lp:yade.
To unsubscribe from this branch go to https://code.launchpad.net/~yade-dev/yade/trunk/+edit-subscription

=== modified file 'pkg/dem/TesselationWrapper.hpp'
--- pkg/dem/TesselationWrapper.hpp	2010-11-02 16:23:44 +0000
+++ pkg/dem/TesselationWrapper.hpp	2010-11-02 17:40:46 +0000
@@ -28,7 +28,7 @@
  *O.run(100) //for unknown reasons, this procedure crashes at iteration 0
  *TW=TesselationWrapper()
  *TW.triangulate(O._sceneObj()) //compute regular Delaunay triangulation, don't construct tesselation
- *TW.computeVolumes() //will silently tesselate the packing, then assign volumes to each Voronoi cell
+ *TW.computeVolumes() //will silently tesselate the packing
  *TW.volume(10) //get volume associated to sphere of id 10
  * 
  */
@@ -93,7 +93,7 @@
 	CGT::Finite_edges_iterator facet_it;
 	MicroMacroAnalyser mma;
 	
-	YADE_CLASS_BASE_DOC_ATTRS_CTOR_PY(TesselationWrapper,GlobalEngine,"Handle the triangulation of spheres in a scene, build tesselation on request, and give access to computed quantities : currently volume and porosity of each Voronoï sphere.",
+	YADE_CLASS_BASE_DOC_ATTRS_CTOR_PY(TesselationWrapper,GlobalEngine,"Handle the triangulation of spheres in a scene, build tesselation on request, and give access to computed quantities : currently volume and porosity of each Voronoï sphere. Example script :\n tt=TriaxialTest()\ntt.generate('test.xml')\nO.load('test.xml')\nO.run(100) //for unknown reasons, this procedure crashes at iteration 0\nTW=TesselationWrapper()\nTW.triangulate(O._sceneObj()) //compute regular Delaunay triangulation, don't construct tesselation\nTW.computeVolumes() //will silently tesselate the packing\nTW.volume(10) //get volume associated to sphere of id 10",
 	((unsigned int,n_spheres,0,,"|ycomp|"))
 	,/*ctor*/
   	Tes = new CGT::Tesselation;