ScalarFresnelMap Class Reference

Inheritance diagram for ScalarFresnelMap:

Collaboration diagram for ScalarFresnelMap:

Classes
class	Hash2Doubles

Public Member Functions
	ScalarFresnelMap (std::unique_ptr< ISpecularStrategy > strategy)
	~ScalarFresnelMap () final
	ScalarFresnelMap (const ScalarFresnelMap &other)=delete
ScalarFresnelMap &	operator= (const ScalarFresnelMap &other)=delete
std::unique_ptr< const ILayerRTCoefficients >	getOutCoefficients (const SimulationElement &sim_element, size_t layer_index) const override
template<typename T >
std::unique_ptr< const ILayerRTCoefficients >	getInCoefficients (const T &sim_element, size_t layer_index) const
virtual void	setSlices (const std::vector< Slice > &slices)
const std::vector< Slice > &	slices () const
void	disableCaching ()

Protected Attributes
std::vector< Slice >	m_slices
bool	m_use_cache
std::unique_ptr< ISpecularStrategy >	m_Strategy

Private Member Functions
std::unique_ptr< const ILayerRTCoefficients >	getCoefficients (const kvector_t &kvec, size_t layer_index) const override
const ISpecularStrategy::coeffs_t &	getCoefficientsFromCache (kvector_t kvec) const

Private Attributes
std::unordered_map< std::pair< double, double >, ISpecularStrategy::coeffs_t, Hash2Doubles >	m_cache

Detailed Description

Implementation of IFresnelMap for scalar valued reflection/transmission coefficients.

Definition at line 32 of file ScalarFresnelMap.h.

Constructor & Destructor Documentation

ScalarFresnelMap() [1/2]

ScalarFresnelMap::ScalarFresnelMap

(

std::unique_ptr< ISpecularStrategy >

strategy

)

Definition at line 19 of file ScalarFresnelMap.cpp.

    : IFresnelMap(std::move(strategy))
{
}

~ScalarFresnelMap()

ScalarFresnelMap::~ScalarFresnelMap ( )

finaldefault

ScalarFresnelMap() [2/2]

ScalarFresnelMap::ScalarFresnelMap ( const ScalarFresnelMap &  other )

delete

Member Function Documentation

operator=()

ScalarFresnelMap& ScalarFresnelMap::operator= ( const ScalarFresnelMap &  other )

delete

getOutCoefficients()

std::unique_ptr< const ILayerRTCoefficients > ScalarFresnelMap::getOutCoefficients ( const SimulationElement &  sim_element, size_t  layer_index  ) const

overridevirtual

Retrieves the amplitude coefficients for a (time-reversed) outgoing wavevector.

Implements IFresnelMap.

Definition at line 34 of file ScalarFresnelMap.cpp.

{
    return getCoefficients(-sim_element.getMeanKf(), layer_index);
}

References getCoefficients(), and SimulationElement::getMeanKf().

Here is the call graph for this function:

getCoefficients()

std::unique_ptr< const ILayerRTCoefficients > ScalarFresnelMap::getCoefficients ( const kvector_t &  kvec, size_t  layer_index  ) const

overrideprivatevirtual

Implements IFresnelMap.

Definition at line 40 of file ScalarFresnelMap.cpp.

{
    if (!m_use_cache) {
        auto coeffs = m_Strategy->Execute(m_slices, kvec);
        return std::unique_ptr<const ILayerRTCoefficients>(coeffs[layer_index]->clone());
    }
    const auto& coef_vector = getCoefficientsFromCache(kvec);
    return std::unique_ptr<const ILayerRTCoefficients>(coef_vector[layer_index]->clone());
}

References getCoefficientsFromCache(), IFresnelMap::m_slices, IFresnelMap::m_Strategy, and IFresnelMap::m_use_cache.

Referenced by getOutCoefficients().

Here is the call graph for this function:

getCoefficientsFromCache()

const ISpecularStrategy::coeffs_t & ScalarFresnelMap::getCoefficientsFromCache ( kvector_t  kvec ) const

private

Definition at line 50 of file ScalarFresnelMap.cpp.

{
    std::pair<double, double> k2_theta(kvec.mag2(), kvec.theta());
    auto it = m_cache.find(k2_theta);
    if (it == m_cache.end()) {
        it = m_cache.emplace(k2_theta, m_Strategy->Execute(m_slices, kvec)).first;
    }
    return it->second;
}

References m_cache, IFresnelMap::m_slices, IFresnelMap::m_Strategy, BasicVector3D< T >::mag2(), and BasicVector3D< T >::theta().

Referenced by getCoefficients().

Here is the call graph for this function:

getInCoefficients()

template<typename T >

std::unique_ptr<const ILayerRTCoefficients> IFresnelMap::getInCoefficients ( const T &  sim_element, size_t  layer_index  ) const

inlineinherited

Retrieves the amplitude coefficients for an incoming wavevector.

Definition at line 41 of file IFresnelMap.h.

    {
        return getCoefficients(sim_element.getKi(), layer_index);
    }

References IFresnelMap::getCoefficients().

Referenced by DepthProbeComputationTerm::compute(), GISASSpecularComputation::compute(), FormFactorCoherentPart::evaluate(), FormFactorCoherentPart::evaluatePol(), and RoughMultiLayerComputation::get_sum8terms().

Here is the call graph for this function:

setSlices()

void IFresnelMap::setSlices ( const std::vector< Slice > &  slices )

virtualinherited

Reimplemented in MatrixFresnelMap.

Definition at line 23 of file IFresnelMap.cpp.

{
    m_slices = slices;
}

References IFresnelMap::m_slices, and IFresnelMap::slices().

Referenced by MatrixFresnelMap::setSlices().

Here is the call graph for this function:

slices()

const std::vector< Slice > & IFresnelMap::slices ( ) const

inherited

Definition at line 28 of file IFresnelMap.cpp.

{
    return m_slices;
}

References IFresnelMap::m_slices.

Referenced by MatrixFresnelMap::getCoefficients(), MatrixFresnelMap::getCoefficientsFromCache(), IFresnelMap::setSlices(), and MatrixFresnelMap::setSlices().

disableCaching()

void IFresnelMap::disableCaching ( )

inherited

Disables caching of previously computed Fresnel coefficients.

Definition at line 35 of file IFresnelMap.cpp.

{
    m_use_cache = false;
}

References IFresnelMap::m_use_cache.

Member Data Documentation

m_cache

std::unordered_map<std::pair<double, double>, ISpecularStrategy::coeffs_t, Hash2Doubles> ScalarFresnelMap::m_cache

mutableprivate

Definition at line 56 of file ScalarFresnelMap.h.

Referenced by getCoefficientsFromCache().

m_slices

std::vector<Slice> IFresnelMap::m_slices

protectedinherited

Definition at line 57 of file IFresnelMap.h.

Referenced by MatrixFresnelMap::getCoefficients(), getCoefficients(), getCoefficientsFromCache(), IFresnelMap::setSlices(), and IFresnelMap::slices().

m_use_cache

bool IFresnelMap::m_use_cache

protectedinherited

Definition at line 58 of file IFresnelMap.h.

Referenced by IFresnelMap::disableCaching(), getCoefficients(), and MatrixFresnelMap::getCoefficients().

m_Strategy

std::unique_ptr<ISpecularStrategy> IFresnelMap::m_Strategy

protectedinherited

Definition at line 60 of file IFresnelMap.h.

Referenced by getCoefficients(), MatrixFresnelMap::getCoefficients(), getCoefficientsFromCache(), and MatrixFresnelMap::getCoefficientsFromCache().

---

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

• /home/www/ba/Sample/Fresnel/ScalarFresnelMap.h
• /home/www/ba/Sample/Fresnel/ScalarFresnelMap.cpp