Description

Specular reflectometry simulation.

Holds an instrument and sample model. Computes detected intensity as function of the glancing angles alpha_i=alpha_f.

Definition at line 33 of file SpecularSimulation.h.

Inheritance diagram for SpecularSimulation:

Collaboration diagram for SpecularSimulation:

Public Member Functions
	SpecularSimulation (const ISpecularScan &scan, const MultiLayer &sample)

	SpecularSimulation (SpecularSimulation &&)

	~SpecularSimulation () override

void	addParameterDistribution (const ParameterDistribution &par_distr)

void	addParameterDistribution (ParameterDistribution::WhichParameter whichParameter, const IDistribution1D &distribution, size_t nbr_samples, double sigma_factor=0.0, const RealLimits &limits=RealLimits())

const IBackground *	background () const

void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...

std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...

ICoordSystem *	createCoordSystem () const override

bool	force_polarized () const override
	Force polarized computation even in absence of sample magnetization or external fields. More...

const std::vector< ParameterDistribution > &	getDistributions () const

size_t	intensityMapSize () const override
	Returns the total number of the intensity values in the simulation result. More...

std::vector< const INode * >	nodeChildren () const override
	Returns all children. More...

std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...

SimulationOptions &	options ()

const SimulationOptions &	options () const

virtual std::vector< ParaMeta >	parDefs () const
	Returns the parameter definitions, to be hard-coded in each leaf class. More...

void	prepareSimulation () override
	Put into a clean state for running a simulation. More...

const MultiLayer *	sample () const

const ISpecularScan *	scan () const
	Returns internal data handler. More...

void	setBackground (const IBackground &bg)

void	setTerminalProgressMonitor ()
	Initializes a progress monitor that prints to stdout. More...

SimulationResult	simulate ()
	Run a simulation, and return the result. More...

void	subscribe (const std::function< bool(size_t)> &inform)

std::string	unitOfParameter (ParameterDistribution::WhichParameter which) const

Protected Member Functions
virtual void	initDistributionHandler ()

ProgressHandler &	progress ()

virtual void	updateIntensityMap ()

Protected Attributes
DistributionHandler	m_distribution_handler

std::vector< double >	m_P

Private Member Functions
void	addBackgroundIntensity (size_t start_ind, size_t n_elements) override

void	addDataToCache (double weight) override

void	checkCache () const

std::unique_ptr< IComputation >	createComputation (const reSample &re_sample, size_t start, size_t n_elements) override
	Generate a single threaded computation for a given range of simulation elements. More...

void	initElementVector () override
	Initializes the vector of ISimulation elements. More...

void	moveDataFromCache () override

void	normalize (size_t start_ind, size_t n_elements) override
	Normalize the detector counts to beam intensity, to solid angle, and to exposure angle. More...

size_t	numberOfElements () const override
	Gets the number of elements this simulation needs to calculate. More...

SimulationResult	pack_result () override
	Sets m_result. More...

void	runSingleSimulation (const reSample &re_sample, size_t batch_start, size_t batch_size, double weight=1.0)
	Runs a single simulation with fixed parameter values. If desired, the simulation is run in several threads. More...

void	validateParametrization (const ParameterDistribution &par_distr) const override
	Checks the distribution validity for simulation. More...

Private Attributes
std::shared_ptr< IBackground >	m_background

std::vector< double >	m_cache

std::vector< SpecularElement >	m_eles

std::shared_ptr< SimulationOptions >	m_options

std::shared_ptr< ProgressHandler >	m_progress

std::shared_ptr< MultiLayer >	m_sample

std::unique_ptr< const ISpecularScan >	m_scan

Constructor & Destructor Documentation

◆ SpecularSimulation() [1/2]

SpecularSimulation::SpecularSimulation	(	const ISpecularScan &	scan,
		const MultiLayer &	sample
	)

Definition at line 33 of file SpecularSimulation.cpp.

     : ISimulation(sample)
     , m_scan(scan.clone())
 {
     // TODO: move inside AlphaScan when pointwise resolution is implemented
     if (scan.coordinateAxis()->min() < 0.0)
         throw std::runtime_error("Invalid scan: minimum value on coordinate axis is negative");
 }

References ISpecularScan::coordinateAxis(), IAxis::min(), and scan().

Here is the call graph for this function:

◆ ~SpecularSimulation()

SpecularSimulation::~SpecularSimulation ( )

overridedefault

◆ SpecularSimulation() [2/2]

SpecularSimulation::SpecularSimulation ( SpecularSimulation && )

default

Member Function Documentation

◆ addBackgroundIntensity()

void SpecularSimulation::addBackgroundIntensity	(	size_t	start_ind,
		size_t	n_elements
	)

overrideprivatevirtual

Implements ISimulation.

Definition at line 115 of file SpecularSimulation.cpp.

 {
     if (!background())
         return;
     for (size_t i = start_ind, stop_point = start_ind + n_elements; i < stop_point; ++i) {
         auto& element = m_eles[i];
         element.setIntensity(background()->addBackground(element.intensity()));
     }
 }

References ISimulation::background(), and m_eles.

Here is the call graph for this function:

◆ addDataToCache()

void SpecularSimulation::addDataToCache ( double weight )

overrideprivatevirtual

Implements ISimulation.

Definition at line 125 of file SpecularSimulation.cpp.

 {
     checkCache();
     for (size_t i = 0, size = m_eles.size(); i < size; ++i)
         m_cache[i] += m_eles[i].intensity() * weight;
 }

References checkCache(), m_cache, and m_eles.

Here is the call graph for this function:

◆ addParameterDistribution() [1/2]

void ISimulation::addParameterDistribution ( const ParameterDistribution & par_distr )

inherited

Definition at line 231 of file ISimulation.cpp.

 {
     validateParametrization(par_distr);
     m_distribution_handler.addParameterDistribution(par_distr);
 }

References DistributionHandler::addParameterDistribution(), ISimulation::m_distribution_handler, and ISimulation::validateParametrization().

Here is the call graph for this function:

◆ addParameterDistribution() [2/2]

void ISimulation::addParameterDistribution	(	ParameterDistribution::WhichParameter	whichParameter,
		const IDistribution1D &	distribution,
		size_t	nbr_samples,
		double	sigma_factor = `0.0`,
		const RealLimits &	limits = `RealLimits()`
	)

inherited

Definition at line 222 of file ISimulation.cpp.

 {
     ParameterDistribution par_distr(whichParameter, distribution, nbr_samples, sigma_factor,
                                     limits);
     addParameterDistribution(par_distr);
 }

◆ background()

const IBackground* ISimulation::background ( ) const

inlineinherited

Definition at line 76 of file ISimulation.h.

76 { return m_background.get(); }

ISimulation::m_background

std::shared_ptr< IBackground > m_background

Definition: ISimulation.h:137

References ISimulation::m_background.

Referenced by DepthProbeSimulation::addBackgroundIntensity(), ISimulation2D::addBackgroundIntensity(), and addBackgroundIntensity().

◆ checkCache()

void SpecularSimulation::checkCache ( ) const

private

Definition at line 88 of file SpecularSimulation.cpp.

 {
     ASSERT(m_eles.size() == m_cache.size());
 }

References ASSERT, m_cache, and m_eles.

Referenced by addDataToCache(), and moveDataFromCache().

◆ checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

 {
     size_t nP = m_P.size();
     if (parDefs().size() != nP) {
         std::cerr << "BUG in class " << className() << std::endl;
         std::cerr << "#m_P = " << nP << std::endl;
         std::cerr << "#PDf = " << parDefs().size() << std::endl;
         for (const ParaMeta& pm : parDefs())
             std::cerr << "  PDf: " << pm.name << std::endl;
         ASSERT(0);
     }
     ASSERT(parDefs().size() == nP);
     for (size_t i = 0; i < nP; ++i) {
         const ParaMeta pm = parDefs()[i];
  
         RealLimits limits = RealLimits::limitless();
         if (pm.vMin == -INF) {
             ASSERT(pm.vMax == +INF);
             // nothing to do
         } else if (pm.vMax == +INF) {
             ASSERT(pm.vMin == 0);
             limits = RealLimits::nonnegative();
         } else {
             limits = RealLimits::limited(pm.vMin, pm.vMax);
         }
         limits.check(pm.name, m_P[i]);
     }
 }

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

◆ className()

std::string SpecularSimulation::className ( ) const

inlinefinalvirtual

Returns the class name, to be hard-coded in each leaf class that inherits from INode.

Implements INode.

Definition at line 39 of file SpecularSimulation.h.

39 { return "SpecularSimulation"; }

◆ createComputation()

std::unique_ptr< IComputation > SpecularSimulation::createComputation	(	const reSample &	re_sample,
		size_t	start,
		size_t	n_elements
	)

overrideprivatevirtual

Generate a single threaded computation for a given range of simulation elements.

Parameters

re_sample	Preprocessed version of our sample
start	Index of the first element to include into computation
n_elements	Number of elements to process

Implements ISimulation.

Definition at line 79 of file SpecularSimulation.cpp.

 {
     ASSERT(start < m_eles.size() && start + n_elements <= m_eles.size());
     const auto& begin = m_eles.begin() + static_cast<long>(start);
     return std::make_unique<SpecularComputation>(re_sample, options(), progress(), begin,
                                                  begin + static_cast<long>(n_elements));
 }

References ASSERT, m_eles, ISimulation::options(), and ISimulation::progress().

Here is the call graph for this function:

◆ createCoordSystem()

ICoordSystem * SpecularSimulation::createCoordSystem ( ) const

overridevirtual

Implements ISimulation.

Definition at line 64 of file SpecularSimulation.cpp.

 {
     return m_scan->createCoordSystem();
 }

References m_scan.

Referenced by pack_result().

◆ force_polarized()

bool SpecularSimulation::force_polarized ( ) const

overridevirtual

Force polarized computation even in absence of sample magnetization or external fields.

Implements ISimulation.

Definition at line 140 of file SpecularSimulation.cpp.

 {
     return m_scan->polarized();
 }

References m_scan.

◆ getDistributions()

const std::vector< ParameterDistribution > & ISimulation::getDistributions ( ) const

inherited

Definition at line 237 of file ISimulation.cpp.

 {
     return m_distribution_handler.getDistributions();
 }

References DistributionHandler::getDistributions(), and ISimulation::m_distribution_handler.

Here is the call graph for this function:

◆ initDistributionHandler()

virtual void ISimulation::initDistributionHandler ( )

inlineprotectedvirtualinherited

Reimplemented in ISimulation2D.

Definition at line 106 of file ISimulation.h.

106 {}

Referenced by ISimulation::simulate().

◆ initElementVector()

void SpecularSimulation::initElementVector ( )

overrideprivatevirtual

Initializes the vector of ISimulation elements.

Implements ISimulation.

Definition at line 70 of file SpecularSimulation.cpp.

 {
     m_eles = m_scan->generateElements();
  
     if (!m_cache.empty())
         return;
     m_cache.resize(m_eles.size(), 0);
 }

References m_cache, m_eles, and m_scan.

◆ intensityMapSize()

size_t SpecularSimulation::intensityMapSize ( ) const

overridevirtual

Returns the total number of the intensity values in the simulation result.

Implements ISimulation.

Definition at line 58 of file SpecularSimulation.cpp.

 {
     return m_scan->coordinateAxis()->size();
 }

References m_scan.

◆ moveDataFromCache()

void SpecularSimulation::moveDataFromCache ( )

overrideprivatevirtual

Implements ISimulation.

Definition at line 132 of file SpecularSimulation.cpp.

 {
     checkCache();
     for (size_t i = 0, size = m_eles.size(); i < size; ++i)
         m_eles[i].setIntensity(m_cache[i]);
     m_cache.clear();
     m_cache.shrink_to_fit();
 }

References checkCache(), m_cache, and m_eles.

Here is the call graph for this function:

◆ nodeChildren()

std::vector< const INode * > ISimulation::nodeChildren ( ) const

overridevirtualinherited

Returns all children.

Reimplemented from INode.

Reimplemented in ISimulation2D.

Definition at line 201 of file ISimulation.cpp.

 {
     std::vector<const INode*> result;
     if (m_sample)
         result << m_sample.get();
     return result;
 }

References ISimulation::m_sample.

Referenced by ISimulation2D::nodeChildren().

◆ nodeOffspring()

std::vector< const INode * > INode::nodeOffspring ( ) const

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

 {
     std::vector<const INode*> result;
     result.push_back(this);
     for (const auto* child : nodeChildren()) {
         for (const auto* p : child->nodeOffspring())
             result.push_back(p);
     }
     return result;
 }

References INode::nodeChildren().

Here is the call graph for this function:

◆ normalize()

void SpecularSimulation::normalize	(	size_t	start_ind,
		size_t	n_elements
	)

overrideprivatevirtual

Normalize the detector counts to beam intensity, to solid angle, and to exposure angle.

Parameters

start_ind	Index of the first element to operate on
n_elements	Number of elements to process

Implements ISimulation.

Definition at line 105 of file SpecularSimulation.cpp.

 {
     std::vector<double> footprints = m_scan->footprint(start_ind, n_elements);
  
     for (size_t i = start_ind, k = 0; i < start_ind + n_elements; ++i, ++k) {
         auto& element = m_eles[i];
         element.setIntensity(element.intensity() * footprints[k]);
     }
 }

References m_eles, and m_scan.

◆ numberOfElements()

size_t SpecularSimulation::numberOfElements ( ) const

overrideprivatevirtual

Gets the number of elements this simulation needs to calculate.

Implements ISimulation.

Definition at line 46 of file SpecularSimulation.cpp.

 {
     return m_scan->numberOfElements();
 }

References m_scan.

◆ options() [1/2]

SimulationOptions & ISimulation::options ( )

inherited

Definition at line 123 of file ISimulation.cpp.

 {
     ASSERT(m_options);
     return *m_options;
 }

References ASSERT, and ISimulation::m_options.

◆ options() [2/2]

const SimulationOptions & ISimulation::options ( ) const

inherited

Definition at line 117 of file ISimulation.cpp.

 {
     ASSERT(m_options);
     return *m_options;
 }

References ASSERT, and ISimulation::m_options.

Referenced by DepthProbeSimulation::createComputation(), ISimulation2D::createComputation(), createComputation(), and ISimulation::simulate().

◆ pack_result()

SimulationResult SpecularSimulation::pack_result ( )

overrideprivatevirtual

Sets m_result.

Implements ISimulation.

Definition at line 51 of file SpecularSimulation.cpp.

 {
     ASSERT(!m_eles.empty());
     Datafield data({m_scan->coordinateAxis()->clone()}, m_scan->createIntensities(m_eles));
     return {data, createCoordSystem()};
 }

References ASSERT, createCoordSystem(), m_eles, and m_scan.

Here is the call graph for this function:

◆ parDefs()

virtual std::vector<ParaMeta> INode::parDefs ( ) const

inlinevirtualinherited

Returns the parameter definitions, to be hard-coded in each leaf class.

Reimplemented in ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, Crystal, Layer, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceHardDisk, Interference2DSuperLattice, Interference2DParaCrystal, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, PolFilter, FootprintSquare, and FootprintGauss.

Definition at line 51 of file INode.h.

51 { return {}; }

Referenced by INode::checkNodeArgs(), and IFormFactor::pythonConstructor().

◆ prepareSimulation()

void SpecularSimulation::prepareSimulation ( )

inlineoverridevirtual

Put into a clean state for running a simulation.

Implements ISimulation.

Definition at line 48 of file SpecularSimulation.h.

48 {}

◆ progress()

ProgressHandler & ISimulation::progress ( )

protectedinherited

Definition at line 129 of file ISimulation.cpp.

 {
     ASSERT(m_progress);
     return *m_progress;
 }

References ASSERT, and ISimulation::m_progress.

Referenced by DepthProbeSimulation::createComputation(), ISimulation2D::createComputation(), and createComputation().

◆ runSingleSimulation()

void ISimulation::runSingleSimulation	(	const reSample &	re_sample,
		size_t	batch_start,
		size_t	batch_size,
		double	weight = `1.0`
	)

privateinherited

Runs a single simulation with fixed parameter values. If desired, the simulation is run in several threads.

Definition at line 245 of file ISimulation.cpp.

 {
     initElementVector();
  
     const size_t n_threads = m_options->getNumberOfThreads();
     ASSERT(n_threads > 0);
  
     std::vector<std::unique_ptr<IComputation>> computations;
  
     for (size_t i_thread = 0; i_thread < n_threads; ++i_thread) {
         const size_t thread_start = batch_start + startIndex(n_threads, i_thread, batch_size);
         const size_t thread_size = batchSize(n_threads, i_thread, batch_size);
         if (thread_size == 0)
             break;
         computations.emplace_back(createComputation(re_sample, thread_start, thread_size));
     }
     runComputations(computations);
  
     normalize(batch_start, batch_size);
     addBackgroundIntensity(batch_start, batch_size);
     addDataToCache(weight);
 }

References ISimulation::addBackgroundIntensity(), ISimulation::addDataToCache(), ASSERT, ISimulation::createComputation(), ISimulation::initElementVector(), ISimulation::m_options, and ISimulation::normalize().

Referenced by ISimulation::simulate().

Here is the call graph for this function:

◆ sample()

const MultiLayer * ISimulation::sample ( ) const

inherited

Definition at line 191 of file ISimulation.cpp.

 {
     return m_sample.get();
 }

References ISimulation::m_sample.

Referenced by ISimulation::simulate(), and DepthProbeSimulation::validityCheck().

◆ scan()

const ISpecularScan* SpecularSimulation::scan ( ) const

inline

Returns internal data handler.

Definition at line 52 of file SpecularSimulation.h.

52 { return m_scan.get(); }

References m_scan.

Referenced by SpecularSimulation().

◆ setBackground()

void ISimulation::setBackground ( const IBackground & bg )

inherited

Definition at line 196 of file ISimulation.cpp.

 {
     m_background.reset(bg.clone());
 }

References IBackground::clone(), and ISimulation::m_background.

Here is the call graph for this function:

◆ setTerminalProgressMonitor()

void ISimulation::setTerminalProgressMonitor ( )

inherited

Initializes a progress monitor that prints to stdout.

Definition at line 142 of file ISimulation.cpp.

 {
     m_progress->subscribe([](size_t percentage_done) -> bool {
         if (percentage_done < 100)
             std::cout << std::setprecision(2) << "\r... " << percentage_done << "%" << std::flush;
         else // wipe out
             std::cout << "\r... 100%\n";
         return true;
     });
 }

References ISimulation::m_progress.

◆ simulate()

SimulationResult ISimulation::simulate ( )

inherited

Run a simulation, and return the result.

Runs simulation with possible averaging over parameter distributions; returns result.

Definition at line 154 of file ISimulation.cpp.

 {
     if (!SampleUtils::Multilayer::ContainsCompatibleMaterials(*m_sample))
         throw std::runtime_error("Sample contains incompatible material definitions");
     gsl_set_error_handler_off();
  
     prepareSimulation();
  
     const auto re_sample = reSample::make(*sample(), options(), force_polarized());
  
     const size_t total_size = numberOfElements();
     size_t param_combinations = m_distribution_handler.getTotalNumberOfSamples();
  
     m_progress->reset();
     m_progress->setExpectedNTicks(param_combinations * total_size);
  
     // restrict calculation to current batch
     const size_t n_batches = m_options->getNumberOfBatches();
     const size_t current_batch = m_options->getCurrentBatch();
  
     const size_t batch_start = startIndex(n_batches, current_batch, total_size);
     const size_t batch_size = batchSize(n_batches, current_batch, total_size);
     ASSERT(batch_size);
  
     if (param_combinations == 1)
         runSingleSimulation(re_sample, batch_start, batch_size, 1.);
     else {
         initDistributionHandler();
         for (size_t index = 0; index < param_combinations; ++index) {
             double weight = m_distribution_handler.setParameterValues(index);
             runSingleSimulation(re_sample, batch_start, batch_size, weight);
         }
     }
     moveDataFromCache();
     return pack_result();
 }

References ASSERT, SampleUtils::Multilayer::ContainsCompatibleMaterials(), ISimulation::force_polarized(), DistributionHandler::getTotalNumberOfSamples(), ISimulation::initDistributionHandler(), ISimulation::m_distribution_handler, ISimulation::m_options, ISimulation::m_progress, ISimulation::m_sample, reSample::make(), ISimulation::moveDataFromCache(), ISimulation::numberOfElements(), ISimulation::options(), ISimulation::pack_result(), ISimulation::prepareSimulation(), ISimulation::runSingleSimulation(), ISimulation::sample(), and DistributionHandler::setParameterValues().

Here is the call graph for this function:

◆ subscribe()

void ISimulation::subscribe ( const std::function< bool(size_t)> & inform )

inherited

Definition at line 135 of file ISimulation.cpp.

 {
     ASSERT(m_progress);
     m_progress->subscribe(inform);
 }

References ASSERT, and ISimulation::m_progress.

◆ unitOfParameter()

std::string ISimulation::unitOfParameter ( ParameterDistribution::WhichParameter which ) const

inherited

Definition at line 209 of file ISimulation.cpp.

 {
     switch (which) {
     case ParameterDistribution::BeamWavelength:
         return "nm";
     case ParameterDistribution::BeamAzimuthalAngle:
     case ParameterDistribution::BeamInclinationAngle:
         return "rad";
     default:
         throw std::runtime_error("ISimulation::unitOfParameter(): missing implementation");
     }
 }

References ParameterDistribution::BeamAzimuthalAngle, ParameterDistribution::BeamInclinationAngle, and ParameterDistribution::BeamWavelength.

◆ updateIntensityMap()

virtual void ISimulation::updateIntensityMap ( )

inlineprotectedvirtualinherited

Reimplemented in OffspecSimulation.

Definition at line 97 of file ISimulation.h.

97 {}

◆ validateParametrization()

void SpecularSimulation::validateParametrization ( const ParameterDistribution & par_distr ) const

overrideprivatevirtual

Checks the distribution validity for simulation.

Reimplemented from ISimulation.

Definition at line 93 of file SpecularSimulation.cpp.

 {
     const bool zero_mean = par_distr.getDistribution()->mean() == 0.0;
     if (zero_mean)
         return;
     /* TODO come back to this after refactoring of distribution handling
     if (par_distr.whichParameter() == ParameterDistribution::BeamInclinationAngle)
         throw std::runtime_error("Error in SpecularSimulation: parameter distribution of "
                                  "beam inclination angle should have zero mean.");
     */
 }

References ParameterDistribution::getDistribution(), and IDistribution1D::mean().

Here is the call graph for this function:

Member Data Documentation

◆ m_background

std::shared_ptr<IBackground> ISimulation::m_background

privateinherited

Definition at line 137 of file ISimulation.h.

Referenced by ISimulation::background(), and ISimulation::setBackground().

◆ m_cache

std::vector<double> SpecularSimulation::m_cache

private

Definition at line 88 of file SpecularSimulation.h.

Referenced by addDataToCache(), checkCache(), initElementVector(), and moveDataFromCache().

◆ m_distribution_handler

DistributionHandler ISimulation::m_distribution_handler

protectedinherited

Definition at line 104 of file ISimulation.h.

Referenced by ISimulation::addParameterDistribution(), ISimulation::getDistributions(), ISimulation2D::initDistributionHandler(), and ISimulation::simulate().

◆ m_eles

std::vector<SpecularElement> SpecularSimulation::m_eles

private

Definition at line 87 of file SpecularSimulation.h.

Referenced by addBackgroundIntensity(), addDataToCache(), checkCache(), createComputation(), initElementVector(), moveDataFromCache(), normalize(), and pack_result().

◆ m_options

std::shared_ptr<SimulationOptions> ISimulation::m_options

privateinherited

Definition at line 135 of file ISimulation.h.

Referenced by ISimulation::options(), ISimulation::runSingleSimulation(), and ISimulation::simulate().

◆ m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

◆ m_progress

std::shared_ptr<ProgressHandler> ISimulation::m_progress

privateinherited

Definition at line 136 of file ISimulation.h.

Referenced by ISimulation::progress(), ISimulation::setTerminalProgressMonitor(), ISimulation::simulate(), and ISimulation::subscribe().

◆ m_sample

std::shared_ptr<MultiLayer> ISimulation::m_sample

privateinherited

Definition at line 133 of file ISimulation.h.

Referenced by ISimulation::nodeChildren(), ISimulation::sample(), and ISimulation::simulate().

◆ m_scan

std::unique_ptr<const ISpecularScan> SpecularSimulation::m_scan

private

Definition at line 86 of file SpecularSimulation.h.

Referenced by createCoordSystem(), force_polarized(), initElementVector(), intensityMapSize(), normalize(), numberOfElements(), pack_result(), and scan().

The documentation for this class was generated from the following files:

/home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Simulation/SpecularSimulation.h
/home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Simulation/SpecularSimulation.cpp

Description

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ SpecularSimulation() [1/2]

◆ ~SpecularSimulation()

◆ SpecularSimulation() [2/2]

Member Function Documentation

◆ addBackgroundIntensity()

◆ addDataToCache()

◆ addParameterDistribution() [1/2]

◆ addParameterDistribution() [2/2]

◆ background()

◆ checkCache()

◆ checkNodeArgs()

◆ className()

◆ createComputation()

◆ createCoordSystem()

◆ force_polarized()

◆ getDistributions()

◆ initDistributionHandler()

◆ initElementVector()

◆ intensityMapSize()

◆ moveDataFromCache()

◆ nodeChildren()

◆ nodeOffspring()

◆ normalize()

◆ numberOfElements()

◆ options() [1/2]

◆ options() [2/2]

◆ pack_result()

◆ parDefs()

◆ prepareSimulation()

◆ progress()

◆ runSingleSimulation()

◆ sample()

◆ scan()

◆ setBackground()

◆ setTerminalProgressMonitor()

◆ simulate()

◆ subscribe()

◆ unitOfParameter()

◆ updateIntensityMap()

◆ validateParametrization()

Member Data Documentation

◆ m_background

◆ m_cache

◆ m_distribution_handler

◆ m_eles

◆ m_options

◆ m_P

◆ m_progress

◆ m_sample

◆ m_scan