rl_DielectricPODArray Class Reference

#include <rl_DielectricPODArray.h>

Collaboration diagram for rl_DielectricPODArray:
[legend]

List of all members.

Public Member Functions

 ~rl_DielectricPODArray ()
 rl_DielectricPODArray ()
 rl_DielectricPODArray (size_t nelts, double const *energy, double const *alpha, double const *gamma) throw ( rl_Exception )
 rl_DielectricPODArray (size_t nelts, rl_Traits::rl_DielectricPOD *diel) throw ( rl_Exception )
void init (size_t nelts, double const *energy, double const *alpha, double const *gamma)
void init (size_t nelts, rl_Traits::rl_DielectricPOD *diel)
size_t num_elts () const
rl_Traits::rl_DielectricPOD const * const_data_ptr () const
void cprint_on (std::FILE *of, char const pre[]="", char const pst[]="") const

Protected Attributes

size_t nelts_
 number of dielectric decrements read in
rl_Traits::rl_DielectricPODdata_
 pointer to the data


Detailed Description

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

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::~rl_DielectricPODArray (  ) 

Destructor

Definition at line 65 of file rl_DielectricPODArray.cc.

References data_.

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::rl_DielectricPODArray ( size_t  nelts,
double const *  energy,
double const *  alpha,
double const *  gamma 
) throw ( rl_Exception )

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.

References data_, init(), and nelts_.

rl_DielectricPODArray::rl_DielectricPODArray ( size_t  nelts,
rl_Traits::rl_DielectricPOD diel 
) throw ( rl_Exception )

Constructor.

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

Definition at line 101 of file rl_DielectricPODArray.cc.

References data_, init(), and nelts_.


Member Function Documentation

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 122 of file rl_DielectricPODArray.cc.

References rl_Traits::rl_DielectricPOD::alpha_, data_, rl_Traits::rl_DielectricPOD::energy_, rl_Traits::rl_DielectricPOD::gamma_, and nelts_.

Referenced by rl_DielectricPODArray().

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 140 of file rl_DielectricPODArray.cc.

References rl_Traits::rl_DielectricPOD::alpha_, data_, rl_Traits::rl_DielectricPOD::energy_, rl_Traits::rl_DielectricPOD::gamma_, and nelts_.

size_t rl_DielectricPODArray::num_elts (  )  const [inline]

Accessor.

Returns:
number of elements in the rl_DielectricPOD array.

Definition at line 170 of file rl_DielectricPODArray.h.

References nelts_.

rl_Traits::rl_DielectricPOD const * rl_DielectricPODArray::const_data_ptr (  )  const [inline]

Accessor.

Returns:
pointer-to-const to rl_DielectricPOD array.

Definition at line 174 of file rl_DielectricPODArray.h.

References data_.

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 156 of file rl_DielectricPODArray.cc.

References data_, and nelts_.


Member Data Documentation

size_t rl_DielectricPODArray::nelts_ [protected]

number of dielectric decrements read in

Definition at line 62 of file rl_DielectricPODArray.h.

Referenced by cprint_on(), init(), num_elts(), and rl_DielectricPODArray().

pointer to the data

Definition at line 64 of file rl_DielectricPODArray.h.

Referenced by const_data_ptr(), cprint_on(), init(), rl_DielectricPODArray(), and ~rl_DielectricPODArray().


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

Generated on Mon Nov 3 18:15:05 2008 for rl_raylib by  doxygen 1.5.6