Description

Abstract base class, holds the infrastructure to run a simulation.

Base class of SpecularSimulation, ISimulation2D and DepthProbeSimulation.

Holds an instrument and sample model. Provides the common infrastructure to run a simulation: multithreading, batch processing, averaging over parameter distributions, etc.

Simulations are run, and results returned, by the function ISimulation::simulate().

Definition at line 42 of file ISimulation.h.

Inheritance diagram for ISimulation:

[legend]

Collaboration diagram for ISimulation:

[legend]

Public Member Functions
	ISimulation (const ISimulation &)=delete

	ISimulation (const MultiLayer &sample)

	ISimulation (ISimulation &&)=default

	~ISimulation () 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...

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

virtual ICoordSystem *	createCoordSystem () const =0

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

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

virtual size_t	intensityMapSize () const =0
	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...

const MultiLayer *	sample () const

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 ()

virtual void	initElementVector ()=0
	Initializes the vector of ISimulation elements. More...

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

virtual SimulationResult	pack_result ()=0
	Sets m_result. More...

virtual void	prepareSimulation ()=0
	Put into a clean state for running a simulation. More...

ProgressHandler &	progress ()

virtual void	updateIntensityMap ()

Protected Attributes
DistributionHandler	m_distribution_handler

std::vector< double >	m_P

Private Member Functions
virtual void	addBackgroundIntensity (size_t start_ind, size_t n_elements)=0

virtual void	addDataToCache (double weight)=0

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

virtual void	moveDataFromCache ()=0

virtual void	normalize (size_t start_ind, size_t n_elements)=0
	Normalize the detector counts to beam intensity, to solid angle, and to exposure angle. 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...

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

Private Attributes
std::shared_ptr< IBackground >	m_background

std::shared_ptr< SimulationOptions >	m_options

std::shared_ptr< ProgressHandler >	m_progress

std::shared_ptr< MultiLayer >	m_sample

Constructor & Destructor Documentation

◆ ISimulation() [1/3]

ISimulation::ISimulation ( const MultiLayer & sample )

Definition at line 108 of file ISimulation.cpp.

     : m_sample(sample.clone())
     , m_options(std::make_unique<SimulationOptions>())
     , m_progress(std::make_unique<ProgressHandler>())
 {
 }

◆ ~ISimulation()

ISimulation::~ISimulation ( )

overridedefault

◆ ISimulation() [2/3]

ISimulation::ISimulation ( const ISimulation & )

delete

◆ ISimulation() [3/3]

ISimulation::ISimulation ( ISimulation && )

default

Member Function Documentation

◆ addBackgroundIntensity()

virtual void ISimulation::addBackgroundIntensity	(	size_t	start_ind,
		size_t	n_elements
	)

privatepure virtual

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

◆ addDataToCache()

virtual void ISimulation::addDataToCache ( double weight )

privatepure virtual

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

◆ addParameterDistribution() [1/2]

void ISimulation::addParameterDistribution ( const ParameterDistribution & par_distr )

Definition at line 231 of file ISimulation.cpp.

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

References DistributionHandler::addParameterDistribution(), m_distribution_handler, and 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()`
	)

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

inline

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 m_background.

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

◆ 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()

virtual std::string INode::className ( ) const

pure virtualinherited

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

Implemented in Particle, SphericalDetector, SpecularSimulation, ScatteringSimulation, OffspecSimulation, DepthProbeSimulation, PoissonBackground, ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, IdentityRotation, ParticleCoreShell, ParticleComposition, MesoCrystal, Crystal, MultiLayer, Layer, Lattice3D, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, LayerInterface, 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, InterferenceNone, InterferenceHardDisk, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, ConvolutionDetectorResolution, PolFilter, RectangularDetector, FootprintSquare, FootprintGauss, and Beam.

Referenced by INode::checkNodeArgs(), ExemplarySamples::createBasic2DParaCrystalWithFTDis(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), and IFormFactor::shapeName().

◆ createComputation()

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

privatepure virtual

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

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

◆ createCoordSystem()

virtual ICoordSystem* ISimulation::createCoordSystem ( ) const

pure virtual

Implemented in SpecularSimulation, ScatteringSimulation, OffspecSimulation, and DepthProbeSimulation.

◆ force_polarized()

virtual bool ISimulation::force_polarized ( ) const

pure virtual

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

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by simulate().

◆ getDistributions()

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

Definition at line 237 of file ISimulation.cpp.

 {
     return m_distribution_handler.getDistributions();
 }

References DistributionHandler::getDistributions(), and m_distribution_handler.

Here is the call graph for this function:

◆ initDistributionHandler()

virtual void ISimulation::initDistributionHandler ( )

inlineprotectedvirtual

Reimplemented in ISimulation2D.

Definition at line 106 of file ISimulation.h.

106 {}

Referenced by simulate().

◆ initElementVector()

virtual void ISimulation::initElementVector ( )

protectedpure virtual

Initializes the vector of ISimulation elements.

Implemented in SpecularSimulation, ScatteringSimulation, OffspecSimulation, and DepthProbeSimulation.

Referenced by runSingleSimulation().

◆ intensityMapSize()

virtual size_t ISimulation::intensityMapSize ( ) const

pure virtual

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

Implemented in SpecularSimulation, ScatteringSimulation, OffspecSimulation, and DepthProbeSimulation.

◆ moveDataFromCache()

virtual void ISimulation::moveDataFromCache ( )

privatepure virtual

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by simulate().

◆ nodeChildren()

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

overridevirtual

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 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()

virtual void ISimulation::normalize	(	size_t	start_ind,
		size_t	n_elements
	)

privatepure virtual

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

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

◆ numberOfElements()

virtual size_t ISimulation::numberOfElements ( ) const

protectedpure virtual

Gets the number of elements this simulation needs to calculate.

Implemented in SpecularSimulation, OffspecSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by simulate().

◆ options() [1/2]

SimulationOptions & ISimulation::options ( )

Definition at line 123 of file ISimulation.cpp.

 {
     ASSERT(m_options);
     return *m_options;
 }

References ASSERT, and m_options.

◆ options() [2/2]

const SimulationOptions & ISimulation::options ( ) const

Definition at line 117 of file ISimulation.cpp.

 {
     ASSERT(m_options);
     return *m_options;
 }

References ASSERT, and m_options.

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

◆ pack_result()

virtual SimulationResult ISimulation::pack_result ( )

protectedpure virtual

Sets m_result.

Implemented in SpecularSimulation, ScatteringSimulation, OffspecSimulation, and DepthProbeSimulation.

Referenced by simulate().

◆ 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()

virtual void ISimulation::prepareSimulation ( )

protectedpure virtual

Put into a clean state for running a simulation.

Implemented in SpecularSimulation, ScatteringSimulation, OffspecSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by simulate().

◆ progress()

ProgressHandler & ISimulation::progress ( )

protected

Definition at line 129 of file ISimulation.cpp.

 {
     ASSERT(m_progress);
     return *m_progress;
 }

References ASSERT, and m_progress.

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

◆ runSingleSimulation()

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

private

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 addBackgroundIntensity(), addDataToCache(), ASSERT, createComputation(), initElementVector(), m_options, and normalize().

Referenced by simulate().

Here is the call graph for this function:

◆ sample()

const MultiLayer * ISimulation::sample ( ) const

Definition at line 191 of file ISimulation.cpp.

 {
     return m_sample.get();
 }

References m_sample.

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

◆ setBackground()

void ISimulation::setBackground ( const IBackground & bg )

Definition at line 196 of file ISimulation.cpp.

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

References IBackground::clone(), and m_background.

Here is the call graph for this function:

◆ setTerminalProgressMonitor()

void ISimulation::setTerminalProgressMonitor ( )

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 m_progress.

◆ simulate()

SimulationResult ISimulation::simulate ( )

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(), force_polarized(), DistributionHandler::getTotalNumberOfSamples(), initDistributionHandler(), m_distribution_handler, m_options, m_progress, m_sample, reSample::make(), moveDataFromCache(), numberOfElements(), options(), pack_result(), prepareSimulation(), runSingleSimulation(), sample(), and DistributionHandler::setParameterValues().

Here is the call graph for this function:

◆ subscribe()

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

Definition at line 135 of file ISimulation.cpp.

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

References ASSERT, and m_progress.

◆ unitOfParameter()

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

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 ( )

inlineprotectedvirtual

Reimplemented in OffspecSimulation.

Definition at line 97 of file ISimulation.h.

97 {}

◆ validateParametrization()

virtual void ISimulation::validateParametrization ( const ParameterDistribution & ) const

inlineprivatevirtual

Checks the distribution validity for simulation.

Reimplemented in SpecularSimulation, OffspecSimulation, and DepthProbeSimulation.

Definition at line 120 of file ISimulation.h.

120 {}

Referenced by addParameterDistribution().

Member Data Documentation

◆ m_background

std::shared_ptr<IBackground> ISimulation::m_background

private

Definition at line 137 of file ISimulation.h.

Referenced by background(), and setBackground().

◆ m_distribution_handler

DistributionHandler ISimulation::m_distribution_handler

protected

Definition at line 104 of file ISimulation.h.

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

◆ m_options

std::shared_ptr<SimulationOptions> ISimulation::m_options

private

Definition at line 135 of file ISimulation.h.

Referenced by options(), runSingleSimulation(), and 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

private

Definition at line 136 of file ISimulation.h.

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

◆ m_sample

std::shared_ptr<MultiLayer> ISimulation::m_sample

private

Definition at line 133 of file ISimulation.h.

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

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

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

Description

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ ISimulation() [1/3]

◆ ~ISimulation()

◆ ISimulation() [2/3]

◆ ISimulation() [3/3]

Member Function Documentation

◆ addBackgroundIntensity()

◆ addDataToCache()

◆ addParameterDistribution() [1/2]

◆ addParameterDistribution() [2/2]

◆ background()

◆ 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()

◆ setBackground()

◆ setTerminalProgressMonitor()

◆ simulate()

◆ subscribe()

◆ unitOfParameter()

◆ updateIntensityMap()

◆ validateParametrization()

Member Data Documentation

◆ m_background

◆ m_distribution_handler

◆ m_options

◆ m_P

◆ m_progress

◆ m_sample