constants.h File Reference

This file contains the global constants for the NPSpec library. More...

#include "npspec/version.h"

Go to the source code of this file.

Enumerations
enum	SpectraType { Efficiency, CrossSection, Molar, Absorption }
enum	ErrorCode {   NoError = 0, SizeWarning = -3, InvalidRadius = -4, InvalidRelativeRadius = -5,   InvalidIncrement = -6, InvalidPathLength = -7, InvalidConcentration = -8, InvalidRefractiveIndex = -9,   InvalidNumberOfLayers = -10, UnknownMaterial = -11 }
enum	NanoparticleShape { Sphere, Ellipsoid }
enum	SpectraProperty { Extinction, Absorbance, Scattering }

Variables
const int	NLAMBDA = 800
const int	MAXLAYERS = 10
const double	wavelengths []

Detailed Description

This file contains the global constants for the NPSpec library.

Enumeration Type Documentation

enum ErrorCode

Enum for npspec errors.

Enumerator
NoError	No error has occured.
SizeWarning	The nanoparticle size is too large.
InvalidRadius	The radius given is invalid.
InvalidRelativeRadius	The relative radius given is invalid.
InvalidIncrement	The increment is not a factor of 800 or is negative.
InvalidPathLength	The path length chosen is invalid.
InvalidConcentration	The concentration given is invalid.
InvalidRefractiveIndex	The refractive index given is invalid.
InvalidNumberOfLayers	The number of layers is either negative or greater than 10.
UnknownMaterial	The material requested is unknown.

enum NanoparticleShape

Enum for shape. This is only used in conjunction with the Nanoparticle class.

Enumerator
Sphere	The nanoparticle is a sphere.
Ellipsoid	The nanoparticle is an ellipsoid.

enum SpectraProperty

Enum for spectra property. This is only used in conjunction with the Nanoparticle class.

Enumerator
Extinction	Return the extinction spectra.
Absorbance	Return the absorbance spectra.
Scattering	Return the scattering spectra.

enum SpectraType

Enum for spectra type.

Enumerator
Efficiency	Calculate the efficiency spectra (unitless).
CrossSection	Calculate the CrossSection spectra (in nm \(^{2}\)).
Molar	Calculate the molar absorbtivitty (in L mol \(^{−1}\) cm \(^{−1}\)).
Absorption	Calculate the absorption spectra (unitless).

Variable Documentation

const int MAXLAYERS = 10

Maximum number of layers the nanoparticle can contain.

const int NLAMBDA = 800

Number of wavelengths that will be calculated.

const double wavelengths[]

The wavelengths that will be calcuated over. This is used internally but is made public to make plotting the data easy.