particles.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/ba3d/model/particles.h
//! @brief     Defines Particle class
//!
//! @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_GUI_BA3D_MODEL_PARTICLES_H
#define BORNAGAIN_GUI_BA3D_MODEL_PARTICLES_H
 
#include "GUI/ba3d/model/object.h"
 
namespace GUI::RealSpace::Particles {
 
enum class EShape {
    BarGauss,
    BarLorentz,
    Bipyramid4,
    Box,
    CantellatedCube,
    Cone,
    CosineRippleBox,
    CosineRippleGauss,
    CosineRippleLorentz,
    Cylinder,
    Dodecahedron,
    EllipsoidalCylinder,
    Sphere,
    Spheroid,
    HemiEllipsoid,
    HorizontalCylinder,
    Icosahedron,
    None,
    PlatonicOctahedron,
    PlatonicTetrahedron,
    Prism3,
    Prism6,
    Pyramid2,
    Pyramid3,
    Pyramid4,
    Pyramid6,
    SawtoothRippleBox,
    SawtoothRippleGauss,
    SawtoothRippleLorentz,
    TruncatedCube,
    TruncatedSphere,
    TruncatedSpheroid
};
 
QString const& name(EShape);
 
//------------------------------------------------------------------------------
 
class Particle : public Object {
protected:
    Particle(GeometricID::Key);
    Vector3D turn;              // turn before scale
    Vector3D scale;             // geometries are of 1-size (box 1x1x1, sphere D=1), need scaling
    Vector3D offset;            // geometries centered around origin; particles stand on z=0 plane
    Vector3D rotate, translate; // remembered
 
    void set();
 
public:
    static EShape const firstKind = EShape::BarGauss;
    static EShape const lastKind = EShape::TruncatedSpheroid;
 
    void transform(Vector3D rotate, Vector3D translate);
    void fancy(Vector3D rotate, float r);
 
    void addTransform(Vector3D rotate, Vector3D translate);
    void addTranslation(Vector3D translate_);
    void addExtrinsicRotation(Vector3D rotateExtrinsic);
};
 
//------------------------------------------------------------------------------
 
class Sphere : public Particle {
public:
    Sphere(float R);
};
 
class Spheroid : public Particle {
public:
    Spheroid(float R, float H);
};
 
class Cylinder : public Particle {
public:
    Cylinder(float R, float H);
};
 
class TruncatedSphere : public Particle {
public:
    TruncatedSphere(float R, float H, float deltaH = 0.0f);
};
 
class TruncatedSpheroid : public Particle {
public:
    TruncatedSpheroid(float R, float H, float fp, float deltaH = 0.0f);
};
 
class Cone : public Particle {
public:
    Cone(float R, float H, float alpha);
};
 
class Icosahedron : public Particle {
public:
    Icosahedron(float L);
};
 
class Dodecahedron : public Particle {
public:
    Dodecahedron(float L);
};
 
class TruncatedCube : public Particle {
public:
    TruncatedCube(float L, float t);
};
 
class Prism6 : public Particle {
public:
    Prism6(float R, float H);
};
 
class Pyramid6 : public Particle {
public:
    Pyramid6(float R, float H, float alpha);
};
 
class Pyramid4 : public Particle {
public:
    Pyramid4(float L, float H, float alpha);
};
 
class Bipyramid4 : public Particle {
public:
    Bipyramid4(float L, float H, float rH, float alpha);
};
 
class Prism3 : public Particle {
public:
    Prism3(float L, float H);
};
 
class Pyramid3 : public Particle {
public:
    Pyramid3(float L, float H, float alpha);
};
 
class EllipsoidalCylinder : public Particle {
public:
    EllipsoidalCylinder(float Ra, float Rb, float H);
};
 
class BarGauss : public Particle {
public:
    BarGauss(float L, float W, float H);
};
 
class BarLorentz : public Particle {
public:
    BarLorentz(float L, float W, float H);
};
 
class Box : public Particle {
public:
    Box(float L, float W, float H);
};
 
class HemiEllipsoid : public Particle {
public:
    HemiEllipsoid(float Ra, float Rb, float H);
};
 
class CosineRippleBox : public Particle {
public:
    CosineRippleBox(float L, float W, float H);
};
 
class CosineRippleGauss : public Particle {
public:
    CosineRippleGauss(float L, float W, float H);
};
 
class CosineRippleLorentz : public Particle {
public:
    CosineRippleLorentz(float L, float W, float H);
};
 
class SawtoothRippleBox : public Particle {
public:
    SawtoothRippleBox(float L, float W, float H);
};
 
class SawtoothRippleGauss : public Particle {
public:
    SawtoothRippleGauss(float L, float W, float H);
};
 
class SawtoothRippleLorentz : public Particle {
public:
    SawtoothRippleLorentz(float L, float W, float H);
};
 
class SawtoothRipple : public Particle {
public:
    SawtoothRipple(float L, float W, float H, float asymmetry);
};
 
class CantellatedCube : public Particle {
public:
    CantellatedCube(float L, float t);
};
 
class HorizontalCylinder : public Particle {
public:
    HorizontalCylinder(float R, float L, float s_b, float s_t);
};
 
class PlatonicOctahedron : public Particle {
public:
    PlatonicOctahedron(float L);
};
 
class PlatonicTetrahedron : public Particle {
public:
    PlatonicTetrahedron(float L);
};
 
class Pyramid2 : public Particle {
public:
    Pyramid2(float L, float W, float H, float alpha);
};
 
} // namespace GUI::RealSpace::Particles
 
#endif // BORNAGAIN_GUI_BA3D_MODEL_PARTICLES_H