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



Constructor Summary
DampedEnergyFunction(ParameterSet[] atomicNumber, RangeFunction range, int modelId, int particleId, PartTable partTable)
          Default constructor
 
Method Summary
 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, setDefaultParams, setDefaultParamsId, setMaterialRange, setModelId, setParticleId, setPartTable
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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

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.