diff --git a/auto/Wrap/doxygenCore.i b/auto/Wrap/doxygenCore.i index 91ef8e787eef26934fc9ece52df19928a3b259fe..44d66e3057645a0a795b8c51cf9e50dc5aec9b9a 100644 --- a/auto/Wrap/doxygenCore.i +++ b/auto/Wrap/doxygenCore.i @@ -445,10 +445,10 @@ C++ includes: DWBASingleComputation.h %feature("docstring") DWBASingleComputation::~DWBASingleComputation "DWBASingleComputation::~DWBASingleComputation() "; -%feature("docstring") DWBASingleComputation::setProgressHandler "void DWBASingleComputation::setProgressHandler(ProgressHandler *p_progress) +%feature("docstring") DWBASingleComputation::setProgressHandler "void DWBASingleComputation::setProgressHandler(ProgressHandler *progress) "; -%feature("docstring") DWBASingleComputation::compute "void DWBASingleComputation::compute(SimulationElement &elem) const +%feature("docstring") DWBASingleComputation::compute "void DWBASingleComputation::compute(SimulationElement &ele) const "; @@ -818,7 +818,7 @@ C++ includes: GISASSpecularComputation.h %feature("docstring") GISASSpecularComputation::GISASSpecularComputation "GISASSpecularComputation::GISASSpecularComputation(const IFresnelMap *p_fresnel_map) "; -%feature("docstring") GISASSpecularComputation::compute "void GISASSpecularComputation::compute(SimulationElement &elem) const +%feature("docstring") GISASSpecularComputation::compute "void GISASSpecularComputation::compute(SimulationElement &ele) const "; @@ -1520,7 +1520,7 @@ C++ includes: ParticleLayoutComputation.h %feature("docstring") ParticleLayoutComputation::~ParticleLayoutComputation "ParticleLayoutComputation::~ParticleLayoutComputation() "; -%feature("docstring") ParticleLayoutComputation::compute "void ParticleLayoutComputation::compute(SimulationElement &elem) const +%feature("docstring") ParticleLayoutComputation::compute "void ParticleLayoutComputation::compute(SimulationElement &ele) const "; @@ -1821,7 +1821,7 @@ C++ includes: RoughMultiLayerComputation.h %feature("docstring") RoughMultiLayerComputation::RoughMultiLayerComputation "RoughMultiLayerComputation::RoughMultiLayerComputation(const ProcessedSample *p_sample) "; -%feature("docstring") RoughMultiLayerComputation::compute "void RoughMultiLayerComputation::compute(SimulationElement &elem) const +%feature("docstring") RoughMultiLayerComputation::compute "void RoughMultiLayerComputation::compute(SimulationElement &ele) const "; @@ -2026,7 +2026,7 @@ C++ includes: SpecularComputationTerm.h %feature("docstring") SpecularComputationTerm::setProgressHandler "void SpecularComputationTerm::setProgressHandler(ProgressHandler *p_progress) "; -%feature("docstring") SpecularComputationTerm::computeIntensity "void SpecularComputationTerm::computeIntensity(SpecularSimulationElement &elem, const SliceStack &slices) const +%feature("docstring") SpecularComputationTerm::computeIntensity "void SpecularComputationTerm::computeIntensity(SpecularSimulationElement &ele, const SliceStack &slices) const "; @@ -2191,6 +2191,9 @@ C++ includes: VarianceFunctions.h "; +// File: namespace_0d11.xml + + // File: namespace_0d17.xml diff --git a/auto/Wrap/doxygenResample.i b/auto/Wrap/doxygenResample.i index 1baa153419b9f509c98a9058e5fe450692cf08a8..776598f9118519c2e3fb0734d0bb42adf939b61d 100644 --- a/auto/Wrap/doxygenResample.i +++ b/auto/Wrap/doxygenResample.i @@ -9,7 +9,7 @@ Information about particle form factor and abundance. C++ includes: FFSum.h "; -%feature("docstring") CoherentFFSum::CoherentFFSum "CoherentFFSum::CoherentFFSum(double abundance, const std::vector< CoherentFFTerm > &parts) +%feature("docstring") CoherentFFSum::CoherentFFSum "CoherentFFSum::CoherentFFSum(double abundance, const std::vector< CoherentFFTerm > &terms) "; %feature("docstring") CoherentFFSum::summedFF "complex_t CoherentFFSum::summedFF(const SimulationElement &sim_element) const @@ -21,9 +21,6 @@ C++ includes: FFSum.h %feature("docstring") CoherentFFSum::relativeAbundance "double CoherentFFSum::relativeAbundance() const "; -%feature("docstring") CoherentFFSum::scaleRelativeAbundance "void CoherentFFSum::scaleRelativeAbundance(double total_abundance) -"; - %feature("docstring") CoherentFFSum::radialExtension "double CoherentFFSum::radialExtension() const "; @@ -36,7 +33,7 @@ Infrastructure to compute the scattering from a given particle in a given layer. C++ includes: FFTerm.h "; -%feature("docstring") CoherentFFTerm::CoherentFFTerm "CoherentFFTerm::CoherentFFTerm(IComputeFF *ff, size_t layer_index) +%feature("docstring") CoherentFFTerm::CoherentFFTerm "CoherentFFTerm::CoherentFFTerm(IComputeFF *computer) "; %feature("docstring") CoherentFFTerm::CoherentFFTerm "CoherentFFTerm::CoherentFFTerm(const CoherentFFTerm &other) @@ -63,7 +60,7 @@ Provides scalar form factor evaluation in Born Approximation for given IFormFact C++ includes: ComputeBA.h "; -%feature("docstring") ComputeBA::ComputeBA "ComputeBA::ComputeBA(const IFormFactor &ff) +%feature("docstring") ComputeBA::ComputeBA "ComputeBA::ComputeBA(const IFormFactor &ff, size_t i_layer) "; %feature("docstring") ComputeBA::~ComputeBA "ComputeBA::~ComputeBA() override @@ -72,7 +69,7 @@ C++ includes: ComputeBA.h %feature("docstring") ComputeBA::clone "ComputeBA * ComputeBA::clone() const override "; -%feature("docstring") ComputeBA::computeFF "complex_t ComputeBA::computeFF(const WavevectorInfo &wavevectors) const override +%feature("docstring") ComputeBA::computeFF "complex_t ComputeBA::computeFF(const WavevectorInfo &wavevectors, const std::unique_ptr< const IFlux > &inFlux, const std::unique_ptr< const IFlux > &outFlux) const override Calculates and returns a form factor calculation in BA. "; @@ -86,7 +83,7 @@ Provides polarized form factor evaluation in Born Approximation for given IFormF C++ includes: ComputeBAPol.h "; -%feature("docstring") ComputeBAPol::ComputeBAPol "ComputeBAPol::ComputeBAPol(const IFormFactor &ff) +%feature("docstring") ComputeBAPol::ComputeBAPol "ComputeBAPol::ComputeBAPol(const IFormFactor &ff, size_t i_layer) "; %feature("docstring") ComputeBAPol::~ComputeBAPol "ComputeBAPol::~ComputeBAPol() override @@ -95,12 +92,7 @@ C++ includes: ComputeBAPol.h %feature("docstring") ComputeBAPol::clone "ComputeBAPol * ComputeBAPol::clone() const override "; -%feature("docstring") ComputeBAPol::computeFF "complex_t ComputeBAPol::computeFF(const WavevectorInfo &wavevectors) const override - -Throws not-implemented exception. -"; - -%feature("docstring") ComputeBAPol::computePolFF "Eigen::Matrix2cd ComputeBAPol::computePolFF(const WavevectorInfo &wavevectors) const override +%feature("docstring") ComputeBAPol::computePolFF "Eigen::Matrix2cd ComputeBAPol::computePolFF(const WavevectorInfo &wavevectors, const std::unique_ptr< const IFlux > &, const std::unique_ptr< const IFlux > &) const override Calculates and returns a polarized form factor calculation in BA. "; @@ -114,7 +106,7 @@ Provides scalar DWBA computation for given IFormFactor. C++ includes: ComputeDWBA.h "; -%feature("docstring") ComputeDWBA::ComputeDWBA "ComputeDWBA::ComputeDWBA(const IFormFactor &ff) +%feature("docstring") ComputeDWBA::ComputeDWBA "ComputeDWBA::ComputeDWBA(const IFormFactor &ff, size_t i_layer) "; %feature("docstring") ComputeDWBA::~ComputeDWBA "ComputeDWBA::~ComputeDWBA() override @@ -123,16 +115,11 @@ C++ includes: ComputeDWBA.h %feature("docstring") ComputeDWBA::clone "ComputeDWBA * ComputeDWBA::clone() const override "; -%feature("docstring") ComputeDWBA::computeFF "complex_t ComputeDWBA::computeFF(const WavevectorInfo &wavevectors) const override +%feature("docstring") ComputeDWBA::computeFF "complex_t ComputeDWBA::computeFF(const WavevectorInfo &wavevectors, const std::unique_ptr< const IFlux > &inFlux, const std::unique_ptr< const IFlux > &outFlux) const override Returns the coherent sum of the four DWBA terms for scalar scattering. "; -%feature("docstring") ComputeDWBA::setFlux "void ComputeDWBA::setFlux(std::unique_ptr< const IFlux > inFlux, std::unique_ptr< const IFlux > outFlux) override - -Sets reflection/transmission info. -"; - // File: classComputeDWBAPol.xml %feature("docstring") ComputeDWBAPol " @@ -142,7 +129,7 @@ Provides polarized DWBA computation for given IFormFactor. C++ includes: ComputeDWBAPol.h "; -%feature("docstring") ComputeDWBAPol::ComputeDWBAPol "ComputeDWBAPol::ComputeDWBAPol(const IFormFactor &ff) +%feature("docstring") ComputeDWBAPol::ComputeDWBAPol "ComputeDWBAPol::ComputeDWBAPol(const IFormFactor &ff, size_t i_layer) "; %feature("docstring") ComputeDWBAPol::~ComputeDWBAPol "ComputeDWBAPol::~ComputeDWBAPol() override @@ -151,21 +138,11 @@ C++ includes: ComputeDWBAPol.h %feature("docstring") ComputeDWBAPol::clone "ComputeDWBAPol * ComputeDWBAPol::clone() const override "; -%feature("docstring") ComputeDWBAPol::computeFF "complex_t ComputeDWBAPol::computeFF(const WavevectorInfo &wavevectors) const override - -Throws not-implemented exception. -"; - -%feature("docstring") ComputeDWBAPol::computePolFF "Eigen::Matrix2cd ComputeDWBAPol::computePolFF(const WavevectorInfo &wavevectors) const override +%feature("docstring") ComputeDWBAPol::computePolFF "Eigen::Matrix2cd ComputeDWBAPol::computePolFF(const WavevectorInfo &wavevectors, const std::unique_ptr< const IFlux > &inFlux, const std::unique_ptr< const IFlux > &outFlux) const override Returns the coherent sum of the four DWBA terms for polarized scattering. "; -%feature("docstring") ComputeDWBAPol::setFlux "void ComputeDWBAPol::setFlux(std::unique_ptr< const IFlux > inFlux, std::unique_ptr< const IFlux > outFlux) override - -Sets reflection/transmission info. -"; - // File: classDecouplingApproximationStrategy.xml %feature("docstring") DecouplingApproximationStrategy " @@ -201,7 +178,7 @@ C++ includes: IComputeFF.h %feature("docstring") IComputeFF::clone "virtual IComputeFF* IComputeFF::clone() const =0 "; -%feature("docstring") IComputeFF::setAmbientMaterial "void IComputeFF::setAmbientMaterial(const Material &material) +%feature("docstring") IComputeFF::iLayer "size_t IComputeFF::iLayer() const "; %feature("docstring") IComputeFF::volume "double IComputeFF::volume() const @@ -216,17 +193,36 @@ C++ includes: IComputeFF.h %feature("docstring") IComputeFF::topZ "double IComputeFF::topZ(const IRotation &rotation) const "; -%feature("docstring") IComputeFF::computeFF "virtual complex_t IComputeFF::computeFF(const WavevectorInfo &wavevectors) const =0 + +// File: classIComputePol.xml +%feature("docstring") IComputePol " + +Provides polarized form factor evaluation for given IFormFactor. Inherited by ComputeBAPol and ComputeDWBAPol. + +C++ includes: IComputePol.h "; -%feature("docstring") IComputeFF::computePolFF "Eigen::Matrix2cd IComputeFF::computePolFF(const WavevectorInfo &wavevectors) const +%feature("docstring") IComputePol::coherentPolFF "Eigen::Matrix2cd IComputePol::coherentPolFF(const SimulationElement &sim_element) const +"; + +%feature("docstring") IComputePol::computePolFF "virtual Eigen::Matrix2cd IComputePol::computePolFF(const WavevectorInfo &wavevectors, const std::unique_ptr< const IFlux > &inFlux, const std::unique_ptr< const IFlux > &outFlux) const =0 Returns scattering amplitude for matrix interactions. "; -%feature("docstring") IComputeFF::setFlux "void IComputeFF::setFlux(std::unique_ptr< const IFlux >, std::unique_ptr< const IFlux >) -Sets reflection/transmission info. +// File: classIComputeScalar.xml +%feature("docstring") IComputeScalar " + +Provides scalar form factor evaluation for given IFormFactor. Inherited by ComputeBA and ComputeDWBA. + +C++ includes: IComputeScalar.h +"; + +%feature("docstring") IComputeScalar::computeFF "virtual complex_t IComputeScalar::computeFF(const WavevectorInfo &wavevectors, const std::unique_ptr< const IFlux > &inFlux, const std::unique_ptr< const IFlux > &outFlux) const =0 +"; + +%feature("docstring") IComputeScalar::coherentFF "complex_t IComputeScalar::coherentFF(const SimulationElement &sim_element) const "; @@ -299,12 +295,12 @@ C++ includes: IFresnelMap.h %feature("docstring") IFresnelMap::~IFresnelMap "IFresnelMap::~IFresnelMap() "; -%feature("docstring") IFresnelMap::getInFlux "virtual std::unique_ptr<const IFlux> IFresnelMap::getInFlux(const kvector_t &kvec, size_t layer_index) const =0 +%feature("docstring") IFresnelMap::getInFlux "virtual std::unique_ptr<const IFlux> IFresnelMap::getInFlux(const kvector_t &kvec, size_t i_layer) const =0 Retrieves the amplitude coefficients for given wavevector and layer. "; -%feature("docstring") IFresnelMap::getOutFlux "virtual std::unique_ptr<const IFlux> IFresnelMap::getOutFlux(const kvector_t &kvec, size_t layer_index) const =0 +%feature("docstring") IFresnelMap::getOutFlux "virtual std::unique_ptr<const IFlux> IFresnelMap::getOutFlux(const kvector_t &kvec, size_t i_layer) const =0 Retrieves the amplitude coefficients for a (time-reversed) outgoing wavevector. "; @@ -819,6 +815,9 @@ C++ includes: SlicedFormFactorList.h %feature("docstring") SlicedFormFactorList::size "size_t SlicedFormFactorList::size() const "; +%feature("docstring") SlicedFormFactorList::getPair "std::pair< const IFormFactor *, size_t > SlicedFormFactorList::getPair(size_t index) const +"; + %feature("docstring") SlicedFormFactorList::regionMap "const std::map< size_t, std::vector< HomogeneousRegion > > & SlicedFormFactorList::regionMap() const "; @@ -960,40 +959,40 @@ C++ includes: SSCAStrategy.h // File: namespace_0d10.xml -// File: namespace_0d15.xml - +// File: namespace_0d19.xml -// File: namespace_0d33.xml - -// File: namespace_0d35.xml +// File: namespace_0d37.xml // File: namespace_0d39.xml -// File: namespace_0d41.xml +// File: namespace_0d43.xml -// File: namespace_0d43.xml +// File: namespace_0d45.xml // File: namespace_0d47.xml -// File: namespace_0d52.xml +// File: namespace_0d51.xml -// File: namespace_0d54.xml +// File: namespace_0d56.xml -// File: namespace_0d56.xml +// File: namespace_0d58.xml // File: namespace_0d60.xml -// File: namespace_0d62.xml +// File: namespace_0d64.xml + + +// File: namespace_0d66.xml // File: namespaceSampleUtils.xml @@ -1088,6 +1087,18 @@ Get default z limits for generating a material profile. // File: IComputeFF_8h.xml +// File: IComputePol_8cpp.xml + + +// File: IComputePol_8h.xml + + +// File: IComputeScalar_8cpp.xml + + +// File: IComputeScalar_8h.xml + + // File: IFlux_8h.xml