DWBAComputation Class Reference

Description

Provides function that performs a single-threaded DWBA computation for a range of DiffuseElements.

Handles progress counter and interrupts, runs loop over DiffuseElements, delegates all further work to DWBATerm.

Controlled by the multi-threading machinery in ISimulation::runSingleSimulation().

Definition at line 41 of file DWBAComputation.h.

Inheritance diagram for DWBAComputation:

Collaboration diagram for DWBAComputation:

Public Member Functions
	DWBAComputation (const reSample &re_sample, const SimulationOptions &options, ProgressHandler &progress, std::vector< std::unique_ptr< DiffuseElement >>::iterator begin_it, std::vector< std::unique_ptr< DiffuseElement >>::iterator end_it)
	~DWBAComputation () override
void	compute ()
	Calls runProtected(), catches exceptions, sets m_status. More...
std::string	errorMessage () const
bool	isCompleted () const

Protected Member Functions
void	setProgressHandler (ProgressHandler *progress) const
void	stepProgress () const

Protected Attributes
const SimulationOptions &	m_options
ProgressHandler *	m_progress
const reSample &	m_re_sample
ComputationStatus	m_status

Private Member Functions
void	runProtected () override
	Performs a single-threaded DWBA computation for a DiffuseElements in range m_begin_it ... m_end_it. Results are stored in those elements. More...

Private Attributes
std::vector< std::unique_ptr< DiffuseElement > >::iterator	m_begin_it
std::vector< std::unique_ptr< DiffuseElement > >::iterator	m_end_it
const std::vector< std::unique_ptr< const ParticleLayoutContribution > >	m_layout_contribs
std::unique_ptr< DelayedProgressCounter >	m_progress_counter
const std::unique_ptr< const RoughMultiLayerContribution >	m_roughness_contrib
const std::unique_ptr< const GISASSpecularContribution >	m_specular_contrib

Constructor & Destructor Documentation

DWBAComputation()

DWBAComputation::DWBAComputation	(	const reSample &	re_sample,
		const SimulationOptions &	options,
		ProgressHandler &	progress,
		std::vector< std::unique_ptr< DiffuseElement >>::iterator	begin_it,
		std::vector< std::unique_ptr< DiffuseElement >>::iterator	end_it
	)

Definition at line 44 of file DWBAComputation.cpp.

    : IComputation(re_sample, options, progress)
    , m_begin_it(begin_it)
    , m_end_it(end_it)
    , m_specular_contrib(options.includeSpecular() ? new GISASSpecularContribution() : nullptr)
    , m_roughness_contrib(m_re_sample.hasRoughness() ? new RoughMultiLayerContribution(m_re_sample)
                                                     : nullptr)
    , m_layout_contribs(makeLayoutComputation(m_re_sample.layouts(), options,
                                              m_re_sample.containsMagneticMaterial()))
{
}

~DWBAComputation()

DWBAComputation::~DWBAComputation ( )

overridedefault

Member Function Documentation

compute()

void IComputation::compute ( )

inherited

Calls runProtected(), catches exceptions, sets m_status.

Definition at line 41 of file IComputation.cpp.

{
    m_status.setRunning();
    try {
        if (!m_progress->alive())
            return;
        setProgressHandler(m_progress);
 
        runProtected(); // <--- here the main work is done
 
        m_status.setCompleted();
    } catch (const std::exception& ex) {
        m_status.setFailed(ex.what());
    }
}

References ProgressHandler::alive(), IComputation::m_progress, IComputation::m_status, IComputation::runProtected(), ComputationStatus::setCompleted(), ComputationStatus::setFailed(), IComputation::setProgressHandler(), and ComputationStatus::setRunning().

Here is the call graph for this function:

errorMessage()

std::string IComputation::errorMessage ( ) const

inlineinherited

Definition at line 47 of file IComputation.h.

{ return m_status.errorMessage(); }

References ComputationStatus::errorMessage(), and IComputation::m_status.

Here is the call graph for this function:

isCompleted()

bool IComputation::isCompleted ( ) const

inlineinherited

Definition at line 46 of file IComputation.h.

{ return m_status.isCompleted(); }

References ComputationStatus::isCompleted(), and IComputation::m_status.

Here is the call graph for this function:

runProtected()

void DWBAComputation::runProtected ( )

overrideprivatevirtual

Performs a single-threaded DWBA computation for a DiffuseElements in range m_begin_it ... m_end_it. Results are stored in those elements.

Implements IComputation.

Definition at line 66 of file DWBAComputation.cpp.

{
    for (auto it = m_begin_it; it != m_end_it; ++it) {
        if (!m_progress->alive())
            break;
        std::unique_ptr<DiffuseElement>& ele = *it;
 
        const Fluxes fluxes_in = m_re_sample.fluxesIn(ele->getKi());
        const Fluxes fluxes_out = m_re_sample.fluxesOut(ele->meanKf());
        ele->setFluxes(&fluxes_in, &fluxes_out);
 
        for (const auto& contrib : m_layout_contribs)
            contrib->compute(*ele);
 
        if (m_roughness_contrib)
            m_roughness_contrib->compute(*ele);
 
        if (m_specular_contrib)
            m_specular_contrib->compute(*ele);
 
        stepProgress();
    }
}

References ProgressHandler::alive(), reSample::fluxesIn(), reSample::fluxesOut(), m_begin_it, m_end_it, m_layout_contribs, IComputation::m_progress, IComputation::m_re_sample, m_roughness_contrib, m_specular_contrib, and IComputation::stepProgress().

Here is the call graph for this function:

setProgressHandler()

void IComputation::setProgressHandler ( ProgressHandler *  progress ) const

protectedinherited

Definition at line 30 of file IComputation.cpp.

{
    m_progress_counter = std::make_unique<DelayedProgressCounter>(progress, 100);
}

References IComputation::m_progress_counter.

Referenced by IComputation::compute().

stepProgress()

void IComputation::stepProgress ( ) const

protectedinherited

Definition at line 35 of file IComputation.cpp.

{
    if (m_progress_counter)
        m_progress_counter->stepProgress();
}

References IComputation::m_progress_counter.

Referenced by DepthProbeComputation::runProtected(), runProtected(), and SpecularComputation::runProtected().

Member Data Documentation

m_begin_it

std::vector<std::unique_ptr<DiffuseElement> >::iterator DWBAComputation::m_begin_it

private

Definition at line 54 of file DWBAComputation.h.

Referenced by runProtected().

m_end_it

std::vector<std::unique_ptr<DiffuseElement> >::iterator DWBAComputation::m_end_it

private

Definition at line 54 of file DWBAComputation.h.

Referenced by runProtected().

m_layout_contribs

const std::vector<std::unique_ptr<const ParticleLayoutContribution> > DWBAComputation::m_layout_contribs

private

Definition at line 57 of file DWBAComputation.h.

Referenced by runProtected().

m_options

const SimulationOptions& IComputation::m_options

protectedinherited

Definition at line 54 of file IComputation.h.

m_progress

ProgressHandler* IComputation::m_progress

protectedinherited

Definition at line 55 of file IComputation.h.

Referenced by IComputation::compute(), and runProtected().

m_progress_counter

std::unique_ptr<DelayedProgressCounter> IComputation::m_progress_counter

mutableprivateinherited

Definition at line 62 of file IComputation.h.

Referenced by IComputation::setProgressHandler(), and IComputation::stepProgress().

m_re_sample

const reSample& IComputation::m_re_sample

protectedinherited

Definition at line 53 of file IComputation.h.

Referenced by DepthProbeComputation::runProtected(), runProtected(), and SpecularComputation::runProtected().

m_roughness_contrib

const std::unique_ptr<const RoughMultiLayerContribution> DWBAComputation::m_roughness_contrib

private

Definition at line 56 of file DWBAComputation.h.

Referenced by runProtected().

m_specular_contrib

const std::unique_ptr<const GISASSpecularContribution> DWBAComputation::m_specular_contrib

private

Definition at line 55 of file DWBAComputation.h.

Referenced by runProtected().

m_status

ComputationStatus IComputation::m_status

protectedinherited

Definition at line 56 of file IComputation.h.

Referenced by IComputation::compute(), IComputation::errorMessage(), and IComputation::isCompleted().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Computation/DWBAComputation.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Computation/DWBAComputation.cpp