reSample Class Reference

Description

Data structure that contains all the necessary data for scattering calculations.

If the usage of average materials is requested, layers and particles are sliced into multiple slices and the average material is calculated for each slice.

Definition at line 41 of file ReSample.h.

Collaboration diagram for reSample:

Public Member Functions
	reSample (const reSample &)=delete
	~reSample ()
const SliceStack &	averageSlices () const
const Slice &	avgeSlice (size_t i) const
bool	containsMagneticMaterial () const
double	crossCorrSpectralFun (R3 kvec, size_t j, size_t k) const
	Fourier transform of the correlation function of roughnesses between the interfaces. More...
Fluxes	fluxesIn (const R3 &k) const
Fluxes	fluxesOut (const R3 &k) const
bool	hasRoughness () const
const std::vector< reLayout > &	layouts () const
size_t	numberOfSlices () const
bool	polarizing () const
	Contains magnetic material, or nonzero magnetic field. More...
const MultiLayer &	sample () const
double	sliceBottomZ (size_t i) const
double	sliceTopZ (size_t i) const

Static Public Member Functions
static reSample	make (const MultiLayer &sample, const SimulationOptions &options, bool forcePolarized=false)
	Factory method that wraps the private constructor. More...

Private Member Functions
	reSample (const MultiLayer &sample, bool polarized, std::vector< reLayout > &&layouts, const SliceStack &refined_stack)

Private Attributes
std::vector< reLayout >	m_layouts
const bool	m_polarized
const MultiLayer &	m_sample
const SliceStack	m_stack

Constructor & Destructor Documentation

reSample() [1/2]

reSample::reSample ( const reSample &  )

delete

Referenced by make().

~reSample()

reSample::~reSample ( )

default

reSample() [2/2]

reSample::reSample ( const MultiLayer &  sample, bool  polarized, std::vector< reLayout > &&  layouts, const SliceStack &  refined_stack  )

private

Definition at line 325 of file ReSample.cpp.

    : m_sample(sample)
    , m_polarized(polarized)
    , m_layouts(std::move(layouts))
    , m_stack(refined_stack)
{
}

Member Function Documentation

averageSlices()

const SliceStack & reSample::averageSlices

(

)

const

Definition at line 341 of file ReSample.cpp.

{
    return m_stack;
}

References m_stack.

Referenced by swigAPI::defaultMaterialProfileLimits(), RoughMultiLayerContribution::get_sum8terms(), swigAPI::materialProfileSLD(), and SpecularComputation::runProtected().

avgeSlice()

const Slice & reSample::avgeSlice

(

size_t

i

)

const

Definition at line 346 of file ReSample.cpp.

{
    return m_stack.at(i);
}

References m_stack.

Referenced by RoughMultiLayerContribution::compute(), RoughMultiLayerContribution::get_refractive_term(), and RoughMultiLayerContribution::get_sum8terms().

containsMagneticMaterial()

bool reSample::containsMagneticMaterial

(

)

const

Definition at line 366 of file ReSample.cpp.

{
    return m_polarized;
}

References m_polarized.

Referenced by polarizing().

crossCorrSpectralFun()

double reSample::crossCorrSpectralFun	(	R3	kvec,
		size_t	j,
		size_t	k
	)		const

Fourier transform of the correlation function of roughnesses between the interfaces.

Definition at line 398 of file ReSample.cpp.

{
    const double xCorrLength = m_sample.crossCorrLength();
    if (xCorrLength <= 0.0)
        return 0.0;
    const double z_j = sliceBottomZ(j);
    const double z_k = sliceBottomZ(k);
    const LayerRoughness* rough_j = m_stack.at(j + 1).topRoughness();
    const LayerRoughness* rough_k = m_stack.at(k + 1).topRoughness();
    if (!rough_j || !rough_k)
        return 0.0;
    const double sigma_j = rough_j->sigma();
    const double sigma_k = rough_k->sigma();
    if (sigma_j <= 0 || sigma_k <= 0)
        return 0.0;
    return 0.5
           * ((sigma_k / sigma_j) * rough_j->spectralFunction(kvec)
              + (sigma_j / sigma_k) * rough_k->spectralFunction(kvec))
           * std::exp(-1 * std::abs(z_j - z_k) / xCorrLength);
}

References MultiLayer::crossCorrLength(), m_sample, m_stack, LayerRoughness::sigma(), sliceBottomZ(), and LayerRoughness::spectralFunction().

Referenced by RoughMultiLayerContribution::compute().

Here is the call graph for this function:

fluxesIn()

Fluxes reSample::fluxesIn

(

const R3 &

k

)

const

Definition at line 384 of file ReSample.cpp.

{
    if (m_polarized)
        return Compute::SpecularMagnetic::fluxes(m_stack, k, true);
    return Compute::SpecularScalar::fluxes(m_stack, k);
}

References Compute::SpecularScalar::fluxes(), Compute::SpecularMagnetic::fluxes(), m_polarized, and m_stack.

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

Here is the call graph for this function:

fluxesOut()

Fluxes reSample::fluxesOut

(

const R3 &

k

)

const

Definition at line 391 of file ReSample.cpp.

{
    if (m_polarized)
        return Compute::SpecularMagnetic::fluxes(m_stack, -k, false);
    return Compute::SpecularScalar::fluxes(m_stack, -k);
}

References Compute::SpecularScalar::fluxes(), Compute::SpecularMagnetic::fluxes(), m_polarized, and m_stack.

Referenced by DWBAComputation::runProtected().

Here is the call graph for this function:

hasRoughness()

bool reSample::hasRoughness

(

)

const

Definition at line 376 of file ReSample.cpp.

{
    for (const auto& slice : m_stack)
        if (slice.topRoughness())
            return true;
    return false;
}

References m_stack, and Slice::topRoughness().

Here is the call graph for this function:

layouts()

const std::vector< reLayout > & reSample::layouts

(

)

const

Definition at line 351 of file ReSample.cpp.

{
    return m_layouts;
}

References m_layouts.

Referenced by make().

make()

reSample reSample::make ( const MultiLayer &  sample, const SimulationOptions &  options, bool  forcePolarized = false  )

static

Factory method that wraps the private constructor.

Definition at line 309 of file ReSample.cpp.

{
    const bool polarized = forcePolarized || sample.isMagnetic() || sample.externalField() != R3();
 
    // slices1: accounting for roughness, but not yet for particles
    const SliceStack slices1 = slicify(sample, options).setBField(sample.externalField());
 
    std::vector<reLayout> layouts = collectLayouts(sample, slices1, polarized);
 
    const SliceStack refined_stack =
        options.useAvgMaterials() ? refineStack(slices1, layouts) : slices1;
 
    return reSample(sample, polarized, std::move(layouts), refined_stack);
}

References reSample(), MultiLayer::externalField(), ISampleNode::isMagnetic(), layouts(), sample(), SliceStack::setBField(), and SimulationOptions::useAvgMaterials().

Referenced by swigAPI::defaultMaterialProfileLimits(), swigAPI::materialProfileSLD(), and ISimulation::simulate().

Here is the call graph for this function:

numberOfSlices()

size_t reSample::numberOfSlices

(

)

const

Definition at line 336 of file ReSample.cpp.

{
    return m_stack.size();
}

References m_stack.

Referenced by RoughMultiLayerContribution::compute(), and DepthProbeComputation::runProtected().

polarizing()

bool reSample::polarizing

(

)

const

Contains magnetic material, or nonzero magnetic field.

Definition at line 371 of file ReSample.cpp.

{
    return containsMagneticMaterial() || m_sample.externalField() != R3{};
}

References containsMagneticMaterial(), MultiLayer::externalField(), and m_sample.

Referenced by SpecularComputation::runProtected().

Here is the call graph for this function:

sample()

const MultiLayer& reSample::sample ( ) const

inline

Definition at line 58 of file ReSample.h.

{ return m_sample; }

References m_sample.

Referenced by RoughMultiLayerContribution::compute(), and make().

sliceBottomZ()

double reSample::sliceBottomZ

(

size_t

i

)

const

Definition at line 361 of file ReSample.cpp.

{
    return m_stack.at(i).zBottom();
}

References m_stack.

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

sliceTopZ()

double reSample::sliceTopZ

(

size_t

i

)

const

Definition at line 356 of file ReSample.cpp.

{
    return m_stack.at(i).zTop();
}

References m_stack.

Referenced by DepthProbeComputation::runProtected().

Member Data Documentation

m_layouts

std::vector<reLayout> reSample::m_layouts

private

Definition at line 71 of file ReSample.h.

Referenced by layouts().

m_polarized

const bool reSample::m_polarized

private

Definition at line 70 of file ReSample.h.

Referenced by containsMagneticMaterial(), fluxesIn(), and fluxesOut().

m_sample

const MultiLayer& reSample::m_sample

private

Definition at line 69 of file ReSample.h.

Referenced by crossCorrSpectralFun(), polarizing(), and sample().

m_stack

const SliceStack reSample::m_stack

private

Definition at line 72 of file ReSample.h.

Referenced by averageSlices(), avgeSlice(), crossCorrSpectralFun(), fluxesIn(), fluxesOut(), hasRoughness(), numberOfSlices(), sliceBottomZ(), and sliceTopZ().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Processed/ReSample.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Processed/ReSample.cpp