spis.Util.List
Class VolSampler

java.lang.Object
  extended byspis.Util.List.VolSampler
Direct Known Subclasses:
GlobalMaxwellVolSampler

public abstract class VolSampler
extends java.lang.Object

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

Description : Generic VolSampler class from which any volume sampler must derive.
Generates sampled velocity distributions.
NB: position sampling is much simpler since it is assumed uniform within a cell, and this service is simply provided by the mesh (volume or surface). This is consistent with the
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
protected  Part particleType
          type of particles generated
 
Constructor Summary
VolSampler(Part particleType_)
          Default constructor
 
Method Summary
 Part getParticleType()
           
abstract  void sample(FloatScalTable volume, IntScalTable index, VeloVectTable velo, float weight)
          Returns a sample of particle velocities (constant weight), the number of physical particles (sum of super-particle weights) being related to the volume Table (usually through a density, cf. derived classes).
abstract  void sample(FloatScalTable volume, IntScalTable index, VeloVectTable velo, FloatScalTable weight)
          Returns a sample of particle velocities and weights, the number of physical particles (sum of super-particle weights) being related to the volume Table (usually through a density, cf. derived classes).
 void setParticleType(Part part)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

particleType

protected Part particleType
type of particles generated

Constructor Detail

VolSampler

public VolSampler(Part particleType_)
Default constructor

Parameters:
particleType_ - the type of particle this sampler can generate
Method Detail

sample

public abstract void sample(FloatScalTable volume,
                            IntScalTable index,
                            VeloVectTable velo,
                            FloatScalTable weight)
Returns a sample of particle velocities and weights, the number of physical particles (sum of super-particle weights) being related to the volume Table (usually through a density, cf. derived classes). The index returns the volume cell the particle belongs to.

Parameters:
volume - cell volumes (input)
index - index of each particle cell (ouput)
velo - sampled velocities (output)
weight - weight of sampled particles (output)

sample

public abstract void sample(FloatScalTable volume,
                            IntScalTable index,
                            VeloVectTable velo,
                            float weight)
Returns a sample of particle velocities (constant weight), the number of physical particles (sum of super-particle weights) being related to the volume Table (usually through a density, cf. derived classes). The index returns the volume cell the particle belongs to.

Parameters:
volume - cell volumes (input)
index - index of each particle cell (ouput)
velo - sampled velocities (output)
weight - fixed particle weight (input)

getParticleType

public Part getParticleType()
Returns:
particle type

setParticleType

public void setParticleType(Part part)
Parameters:
part -