formfactors: correct geometric misnomers in API
Some names are in conflict with established geometric terminology. Question is how far we go. [Redmine1497,1567,1569]
- - "FormFactor"
- + Cube
- + Prism4
- TruncatedSphere -> SphericalSegment
- FullSphere -> Sphere
- HemiEllipsoid -> SpheroidalSegment ?
Notes:
- $ Each of these form factors can easily be modelled by putting certain parameters of a more generic shape to a special value. A fundamental decision is needed whether we want to offer these special cases. Cf #1463.
- @0 The meanings of »facetted sphere« in IsGISAXS and FitGISAXS differ.
- @5 Put ripples in a separate directory, and in a separate frame in the GUI, so that it becomes clear that these are ripples. Other proposal (GP): CosineRipple, TriangularRipple.
- @6 See https://en.wikipedia.org/wiki/Archimedean_solid for use of »truncated«.
- @7 There is no physical reason why the contact angle should be just 90deg. Therefore we no need for HemiEllipsoid and HemiSpheroid. Rather, let us introduce TruncatedEllipsoid with truncation at arbitrary height (#1568).
- @8 If we have Sphere, TruncatedSphere, and TruncatedEllipsoid, then Ellipsoid should be there for clearer systematic.
Activity
marked this issue as related to #8
mentioned in issue #8
added formfactor label
changed milestone to %v22
Resolved by Wuttke, JoachimRecently, ahead of v22, we changed the parameterization of "truncated" form factors, i.e. the same constructor call now has different effect. This can be dangerous for users who continue using scripts from v21 or earlier (just changing them where they fail).
Therefore this is the right moment to do the following changes:
- TruncatedSphere -> SphericalSegment
- TruncatedSpheroid -> SpheroidalSegment
-
HemiEllipsoid -> remove (wait for user request to reintroduce something more plausible)
Edited by Wuttke, Joachim- Last reply by Wuttke, Joachim
-
Removed bullet point "Ellipsoid". Anyway, let's concentrate on the three bullet points from my last list.
HemiEllipsoid is a misnomer because it has two, not three different radii, hence it is a Spheroid.I see no good physical reasons why to cut this horizontally oriented spheroid just at 50% height. From my knowledge of wetting there is nothing special of a contact angle of 90 deg.
A properly generalized class might be HorizontalSpheroidalSegment. But we may wait until it is requested by a user.
Edited by Wuttke, Joachim
assigned to @m.svechnikov
mentioned in merge request !2947 (merged)
mentioned in commit 3391f6f6
closed with merge request !2947 (merged)
