spis.Util.List
Class SurfSampler
java.lang.Object
spis.Util.List.SurfSampler
- Direct Known Subclasses:
- GlobalMaxwellSurfSampler, LocalMaxwellSurfSampler
- public abstract class SurfSampler
- extends java.lang.Object
Class Name : SurfSampler
Project ref : SPIS project
File name : SurfSampler.java
File type : class
Copyright : ONERA, 2 Av. E. Belin, 31055 Toulouse cedex, France
http://www.onecert.fr
Status : under development
Creation : Mar 3, 2004
Modification :
Description : Generic surface sampler class from which any surface sampler must derive.
Generates sampled velocity distributions.
NB: position sampling is much simpler since it is assumed uniform within
a surface, and this service is simply provided by the mesh (volume or surface).
Versions and anomalies correction :
Version number | Author (name, e-mail) | Corrections/Modifications |
0.1 | JF Roussel, roussel@onecert.fr | Creation |
- Version:
- 0.1
- Author:
- JF Roussel
Method Summary |
Part |
getParticleType()
|
abstract void |
sample(SpaceVectTable surfNormal,
FloatScalTable area,
float time,
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 area Table (usually through a flux or density, cf. derived classes).
|
abstract void |
sample(SpaceVectTable surfNormal,
FloatScalTable area,
float time,
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 area Table (usually through a flux or 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 |
particleType
protected Part particleType
- type of particles generated
SurfSampler
public SurfSampler(Part particleType_)
- Default constructor
- Parameters:
particleType_
- the type of particle this sampler can generate
sample
public abstract void sample(SpaceVectTable surfNormal,
FloatScalTable area,
float time,
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 area Table (usually through a flux or density, cf. derived classes).
The index returns the surface element the particle belongs to.
- Parameters:
surfNormal
- surface normals (input)area
- cell areas (input)time
- the particles generated are the particle that would cross the surfaces during that timeindex
- index of each particle surface element (ouput)velo
- sampled velocities (output)weight
- weight of sampled particles (output)
sample
public abstract void sample(SpaceVectTable surfNormal,
FloatScalTable area,
float time,
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 area Table (usually through a flux or density, cf. derived classes).
The index returns the surface element the particle belongs to.
- Parameters:
surfNormal
- surface normals (input)area
- cell areas (input)time
- the particles generated are the particle that would cross the surfaces during that time (input)index
- index of each particle surface (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
-