SampleUtils::Multilayer Namespace Reference

Description

Helper functions for class MultiLayer.

Functions
bool	ContainsCompatibleMaterials (const MultiLayer &sample)
	Returns true if the sample contains non-default materials of one type only. More...
bool	hasRoughness (const MultiLayer &sample)
size_t	IndexOfLayer (const MultiLayer &sample, const Layer *p_layer)
	Returns the index of the given layer. More...
const LayerRoughness *	LayerTopRoughness (const MultiLayer &sample, size_t i)
	Returns top roughness of layer. More...

Function Documentation

ContainsCompatibleMaterials()

bool SampleUtils::Multilayer::ContainsCompatibleMaterials

(

const MultiLayer &

sample

)

Returns true if the sample contains non-default materials of one type only.

Definition at line 36 of file MultilayerUtils.cpp.

{
    return MaterialUtils::checkMaterialTypes(sample.containedMaterials())
           != MATERIAL_TYPES::InvalidMaterialType;
}

References MaterialUtils::checkMaterialTypes(), ISampleNode::containedMaterials(), and InvalidMaterialType.

Referenced by ISimulation::simulate().

Here is the call graph for this function:

hasRoughness()

bool SampleUtils::Multilayer::hasRoughness

(

const MultiLayer &

sample

)

Definition at line 42 of file MultilayerUtils.cpp.

{
    for (size_t i = 0; i < sample.numberOfLayers() - 1; i++)
        if (sample.layerInterface(i)->roughness())
            return true;
    return false;
}

References MultiLayer::layerInterface(), MultiLayer::numberOfLayers(), and LayerInterface::roughness().

Here is the call graph for this function:

IndexOfLayer()

size_t SampleUtils::Multilayer::IndexOfLayer	(	const MultiLayer &	sample,
		const Layer *	p_layer
	)

Returns the index of the given layer.

Definition at line 28 of file MultilayerUtils.cpp.

{
    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");
}

References MultiLayer::layer(), and MultiLayer::numberOfLayers().

Here is the call graph for this function:

LayerTopRoughness()

const LayerRoughness * SampleUtils::Multilayer::LayerTopRoughness	(	const MultiLayer &	sample,
		size_t	i
	)

Returns top roughness of layer.

Definition at line 21 of file MultilayerUtils.cpp.

{
    if (i == 0)
        return nullptr;
    return sample.layerInterface(i - 1)->roughness();
}

References MultiLayer::layerInterface(), and LayerInterface::roughness().

Here is the call graph for this function: