Particle.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Particle/Particle.h
//! @brief     Defines class Particle.
//!
//! @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_PARTICLE_H
#define BORNAGAIN_SAMPLE_PARTICLE_PARTICLE_H
 
#include "Sample/Material/Material.h"
#include "Sample/Particle/IFormFactor.h"
#include "Sample/Particle/IParticle.h"
 
//! A particle with a form factor and refractive index.
//! @ingroup samples
 
class Particle : public IParticle {
public:
    Particle(Material material, const IFormFactor& formfactor);
    Particle(Material material, const IFormFactor& formfactor, const IRotation& rotation);
    ~Particle() override;
 
    Particle* clone() const override;
    std::string className() const override { return "Particle"; }
    std::vector<const INode*> nodeChildren() const override;
 
    const Material* material() const override { return &m_material; }
 
    const IFormFactor* formfactor_at_bottom() const { return m_formfactor.get(); }
 
private:
    const Material m_material;
    std::unique_ptr<const IFormFactor> m_formfactor;
};
 
#endif // BORNAGAIN_SAMPLE_PARTICLE_PARTICLE_H