FormFactorCrystal Class Reference
The form factor of a MesoCrystal. More...
Inheritance diagram for FormFactorCrystal:
Public Member Functions | |
| FormFactorCrystal (const Lattice &lattice, const IFormFactor &basis_form_factor, const IFormFactor &meso_form_factor, double position_variance=0.0) | |
| FormFactorCrystal * | clone () const override final |
| Returns a clone of this ISample object. | |
| void | accept (INodeVisitor *visitor) const override final |
| Calls the INodeVisitor's visit method. | |
| void | setAmbientMaterial (const Material &material) override |
| Passes the material in which this particle is embedded. | |
| double | volume () const override final |
| Returns the total volume of the particle of this form factor's shape. | |
| double | radialExtension () const override final |
| Returns the (approximate in some cases) radial size of the particle of this form factor's shape. More... | |
| double | bottomZ (const IRotation &rotation) const override |
| Returns the z-coordinate of the lowest point in this shape after a given rotation. | |
| double | topZ (const IRotation &rotation) const override final |
| Returns the z-coordinate of the lowest point in this shape after a given rotation. | |
| complex_t | evaluate (const WavevectorInfo &wavevectors) const override final |
| Returns scattering amplitude for complex wavevectors ki, kf. | |
| Eigen::Matrix2cd | evaluatePol (const WavevectorInfo &wavevectors) const override final |
| Returns scattering amplitude for matrix interactions. | |
| 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 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 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 |
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) |
| Protected Member Functions inherited from IFormFactor | |
| virtual bool | canSliceAnalytically (const IRotation &rot) const |
| Checks if slicing has a fast analytical solution. | |
| virtual IFormFactor * | sliceFormFactor (ZLimits limits, const IRotation &rot, kvector_t translation) const |
| Actually slices the form factor or throws an exception. | |
| Protected Attributes inherited from INode | |
| const size_t | m_NP |
| std::vector< double > | m_P |
Detailed Description
The form factor of a MesoCrystal.
Definition at line 24 of file FormFactorCrystal.h.
Member Function Documentation
◆ radialExtension()
|
inlinefinaloverridevirtual |
Returns the (approximate in some cases) radial size of the particle of this form factor's shape.
This is used for SSCA calculations
Implements IFormFactor.
Definition at line 45 of file FormFactorCrystal.h.
The documentation for this class was generated from the following files:
- /home/www/ba/Sample/Particle/FormFactorCrystal.h
- /home/www/ba/Sample/Particle/FormFactorCrystal.cpp
