spis.Surf.InteractModel
Class EnergyFunction

java.lang.Object
  extended byspis.Surf.InteractModel.FunctionOfParticle
      extended byspis.Surf.InteractModel.FunctionOfParticleE
          extended byspis.Surf.InteractModel.EnergyFunction
All Implemented Interfaces:
ScalFunctionOf4Scal, ScalFunctionOfScal

public class EnergyFunction
extends FunctionOfParticleE

Class Name : EnergyFunction
Project ref : SPIS project
File name : EnergyFunction.java
File type : class
Copyright : ONERA, 2 Av. E. Belin, 31055 Toulouse cedex, France http://www.onecert.fr
Status : under development
Creation : 20 oct. 2004
Modification :

Description :

Versions and anomalies correction :

Version numberAuthor (name, e-mail) Corrections/Modifications
0.1 JF Roussel, roussel@onecert.frCreation


Version:
0.1
Author:
JF Roussel

Field Summary
 
Fields inherited from class spis.Surf.InteractModel.FunctionOfParticle
defaultParamsId, materialRange, modelId, particleId, partTable
 
Constructor Summary
EnergyFunction()
          Constructor without a reference to a particle table (possible for this very simple function of energy, which is energy)
EnergyFunction(PartTable partTable)
          Default constructor
 
Method Summary
protected  float compute(float E, int paramsId)
          Returns particle energy
 
Methods inherited from class spis.Surf.InteractModel.FunctionOfParticleE
compute, compute, compute, compute
 
Methods inherited from class spis.Surf.InteractModel.FunctionOfParticle
getDefaultParamsId, getMaterialRange, getModelId, getParticleId, getPartTable, selectParamSet, setDefaultParams, setDefaultParamsId, setMaterialRange, setModelId, setParticleId, setPartTable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EnergyFunction

public EnergyFunction(PartTable partTable)
Default constructor

Parameters:
partTable -

EnergyFunction

public EnergyFunction()
Constructor without a reference to a particle table (possible for this very simple function of energy, which is energy)

Method Detail

compute

protected float compute(float E,
                        int paramsId)
Returns particle energy

Specified by:
compute in class FunctionOfParticleE
Parameters:
E - particle energy [eV] (and not keV as often)
paramsId - selected parameter set
Returns:
range [m] (not Angstrom, translation is done by l0)
See Also:
ScalFunctionOfScal.compute(float)