Box.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/HardParticle/Box.h
//! @brief     Defines class Box.
//!
//! @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_HARDPARTICLE_BOX_H
#define BORNAGAIN_SAMPLE_HARDPARTICLE_BOX_H
 
#include "Sample/HardParticle/IFormFactorPrism.h"
 
//! A rectangular prism (parallelepiped).
//! @ingroup hardParticle
 
class Box : public IFormFactorPrism {
public:
    Box(double length, double width, double height);
#ifndef USER_API
    Box(std::vector<double> P);
 
    Box* clone() const override { return new Box(m_length, m_width, m_height); }
    std::string className() const final { return "Box"; }
    // const auto tooltip = "rectangular cuboid";
    std::vector<ParaMeta> parDefs() const final
    {
        return {{"Length", "nm", "side length in x direction", 0, +INF, 0},
                {"Width", "nm", "side length in y direction", 0, +INF, 0},
                {"Height", "nm", "side length in z direction", 0, +INF, 0}};
    }
 
    double length() const { return m_length; }
    double width() const { return m_width; }
    double height() const override { return m_height; }
 
    double volume() const override { return m_length * m_height * m_width; }
    double radialExtension() const override { return m_length / 2.0; }
    complex_t formfactor_at_bottom(C3 q) const override;
 
private:
    const double& m_length;
    const double& m_width;
    const double& m_height;
#endif // USER_API
};
 
#endif // BORNAGAIN_SAMPLE_HARDPARTICLE_BOX_H