MultiLayer.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Multilayer/MultiLayer.h
//! @brief     Defines class MultiLayer.
//!
//! @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_MULTILAYER_MULTILAYER_H
#define BORNAGAIN_SAMPLE_MULTILAYER_MULTILAYER_H
 
#include "Base/Types/OwningVector.h"
#include "Sample/Multilayer/RoughnessModels.h"
#include "Sample/Scattering/ISampleNode.h"
#include <functional>
#include <heinz/Vectors3D.h>
 
class ParticleLayout;
class Layer;
class LayerInterface;
class LayerRoughness;
 
//! Our sample model: a stack of layers one below the other.
//! @ingroup samples
 
//! Example of system of 4 layers (3 interfaces):
//! @verbatim
//! vacuum      layer 0
//! ---------   interface 0    z=0.0
//! Fe, 20A     layer 1
//! ---------   interface 1    z=-20.0
//! Cr, 40A     layer 2
//! ---------   interface 2    z=-60.0
//! substrate   layer 3
//! @endverbatim
 
class MultiLayer : public ISampleNode {
public:
    MultiLayer(std::string name = "Unnamed");
    ~MultiLayer() override;
 
    MultiLayer* clone() const override;
    std::string className() const final { return "MultiLayer"; }
 
    size_t numberOfLayers() const { return m_layers.size(); }
 
    void addLayer(const Layer& layer);
    void addLayerWithTopRoughness(const Layer& layer, const LayerRoughness& roughness);
    void setRoughnessModel(RoughnessModel roughnessModel);
    //! Sets cross correlation length of roughnesses between interfaces
    void setCrossCorrLength(double crossCorrLength);
    //! Sets the external field applied to the sample (units: A/m)
    void setExternalField(R3 ext_field);
 
    //! Returns layer with given index
    const Layer* layer(size_t i_layer) const;
 
    //! Returns interface with given index
    const LayerInterface* layerInterface(size_t i_interface) const;
 
    RoughnessModel roughnessModel() const { return m_roughness_model; }
    //! Returns cross correlation length of roughnesses between interfaces
    double crossCorrLength() const { return m_crossCorrLength; }
    //! Returns the external field applied to the sample (units: A/m)
    R3 externalField() const { return m_ext_field; }
 
    std::vector<const INode*> nodeChildren() const override;
 
    void setSampleName(const std::string& name) { m_sample_name = name; }
    const std::string& sampleName() const { return m_sample_name; }
 
private:
    //! Adds the layer with simultaneous registration in parent class
    void addLayer(Layer* child);
 
    //! Adds the interface with simultaneous registration in parent class
    void addInterface(LayerInterface* child);
 
    //! stack of layers [nlayers]
    OwningVector<Layer> m_layers;
    //! stack of layer interfaces [nlayers-1]
    OwningVector<LayerInterface> m_interfaces;
    //! cross correlation length (in z direction) between different layers
    double m_crossCorrLength;
    //! external magnetic field (in A/m)
    R3 m_ext_field;
 
    std::string m_sample_name{"Unnamed"};
    RoughnessModel m_roughness_model{RoughnessModel::DEFAULT};
};
 
#endif // BORNAGAIN_SAMPLE_MULTILAYER_MULTILAYER_H