rl_raylib  1.1.10
rl_DielectricData Class Reference

A class encapsulating the dielectric data (alpha, gamma) as a function of energy. More...

#include <rl_DielectricData.h>

Classes

struct  rl_DielectricDataBinPOD
 A POD describing the lower and upper edge of an energy bin. More...
 

Public Member Functions

 ~rl_DielectricData ()
 Non-virtual detructor.
 
 rl_DielectricData ()
 Default constructor. More...
 
 rl_DielectricData (rl_DielectricData const &other)
 Copy constructor. More...
 
 rl_DielectricData (rl_Traits::rl_DielectricPOD const *diel, size_t num_pts, rl_Traits::EInterpMode interp_mode, double bulk_density=1.0)
 Constructor. More...
 
void init (rl_Traits::rl_DielectricPOD const *diel, size_t num_pts, rl_Traits::EInterpMode interp_mode, double bulk_density=1.0)
 Initialization function. More...
 
int alpha_gamma (double energy, double &alpha, double &gamma)
 Evaluate the dielectric decrements, alpha and gamma, at the given energy. More...
 
double energy_min () const
 Return the minimum energy covered by this dataset.
 
double energy_max () const
 Return the maximum energy covered by this dataset.
 
double bulk_density_factor () const
 Return the maximum energy covered by this dataset. More...
 
rl_Traits::Bool is_vacuum () const
 Returns True if the object is a vacuum state; False, otherwise.
 

Detailed Description

A class encapsulating the dielectric data (alpha, gamma) as a function of energy.

Definition at line 64 of file rl_DielectricData.h.

Constructor & Destructor Documentation

◆ rl_DielectricData() [1/3]

rl_DielectricData::rl_DielectricData ( )
inline

Default constructor.

Constructs a vacuum rl_DielectricData. Use init to initialize the object to a state other than vacuum.

Definition at line 212 of file rl_DielectricData.h.

◆ rl_DielectricData() [2/3]

rl_DielectricData::rl_DielectricData ( rl_DielectricData const &  other)

Copy constructor.

Parameters
otherrl_DielectricData to be copied.

Definition at line 60 of file rl_DielectricData.cc.

◆ rl_DielectricData() [3/3]

rl_DielectricData::rl_DielectricData ( rl_Traits::rl_DielectricPOD const *  diel,
size_t  num_pts,
rl_Traits::EInterpMode  interp_mode,
double  bulk_density = 1.0 
)

Constructor.

The data for the dielectric constants are obtained from a c-style array of const rl_DielectricPOD; the array contains num_pts points. The interpolation mode will be set to interp_mode. The optical constants will be scaled by bulk_density.

Parameters
dielan array of num_pts POD's containing the complex dielectric decrements.
num_ptsnumber of elements in diel.
interp_modetype of interpolation to be used in interpolating the dielectric constants.
bulk_densityrelative bulk density factor to be used; 1.0 for full bulk density. The dielectric decrements will be scaled by bulk_density.

Definition at line 74 of file rl_DielectricData.cc.

Member Function Documentation

◆ alpha_gamma()

int rl_DielectricData::alpha_gamma ( double  energy,
double &  alpha,
double &  gamma 
)

Evaluate the dielectric decrements, alpha and gamma, at the given energy.

The energy must be between the minimum and the maximum energies in the rl_DielectricPOD array used to initialize the rl_DielectricData Returns: 0 on success; -1 if energy is below lower limit, +1 if energy is above upper limit.

Parameters
energyphoton energy (in keV).
alphareal part of the complex dielectric decrement.
gammaimaginary part of the complex dielectric decrement.

Definition at line 173 of file rl_DielectricData.cc.

◆ bulk_density_factor()

double rl_DielectricData::bulk_density_factor ( ) const
inline

Return the maximum energy covered by this dataset.

Return the relative bulk density for this set of optical constants. 1.0 is nominal full bulk density

Definition at line 236 of file rl_DielectricData.h.

◆ init()

void rl_DielectricData::init ( rl_Traits::rl_DielectricPOD const *  diel,
size_t  num_pts,
rl_Traits::EInterpMode  interp_mode,
double  bulk_density = 1.0 
)

Initialization function.

The data are obtained from a c-style array of const rl_DielectricPOD; the array contains num_pts points. The interpolation mode will be set to interp_mode. The optical constants will be scaled by bulk_density.

Parameters
dielan array of num_pts POD's containing the complex dielectric decrements.
num_ptsnumber of elements in diel.
interp_modetype of interpolation to be used in interpolating the dielectric constants.
bulk_densityrelative bulk density factor to be used; 1.0 for full bulk density. The dielectric decrements will be scaled by bulk_density.

Definition at line 84 of file rl_DielectricData.cc.


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