diff --git a/Core/Computation/MainComputation.cpp b/Core/Computation/MainComputation.cpp index 71c635437f33161094ef14a8089f67b7a7f5c3df..aa409694b141e9e44e46dca48701eea12717c206 100644 --- a/Core/Computation/MainComputation.cpp +++ b/Core/Computation/MainComputation.cpp @@ -17,15 +17,13 @@ #include "ParticleLayoutComputation.h" #include "Layer.h" #include "IFresnelMap.h" -#include "MatrixSpecularInfoMap.h" +#include "MatrixFresnelMap.h" #include "MultiLayer.h" #include "RoughMultiLayerComputation.h" #include "SpecularComputation.h" -#include "ScalarSpecularInfoMap.h" +#include "ScalarFresnelMap.h" #include "ProgressHandler.h" #include "SimulationElement.h" -#include "SpecularMagnetic.h" -#include "SpecularMatrix.h" #include <iterator> // needed for back_inserter MainComputation::MainComputation( @@ -101,7 +99,7 @@ IFresnelMap* MainComputation::createFresnelMap(const MultiLayer* p_multilayer, const MultiLayer* p_inverted_multilayer) { if (!p_multilayer->requiresMatrixRTCoefficients()) - return new ScalarSpecularInfoMap(p_multilayer); + return new ScalarFresnelMap(p_multilayer); else - return new MatrixSpecularInfoMap(p_multilayer, p_inverted_multilayer); + return new MatrixFresnelMap(p_multilayer, p_inverted_multilayer); } diff --git a/Core/Multilayer/MatrixSpecularInfoMap.cpp b/Core/Multilayer/MatrixFresnelMap.cpp similarity index 79% rename from Core/Multilayer/MatrixSpecularInfoMap.cpp rename to Core/Multilayer/MatrixFresnelMap.cpp index 1704d1a73e88176e6e3e495638e6a965c7f7e3fa..848f913051502b4fd404381310a38812a2864e6b 100644 --- a/Core/Multilayer/MatrixSpecularInfoMap.cpp +++ b/Core/Multilayer/MatrixFresnelMap.cpp @@ -2,8 +2,8 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Multilayer/MatrixSpecularInfoMap.cpp -//! @brief Implements class ScalarSpecularInfoMap. +//! @file Core/Multilayer/MatrixFresnelMap.cpp +//! @brief Implements class MatrixFresnelMap. //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) @@ -13,20 +13,20 @@ // // ************************************************************************** // -#include "MatrixSpecularInfoMap.h" +#include "MatrixFresnelMap.h" #include "ILayerRTCoefficients.h" #include "MatrixRTCoefficients.h" #include "MultiLayer.h" #include "SimulationElement.h" #include "SpecularMagnetic.h" -MatrixSpecularInfoMap::MatrixSpecularInfoMap(const MultiLayer* p_multilayer, +MatrixFresnelMap::MatrixFresnelMap(const MultiLayer* p_multilayer, const MultiLayer* p_inverted_multilayer) : mp_multilayer(p_multilayer) , mp_inverted_multilayer(p_inverted_multilayer) {} -const ILayerRTCoefficients* MatrixSpecularInfoMap::getOutCoefficients( +const ILayerRTCoefficients* MatrixFresnelMap::getOutCoefficients( const SimulationElement& sim_element, size_t layer_index) const { SpecularMagnetic::MultiLayerCoeff_t coeffs; @@ -34,7 +34,7 @@ const ILayerRTCoefficients* MatrixSpecularInfoMap::getOutCoefficients( return new MatrixRTCoefficients(coeffs[layer_index]); } -const ILayerRTCoefficients* MatrixSpecularInfoMap::getInCoefficients( +const ILayerRTCoefficients* MatrixFresnelMap::getInCoefficients( const SimulationElement& sim_element, size_t layer_index) const { SpecularMagnetic::MultiLayerCoeff_t coeffs; diff --git a/Core/Multilayer/MatrixSpecularInfoMap.h b/Core/Multilayer/MatrixFresnelMap.h similarity index 70% rename from Core/Multilayer/MatrixSpecularInfoMap.h rename to Core/Multilayer/MatrixFresnelMap.h index 9234f7e2faef98387d8f137b319cb6946df4cf5f..c3c8189c26cafe8e673b5727aadce5969da2d83e 100644 --- a/Core/Multilayer/MatrixSpecularInfoMap.h +++ b/Core/Multilayer/MatrixFresnelMap.h @@ -2,8 +2,8 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Multilayer/MatrixSpecularInfoMap.h -//! @brief Defines class MatrixSpecularInfoMap. +//! @file Core/Multilayer/MatrixFresnelMap.h +//! @brief Defines class MatrixFresnelMap. //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) @@ -13,8 +13,8 @@ // // ************************************************************************** // -#ifndef MATRIXSPECULARINFOMAP_H -#define MATRIXSPECULARINFOMAP_H +#ifndef MATRIXFRESNELMAP_H +#define MATRIXFRESNELMAP_H #include "IFresnelMap.h" #include <cstddef> @@ -23,14 +23,14 @@ class ILayerRTCoefficients; class MultiLayer; class SimulationElement; -//! Implementation of ISpecularInfoMap for matrix valued reflection/transmission coefficients. +//! Implementation of IFresnelMap for matrix valued reflection/transmission coefficients. //! @ingroup algorithms_internal -class BA_CORE_API_ MatrixSpecularInfoMap : public IFresnelMap +class BA_CORE_API_ MatrixFresnelMap : public IFresnelMap { public: - MatrixSpecularInfoMap(const MultiLayer* p_multilayer, const MultiLayer* p_inverted_multilayer); - ~MatrixSpecularInfoMap() final {} + MatrixFresnelMap(const MultiLayer* p_multilayer, const MultiLayer* p_inverted_multilayer); + ~MatrixFresnelMap() final {} //! Retrieves the amplitude coefficients for the given angles const ILayerRTCoefficients* getOutCoefficients( @@ -45,4 +45,4 @@ private: const MultiLayer* mp_inverted_multilayer; }; -#endif // MATRIXSPECULARINFOMAP_H +#endif // MATRIXFRESNELMAP_H diff --git a/Core/Multilayer/ScalarSpecularInfoMap.cpp b/Core/Multilayer/ScalarFresnelMap.cpp similarity index 73% rename from Core/Multilayer/ScalarSpecularInfoMap.cpp rename to Core/Multilayer/ScalarFresnelMap.cpp index 6afc54055f87be41fb2723ee3d340fc5d5ceecd7..8d4c3fcc2d83a48d9b89ae5738dae1966c499613 100644 --- a/Core/Multilayer/ScalarSpecularInfoMap.cpp +++ b/Core/Multilayer/ScalarFresnelMap.cpp @@ -2,8 +2,8 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Multilayer/ScalarSpecularInfoMap.cpp -//! @brief Implements class ScalarSpecularInfoMap. +//! @file Core/Multilayer/ScalarFresnelMap.cpp +//! @brief Implements class ScalarFresnelMap. //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) @@ -13,29 +13,29 @@ // // ************************************************************************** // -#include "ScalarSpecularInfoMap.h" +#include "ScalarFresnelMap.h" #include "MultiLayer.h" #include "ScalarRTCoefficients.h" #include "SimulationElement.h" #include "SpecularMatrix.h" -ScalarSpecularInfoMap::ScalarSpecularInfoMap(const MultiLayer* multilayer) +ScalarFresnelMap::ScalarFresnelMap(const MultiLayer* multilayer) : mp_multilayer(multilayer) {} -const ILayerRTCoefficients* ScalarSpecularInfoMap::getOutCoefficients( +const ILayerRTCoefficients* ScalarFresnelMap::getOutCoefficients( const SimulationElement& sim_element, size_t layer_index) const { return getCoefficients(-sim_element.getMeanKf(), layer_index); } -const ILayerRTCoefficients* ScalarSpecularInfoMap::getInCoefficients( +const ILayerRTCoefficients* ScalarFresnelMap::getInCoefficients( const SimulationElement& sim_element, size_t layer_index) const { return getCoefficients(sim_element.getKi(), layer_index); } -const ScalarRTCoefficients* ScalarSpecularInfoMap::getCoefficients( +const ScalarRTCoefficients* ScalarFresnelMap::getCoefficients( kvector_t kvec, size_t layer_index) const { SpecularMatrix::MultiLayerCoeff_t coeffs; diff --git a/Core/Multilayer/ScalarSpecularInfoMap.h b/Core/Multilayer/ScalarFresnelMap.h similarity index 73% rename from Core/Multilayer/ScalarSpecularInfoMap.h rename to Core/Multilayer/ScalarFresnelMap.h index 28f8eb42e72072d77ee25c544cc53dd7a4edf7f6..1a021daf3f37434c05ab8d10541932b09d461354 100644 --- a/Core/Multilayer/ScalarSpecularInfoMap.h +++ b/Core/Multilayer/ScalarFresnelMap.h @@ -2,8 +2,8 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Multilayer/ScalarSpecularInfoMap.h -//! @brief Defines class ScalarSpecularInfoMap. +//! @file Core/Multilayer/ScalarFresnelMap.h +//! @brief Defines class ScalarFresnelMap. //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) @@ -13,8 +13,8 @@ // // ************************************************************************** // -#ifndef SCALARSPECULARINFOMAP_H -#define SCALARSPECULARINFOMAP_H +#ifndef SCALARFRESNELMAP_H +#define SCALARFRESNELMAP_H #include "IFresnelMap.h" #include "Vectors3D.h" @@ -24,14 +24,14 @@ class ILayerRTCoefficients; class ScalarRTCoefficients; class SimulationElement; -//! Implementation of ISpecularInfoMap for scalar valued reflection/transmission coefficients. +//! Implementation of IFresnelMap for scalar valued reflection/transmission coefficients. //! @ingroup algorithms_internal -class BA_CORE_API_ ScalarSpecularInfoMap : public IFresnelMap +class BA_CORE_API_ ScalarFresnelMap : public IFresnelMap { public: - ScalarSpecularInfoMap(const MultiLayer* multilayer); - ~ScalarSpecularInfoMap() final {} + ScalarFresnelMap(const MultiLayer* multilayer); + ~ScalarFresnelMap() final {} //! Retrieves the amplitude coefficients for the given angles const ILayerRTCoefficients* getOutCoefficients ( @@ -46,4 +46,4 @@ private: const ScalarRTCoefficients* getCoefficients(kvector_t kvec, size_t layer_index) const; }; -#endif // SCALARSPECULARINFOMAP_H +#endif // SCALARFRESNELMAP_H diff --git a/auto/Wrap/doxygen_core.i b/auto/Wrap/doxygen_core.i index 3e5daba6547827b9d487627dcde39bf950b481ea..6d4a76e90ab2b5c22e8d51c8c428d65252a2cf7a 100644 --- a/auto/Wrap/doxygen_core.i +++ b/auto/Wrap/doxygen_core.i @@ -6264,7 +6264,7 @@ Returns the (approximate in some cases) radial size of the particle of this form // File: classIFresnelMap.xml %feature("docstring") IFresnelMap " -Holds the necessary information to calculate the radiation wavefunction in a specific layer for different incoming (outgoing) angles of the beam in the top layer (these amplitudes correspond to the specular part of the wavefunction). +Holds the necessary information to calculate the radiation wavefunction in every layer for different incoming (outgoing) angles of the beam in the top layer (these amplitudes correspond to the specular part of the wavefunction). C++ includes: IFresnelMap.h "; @@ -9335,6 +9335,31 @@ C++ includes: MainComputation.h "; +// File: classMatrixFresnelMap.xml +%feature("docstring") MatrixFresnelMap " + +Implementation of IFresnelMap for matrix valued reflection/transmission coefficients. + +C++ includes: MatrixFresnelMap.h +"; + +%feature("docstring") MatrixFresnelMap::MatrixFresnelMap "MatrixFresnelMap::MatrixFresnelMap(const MultiLayer *p_multilayer, const MultiLayer *p_inverted_multilayer) +"; + +%feature("docstring") MatrixFresnelMap::~MatrixFresnelMap "MatrixFresnelMap::~MatrixFresnelMap() final +"; + +%feature("docstring") MatrixFresnelMap::getOutCoefficients "const ILayerRTCoefficients * MatrixFresnelMap::getOutCoefficients(const SimulationElement &sim_element, size_t layer_index) const finaloverride + +Retrieves the amplitude coefficients for the given angles. +"; + +%feature("docstring") MatrixFresnelMap::getInCoefficients "const ILayerRTCoefficients * MatrixFresnelMap::getInCoefficients(const SimulationElement &sim_element, size_t layer_index) const finaloverride + +Retrieves the amplitude coefficients for the given angles. +"; + + // File: classMatrixRTCoefficients.xml %feature("docstring") MatrixRTCoefficients " @@ -9384,31 +9409,6 @@ Returns z-part of the two wavevector eigenmodes. "; -// File: classMatrixSpecularInfoMap.xml -%feature("docstring") MatrixSpecularInfoMap " - -Implementation of ISpecularInfoMap for matrix valued reflection/transmission coefficients. - -C++ includes: MatrixSpecularInfoMap.h -"; - -%feature("docstring") MatrixSpecularInfoMap::MatrixSpecularInfoMap "MatrixSpecularInfoMap::MatrixSpecularInfoMap(const MultiLayer *p_multilayer, const MultiLayer *p_inverted_multilayer) -"; - -%feature("docstring") MatrixSpecularInfoMap::~MatrixSpecularInfoMap "MatrixSpecularInfoMap::~MatrixSpecularInfoMap() final -"; - -%feature("docstring") MatrixSpecularInfoMap::getOutCoefficients "const ILayerRTCoefficients * MatrixSpecularInfoMap::getOutCoefficients(const SimulationElement &sim_element, size_t layer_index) const finaloverride - -Retrieves the amplitude coefficients for the given angles. -"; - -%feature("docstring") MatrixSpecularInfoMap::getInCoefficients "const ILayerRTCoefficients * MatrixSpecularInfoMap::getInCoefficients(const SimulationElement &sim_element, size_t layer_index) const finaloverride - -Retrieves the amplitude coefficients for the given angles. -"; - - // File: classMesoCrystal.xml %feature("docstring") MesoCrystal " @@ -11866,6 +11866,31 @@ C++ includes: SampleTreeIterator.h "; +// File: classScalarFresnelMap.xml +%feature("docstring") ScalarFresnelMap " + +Implementation of IFresnelMap for scalar valued reflection/transmission coefficients. + +C++ includes: ScalarFresnelMap.h +"; + +%feature("docstring") ScalarFresnelMap::ScalarFresnelMap "ScalarFresnelMap::ScalarFresnelMap(const MultiLayer *multilayer) +"; + +%feature("docstring") ScalarFresnelMap::~ScalarFresnelMap "ScalarFresnelMap::~ScalarFresnelMap() final +"; + +%feature("docstring") ScalarFresnelMap::getOutCoefficients "const ILayerRTCoefficients * ScalarFresnelMap::getOutCoefficients(const SimulationElement &sim_element, size_t layer_index) const finaloverride + +Retrieves the amplitude coefficients for the given angles. +"; + +%feature("docstring") ScalarFresnelMap::getInCoefficients "const ILayerRTCoefficients * ScalarFresnelMap::getInCoefficients(const SimulationElement &sim_element, size_t layer_index) const finaloverride + +Retrieves the amplitude coefficients for the given angles. +"; + + // File: classScalarRTCoefficients.xml %feature("docstring") ScalarRTCoefficients " @@ -11926,31 +11951,6 @@ Scalar value getters; these throw errors by default as they should only be used "; -// File: classScalarSpecularInfoMap.xml -%feature("docstring") ScalarSpecularInfoMap " - -Implementation of ISpecularInfoMap for scalar valued reflection/transmission coefficients. - -C++ includes: ScalarSpecularInfoMap.h -"; - -%feature("docstring") ScalarSpecularInfoMap::ScalarSpecularInfoMap "ScalarSpecularInfoMap::ScalarSpecularInfoMap(const MultiLayer *multilayer) -"; - -%feature("docstring") ScalarSpecularInfoMap::~ScalarSpecularInfoMap "ScalarSpecularInfoMap::~ScalarSpecularInfoMap() final -"; - -%feature("docstring") ScalarSpecularInfoMap::getOutCoefficients "const ILayerRTCoefficients * ScalarSpecularInfoMap::getOutCoefficients(const SimulationElement &sim_element, size_t layer_index) const finaloverride - -Retrieves the amplitude coefficients for the given angles. -"; - -%feature("docstring") ScalarSpecularInfoMap::getInCoefficients "const ILayerRTCoefficients * ScalarSpecularInfoMap::getInCoefficients(const SimulationElement &sim_element, size_t layer_index) const finaloverride - -Retrieves the amplitude coefficients for the given angles. -"; - - // File: classExceptions_1_1SelfReferenceException.xml %feature("docstring") Exceptions::SelfReferenceException ""; @@ -14647,16 +14647,16 @@ make Swappable // File: LayerStrategyBuilder_8h.xml -// File: MatrixRTCoefficients_8cpp.xml +// File: MatrixFresnelMap_8cpp.xml -// File: MatrixRTCoefficients_8h.xml +// File: MatrixFresnelMap_8h.xml -// File: MatrixSpecularInfoMap_8cpp.xml +// File: MatrixRTCoefficients_8cpp.xml -// File: MatrixSpecularInfoMap_8h.xml +// File: MatrixRTCoefficients_8h.xml // File: MultiLayer_8cpp.xml @@ -14665,13 +14665,13 @@ make Swappable // File: MultiLayer_8h.xml -// File: ScalarRTCoefficients_8h.xml +// File: ScalarFresnelMap_8cpp.xml -// File: ScalarSpecularInfoMap_8cpp.xml +// File: ScalarFresnelMap_8h.xml -// File: ScalarSpecularInfoMap_8h.xml +// File: ScalarRTCoefficients_8h.xml // File: SpecularMagnetic_8cpp.xml diff --git a/unused/MatrixSpecularInfoMapTest.h b/unused/MatrixSpecularInfoMapTest.h index 6353f79822953b0a0308e45a52f4d6891df59257..61fb53e3f867bc8cc980fd6992ac2bff7fe36429 100644 --- a/unused/MatrixSpecularInfoMapTest.h +++ b/unused/MatrixSpecularInfoMapTest.h @@ -4,7 +4,7 @@ #include "HomogeneousMaterial.h" #include "Layer.h" #include "MatrixRTCoefficients.h" -#include "MatrixSpecularInfoMap.h" +#include "MatrixFresnelMap.h" #include "MultiLayer.h" #include "MathConstants.h" #include "SimulationElement.h"