Slice.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Slice/Slice.h
//! @brief     Defines class Slice.
//!
//! @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_SLICE_H
#define BORNAGAIN_RESAMPLE_SLICE_SLICE_H
 
#include "Resample/Slice/ZLimits.h"
#include "Sample/Material/Material.h"
#include <memory>
 
class LayerRoughness;
 
//! Data structure containing the data of a single slice, for calculating the Fresnel coefficients.
 
class Slice {
public:
    Slice(const ZLimits& zRange, Material material, const R3& B_field,
          const LayerRoughness* roughness);
    Slice(const Slice& other);
    Slice(Slice&& other);
    ~Slice();
 
    void setMaterial(const Material& material);
    const Material& material() const;
 
    double zBottom() const;
    double zTop() const;
    double zTopOr0() const;
    double thicknessOr0() const;
    const LayerRoughness* topRoughness() const;
 
    //! Return the potential term that is used in the one-dimensional Fresnel calculations
    complex_t scalarReducedPotential(R3 k, double n_ref) const;
 
    //! Return the potential term that is used in the one-dimensional Fresnel calculations
    //! in the presence of magnetization
    SpinMatrix polarizedReducedPotential(R3 k, double n_ref) const;
 
    //! Initializes the magnetic B field from a given ambient field strength H
    void initBField(R3 h_field, double h_z);
    R3 bField() const { return m_B_field; }
 
    void invertBField();
 
private:
    const ZLimits m_zRange;
    Material m_material;
    R3 m_B_field; //!< cached value of magnetic induction
    const LayerRoughness* const m_top_roughness;
};
 
#endif // BORNAGAIN_RESAMPLE_SLICE_SLICE_H
#endif // USER_API