MultilayerUtils.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Multilayer/MultilayerUtils.cpp
//! @brief     Implements helper functions for MultiLayer objects.
//!
//! @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)
//
//  ************************************************************************************************
 
#include "Sample/Multilayer/MultilayerUtils.h"
#include "Sample/Interface/LayerInterface.h"
#include "Sample/Material/MaterialUtils.h"
#include "Sample/Multilayer/Layer.h"
#include "Sample/Multilayer/MultiLayer.h"
 
const LayerRoughness* SampleUtils::Multilayer::LayerTopRoughness(const MultiLayer& sample, size_t i)
{
    if (i == 0)
        return nullptr;
    return sample.layerInterface(i - 1)->roughness();
}
 
size_t SampleUtils::Multilayer::IndexOfLayer(const MultiLayer& sample, const Layer* p_layer)
{
    for (size_t i = 0; i < sample.numberOfLayers(); ++i)
        if (p_layer == sample.layer(i))
            return i;
    throw std::out_of_range("SampleUtils::Multilayer::IndexOfLayer: layer not found");
}
 
bool SampleUtils::Multilayer::ContainsCompatibleMaterials(const MultiLayer& sample)
{
    return MaterialUtils::checkMaterialTypes(sample.containedMaterials())
           != MATERIAL_TYPES::InvalidMaterialType;
}
 
bool SampleUtils::Multilayer::hasRoughness(const MultiLayer& sample)
{
    for (size_t i = 0; i < sample.numberOfLayers() - 1; i++)
        if (sample.layerInterface(i)->roughness())
            return true;
    return false;
}