ISimulation Class Reference

Abstract base class of OffSpecularSimulation, GISASSimulation and SpecularSimulation. More...

Inheritance diagram for ISimulation:

Collaboration diagram for ISimulation:

Public Member Functions
	ISimulation ()
	ISimulation (const Beam &beam, const IDetector &detector)
	ISimulation (const Beam &beam, const MultiLayer &sample, const IDetector &detector)
virtual	~ISimulation ()
virtual void	accept (INodeVisitor *visitor) const =0
	Calls the INodeVisitor's visit method. More...
void	addParameterDistribution (const ParameterDistribution &par_distr)
void	addParameterDistribution (const std::string &param_name, const IDistribution1D &distribution, size_t nbr_samples, double sigma_factor=0.0, const RealLimits &limits=RealLimits())
const IBackground *	background () const
Beam &	beam ()
const Beam &	beam () const
virtual ISimulation *	clone () const =0
SimulationResult	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. More...
int	copyNumber (const INode *node) const
	Returns copyNumber of child, which takes into account existence of children with same name. More...
ParameterPool *	createParameterTree () const
	Creates new parameter pool, with all local parameters and those of its children. More...
IDetector &	detector ()
const IDetector &	detector () const
std::string	displayName () const
	Returns display name, composed from the name of node and it's copy number. More...
std::vector< const INode * >	getChildren () const
	Returns a vector of children. More...
IDetector *	getDetector ()
const IDetector *	getDetector () const
const DistributionHandler &	getDistributionHandler () const
const std::string &	getName () const
SimulationOptions &	getOptions ()
const SimulationOptions &	getOptions () const
Instrument &	instrument ()
const Instrument &	instrument () const
virtual size_t	intensityMapSize () const =0
	Returns the total number of the intensity values in the simulation result. More...
virtual void	onChange ()
	Action to be taken in inherited class when a parameter has changed. More...
RealParameter *	parameter (const std::string &name) const
	Returns parameter with given 'name'. More...
ParameterPool *	parameterPool () const
	Returns pointer to the parameter pool. More...
std::string	parametersToString () const
	Returns multiline string representing available parameters. More...
INode *	parent ()
const INode *	parent () const
virtual void	prepareSimulation ()
	Put into a clean state for running a simulation. More...
std::vector< const INode * >	progeny () const
	Returns a vector of all descendants. More...
void	registerChild (INode *node)
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	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
virtual SimulationResult	result () const =0
	Returns the results of the simulation in a format that supports unit conversion and export to numpy arrays. More...
void	runMPISimulation ()
	Run a simulation in a MPI environment. More...
void	runSimulation ()
	Run a simulation, possibly averaged over parameter distributions. More...
const MultiLayer *	sample () const
void	setBackground (const IBackground &bg)
void	setDetectorResolutionFunction (const IResolutionFunction2D &resolution_function)
void	setInstrument (const Instrument &instrument_)
void	setName (const std::string &name)
void	setOptions (const SimulationOptions &options)
void	setParameterValue (const std::string &name, double value)
virtual void	setParent (const INode *newParent)
void	setSample (const MultiLayer &sample)
	The MultiLayer object will not be owned by the ISimulation object. More...
void	setSampleBuilder (const std::shared_ptr< ISampleBuilder > &sample_builder)
void	setTerminalProgressMonitor ()
	Initializes a progress monitor that prints to stdout. More...
void	setVectorValue (const std::string &base_name, kvector_t value)
void	subscribe (ProgressHandler::Callback_t inform)
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
virtual std::string	treeToString () const
	Returns multiline string representing tree structure below the node. More...

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
	ISimulation (const ISimulation &other)
virtual void	initSimulationElementVector ()=0
	Initializes the vector of ISimulation elements. More...
virtual size_t	numberOfSimulationElements () const =0
	Gets the number of elements this simulation needs to calculate. More...
const SimulationOptions &	options () const
ProgressHandler &	progress ()
virtual void	transferResultsToIntensityMap ()
	Creates the appropriate data structure (e.g. More...
virtual void	updateIntensityMap ()

Protected Attributes
const size_t	m_NP
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 >	generateSingleThreadedComputation (size_t start, size_t n_elements)=0
	Generate a single threaded computation for a given range of simulation elements. More...
void	initialize ()
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...
virtual std::vector< double >	rawResults () const =0
void	runSingleSimulation (size_t batch_start, size_t batch_size, double weight=1.0)
	Runs a single simulation with fixed parameter values. More...
virtual void	setRawResults (const std::vector< double > &raw_data)=0
virtual void	validateParametrization (const ParameterDistribution &) const
	Checks the distribution validity for simulation. More...

Private Attributes
std::unique_ptr< IBackground >	m_background
DistributionHandler	m_distribution_handler
Instrument	m_instrument
std::string	m_name
SimulationOptions	m_options
const INode *	m_parent {nullptr}
std::unique_ptr< ParameterPool >	m_pool
	parameter pool (kind of pointer-to-implementation) More...
ProgressHandler	m_progress
SampleProvider	m_sample_provider

Friends
class	MPISimulation

Detailed Description

Abstract 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 38 of file ISimulation.h.

Constructor & Destructor Documentation

ISimulation() [1/4]

ISimulation::ISimulation	(	const Beam &	beam,
		const MultiLayer &	sample,
		const IDetector &	detector
	)

Definition at line 116 of file ISimulation.cpp.

    : m_instrument(beam, detector)
{
    setSample(sample);
    initialize();
}

References initialize(), sample(), and setSample().

Here is the call graph for this function:

ISimulation() [2/4]

ISimulation::ISimulation

(

)

Definition at line 130 of file ISimulation.cpp.

{
    initialize();
}

References initialize().

Here is the call graph for this function:

~ISimulation()

ISimulation::~ISimulation ( )

virtualdefault

ISimulation() [3/4]

ISimulation::ISimulation	(	const Beam &	beam,
		const IDetector &	detector
	)

Definition at line 124 of file ISimulation.cpp.

                                                                    : m_instrument(beam, detector)
{
    initialize();
}

References initialize().

Here is the call graph for this function:

ISimulation() [4/4]

ISimulation::ISimulation ( const ISimulation &  other )

protected

Definition at line 135 of file ISimulation.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

accept()

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

pure virtualinherited

Calls the INodeVisitor's visit method.

Implemented in FormFactorDecoratorMaterial, FormFactorWeighted, FormFactorCrystal, FormFactorCoreShell, Lattice3D, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceFunctionHardDisk, InterferenceFunctionFinite3DLattice, InterferenceFunctionFinite2DLattice, InterferenceFunction3DLattice, InterferenceFunction2DSuperLattice, InterferenceFunction2DParaCrystal, InterferenceFunction2DLattice, InterferenceFunction1DLattice, SphericalDetector, SpecularDetector1D, FootprintSquare, FootprintGauss, Beam, OffSpecularSimulation, GISASSimulation, PoissonNoiseBackground, ConstantBackground, FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, FormFactorDecoratorRotation, FormFactorDecoratorPositionFactor, SampleProvider, SampleBuilderNode, ParticleDistribution, ParticleCoreShell, ParticleComposition, Particle, MesoCrystal, Crystal, MultiLayer, Layer, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, 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, FormFactorBarLorentz, FormFactorBarGauss, FormFactorAnisoPyramid, FTDistribution2DVoigt, FTDistribution2DCone, FTDistribution2DGate, FTDistribution2DGauss, FTDistribution2DCauchy, FTDistribution1DVoigt, FTDistribution1DCosine, FTDistribution1DTriangle, FTDistribution1DGate, FTDistribution1DGauss, FTDistribution1DCauchy, FTDecayFunction2DVoigt, FTDecayFunction2DGauss, FTDecayFunction2DCauchy, FTDecayFunction1DVoigt, FTDecayFunction1DTriangle, FTDecayFunction1DGauss, FTDecayFunction1DCauchy, InterferenceFunctionTwin, InterferenceFunctionRadialParaCrystal, InterferenceFunctionNone, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, ConvolutionDetectorResolution, Instrument, RectangularDetector, IsGISAXSDetector, DetectionProperties, SpecularSimulation, DepthProbeSimulation, LayerRoughness, LayerInterface, RotationEuler, RotationZ, RotationY, RotationX, IdentityRotation, and IAbstractParticle.

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 272 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	(	const std::string &	param_name,
		const IDistribution1D &	distribution,
		size_t	nbr_samples,
		double	sigma_factor = 0.0,
		const RealLimits &	limits = RealLimits()
	)

Definition at line 264 of file ISimulation.cpp.

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

Referenced by StandardSimulations::MiniGISASBeamDivergence(), and TransformToDomain::setBeamDistribution().

background()

const IBackground* ISimulation::background ( ) const

inline

Definition at line 74 of file ISimulation.h.

{ return m_background.get(); }

References m_background.

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

beam() [1/2]

Beam& ISimulation::beam ( )

inline

Definition at line 58 of file ISimulation.h.

{ return m_instrument.beam(); }

References Instrument::beam(), and m_instrument.

Referenced by StandardSimulations::BasicGISAS00(), StandardSimulations::BasicPolarizedGISAS(), DepthProbeSimulation::createUnitConverter(), OffSpecularSimulation::createUnitConverter(), DepthProbeSimulation::generateSimulationElements(), ISimulation2D::generateSimulationElements(), DepthProbeSimulation::initialize(), DepthProbeSimulation::initSimulationElementVector(), GISASSimulation::initSimulationElementVector(), OffSpecularSimulation::initSimulationElementVector(), StandardSimulations::MaxiGISAS00(), StandardSimulations::MiniGISASPolarizationMM(), StandardSimulations::MiniGISASPolarizationMP(), StandardSimulations::MiniGISASPolarizationPM(), StandardSimulations::MiniGISASPolarizationPP(), DepthProbeSimulation::normalize(), ISimulation2D::normalize(), SpecularSimulation::normalize(), OffSpecularSimulation::result(), DepthProbeSimulation::setBeamParameters(), TransformFromDomain::setGISASBeamItem(), TransformFromDomain::setOffSpecularBeamItem(), and TransformFromDomain::setSpecularBeamItem().

Here is the call graph for this function:

beam() [2/2]

const Beam& ISimulation::beam ( ) const

inline

Definition at line 59 of file ISimulation.h.

{ return m_instrument.beam(); }

References Instrument::beam(), and m_instrument.

Here is the call graph for this function:

clone()

virtual ISimulation* ISimulation::clone ( ) const

pure virtual

Implements ICloneable.

Implemented in ISimulation2D, SpecularSimulation, OffSpecularSimulation, GISASSimulation, and DepthProbeSimulation.

Referenced by GUIObjectBuilder::populateSampleModelFromSim().

convertData()

SimulationResult ISimulation::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 308 of file ISimulation.cpp.

{
    auto converter = UnitConverterUtils::createConverter(*this);
    auto roi_data = UnitConverterUtils::createOutputData(*converter, converter->defaultUnits());
 
    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(), detector(), SimulationAreaIterator::detectorIndex(), OutputData< T >::getRawDataVector(), IDetector::iterate(), and SimulationAreaIterator::roiIndex().

Here is the call graph for this function:

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 94 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(), IParametricComponent::getName(), and INode::parent().

Referenced by INode::displayName().

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

Definition at line 126 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    for (const INode* child : progeny()) {
        const std::string path = NodeUtils::nodePath(child, parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
    }
 
    return result.release();
}

References NodeUtils::nodePath(), INode::parent(), and INode::progeny().

Referenced by runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecularSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

detector() [1/2]

IDetector& ISimulation::detector ( )

inline

Definition at line 63 of file ISimulation.h.

{ return m_instrument.detector(); }

References Instrument::detector(), and m_instrument.

Referenced by SpecularSimulation::SpecularSimulation(), StandardSimulations::BasicGISAS00(), StandardSimulations::BasicPolarizedGISAS(), OffSpecularSimulation::checkInitialization(), convertData(), ISimulation2D::generateSimulationElements(), ISimulation2D::generateSingleThreadedComputation(), SpecularSimulation::generateSingleThreadedComputation(), GISASSimulation::intensityMapSize(), OffSpecularSimulation::intensityMapSize(), StandardSimulations::MaxiGISAS00(), StandardSimulations::MiniGISASPolarizationMM(), StandardSimulations::MiniGISASPolarizationMP(), StandardSimulations::MiniGISASPolarizationPM(), StandardSimulations::MiniGISASPolarizationPP(), GISASSimulation::prepareSimulation(), SpecularSimulation::prepareSimulation(), GISASSimulation::result(), DepthProbeSimulation::setBeamParameters(), ISimulation2D::setDetector(), setDetectorResolutionFunction(), SpecularSimulation::setScan(), OffSpecularSimulation::transferDetectorImage(), OffSpecularSimulation::transferResultsToIntensityMap(), and OffSpecularSimulation::updateIntensityMap().

Here is the call graph for this function:

detector() [2/2]

const IDetector& ISimulation::detector ( ) const

inline

Definition at line 64 of file ISimulation.h.

{ return m_instrument.detector(); }

References Instrument::detector(), and m_instrument.

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 115 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(), IParametricComponent::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath().

Here is the call graph for this function:

generateSingleThreadedComputation()

virtual std::unique_ptr<IComputation> ISimulation::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, ISimulation2D, and DepthProbeSimulation.

Referenced by runSingleSimulation().

getChildren()

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

virtual

Returns a vector of children.

Reimplemented from INode.

Definition at line 254 of file ISimulation.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:

getDetector() [1/2]

IDetector* ISimulation::getDetector ( )

inline

Definition at line 61 of file ISimulation.h.

{ return m_instrument.getDetector(); }

References Instrument::getDetector(), and m_instrument.

Referenced by ISimulation2D::detector2D(), TransformFromDomain::setDetector(), and TransformFromDomain::setDetectorMasks().

Here is the call graph for this function:

getDetector() [2/2]

const IDetector* ISimulation::getDetector ( ) const

inline

Definition at line 62 of file ISimulation.h.

{ return m_instrument.getDetector(); }

References Instrument::getDetector(), and m_instrument.

Here is the call graph for this function:

getDistributionHandler()

const DistributionHandler& ISimulation::getDistributionHandler ( ) const

inline

Definition at line 88 of file ISimulation.h.

{ return m_distribution_handler; }

References m_distribution_handler.

Referenced by TransformFromDomain::setGISASBeamItem().

getName()

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

inlineinherited

Definition at line 70 of file IParametricComponent.h.

{ return m_name; }

References IParametricComponent::m_name.

Referenced by Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), IDetector::IDetector(), Instrument::Instrument(), IParametricComponent::IParametricComponent(), SampleBuilderNode::SampleBuilderNode(), Layer::clone(), INode::copyNumber(), IParametricComponent::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), Beam::operator=(), SampleBuilderNode::operator=(), GUIObjectBuilder::populateInstrumentModel(), PyImportAssistant::populateModels(), GUIDomainSampleVisitor::populateSampleModel(), IParametricComponent::registerParameter(), IFormFactor::sliceFormFactor(), and GUIDomainSampleVisitor::visit().

getOptions() [1/2]

SimulationOptions& ISimulation::getOptions ( )

inline

Definition at line 92 of file ISimulation.h.

{ return m_options; }

References m_options.

getOptions() [2/2]

const SimulationOptions& ISimulation::getOptions ( ) const

inline

Definition at line 91 of file ISimulation.h.

{ return m_options; }

References m_options.

Referenced by StandardSimulations::MiniGISASMonteCarlo(), StandardSimulations::MiniGISASSpecularPeak(), GUIObjectBuilder::populateDocumentModel(), and TransformToDomain::setSimulationOptions().

initialize()

void ISimulation::initialize ( )

private

Definition at line 151 of file ISimulation.cpp.

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

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

Referenced by ISimulation().

Here is the call graph for this function:

initSimulationElementVector()

virtual void ISimulation::initSimulationElementVector ( )

protectedpure virtual

Initializes the vector of ISimulation elements.

Implemented in SpecularSimulation, OffSpecularSimulation, GISASSimulation, and DepthProbeSimulation.

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

instrument() [1/2]

Instrument& ISimulation::instrument ( )

inline

Definition at line 56 of file ISimulation.h.

{ return m_instrument; }

References m_instrument.

instrument() [2/2]

const Instrument& ISimulation::instrument ( ) const

inline

Definition at line 55 of file ISimulation.h.

{ return m_instrument; }

References m_instrument.

Referenced by SpecularSimulation::SpecularSimulation(), getChildren(), SpecularSimulation::initialize(), SpecularSimulation::initSimulationElementVector(), GUIObjectBuilder::populateInstrumentModel(), GISASSimulation::prepareSimulation(), SpecularSimulation::prepareSimulation(), GISASSimulation::result(), DepthProbeSimulation::setBeamParameters(), OffSpecularSimulation::setBeamParameters(), GISASSimulation::setBeamParameters(), ISimulation2D::setDetector(), and SpecularSimulation::setScan().

intensityMapSize()

virtual size_t ISimulation::intensityMapSize ( ) const

pure virtual

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

Implemented in SpecularSimulation, OffSpecularSimulation, GISASSimulation, and DepthProbeSimulation.

moveDataFromCache()

virtual void ISimulation::moveDataFromCache ( )

privatepure virtual

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by runSimulation().

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

numberOfSimulationElements()

virtual size_t ISimulation::numberOfSimulationElements ( ) const

protectedpure virtual

Gets the number of elements this simulation needs to calculate.

Implemented in SpecularSimulation, OffSpecularSimulation, ISimulation2D, and DepthProbeSimulation.

Referenced by runSimulation().

onChange()

virtual void IParametricComponent::onChange ( )

inlinevirtualinherited

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

Reimplemented in IProfileRipple, Lattice3D, InterferenceFunction3DLattice, InterferenceFunction2DLattice, 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, and Lattice2D.

Definition at line 59 of file IParametricComponent.h.

{}

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

options()

const SimulationOptions& ISimulation::options ( ) const

inlineprotected

Definition at line 124 of file ISimulation.h.

{ return m_options; }

References m_options.

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

parameter()

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

inherited

Returns parameter with given 'name'.

Definition at line 86 of file IParametricComponent.cpp.

{
    return m_pool->parameter(name);
}

References IParametricComponent::m_pool, and RealSpace::Particles::name().

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

Here is the call graph for this function:

parameterPool()

ParameterPool* IParametricComponent::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 39 of file IParametricComponent.h.

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

References IParametricComponent::m_pool.

Referenced by INode::INode(), IParametricComponent::IParametricComponent(), pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParametricComponent::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 43 of file IParametricComponent.cpp.

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

References IParametricComponent::createParameterTree().

Here is the call graph for this function:

parent() [1/2]

INode * INode::parent ( )

inherited

Definition at line 89 of file INode.cpp.

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

References INode::m_parent.

parent() [2/2]

const INode * INode::parent ( ) const

inherited

Definition at line 84 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

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

prepareSimulation()

void ISimulation::prepareSimulation ( )

virtual

Put into a clean state for running a simulation.

Reimplemented in SpecularSimulation, OffSpecularSimulation, ISimulation2D, and GISASSimulation.

Definition at line 182 of file ISimulation.cpp.

{
    m_sample_provider.updateSample();
    if (!MultiLayerUtils::ContainsCompatibleMaterials(*m_sample_provider.sample()))
        throw std::runtime_error(
            "Error in ISimulation::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 ISimulation2D::prepareSimulation(), SpecularSimulation::prepareSimulation(), and runSimulation().

Here is the call graph for this function:

progeny()

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

inherited

Returns a vector of all descendants.

Definition at line 68 of file INode.cpp.

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

References INode::getChildren().

Referenced by INode::createParameterTree(), and ParticleDistribution::generateParticles().

Here is the call graph for this function:

progress()

ProgressHandler& ISimulation::progress ( )

inlineprotected

Definition at line 125 of file ISimulation.h.

{ return m_progress; }

References m_progress.

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

rawResults()

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

privatepure virtual

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 57 of file INode.cpp.

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

References ASSERT, and INode::setParent().

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

Here is the call graph for this function:

registerParameter()

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

inherited

Definition at line 51 of file IParametricComponent.cpp.

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

References IParametricComponent::getName(), IParametricComponent::m_pool, RealSpace::Particles::name(), and IParametricComponent::onChange().

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

Here is the call graph for this function:

registerVector()

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

inherited

Definition at line 57 of file IParametricComponent.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 ModelView::Utils::base_name(), IParametricComponent::registerParameter(), RealParameter::setUnit(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice3D::initialize(), and IParticle::registerPosition().

Here is the call graph for this function:

removeParameter()

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

inherited

Definition at line 91 of file IParametricComponent.cpp.

{
    m_pool->removeParameter(name);
}

References IParametricComponent::m_pool, and RealSpace::Particles::name().

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

Here is the call graph for this function:

removeVector()

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

inherited

Definition at line 96 of file IParametricComponent.cpp.

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

References ModelView::Utils::base_name(), IParametricComponent::removeParameter(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

result()

virtual SimulationResult ISimulation::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, OffSpecularSimulation, GISASSimulation, and DepthProbeSimulation.

Referenced by ISimulation2D::generateSimulationElements(), getChildren(), ISimulation2D::rawResults(), and JobItemUtils::setResults().

runMPISimulation()

void ISimulation::runMPISimulation

(

)

Run a simulation in a MPI environment.

Definition at line 226 of file ISimulation.cpp.

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

References MPISimulation::runSimulation().

Here is the call graph for this function:

runSimulation()

void ISimulation::runSimulation

(

)

Run a simulation, possibly averaged over parameter distributions.

Run simulation with possible averaging over parameter distributions.

Definition at line 193 of file ISimulation.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;
 
    if(param_combinations == 1)
        runSingleSimulation(batch_start, batch_size, 1.);
    else{
        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(), DistributionHandler::getTotalNumberOfSamples(), m_distribution_handler, m_options, m_progress, moveDataFromCache(), numberOfSimulationElements(), prepareSimulation(), ProgressHandler::reset(), runSingleSimulation(), ProgressHandler::setExpectedNTicks(), DistributionHandler::setParameterToMeans(), DistributionHandler::setParameterValues(), and transferResultsToIntensityMap().

Referenced by JobWorker::start().

Here is the call graph for this function:

runSingleSimulation()

void ISimulation::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 280 of file ISimulation.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(computations);
 
    normalize(batch_start, batch_size);
    addBackgroundIntensity(batch_start, batch_size);
    addDataToCache(weight);
}

References addBackgroundIntensity(), addDataToCache(), ASSERT, generateSingleThreadedComputation(), SimulationOptions::getNumberOfThreads(), initSimulationElementVector(), m_options, and normalize().

Referenced by runSimulation().

Here is the call graph for this function:

sample()

const MultiLayer * ISimulation::sample

(

)

const

Definition at line 238 of file ISimulation.cpp.

{
    return m_sample_provider.sample();
}

References m_sample_provider, and SampleProvider::sample().

Referenced by ISimulation(), DepthProbeSimulation::generateSingleThreadedComputation(), ISimulation2D::generateSingleThreadedComputation(), SpecularSimulation::generateSingleThreadedComputation(), setSample(), and DepthProbeSimulation::validityCheck().

Here is the call graph for this function:

setBackground()

void ISimulation::setBackground

(

const IBackground &

bg

)

Definition at line 248 of file ISimulation.cpp.

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

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

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

Here is the call graph for this function:

setDetectorResolutionFunction()

void ISimulation::setDetectorResolutionFunction

(

const IResolutionFunction2D &

resolution_function

)

Definition at line 177 of file ISimulation.cpp.

{
    detector().setResolutionFunction(resolution_function);
}

References detector(), and IDetector::setResolutionFunction().

Referenced by StandardSimulations::MiniGISASDetectorResolution().

Here is the call graph for this function:

setInstrument()

void ISimulation::setInstrument

(

const Instrument &

instrument_

)

Definition at line 158 of file ISimulation.cpp.

{
    m_instrument = instrument_;
    updateIntensityMap();
}

References m_instrument, and updateIntensityMap().

Here is the call graph for this function:

setName()

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

inlineinherited

Definition at line 69 of file IParametricComponent.h.

{ m_name = name; }

References IParametricComponent::m_name, and RealSpace::Particles::name().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice2D::HexagonalLattice2D(), IDetector::IDetector(), 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(), Lattice3D::Lattice3D(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SphericalDetector::SphericalDetector(), SquareLattice2D::SquareLattice2D(), Layer::clone(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecularSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), Beam::operator=(), SampleBuilderNode::operator=(), SampleBuilderNode::reset(), and SampleBuilderNode::setSBN().

Here is the call graph for this function:

setOptions()

void ISimulation::setOptions ( const SimulationOptions &  options )

inline

Definition at line 90 of file ISimulation.h.

{ m_options = options; }

References m_options, and options().

Here is the call graph for this function:

setParameterValue()

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

inherited

Definition at line 65 of file IParametricComponent.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 IParametricComponent::createParameterTree(), IParametricComponent::m_pool, RealSpace::Particles::name(), and ParameterPool::setMatchedParametersValue().

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

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 79 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

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

setRawResults()

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

privatepure virtual

Implemented in SpecularSimulation, ISimulation2D, and DepthProbeSimulation.

setSample()

void ISimulation::setSample

(

const MultiLayer &

sample

)

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

Definition at line 233 of file ISimulation.cpp.

{
    m_sample_provider.setSample(sample);
}

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

Referenced by ISimulation().

Here is the call graph for this function:

setSampleBuilder()

void ISimulation::setSampleBuilder

(

const std::shared_ptr< ISampleBuilder > &

sample_builder

)

Definition at line 243 of file ISimulation.cpp.

{
    m_sample_provider.setBuilder(sample_builder);
}

References m_sample_provider, and SampleProvider::setBuilder().

Here is the call graph for this function:

setTerminalProgressMonitor()

void ISimulation::setTerminalProgressMonitor

(

)

Initializes a progress monitor that prints to stdout.

Definition at line 166 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, and ProgressHandler::subscribe().

Here is the call graph for this function:

setVectorValue()

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

inherited

Definition at line 78 of file IParametricComponent.cpp.

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

References ModelView::Utils::base_name(), IParametricComponent::setParameterValue(), BasicVector3D< T >::x(), IParametricComponent::XComponentName(), BasicVector3D< T >::y(), IParametricComponent::YComponentName(), BasicVector3D< T >::z(), and IParametricComponent::ZComponentName().

Here is the call graph for this function:

subscribe()

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

inline

Definition at line 94 of file ISimulation.h.

{ m_progress.subscribe(inform); }

References m_progress, and ProgressHandler::subscribe().

Referenced by JobWorker::start().

Here is the call graph for this function:

transferResultsToIntensityMap()

virtual void ISimulation::transferResultsToIntensityMap ( )

inlineprotectedvirtual

Creates the appropriate data structure (e.g.

2D intensity map) from the calculated SimulationElement objects

Reimplemented in OffSpecularSimulation.

Definition at line 114 of file ISimulation.h.

{}

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

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 34 of file ICloneable.h.

treeToString()

std::string INode::treeToString ( ) const

virtualinherited

Returns multiline string representing tree structure below the node.

Definition at line 52 of file INode.cpp.

{
    return NodeUtils::nodeToString(this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

updateIntensityMap()

virtual void ISimulation::updateIntensityMap ( )

inlineprotectedvirtual

Reimplemented in OffSpecularSimulation.

Definition at line 119 of file ISimulation.h.

{}

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

validateParametrization()

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

inlineprivatevirtual

Checks the distribution validity for simulation.

Reimplemented in SpecularSimulation, OffSpecularSimulation, and DepthProbeSimulation.

Definition at line 139 of file ISimulation.h.

{}

Referenced by addParameterDistribution().

XComponentName()

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

staticinherited

Definition at line 103 of file IParametricComponent.cpp.

{
    return base_name + "X";
}

References ModelView::Utils::base_name().

Referenced by Lattice3D::initialize(), IParticle::registerPosition(), IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

YComponentName()

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

staticinherited

Definition at line 108 of file IParametricComponent.cpp.

{
    return base_name + "Y";
}

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

ZComponentName()

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

staticinherited

Definition at line 113 of file IParametricComponent.cpp.

{
    return base_name + "Z";
}

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

Friends And Related Function Documentation

MPISimulation

friend class MPISimulation

friend

Definition at line 102 of file ISimulation.h.

Member Data Documentation

m_background

std::unique_ptr<IBackground> ISimulation::m_background

private

Definition at line 161 of file ISimulation.h.

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

m_distribution_handler

DistributionHandler ISimulation::m_distribution_handler

private

Definition at line 159 of file ISimulation.h.

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

m_instrument

Instrument ISimulation::m_instrument

private

Definition at line 160 of file ISimulation.h.

Referenced by beam(), detector(), getDetector(), initialize(), instrument(), and setInstrument().

m_name

std::string IParametricComponent::m_name

privateinherited

Definition at line 73 of file IParametricComponent.h.

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

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 88 of file INode.h.

Referenced by INode::INode().

m_options

SimulationOptions ISimulation::m_options

private

Definition at line 156 of file ISimulation.h.

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

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 89 of file INode.h.

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

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 83 of file INode.h.

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

m_pool

std::unique_ptr<ParameterPool> IParametricComponent::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 74 of file IParametricComponent.h.

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

m_progress

ProgressHandler ISimulation::m_progress

private

Definition at line 157 of file ISimulation.h.

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

m_sample_provider

SampleProvider ISimulation::m_sample_provider

private

Definition at line 158 of file ISimulation.h.

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

---

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

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