|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectspis.Top.Default.Parameter
spis.Top.Default.GlobalParameter
Class Name : GlobalParameter
Project ref : SPIS project
File name : GlobalParameter.java
File type : class
Copyright : ONERA, 2 Av. E. Belin, 31055 Toulouse cedex, France
http://www.onecert.fr
Status : under development
Creation : 10 mars 2004
Modification :
Description : Control Parameter of the global simulation.
Versions and anomalies correction :
Version number | Author (name, e-mail) | Corrections/Modifications |
0.1 | JF Roussel, roussel@onecert.fr | Creation |
Field Summary | |
static java.lang.String |
avPartNbPerCell
Name of the following parameter: average number of super-particle per cell NB: the average particle number per node is more relevant because computation is mostly on the nodes. |
static java.lang.String |
Bx
Name of the following parameter: x-component of the magnetic field (uniform over the computation box) [T] (default value: 0.0, type: float) |
static java.lang.String |
By
Name of the following parameter: y-component of the magnetic field [T] (default value: 0.0, type: float) |
static java.lang.String |
Bz
Name of the following parameter: z-component of the magnetic field [T] (default value: 0.0, type: float) |
static java.lang.String |
CSat
Name of the following parameter: absolute spacecraft capacitance [C] (default value: 1.e-9, type: float) |
static java.lang.String |
densitiesMapsMonitorStep
Name of the following parameter: time step for densities monitoring (0.0 => none) [s] (default value: 0.0, type: float) |
static java.lang.String |
duration
Name of the following parameter: Duration of the simulation [s] (default value: 1.0, type: float) |
static java.lang.String |
electricCircuitFilename
Name of the following parameter: Name of the file describing extra electric devices between electric (super-)nodes (RLCV) - (default value: circuit.txt, type: String) |
static java.lang.String |
electricCircuitIntegrate
Name of the following parameter: Flag controlling SC electric circuit integration: - 0: do not integrate (constant initial potentials) - 1: integrate - 2: integrate with implicit scheme - (default value: 1, type: int) |
static java.lang.String |
electronDensity
Name of the following parameter: Electron density (1st population) [m-3] (default value: 1.0e6, type: float) |
static java.lang.String |
electronDensity2
Name of the following parameter: Electron density (2nd population) [#/m3] (default value: 0.0, type: float) |
static java.lang.String |
electronDistrib
Name of the following parameter: Name of the VolDistrib class to be used for electrons - (default value: GlobalMaxwellBoltzmannVolDistrib, type: String / Class) |
static java.lang.String |
electronDistrib2
Name of the following parameter: Name of the VolDistrib class to be used for the 2nd electron population - (default value: GlobalMaxwellBoltzmannVolDistrib, type: String/ Class) |
static java.lang.String |
electronSecondaryEmission
Name of the following parameter: secondaryEmissionFlagUnderElectronImpact: : 0=no, 1=yes without secondary-electron dynamics, 3=yes with dynamics - (default value: 0, type: int) |
static java.lang.String |
electronTemperature
Name of the following parameter: Electron temperature(1st population) [eV] (default value: 1.0, type: float) |
static java.lang.String |
electronTemperature2
Name of the following parameter: Electron temperature (2nd population) [eV] (default value: 1000.0, type: float) |
static java.lang.String |
environmentType
Name of the following parameter: Name of the Environment class to be used (ex: BiMaxwellianEnvironment which will use the parameters below, or WorstCaseGeoEnvironment which will be self-contained) - (default value: BiMaxwellianEnvironment, type: String / Class) |
static java.lang.String |
inducedConductivity
Name of the following parameter: induced conductivity: 0=no, 1=yes - (default value: 0, type: int) |
static java.lang.String |
initPot
Name of the following parameter: initial potential (default value: 0.0, type: float) |
static java.lang.String |
initPotFlag
Name of the following parameter: flag to define initial pot: 0 => set to 0, 1 => set to global initPot, 2 => set to local potential defined as SC Dirichlet condition (default value: 1, type: int) |
static java.lang.String |
ionDensity
Name of the following parameter: Ion density (1st population) [m-3] (default value: 1.0e6, type: float) |
static java.lang.String |
ionDensity2
Name of the following parameter: Ion density (2nd population) [#/m3] (default value: 0.0, type: float) |
static java.lang.String |
ionDistrib
Name of the following parameter: Name of the VolDistrib class to be used for ions - (default value: PICVolDistrib, type: String / Class) |
static java.lang.String |
ionDistrib2
Name of the following parameter: Name of the VolDistrib class to be used for ions 2nd population - (default value: PICVolDistrib, type: String/ Class) |
static java.lang.String |
ionTemperature
Name of the following parameter: Ion temperature (1st population) [eV] (default value: 1.0, type: float) |
static java.lang.String |
ionTemperature2
Name of the following parameter: Ion temperature (2nd population) [eV] (default value: 1000.0, type: float) |
static java.lang.String |
ionType
Name of the following parameter: First ion population (a string that must be found in the particle types filename below) - (default value: H+, type: String) |
static java.lang.String |
ionType2
Name of the following parameter: Second ion population (a string that must be found in the particle types filename below) - (default value: H+, type: String) |
static java.lang.String |
ionVx
Name of the following parameter: Ion drift velocity along x axis (1st population) [m/s] (default value: 0.0, type: float) |
static java.lang.String |
ionVx2
Name of the following parameter: Ion drift velocity along x axis (2nd population) [m/s] (default value: 0.0, type: float) |
static java.lang.String |
ionVy
Name of the following parameter: Ion drift velocity along y axis (1st population) [m/s] (default value: 0.0, type: float) |
static java.lang.String |
ionVy2
Name of the following parameter: Ion drift velocity along y axis (2nd population) [m/s] (default value: 0.0, type: float) |
static java.lang.String |
ionVz
Name of the following parameter: Ion drift velocity along z axis (1st population) [m/s] (default value: 0.0, type: float) |
static java.lang.String |
ionVz2
Name of the following parameter: Ion drift velocity along z axis (2nd population) [m/s] (default value: 0.0, type: float) |
static java.lang.String |
iterGradient
Name of the following parameter: Maximum iteration number for conjugate gradient Poisson Solver - (default value: 100, type: int) |
static java.lang.String |
iterGradientNl
Name of the following parameter: Maximum iteration number for conjugate gradient Poisson Solver when non-linear solving - (default value: 100, type: int) |
static java.lang.String |
iterNewton
Name of the following parameter: Maximum iteration number for Newton algorithm in non-linear Poisson solving - (default value: 10, type: int) |
static java.lang.String |
linearPoisson
Name of the following parameter: 0- no: non-linear Poisson solver in use 1- yes: linear Poisson solver in use - (default value: 0, type: int) |
static java.lang.String |
materialPropertyPlots
Name of the following parameter: plot material properties? |
static java.lang.String |
particleTrajectoriesNb
Name of the following parameter: number of particle trajectories per PIC population - (default value: 0, type: int) |
static java.lang.String |
photoElectronTemperature
name of the global parameter giving photo-electron temperature [eV] (default: 2.0, type float) |
static java.lang.String |
photoEmission
Name of the following parameter: photoEmissionFlag: 0=no, 1=yes without photo-electron dynamics, 3=yes with dynamics - (default value: 0, type: int) |
static java.lang.String |
plasmaDt
Name of the following parameter: Time step for plasma dynamics (automatic if <= 0) [s] (default value: 0.0, type: float) |
static java.lang.String |
plasmaDuration
Name of the following parameter: Duration of plasma dynamics integration before SC potenial is updated (100 times plasmaDt if <= 0) [s] (default value: 0.0, type: float) |
static java.lang.String |
plasmaPotMapMonitorStep
Name of the following parameter: time step for plasma potential monitoring (0.0 => none) [s] (default value: 0.0, type: float) |
static java.lang.String |
poissonBCParameter1
Name of the following parameter: Parameter that can be used by some BC types (e.g. 1/rn exponent) [varies] (default value: , type: float) |
static java.lang.String |
poissonBCParameter2
Name of the following parameter: 2nd parameter that can be used by some BC types [varies] (default value: , type: float) |
static java.lang.String |
poissonBCType
Name of the following parameter: type of Poisson BC (always Dirchlet on SC and Fourier on boundary): 0- Use the Poisson boundary conditions defined as fields through electric node editor (Dirchlet/Fourier with UI-defined parameters) 1- Dirichlet on SC (values from UI), Fourier on external boundary with alpha parameter mimicking a 1/r decay (~vacuum) 2- Dirichlet on SC (values from UI), Fourier on external boundary with alpha parameter mimicking a 1/r2 decay (~presheath) 3- Dirichlet on SC (values from UI), Fourier on boundary with alpha parameter mimicking a 1/r^n decay, n = poissonBCParameter1 ... other types possible - (default value: 2, type: int) |
static java.lang.String |
poissonVerbose
Name of the following parameter: Same as verbose, but specific to Poisson solver - (default value: 3, type: int) |
static java.lang.String |
protonSecondaryEmission
Name of the following parameter: secondaryEmissionFlagUnderProtonImpact: : 0=no, 1=yes without secondary-electron dynamics, 2 or 3 = yes with dynamics - (default value: 0, type: int) |
static java.lang.String |
scCurrentMapMonitorStep
Name of the following parameter: time step for spacecraft local currents monitoring (0.0 => none) [s] (default value: 0.0, type: float) |
static java.lang.String |
scDt
Name of the following parameter: Integration time for SC potential between each plasma dynamics integration (10 times plasmaDt if <= 0) [s] (default value: 0.0, type: float) |
static java.lang.String |
scPotMapMonitorStep
Name of the following parameter: time step for spacecraft local potential monitoring (0.0 => none) [s] (default value: 0.0, type: float) |
static java.lang.String |
scPotMonitorStep
Name of the following parameter: time step for spacecraft ground potential monitoring (0.0 => none) [s] (default value: 0.0, type: float) |
static java.lang.String |
secondaryFromProtonTemperature
name of the global parameter giving secondary electron temperature (from proton impact) [eV] (default: 2.0, type float) |
static java.lang.String |
secondaryTemperature
name of the global parameter giving secondary electron temperature (from electron impact) [eV] (default: 2.0, type float) |
static java.lang.String |
sourceFlag
Name of the following parameter: flag for defining an artificial source on the spacecraft: 0 => none, 1 => yes, x => number of super-particles densified by x (default value: 0, type: float). |
static java.lang.String |
sourceNb
Name of the following parameter: number of source particles. |
static java.lang.String |
sourceParticleType
Name of the following parameter: Type of particles (a string that must be found in the particle types) - (default value: Xe+, type: String) There are indeed several such parameters named sourceParticleType1, sourceParticleType2, etc. |
static java.lang.String |
sourceType
Name of the following parameter: Name of the SurfDistrib class to be used for an artificial source on the spacecraft (ex: LocalMaxwellSurfDistrib, which will use the "source flux", "source temperature" and "source Mach" user-defined local fields, whereas a specific EP model could only use the "source flux" and define internally its velocity distribution) - (default value: LocalMaxwellSurfDistrib, type: String / Class) There are indeed several such parameters named sourceType1, sourceType2, etc. |
static java.lang.String |
sunX
Name of the following parameter: x-component of sun direction (points to sun, vector opposite to photons' velocity) - (default value: 0.0, type: float) |
static java.lang.String |
sunY
Name of the following parameter: y-component of sun direction - (default value: 0.0, type: float) |
static java.lang.String |
sunZ
Name of the following parameter: z-component of sun direction - (default value: 1.0, type: float) |
static java.lang.String |
surfaceConductivity
Name of the following parameter: surface conductivity: 0=no, 1=yes - (default value: 0, type: int) |
static java.lang.String |
tolGradient
Name of the following parameter: Tolerance for conjugate gradient Poisson Solver (stops when residue is smaller than tolGradient * ??) |
static java.lang.String |
tolGradientNl
Name of the following parameter: Tolerance for conjugate gradient Poisson Solver when non-linear solving [-] (default value: 0.0001, type: float) |
static java.lang.String |
tolNewton
Name of the following parameter: Tolerance for Newton algorithm loop in non-linear Poisson solving [-] (default value: 0.02, type: float) |
static java.lang.String |
verbose
Name of the following parameter: Verbosity level (level of screen messages about code execution): 0 = no print at all 1 = prints errors and warnings only 2 = 1 + minimal information 3 = 1 + more information (remains yet readable) 4 = even more information … (next levels for debugging) - (default value: 3, type: int) |
static java.lang.String |
volumeConductivity
Name of the following parameter: volume consductivity: 0=no, 1=yes - (default value: 0, type: int) |
Constructor Summary | |
GlobalParameter(java.lang.String name_,
java.lang.String type_,
java.lang.Object value_,
java.lang.String unit_,
java.lang.String comment_)
Default constructor. |
Method Summary | |
static float |
extractDens(java.lang.String option)
|
static GlobalParameter |
extractGlobalParam(java.lang.String name)
Returns the global parameter of name name from the global parameter array (static variable of Global class). |
static Part |
extractPartType(java.lang.String option)
|
static float |
extractTemp(java.lang.String option)
|
static float[] |
extractVelo(java.lang.String option)
|
Methods inherited from class spis.Top.Default.Parameter |
extractParam, getComment, getName, getType, getUnit, getValue, setComment, setName, setType, setUnit, setValue |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static java.lang.String duration
public static java.lang.String plasmaDt
public static java.lang.String plasmaDuration
public static java.lang.String scDt
public static java.lang.String environmentType
public static java.lang.String electronDensity
public static java.lang.String electronTemperature
public static java.lang.String electronDistrib
public static java.lang.String ionDensity
public static java.lang.String ionTemperature
public static java.lang.String ionVx
public static java.lang.String ionVy
public static java.lang.String ionVz
public static java.lang.String ionType
public static java.lang.String ionDistrib
public static java.lang.String electronDensity2
public static java.lang.String electronTemperature2
public static java.lang.String electronDistrib2
public static java.lang.String ionDensity2
public static java.lang.String ionTemperature2
public static java.lang.String ionVx2
public static java.lang.String ionVy2
public static java.lang.String ionVz2
public static java.lang.String ionType2
public static java.lang.String ionDistrib2
public static java.lang.String avPartNbPerCell
public static java.lang.String poissonBCType
public static java.lang.String poissonBCParameter1
public static java.lang.String poissonBCParameter2
public static java.lang.String linearPoisson
public static java.lang.String iterGradient
public static java.lang.String tolGradient
public static java.lang.String iterGradientNl
public static java.lang.String tolGradientNl
public static java.lang.String iterNewton
public static java.lang.String tolNewton
public static java.lang.String Bx
public static java.lang.String By
public static java.lang.String Bz
public static java.lang.String electricCircuitIntegrate
public static java.lang.String initPotFlag
public static java.lang.String initPot
public static java.lang.String CSat
public static java.lang.String electricCircuitFilename
public static java.lang.String sourceFlag
public static java.lang.String sourceType
public static java.lang.String sourceParticleType
public static java.lang.String sourceNb
public static java.lang.String photoEmission
public static java.lang.String electronSecondaryEmission
public static java.lang.String protonSecondaryEmission
public static java.lang.String volumeConductivity
public static java.lang.String inducedConductivity
public static java.lang.String surfaceConductivity
public static java.lang.String sunX
public static java.lang.String sunY
public static java.lang.String sunZ
public static java.lang.String photoElectronTemperature
public static java.lang.String secondaryTemperature
public static java.lang.String secondaryFromProtonTemperature
public static java.lang.String scPotMonitorStep
public static java.lang.String scPotMapMonitorStep
public static java.lang.String scCurrentMapMonitorStep
public static java.lang.String plasmaPotMapMonitorStep
public static java.lang.String densitiesMapsMonitorStep
public static java.lang.String particleTrajectoriesNb
public static java.lang.String materialPropertyPlots
public static java.lang.String verbose
public static java.lang.String poissonVerbose
Constructor Detail |
public GlobalParameter(java.lang.String name_, java.lang.String type_, java.lang.Object value_, java.lang.String unit_, java.lang.String comment_)
Method Detail |
public static GlobalParameter extractGlobalParam(java.lang.String name)
name
-
public static float extractDens(java.lang.String option)
public static float extractTemp(java.lang.String option)
public static float[] extractVelo(java.lang.String option)
public static Part extractPartType(java.lang.String option)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |