ReParticle.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Particle/ReParticle.h
//! @brief     Defines interface class ReParticle.
//!
//! @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_RESAMPLE_PARTICLE_REPARTICLE_H
#define BORNAGAIN_RESAMPLE_PARTICLE_REPARTICLE_H
 
#include "Resample/Particle/IReParticle.h"
#include <heinz/Vectors3D.h>
#include <memory>
 
class IFormFactor;
class Material;
class RotMatrix;
 
//! A reprocessed simple particle, with shape m_ff.
 
class ReParticle : public IReParticle {
public:
    ReParticle(const IFormFactor& ff);
    ~ReParticle() override;
 
    ReParticle* clone() const override;
 
    //! Sets the material of the scatterer
    void setMaterial(const Material& material);
 
    //! Sets the ambient material
    void setAmbientMaterial(const Material& ambient_material) override;
 
    void setPosition(const R3& position);
    void setRotMatrix(const RotMatrix& rotMatrix);
 
    complex_t theFF(const WavevectorInfo& wavevectors) const override;
    SpinMatrix thePolFF(const WavevectorInfo& wavevectors) const override;
 
    double volume() const override;
 
    double radialExtension() const override;
 
    double bottomZ(const IRotation* rotation) const override;
 
    double topZ(const IRotation* rotation) const override;
 
    const IFormFactor* formfactor_at_bottom() const;
 
    virtual complex_t formfactor_at_bottom(C3 q) const;
 
    static ReParticle* createTransformedFormFactor(const IFormFactor& formfactor,
                                                   const IRotation* rot, R3 translation);
 
protected:
    std::unique_ptr<const IFormFactor> m_ff;
 
    // private:
    ReParticle(IFormFactor* ff, const Material* material, const Material* ambient_material,
               const R3* position, const RotMatrix* rotMatrix);
 
    std::unique_ptr<const Material> m_material;
    std::unique_ptr<const Material> m_ambient_material;
    std::unique_ptr<const R3> m_position;
    std::unique_ptr<const RotMatrix> m_rotMatrix;
};
 
#endif // BORNAGAIN_RESAMPLE_PARTICLE_REPARTICLE_H
#endif // USER_API