From 1dfd7e1e566fce445741fda8ebc5461d687834aa Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de>
Date: Wed, 21 Jul 2021 16:48:47 +0200
Subject: [PATCH] rename namespaces
---
Core/Element/SpecularElement.cpp | 7 ++--
Resample/Processed/ParticleRegions.cpp | 4 +--
Resample/Processed/ParticleRegions.h | 6 ++--
Resample/Processed/ProcessedSample.cpp | 4 +--
Resample/Slice/KzComputation.cpp | 11 +++---
Resample/Slice/KzComputation.h | 13 ++-----
.../Specular/SpecularMagneticNCStrategy.h | 4 +--
.../Specular/SpecularMagneticStrategy.cpp | 13 +++----
.../Specular/SpecularMagneticTanhStrategy.cpp | 3 +-
.../Specular/SpecularMagneticTanhStrategy.h | 4 +--
Resample/Specular/SpecularScalarStrategy.cpp | 2 +-
.../Core/Fresnel/KzComputationTest.cpp | 20 +++++------
.../Core/Fresnel/SpecularMagneticTest.cpp | 4 +--
auto/Wrap/doxygenResample.i | 35 +++++++++----------
14 files changed, 58 insertions(+), 72 deletions(-)
diff --git a/Core/Element/SpecularElement.cpp b/Core/Element/SpecularElement.cpp
index 050b4773cfb..f85333e9431 100644
--- a/Core/Element/SpecularElement.cpp
+++ b/Core/Element/SpecularElement.cpp
@@ -22,9 +22,8 @@ SpecularElement::SpecularElement(double kz, const Instrument& instrument, bool c
instrument.detector().detectionProperties().analyzerOperator())
, m_intensity(0.0)
, m_computable(computable)
- , m_kz_computation([kz](const SliceStack& slices) {
- return SampleUtils::KzComputation::computeKzFromSLDs(slices, kz);
- })
+ , m_kz_computation(
+ [kz](const SliceStack& slices) { return Compute::Kz::computeKzFromSLDs(slices, kz); })
{
}
@@ -35,7 +34,7 @@ SpecularElement::SpecularElement(double wavelength, double alpha, const Instrume
, m_intensity(0.0)
, m_computable(computable)
, m_kz_computation([k = vecOfLambdaAlphaPhi(wavelength, alpha, 0.0)](const SliceStack& slices) {
- return SampleUtils::KzComputation::computeKzFromRefIndices(slices, k);
+ return Compute::Kz::computeKzFromRefIndices(slices, k);
})
{
}
diff --git a/Resample/Processed/ParticleRegions.cpp b/Resample/Processed/ParticleRegions.cpp
index a475175a016..7e52543e2a8 100644
--- a/Resample/Processed/ParticleRegions.cpp
+++ b/Resample/Processed/ParticleRegions.cpp
@@ -153,8 +153,8 @@ void LayerFillLimits::updateLayerLimits(size_t i_layer, ZLimits limits)
// ************************************************************************************************
//! Calculate z-admixtures occupied by particles
-std::vector<ZLimits> SampleUtils::Preprocessor::particleRegions(const MultiLayer& multilayer,
- bool use_slicing)
+std::vector<ZLimits> Compute::Slicing::particleRegions(const MultiLayer& multilayer,
+ bool use_slicing)
{
const std::vector<double> bottom_coords = bottomLayerCoordinates(multilayer);
LayerFillLimits layer_fill_limits(bottom_coords);
diff --git a/Resample/Processed/ParticleRegions.h b/Resample/Processed/ParticleRegions.h
index 0e647c21bd9..55619d6d2a1 100644
--- a/Resample/Processed/ParticleRegions.h
+++ b/Resample/Processed/ParticleRegions.h
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit reflection and scattering
//
//! @file Resample/Processed/ParticleRegions.h
-//! @brief Defines function SampleUtils::Preprocessor::particleRegions.
+//! @brief Defines function Compute::Slicing::particleRegions.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
@@ -25,11 +25,11 @@
class MultiLayer;
class ZLimits;
-namespace SampleUtils::Preprocessor {
+namespace Compute::Slicing {
std::vector<ZLimits> particleRegions(const MultiLayer& multilayer, bool use_slicing);
-} // namespace SampleUtils::Preprocessor
+} // namespace Compute::Slicing
#endif // BORNAGAIN_RESAMPLE_PROCESSED_PARTICLEREGIONS_H
diff --git a/Resample/Processed/ProcessedSample.cpp b/Resample/Processed/ProcessedSample.cpp
index 22e90e04e05..7529b9655a3 100644
--- a/Resample/Processed/ProcessedSample.cpp
+++ b/Resample/Processed/ProcessedSample.cpp
@@ -19,8 +19,8 @@
#include "Resample/Processed/ProcessedLayout.h"
#include "Resample/Slice/Slice.h"
#include "Resample/Slice/SliceStack.h"
-#include "Resample/Specular/SpecularScalarStrategy.h"
#include "Resample/Specular/SpecularMagneticStrategy.h"
+#include "Resample/Specular/SpecularScalarStrategy.h"
#include "Sample/Interface/LayerRoughness.h"
#include "Sample/Material/Admixtures.h"
#include "Sample/Material/MaterialBySLDImpl.h"
@@ -128,7 +128,7 @@ SliceStack slicify(const MultiLayer& sample, const SimulationOptions& options)
if (sample.numberOfLayers() == 0)
return result;
const bool use_slicing = options.useAvgMaterials() && sample.numberOfLayers() > 1;
- const auto layer_limits = SampleUtils::Preprocessor::particleRegions(sample, use_slicing);
+ const auto layer_limits = Compute::Slicing::particleRegions(sample, use_slicing);
for (size_t i = 0; i < sample.numberOfLayers(); ++i) {
const Layer* const layer = sample.layer(i);
const size_t N = layer->numberOfSlices();
diff --git a/Resample/Slice/KzComputation.cpp b/Resample/Slice/KzComputation.cpp
index cc5903d67fc..ef5d8043956 100644
--- a/Resample/Slice/KzComputation.cpp
+++ b/Resample/Slice/KzComputation.cpp
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit reflection and scattering
//
//! @file Resample/Slice/KzComputation.cpp
-//! @brief Implements functions in namespace KzComputation.
+//! @brief Implements functions in namespace Compute::Kz.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
@@ -41,8 +41,7 @@ complex_t checkForUnderflow(complex_t val)
// namespace KzComputation
// ************************************************************************************************
-std::vector<complex_t> SampleUtils::KzComputation::computeReducedKz(const SliceStack& slices,
- kvector_t k)
+std::vector<complex_t> Compute::Kz::computeReducedKz(const SliceStack& slices, kvector_t k)
{
const size_t N = slices.size();
const double n_ref = slices[0].material().refractiveIndex(M_TWOPI / k.mag()).real();
@@ -59,8 +58,7 @@ std::vector<complex_t> SampleUtils::KzComputation::computeReducedKz(const SliceS
return result;
}
-std::vector<complex_t> SampleUtils::KzComputation::computeKzFromSLDs(const SliceStack& slices,
- double kz)
+std::vector<complex_t> Compute::Kz::computeKzFromSLDs(const SliceStack& slices, double kz)
{
const size_t N = slices.size();
const double k_sign = kz > 0.0 ? -1 : 1;
@@ -76,8 +74,7 @@ std::vector<complex_t> SampleUtils::KzComputation::computeKzFromSLDs(const Slice
return result;
}
-std::vector<complex_t> SampleUtils::KzComputation::computeKzFromRefIndices(const SliceStack& slices,
- kvector_t k)
+std::vector<complex_t> Compute::Kz::computeKzFromRefIndices(const SliceStack& slices, kvector_t k)
{
const size_t N = slices.size();
const double kz = k.z();
diff --git a/Resample/Slice/KzComputation.h b/Resample/Slice/KzComputation.h
index f6366172acb..00e067d4933 100644
--- a/Resample/Slice/KzComputation.h
+++ b/Resample/Slice/KzComputation.h
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit reflection and scattering
//
//! @file Resample/Slice/KzComputation.h
-//! @brief Declares functions in namespace KzComputation.
+//! @brief Declares functions in namespace ComputateKz.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
@@ -25,12 +25,7 @@
class SliceStack;
-namespace SampleUtils {
-
-//! Namespace containing functions for computing kz values for given multilayer and k (or kz) value
-//! on the surface of the sample.
-
-namespace KzComputation {
+namespace Compute::Kz {
//! Computes kz values from known k vector and slices with the following assumptions:
//! - the beam penetrates fronting medium from a side
@@ -52,9 +47,7 @@ std::vector<complex_t> computeKzFromSLDs(const SliceStack& slices, double kz);
std::vector<complex_t> computeKzFromRefIndices(const SliceStack& slices, kvector_t k);
-} // namespace KzComputation
-
-} // namespace SampleUtils
+} // namespace Compute::Kz
#endif // BORNAGAIN_RESAMPLE_SLICE_KZCOMPUTATION_H
#endif // USER_API
diff --git a/Resample/Specular/SpecularMagneticNCStrategy.h b/Resample/Specular/SpecularMagneticNCStrategy.h
index e66d6bc244a..695d0358bba 100644
--- a/Resample/Specular/SpecularMagneticNCStrategy.h
+++ b/Resample/Specular/SpecularMagneticNCStrategy.h
@@ -32,8 +32,8 @@
//! document "Polarized Implementation of the Transfer Matrix Method"
namespace Compute::MagneticNevotCroceTransition {
- std::pair<Eigen::Matrix2cd, Eigen::Matrix2cd>
- backwardsSubmatrices(const MatrixFlux& coeff_i, const MatrixFlux& coeff_i1, double sigma);
+std::pair<Eigen::Matrix2cd, Eigen::Matrix2cd>
+backwardsSubmatrices(const MatrixFlux& coeff_i, const MatrixFlux& coeff_i1, double sigma);
}
#endif // BORNAGAIN_RESAMPLE_SPECULAR_SPECULARMAGNETICNCSTRATEGY_H
diff --git a/Resample/Specular/SpecularMagneticStrategy.cpp b/Resample/Specular/SpecularMagneticStrategy.cpp
index 2ecec810eb8..a29ca36d63f 100644
--- a/Resample/Specular/SpecularMagneticStrategy.cpp
+++ b/Resample/Specular/SpecularMagneticStrategy.cpp
@@ -51,8 +51,8 @@ computeBackwardsSubmatrices(const MatrixFlux& coeff_i, const MatrixFlux& coeff_i
const RoughnessModel& r_model)
{
if (r_model == RoughnessModel::NEVOT_CROCE)
- return Compute::MagneticNevotCroceTransition::backwardsSubmatrices(
- coeff_i, coeff_i1, sigma);
+ return Compute::MagneticNevotCroceTransition::backwardsSubmatrices(coeff_i, coeff_i1,
+ sigma);
return Compute::MagneticTanhTransition::backwardsSubmatrices(coeff_i, coeff_i1, sigma);
}
@@ -63,7 +63,7 @@ computeBackwardsSubmatrices(const MatrixFlux& coeff_i, const MatrixFlux& coeff_i
Fluxes SpecularMagneticStrategy::Execute(const SliceStack& slices, const kvector_t& k,
const RoughnessModel& r_model) const
{
- return Execute(slices, SampleUtils::KzComputation::computeReducedKz(slices, k), r_model);
+ return Execute(slices, Compute::Kz::computeReducedKz(slices, k), r_model);
}
Fluxes SpecularMagneticStrategy::Execute(const SliceStack& slices, const std::vector<complex_t>& kz,
@@ -78,9 +78,10 @@ Fluxes SpecularMagneticStrategy::Execute(const SliceStack& slices, const std::ve
return result;
}
-std::variant<complex_t, Eigen::Matrix2cd> SpecularMagneticStrategy::computeTopLayerR(
- const SliceStack& slices, const std::vector<complex_t>& kzs,
- const RoughnessModel& r_model) const
+std::variant<complex_t, Eigen::Matrix2cd>
+SpecularMagneticStrategy::computeTopLayerR(const SliceStack& slices,
+ const std::vector<complex_t>& kzs,
+ const RoughnessModel& r_model) const
{
ASSERT(slices.size() == kzs.size());
diff --git a/Resample/Specular/SpecularMagneticTanhStrategy.cpp b/Resample/Specular/SpecularMagneticTanhStrategy.cpp
index 66e080f9c05..fd85d255322 100644
--- a/Resample/Specular/SpecularMagneticTanhStrategy.cpp
+++ b/Resample/Specular/SpecularMagneticTanhStrategy.cpp
@@ -61,8 +61,7 @@ Eigen::Matrix2cd computeRoughnessMatrix(const MatrixFlux& coeff, double sigma, b
std::pair<Eigen::Matrix2cd, Eigen::Matrix2cd>
Compute::MagneticTanhTransition::backwardsSubmatrices(const MatrixFlux& coeff_i,
- const MatrixFlux& coeff_i1,
- double sigma)
+ const MatrixFlux& coeff_i1, double sigma)
{
Eigen::Matrix2cd R{Eigen::Matrix2cd::Identity()};
Eigen::Matrix2cd RInv{Eigen::Matrix2cd::Identity()};
diff --git a/Resample/Specular/SpecularMagneticTanhStrategy.h b/Resample/Specular/SpecularMagneticTanhStrategy.h
index 2bdd0a24ba3..7068ac093c0 100644
--- a/Resample/Specular/SpecularMagneticTanhStrategy.h
+++ b/Resample/Specular/SpecularMagneticTanhStrategy.h
@@ -31,8 +31,8 @@
namespace Compute::MagneticTanhTransition {
- std::pair<Eigen::Matrix2cd, Eigen::Matrix2cd>
- backwardsSubmatrices(const MatrixFlux& coeff_i, const MatrixFlux& coeff_i1, double sigma);
+std::pair<Eigen::Matrix2cd, Eigen::Matrix2cd>
+backwardsSubmatrices(const MatrixFlux& coeff_i, const MatrixFlux& coeff_i1, double sigma);
}
diff --git a/Resample/Specular/SpecularScalarStrategy.cpp b/Resample/Specular/SpecularScalarStrategy.cpp
index a0ddc06aff3..020e200fcab 100644
--- a/Resample/Specular/SpecularScalarStrategy.cpp
+++ b/Resample/Specular/SpecularScalarStrategy.cpp
@@ -74,7 +74,7 @@ std::pair<complex_t, complex_t> transition(complex_t kzi, complex_t kzi1, double
Fluxes SpecularScalarStrategy::Execute(const SliceStack& slices, const kvector_t& k,
const RoughnessModel& r_model) const
{
- std::vector<complex_t> kz = SampleUtils::KzComputation::computeReducedKz(slices, k);
+ std::vector<complex_t> kz = Compute::Kz::computeReducedKz(slices, k);
return Execute(slices, kz, r_model);
}
diff --git a/Tests/UnitTests/Core/Fresnel/KzComputationTest.cpp b/Tests/UnitTests/Core/Fresnel/KzComputationTest.cpp
index 5c3d96990a5..dd398ed5c53 100644
--- a/Tests/UnitTests/Core/Fresnel/KzComputationTest.cpp
+++ b/Tests/UnitTests/Core/Fresnel/KzComputationTest.cpp
@@ -38,9 +38,9 @@ TEST_F(KzComputationTest, initial)
const auto re_sample = ProcessedSample::make(mLayer, {});
const SliceStack& slices = re_sample.averageSlices();
- auto res_ref = SampleUtils::KzComputation::computeReducedKz(slices, k);
- auto res_ri = SampleUtils::KzComputation::computeKzFromRefIndices(slices, k);
- auto res_sld = SampleUtils::KzComputation::computeKzFromSLDs(slices, k.z());
+ auto res_ref = Compute::Kz::computeReducedKz(slices, k);
+ auto res_ri = Compute::Kz::computeKzFromRefIndices(slices, k);
+ auto res_sld = Compute::Kz::computeKzFromSLDs(slices, k.z());
EXPECT_EQ(res_ref.size(), res_sld.size());
EXPECT_EQ(res_ref.size(), res_ri.size());
@@ -79,9 +79,9 @@ TEST_F(KzComputationTest, negativeKz)
ProcessedSample sample = ProcessedSample::make(mLayer, options);
const SliceStack& slices = sample.averageSlices();
- auto res_ref = SampleUtils::KzComputation::computeReducedKz(slices, k);
- auto res_ri = SampleUtils::KzComputation::computeKzFromRefIndices(slices, k);
- auto res_sld = SampleUtils::KzComputation::computeKzFromSLDs(slices, k.z());
+ auto res_ref = Compute::Kz::computeReducedKz(slices, k);
+ auto res_ri = Compute::Kz::computeKzFromRefIndices(slices, k);
+ auto res_sld = Compute::Kz::computeKzFromSLDs(slices, k.z());
EXPECT_EQ(res_ref.size(), res_sld.size());
EXPECT_EQ(res_ref.size(), res_ri.size());
@@ -120,8 +120,8 @@ TEST_F(KzComputationTest, absorptiveAmbience)
ProcessedSample sample(ProcessedSample::make(mLayer, options));
const SliceStack& slices = sample.averageSlices();
- auto res_ri = SampleUtils::KzComputation::computeKzFromRefIndices(slices, k);
- auto res_sld = SampleUtils::KzComputation::computeKzFromSLDs(slices, k.z());
+ auto res_ri = Compute::Kz::computeKzFromRefIndices(slices, k);
+ auto res_sld = Compute::Kz::computeKzFromSLDs(slices, k.z());
EXPECT_EQ(res_ri.size(), res_sld.size());
for (size_t i = 0; i < res_ri.size(); ++i) {
@@ -141,8 +141,8 @@ TEST_F(KzComputationTest, TiNiSampleWithRoughness)
const auto re_sample = ProcessedSample::make(*sample, options);
const SliceStack& slices = re_sample.averageSlices();
- auto res_ri = SampleUtils::KzComputation::computeKzFromRefIndices(slices, k);
- auto res_sld = SampleUtils::KzComputation::computeKzFromSLDs(slices, k.z());
+ auto res_ri = Compute::Kz::computeKzFromRefIndices(slices, k);
+ auto res_sld = Compute::Kz::computeKzFromSLDs(slices, k.z());
EXPECT_EQ(res_ri.size(), res_sld.size());
for (size_t i = 0; i < res_ri.size(); ++i) {
diff --git a/Tests/UnitTests/Core/Fresnel/SpecularMagneticTest.cpp b/Tests/UnitTests/Core/Fresnel/SpecularMagneticTest.cpp
index f43f581b8a2..2982a51e203 100644
--- a/Tests/UnitTests/Core/Fresnel/SpecularMagneticTest.cpp
+++ b/Tests/UnitTests/Core/Fresnel/SpecularMagneticTest.cpp
@@ -62,9 +62,9 @@ void SpecularMagneticTest::testZeroField(const kvector_t& k, const ProcessedSamp
{
const SliceStack& slices = sample.averageSlices();
auto coeffs_scalar = std::make_unique<SpecularScalarTanhStrategy>()->Execute(
- slices, SampleUtils::KzComputation::computeKzFromRefIndices(slices, k));
+ slices, Compute::Kz::computeKzFromRefIndices(slices, k));
auto coeffs_zerofield = std::make_unique<Strategy>()->Execute(
- slices, SampleUtils::KzComputation::computeKzFromRefIndices(slices, k));
+ slices, Compute::Kz::computeKzFromRefIndices(slices, k));
EXPECT_EQ(coeffs_scalar.size(), coeffs_zerofield.size());
diff --git a/auto/Wrap/doxygenResample.i b/auto/Wrap/doxygenResample.i
index d9774d1b7bd..03bf4c76c2f 100644
--- a/auto/Wrap/doxygenResample.i
+++ b/auto/Wrap/doxygenResample.i
@@ -835,21 +835,8 @@ C++ includes: SSCAStrategy.h
// File: namespaceCompute.xml
-// File: namespaceCompute_1_1MagneticNevotCroceTransition.xml
-%feature("docstring") Compute::MagneticNevotCroceTransition::backwardsSubmatrices "std::pair< Eigen::Matrix2cd, Eigen::Matrix2cd > Compute::MagneticNevotCroceTransition::backwardsSubmatrices(const MatrixFlux &coeff_i, const MatrixFlux &coeff_i1, double sigma)
-";
-
-
-// File: namespaceCompute_1_1MagneticTanhTransition.xml
-%feature("docstring") Compute::MagneticTanhTransition::backwardsSubmatrices "std::pair< Eigen::Matrix2cd, Eigen::Matrix2cd > Compute::MagneticTanhTransition::backwardsSubmatrices(const MatrixFlux &coeff_i, const MatrixFlux &coeff_i1, double sigma)
-";
-
-
-// File: namespaceSampleUtils.xml
-
-
-// File: namespaceSampleUtils_1_1KzComputation.xml
-%feature("docstring") SampleUtils::KzComputation::computeReducedKz "std::vector< complex_t > SampleUtils::KzComputation::computeReducedKz(const SliceStack &slices, kvector_t k)
+// File: namespaceCompute_1_1Kz.xml
+%feature("docstring") Compute::Kz::computeReducedKz "std::vector< complex_t > Compute::Kz::computeReducedKz(const SliceStack &slices, kvector_t k)
Computes kz values from known k vector and slices with the following assumptions:
the beam penetrates fronting medium from a side
@@ -861,19 +848,29 @@ the incident angle is known for the sample surface
This function is used in GISAS and off-spec computations mainly for back-compatibility reasons and should be replaced with computeKzFromRefIndices.
";
-%feature("docstring") SampleUtils::KzComputation::computeKzFromSLDs "std::vector< complex_t > SampleUtils::KzComputation::computeKzFromSLDs(const SliceStack &slices, double kz)
+%feature("docstring") Compute::Kz::computeKzFromSLDs "std::vector< complex_t > Compute::Kz::computeKzFromSLDs(const SliceStack &slices, double kz)
Computes kz values from kz of the incoming beam known at a distant point in vacuum. It is assumed, that the beam penetrates fronting medium from a side.
";
-%feature("docstring") SampleUtils::KzComputation::computeKzFromRefIndices "std::vector< complex_t > SampleUtils::KzComputation::computeKzFromRefIndices(const SliceStack &slices, kvector_t k)
+%feature("docstring") Compute::Kz::computeKzFromRefIndices "std::vector< complex_t > Compute::Kz::computeKzFromRefIndices(const SliceStack &slices, kvector_t k)
Computes kz values from k-vector of the incoming beam known at a distant point in vacuum. It is assumed, that the beam penetrates fronting medium from a side.
";
-// File: namespaceSampleUtils_1_1Preprocessor.xml
-%feature("docstring") SampleUtils::Preprocessor::particleRegions "std::vector< ZLimits > SampleUtils::Preprocessor::particleRegions(const MultiLayer &multilayer, bool use_slicing)
+// File: namespaceCompute_1_1MagneticNevotCroceTransition.xml
+%feature("docstring") Compute::MagneticNevotCroceTransition::backwardsSubmatrices "std::pair< Eigen::Matrix2cd, Eigen::Matrix2cd > Compute::MagneticNevotCroceTransition::backwardsSubmatrices(const MatrixFlux &coeff_i, const MatrixFlux &coeff_i1, double sigma)
+";
+
+
+// File: namespaceCompute_1_1MagneticTanhTransition.xml
+%feature("docstring") Compute::MagneticTanhTransition::backwardsSubmatrices "std::pair< Eigen::Matrix2cd, Eigen::Matrix2cd > Compute::MagneticTanhTransition::backwardsSubmatrices(const MatrixFlux &coeff_i, const MatrixFlux &coeff_i1, double sigma)
+";
+
+
+// File: namespaceCompute_1_1Slicing.xml
+%feature("docstring") Compute::Slicing::particleRegions "std::vector< ZLimits > Compute::Slicing::particleRegions(const MultiLayer &multilayer, bool use_slicing)
Calculate z-admixtures occupied by particles.
";
--
GitLab