IInterferenceFunction Class Referenceabstract
Pure virtual base class of interference functions. More...
Inheritance diagram for IInterferenceFunction:
Public Member Functions | |
| IInterferenceFunction (const NodeMeta &meta, const std::vector< double > &PValues) | |
| IInterferenceFunction (double position_var) | |
| virtual IInterferenceFunction * | clone () const =0 |
| Returns a clone of this ISample object. | |
| virtual double | evaluate (const kvector_t q, double outer_iff=1.0) const |
| Evaluates the interference function for a given wavevector transfer. | |
| void | setPositionVariance (double var) |
| Sets the variance of the position for the calculation of the DW factor It is defined as the variance in each relevant dimension. | |
| double | positionVariance () const |
| Returns the position variance. | |
| virtual double | getParticleDensity () const |
| If defined by this interference function's parameters, returns the particle density (per area). More... | |
| virtual bool | supportsMultilayer () const |
| Indicates if this interference function can be used with a multilayer (DWBA mode) | |
| double | DWfactor (kvector_t q) const |
| Evaluates the Debye-Waller factor for a given wavevector transfer. | |
| 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 | |
| double | iff_no_inner (const kvector_t q, double outer_iff) const |
| Calculates the structure factor in the absence of extra inner structure. | |
| virtual double | iff_without_dw (const kvector_t q) const =0 |
| Calculates the structure factor without Debye-Waller factor. | |
Protected Attributes | |
| double | m_position_var |
| 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 of interference functions.
Definition at line 23 of file IInterferenceFunction.h.
Member Function Documentation
◆ getParticleDensity()
|
inlinevirtual |
If defined by this interference function's parameters, returns the particle density (per area).
Otherwise, returns zero or a user-defined value
Reimplemented in InterferenceFunctionHardDisk, InterferenceFunctionFinite2DLattice, InterferenceFunction2DParaCrystal, and InterferenceFunction2DLattice.
Definition at line 43 of file IInterferenceFunction.h.
The documentation for this class was generated from the following files:
- /home/www/ba/Sample/Aggregate/IInterferenceFunction.h
- /home/www/ba/Sample/Aggregate/IInterferenceFunction.cpp
