IReParticle.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Particle/IReParticle.h
//! @brief     Defines and implements interface IReParticle.
//!
//! @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_IREPARTICLE_H
#define BORNAGAIN_RESAMPLE_PARTICLE_IREPARTICLE_H
 
#include "Base/Types/ICloneable.h"
#include <heinz/Complex.h>
#include <heinz/Vectors3D.h>
 
class IRotation;
class Material;
class SpinMatrix;
class WavevectorInfo;
 
//! Abstract base class for reprocessed particles.
//!
//! Reprocessing is necessary to handle particles that cross material layers.
//! These particles are divided into several.
 
class IReParticle : public ICloneable {
protected:
    IReParticle() = default;
 
public:
    ~IReParticle() override = default;
 
    IReParticle* clone() const override = 0;
 
    //! Passes the material in which this particle is embedded.
    virtual void setAmbientMaterial(const Material&) {}
 
    //! Returns scattering amplitude for complex wavevectors ki, kf.
    virtual complex_t theFF(const WavevectorInfo& wavevectors) const = 0;
 
    //! Returns the (approximate in some cases) radial size of the particle of this
    //! form factor's shape. This is used for SSCA calculations
    virtual double radialExtension() const = 0;
 
    //! Returns the z-coordinate of the lowest point in this shape after a given rotation
    virtual double bottomZ(const IRotation* rotation) const = 0;
 
    //! Returns the z-coordinate of the lowest point in this shape after a given rotation
    virtual double topZ(const IRotation* rotation) const = 0;
 
    //! Returns scattering amplitude for matrix interactions
    virtual SpinMatrix thePolFF(const WavevectorInfo& wavevectors) const;
 
    //! Returns the total volume of the particle of this form factor's shape
    virtual double volume() const;
};
 
#endif // BORNAGAIN_RESAMPLE_PARTICLE_IREPARTICLE_H
#endif // USER_API