|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectspis.Top.Plasma.Environment
Class Name : Environment
Project ref : SPIS project
File name : Environment.java
File type : class
Copyright : ONERA, 2 Av. E. Belin, 31055 Toulouse cedex, France
http://www.onecert.fr
Status : under development
Creation : Jun 16, 2004
Modification :
Description : generic abstract environement class
Monstly a constainer of particle distributions, i.e. it contains physical
data (densities...) but also computational ones as the way these populations
are modelled since it returns VolDistrib-utions, which can be PIC, Boltzmann...
All environment defining classes must derive from this one.
Sub-classes to be built from UI parameters:
to offer the possibility be built from UI parameters (local and global
parameters, the latter including the class name) subclasses of
this class must have a constructor with arguments:
- GlobalParameter[] globalParams,
- LocalParameter[] localParams,
- String option: unused here (but must be present)
- VolMesh vm,
- EField E,
- VectVolField B
which is not enforced at compilation time, but must be true at execution time
when such a class is built.
Versions and anomalies correction :
Version number | Author (name, e-mail) | Corrections/Modifications |
0.1 | JF Roussel, roussel@onecert.fr | Creation |
Field Summary | |
protected VolDistribWithIO[] |
pop
particle populations, TBD derived types |
Constructor Summary | |
Environment()
|
Method Summary | |
protected VolDistribWithIO |
buildNewPop(java.lang.String distribName,
java.lang.String option,
java.lang.Object[] otherParams)
Builds a new population from UI-defined parameters |
abstract VolDistribWithIO[] |
getElectronPopulations()
Returns the elcetron populations (used for secondary emission under electron impact) |
abstract VolDistribWithIO[] |
getIonPopulations()
Returns the ion populations |
VolDistribWithIO[] |
getPopulations()
Returns the particle populations (distributions) describing this environment |
abstract VolDistribWithIO[] |
getProtonPopulations()
Returns the proton populations, including mixed distributions, possibly including several types of ions (used for secondary emission under proton impact) |
protected VolDistribWithIO[] |
selectDistrib(int[] positions)
Selects and returns the populations of indices positions which are not null
(no null in the returned array, which has exactly the right size).
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected VolDistribWithIO[] pop
Constructor Detail |
public Environment()
Method Detail |
public VolDistribWithIO[] getPopulations()
public abstract VolDistribWithIO[] getElectronPopulations()
public abstract VolDistribWithIO[] getProtonPopulations()
public abstract VolDistribWithIO[] getIonPopulations()
protected VolDistribWithIO buildNewPop(java.lang.String distribName, java.lang.String option, java.lang.Object[] otherParams)
distribName
- one of "electronDistrib", "ionDistrib", "electronDistrib2", "ionDistrib2"option
- one of "ions", "elec", "ions2", "elec2"otherParams
- should of dimension 3, with successively volMesh, E, B
protected VolDistribWithIO[] selectDistrib(int[] positions)
positions
which are not null
(no null in the returned array, which has exactly the right size).
NB: Negative indices are allowed and discarded.
positions
-
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |