MultiLayerFuncs.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Processed/MultiLayerFuncs.h
//! @brief     Global functions related to MultiLayers.
//!
//! @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 USER_API
#ifndef BORNAGAIN_SAMPLE_PROCESSED_MULTILAYERFUNCS_H
#define BORNAGAIN_SAMPLE_PROCESSED_MULTILAYERFUNCS_H
 
#include "Base/Types/Complex.h"
#include <utility>
#include <vector>
 
class MultiLayer;
 
//! @ingroup materials
 
//! Functions that are only used in the swig *.i files
namespace swigAPI {
 
std::vector<double> generateZValues(int n_points, double z_min, double z_max);
 
//! Calculate average material profile for given multilayer
std::vector<complex_t> materialProfileSLD(const MultiLayer& multilayer, int n_points, double z_min,
                                          double z_max);
 
//! Get default z limits for generating a material profile
std::pair<double, double> defaultMaterialProfileLimits(const MultiLayer& multilayer);
 
} // namespace swigAPI
 
#endif // BORNAGAIN_SAMPLE_PROCESSED_MULTILAYERFUNCS_H
#endif // USER_API