corsika::UniformRefractiveIndex< T > Class Template Reference

A uniform refractive index. More...

#include <UniformRefractiveIndex.hpp>

Inheritance diagram for corsika::UniformRefractiveIndex< T >:

Public Member Functions
template<typename... Args>
	UniformRefractiveIndex (double const n, Args &&... args)
	Construct a UniformRefractiveIndex. More...
double	getRefractiveIndex (Point const &) const override
	Evaluate the refractive index at a given location. More...
void	setRefractiveIndex (double const &n)
	Set the refractive index returned by this instance. More...

Detailed Description

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

A uniform refractive index.

This class returns the same refractive index for all evaluated locations.

Definition at line 23 of file UniformRefractiveIndex.hpp.

Constructor & Destructor Documentation

UniformRefractiveIndex()

template<typename T >

template<typename... Args>

corsika::UniformRefractiveIndex< T >::UniformRefractiveIndex	(	double const	n,
		Args &&...	args
	)

Construct a UniformRefractiveIndex.

This is initialized with a fixed refractive index and returns this refractive index at all locations.

Parameters

field

The refractive index to return everywhere.

Member Function Documentation

getRefractiveIndex()

template<typename T >

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

override

Evaluate the refractive index at a given location.

Parameters

point

The location to evaluate at.

Returns

The refractive index at this point.

setRefractiveIndex()

template<typename T >

void corsika::UniformRefractiveIndex< T >::setRefractiveIndex

(

double const &

n

)

Set the refractive index returned by this instance.

Parameters

point

The location to evaluate at.

Returns

The refractive index at this location.

---

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

• corsika/media/UniformRefractiveIndex.hpp