IInterparticleStrategy Class Reference

Description

Abstract base class of DecouplingApproximationStrategy, SSCAStrategy. Provides function 'evaluate' that computes the total scattering intensity from a decorated layer.

Instantiation of child classes takes place in LayoutStrategyBuilder::createStrategy, which is called from ParticleLayoutContribution::eval.

Definition at line 41 of file IInterparticleStrategy.h.

Inheritance diagram for IInterparticleStrategy:

Collaboration diagram for IInterparticleStrategy:

Public Member Functions
	IInterparticleStrategy (const std::vector< std::unique_ptr< const CoherentFFSum >> &weighted_formfactors, const SimulationOptions &sim_params, bool polarized)
virtual	~IInterparticleStrategy ()
double	evaluate (const DiffuseElement &ele) const
	Calculates the intensity for scalar particles/interactions. More...

Protected Attributes
const SimulationOptions	m_options
const std::vector< std::unique_ptr< const CoherentFFSum > > &	m_weighted_formfactors

Private Member Functions
double	evaluate_for_fixed_angles (const double *fractions, size_t dim, const void *params) const
double	evaluateSinglePoint (const DiffuseElement &ele) const
double	MCIntegratedEvaluate (const DiffuseElement &ele) const
	Performs a Monte Carlo integration over the bin for the evaluation of the intensity. More...
virtual double	polarizedCalculation (const DiffuseElement &ele) const =0
	Evaluates the intensity in the polarized case. More...
virtual double	scalarCalculation (const DiffuseElement &ele) const =0
	Evaluates the intensity in the scalar case. More...

Private Attributes
const std::unique_ptr< IntegratorMCMiser< IInterparticleStrategy > >	m_integrator
const bool	m_polarized

Constructor & Destructor Documentation

IInterparticleStrategy()

IInterparticleStrategy::IInterparticleStrategy	(	const std::vector< std::unique_ptr< const CoherentFFSum >> &	weighted_formfactors,
		const SimulationOptions &	sim_params,
		bool	polarized
	)

Definition at line 21 of file IInterparticleStrategy.cpp.

    : m_weighted_formfactors(weighted_formfactors)
    , m_options(sim_params)
    , m_polarized(polarized)
    , m_integrator(
          make_integrator_miser(this, &IInterparticleStrategy::evaluate_for_fixed_angles, 2))
{
    ASSERT(!m_weighted_formfactors.empty());
}

References ASSERT, and m_weighted_formfactors.

~IInterparticleStrategy()

IInterparticleStrategy::~IInterparticleStrategy ( )

virtualdefault

Member Function Documentation

evaluate()

double IInterparticleStrategy::evaluate

(

const DiffuseElement &

ele

)

const

Calculates the intensity for scalar particles/interactions.

Definition at line 35 of file IInterparticleStrategy.cpp.

{
    if (m_options.isIntegrate() && (ele.solidAngle() > 0.0))
        return MCIntegratedEvaluate(ele);
    return evaluateSinglePoint(ele);
}

References evaluateSinglePoint(), SimulationOptions::isIntegrate(), m_options, MCIntegratedEvaluate(), and DiffuseElement::solidAngle().

Here is the call graph for this function:

evaluate_for_fixed_angles()

double IInterparticleStrategy::evaluate_for_fixed_angles ( const double *  fractions, size_t  dim, const void *  params  ) const

private

Definition at line 57 of file IInterparticleStrategy.cpp.

{
    double par0 = fractions[0];
    double par1 = fractions[1];
 
    const auto* pars = static_cast<const DiffuseElement*>(params);
 
    DiffuseElement ele = pars->pointElement(par0, par1);
    return pars->integrationFactor(par0, par1) * evaluateSinglePoint(ele);
}

References evaluateSinglePoint(), DiffuseElement::integrationFactor(), and DiffuseElement::pointElement().

Here is the call graph for this function:

evaluateSinglePoint()

double IInterparticleStrategy::evaluateSinglePoint ( const DiffuseElement &  ele ) const

private

Definition at line 42 of file IInterparticleStrategy.cpp.

{
    if (!m_polarized)
        return scalarCalculation(ele);
    return polarizedCalculation(ele);
}

References m_polarized, polarizedCalculation(), and scalarCalculation().

Referenced by evaluate(), and evaluate_for_fixed_angles().

Here is the call graph for this function:

MCIntegratedEvaluate()

double IInterparticleStrategy::MCIntegratedEvaluate ( const DiffuseElement &  ele ) const

private

Performs a Monte Carlo integration over the bin for the evaluation of the intensity.

Definition at line 50 of file IInterparticleStrategy.cpp.

{
    double min_array[] = {0.0, 0.0};
    double max_array[] = {1.0, 1.0};
    return m_integrator->integrate(min_array, max_array, (void*)&ele, m_options.getMcPoints());
}

References SimulationOptions::getMcPoints(), m_integrator, and m_options.

Referenced by evaluate().

Here is the call graph for this function:

polarizedCalculation()

virtual double IInterparticleStrategy::polarizedCalculation ( const DiffuseElement &  ele ) const

privatepure virtual

Evaluates the intensity in the polarized case.

Implemented in SSCAStrategy, and DecouplingApproximationStrategy.

Referenced by evaluateSinglePoint().

scalarCalculation()

virtual double IInterparticleStrategy::scalarCalculation ( const DiffuseElement &  ele ) const

privatepure virtual

Evaluates the intensity in the scalar case.

Implemented in SSCAStrategy, and DecouplingApproximationStrategy.

Referenced by evaluateSinglePoint().

Member Data Documentation

m_integrator

const std::unique_ptr<IntegratorMCMiser<IInterparticleStrategy> > IInterparticleStrategy::m_integrator

private

Definition at line 66 of file IInterparticleStrategy.h.

Referenced by MCIntegratedEvaluate().

m_options

const SimulationOptions IInterparticleStrategy::m_options

protected

Definition at line 53 of file IInterparticleStrategy.h.

Referenced by evaluate(), and MCIntegratedEvaluate().

m_polarized

const bool IInterparticleStrategy::m_polarized

private

Definition at line 64 of file IInterparticleStrategy.h.

Referenced by evaluateSinglePoint().

m_weighted_formfactors

const std::vector<std::unique_ptr<const CoherentFFSum> >& IInterparticleStrategy::m_weighted_formfactors

protected

Definition at line 52 of file IInterparticleStrategy.h.

Referenced by IInterparticleStrategy(), DecouplingApproximationStrategy::polarizedCalculation(), SSCAStrategy::polarizedCalculation(), DecouplingApproximationStrategy::scalarCalculation(), and SSCAStrategy::scalarCalculation().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Interparticle/IInterparticleStrategy.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Interparticle/IInterparticleStrategy.cpp