Doc of cylinder-related models
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Yade |
Fix Released
|
Undecided
|
Unassigned |
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_
At the moment, they look very like the doc of Law2_ScGeom_
2. I would have a similar remark (about room for improvement) for the doc of ChCylGeom6D [4]
3. Do we agree Ig2_ChainedCyli
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_
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:/
[2] https:/
[3] https:/
[4] https:/
[5] https:/
[6] https:/
[7] https:/
Hi Jérôme,
Chained cylinders are considered deprecated, they should be replaced by PFacets and friends - hence removed at some point (better NOT use them). No point improving the doc then.
Besides, one of your comment overlooked the meaning of inheritance in c++ in general and in Yade: nder_ChainedCyl inder_ScGeom6D actually return a ChCylGeom6D instance [5] ?
"Do we agree Ig2_ChainedCyli
And neither a ScGeom6D (as the name suggests), nor a ScGeom"
Inheritance in c++ must be understood as "B is a A" if B inherits from A. So not only Ig2_ChainedCyli nder_ChainedCyl inder_ScGeom6D is really returning a ScGeom, *and* also a ScGeom6D (*and* more exactly a ChCylGeom6D); its purpose is really to return a ScGeom[6D] so that older law functors can be used unmodified.
That would not be possible if ChCylGeom6D was not a ScGeom. The doc is thus correct even though it may seem inaccurate.
Bruno