SliceStack.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Slice/SliceStack.h
//! @brief     Defines class SliceStack.
//!
//! @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_SLICE_SLICESTACK_H
#define BORNAGAIN_RESAMPLE_SLICE_SLICESTACK_H
 
#include "Resample/Slice/Slice.h" // TODO move back to cpp file
#include <heinz/Vectors3D.h>
 
// - either get rid of m_roughness_model
// - or of inheritance from std::vector
 
#include "Sample/Multilayer/RoughnessModels.h"
#include <vector>
 
class LayerRoughness;
class Material;
class Slice;
 
//! A stack of Slice%s.
 
class SliceStack : public std::vector<Slice> {
public:
    SliceStack(const RoughnessModel roughness_model)
        : m_roughness_model(roughness_model)
    {
    }
    SliceStack(const SliceStack& other);
 
    void addTopSlice(double zbottom, const Material& material);
    void addSlice(double thickness, const Material& material,
                  const LayerRoughness* roughness = nullptr);
    void addNSlices(size_t n, double thickness, const Material& material,
                    const LayerRoughness* roughness = nullptr);
 
    SliceStack setBField(const R3& externalField);
 
    bool containsMagneticMaterial() const;
    const LayerRoughness* bottomRoughness(size_t i_slice) const;
 
    RoughnessModel roughnessModel() const { return m_roughness_model; }
 
private:
    const RoughnessModel m_roughness_model;
};
 
#endif // BORNAGAIN_RESAMPLE_SLICE_SLICESTACK_H
#endif // USER_API