IParticle.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Particle/IParticle.h
//! @brief     Defines interface IParticle.
//!
//! @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 USER_API
#ifndef BORNAGAIN_SAMPLE_PARTICLE_IPARTICLE_H
#define BORNAGAIN_SAMPLE_PARTICLE_IPARTICLE_H
 
#include "Sample/Scattering/ISampleNode.h"
#include <heinz/Vectors3D.h>
#include <memory>
#include <vector>
 
class IRotation;
 
//! Abstract base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal.
//! Provides position/rotation and form factor. Abundance is inherited from IParticle.
//!
//! @ingroup samples
 
class IParticle : public ISampleNode {
public:
    ~IParticle() override;
 
    IParticle* clone() const override = 0;
    std::vector<const INode*> nodeChildren() const override;
 
    double abundance() const { return m_abundance; }
 
    //! Sets particle abundance.
    //! @param abundance: proportion of this type of particles normalized to the
    //! total number of particles in the layout.
    void setAbundance(double abundance) { m_abundance = abundance; }
 
    //! Returns particle position.
    R3 particlePosition() const { return m_position; }
 
    //! Sets relative position of the particle's reference point in the
    //! coordinate system of parent.
    //! @param position: relative position vector (components are in nanometers)
    void setParticlePosition(R3 position) { m_position = position; }
 
    //! Sets relative position of the particle's reference point in the
    //! coordinate system of parent.
    //! @param x: x-coordinate in nanometers
    //! @param y: y-coordinate in nanometers
    //! @param z: z-coordinate in nanometers
    void setParticlePosition(double x, double y, double z) { m_position = R3(x, y, z); }
 
    //! Translates the particle, and returns this.
    IParticle* translate(R3 translation);
 
    //! Returns rotation object
    const IRotation* rotation() const;
 
    //! Sets transformation.
    void setRotation(const IRotation& rotation);
 
    //! Rotates the particle, and returns this.
    IParticle* rotate(const IRotation& rotation);
 
#ifndef SWIG
    //! Decompose in constituent IParticle objects
    virtual std::vector<std::unique_ptr<IParticle>> decompose() const;
#endif
 
protected:
    double m_abundance{1.0}; // not a Parameter
    R3 m_position;
    std::unique_ptr<IRotation> m_rotation;
};
 
#endif // BORNAGAIN_SAMPLE_PARTICLE_IPARTICLE_H
#endif // USER_API