|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectspis.Top.Simulation.Simulation
spis.Top.Simulation.PlasmaScSimulation
Class Name : PlasmaScSimulation
Project ref : SPIS project
File name : PlasmaScSimulation.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 : Generic simulation class with major two variables:
- the spacecraft
- the plasma
and the meshes they rely upon.
It is an intermediate abstract layer un the derivation scheme between the parent
class Simulation, which simply enforces communication with the framework
(meshes as input results as output), and the next non-abstract derived classes
e.g. GeoSimulation, LeoSimulation, SeePhotoemissionSimulation...
(for now only exemple Simulations are implmented).
This class embeds the objects that are usually needed in any simulation
(a spaceacraft and a plasma), which allow to develop some generic routines
only depending on the existence of these objects (at least the getters and setters).
NB: It the responsibility of the developers of derived classes to define the
spacecraft and plasma at this class level through the setters, since it could
not be enforced to pass such complex objects in PlasmaScSimulation constructor
(they need a few instructions to be built from the meshes that are passed
by the framework to derived classes, which is incompatible with the constraint
to call the parent-class constructor in the first line of a constructor).
Versions and anomalies correction :
Version number | Author (name, e-mail) | Corrections/Modifications |
0.1 | JF Roussel, roussel@onecert.fr | Creation |
Field Summary | |
protected ThreeDUnstructSurfMesh |
bdSurfMesh
the 3D untructured surface mesh, external boundary of the simulation box (not a physical surface) |
protected MmfPlasma |
plasma
plasma model (might be a generic plasma later, for now an MmfPlasma) |
protected RCCabsSC |
sc
spacecraft model (might be a generic SC later, for now an RCCabsSC) |
protected ThreeDUnstructSurfMesh |
scSurfMesh
the 3D untructured spacecraft surface mesh, (a physical surface) |
protected ThreeDUnstructVolMesh |
volMesh
the 3D untructured volume mesh, of the simulation box |
Fields inherited from class spis.Top.Simulation.Simulation |
results |
Constructor Summary | |
protected |
PlasmaScSimulation()
temporary constructor without meshes, to allow to build this from the framework without meshes |
|
PlasmaScSimulation(ThreeDUnstructVolMesh vm,
ThreeDUnstructSurfMesh bsm,
ThreeDUnstructSurfMesh scsm)
Main constructor. |
|
PlasmaScSimulation(ThreeDUnstructVolMesh vm,
ThreeDUnstructSurfMesh bsm,
ThreeDUnstructSurfMesh scsm,
GlobalParameter[] globalParameters)
Constructor with global parameters |
Method Summary | |
SurfField[] |
getBdSurfResults()
Returns data on the external boundary surface resulting of the computation, typically potential and current surface maps. |
XyzData[] |
getCurveTimePlots()
returns two arbitrary sets (y(x))(t) for post-processing testing |
MmfPlasma |
getMFPlasma()
Returns a pointer to the plasma of the simulation. |
RCCabsSC |
getRCCabsSC()
Returns a pointer to the spacecraft of the simulation. |
SurfField[] |
getScSurfResults()
Returns data on spacecraft surface resulting of the computation, typically potential and current surface maps. |
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). |
VolField[] |
getVolResults()
Returns volume data resulting of the computation, typically potential and density volume maps. |
protected int |
selectSurfResults(SurfField[] specificData,
int ctr,
SurfMesh sm)
Adds surface results (SurfField-s) living on the specified SurfMesh sm to the array specificData, starting at the index ctr of the passed array specific data (it must have been dimensioned to a sufficient size before the call, use results.size()). |
void |
setPlasma(MmfPlasma plasma_)
Sets the simulation plasma. |
void |
setSC(RCCabsSC spacecraft)
Sets the simulation spacecraft. |
Methods inherited from class spis.Top.Simulation.Simulation |
exportUIData, getBdSurfMesh, getGlobalParameters, getResults, getScalTimePlots, getScSurfMesh, getVolMesh, importUIData, integrate, selectResults, setBdSurfMesh, setDefaultInputPath, setDefaultOutputPath, setDefaultPaths, setGlobalParameters, setResults, setScSurfMesh, setVolMesh |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected RCCabsSC sc
protected MmfPlasma plasma
protected ThreeDUnstructVolMesh volMesh
protected ThreeDUnstructSurfMesh bdSurfMesh
protected ThreeDUnstructSurfMesh scSurfMesh
Constructor Detail |
public PlasmaScSimulation(ThreeDUnstructVolMesh vm, ThreeDUnstructSurfMesh bsm, ThreeDUnstructSurfMesh scsm)
public PlasmaScSimulation(ThreeDUnstructVolMesh vm, ThreeDUnstructSurfMesh bsm, ThreeDUnstructSurfMesh scsm, GlobalParameter[] globalParameters)
protected PlasmaScSimulation()
Method Detail |
public VolField[] getVolResults()
Simulation
getVolResults
in class Simulation
Simulation.getVolResults()
public SurfField[] getScSurfResults()
Simulation
getScSurfResults
in class Simulation
public SurfField[] getBdSurfResults()
getBdSurfResults
in class Simulation
public RCCabsSC getRCCabsSC()
public MmfPlasma getMFPlasma()
public void setSC(RCCabsSC spacecraft)
public void setPlasma(MmfPlasma plasma_)
protected int selectSurfResults(SurfField[] specificData, int ctr, SurfMesh sm)
specificData
- ctr
- sm
-
public XyzData[] getCurveTimePlots()
getCurveTimePlots
in class Simulation
Simulation.getCurveTimePlots()
public Trajectory[] getTrajectories()
getTrajectories
in class Simulation
spis.Top.Simulation.Simulation#getParticleTrajectories()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |