MultiLayerFuncs.cpp File Reference

Include dependency graph for MultiLayerFuncs.cpp:

Go to the source code of this file.

Functions
std::vector< complex_t >	MaterialProfile (const MultiLayer &multilayer, int n_points, double z_min, double z_max)
std::pair< double, double >	DefaultMaterialProfileLimits (const MultiLayer &multilayer)
std::vector< double >	GenerateZValues (int n_points, double z_min, double z_max)

Detailed Description

Global functions related to MultiLayers.

Homepage:\n http://www.bornagainproject.org

License:\n GNU General Public License v3 or higher (see COPYING)

Copyright

Forschungszentrum Jülich GmbH 2018

Authors

Scientific Computing Group at MLZ (see CITATION, AUTHORS)

Definition in file MultiLayerFuncs.cpp.

Function Documentation

DefaultMaterialProfileLimits()

std::pair<double, double> DefaultMaterialProfileLimits

(

const MultiLayer &

multilayer

)

Get default z limits for generating a material profile.

Definition at line 31 of file MultiLayerFuncs.cpp.

{
    SimulationOptions options;
    options.setUseAvgMaterials(true);
    ProcessedSample sample(multilayer, options);
    ProfileHelper helper(sample);
    return helper.defaultLimits();
}

References ProfileHelper::defaultLimits(), and SimulationOptions::setUseAvgMaterials().

Here is the call graph for this function:

GenerateZValues()

std::vector<double> GenerateZValues	(	int	n_points,
		double	z_min,
		double	z_max
	)

Generate z values (equidistant) for use in MaterialProfile.

Definition at line 40 of file MultiLayerFuncs.cpp.

{
    std::vector<double> result;
    if (n_points < 1)
        return result;
    double step = n_points > 1 ? (z_max - z_min) / (n_points - 1) : 0.0;
    for (int i = 0; i < n_points; ++i) {
        result.push_back(z_min + i * step);
    }
    return result;
}

Referenced by MaterialProfile().