gov.nist.microanalysis.NISTMonte
Class MonteCarloSS.GaussianBeam

java.lang.Object
  gov.nist.microanalysis.NISTMonte.MonteCarloSS.GaussianBeam

All Implemented Interfaces:

MonteCarloSS.ElectronGun

Enclosing class:

MonteCarloSS

public class MonteCarloSS.GaussianBeam
extends java.lang.Object
implements MonteCarloSS.ElectronGun

Constructor Summary

MonteCarloSS.GaussianBeam(double width)
GaussianBeam - Create a instance of the ElectronGun interface modeling a GaussianBeam with the specified gaussian width parameter.

Method Summary

MonteCarloSS.Electron	createElectron() createElectron - Called by MonteCarloSS at the beginning of each trajectory to get a fresh Electron.
double	getBeamEnergy() getBeamEnergy - Returns the beam energy
double[]	getCenter() getCenter - Returns the location of the center of the gun.
double	getWidth() getWidth - Returns the width of the Gaussian beam.
void	setBeamEnergy(double beamEnergy) setBeamEnergy - Called by MonteCarloSS.setBeamEnergy to modify the acceleration potential.
void	setCenter(double[] center) setCenter - Called by MonteCarloSS to set the location of the electron source.
void	setWidth(double width) setWidth - Set the width of the Gaussian beam.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MonteCarloSS.GaussianBeam

public MonteCarloSS.GaussianBeam(double width)

GaussianBeam - Create a instance of the ElectronGun interface modeling a GaussianBeam with the specified gaussian width parameter.

Parameters:

width - double - The Gaussian width paramter in meters.

Method Detail

setWidth

public void setWidth(double width)

setWidth - Set the width of the Gaussian beam.

Parameters:

width - double

getWidth

public double getWidth()

getWidth - Returns the width of the Gaussian beam.

Returns:

double

setBeamEnergy

public void setBeamEnergy(double beamEnergy)

Description copied from interface: MonteCarloSS.ElectronGun

setBeamEnergy - Called by MonteCarloSS.setBeamEnergy to modify the acceleration potential.

Specified by:

setBeamEnergy in interface MonteCarloSS.ElectronGun

Parameters:

beamEnergy - double - in Joules

getBeamEnergy

public double getBeamEnergy()

Description copied from interface: MonteCarloSS.ElectronGun

getBeamEnergy - Returns the beam energy

Specified by:

getBeamEnergy in interface MonteCarloSS.ElectronGun

Returns:

double - in Joules

setCenter

public void setCenter(double[] center)

Description copied from interface: MonteCarloSS.ElectronGun

setCenter - Called by MonteCarloSS to set the location of the electron source.

Specified by:

setCenter in interface MonteCarloSS.ElectronGun

Parameters:

center - double[]

getCenter

public double[] getCenter()

Description copied from interface: MonteCarloSS.ElectronGun

getCenter - Returns the location of the center of the gun.

Specified by:

getCenter in interface MonteCarloSS.ElectronGun

Returns:

double[]

createElectron

public MonteCarloSS.Electron createElectron()

Description copied from interface: MonteCarloSS.ElectronGun

createElectron - Called by MonteCarloSS at the beginning of each trajectory to get a fresh Electron.

Specified by:

createElectron in interface MonteCarloSS.ElectronGun

Returns:

Electron