SliceStack Class Reference

Description

A stack of Slices.

Definition at line 38 of file SliceStack.h.

Inheritance diagram for SliceStack:

Collaboration diagram for SliceStack:

Public Member Functions
	SliceStack (const RoughnessModel roughness_model)
	SliceStack (const SliceStack &other)
void	addNSlices (size_t n, double thickness, const Material &material, const LayerRoughness *roughness=nullptr)
	Adds n times the same slice to the stack. More...
void	addSlice (double thickness, const Material &material, const LayerRoughness *roughness=nullptr)
void	addTopSlice (double zbottom, const Material &material)
const LayerRoughness *	bottomRoughness (size_t i_slice) const
bool	containsMagneticMaterial () const
RoughnessModel	roughnessModel () const
SliceStack	setBField (const R3 &externalField)

Public Attributes
T	elements
	STL member. More...

Private Attributes
const RoughnessModel	m_roughness_model

Constructor & Destructor Documentation

SliceStack() [1/2]

SliceStack::SliceStack ( const RoughnessModel  roughness_model )

inline

Definition at line 40 of file SliceStack.h.

        : m_roughness_model(roughness_model)
    {
    }

SliceStack() [2/2]

SliceStack::SliceStack

(

const SliceStack &

other

)

Definition at line 19 of file SliceStack.cpp.

    : std::vector<Slice>((std::vector<Slice>)other)
    , m_roughness_model(other.roughnessModel())
{
}

Member Function Documentation

addNSlices()

void SliceStack::addNSlices	(	size_t	n,
		double	thickness,
		const Material &	material,
		const LayerRoughness *	roughness = nullptr
	)

Adds n times the same slice to the stack.

Definition at line 46 of file SliceStack.cpp.

{
    ASSERT(thickness > 0);
    ASSERT(n > 0);
    const double slice_thickness = thickness / n;
    addSlice(slice_thickness, material, roughness);
    for (size_t i = 1; i < n; ++i)
        addSlice(slice_thickness, material);
}

References addSlice(), and ASSERT.

Here is the call graph for this function:

addSlice()

void SliceStack::addSlice	(	double	thickness,
		const Material &	material,
		const LayerRoughness *	roughness = nullptr
	)

Definition at line 30 of file SliceStack.cpp.

{
    ASSERT(!this->empty());
    double top = this->back().zBottom();
    ASSERT(thickness >= 0);
    std::unique_ptr<ZLimits> zRange;
    if (thickness == 0)
        zRange = std::make_unique<ZLimits>(-ZLimits::inf, top);
    else
        zRange = std::make_unique<ZLimits>(top - thickness, top);
    this->emplace_back(Slice(*zRange, material, {}, roughness));
}

References ASSERT, and ZLimits::inf.

Referenced by addNSlices().

addTopSlice()

void SliceStack::addTopSlice	(	double	zbottom,
		const Material &	material
	)

Definition at line 25 of file SliceStack.cpp.

{
    this->emplace_back(Slice(ZLimits(zbottom, ZLimits::inf), material, {}, nullptr));
}

References ZLimits::inf.

bottomRoughness()

const LayerRoughness * SliceStack::bottomRoughness

(

size_t

i_slice

)

const

Definition at line 75 of file SliceStack.cpp.

{
    if (i_slice + 1 < size())
        return (*this)[i_slice + 1].topRoughness();
    return nullptr;
}

Referenced by RoughMultiLayerContribution::get_sum8terms(), Compute::SpecularScalar::topLayerR(), and Compute::SpecularMagnetic::topLayerR().

containsMagneticMaterial()

bool SliceStack::containsMagneticMaterial

(

)

const

Definition at line 68 of file SliceStack.cpp.

{
    return std::any_of(this->cbegin(), this->cend(), [](const Slice& slice) -> bool {
        return slice.material().isMagneticMaterial();
    });
}

References Slice::material().

Here is the call graph for this function:

roughnessModel()

RoughnessModel SliceStack::roughnessModel ( ) const

inline

Definition at line 57 of file SliceStack.h.

{ return m_roughness_model; }

References m_roughness_model.

Referenced by Compute::SpecularScalar::fluxes(), Compute::SpecularMagnetic::fluxes(), Compute::SpecularScalar::topLayerR(), and Compute::SpecularMagnetic::topLayerR().

setBField()

SliceStack SliceStack::setBField

(

const R3 &

externalField

)

Definition at line 57 of file SliceStack.cpp.

{
    if (this->empty())
        return *this;
    const double M_z0 = this->at(0).material().magnetization().z();
    const double H_z = externalField.z() + M_z0;
    for (Slice& slice : *this)
        slice.initBField(externalField, H_z);
    return *this;
}

References Slice::initBField().

Referenced by reSample::make().

Here is the call graph for this function:

Member Data Documentation

elements

T std::vector< T >::elements

inherited

STL member.

m_roughness_model

const RoughnessModel SliceStack::m_roughness_model

private

Definition at line 60 of file SliceStack.h.

Referenced by roughnessModel().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Slice/SliceStack.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Slice/SliceStack.cpp