yade-dev team mailing list archive

[Jérôme Duriez <jerome.duriez@xxxxxxxxx>]

Public bug reported:

Hello,

I have few questions regarding the doc of chained cylinders classes and
such.


1. It seems to me the doc ("doc" string of YADE_CLASS_BASE_DOC_*) of Law2_ChCylGeom6D_CohFrictPhys_CohesionMoment [1] and Law2_CylScGeom_FrictPhys_CundallStrack [2] may deserve some improvements.
At the moment, they look very like the doc of Law2_ScGeom_FrictPhys_CundallStrack [3] even though Law2_ChCylGeom6D_CohFrictPhys_CohesionMoment does have cohesion for instance ;-)


2. I would have a similar remark (about room for improvement) for the doc of ChCylGeom6D [4]


3. Do we agree Ig2_ChainedCylinder_ChainedCylinder_ScGeom6D actually return a ChCylGeom6D instance [5] ?
And neither a ScGeom6D (as the name suggests), nor a ScGeom (as the doc [6] suggests)


4. Do we agree "ScPFaceCoGeom" actually is "ScGridCoGeom" in the doc of Ig2_Sphere_PFacet_ScGridCoGeom [7] ?


I did not make yet the modifications myself because I'm just discovering this part of the code, but, if necessary, I could take care of most of the corrections after minimal discussion here.


Jérôme


[1] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Law2_ChCylGeom6D_CohFrictPhys_CohesionMoment
[2] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Law2_CylScGeom_FrictPhys_CundallStrack
[3] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Law2_ScGeom_FrictPhys_CundallStrack
[4] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.ChCylGeom6D
[5] https://github.com/yade/trunk/blob/e4e757f2e98a620e3177b7a36a1d10f69f6a6a28/pkg/common/Cylinder.cpp#L388
[6] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Ig2_ChainedCylinder_ChainedCylinder_ScGeom6D
[7] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Ig2_Sphere_PFacet_ScGridCoGeom

** Affects: yade
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yade
developers, which is subscribed to Yade.
https://bugs.launchpad.net/bugs/1746037

Title:
  Doc of cylinder-related models

Status in Yade:
  New

Bug description:
  Hello,

  I have few questions regarding the doc of chained cylinders classes
  and such.

  
  1. It seems to me the doc ("doc" string of YADE_CLASS_BASE_DOC_*) of Law2_ChCylGeom6D_CohFrictPhys_CohesionMoment [1] and Law2_CylScGeom_FrictPhys_CundallStrack [2] may deserve some improvements.
  At the moment, they look very like the doc of Law2_ScGeom_FrictPhys_CundallStrack [3] even though Law2_ChCylGeom6D_CohFrictPhys_CohesionMoment does have cohesion for instance ;-)

  
  2. I would have a similar remark (about room for improvement) for the doc of ChCylGeom6D [4]

  
  3. Do we agree Ig2_ChainedCylinder_ChainedCylinder_ScGeom6D actually return a ChCylGeom6D instance [5] ?
  And neither a ScGeom6D (as the name suggests), nor a ScGeom (as the doc [6] suggests)

  
  4. Do we agree "ScPFaceCoGeom" actually is "ScGridCoGeom" in the doc of Ig2_Sphere_PFacet_ScGridCoGeom [7] ?

  
  I did not make yet the modifications myself because I'm just discovering this part of the code, but, if necessary, I could take care of most of the corrections after minimal discussion here.

  
  Jérôme

  
  [1] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Law2_ChCylGeom6D_CohFrictPhys_CohesionMoment
  [2] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Law2_CylScGeom_FrictPhys_CundallStrack
  [3] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Law2_ScGeom_FrictPhys_CundallStrack
  [4] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.ChCylGeom6D
  [5] https://github.com/yade/trunk/blob/e4e757f2e98a620e3177b7a36a1d10f69f6a6a28/pkg/common/Cylinder.cpp#L388
  [6] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Ig2_ChainedCylinder_ChainedCylinder_ScGeom6D
  [7] https://yade-dem.org/doc/yade.wrapper.html#yade.wrapper.Ig2_Sphere_PFacet_ScGridCoGeom

To manage notifications about this bug go to:
https://bugs.launchpad.net/yade/+bug/1746037/+subscriptions