spis.Surf.InteractModel
Class ReciprocalOfFunctionOfParticleE

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

public class ReciprocalOfFunctionOfParticleE
extends FunctionOfParticleE

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

Description : The reciprocal function of a function of particle energy.
This reciprocal function is defined as the reprocal of the function y=f(E) of particle energy passed to the constructor.
WARNING: is indeed not a function of energy (but E=f-1(y))=> no to be used generically as a function of particle energy (e.g. by using the compute(float[] velocity, float mass, float[] normal) method of FunctionOfParticleE which defines the argument as really the energy from velocity and mass (checked => throws an exception if invoked so)
This reciprocal function is yet derived from FunctionOfParticleE since it is still a function depending of one particle "kinematic" parameter and material.
In practice it is used to invert range function r(E).

Versions and anomalies correction :

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


Version:
0.1
Author:
JF Roussel

Constructor Summary
ReciprocalOfFunctionOfParticleE(FunctionOfParticleE f, float xmin, float xmax, float firstStep, float stepRatio)
           
 
Method Summary
 float compute(float[] velocity, float mass, float[] normal)
          Should return the energy dependent function computed from particle data, but cannot here because the reciprocal of a function of energy is not a function of energy !
 float compute(float[] velocity, float mass, float[] normal, float matModId, float matId, float partId)
          Should return the energy dependent function computed from particle data, but cannot here because the reciprocal of a function of energy is not a function of energy !
 
Methods inherited from class spis.Surf.InteractModel.FunctionOfParticleE
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

ReciprocalOfFunctionOfParticleE

public ReciprocalOfFunctionOfParticleE(FunctionOfParticleE f,
                                       float xmin,
                                       float xmax,
                                       float firstStep,
                                       float stepRatio)
Method Detail

compute

public float compute(float[] velocity,
                     float mass,
                     float[] normal)
Should return the energy dependent function computed from particle data, but cannot here because the reciprocal of a function of energy is not a function of energy !

Overrides:
compute in class FunctionOfParticleE
Parameters:
velocity - particle velocity
mass - particle mass
normal - vector defining the angle origin
Returns:
See Also:
ReciprocalOfFunctionOfParticleE

compute

public float compute(float[] velocity,
                     float mass,
                     float[] normal,
                     float matModId,
                     float matId,
                     float partId)
Should return the energy dependent function computed from particle data, but cannot here because the reciprocal of a function of energy is not a function of energy !

Overrides:
compute in class FunctionOfParticleE
Parameters:
velocity - particle velocity
mass - particle mass
normal - vector defining the angle origin
matModId - material model Id
matId - material Id
partId - particle Id
Returns:
See Also:
ReciprocalOfFunctionOfParticleE