yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 2856
committer: jduriez <jduriez@c1solimara-l>
branch nick: yade
timestamp: Wed 2011-05-04 14:37:24 +0200
message:
  - still small changes in doc mainly
renamed:
  scripts/normalInelasticity-test.py => examples/normalInelasticity-test.py
modified:
  pkg/common/PeriodicEngines.hpp
  pkg/dem/NormalInelasticMat.hpp
  pkg/dem/NormalInelasticityLaw.hpp
  examples/normalInelasticity-test.py


--
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

=== renamed file 'scripts/normalInelasticity-test.py' => 'examples/normalInelasticity-test.py'
--- scripts/normalInelasticity-test.py	2011-05-04 10:19:03 +0000
+++ examples/normalInelasticity-test.py	2011-05-04 12:37:24 +0000
@@ -7,9 +7,9 @@
 
 #Different graphs illustrate the effects of the different loadings. The run is paused at each plot window (so that there is time to observe them). Push on "Return", while being in the Yade terminal, to go ahead.
 
-# Comment/decomment around l.18-19 and l.38 to execute the script with Law2_ScGeom_FrictPhys_CundallStrack, to see the difference
+# Comment/uncomment around l.18-19 and l.38 to execute the script with Law2_ScGeom_FrictPhys_CundallStrack, to see the difference
 
-#No crash warranty with r2676 and r2849
+#No crash warranty with r2676 and r2852 +/-2
 
 
 from yade import plot

=== modified file 'pkg/common/PeriodicEngines.hpp'
--- pkg/common/PeriodicEngines.hpp	2011-05-04 10:19:03 +0000
+++ pkg/common/PeriodicEngines.hpp	2011-05-04 12:37:24 +0000
@@ -41,13 +41,13 @@
 		start counting period (realLast etc interal variables) from that point, but without actually running, and will run \
 		only once a period has elapsed since the initial run. \n\n\
 		\
-		This class should be used directly; rather, derive your own engine which you want to be run periodically. \n\n\
+		This class should not be used directly; rather, derive your own engine which you want to be run periodically. \n\n\
 		\
 		Derived engines should override Engine::action(), which will be called periodically. If the derived Engine \
 		overrides also Engine::isActivated, it should also take in account return value from PeriodicEngine::isActivated, \
 		since otherwise the periodicity will not be functional. \n\n\
 		\
-		Example with :yref`PyRunner`, which derives from PeriodicEngine; likely to be encountered in python scripts:: \n\n\
+		Example with :yref:`PyRunner`, which derives from PeriodicEngine; likely to be encountered in python scripts:: \n\n\
 		\
 			PyRunner(realPeriod=5,iterPeriod=10000,command='print O.iter')	\n\n\
 		\

=== modified file 'pkg/dem/NormalInelasticMat.hpp'
--- pkg/dem/NormalInelasticMat.hpp	2010-11-07 11:46:20 +0000
+++ pkg/dem/NormalInelasticMat.hpp	2011-05-04 12:37:24 +0000
@@ -18,7 +18,7 @@
 		virtual ~NormalInelasticMat ();
 
 /// Serialization
-	YADE_CLASS_BASE_DOC_ATTRS_CTOR(NormalInelasticMat,FrictMat,"Material class for particles whose contact obey to a normal inelasticity (governed by this *coeff_dech*).",
+	YADE_CLASS_BASE_DOC_ATTRS_CTOR(NormalInelasticMat,FrictMat,"Material class for particles whose contact obey to a normal inelasticity (governed by this :yref:`coeff_dech<NormalInelasticMat::coeff_dech>`).",
 		((Real,coeff_dech,1.0,,"=kn(unload) / kn(load)"))
 		,
 		createIndex();

=== modified file 'pkg/dem/NormalInelasticityLaw.hpp'
--- pkg/dem/NormalInelasticityLaw.hpp	2011-05-04 10:19:03 +0000
+++ pkg/dem/NormalInelasticityLaw.hpp	2011-05-04 12:37:24 +0000
@@ -33,9 +33,9 @@
 
 	YADE_CLASS_BASE_DOC_ATTRS_CTOR(Law2_ScGeom6D_NormalInelasticityPhys_NormalInelasticity,
 				LawFunctor,
-				"Contact law used to simulate granulate filler in rock joints [Duriez2009a]_, [Duriez2011]_. It includes possibility of cohesion, moment transfer and inelastic compression behaviour (to reproduce the normal inelasticity observed for rock joints, for the latter).\n\n The moment transfer relation corresponds to the adaptation of the work of Plassiard & Belheine (see in [DeghmReport2006]_ for example), which was realized by J. Kozicki, and is now coded in :yref:`ScGeom6D`.\n\n As others :yref:`LawFunctor`, it uses pre-computed data of the interactions (rigidities, friction angles -with their tan()-, orientations of the interactions); this work is done here in :yref:`Ip2_2xNormalInelasticMat_NormalInelasticityPhys`.\n\n To use this you should also use :yref:`NormalInelasticMat` as material type of the bodies.\n\n The effects of this law are illustrated in scripts/normalInelasticityTest.py",
+				"Contact law used to simulate granular filler in rock joints [Duriez2009a]_, [Duriez2011]_. It includes possibility of cohesion, moment transfer and inelastic compression behaviour (to reproduce the normal inelasticity observed for rock joints, for the latter).\n\n The moment transfer relation corresponds to the adaptation of the work of Plassiard & Belheine (see in [DeghmReport2006]_ for example), which was realized by J. Kozicki, and is now coded in :yref:`ScGeom6D`.\n\n As others :yref:`LawFunctor`, it uses pre-computed data of the interactions (rigidities, friction angles -with their tan()-, orientations of the interactions); this work is done here in :yref:`Ip2_2xNormalInelasticMat_NormalInelasticityPhys`.\n\n To use this you should also use :yref:`NormalInelasticMat` as material type of the bodies.\n\n The effects of this law are illustrated in examples/normalInelasticityTest.py",
 				((bool,momentRotationLaw,true,,"boolean, true=> computation of a torque (against relative rotation) exchanged between particles"))
-				((bool,momentAlwaysElastic,false,,"boolean, true=> the torque (computed only if momentRotationLaw !!) is not limited by a plastic threshold"))
+				((bool,momentAlwaysElastic,false,,"boolean, true=> the part of the contact torque (caused relative rotations, which is computed only if momentRotationLaw..) is not limited by a plastic threshold"))
 				,
 				moment=Vector3r::Zero();
 				f=Vector3r::Zero();