spis.Vol.VolField
Class PotVectVolField

java.lang.Object
  extended byspis.Vol.VolField.VolField
      extended byspis.Vol.VolField.VectVolField
          extended byspis.Vol.VolField.PotVectVolField
All Implemented Interfaces:
java.io.Serializable

public class PotVectVolField
extends VectVolField
implements java.io.Serializable

Class Name : PotVectVolField (Vectorial Volume Field stored through its potential)
Project ref : SPIS project
File name : PotVectVolField.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 : Vectorial Volume Field directly stored as a potential (as opposed to the direct storage of vectors)

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

Constructor Summary
PotVectVolField(ScalVolField potential)
          Constructor with ScalVolField provided.
PotVectVolField(VolMesh volMesh, Centring cent)
          Default constructor, empty VectTable is allocated of sub-type VeloVectTable (if a SpaceVectTable is wished, used other constructor).
 
Method Summary
 void computeField(PointList pl, Table val)
          Provides the values of the field at a list of arbitrary locations PointList (particle positions).
 void computePot(PointList pl, FloatScalTable val)
          Provides the potential at a list of arbitrary locations PointList (particle positions).
 void divide(ScalVolField f)
          Multiplies this field by another field (on the spot)
 ScalVolField getPot()
          Returns the potential this PotVectVolField derives from.
 FloatScalTable getPotTable()
          Provides the potential at the mesh elements it is defined on (nodes/cells/...depending on centring).
 VectTable getTable()
          Provides the values of the field at a the mesh elements it is defined on (nodes/cells/...depending on centring).
 void mult(float x)
          Multiplies this field by a scalar (on the spot)
 void mult(ScalVolField f)
          Multiplies this field by another field (on the spot)
 void setPotTable(FloatScalTable val)
          Sets the potential at the mesh elements it is defined on (nodes/cells/...depending on centring).
 
Methods inherited from class spis.Vol.VolField.VolField
checkDim, checkSameCentring, getCentring, getName, getTime, getVm, setName, setTime
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PotVectVolField

public PotVectVolField(VolMesh volMesh,
                       Centring cent)
Default constructor, empty VectTable is allocated of sub-type VeloVectTable (if a SpaceVectTable is wished, used other constructor).


PotVectVolField

public PotVectVolField(ScalVolField potential)
Constructor with ScalVolField provided.

Method Detail

mult

public void mult(ScalVolField f)
Multiplies this field by another field (on the spot)

Specified by:
mult in class VolField

mult

public void mult(float x)
Multiplies this field by a scalar (on the spot)

Specified by:
mult in class VolField

divide

public void divide(ScalVolField f)
Multiplies this field by another field (on the spot)

Specified by:
divide in class VolField

computeField

public void computeField(PointList pl,
                         Table val)
Provides the values of the field at a list of arbitrary locations PointList (particle positions).
The result table val must be of the same type as the field, i.e. vectorial here.

Specified by:
computeField in class VolField
See Also:
EField#computeField(PointList, Table)

getTable

public VectTable getTable()
Provides the values of the field at a the mesh elements it is defined on (nodes/cells/...depending on centring).


computePot

public void computePot(PointList pl,
                       FloatScalTable val)
Provides the potential at a list of arbitrary locations PointList (particle positions).

Specified by:
computePot in class VectVolField

getPotTable

public FloatScalTable getPotTable()
Provides the potential at the mesh elements it is defined on (nodes/cells/...depending on centring).

Specified by:
getPotTable in class VectVolField

setPotTable

public void setPotTable(FloatScalTable val)
Sets the potential at the mesh elements it is defined on (nodes/cells/...depending on centring).


getPot

public ScalVolField getPot()
Returns the potential this PotVectVolField derives from.

Overrides:
getPot in class VectVolField