corsika::ExponentialRefractiveIndex< T > Class Template Reference

An exponential refractive index. More...

#include <ExponentialRefractiveIndex.hpp>

Inheritance diagram for corsika::ExponentialRefractiveIndex< T >:

Public Member Functions
template<typename... Args>
	ExponentialRefractiveIndex (double const n0, InverseLengthType const lambda, Point const center, LengthType const radius, Args &&... args)
	Construct an ExponentialRefractiveIndex. More...
double	getRefractiveIndex (Point const &point) const final override
	Evaluate the refractive index at a given location using its z-coordinate. More...

Detailed Description

template<typename T>
class corsika::ExponentialRefractiveIndex< T >

An exponential refractive index.

This class returns the value of an exponential refractive index for all evaluated locations.

Definition at line 23 of file ExponentialRefractiveIndex.hpp.

Constructor & Destructor Documentation

ExponentialRefractiveIndex()

template<typename T >

template<typename... Args>

corsika::ExponentialRefractiveIndex< T >::ExponentialRefractiveIndex	(	double const	n0,
		InverseLengthType const	lambda,
		Point const	center,
		LengthType const	radius,
		Args &&...	args
	)

Construct an ExponentialRefractiveIndex.

This is initialized with two parameters n_0 and lambda and returns the value of the exponential refractive index at a given point location.

Parameters

field

The refractive index to return to a given point.

Member Function Documentation

getRefractiveIndex()

template<typename T >

double corsika::ExponentialRefractiveIndex< T >::getRefractiveIndex ( Point const &  point ) const

finaloverride

Evaluate the refractive index at a given location using its z-coordinate.

Parameters

point

The location to evaluate at.

Returns

The refractive index at this point.

---

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

• corsika/media/ExponentialRefractiveIndex.hpp