spis.Circ.CircField
Class DirCircField

java.lang.Object
  extended byspis.Circ.CircField.CircField
      extended byspis.Circ.CircField.DirCircField

public class DirCircField
extends CircField

Class Name : DirCircField
Project ref : SPIS project
File name : DirCircField.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 : Direct-storage Circuit Field class, i.e. stored in a table (as opposed to other possible version, which could be analytical/global)
Values at each circuit field node are really stored in a table.

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
DirCircField(CircField circField)
          Copy constructor
DirCircField(Circ circ, float initValue)
          Constructor with intialisation value, generates a table of dimension NodeNb.
DirCircField(Circ circ, float initValue, int dim)
          Constructor with intialisation value and dimension of the array to be created, which can be different from NodeNb since reduced nodes can be considered with the circuit solver.
DirCircField(Circ circ, FloatScalTable values)
          Constructor with value array passed.
DirCircField(Circ circ, int dim)
          Constructor with dimension of the array to be created, which can be different from NodeNb since reduced nodes can be considered with the circuit solver.
 
Method Summary
 FloatScalTable getTable()
          Returns the field values on the circuit nodes in table val
 void increment(CircField c)
          Increments the current CircField by the passed CircField.
 void linComb(float a1, CircField c, float a2)
          performs the following linear comination o nthis circuit field: this = a1 this + a2 c.
 
Methods inherited from class spis.Circ.CircField.CircField
getCirc
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DirCircField

public DirCircField(Circ circ,
                    float initValue)
Constructor with intialisation value, generates a table of dimension NodeNb.


DirCircField

public DirCircField(Circ circ,
                    float initValue,
                    int dim)
Constructor with intialisation value and dimension of the array to be created, which can be different from NodeNb since reduced nodes can be considered with the circuit solver.
The scope of this constructor should thus be limited to packages CircField and Circ (they should thus be merged and this constructor be protected).


DirCircField

public DirCircField(Circ circ,
                    int dim)
Constructor with dimension of the array to be created, which can be different from NodeNb since reduced nodes can be considered with the circuit solver.
The scope of this constructor should thus be limited to packages CircField and Circ (they should thus be merged and this constructor be protected).


DirCircField

public DirCircField(Circ circ,
                    FloatScalTable values)
Constructor with value array passed. This array can be different of dimension different from NodeNb since reduced nodes can be considered with the circuit solver.


DirCircField

public DirCircField(CircField circField)
Copy constructor

Method Detail

linComb

public void linComb(float a1,
                    CircField c,
                    float a2)
performs the following linear comination o nthis circuit field: this = a1 this + a2 c.

Specified by:
linComb in class CircField

increment

public void increment(CircField c)
Increments the current CircField by the passed CircField. Both must be of same dimension (checked at table level).

Specified by:
increment in class CircField

getTable

public FloatScalTable getTable()
Returns the field values on the circuit nodes in table val

Specified by:
getTable in class CircField