SlicedFormFactorList Class Reference

Class that contains and owns a list of form factors and the index of their containing layer. More...

Public Member Functions
	SlicedFormFactorList ()=default
	SlicedFormFactorList (SlicedFormFactorList &&other)=default
	~SlicedFormFactorList ()=default
SlicedFormFactorList &	operator= (SlicedFormFactorList &&other)=default
std::pair< const IFormFactor *, size_t >	operator[] (size_t index) const
std::map< size_t, std::vector< HomogeneousRegion > >	regionMap () const
size_t	size () const

Static Public Member Functions
static SlicedFormFactorList	createSlicedFormFactors (const IParticle &particle, const std::vector< Slice > &slices, double z_ref)

Private Member Functions
void	addParticle (IParticle &particle, const std::vector< Slice > &slices, double z_ref)

Private Attributes
std::vector< std::pair< std::unique_ptr< IFormFactor >, size_t > >	m_ff_list
std::map< size_t, std::vector< HomogeneousRegion > >	m_region_map

Detailed Description

Class that contains and owns a list of form factors and the index of their containing layer.

This class also handles the slicing of form factors if they cross layer interfaces.

Definition at line 36 of file SlicedFormFactorList.h.

Constructor & Destructor Documentation

SlicedFormFactorList() [1/2]

SlicedFormFactorList::SlicedFormFactorList ( )

default

SlicedFormFactorList() [2/2]

SlicedFormFactorList::SlicedFormFactorList ( SlicedFormFactorList &&  other )

default

~SlicedFormFactorList()

SlicedFormFactorList::~SlicedFormFactorList ( )

default

Member Function Documentation

addParticle()

void SlicedFormFactorList::addParticle ( IParticle &  particle, const std::vector< Slice > &  slices, double  z_ref  )

private

Definition at line 44 of file SlicedFormFactorList.cpp.

{
    auto slice_indices = SliceIndexSpan(particle, slices, z_ref);
    bool single_layer = (slice_indices.first == slice_indices.second);
    for (size_t i = slice_indices.first; i < slice_indices.second + 1; ++i) {
        double z_top_i = SliceTopZ(i, slices);
        kvector_t translation(0.0, 0.0, z_ref - z_top_i);
        particle.translate(translation);
        // if particle is contained in this layer, set limits to infinite:
        ZLimits limits = single_layer ? ZLimits() : SlicesZLimits(slices, i);
        auto sliced_particle = particle.createSlicedParticle(limits);
        m_ff_list.emplace_back(std::move(sliced_particle.m_slicedff), i);
        double thickness = slices[i].thickness();
        if (thickness > 0.0)
            ScaleRegions(sliced_particle.m_regions, 1 / thickness);
        m_region_map[i].insert(m_region_map[i].end(), sliced_particle.m_regions.begin(),
                               sliced_particle.m_regions.end());
        z_ref = z_top_i; // particle now has coordinates relative to z_top_i
    }
}

References IParticle::createSlicedParticle(), m_ff_list, m_region_map, and IParticle::translate().

Referenced by createSlicedFormFactors().

Here is the call graph for this function:

createSlicedFormFactors()

SlicedFormFactorList SlicedFormFactorList::createSlicedFormFactors ( const IParticle &  particle, const std::vector< Slice > &  slices, double  z_ref  )

static

Definition at line 32 of file SlicedFormFactorList.cpp.

{
    SlicedFormFactorList result;
    auto particles = particle.decompose();
    for (auto* particle : particles) {
        result.addParticle(*particle, slices, z_ref);
    }
    return result;
}

References addParticle(), and IParticle::decompose().

Referenced by ProcessedLayout::processParticle().

Here is the call graph for this function:

operator=()

SlicedFormFactorList& SlicedFormFactorList::operator= ( SlicedFormFactorList &&  other )

default

operator[]()

std::pair< const IFormFactor *, size_t > SlicedFormFactorList::operator[]

(

size_t

index

)

const

Definition at line 71 of file SlicedFormFactorList.cpp.

{
    if (index >= size())
        throw std::out_of_range("SlicedFormFactorList::operator[] error: "
                                "index out of range");
    return {m_ff_list[index].first.get(), m_ff_list[index].second};
}

References m_ff_list, and size().

Here is the call graph for this function:

regionMap()

std::map< size_t, std::vector< HomogeneousRegion > > SlicedFormFactorList::regionMap

(

)

const

Definition at line 79 of file SlicedFormFactorList.cpp.

{
    return m_region_map;
}

References m_region_map.

size()

size_t SlicedFormFactorList::size

(

)

const

Definition at line 66 of file SlicedFormFactorList.cpp.

{
    return m_ff_list.size();
}

References m_ff_list.

Referenced by operator[]().

Member Data Documentation

m_ff_list

std::vector<std::pair<std::unique_ptr<IFormFactor>, size_t> > SlicedFormFactorList::m_ff_list

private

Definition at line 55 of file SlicedFormFactorList.h.

Referenced by addParticle(), operator[](), and size().

m_region_map

std::map<size_t, std::vector<HomogeneousRegion> > SlicedFormFactorList::m_region_map

private

Definition at line 56 of file SlicedFormFactorList.h.

Referenced by addParticle(), and regionMap().

---

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

• /home/www/ba/Sample/Slice/SlicedFormFactorList.h
• /home/www/ba/Sample/Slice/SlicedFormFactorList.cpp