spis.Surf.InteractModel
Class DampedEnergyFunction

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

public class DampedEnergyFunction
extends FunctionOfParticleE

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

Description : Compute the average energy of a particle after crossing some thickness of material (hence the remaining damped energy).
The computation is based on a range function passed to the constructor.
Takes into account the probabilty of the particle to be absorbed before (0 energy left if lost).
It is computed as the product of the transmission probability (see TransmissionFunction) by the average energy of the transmitted particles (derived from the RangeFunction by inversion of the function).

Version:
0.1
Author:
JF Roussel
See Also:
TransmissionFunction,
Versions and anomalies correction :
Version numberAuthor (name, e-mail) Corrections/Modifications
0.1 JF Roussel, roussel@onecert.frCreation



Field Summary
private  float depth
          Depth in the material at which the average damped energy must be computed
private  RangeFunction range
          range function the particle energy loss is computed from
private  FunctionOfParticleE reciprocalRangeFunction
          Reciprocal of the range function (energy as a function of range) Warning: is indeed not a function of energy => no to be used generically as a function of particle of energy
private  TransmissionFunction transmission
          transmission function the particle energy loss is computed from
 
Fields inherited from class spis.Surf.InteractModel.FunctionOfParticle
defaultParamsId, materialRange, modelId, particleId, partTable
 
Constructor Summary
DampedEnergyFunction(ParameterSet[] atomicNumber, RangeFunction range, int modelId, int particleId, PartTable partTable)
          Default constructor
 
Method Summary
protected  float compute(float E, int matId)
          Protected abstract method to be implemented by derived classes (the only one, always the one called by the public methods defined in FunctionOfParticleE)
 float getDepth()
           
 void setDepth(float depth)
           
 
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
 

Field Detail

range

private RangeFunction range
range function the particle energy loss is computed from


transmission

private TransmissionFunction transmission
transmission function the particle energy loss is computed from


depth

private float depth
Depth in the material at which the average damped energy must be computed


reciprocalRangeFunction

private FunctionOfParticleE reciprocalRangeFunction
Reciprocal of the range function (energy as a function of range) Warning: is indeed not a function of energy => no to be used generically as a function of particle of energy

Constructor Detail

DampedEnergyFunction

public DampedEnergyFunction(ParameterSet[] atomicNumber,
                            RangeFunction range,
                            int modelId,
                            int particleId,
                            PartTable partTable)
Default constructor

Parameters:
range - range function describing the energy loss of the particle
partTable -
Method Detail

compute

protected float compute(float E,
                        int matId)
Description copied from class: FunctionOfParticleE
Protected abstract method to be implemented by derived classes (the only one, always the one called by the public methods defined in FunctionOfParticleE)

Specified by:
compute in class FunctionOfParticleE
Parameters:
E - particle energy [eV] (and not keV)
matId -
Returns:
average particle energy after crossing the given thickness [eV]

getDepth

public float getDepth()
Returns:
Returns the depth.

setDepth

public void setDepth(float depth)
Parameters:
depth - Sets the depth in the material at which the average damped energy must be computed.