SpecularComputation Class Reference

Description

Performs a single-threaded specular computation with given sample.

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

Definition at line 32 of file SpecularComputation.h.

Inheritance diagram for SpecularComputation:

Collaboration diagram for SpecularComputation:

Public Member Functions
	SpecularComputation (const reSample &re_sample, const SimulationOptions &options, ProgressHandler &progress, SpecularElementIter begin_it, SpecularElementIter end_it)
	~SpecularComputation () 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 Types
using	SpecularElementIter = std::vector< SpecularElement >::iterator

Private Member Functions
void	runProtected () override
	Runs computation. May throw. To be called from run(), which catches exceptions. More...

Private Attributes
const SpecularElementIter	m_begin_it
	these iterators define the span of detector bins this simulation will work on More...
const SpecularElementIter	m_end_it
std::unique_ptr< DelayedProgressCounter >	m_progress_counter

Member Typedef Documentation

SpecularElementIter

using SpecularComputation::SpecularElementIter = std::vector<SpecularElement>::iterator

private

Definition at line 33 of file SpecularComputation.h.

Constructor & Destructor Documentation

SpecularComputation()

SpecularComputation::SpecularComputation	(	const reSample &	re_sample,
		const SimulationOptions &	options,
		ProgressHandler &	progress,
		SpecularElementIter	begin_it,
		SpecularElementIter	end_it
	)

Definition at line 23 of file SpecularComputation.cpp.

    : IComputation(std::move(re_sample), options, progress)
    , m_begin_it(begin_it)
    , m_end_it(end_it)
{
}

~SpecularComputation()

SpecularComputation::~SpecularComputation ( )

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 SpecularComputation::runProtected ( )

overrideprivatevirtual

Runs computation. May throw. To be called from run(), which catches exceptions.

Implements IComputation.

Definition at line 35 of file SpecularComputation.cpp.

{
    const SliceStack& slices = m_re_sample.averageSlices();
 
    for (auto it = m_begin_it; it != m_end_it; ++it) {
        SpecularElement& ele = *it;
        if (!ele.isCalculated())
            continue;
        std::vector<complex_t> kz_stack = ele.produceKz(slices);
        if (m_re_sample.polarizing()) {
            const SpinMatrix R = Compute::SpecularMagnetic::topLayerR(slices, kz_stack, true);
 
            const auto& polMatrix = ele.polMatrices().polarizerMatrix();
            const auto& anaMatrix = ele.polMatrices().analyzerMatrix();
 
            const complex_t trace = (polMatrix * R.adjoint() * anaMatrix * R).trace();
 
            ele.setIntensity(std::abs(trace));
        } else {
            const complex_t R = Compute::SpecularScalar::topLayerR(slices, kz_stack);
            ele.setIntensity(std::norm(R));
        }
 
        stepProgress();
    }
}

References PolMatrices::analyzerMatrix(), reSample::averageSlices(), SpecularElement::isCalculated(), m_begin_it, m_end_it, IComputation::m_re_sample, PolMatrices::polarizerMatrix(), reSample::polarizing(), IElement::polMatrices(), SpecularElement::produceKz(), TMath::R(), SpecularElement::setIntensity(), IComputation::stepProgress(), Compute::SpecularScalar::topLayerR(), and Compute::SpecularMagnetic::topLayerR().

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(), DWBAComputation::runProtected(), and runProtected().

Member Data Documentation

m_begin_it

const SpecularElementIter SpecularComputation::m_begin_it

private

these iterators define the span of detector bins this simulation will work on

Definition at line 45 of file SpecularComputation.h.

Referenced by runProtected().

m_end_it

const SpecularElementIter SpecularComputation::m_end_it

private

Definition at line 45 of file SpecularComputation.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 DWBAComputation::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(), DWBAComputation::runProtected(), and 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/SpecularComputation.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Computation/SpecularComputation.cpp