spis.Surf.InteractModel
Class FunctionOfDistrib

java.lang.Object
  extended byspis.Surf.InteractModel.FunctionOfDistrib
Direct Known Subclasses:
ConstantFunctionOfDistrib, FunctionOfDistribFromFuncOfPart

public abstract class FunctionOfDistrib
extends java.lang.Object

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

Description : general Macroscopic Yield class.
A Yield object is a yield function of an interaction.
For a given surface distribution function (sampled or with moments), it gives a scalar, the result of the interaction have this yield.
The yield function can be hard-coded in a derived class, or default derived classes can be used where tabulated yield functions versus particles energy and/or angle are provided.
NB: compare to FunctionOfParticle, which does the same job for a single particle (or monokinetic distribution). Note that "macroscopic", here, does not have a perfectly standard meaning: FunctionOfDistrib handles a distribution over the whole space, hence in (up to) 6D phase space, whereas FunctionOfParticle handles a 0D phase space.

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
FunctionOfDistrib()
           
 
Method Summary
abstract  void compute(SurfDistrib fluxIn, ScalSurfField result)
          Computes the (local) result of applying this yield on the incoming surface distribution fluxIn (one value per surface element in result)
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FunctionOfDistrib

public FunctionOfDistrib()
Method Detail

compute

public abstract void compute(SurfDistrib fluxIn,
                             ScalSurfField result)
Computes the (local) result of applying this yield on the incoming surface distribution fluxIn (one value per surface element in result)