|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectspis.Vol.VolDistrib.VolDistrib
spis.Vol.VolDistrib.VolDistribWithIO
spis.Vol.VolDistrib.PICVolDistrib
Class Name : PICVolDistrib (PIC Volume Distribution)
Project ref : SPIS project
File name : PICVolDistrib.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 : Particle_In-Cell (PIC) Volume Distribution.
The particle distribution is kinetic through Monte-Carlo sampling.
Versions and anomalies correction :
Version number | Author (name, e-mail) | Corrections/Modifications |
0.1 | JF Roussel, roussel@onecert.fr | Creation |
Constructor Summary | |
PICVolDistrib(GlobalParameter[] globalParams,
LocalParameter[] localParams,
java.lang.String option,
VolMesh vm,
VectVolField E,
VectVolField B)
Constructor based on UI-defined parameters NB: not used for now, the UI-defined parameters are currently extracted before the call of the PICVolDistrib constructor |
|
PICVolDistrib(VolMesh vm,
float dens,
float[] velo,
float temp,
Part particleType,
VectVolField E,
VectVolField B)
Quick constructor, initialises particles in volume (generates homogeneous sample) and the incoming flux as SelfInFlux (with its sampler) |
|
PICVolDistrib(VolMesh vm,
PartList partList,
MatterBC selfInFlux_,
MatterBC inFlux_,
SurfDistrib scOutFlux_,
SurfDistrib bdOutFlux_,
EField E_,
VectVolField B_)
Default constructor with IO data, with the electric field defined as a physical EField (including solver). |
|
PICVolDistrib(VolMesh vm,
PartList partList,
MatterBC selfInFlux_,
MatterBC inFlux_,
SurfDistrib scOutFlux_,
SurfDistrib bdOutFlux_,
VectVolField E_,
VectVolField B_)
Default constructor with IO data |
|
PICVolDistrib(VolMesh vm,
PartList partList,
VectVolField E,
VectVolField B)
Default constructor without IO data (in/out fluxes, E-B fields): use setters to define the ones needed (most of them can remain null, as initialised by this constructor, if not needed). |
|
PICVolDistrib(VolMesh vm,
VectVolField E,
VectVolField B)
Constructor with minimal data: a default RichParlist will be defined, no IO data will be defined, use setters to define the ones needed (most of them can remain null, as initialised by this constructor, if not needed). |
Method Summary | |
float |
assessLargestDt()
No upper limit for time integration time step for analytical distributions |
void |
buildMostAccurateScOutFlux()
Builds the most accurate outgoing flux onto spacecraft. |
boolean |
containsOnly(Part particleType)
|
void |
getMoment(VolField mom,
int order,
int charge,
int mass)
normalised and deviation flags omitted: they are set to their default value, 0 |
PartList |
getPartList()
|
void |
init()
intialisation routine, invoked by constructors |
void |
injectAllInFlux(float dt)
Injects all the incoming fluxes (in allInFlux) into this list with an amount of particles corresponding to the time dt. |
boolean |
mayContain(Part particleType)
|
void |
move(float dt)
Time integration of the particle distribution over the duration dt. |
Methods inherited from class spis.Vol.VolDistrib.VolDistribWithIO |
buildAllInFlux, getB, getBdOutFlux, getE, getInFlux, getScOutFlux, getSelfInFlux, setB, setBdOutFlux, setE, setInFlux, setScOutFlux, setSelfInFlux |
Methods inherited from class spis.Vol.VolDistrib.VolDistrib |
getMoment, getMoment, getMoment, getMoment, getName, getParticleType, getVm, isDensityImplicit, setImplicitDensity, setName, setParticleType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PICVolDistrib(VolMesh vm, PartList partList, MatterBC selfInFlux_, MatterBC inFlux_, SurfDistrib scOutFlux_, SurfDistrib bdOutFlux_, VectVolField E_, VectVolField B_)
vm
- volume meshpartList
- particle listselfInFlux_
- self-generated incoming flux (e.g. plasma source)inFlux_
- externally-generated incoming flux (e.g. source on SC)scOutFlux_
- outgoing flux to SCbdOutFlux_
- outgoing flux to external boundaryE_
- electric fieldB_
- magnetic fieldpublic PICVolDistrib(VolMesh vm, PartList partList, MatterBC selfInFlux_, MatterBC inFlux_, SurfDistrib scOutFlux_, SurfDistrib bdOutFlux_, EField E_, VectVolField B_)
vm
- volume meshpartList
- particle listselfInFlux_
- self-generated incoming flux (e.g. plasma source)inFlux_
- externally-generated incoming flux (e.g. source on SC)scOutFlux_
- outgoing flux to SCbdOutFlux_
- outgoing flux to external boundaryE_
- electric field as an EFieldB_
- magnetic fieldpublic PICVolDistrib(VolMesh vm, PartList partList, VectVolField E, VectVolField B)
vm
- volume meshpartList
- particle listE
- pointer to the electric field (for trajectory integration)B
- pointer to magnetic fieldpublic PICVolDistrib(VolMesh vm, VectVolField E, VectVolField B)
vm
- volume meshpublic PICVolDistrib(VolMesh vm, float dens, float[] velo, float temp, Part particleType, VectVolField E, VectVolField B)
vm
- volume meshdens
- particle densityvelo
- particle velocitytemp
- particle temperatureparticleType
- particle typepublic PICVolDistrib(GlobalParameter[] globalParams, LocalParameter[] localParams, java.lang.String option, VolMesh vm, VectVolField E, VectVolField B)
globalParams
- localParams
- option
- vm
- E
- B
- VolDistribWithIO for specification of this type of constructor
Method Detail |
public void init()
public void move(float dt)
move
in class VolDistrib
VolDistribWithIO
public void injectAllInFlux(float dt)
dt
- public float assessLargestDt()
assessLargestDt
in class VolDistrib
public void getMoment(VolField mom, int order, int charge, int mass)
VolDistrib
getMoment
in class VolDistrib
VolDistrib.getMoment(VolField, int, int, int, int, int)
public boolean containsOnly(Part particleType)
containsOnly
in class VolDistrib
particleType
-
public boolean mayContain(Part particleType)
mayContain
in class VolDistrib
particleType
-
public void buildMostAccurateScOutFlux()
VolDistribWithIO
buildMostAccurateScOutFlux
in class VolDistribWithIO
public PartList getPartList()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |