yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 3545
committer: jduriez <jerome.duriez@xxxxxxxxxxx>
timestamp: Wed 2014-11-26 10:26:29 -0700
message:
  Minor doc fixes
modified:
  pkg/dem/JointedCohesiveFrictionalPM.hpp
  pkg/dem/NormalInelasticPM.hpp


--
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.hpp'
--- pkg/dem/JointedCohesiveFrictionalPM.hpp	2014-11-05 15:08:12 +0000
+++ pkg/dem/JointedCohesiveFrictionalPM.hpp	2014-11-26 17:26:29 +0000
@@ -13,8 +13,8 @@
 		((int,tensBreak,0,,"Number of tensile breakages. [-]"))
 		((int,shearBreak,0,,"Number of shear breakages. [-]"))
 		((int,noIniLinks,0,,"Number of initial cohesive interactions. [-]"))
-		((Real,tensBreakRel,0,,"Relative number (in [0;1], compared with :yref:noIniLinks) of tensile breakages. [-]"))
-		((Real,shearBreakRel,0,,"Relative number (in [0;1], compared with :yref:noIniLinks) of shear breakages. [-]"))
+		((Real,tensBreakRel,0,,"Relative number (in [0;1], compared with :yref:`noIniLinks<JCFpmState.noIniLinks>`) of tensile breakages. [-]"))
+		((Real,shearBreakRel,0,,"Relative number (in [0;1], compared with :yref:`noIniLinks<JCFpmState.noIniLinks>`) of shear breakages. [-]"))
 		((bool,onJoint,false,,"Identifies if the particle is on a joint surface."))
 		((int,joint,0,,"Indicates the number of joint surfaces to which the particle belongs (0-> no joint, 1->1 joint, etc..). [-]"))
 		((Vector3r,jointNormal1,Vector3r::Zero(),,"Specifies the normal direction to the joint plane 1. Rk: the ideal here would be to create a vector of vector wich size is defined by the joint integer (as much joint normals as joints). However, it needs to make the pushback function works with python since joint detection is done through a python script. lines 272 to 312 of cpp file should therefore be adapted. [-]"))

=== modified file 'pkg/dem/NormalInelasticPM.hpp'
--- pkg/dem/NormalInelasticPM.hpp	2014-10-15 06:44:01 +0000
+++ pkg/dem/NormalInelasticPM.hpp	2014-11-26 17:26:29 +0000
@@ -105,7 +105,7 @@
 	FUNCTOR2D(NormalInelasticMat,NormalInelasticMat);
 	YADE_CLASS_BASE_DOC_ATTRS(Ip2_2xNormalInelasticMat_NormalInelasticityPhys,
 				  IPhysFunctor,
-				  "The RelationShips for using :yref:`Law2_ScGeom6D_NormalInelasticityPhys_NormalInelasticity`\n\n In these RelationShips all the attributes of the interactions (which are of NormalInelasticityPhys type) are computed. \n\n.. warning::\n\tas in the others :yref:`Ip2 functors<IPhysFunctor>`, most of the attributes are computed only once, when the interaction is new.",
+				  "Computes interaction attributes (of :yref:`NormalInelasticityPhys` type) from :yref:`NormalInelasticMat` material parameters. For simulations using :yref:`Law2_ScGeom6D_NormalInelasticityPhys_NormalInelasticity`. Note that, as for others :yref:`Ip2 functors<IPhysFunctor>`, most of the attributes are computed only once, when the interaction is new.",
 				  ((Real,betaR,0.12,,"Parameter for computing the torque-stifness : T-stifness = betaR * Rmoy^2"))
 				  );
 };