spis.Top.Simulation
Class GeoExample

java.lang.Object
  extended byspis.Top.Simulation.Simulation
      extended byspis.Top.Simulation.PlasmaScSimulation
          extended byspis.Top.Simulation.GeoExample

public class GeoExample
extends PlasmaScSimulation

Class Name : GeoExample
Project ref : SPIS project
File name : GeoExample.java
File type : class
Copyright : ONERA, 2 Av. E. Belin, 31055 Toulouse cedex, France http://www.onecert.fr
Status : under development
Creation : 11 mars 2004
Modification :

Description : Basic example of GEO orbit simulation.
High energy environment, PIC model of ions, Boltzmann for electrons

Versions and anomalies correction :

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


Version:
0.1
Author:
JF Roussel

Constructor Summary
GeoExample()
          temporary constructor without meshes, to allow to build this from the framework without meshes
GeoExample(RCCabsSC spacecraft, MmfPlasma plasma)
          Constructor with spacecraft and plasma, which can only be called by the Top object, not from the framework, unless Jython code is enhanced to build a SC and a plasma.
GeoExample(ThreeDUnstructVolMesh vm, ThreeDUnstructSurfMesh bsm, ThreeDUnstructSurfMesh scsm)
          Default constructor
 
Method Summary
 void buildScAndPlasma()
          initialisations: builds a spacecraft and a plasma objects (and sets them in PlasmaScSimulation) and the connections between them (particle fluxes, potentials and current transfers)
 XyzData[] getCurveTimePlots()
          returns two arbitrary sets (y(x))(t) for post-processing testing
 Trajectory[] getTrajectories()
          returns two arbitrary trajectories for post-processing testing, which might even be out of the mesh if changed (it is contained in a [0-5]^3 cube, which e.g. fits in Demo_5.geo).
 void init()
          standard initialisations: buffer allocation...
 void integrate(float duration)
          Time integration of the coupled plasma-spacecraft dynamics over the time t.
 
Methods inherited from class spis.Top.Simulation.PlasmaScSimulation
getBdSurfResults, getMFPlasma, getRCCabsSC, getScSurfResults, getVolResults, setPlasma, setSC
 
Methods inherited from class spis.Top.Simulation.Simulation
exportUIData, getBdSurfMesh, getGlobalParameters, getResults, getScalTimePlots, getScSurfMesh, getVolMesh, importUIData, setBdSurfMesh, setDefaultInputPath, setDefaultOutputPath, setDefaultPaths, setGlobalParameters, setResults, setScSurfMesh, setVolMesh
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GeoExample

public GeoExample(ThreeDUnstructVolMesh vm,
                  ThreeDUnstructSurfMesh bsm,
                  ThreeDUnstructSurfMesh scsm)
Default constructor

Parameters:
vm - volume mesh
bsm - external boundary surface mesh
scsm - spacecraft surface mesh

GeoExample

public GeoExample(RCCabsSC spacecraft,
                  MmfPlasma plasma)
Constructor with spacecraft and plasma, which can only be called by the Top object, not from the framework, unless Jython code is enhanced to build a SC and a plasma.


GeoExample

public GeoExample()
temporary constructor without meshes, to allow to build this from the framework without meshes

Method Detail

init

public void init()
standard initialisations: buffer allocation...


buildScAndPlasma

public void buildScAndPlasma()
initialisations: builds a spacecraft and a plasma objects (and sets them in PlasmaScSimulation) and the connections between them (particle fluxes, potentials and current transfers)


integrate

public void integrate(float duration)
Time integration of the coupled plasma-spacecraft dynamics over the time t.
The results of this time evolution are the update of the plasma and spacecraft state variables (defined in the derived classes). It basically consists in an iteration of calls to the plasma dynamics and spacecraft potential update. Several different versions can be developed in derived classes.

Specified by:
integrate in class Simulation

getCurveTimePlots

public XyzData[] getCurveTimePlots()
returns two arbitrary sets (y(x))(t) for post-processing testing

Overrides:
getCurveTimePlots in class PlasmaScSimulation
See Also:
Simulation.getCurveTimePlots()

getTrajectories

public Trajectory[] getTrajectories()
returns two arbitrary trajectories for post-processing testing, which might even be out of the mesh if changed (it is contained in a [0-5]^3 cube, which e.g. fits in Demo_5.geo).

Overrides:
getTrajectories in class PlasmaScSimulation
See Also:
spis.Top.Simulation.Simulation#getParticleTrajectories()