DepthProbeComputation Class Reference

Description

Performs a single-threaded depth probe computation with given sample.

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

Definition at line 33 of file DepthProbeComputation.h.

Inheritance diagram for DepthProbeComputation:

Collaboration diagram for DepthProbeComputation:

Public Member Functions
	DepthProbeComputation (const reSample &re_sample, const SimulationOptions &options, ProgressHandler &progress, DepthProbeElementIter begin_it, DepthProbeElementIter end_it)
	~DepthProbeComputation () 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	DepthProbeElementIter = std::vector< DepthProbeElement >::iterator

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

Private Attributes
DepthProbeElementIter	m_begin_it
DepthProbeElementIter	m_end_it
std::unique_ptr< DelayedProgressCounter >	m_progress_counter

Member Typedef Documentation

DepthProbeElementIter

using DepthProbeComputation::DepthProbeElementIter = std::vector<DepthProbeElement>::iterator

private

Definition at line 34 of file DepthProbeComputation.h.

Constructor & Destructor Documentation

DepthProbeComputation()

DepthProbeComputation::DepthProbeComputation	(	const reSample &	re_sample,
		const SimulationOptions &	options,
		ProgressHandler &	progress,
		DepthProbeElementIter	begin_it,
		DepthProbeElementIter	end_it
	)

Definition at line 23 of file DepthProbeComputation.cpp.

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

~DepthProbeComputation()

DepthProbeComputation::~DepthProbeComputation ( )

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

overrideprivatevirtual

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

Implements IComputation.

Definition at line 36 of file DepthProbeComputation.cpp.

{
    for (auto it = m_begin_it; it != m_end_it; ++it) {
        DepthProbeElement& ele = *it;
        if (!ele.isCalculated())
            continue;
 
        const IAxis& z_positions = *ele.getZPositions();
        const size_t n_z = z_positions.size();
        const size_t n_layers = m_re_sample.numberOfSlices();
        size_t start_z_ind = n_z;
        std::valarray<double> intensities(0.0, n_z);
 
        Fluxes fluxes = m_re_sample.fluxesIn(ele.getKi());
 
        double z_layer_bottom(0.0);
        double z_layer_top(0.0);
        for (size_t i_layer = 0; i_layer < n_layers && start_z_ind != 0; ++i_layer) {
            z_layer_bottom = m_re_sample.sliceBottomZ(i_layer);
            z_layer_top = i_layer ? m_re_sample.sliceTopZ(i_layer) : 0;
 
            // get R & T coefficients for current layer
            const auto* flux = dynamic_cast<const ScalarFlux*>(fluxes[i_layer].get());
            ASSERT(flux);
            const complex_t R = flux->getScalarR();
            const complex_t T = flux->getScalarT();
            const complex_t kz_out = flux->getScalarKz();
            const complex_t kz_in = -kz_out;
 
            // Compute intensity for z's of the layer
            size_t ip1_z = start_z_ind;
            for (; ip1_z > 0; --ip1_z) {
                const size_t i_z = ip1_z - 1;
                if (i_layer + 1 != n_layers && z_positions[i_z] <= z_layer_bottom)
                    break;
                const double z = z_positions[i_z] - z_layer_top;
                intensities[i_z] = std::norm(R * exp_I(kz_out * z) + T * exp_I(kz_in * z));
            }
            start_z_ind = ip1_z;
        }
        ele.setIntensities(std::move(intensities));
 
        stepProgress();
    }
}

References ASSERT, Compute::SpecularMagnetic::fluxes(), reSample::fluxesIn(), DepthProbeElement::getKi(), DepthProbeElement::getZPositions(), DepthProbeElement::isCalculated(), m_begin_it, m_end_it, IComputation::m_re_sample, reSample::numberOfSlices(), TMath::R(), DepthProbeElement::setIntensities(), IAxis::size(), reSample::sliceBottomZ(), reSample::sliceTopZ(), 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 runProtected(), DWBAComputation::runProtected(), and SpecularComputation::runProtected().

Member Data Documentation

m_begin_it

DepthProbeElementIter DepthProbeComputation::m_begin_it

private

Definition at line 45 of file DepthProbeComputation.h.

Referenced by runProtected().

m_end_it

DepthProbeElementIter DepthProbeComputation::m_end_it

private

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