LayerInterface.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Interface/LayerInterface.h
//! @brief     Defines class LayerInterface.
//!
//! @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_SAMPLE_INTERFACE_LAYERINTERFACE_H
#define BORNAGAIN_SAMPLE_INTERFACE_LAYERINTERFACE_H
 
#include "Sample/Scattering/ISampleNode.h"
#include <memory>
 
class LayerRoughness;
class Layer;
 
//! Interface between two layers, possibly with roughness.
 
class LayerInterface : public ISampleNode {
public:
    ~LayerInterface() override;
 
    LayerInterface* clone() const override;
    std::string className() const final { return "LayerInterface"; }
 
    //! Creates smooth interface between two layers
    static LayerInterface* createSmoothInterface(const Layer* top_layer, const Layer* bottom_layer);
 
    //! Creates rough interface between two layers
    static LayerInterface* createRoughInterface(const Layer* top_layer, const Layer* bottom_layer,
                                                const LayerRoughness& roughness);
 
    //! Sets roughness of the interface.
    void setRoughness(const LayerRoughness& roughness);
 
    //! Returns roughness of the interface.
    const LayerRoughness* roughness() const;
 
    const Layer* topLayer() const;
 
    const Layer* bottomLayer() const;
 
    std::vector<const INode*> nodeChildren() const override;
 
private:
    void setLayersTopBottom(const Layer* top_layer, const Layer* bottom_layer);
    LayerInterface();
 
    const Layer* m_topLayer;                     //!< pointer to the layer above interface
    const Layer* m_bottomLayer;                  //!< pointer to the layer below interface
    std::unique_ptr<LayerRoughness> m_roughness; //!< roughness of the interface
};
 
inline const LayerRoughness* LayerInterface::roughness() const
{
    return m_roughness.get();
}
 
inline const Layer* LayerInterface::topLayer() const
{
    return m_topLayer;
}
 
inline const Layer* LayerInterface::bottomLayer() const
{
    return m_bottomLayer;
}
 
#endif // BORNAGAIN_SAMPLE_INTERFACE_LAYERINTERFACE_H
#endif // USER_API