spis.Util.Monitor
Class ElecSuperNodeMonitor

java.lang.Object
  extended byspis.Util.Monitor.ElecSuperNodeMonitor

public class ElecSuperNodeMonitor
extends java.lang.Object

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

Description : Monitors data on electric super nodes: potentials and currents.

They are stored with predefined time steps. The monitor method must be invoked more often than the time steps, and the storage is done only if needed.
Currents (not potentials) are averaged over the time frame between each storage, it is this advised to call monitor(...) anytime a new current has been computed to get the best statistics.
These data are directed to:
- XyData time plots, to be retrieved by getResults() for post procesing
- Output files: potentials.txt, emittedCurrents.txt, collectedCurrents.txt (need to be manually closes at the end with closeOutputFiles())
- screen: only sums
NB: modifications by user is easy and encouraged: reduce the number of outputs if too many, average potentials if noisy also, etc.

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
ElecSuperNodeMonitor(MmfPlasma plasma, RCCabsSC sc, float esnMonitorStep)
          Default constructor
 
Method Summary
 void closeOutputFiles()
          Close monitoring output files: potentials.txt, emittedCurrents.txt, collectedCurrents.txt
 java.util.Vector getResults()
           
 void monitor(float t, SurfDistrib[] collectedCurrents, SurfDistrib[] emittedCurrents)
          Stores extra data at time t for monitoring if needed.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ElecSuperNodeMonitor

public ElecSuperNodeMonitor(MmfPlasma plasma,
                            RCCabsSC sc,
                            float esnMonitorStep)
Default constructor

Parameters:
plasma -
sc -
esnMonitorStep -
Method Detail

monitor

public void monitor(float t,
                    SurfDistrib[] collectedCurrents,
                    SurfDistrib[] emittedCurrents)
Stores extra data at time t for monitoring if needed.
Currents are to be passed to this method because they are not stored in permanent objects (SC) passed to this monitor constructor (contrarily to potentials)

Parameters:
t -
collectedCurrents - If null no storage
emittedCurrents - If null no storage

getResults

public java.util.Vector getResults()
Returns:
Returns the results of the monitoring (potentials and currents on/from super nodes versus time)

closeOutputFiles

public void closeOutputFiles()
Close monitoring output files: potentials.txt, emittedCurrents.txt, collectedCurrents.txt