yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 3696
committer: Jerome Duriez <jerome.duriez@xxxxxxxxxxxxxxx>
timestamp: Thu 2013-09-19 10:50:04 +0200
message:
  - few changes in comments in JointedCohesiveFrictionalPM.*
  - typos corrected in doxygen and sphinx docs of TriaxialTest (there was some "Trixial" instead of "Triaxial")
  - correction of typo, broken links, and add of two precisions in the doc of a function of pack.py
modified:
  pkg/dem/JointedCohesiveFrictionalPM.cpp
  pkg/dem/JointedCohesiveFrictionalPM.hpp
  pkg/dem/TriaxialTest.hpp
  py/_extraDocs.py
  py/pack/pack.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/dem/JointedCohesiveFrictionalPM.cpp'
--- pkg/dem/JointedCohesiveFrictionalPM.cpp	2013-08-01 11:54:13 +0000
+++ pkg/dem/JointedCohesiveFrictionalPM.cpp	2013-09-19 08:50:04 +0000
@@ -174,7 +174,7 @@
 	
 	shared_ptr<JCFpmPhys> contactPhysics(new JCFpmPhys()); 
 	
-	/* From interaction physics */
+	/* From material properties */
 	Real E1 	= yade1->young;
 	Real E2 	= yade2->young;
 	Real f1 	= yade1->frictionAngle;
@@ -185,7 +185,7 @@
 	Real R2= geom->radius2;
 	contactPhysics->crossSection = Mathr::PI*pow(min(R1,R2),2);
 
-	/* Pass values to JCFpmPhys */
+	/* Pass values to JCFpmPhys. In case of a "jointed" interaction, the following values will be replaced by other ones later (in few if(){} blocks)*/
 	
 	// frictional properties
 	contactPhysics->kn = 2.*E1*R1*E2*R2/(E1*R1+E2*R2);

=== modified file 'pkg/dem/JointedCohesiveFrictionalPM.hpp'
--- pkg/dem/JointedCohesiveFrictionalPM.hpp	2013-08-01 11:54:13 +0000
+++ pkg/dem/JointedCohesiveFrictionalPM.hpp	2013-09-19 08:50:04 +0000
@@ -77,11 +77,11 @@
 		
 		YADE_CLASS_BASE_DOC_ATTRS(Ip2_JCFpmMat_JCFpmMat_JCFpmPhys,IPhysFunctor,"converts 2 JCFpmMat instances to JCFpmPhys with corresponding parameters.",
 			((int,cohesiveTresholdIteration,1,,"should new contacts be cohesive? They will before this iter, they won't afterward."))
-			((Real,alpha,0.,,"defines the shear to normal stiffness ratio ks/kn."))
+			((Real,alpha,0.,,"defines the shear to normal stiffness ratio ks/kn in the matrix."))
 			((Real,tensileStrength,0.,,"defines the maximum admissible normal force in traction FnMax=tensileStrength*crossSection in the matrix. [Pa]"))
 			((Real,cohesion,0.,,"defines the maximum admissible tangential force in shear FsMax=cohesion*crossSection in the matrix. [Pa]"))
-			((Real,jointNormalStiffness,0.,,"defines the normal stiffness on the joint surface. "))
-			((Real,jointShearStiffness,0.,,"defines the shear stiffness on the joint surface."))
+			((Real,jointNormalStiffness,0.,,"defines the normal stiffness on the joint surface. [Pa]"))
+			((Real,jointShearStiffness,0.,,"defines the shear stiffness on the joint surface. [Pa]"))
 			((Real,jointTensileStrength,0.,,"defines the maximum admissible normal force in traction FnMax=tensileStrength*crossSection on the joint surface. [Pa]"))
 			((Real,jointCohesion,0.,,"defines the maximum admissible tangential force in shear FsMax=cohesion*crossSection on the joint surface. [Pa]"))
 			((Real,jointFrictionAngle,-1,,"defines Coulomb friction on the joint surface. [rad]"))

=== modified file 'pkg/dem/TriaxialTest.hpp'
--- pkg/dem/TriaxialTest.hpp	2012-09-08 01:19:45 +0000
+++ pkg/dem/TriaxialTest.hpp	2013-09-19 08:50:04 +0000
@@ -28,7 +28,7 @@
 	
 	Essential engines :
 	
-	1/ The TrixialCompressionEngine is used for controlling the state of the sample and simulating loading paths. TrixialCompressionEngine inherits from TriaxialStressController, which can compute stress- strain-like quantities in the packing and maintain a constant level of stress at each boundary. TriaxialCompressionEngine has few more members in order to impose constant strain rate and control the transition between isotropic compression and triaxial test.
+	1/ The TriaxialCompressionEngine is used for controlling the state of the sample and simulating loading paths. TriaxialCompressionEngine inherits from TriaxialStressController, which can compute stress- strain-like quantities in the packing and maintain a constant level of stress at each boundary. TriaxialCompressionEngine has few more members in order to impose constant strain rate and control the transition between isotropic compression and triaxial test.
 		
 	2/ The class TriaxialStateRecorder is used to write to a file the history of stresses and strains.
 	

=== modified file 'py/_extraDocs.py'
--- py/_extraDocs.py	2013-08-29 10:30:31 +0000
+++ py/_extraDocs.py	2013-09-19 08:50:04 +0000
@@ -46,7 +46,7 @@
 	.. note:: *Axis conventions.* Boundaries perpendicular to the *x* axis are called "left" and "right", *y* corresponds to "top" and "bottom", and axis *z* to "front" and "back". In the default loading path, strain rate is assigned along *y*, and constant stresses are assigned on *x* and *z*.
 
 **Essential engines**
-	#. The :yref:`TrixaialCompressionEngine` is used for controlling the state of the sample and simulating loading paths. :yref:`TriaxialCompressionEngine` inherits from :yref:`TriaxialStressController`, which computes stress- and strain-like quantities in the packing and maintain a constant level of stress at each boundary. :yref:`TriaxialCompressionEngine` has few more members in order to impose constant strain rate and control the transition between isotropic compression and triaxial test. Transitions are defined by changing some flags of the :yref:`TriaxialStressController`, switching from/to imposed strain rate to/from imposed stress.
+	#. The :yref:`TriaxialCompressionEngine` is used for controlling the state of the sample and simulating loading paths. :yref:`TriaxialCompressionEngine` inherits from :yref:`TriaxialStressController`, which computes stress- and strain-like quantities in the packing and maintain a constant level of stress at each boundary. :yref:`TriaxialCompressionEngine` has few more members in order to impose constant strain rate and control the transition between isotropic compression and triaxial test. Transitions are defined by changing some flags of the :yref:`TriaxialStressController`, switching from/to imposed strain rate to/from imposed stress.
 	#. The class :yref:`TriaxialStateRecorder` is used to write to a file the history of stresses and strains.
 	#. :yref:`TriaxialTest` is using :yref:`GlobalStiffnessTimeStepper` to compute an appropriate $\Dt$ for the numerical scheme. 
 

=== modified file 'py/pack/pack.py'
--- py/pack/pack.py	2013-03-08 21:26:47 +0000
+++ py/pack/pack.py	2013-09-19 08:50:04 +0000
@@ -286,7 +286,8 @@
 	return ret
 
 def filterSpherePack(predicate,spherePack,returnSpherePack=None,**kw):
-	"""Using given SpherePack instance, return spheres the satisfy predicate.
+	"""Using given SpherePack instance, return spheres that satisfy predicate.
+	It returns either a :yref:`yade._packSpheres.SpherePack` (if returnSpherePack) or a list.
 	The packing will be recentered to match the predicate and warning is given if the predicate
 	is larger than the packing."""
 	if returnSpherePack==None:
@@ -386,7 +387,7 @@
 	:param predicate: solid-defining predicate for which we generate packing
 	:param spheresInCell: if given, the packing will be periodic, with given number of spheres in the periodic cell.
 	:param radius: mean radius of spheres
-	:param rRelFuzz: relative fuzz of the radius -- e.g. radius=10, rRelFuzz=.2, then spheres will have radii 10 ± (10*.2)).
+	:param rRelFuzz: relative fuzz of the radius -- e.g. radius=10, rRelFuzz=.2, then spheres will have radii 10 ± (10*.2)), with an uniform distribution.
 		0 by default, meaning all spheres will have exactly the same radius.
 	:param cropLayers: (aperiodic only) how many layers of spheres will be added to the computed dimension of the box so that there no
 		(or not so much, at least) boundary effects at the boundaries of the predicate.
@@ -398,9 +399,9 @@
 		least number spheres will be loaded and returned.
 	:param useOBB: effective only if a inGtsSurface predicate is given. If true (not default), oriented bounding box will be
 		computed first; it can reduce substantially number of spheres for the triaxial compression (like 10× depending on
-		how much asymmetric the body is), see scripts/test/gts-triax-pack-obb.py.
-	:param memoDbg: show packigns that are considered and reasons why they are rejected/accepted
-	:param returnSpherePack: see :yref:`filterSpherePack`
+		how much asymmetric the body is), see examples/gts-horse/gts-random-pack-obb.py
+	:param memoDbg: show packings that are considered and reasons why they are rejected/accepted
+	:param returnSpherePack: see the corresponding argument in :yref:`yade.pack.filterSpherePack`
 
 	:return: SpherePack object with spheres, filtered by the predicate.
 	"""