|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectspis.Surf.SurfDistrib.SurfDistrib
Class Name : SurfDistrib (generic Surface Distribution)
Project ref : SPIS project
File name : SurfDistrib.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 : generic abstract Surface Distribution.
A surface distribution f_s is indeed a "flux distribution", it is the
volume distribution f_n multiplied by the velocity normal to the surface v.n:
f_s(x,v,t) = v.n f_v(x,v,t).
It stores the particle distribution at the desired accuracy level:
it can be a full velocity distribution function (PIC model) or only its moments (fluid approach)
All Surface Distribution classes must be derived from this class.
Versions and anomalies correction :
Version number | Author (name, e-mail) | Corrections/Modifications |
0.1 | JF Roussel, roussel@onecert.fr | Creation |
Field Summary | |
protected VolDistrib |
from
Volume distribution this surface distribution comes from (optioinal data, thus not requested in constructor) |
protected SurfMesh |
sm
Surface Mesh on which the distribution "lives" |
protected VolDistrib |
to
Volume distribution this surface distribution comes from (optioinal data, thus not requested in constructor) |
Constructor Summary | |
SurfDistrib(SurfMesh surfMesh)
constructor |
Method Summary | |
abstract float |
assesMinTimeToCrossOneCell()
Assesses the minimum time to cross one cell when particles are injected from this surface distribution into volume. |
protected void |
checkMomentConsistentWithOrder(SurfField mom,
int order)
Checks the moment sub-type (ScalSurfField or VectSurfField) is consistent with the moment order. |
VolDistrib |
getFrom()
|
void |
getMoment(SurfField mom,
int order)
charge, mass, time, normalised and deviation flags omitted: they are set to their default value, 0 |
void |
getMoment(SurfField mom,
int order,
int charge)
mass, time, normalised and deviation flags omitted: they are set to their default value, 0 |
void |
getMoment(SurfField mom,
int order,
int charge,
int mass)
time, normalised and deviation flags omitted: they are set to their default value, 0 |
abstract void |
getMoment(SurfField mom,
int order,
int charge,
int mass,
int time)
normalised and deviation flags omitted: they are set to their default value, 0 |
void |
getMoment(SurfField mom,
int order,
int charge,
int mass,
int time,
int normalised)
deviation flag omitted: it is set to its default value, 0 |
void |
getMoment(SurfField mom,
int order,
int charge,
int mass,
int time,
int normalised,
int deviation)
Provides the moments of the distribution (order=0 => number current, 1 => momentum current, 2 => energy current...). |
abstract PartList |
getSample(float dt)
Returns a sample of the surface distribution (a flux indeed) integrated over the time dt. |
SurfMesh |
getSm()
Provides a pointer to the surface mesh this distribution lives on |
VolDistrib |
getTo()
|
abstract void |
map(SurfDistrib sd)
Maps the SurfDistrib passed, sd, into this SurfDistrib. |
abstract void |
sample(PartList pl,
float dt)
Computes a sample of the surface distribution (a flux indeed) integrated over the time dt. |
void |
setFrom(VolDistrib fromDistrib)
|
void |
setTo(VolDistrib toDistrib)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected SurfMesh sm
protected VolDistrib from
protected VolDistrib to
Constructor Detail |
public SurfDistrib(SurfMesh surfMesh)
surfMesh
- Method Detail |
public void getMoment(SurfField mom, int order, int charge, int mass, int time, int normalised, int deviation)
mom
- order
- charge
- mass
- time
- normalised
- deviation
- public void getMoment(SurfField mom, int order, int charge, int mass, int time, int normalised)
mom
- order
- charge
- mass
- time
- normalised
- getMoment(SurfField, int, int, int, int, int, int)
public abstract void getMoment(SurfField mom, int order, int charge, int mass, int time)
mom
- order
- charge
- mass
- time
- getMoment(SurfField, int, int, int, int, int, int)
public void getMoment(SurfField mom, int order, int charge, int mass)
mom
- order
- charge
- mass
- getMoment(SurfField, int, int, int, int, int, int)
public void getMoment(SurfField mom, int order, int charge)
mom
- order
- charge
- getMoment(SurfField, int, int, int, int, int, int)
public void getMoment(SurfField mom, int order)
mom
- order
- getMoment(SurfField, int, int, int, int, int, int)
public abstract void sample(PartList pl, float dt)
getSample(float)
public abstract PartList getSample(float dt)
sample(PartList, float)
public abstract void map(SurfDistrib sd)
public abstract float assesMinTimeToCrossOneCell()
protected void checkMomentConsistentWithOrder(SurfField mom, int order)
mom
- momentorder
- moment orderpublic SurfMesh getSm()
public VolDistrib getFrom()
public VolDistrib getTo()
public void setFrom(VolDistrib fromDistrib)
fromDistrib
- the volume distribution this flux comes frompublic void setTo(VolDistrib toDistrib)
toDistrib
- the volume distribution this flux has to be directed to
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |