rl_DielectricPODArray Class Reference

A class encapsulating an array of rl_DielectricPODs storing the dielectric contants as a function of energy: More...

#include <rl_DielectricPODArray.h>

Collaboration diagram for rl_DielectricPODArray:

Public Member Functions
	~rl_DielectricPODArray ()
	Destructor.
	rl_DielectricPODArray ()
	Default constructor. More...
	rl_DielectricPODArray (size_t nelts, double const *energy, double const *alpha, double const *gamma)
	Constructor. More...
	rl_DielectricPODArray (size_t nelts, rl_Traits::rl_DielectricPOD *diel)
	Constructor. More...
void	init (size_t nelts, double const *energy, double const *alpha, double const *gamma)
	Initializer. More...
void	init (size_t nelts, rl_Traits::rl_DielectricPOD *diel)
	Initializer. More...
size_t	num_elts () const
	Accessor. More...
rl_Traits::rl_DielectricPOD const *	const_data_ptr () const
	Accessor. More...
void	cprint_on (std::FILE *of, char const pre[]="", char const pst[]="") const
	Accessor. More...

Protected Attributes
size_t	nelts_
	number of dielectric decrements read in
rl_Traits::rl_DielectricPOD *	data_
	pointer to the data

Detailed Description

A class encapsulating an array of rl_DielectricPODs storing the dielectric contants as a function of energy:

• energy (keV)
• alpha (real part of dielectric decrement)
• gamma (imaginary part of the dielectric decrement)

The complex dielectric constant has real part (1-alpha) and imaginary part (-gamma).

Definition at line 57 of file rl_DielectricPODArray.h.

Constructor & Destructor Documentation

rl_DielectricPODArray() [1/3]

rl_DielectricPODArray::rl_DielectricPODArray

(

)

Default constructor.

An empty uninitialized rl_DielectricPODArray is created 
and the init method must be called to initialize the object.

Definition at line 69 of file rl_DielectricPODArray.cc.

rl_DielectricPODArray() [2/3]

rl_DielectricPODArray::rl_DielectricPODArray	(	size_t	nelts,
		double const *	energy,
		double const *	alpha,
		double const *	gamma
	)

Constructor.

Parameters

nelts	number of elements in the array
energy	array of energies
alpha	array of dielectric decrement real part (alpha)
gamma	array of dielectric decrement imag part (gamma)

Definition at line 74 of file rl_DielectricPODArray.cc.

rl_DielectricPODArray() [3/3]

rl_DielectricPODArray::rl_DielectricPODArray	(	size_t	nelts,
		rl_Traits::rl_DielectricPOD *	diel
	)

Constructor.

Parameters

nelts	number of elements in the array
diel	array of dielectric decrement PODs

Definition at line 100 of file rl_DielectricPODArray.cc.

Member Function Documentation

const_data_ptr()

rl_Traits::rl_DielectricPOD const * rl_DielectricPODArray::const_data_ptr ( ) const

inline

Accessor.

Returns

pointer-to-const to rl_DielectricPOD array.

Definition at line 172 of file rl_DielectricPODArray.h.

cprint_on()

void rl_DielectricPODArray::cprint_on	(	std::FILE *	of,
		char const	pre[] = "",
		char const	pst[] = ""
	)		const

Accessor.

Returns

pointer-to-const to rl_DielectricPOD array.Print reflectivity information to output FILE* stream.

Parameters

of	output FILE* stream.
pre	optional prefix (char*) string.
pst	optional postfix (char*) string.

Definition at line 154 of file rl_DielectricPODArray.cc.

init() [1/2]

void rl_DielectricPODArray::init	(	size_t	nelts,
		double const *	energy,
		double const *	alpha,
		double const *	gamma
	)

Initializer.

Parameters

nelts	number of elements in the array
energy	array of energies
alpha	array of dielectric decrement real part (alpha)
gamma	array of dielectric decrement imag part (gamma)

initialize this rl_DielectricPODArray from the energy, alpha, and gamma arrays. The rl_DielectricPODArray is sorted on the energy field.

Definition at line 120 of file rl_DielectricPODArray.cc.

init() [2/2]

void rl_DielectricPODArray::init	(	size_t	nelts,
		rl_Traits::rl_DielectricPOD *	diel
	)

Initializer.

Parameters

nelts	number of elements in the array
diel	array of dielectric decrement PODs

initialize this rl_DielectricPODArray from the input array of rl_DielectricPODs. The rl_DielectricPODArray is sorted on the energy field.

Definition at line 138 of file rl_DielectricPODArray.cc.

num_elts()

size_t rl_DielectricPODArray::num_elts ( ) const

inline

Accessor.

Returns

number of elements in the rl_DielectricPOD array.

Definition at line 168 of file rl_DielectricPODArray.h.

---

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

• rl_DielectricPODArray.h
• rl_DielectricPODArray.cc