ParaCrystalBuilder.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/StandardSamples/ParaCrystalBuilder.h
//! @brief     Defines classes of ParaCrystalBuilder family.
//!
//! @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)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_SAMPLE_STANDARDSAMPLES_PARACRYSTALBUILDER_H
#define BORNAGAIN_SAMPLE_STANDARDSAMPLES_PARACRYSTALBUILDER_H
 
#include "Sample/SampleBuilderEngine/ISampleBuilder.h"
#include <memory>
 
class IFTDistribution2D;
class FTDistribution2DComponents;
 
//! @ingroup standard_samples
//! Builds sample: cylinders with 1DDL structure factor (IsGISAXS example #4).
 
class RadialParaCrystalBuilder : public ISampleBuilder {
public:
    MultiLayer* buildSample() const;
};
 
//! Builds sample: basic two dimensional paracrystal with various probability
//! distribution functions (PDF's). They are initialized via component service.
//! @ingroup standard_samples
 
class Basic2DParaCrystalBuilder : public ISampleBuilder {
public:
    Basic2DParaCrystalBuilder();
    ~Basic2DParaCrystalBuilder();
    MultiLayer* buildSample() const;
 
    MultiLayer* createSampleByIndex(size_t index);
 
private:
    std::unique_ptr<IFTDistribution2D> m_pdf1;
    std::unique_ptr<IFTDistribution2D> m_pdf2;
};
 
//! Builds sample: cylinders with 2DDL structure factor (IsGISAXS example #4).
//! @ingroup standard_samples
 
class HexParaCrystalBuilder : public ISampleBuilder {
public:
    MultiLayer* buildSample() const;
};
 
//! @ingroup standard_samples
//! Builds sample: 2D paracrystal lattice (IsGISAXS example #8).
 
class RectParaCrystalBuilder : public ISampleBuilder {
public:
    MultiLayer* buildSample() const;
};
 
#endif // BORNAGAIN_SAMPLE_STANDARDSAMPLES_PARACRYSTALBUILDER_H
#endif // USER_API