spis.Top.Plasma
Class Environment

java.lang.Object
  extended byspis.Top.Plasma.Environment
Direct Known Subclasses:
BiMaxwellianEnvironment

public abstract class Environment
extends java.lang.Object

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 numberAuthor (name, e-mail) Corrections/Modifications
0.1 JF Roussel, roussel@onecert.frCreation


Version:
0.1
Author:
JF Roussel

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

pop

protected VolDistribWithIO[] pop
particle populations, TBD derived types

Constructor Detail

Environment

public Environment()
Method Detail

getPopulations

public VolDistribWithIO[] getPopulations()
Returns the particle populations (distributions) describing this environment

Returns:

getElectronPopulations

public abstract VolDistribWithIO[] getElectronPopulations()
Returns the elcetron populations (used for secondary emission under electron impact)

Returns:

getProtonPopulations

public abstract VolDistribWithIO[] getProtonPopulations()
Returns the proton populations, including mixed distributions, possibly including several types of ions (used for secondary emission under proton impact)

Returns:

getIonPopulations

public abstract VolDistribWithIO[] getIonPopulations()
Returns the ion populations

Returns:

buildNewPop

protected VolDistribWithIO buildNewPop(java.lang.String distribName,
                                       java.lang.String option,
                                       java.lang.Object[] otherParams)
Builds a new population from UI-defined parameters

Parameters:
distribName - one of "electronDistrib", "ionDistrib", "electronDistrib2", "ionDistrib2"
option - one of "ions", "elec", "ions2", "elec2"
otherParams - should of dimension 3, with successively volMesh, E, B
Returns:
the built population

selectDistrib

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). NB: Negative indices are allowed and discarded.

Parameters:
positions -
Returns: