InterferenceFunctionRadialParaCrystal.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Aggregate/InterferenceFunctionRadialParaCrystal.h
//! @brief     Defines class InterferenceFunctionRadialParaCrystal.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_SAMPLE_AGGREGATE_INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H
#define BORNAGAIN_SAMPLE_AGGREGATE_INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H
 
#include "Sample/Aggregate/IInterferenceFunction.h"
#include "Sample/Correlations/FTDistributions1D.h"
#include <memory>
 
//! Interference function of radial paracrystal.
//! @ingroup interference
 
class InterferenceFunctionRadialParaCrystal : public IInterferenceFunction {
public:
    InterferenceFunctionRadialParaCrystal(double peak_distance, double damping_length);
    InterferenceFunctionRadialParaCrystal* clone() const final;
 
    void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
 
    void setKappa(double kappa);
    double kappa() const;
 
    void setDomainSize(double size);
    double domainSize() const { return m_domain_size; }
 
    complex_t FTPDF(double qpar) const;
 
    void setProbabilityDistribution(const IFTDistribution1D& pdf);
 
    double peakDistance() const { return m_peak_distance; }
 
    double dampingLength() const { return m_damping_length; }
 
    std::vector<const INode*> getChildren() const final;
 
    double randomSample() const { return m_pdf->createSampler()->randomSample(); }
 
private:
    double iff_without_dw(const kvector_t q) const final;
    void init_parameters();
 
    double m_peak_distance;  //!< the distance to the first neighbor peak
    double m_damping_length; //!< damping length of paracrystal
    //! Fourier transformed probability distribution of the nearest particle
    std::unique_ptr<IFTDistribution1D> m_pdf;
    bool m_use_damping_length;
    double m_kappa;       //!< Size-spacing coupling parameter
    double m_domain_size; //!< Size of coherence domain
};
 
#endif // BORNAGAIN_SAMPLE_AGGREGATE_INTERFERENCEFUNCTIONRADIALPARACRYSTAL_H