Refactoring #1567

Feature #1290: === Core: framework ===

Envelope task #1566: == API changes ==

omit »FormFactor« from particle geometry class names

Added by wuttke over 3 years ago. Updated over 2 years ago.

Status:RejectedStart date:03 Aug 2016
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:-
Target version:-

Description

Rename
  • FormFactorCone -> Cone
  • FormFactorTruncatedSpheroid -> TruncatedSpheroid
  • and so on for all hard particle shapes.
  • FormFactorGaussian -> SoftEllipsoidGaussian
  • FormFactorSphereLogNormalRadius -> SoftSphereLogNormal
  • and similar for all soft particles
The main method should then be renamed
  • evaluate_for_q(q) -> formfactor(q)

Rationale:
Our sample is a MultiLayer composed of Layers that may contain Particles. So far this is plain geometric language, and conveys an intuitive real-space description of the sample we are modelling. Accordingly, I would expect a HardParticle to specialize into real-space particle shapes, named Cone, Cylinder and so on, and not into a FormFactorSomething.

History

#1 Updated by wuttke over 3 years ago

Next question then, whether to put them in a namespace.

#2 Updated by wuttke over 3 years ago

  • Status changed from Rfc to Waiting

#3 Updated by pospelov over 2 years ago

  • Status changed from Waiting to Rejected

Rejected, see #1823

Also available in: Atom PDF