spis.Top.Default
Class LocalParameter

java.lang.Object
  extended byspis.Top.Default.Parameter
      extended byspis.Top.Default.LocalParameter
All Implemented Interfaces:
java.io.Serializable

public class LocalParameter
extends Parameter
implements java.io.Serializable

Class Name : LocalParameter
Project ref : SPIS project
File name : LocalParameter.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 : Local Parameter for the simulation (i.e. a local field).

Versions and anomalies correction :

Version numberAuthor (name, e-mail) Corrections/Modifications
0.1 JF Roussel, roussel@onecert.frCreation


Version:
0.1
Author:
JF Roussel
See Also:
Serialized Form

Field Summary
static java.lang.String backGroundDens
          Name of the local parameter: Fixed background density used to compute volume interaction (typically: neutral density) [m-3] (default param value: 0.0 , mesh: Volume , centring: 3 )
static java.lang.String bdDiriFlag
          Name of the local parameter: If 1, Dirichlet condition for Poisson equation on external boundary (fixed potential) - (default param value: 0 (no) , mesh: Boundary , centring: 0 )
static java.lang.String bdDiriPot
          Name of the local parameter: The potential to be used for Dirichlet condition [V] (default param value: 0.0 , mesh: Boundary , centring: 0 )
static java.lang.String bdFourAlpha
          Name of the local parameter: Alpha parameter in Fourier condition [m-1] (default param value: 1.0 [m-1] , mesh: Boundary , centring: 2 )
static java.lang.String bdFourFlag
          Name of the local parameter: If 1, Fourier condition for Poisson equation on external boundary - (default param value: 1 (yes) , mesh: Boundary , centring: 2 )
static java.lang.String bdFourValue
          Name of the local parameter: Right hand side parameter in Fourier condition [V] (default param value: 0.0 , mesh: Boundary , centring: 0 )
static java.lang.String elecNodeId
          Name of the local parameter: The (macro) electric node this element is related to (SC ground, array ground…) - (default param value: 0 (default electric node, related to SC ground) , mesh: SC , centring: 2 )
static java.lang.String elecSecEmis
          Name of the local parameter: If 1, secondary electron emission under electron impact is turned on and simulated - (default param value: 0 (no electron secondary emission) , mesh: SC , centring: 2 )
static java.lang.String incomPart
          Name of the local parameter: - If 0, no particle are injected
static java.lang.String indConduct
          Name of the local parameter: If 1, induced volume conductivity is turned on and simulated (if 0, the raw volume conductivity above is used) - (default param value: 0 (no induced conductivity) , mesh: SC , centring: 2 )
static java.lang.String matModelId
          Name of the local parameter: Id of the material model used for this material - (default param value: 0 (default model = NASCAP-properties-based) , mesh: SC , centring: 2 )
static java.lang.String matThickness
          Name of the local parameter: Material thickness (if defined, overrides the default material thickness defined in the material properties) [m] (default param value: -1 (use the default material thickness defined in the material properties) , mesh: SC , centring: 2 )
static java.lang.String matTypeId
          Name of the local parameter: Id of this material in its material model - (default param value: -1 (no coating: bare metal, no interaction (except collection)) , mesh: SC , centring: 2 )
static java.lang.String outgoPart
          Name of the local parameter: - If 0, outgoing particles are lost (sink) - If 1, they bounce specularly (extra options possible) - (default param value: 0 (sink) , mesh: Boundary , centring: 2 )
static java.lang.String photoEmis
          Name of the local parameter: If 1, photo emission is turned on and simulated - (default param value: 0 (no photo emission) , mesh: SC , centring: 2 )
static java.lang.String protSecEmis
          Name of the local parameter: If 1, secondary electron emission under proton impact is turned on and simulated - (default param value: 0 (no ion secondary emission) , mesh: SC , centring: 2 )
static java.lang.String scDiriFlag
          Name of the local parameter: If 1, Dirichlet condition for Poisson equation on SC (fixed potential) - (default param value: 1 (yes) , mesh: SC , centring: 0 )
static java.lang.String scDiriPot
          Name of the local parameter: The potential to be used for Dirichlet condition [V] (default param value: 0.0 , mesh: SC , centring: 0 )
static java.lang.String scFourAlpha
          Name of the local parameter: Alpha parameter in Fourier condition: alpha pot + d(pot)/dn = value [m-1] (default param value: 1.0 , mesh: SC , centring: 2 )
static java.lang.String scFourFlag
          Name of the local parameter: If 1, Fourier condition for Poisson equation on SC: alpha pot + d(pot)/dn = value - (default param value: 0 (no) , mesh: SC , centring: 2 )
static java.lang.String scFourValue
          Name of the local parameter: Right hand side parameter in Fourier condition : alpha pot + d(pot)/dn = value NB: note the centring different from other Fourier parameters [V] (default param value: 0.0 , mesh: SC , centring: 0 )
static java.lang.String sourceCurrent
          Name of the local parameter: Current of an artificial source defined on the spacecraft (NB: for some sources the unit can be different, e.g. the particle number, or the total current) [A / m2] (default param value: 0.0 , mesh: SC , centring: 2 )
static java.lang.String sourceId
          Name of the local parameter: Id/type of an artificial plasma source defined on the spacecraft (e.g. thruster or ion gun) - (default param value: -1 (no source) , mesh: SC , centring: 2 )
static java.lang.String sourceMach
          Name of the local parameter: Source Mach number (0 => Lambertian) [-] (default param value: 0.0 , mesh: SC , centring: 2 )
static java.lang.String sourceTemp
          Name of the local parameter: Temperature of the emitted Maxwellian distribution [eV] (default param value: 1.0 , mesh: SC , centring: 2 )
static java.lang.String sunFlux
          Name of the local parameter: Sun flux on spacecraft [sun at 1 AU] (default param value: -1.0 (compute it from sun direction, possibly including shades) , mesh: SC , centring: 2 )
static java.lang.String surfConduct
          Name of the local parameter: If 1, surface conductivity is turned on and simulated (from the top of a cell to the next ones) - (default param value: 0 (no surface conductivity) , mesh: SC , centring: 2 )
static java.lang.String temperature
          Name of the local parameter: Surface temperature [K] (default param value: 300.0 , mesh: SC , centring: 2 )
static java.lang.String volConduct
          Name of the local parameter: If 1, volume conductivity through the bulk material is turned on - (default param value: 0 (no volume conductivity) , mesh: SC , centring: 2 )
static java.lang.String volInteracFlag
          Name of the local parameter: If 1, volume interaction is computed in that region (typically charge exchange) - (default param value: 0 (no) , mesh: Volume , centring: 3 )
 
Constructor Summary
LocalParameter(java.lang.String name_, float[] value_, int centring, java.lang.Object mesh, java.lang.String unit_, java.lang.String comment_)
          Dirty constructor for scalar field, for faster use from Jython UI layer
LocalParameter(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 LocalParameter extractLocalParam(java.lang.String name)
          Returns the local parameter of name name from the local parameter array (static variable of Global class).
 
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

matModelId

public static java.lang.String matModelId
Name of the local parameter: Id of the material model used for this material - (default param value: 0 (default model = NASCAP-properties-based) , mesh: SC , centring: 2 )


matTypeId

public static java.lang.String matTypeId
Name of the local parameter: Id of this material in its material model - (default param value: -1 (no coating: bare metal, no interaction (except collection)) , mesh: SC , centring: 2 )


matThickness

public static java.lang.String matThickness
Name of the local parameter: Material thickness (if defined, overrides the default material thickness defined in the material properties) [m] (default param value: -1 (use the default material thickness defined in the material properties) , mesh: SC , centring: 2 )


photoEmis

public static java.lang.String photoEmis
Name of the local parameter: If 1, photo emission is turned on and simulated - (default param value: 0 (no photo emission) , mesh: SC , centring: 2 )


elecSecEmis

public static java.lang.String elecSecEmis
Name of the local parameter: If 1, secondary electron emission under electron impact is turned on and simulated - (default param value: 0 (no electron secondary emission) , mesh: SC , centring: 2 )


protSecEmis

public static java.lang.String protSecEmis
Name of the local parameter: If 1, secondary electron emission under proton impact is turned on and simulated - (default param value: 0 (no ion secondary emission) , mesh: SC , centring: 2 )


volConduct

public static java.lang.String volConduct
Name of the local parameter: If 1, volume conductivity through the bulk material is turned on - (default param value: 0 (no volume conductivity) , mesh: SC , centring: 2 )


indConduct

public static java.lang.String indConduct
Name of the local parameter: If 1, induced volume conductivity is turned on and simulated (if 0, the raw volume conductivity above is used) - (default param value: 0 (no induced conductivity) , mesh: SC , centring: 2 )


surfConduct

public static java.lang.String surfConduct
Name of the local parameter: If 1, surface conductivity is turned on and simulated (from the top of a cell to the next ones) - (default param value: 0 (no surface conductivity) , mesh: SC , centring: 2 )


temperature

public static java.lang.String temperature
Name of the local parameter: Surface temperature [K] (default param value: 300.0 , mesh: SC , centring: 2 )


sunFlux

public static java.lang.String sunFlux
Name of the local parameter: Sun flux on spacecraft [sun at 1 AU] (default param value: -1.0 (compute it from sun direction, possibly including shades) , mesh: SC , centring: 2 )


elecNodeId

public static java.lang.String elecNodeId
Name of the local parameter: The (macro) electric node this element is related to (SC ground, array ground…) - (default param value: 0 (default electric node, related to SC ground) , mesh: SC , centring: 2 )


scDiriFlag

public static java.lang.String scDiriFlag
Name of the local parameter: If 1, Dirichlet condition for Poisson equation on SC (fixed potential) - (default param value: 1 (yes) , mesh: SC , centring: 0 )


scDiriPot

public static java.lang.String scDiriPot
Name of the local parameter: The potential to be used for Dirichlet condition [V] (default param value: 0.0 , mesh: SC , centring: 0 )


scFourFlag

public static java.lang.String scFourFlag
Name of the local parameter: If 1, Fourier condition for Poisson equation on SC: alpha pot + d(pot)/dn = value - (default param value: 0 (no) , mesh: SC , centring: 2 )


scFourAlpha

public static java.lang.String scFourAlpha
Name of the local parameter: Alpha parameter in Fourier condition: alpha pot + d(pot)/dn = value [m-1] (default param value: 1.0 , mesh: SC , centring: 2 )


scFourValue

public static java.lang.String scFourValue
Name of the local parameter: Right hand side parameter in Fourier condition : alpha pot + d(pot)/dn = value NB: note the centring different from other Fourier parameters [V] (default param value: 0.0 , mesh: SC , centring: 0 )


bdDiriFlag

public static java.lang.String bdDiriFlag
Name of the local parameter: If 1, Dirichlet condition for Poisson equation on external boundary (fixed potential) - (default param value: 0 (no) , mesh: Boundary , centring: 0 )


bdDiriPot

public static java.lang.String bdDiriPot
Name of the local parameter: The potential to be used for Dirichlet condition [V] (default param value: 0.0 , mesh: Boundary , centring: 0 )


bdFourFlag

public static java.lang.String bdFourFlag
Name of the local parameter: If 1, Fourier condition for Poisson equation on external boundary - (default param value: 1 (yes) , mesh: Boundary , centring: 2 )


bdFourAlpha

public static java.lang.String bdFourAlpha
Name of the local parameter: Alpha parameter in Fourier condition [m-1] (default param value: 1.0 [m-1] , mesh: Boundary , centring: 2 )


bdFourValue

public static java.lang.String bdFourValue
Name of the local parameter: Right hand side parameter in Fourier condition [V] (default param value: 0.0 , mesh: Boundary , centring: 0 )


sourceId

public static java.lang.String sourceId
Name of the local parameter: Id/type of an artificial plasma source defined on the spacecraft (e.g. thruster or ion gun) - (default param value: -1 (no source) , mesh: SC , centring: 2 )


sourceCurrent

public static java.lang.String sourceCurrent
Name of the local parameter: Current of an artificial source defined on the spacecraft (NB: for some sources the unit can be different, e.g. the particle number, or the total current) [A / m2] (default param value: 0.0 , mesh: SC , centring: 2 )


sourceTemp

public static java.lang.String sourceTemp
Name of the local parameter: Temperature of the emitted Maxwellian distribution [eV] (default param value: 1.0 , mesh: SC , centring: 2 )


sourceMach

public static java.lang.String sourceMach
Name of the local parameter: Source Mach number (0 => Lambertian) [-] (default param value: 0.0 , mesh: SC , centring: 2 )


incomPart

public static java.lang.String incomPart
Name of the local parameter: - If 0, no particle are injected. - If 1, particles are injected (following the defined environment) - (default param value: 1 (injection) , mesh: Boundary , centring: 2 )


outgoPart

public static java.lang.String outgoPart
Name of the local parameter: - If 0, outgoing particles are lost (sink) - If 1, they bounce specularly (extra options possible) - (default param value: 0 (sink) , mesh: Boundary , centring: 2 )


volInteracFlag

public static java.lang.String volInteracFlag
Name of the local parameter: If 1, volume interaction is computed in that region (typically charge exchange) - (default param value: 0 (no) , mesh: Volume , centring: 3 )


backGroundDens

public static java.lang.String backGroundDens
Name of the local parameter: Fixed background density used to compute volume interaction (typically: neutral density) [m-3] (default param value: 0.0 , mesh: Volume , centring: 3 )

Constructor Detail

LocalParameter

public LocalParameter(java.lang.String name_,
                      java.lang.String type_,
                      java.lang.Object value_,
                      java.lang.String unit_,
                      java.lang.String comment_)
Default constructor. Supported types for value are SurfField or VolField (enforced)


LocalParameter

public LocalParameter(java.lang.String name_,
                      float[] value_,
                      int centring,
                      java.lang.Object mesh,
                      java.lang.String unit_,
                      java.lang.String comment_)
Dirty constructor for scalar field, for faster use from Jython UI layer

Method Detail

extractLocalParam

public static LocalParameter extractLocalParam(java.lang.String name)
Returns the local parameter of name name from the local parameter array (static variable of Global class). Returns null if not found.

Parameters:
name -
Returns: