Public Member Functions |
Protected Member Functions |
Static Protected Member Functions |
Protected Attributes |
List of all members
IFormFactorBorn Class Referenceabstract
Pure virtual base class for Born form factors. More...
Inheritance diagram for IFormFactorBorn:
Public Member Functions | |
| IFormFactorBorn (const NodeMeta &meta, const std::vector< double > &PValues) | |
| IFormFactorBorn * | clone () const override=0 |
| Returns a clone of this ISample object. | |
| void | setAmbientMaterial (const Material &) override |
| Passes the material in which this particle is embedded. | |
| complex_t | evaluate (const WavevectorInfo &wavevectors) const override |
| Returns scattering amplitude for complex wavevectors ki, kf. | |
| Eigen::Matrix2cd | evaluatePol (const WavevectorInfo &wavevectors) const override |
| Returns scattering amplitude for matrix interactions. | |
| virtual double | bottomZ (const IRotation &rotation) const override |
| Returns the z-coordinate of the lowest point in this shape after a given rotation. | |
| virtual double | topZ (const IRotation &rotation) const override |
| Returns the z-coordinate of the lowest point in this shape after a given rotation. | |
| virtual complex_t | evaluate_for_q (cvector_t q) const =0 |
| Returns scattering amplitude for complex scattering wavevector q=k_i-k_f. More... | |
| Public Member Functions inherited from IFormFactor | |
| IFormFactor (const NodeMeta &meta, const std::vector< double > &PValues) | |
| IFormFactor * | createSlicedFormFactor (ZLimits limits, const IRotation &rot, kvector_t translation) const |
| Creates a (possibly sliced) form factor with the given rotation and translation. | |
| virtual double | volume () const |
| Returns the total volume of the particle of this form factor's shape. | |
| virtual double | radialExtension () const =0 |
| Returns the (approximate in some cases) radial size of the particle of this form factor's shape. More... | |
| virtual void | setSpecularInfo (std::unique_ptr< const ILayerRTCoefficients >, std::unique_ptr< const ILayerRTCoefficients >) |
| Sets reflection/transmission info. | |
| Public Member Functions inherited from ISample | |
| ISample (const NodeMeta &meta, const std::vector< double > &PValues) | |
| virtual const Material * | material () const |
| Returns nullptr, unless overwritten to return a specific material. | |
| std::vector< const Material * > | containedMaterials () const |
| Returns set of unique materials contained in this ISample. | |
| Public Member Functions inherited from ICloneable | |
| ICloneable (const ICloneable &)=delete | |
| ICloneable (ICloneable &&)=default | |
| virtual void | transferToCPP () |
| Used for Python overriding of clone (see swig/tweaks.py) | |
| Public Member Functions inherited from INode | |
| INode (const NodeMeta &meta, const std::vector< double > &PValues) | |
| virtual void | accept (INodeVisitor *visitor) const =0 |
| Calls the INodeVisitor's visit method. | |
| virtual std::string | treeToString () const |
| Returns multiline string representing tree structure below the node. | |
| void | registerChild (INode *node) |
| virtual std::vector< const INode * > | getChildren () const |
| Returns a vector of children (const). | |
| virtual void | setParent (const INode *newParent) |
| const INode * | parent () const |
| INode * | parent () |
| int | copyNumber (const INode *node) const |
| Returns copyNumber of child, which takes into account existence of children with same name. | |
| std::string | displayName () const |
| Returns display name, composed from the name of node and it's copy number. | |
| ParameterPool * | createParameterTree () const |
| Creates new parameter pool, with all local parameters and those of its children. | |
| Public Member Functions inherited from IParameterized | |
| IParameterized (const std::string &name="") | |
| IParameterized (const IParameterized &other) | |
| IParameterized & | operator= (const IParameterized &other)=delete |
| ParameterPool * | parameterPool () const |
| Returns pointer to the parameter pool. | |
| std::string | parametersToString () const |
| Returns multiline string representing available parameters. | |
| RealParameter & | registerParameter (const std::string &name, double *parpointer) |
| void | registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm") |
| void | setParameterValue (const std::string &name, double value) |
| void | setVectorValue (const std::string &base_name, kvector_t value) |
| RealParameter * | parameter (const std::string &name) const |
| Returns parameter with given 'name'. | |
| virtual void | onChange () |
| Action to be taken in inherited class when a parameter has changed. | |
| void | removeParameter (const std::string &name) |
| void | removeVector (const std::string &base_name) |
| void | setName (const std::string &name) |
| const std::string & | getName () const |
Protected Member Functions | |
| bool | canSliceAnalytically (const IRotation &rot) const override |
| Default implementation only allows rotations along z-axis. | |
| virtual Eigen::Matrix2cd | evaluate_for_q_pol (cvector_t q) const |
| Returns scattering amplitude for complex scattering wavevector q=k_i-k_f in case of matrix interactions. More... | |
| SlicingEffects | computeSlicingEffects (ZLimits limits, const kvector_t &position, double height) const |
| Helper method for slicing. | |
| Protected Member Functions inherited from IFormFactor | |
| virtual IFormFactor * | sliceFormFactor (ZLimits limits, const IRotation &rot, kvector_t translation) const |
| Actually slices the form factor or throws an exception. | |
Static Protected Member Functions | |
| static double | BottomZ (const std::vector< kvector_t > &vertices, const IRotation &rotation) |
| Calculates the z-coordinate of the lowest vertex after rotation. | |
| static double | TopZ (const std::vector< kvector_t > &vertices, const IRotation &rotation) |
| Calculates the z-coordinate of the highest vertex after rotation. | |
Protected Attributes | |
| std::unique_ptr< IShape > | mP_shape |
| IShape object, used to retrieve vertices (which may be approximate in the case of round shapes). More... | |
| Protected Attributes inherited from INode | |
| const size_t | m_NP |
| std::vector< double > | m_P |
Additional Inherited Members | |
| Static Public Member Functions inherited from IParameterized | |
| static std::string | XComponentName (const std::string &base_name) |
| static std::string | YComponentName (const std::string &base_name) |
| static std::string | ZComponentName (const std::string &base_name) |
Detailed Description
Pure virtual base class for Born form factors.
In contrast to the generic IFormFactor, a Born form factor does not depend on the incoming and outgoing wave vectors ki and kf, except through their difference, the scattering vector q=ki-kf.
Definition at line 31 of file IFormFactorBorn.h.
Member Function Documentation
◆ evaluate_for_q()
|
pure virtual |
Returns scattering amplitude for complex scattering wavevector q=k_i-k_f.
This method is public only for convenience of plotting form factors in Python.
Implemented in FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, IProfileRipple, IFormFactorPolyhedron, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDot, FormFactorCylinder, FormFactorCone, FormFactorBox, and IFormFactorPrism.
◆ evaluate_for_q_pol()
|
protectedvirtual |
Returns scattering amplitude for complex scattering wavevector q=k_i-k_f in case of matrix interactions.
Default implementation calls evaluate_for_q(q) and multiplies with the unit matrix.
Definition at line 62 of file IFormFactorBorn.cpp.
Member Data Documentation
◆ mP_shape
|
protected |
IShape object, used to retrieve vertices (which may be approximate in the case of round shapes).
For soft particles, this will be a hard mean shape.
Definition at line 68 of file IFormFactorBorn.h.
The documentation for this class was generated from the following files:
- /home/www/ba/Sample/Scattering/IFormFactorBorn.h
- /home/www/ba/Sample/Scattering/IFormFactorBorn.cpp
