MesoCrystal.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Particle/MesoCrystal.h
//! @brief     Defines class MesoCrystal.
//!
//! @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_PARTICLE_MESOCRYSTAL_H
#define BORNAGAIN_SAMPLE_PARTICLE_MESOCRYSTAL_H
 
#include "Sample/Particle/IParticle.h"
 
class IFormFactor;
class Crystal;
 
//! A particle with a crystalline inner structure, made of smaller particles,
//! and an outer shape described by a particle form factor.
//! @ingroup samples
 
class MesoCrystal : public IParticle {
public:
    MesoCrystal(const Crystal& crystal, const IFormFactor& formfactor);
 
    ~MesoCrystal() override;
 
    MesoCrystal* clone() const override;
    std::string className() const final { return "MesoCrystal"; }
    std::vector<const INode*> nodeChildren() const override;
 
    const IFormFactor* outerShape() const { return m_meso_formfactor.get(); }
    const Crystal& particleStructure() const;
 
private:
    MesoCrystal(Crystal* crystal, IFormFactor* formfactor);
 
    const std::unique_ptr<Crystal> m_crystal;             //!< Crystalline inner structure
    const std::unique_ptr<IFormFactor> m_meso_formfactor; //!< Outer shape of the mesocrystal
};
 
#endif // BORNAGAIN_SAMPLE_PARTICLE_MESOCRYSTAL_H