Simulation Class Reference

Inheritance diagram for Simulation:

Collaboration diagram for Simulation:

Public Member Functions
	Simulation ()
virtual	~Simulation ()
virtual Simulation *	clone () const =0
virtual void	prepareSimulation ()
void	runSimulation ()
void	runMPISimulation ()
void	setInstrument (const Instrument &instrument_)
const Instrument &	instrument () const
Instrument &	instrument ()
void	setBeamIntensity (double intensity)
double	getBeamIntensity () const
void	setBeamPolarization (const kvector_t bloch_vector)
void	setDetectorResolutionFunction (const IResolutionFunction2D &resolution_function)
void	removeDetectorResolutionFunction ()
void	setAnalyzerProperties (const kvector_t direction, double efficiency, double total_transmission)
void	setSample (const MultiLayer &sample)
const MultiLayer *	sample () const
void	setSampleBuilder (const std::shared_ptr< ISampleBuilder > &sample_builder)
void	setBackground (const IBackground &bg)
const IBackground *	background () const
virtual size_t	intensityMapSize () const =0
virtual SimulationResult	result () const =0
void	addParameterDistribution (const std::string &param_name, const IDistribution1D &distribution, size_t nbr_samples, double sigma_factor=0.0, const RealLimits &limits=RealLimits())
void	addParameterDistribution (const ParameterDistribution &par_distr)
const DistributionHandler &	getDistributionHandler () const
void	setOptions (const SimulationOptions &options)
const SimulationOptions &	getOptions () const
SimulationOptions &	getOptions ()
void	subscribe (ProgressHandler::Callback_t inform)
void	setTerminalProgressMonitor ()
std::vector< const INode * >	getChildren () const
SimulationResult	convertData (const OutputData< double > &data, bool put_masked_areas_to_zero=true)
virtual void	transferToCPP ()
virtual void	accept (INodeVisitor *visitor) const =0
virtual std::string	treeToString () const
void	registerChild (INode *node)
virtual void	setParent (const INode *newParent)
const INode *	parent () const
INode *	parent ()
int	copyNumber (const INode *node) const
std::string	displayName () const
ParameterPool *	createParameterTree () const
ParameterPool *	parameterPool () const
std::string	parametersToString () const
RealParameter &	registerParameter (const std::string &name, double *parpointer)
void	registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
void	setParameterValue (const std::string &name, double value)
void	setVectorValue (const std::string &base_name, kvector_t value)
RealParameter *	parameter (const std::string &name) const
virtual void	onChange ()
void	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setName (const std::string &name)
const std::string &	getName () const

Static Public Member Functions
static std::string	XComponentName (const std::string &base_name)
static std::string	YComponentName (const std::string &base_name)
static std::string	ZComponentName (const std::string &base_name)

Protected Member Functions
	Simulation (const Simulation &other)
virtual void	transferResultsToIntensityMap ()
virtual void	initSimulationElementVector ()=0
virtual void	updateIntensityMap ()
virtual size_t	numberOfSimulationElements () const =0
const SimulationOptions &	options () const
ProgressHandler &	progress ()

Protected Attributes
const size_t	m_NP
std::vector< double >	m_P

Private Member Functions
void	initialize ()
void	runSingleSimulation (size_t batch_start, size_t batch_size, double weight=1.0)
virtual std::unique_ptr< IComputation >	generateSingleThreadedComputation (size_t start, size_t n_elements)=0
virtual void	validateParametrization (const ParameterDistribution &) const
virtual void	addBackgroundIntensity (size_t start_ind, size_t n_elements)=0
virtual void	normalize (size_t start_ind, size_t n_elements)=0
virtual void	addDataToCache (double weight)=0
virtual void	moveDataFromCache ()=0
virtual std::vector< double >	rawResults () const =0
virtual void	setRawResults (const std::vector< double > &raw_data)=0

Private Attributes
SimulationOptions	m_options
ProgressHandler	m_progress
SampleProvider	m_sample_provider
DistributionHandler	m_distribution_handler
Instrument	m_instrument
std::unique_ptr< IBackground >	m_background
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Friends
class	MPISimulation

Detailed Description

Pure virtual base class of OffSpecularSimulation, GISASSimulation and SpecularSimulation.

Holds the common infrastructure to run a simulation: multithreading, batch processing, weighting over parameter distributions, ...

Definition at line 37 of file Simulation.h.

Constructor & Destructor Documentation

Simulation() [1/2]

Simulation::Simulation

(

)

Definition at line 121 of file Simulation.cpp.

{
    initialize();
}

References initialize().

Here is the call graph for this function:

~Simulation()

Simulation::~Simulation ( )

virtualdefault

Simulation() [2/2]

Simulation::Simulation ( const Simulation &  other )

protected

Definition at line 126 of file Simulation.cpp.

    : ICloneable(), INode(), m_options(other.m_options), m_progress(other.m_progress),
      m_sample_provider(other.m_sample_provider),
      m_distribution_handler(other.m_distribution_handler), m_instrument(other.instrument())
{
    if (other.m_background)
        setBackground(*other.m_background);
    initialize();
}

References initialize(), m_background, and setBackground().

Here is the call graph for this function:

Member Function Documentation

clone()

virtual Simulation* Simulation::clone ( ) const

pure virtual

Implements ICloneable.

Implemented in Simulation2D, SpecularSimulation, OffSpecSimulation, GISASSimulation, and DepthProbeSimulation.

Referenced by anonymous_namespace{ExportToPython.cpp}::simulationCode().

prepareSimulation()

void Simulation::prepareSimulation ( )

virtual

Put into a clean state for running a simulation.

Reimplemented in SpecularSimulation, Simulation2D, GISASSimulation, and OffSpecSimulation.

Definition at line 189 of file Simulation.cpp.

{
    m_sample_provider.updateSample();
    if (!MultiLayerUtils::ContainsCompatibleMaterials(*m_sample_provider.sample()))
        throw std::runtime_error(
            "Error in Simulation::prepareSimulation(): non-default materials of"
            " several different types are used in the sample provided");
    gsl_set_error_handler_off();
}

References MultiLayerUtils::ContainsCompatibleMaterials(), m_sample_provider, SampleProvider::sample(), and SampleProvider::updateSample().

Referenced by Simulation2D::prepareSimulation(), SpecularSimulation::prepareSimulation(), and runSimulation().

Here is the call graph for this function:

runSimulation()

void Simulation::runSimulation

(

)

Run a simulation, possibly averaged over parameter distributions.

Run simulation with possible averaging over parameter distributions.

Definition at line 200 of file Simulation.cpp.

{
    prepareSimulation();
 
    const size_t total_size = numberOfSimulationElements();
    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 = getStartIndex(n_batches, current_batch, total_size);
    const size_t batch_size = getNumberOfElements(n_batches, current_batch, total_size);
    if (batch_size == 0)
        return;
 
    std::unique_ptr<ParameterPool> param_pool(createParameterTree());
    for (size_t index = 0; index < param_combinations; ++index) {
        double weight = m_distribution_handler.setParameterValues(param_pool.get(), index);
        runSingleSimulation(batch_start, batch_size, weight);
    }
    m_distribution_handler.setParameterToMeans(param_pool.get());
    moveDataFromCache();
    transferResultsToIntensityMap();
}

References INode::createParameterTree(), SimulationOptions::getCurrentBatch(), SimulationOptions::getNumberOfBatches(), anonymous_namespace{Simulation.cpp}::getNumberOfElements(), anonymous_namespace{Simulation.cpp}::getStartIndex(), DistributionHandler::getTotalNumberOfSamples(), m_distribution_handler, m_options, m_progress, moveDataFromCache(), numberOfSimulationElements(), prepareSimulation(), ProgressHandler::reset(), runSingleSimulation(), ProgressHandler::setExpectedNTicks(), DistributionHandler::setParameterToMeans(), DistributionHandler::setParameterValues(), and transferResultsToIntensityMap().

Here is the call graph for this function:

runMPISimulation()

void Simulation::runMPISimulation

(

)

Run a simulation in a MPI environment.

Definition at line 229 of file Simulation.cpp.

{
    MPISimulation ompi;
    ompi.runSimulation(this);
}

References MPISimulation::runSimulation().

Here is the call graph for this function:

setInstrument()

void Simulation::setInstrument

(

const Instrument &

instrument_

)

Definition at line 235 of file Simulation.cpp.

{
    m_instrument = instrument_;
    updateIntensityMap();
}

References m_instrument, and updateIntensityMap().

Here is the call graph for this function:

instrument() [1/2]

const Instrument& Simulation::instrument ( ) const

inline

Definition at line 55 of file Simulation.h.

{ return m_instrument; }

References m_instrument.

Referenced by Simulation2D::addMask(), OffSpecSimulation::checkInitialization(), convertData(), DepthProbeSimulation::createUnitConverter(), OffSpecSimulation::createUnitConverter(), SimulationToPython::defineDetector(), SimulationToPython::defineDetectorPolarizationAnalysis(), SimulationToPython::defineDetectorResolutionFunction(), SimulationToPython::defineGISASBeam(), SimulationToPython::defineMasks(), SimulationToPython::defineOffSpecBeam(), SimulationToPython::defineSpecularScan(), Simulation2D::generateSimulationElements(), getBeamIntensity(), getChildren(), DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), DepthProbeSimulation::initSimulationElementVector(), GISASSimulation::initSimulationElementVector(), OffSpecSimulation::initSimulationElementVector(), SpecularSimulation::initSimulationElementVector(), GISASSimulation::intensityMapSize(), OffSpecSimulation::intensityMapSize(), Simulation2D::maskAll(), DepthProbeSimulation::normalize(), SpecularSimulation::normalize(), GISASSimulation::prepareSimulation(), Simulation2D::prepareSimulation(), SpecularSimulation::prepareSimulation(), removeDetectorResolutionFunction(), Simulation2D::removeMasks(), GISASSimulation::result(), OffSpecSimulation::result(), setAnalyzerProperties(), setBeamIntensity(), DepthProbeSimulation::setBeamParameters(), OffSpecSimulation::setBeamParameters(), GISASSimulation::setBeamParameters(), setBeamPolarization(), Simulation2D::setDetector(), Simulation2D::setDetectorParameters(), setDetectorResolutionFunction(), Simulation2D::setRegionOfInterest(), SpecularSimulation::setScan(), OffSpecSimulation::transferDetectorImage(), OffSpecSimulation::transferResultsToIntensityMap(), and OffSpecSimulation::updateIntensityMap().

instrument() [2/2]

Instrument& Simulation::instrument ( )

inline

Definition at line 56 of file Simulation.h.

{ return m_instrument; }

References m_instrument.

setBeamIntensity()

void Simulation::setBeamIntensity

(

double

intensity

)

Definition at line 173 of file Simulation.cpp.

{
    instrument().setBeamIntensity(intensity);
}

References instrument(), and Instrument::setBeamIntensity().

Referenced by StandardSimulations::GISASWithMasks().

Here is the call graph for this function:

getBeamIntensity()

double Simulation::getBeamIntensity

(

)

const

Definition at line 178 of file Simulation.cpp.

{
    return instrument().getBeamIntensity();
}

References Instrument::getBeamIntensity(), and instrument().

Referenced by DepthProbeSimulation::normalize(), Simulation2D::normalize(), and SpecularSimulation::normalize().

Here is the call graph for this function:

setBeamPolarization()

void Simulation::setBeamPolarization

(

const kvector_t

bloch_vector

)

Sets the beam polarization according to the given Bloch vector.

Definition at line 184 of file Simulation.cpp.

{
    instrument().setBeamPolarization(bloch_vector);
}

References instrument(), and Instrument::setBeamPolarization().

Referenced by StandardSimulations::BasicGISAS00(), StandardSimulations::BasicPolarizedGISAS(), StandardSimulations::MaxiGISAS00(), StandardSimulations::MiniGISASPolarizationMM(), StandardSimulations::MiniGISASPolarizationMP(), StandardSimulations::MiniGISASPolarizationPM(), and StandardSimulations::MiniGISASPolarizationPP().

Here is the call graph for this function:

setDetectorResolutionFunction()

void Simulation::setDetectorResolutionFunction

(

const IResolutionFunction2D &

resolution_function

)

Definition at line 156 of file Simulation.cpp.

{
    instrument().setDetectorResolutionFunction(resolution_function);
}

References instrument(), and Instrument::setDetectorResolutionFunction().

Referenced by StandardSimulations::MiniGISASDetectorResolution().

Here is the call graph for this function:

removeDetectorResolutionFunction()

void Simulation::removeDetectorResolutionFunction

(

)

Definition at line 161 of file Simulation.cpp.

{
    instrument().removeDetectorResolution();
}

References instrument(), and Instrument::removeDetectorResolution().

Here is the call graph for this function:

setAnalyzerProperties()

void Simulation::setAnalyzerProperties	(	const kvector_t	direction,
		double	efficiency,
		double	total_transmission
	)

Sets the polarization analyzer characteristics of the detector.

Definition at line 167 of file Simulation.cpp.

{
    instrument().setAnalyzerProperties(direction, efficiency, total_transmission);
}

References instrument(), and Instrument::setAnalyzerProperties().

Referenced by StandardSimulations::BasicGISAS00(), StandardSimulations::BasicPolarizedGISAS(), StandardSimulations::MaxiGISAS00(), StandardSimulations::MiniGISASPolarizationMM(), StandardSimulations::MiniGISASPolarizationMP(), StandardSimulations::MiniGISASPolarizationPM(), and StandardSimulations::MiniGISASPolarizationPP().

Here is the call graph for this function:

setSample()

void Simulation::setSample

(

const MultiLayer &

sample

)

The MultiLayer object will not be owned by the Simulation object.

Definition at line 242 of file Simulation.cpp.

{
    m_sample_provider.setSample(sample);
}

References m_sample_provider, sample(), and SampleProvider::setSample().

Here is the call graph for this function:

sample()

const MultiLayer * Simulation::sample

(

)

const

Definition at line 247 of file Simulation.cpp.

{
    return m_sample_provider.sample();
}

References m_sample_provider, and SampleProvider::sample().

Referenced by SimulationToPython::generateSimulationCode(), DepthProbeSimulation::generateSingleThreadedComputation(), Simulation2D::generateSingleThreadedComputation(), SpecularSimulation::generateSingleThreadedComputation(), setSample(), and DepthProbeSimulation::validityCheck().

Here is the call graph for this function:

setSampleBuilder()

void Simulation::setSampleBuilder

(

const std::shared_ptr< ISampleBuilder > &

sample_builder

)

Definition at line 252 of file Simulation.cpp.

{
    m_sample_provider.setBuilder(sample_builder);
}

References m_sample_provider, and SampleProvider::setBuilder().

Here is the call graph for this function:

setBackground()

void Simulation::setBackground

(

const IBackground &

bg

)

Definition at line 257 of file Simulation.cpp.

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

References IBackground::clone(), m_background, and INode::registerChild().

Referenced by StandardSimulations::ConstantBackgroundGISAS(), and Simulation().

Here is the call graph for this function:

background()

const IBackground* Simulation::background ( ) const

inline

Definition at line 75 of file Simulation.h.

{ return m_background.get(); }

References m_background.

Referenced by DepthProbeSimulation::addBackgroundIntensity(), Simulation2D::addBackgroundIntensity(), SpecularSimulation::addBackgroundIntensity(), and SimulationToPython::defineBackground().

intensityMapSize()

virtual size_t Simulation::intensityMapSize ( ) const

pure virtual

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

Implemented in SpecularSimulation, OffSpecSimulation, GISASSimulation, and DepthProbeSimulation.

result()

virtual SimulationResult Simulation::result ( ) const

pure virtual

Returns the results of the simulation in a format that supports unit conversion and export to numpy arrays.

Implemented in SpecularSimulation, OffSpecSimulation, GISASSimulation, and DepthProbeSimulation.

Referenced by Simulation2D::generateSimulationElements(), getChildren(), and Simulation2D::rawResults().

addParameterDistribution() [1/2]

void Simulation::addParameterDistribution	(	const std::string &	param_name,
		const IDistribution1D &	distribution,
		size_t	nbr_samples,
		double	sigma_factor = 0.0,
		const RealLimits &	limits = RealLimits()
	)

Definition at line 273 of file Simulation.cpp.

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

Referenced by StandardSimulations::MiniGISASBeamDivergence().

addParameterDistribution() [2/2]

void Simulation::addParameterDistribution

(

const ParameterDistribution &

par_distr

)

Definition at line 281 of file Simulation.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:

getDistributionHandler()

const DistributionHandler& Simulation::getDistributionHandler ( ) const

inline

Definition at line 89 of file Simulation.h.

{ return m_distribution_handler; }

References m_distribution_handler.

Referenced by SimulationToPython::defineParameterDistributions().

setOptions()

void Simulation::setOptions ( const SimulationOptions &  options )

inline

Definition at line 91 of file Simulation.h.

{ m_options = options; }

References m_options, and options().

Here is the call graph for this function:

getOptions() [1/2]

const SimulationOptions& Simulation::getOptions ( ) const

inline

Definition at line 92 of file Simulation.h.

{ return m_options; }

References m_options.

Referenced by SimulationToPython::defineSimulationOptions(), StandardSimulations::MiniGISASMonteCarlo(), and StandardSimulations::MiniGISASSpecularPeak().

getOptions() [2/2]

SimulationOptions& Simulation::getOptions ( )

inline

Definition at line 93 of file Simulation.h.

{ return m_options; }

References m_options.

subscribe()

void Simulation::subscribe ( ProgressHandler::Callback_t  inform )

inline

Definition at line 95 of file Simulation.h.

{ m_progress.subscribe(inform); }

References m_progress, and ProgressHandler::subscribe().

Here is the call graph for this function:

setTerminalProgressMonitor()

void Simulation::setTerminalProgressMonitor

(

)

Initializes a progress monitor that prints to stdout.

Definition at line 145 of file Simulation.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, and ProgressHandler::subscribe().

Here is the call graph for this function:

getChildren()

std::vector< const INode * > Simulation::getChildren ( ) const

virtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 263 of file Simulation.cpp.

{
    std::vector<const INode*> result;
    result.push_back(&instrument());
    result << m_sample_provider.getChildren();
    if (m_background)
        result.push_back(m_background.get());
    return result;
}

References SampleProvider::getChildren(), instrument(), m_background, m_sample_provider, and result().

Here is the call graph for this function:

convertData()

SimulationResult Simulation::convertData	(	const OutputData< double > &	data,
		bool	put_masked_areas_to_zero = true
	)

Convert user data to SimulationResult object for later drawing in various axes units.

User data will be cropped to the ROI defined in the simulation, amplitudes in areas corresponding to the masked areas of the detector will be set to zero.

Definition at line 317 of file Simulation.cpp.

{
    auto converter = UnitConverterUtils::createConverter(*this);
    auto roi_data = UnitConverterUtils::createOutputData(*converter, converter->defaultUnits());
 
    const IDetector& detector = instrument().detector();
 
    if (roi_data->hasSameDimensions(data)) {
        // data is already cropped to ROI
        if (put_masked_areas_to_zero) {
            detector.iterate(
                [&](IDetector::const_iterator it) {
                    (*roi_data)[it.roiIndex()] = data[it.roiIndex()];
                },
                /*visit_masked*/ false);
        } else {
            roi_data->setRawDataVector(data.getRawDataVector());
        }
 
    } else if (detHasSameDimensions(detector, data)) {
        // exp data has same shape as the detector, we have to put orig data to smaller roi map
        detector.iterate(
            [&](IDetector::const_iterator it) {
                (*roi_data)[it.roiIndex()] = data[it.detectorIndex()];
            },
            /*visit_masked*/ !put_masked_areas_to_zero);
 
    } else {
        throw std::runtime_error("FitObject::init_dataset() -> Error. Detector and exp data have "
                                 "different shape.");
    }
 
    return SimulationResult(*roi_data, *converter);
}

References UnitConverterUtils::createConverter(), UnitConverterUtils::createOutputData(), Instrument::detector(), SimulationAreaIterator::detectorIndex(), anonymous_namespace{Simulation.cpp}::detHasSameDimensions(), OutputData< T >::getRawDataVector(), instrument(), IDetector::iterate(), and SimulationAreaIterator::roiIndex().

Here is the call graph for this function:

transferResultsToIntensityMap()

virtual void Simulation::transferResultsToIntensityMap ( )

inlineprotectedvirtual

Creates the appropriate data structure (e.g.

2D intensity map) from the calculated SimulationElement objects

Reimplemented in OffSpecSimulation.

Definition at line 110 of file Simulation.h.

{}

Referenced by runSimulation(), Simulation2D::setRawResults(), and SpecularSimulation::setRawResults().

initSimulationElementVector()

virtual void Simulation::initSimulationElementVector ( )

protectedpure virtual

Initializes the vector of Simulation elements.

Implemented in SpecularSimulation, OffSpecSimulation, GISASSimulation, and DepthProbeSimulation.

Referenced by runSingleSimulation(), and Simulation2D::setRawResults().

updateIntensityMap()

virtual void Simulation::updateIntensityMap ( )

inlineprotectedvirtual

Reimplemented in OffSpecSimulation.

Definition at line 115 of file Simulation.h.

{}

Referenced by Simulation2D::setDetectorParameters(), and setInstrument().

numberOfSimulationElements()

virtual size_t Simulation::numberOfSimulationElements ( ) const

protectedpure virtual

Gets the number of elements this simulation needs to calculate.

Implemented in SpecularSimulation, Simulation2D, DepthProbeSimulation, and OffSpecSimulation.

Referenced by runSimulation().

options()

const SimulationOptions& Simulation::options ( ) const

inlineprotected

Definition at line 120 of file Simulation.h.

{ return m_options; }

References m_options.

Referenced by DepthProbeSimulation::generateSingleThreadedComputation(), Simulation2D::generateSingleThreadedComputation(), SpecularSimulation::generateSingleThreadedComputation(), and setOptions().

progress()

ProgressHandler& Simulation::progress ( )

inlineprotected

Definition at line 121 of file Simulation.h.

{ return m_progress; }

References m_progress.

Referenced by DepthProbeSimulation::generateSingleThreadedComputation(), Simulation2D::generateSingleThreadedComputation(), and SpecularSimulation::generateSingleThreadedComputation().

initialize()

void Simulation::initialize ( )

private

Definition at line 138 of file Simulation.cpp.

{
    registerChild(&m_instrument);
    registerChild(&m_sample_provider);
}

References m_instrument, m_sample_provider, and INode::registerChild().

Referenced by Simulation().

Here is the call graph for this function:

runSingleSimulation()

void Simulation::runSingleSimulation ( 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 289 of file Simulation.cpp.

{
    initSimulationElementVector();
 
    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) { // Distribute computations by threads
        const size_t thread_start = batch_start + getStartIndex(n_threads, i_thread, batch_size);
        const size_t thread_size = getNumberOfElements(n_threads, i_thread, batch_size);
        if (thread_size == 0)
            break;
        computations.push_back(generateSingleThreadedComputation(thread_start, thread_size));
    }
    runComputations(std::move(computations));
 
    normalize(batch_start, batch_size);
    addBackgroundIntensity(batch_start, batch_size);
    addDataToCache(weight);
}

References addBackgroundIntensity(), addDataToCache(), ASSERT, generateSingleThreadedComputation(), anonymous_namespace{Simulation.cpp}::getNumberOfElements(), SimulationOptions::getNumberOfThreads(), anonymous_namespace{Simulation.cpp}::getStartIndex(), initSimulationElementVector(), m_options, normalize(), and anonymous_namespace{Simulation.cpp}::runComputations().

Referenced by runSimulation().

Here is the call graph for this function:

generateSingleThreadedComputation()

virtual std::unique_ptr<IComputation> Simulation::generateSingleThreadedComputation ( size_t  start, size_t  n_elements  )

privatepure virtual

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

Parameters

start	Index of the first element to include into computation
n_elements	Number of elements to process

Implemented in SpecularSimulation, Simulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

validateParametrization()

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

inlineprivatevirtual

Checks the distribution validity for simulation.

Reimplemented in SpecularSimulation, OffSpecSimulation, and DepthProbeSimulation.

Definition at line 135 of file Simulation.h.

{}

Referenced by addParameterDistribution().

addBackgroundIntensity()

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

privatepure virtual

Implemented in SpecularSimulation, Simulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

normalize()

virtual void Simulation::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, Simulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

addDataToCache()

virtual void Simulation::addDataToCache ( double  weight )

privatepure virtual

Implemented in SpecularSimulation, Simulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

moveDataFromCache()

virtual void Simulation::moveDataFromCache ( )

privatepure virtual

Implemented in SpecularSimulation, Simulation2D, and DepthProbeSimulation.

Referenced by runSimulation().

rawResults()

virtual std::vector<double> Simulation::rawResults ( ) const

privatepure virtual

Implemented in SpecularSimulation, Simulation2D, and DepthProbeSimulation.

setRawResults()

virtual void Simulation::setRawResults ( const std::vector< double > &  raw_data )

privatepure virtual

Implemented in SpecularSimulation, Simulation2D, and DepthProbeSimulation.

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 34 of file ICloneable.h.

accept()

virtual void INode::accept ( INodeVisitor *  visitor ) const

pure virtualinherited

Calls the INodeVisitor's visit method.

Implemented in FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, FormFactorDecoratorRotation, FormFactorDecoratorPositionFactor, FormFactorDecoratorMaterial, ParticleDistribution, ParticleCoreShell, ParticleComposition, Particle, MesoCrystal, FormFactorWeighted, FormFactorCrystal, FormFactorCoreShell, Crystal, Layer, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorTruncatedCube, FormFactorTetrahedron, FormFactorSawtoothRippleLorentz, FormFactorSawtoothRippleGauss, FormFactorSawtoothRippleBox, FormFactorPyramid, FormFactorPrism6, FormFactorPrism3, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorIcosahedron, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDot, FormFactorDodecahedron, FormFactorCylinder, FormFactorCuboctahedron, FormFactorCosineRippleLorentz, FormFactorCosineRippleGauss, FormFactorCosineRippleBox, FormFactorCone6, FormFactorCone, FormFactorCantellatedCube, FormFactorBox, FormFactorAnisoPyramid, FTDistribution1DVoigt, FTDistribution1DCosine, FTDistribution1DTriangle, FTDistribution1DGate, FTDistribution1DGauss, FTDistribution1DCauchy, InterferenceFunctionTwin, InterferenceFunctionRadialParaCrystal, InterferenceFunctionNone, InterferenceFunctionHardDisk, InterferenceFunctionFinite3DLattice, InterferenceFunctionFinite2DLattice, InterferenceFunction3DLattice, InterferenceFunction2DSuperLattice, InterferenceFunction2DParaCrystal, InterferenceFunction2DLattice, InterferenceFunction1DLattice, SpecularSimulation, DepthProbeSimulation, FormFactorDWBAPol, FormFactorDWBA, FormFactorBAPol, Lattice, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, SphericalDetector, SpecularDetector1D, FootprintSquare, FootprintGauss, Beam, GISASSimulation, PoissonNoiseBackground, ConstantBackground, MultiLayer, ParticleLayout, SampleProvider, SampleBuilderNode, HexagonalLattice, SquareLattice, BasicLattice, FormFactorBarLorentz, FormFactorBarGauss, FTDistribution2DVoigt, FTDistribution2DCone, FTDistribution2DGate, FTDistribution2DGauss, FTDistribution2DCauchy, FTDecayFunction2DVoigt, FTDecayFunction2DGauss, FTDecayFunction2DCauchy, FTDecayFunction1DVoigt, FTDecayFunction1DTriangle, FTDecayFunction1DGauss, FTDecayFunction1DCauchy, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, ConvolutionDetectorResolution, Instrument, RectangularDetector, IsGISAXSDetector, DetectionProperties, OffSpecSimulation, ILayout, LayerRoughness, LayerInterface, RotationEuler, RotationZ, RotationY, RotationX, IdentityRotation, and IAbstractParticle.

Referenced by VisitNodesPostorder(), and VisitNodesPreorder().

treeToString()

std::string INode::treeToString ( ) const

virtualinherited

Returns multiline string representing tree structure below the node.

Definition at line 53 of file INode.cpp.

{
    return NodeUtils::nodeToString(*this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 58 of file INode.cpp.

{
    ASSERT(node);
    node->setParent(this);
}

References ASSERT, and INode::setParent().

Referenced by ParticleLayout::addAndRegisterAbstractParticle(), ParticleCoreShell::addAndRegisterCore(), MultiLayer::addAndRegisterInterface(), MultiLayer::addAndRegisterLayer(), ParticleCoreShell::addAndRegisterShell(), Layer::addLayout(), ParticleComposition::addParticlePointer(), Beam::Beam(), Crystal::Crystal(), IDetector::IDetector(), initialize(), MesoCrystal::initialize(), Instrument::Instrument(), Beam::operator=(), Instrument::operator=(), Particle::Particle(), ParticleDistribution::ParticleDistribution(), IParticle::rotate(), ParticleLayout::setAndRegisterInterferenceFunction(), setBackground(), InterferenceFunction1DLattice::setDecayFunction(), InterferenceFunction2DLattice::setDecayFunction(), Instrument::setDetector(), IDetector::setDetectorResolution(), Beam::setFootprintFactor(), Particle::setFormFactor(), InterferenceFunctionFinite3DLattice::setLattice(), InterferenceFunction2DLattice::setLattice(), InterferenceFunction2DParaCrystal::setLattice(), InterferenceFunction2DSuperLattice::setLattice(), InterferenceFunctionFinite2DLattice::setLattice(), InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(), InterferenceFunction2DParaCrystal::setProbabilityDistributions(), ConvolutionDetectorResolution::setResolutionFunction(), IParticle::setRotation(), LayerInterface::setRoughness(), and InterferenceFunction2DSuperLattice::setSubstructureIFF().

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 69 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

Referenced by INode::registerChild(), SampleProvider::setBuilder(), and SampleProvider::setParent().

parent() [1/2]

const INode * INode::parent ( ) const

inherited

Definition at line 74 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

Referenced by INode::copyNumber(), INode::createParameterTree(), NodeUtils::nodePath(), Lattice2D::onChange(), SampleProvider::setBuilder(), SampleProvider::setParent(), and SampleProvider::setSample().

parent() [2/2]

INode * INode::parent ( )

inherited

Definition at line 79 of file INode.cpp.

{
    return const_cast<INode*>(m_parent);
}

References INode::m_parent.

copyNumber()

int INode::copyNumber ( const INode *  node ) const

inherited

Returns copyNumber of child, which takes into account existence of children with same name.

Definition at line 84 of file INode.cpp.

{
    if (node->parent() != this)
        return -1;
 
    int result(-1), count(0);
    for (auto child : getChildren()) {
 
        if (child == nullptr)
            throw std::runtime_error("INode::copyNumber() -> Error. Nullptr as child.");
 
        if (child == node)
            result = count;
 
        if (child->getName() == node->getName())
            ++count;
    }
 
    return count > 1 ? result : -1;
}

References INode::getChildren(), IParameterized::getName(), and INode::parent().

Referenced by INode::displayName().

Here is the call graph for this function:

displayName()

std::string INode::displayName ( ) const

inherited

Returns display name, composed from the name of node and it's copy number.

Definition at line 105 of file INode.cpp.

{
    std::string result = getName();
    if (m_parent) {
        int index = m_parent->copyNumber(this);
        if (index >= 0)
            result = result + std::to_string(index);
    }
    return result;
}

References INode::copyNumber(), IParameterized::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath(), and anonymous_namespace{NodeUtils.cpp}::nodeString().

Here is the call graph for this function:

createParameterTree()

ParameterPool * INode::createParameterTree ( ) const

virtualinherited

Creates new parameter pool, with all local parameters and those of its children.

Reimplemented from IParameterized.

Definition at line 116 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    NodeIterator<PreorderStrategy> it(this);
    it.first();
    while (!it.isDone()) {
        const INode* child = it.getCurrent();
        const std::string path = NodeUtils::nodePath(*child, this->parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
        it.next();
    }
 
    return result.release();
}

References ParameterPool::copyToExternalPool(), NodeIterator< Strategy >::first(), NodeIterator< Strategy >::getCurrent(), NodeIterator< Strategy >::isDone(), NodeIterator< Strategy >::next(), NodeUtils::nodePath(), IParameterized::parameterPool(), and INode::parent().

Referenced by ParticleDistribution::generateParticles(), runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

parameterPool()

ParameterPool* IParameterized::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 38 of file IParameterized.h.

{ return m_pool.get(); } // has non-const usages!

References IParameterized::m_pool.

Referenced by pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), INode::createParameterTree(), INode::INode(), IParameterized::IParameterized(), anonymous_namespace{NodeUtils.cpp}::poolToString(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParameterized::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 40 of file IParameterized.cpp.

{
    std::ostringstream result;
    std::unique_ptr<ParameterPool> P_pool(createParameterTree());
    result << *P_pool << "\n";
    return result.str();
}

References IParameterized::createParameterTree().

Here is the call graph for this function:

registerParameter()

RealParameter & IParameterized::registerParameter ( const std::string &  name, double *  parpointer  )

inherited

Definition at line 48 of file IParameterized.cpp.

{
    return m_pool->addParameter(
        new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
}

References IParameterized::getName(), IParameterized::m_pool, and IParameterized::onChange().

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), CylindersInBABuilder::CylindersInBABuilder(), DetectionProperties::DetectionProperties(), HexagonalLattice::HexagonalLattice(), IInterferenceFunction::IInterferenceFunction(), INode::INode(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::registerVector(), ParticleLayout::registerWeight(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), Lattice2D::setRotationEnabled(), SquareLattice::SquareLattice(), and TriangularRippleBuilder::TriangularRippleBuilder().

Here is the call graph for this function:

registerVector()

void IParameterized::registerVector ( const std::string &  base_name, kvector_t *  p_vec, const std::string &  units = "nm"  )

inherited

Definition at line 54 of file IParameterized.cpp.

{
    registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
    registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
    registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
}

References IParameterized::registerParameter(), RealParameter::setUnit(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice::registerBasisVectors(), and IParticle::registerPosition().

Here is the call graph for this function:

setParameterValue()

void IParameterized::setParameterValue ( const std::string &  name, double  value  )

inherited

Definition at line 62 of file IParameterized.cpp.

{
    if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
        m_pool->setParameterValue(name, value);
    } else {
        std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
        if (name.find('*') != std::string::npos)
            P_pool->setMatchedParametersValue(name, value);
        else
            P_pool->setParameterValue(name, value);
    }
}

References IParameterized::createParameterTree(), IParameterized::m_pool, and ParameterPool::setMatchedParametersValue().

Referenced by AsymRippleBuilder::buildSample(), and IParameterized::setVectorValue().

Here is the call graph for this function:

setVectorValue()

void IParameterized::setVectorValue ( const std::string &  base_name, kvector_t  value  )

inherited

Definition at line 75 of file IParameterized.cpp.

{
    setParameterValue(XComponentName(base_name), value.x());
    setParameterValue(YComponentName(base_name), value.y());
    setParameterValue(ZComponentName(base_name), value.z());
}

References IParameterized::setParameterValue(), BasicVector3D< T >::x(), IParameterized::XComponentName(), BasicVector3D< T >::y(), IParameterized::YComponentName(), BasicVector3D< T >::z(), and IParameterized::ZComponentName().

Here is the call graph for this function:

parameter()

RealParameter * IParameterized::parameter ( const std::string &  name ) const

inherited

Returns parameter with given 'name'.

Definition at line 83 of file IParameterized.cpp.

{
    return m_pool->parameter(name);
}

References IParameterized::m_pool.

Referenced by DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), IParticle::registerAbundance(), Lattice::registerBasisVectors(), ParticleLayout::registerParticleDensity(), IParticle::registerPosition(), Layer::registerThickness(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

onChange()

virtual void IParameterized::onChange ( )

inlinevirtualinherited

Action to be taken in inherited class when a parameter has changed.

Reimplemented in IProfileRipple, FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, ISawtoothRipple, ICosineRipple, IProfileRectangularRipple, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorTruncatedCube, FormFactorTetrahedron, FormFactorPyramid, FormFactorPrism6, FormFactorPrism3, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorIcosahedron, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDodecahedron, FormFactorCylinder, FormFactorCuboctahedron, FormFactorCone6, FormFactorCone, FormFactorCantellatedCube, FormFactorBox, FormFactorAnisoPyramid, InterferenceFunction3DLattice, InterferenceFunction2DLattice, Lattice, and Lattice2D.

Definition at line 58 of file IParameterized.h.

{}

Referenced by Lattice2D::onChange(), and IParameterized::registerParameter().

removeParameter()

void IParameterized::removeParameter ( const std::string &  name )

inherited

Definition at line 88 of file IParameterized.cpp.

{
    m_pool->removeParameter(name);
}

References IParameterized::m_pool.

Referenced by IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::removeVector(), and Lattice2D::setRotationEnabled().

removeVector()

void IParameterized::removeVector ( const std::string &  base_name )

inherited

Definition at line 93 of file IParameterized.cpp.

{
    removeParameter(XComponentName(base_name));
    removeParameter(YComponentName(base_name));
    removeParameter(ZComponentName(base_name));
}

References IParameterized::removeParameter(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

XComponentName()

std::string IParameterized::XComponentName ( const std::string &  base_name )

staticinherited

Definition at line 100 of file IParameterized.cpp.

{
    return base_name + "X";
}

Referenced by Lattice::registerBasisVectors(), IParticle::registerPosition(), IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

YComponentName()

std::string IParameterized::YComponentName ( const std::string &  base_name )

staticinherited

Definition at line 105 of file IParameterized.cpp.

{
    return base_name + "Y";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

ZComponentName()

std::string IParameterized::ZComponentName ( const std::string &  base_name )

staticinherited

Definition at line 110 of file IParameterized.cpp.

{
    return base_name + "Z";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

setName()

void IParameterized::setName ( const std::string &  name )

inlineinherited

Definition at line 68 of file IParameterized.h.

{ m_name = name; }

References IParameterized::m_name.

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), Layer::clone(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorBAPol::FormFactorBAPol(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorDWBA::FormFactorDWBA(), FormFactorDWBAPol::FormFactorDWBAPol(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice::HexagonalLattice(), IDetector::IDetector(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), INode::INode(), Instrument::Instrument(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DLattice::InterferenceFunction2DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunction2DSuperLattice::InterferenceFunction2DSuperLattice(), InterferenceFunction3DLattice::InterferenceFunction3DLattice(), InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice(), InterferenceFunctionFinite3DLattice::InterferenceFunctionFinite3DLattice(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionNone::InterferenceFunctionNone(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), ISampleBuilder::ISampleBuilder(), IsGISAXSDetector::IsGISAXSDetector(), Lattice::Lattice(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), Beam::operator=(), SampleBuilderNode::operator=(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), SampleBuilderNode::reset(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SampleBuilderNode::setSBN(), SphericalDetector::SphericalDetector(), and SquareLattice::SquareLattice().

getName()

const std::string& IParameterized::getName ( ) const

inlineinherited

Definition at line 69 of file IParameterized.h.

{ return m_name; }

References IParameterized::m_name.

Referenced by Beam::Beam(), Layer::clone(), IFormFactorBorn::computeSlicingEffects(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), INode::copyNumber(), IParameterized::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineFormFactors(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), IDetector::IDetector(), Instrument::Instrument(), IParameterized::IParameterized(), Beam::operator=(), SampleBuilderNode::operator=(), anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), IParameterized::registerParameter(), SampleBuilderNode::SampleBuilderNode(), and IFormFactor::sliceFormFactor().

Friends And Related Function Documentation

MPISimulation

friend class MPISimulation

friend

Definition at line 103 of file Simulation.h.

Member Data Documentation

m_options

SimulationOptions Simulation::m_options

private

Definition at line 152 of file Simulation.h.

Referenced by getOptions(), options(), runSimulation(), runSingleSimulation(), and setOptions().

m_progress

ProgressHandler Simulation::m_progress

private

Definition at line 153 of file Simulation.h.

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

m_sample_provider

SampleProvider Simulation::m_sample_provider

private

Definition at line 154 of file Simulation.h.

Referenced by getChildren(), initialize(), prepareSimulation(), sample(), setSample(), and setSampleBuilder().

m_distribution_handler

DistributionHandler Simulation::m_distribution_handler

private

Definition at line 155 of file Simulation.h.

Referenced by addParameterDistribution(), getDistributionHandler(), and runSimulation().

m_instrument

Instrument Simulation::m_instrument

private

Definition at line 156 of file Simulation.h.

Referenced by initialize(), instrument(), and setInstrument().

m_background

std::unique_ptr<IBackground> Simulation::m_background

private

Definition at line 157 of file Simulation.h.

Referenced by background(), getChildren(), setBackground(), and Simulation().

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 81 of file INode.h.

Referenced by INode::displayName(), INode::parent(), and INode::setParent().

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 86 of file INode.h.

Referenced by INode::INode().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 87 of file INode.h.

Referenced by INode::INode(), and IFootprintFactor::setWidthRatio().

m_name

std::string IParameterized::m_name

privateinherited

Definition at line 72 of file IParameterized.h.

Referenced by IParameterized::getName(), and IParameterized::setName().

m_pool

std::unique_ptr<ParameterPool> IParameterized::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 73 of file IParameterized.h.

Referenced by IParameterized::createParameterTree(), IParameterized::parameter(), IParameterized::parameterPool(), IParameterized::registerParameter(), IParameterized::removeParameter(), and IParameterized::setParameterValue().

---

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

• /home/www/ba/Core/Simulation/Simulation.h
• /home/www/ba/Core/Simulation/Simulation.cpp