|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectspis.Surf.SurfField.SurfField
spis.Surf.SurfField.ScalSurfField
Class Name : ScalSurfField
Project ref : SPIS project
File name : ScalSurfField.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 : Scalar Surface Field class.
Versions and anomalies correction :
Version number | Author (name, e-mail) | Corrections/Modifications |
0.1 | JF Roussel, roussel@onecert.fr | Creation |
Constructor Summary | |
ScalSurfField(ScalSurfField f)
Copy constructor |
|
ScalSurfField(SurfMesh surfMesh,
Centring centring)
Default constructor, a Table is allocated (set to zero). |
|
ScalSurfField(SurfMesh surfMesh,
Centring centring,
float value)
Constructor defining the field from a passed value. |
|
ScalSurfField(SurfMesh surfMesh,
Centring centring,
FloatScalTable values)
Constructor defining the field from a passed table. |
|
ScalSurfField(SurfMesh surfMesh,
Centring centring,
ScalFunctionOfVect f)
Constructor defining the field from a passed scalar function of node/cell/... position. |
Method Summary | |
void |
add(SurfField field)
Increments this field by another field (on the spot), which must indeed be a scalar field |
void |
applyFunc(ScalFunctionOfScal f)
Applies the function f to this field (on the spot). |
void |
divide(ScalSurfField scalField)
Divides this field by another field (on the spot) |
void |
equalTotalCurrent(SurfDistrib[] fluxes)
Computes the total current [A/fqce] resulting from an array of fluxes (surface distributions). |
SurfField |
getSimilar()
returns a similar SurfField: same subtype and same Centring |
FloatScalTable |
getTable()
Provides the values of the field at a the mesh elements it is defined on (surfaces/edges/nodes depending on centring). |
boolean |
isOfSameSubtype(SurfField f)
tests whether the passed field is of similar subtype |
boolean |
isUniform(float uniformValue)
Tests whether a Field is uniform (same value all over the mesh). |
void |
linComb(float a1,
SurfField field,
float a2)
Computes the linear combination a1*this + a2*field and affects it to this (field must be a scalar field) |
void |
mult(float factor)
Multiplies this field by a constant factor (on the spot) |
void |
mult(ScalSurfField scalField)
Multiplies this field by another field (on the spot) |
void |
mult(ScalSurfField scalField,
float factor)
Multiplies this field by another field and a constant factor (on the spot) |
void |
reset()
Sets this field to zero value |
ScalSurfField |
returnDivide(ScalSurfField scalField)
Divides this field by another field and returns the results as a new Field. |
void |
set(float value)
Sets this field to a uniform value |
void |
set(ScalFunctionOfNothing f)
Applies the function f (to nothing) and assigns the result to this Field hence equivalent to set(f.compute()). |
void |
set(ScalSurfField inField)
Sets this field to the same local values as the passed field (copies the values). |
void |
set(ScalSurfField inField,
int flag)
Sets this field to the same local values as the passed field (copies the values). |
void |
set(ScalSurfField inField,
ScalFunctionOfScal f)
Applies the function f to the passed field and assigns the result to this Field. |
void |
set(ScalSurfField inField1,
ScalSurfField inField2,
float x3,
ScalFunctionOf3Scal f)
Applies the function f to the passed Fields/value and assigns the result to this Field. |
void |
set(ScalSurfField inField1,
ScalSurfField inField2,
ScalFunctionOf2Scal f)
Applies the function f to the both passed field and assigns the result to this Field. |
void |
set(ScalSurfField inField1,
ScalSurfField inField2,
ScalSurfField inField3,
float x4,
ScalFunctionOf4Scal f)
Applies the function f to the passed Fields/value and assigns the result to this Field. |
void |
set(ScalSurfField inField1,
ScalSurfField inField2,
ScalSurfField inField3,
ScalSurfField inField4,
float x5,
ScalFunctionOf5Scal f)
Applies the function f to the passed Fields/value and assigns the result to this Field. |
void |
setTable(FloatScalTable values)
Sets the values of the field at a the mesh elements it is defined on (surfaces/edges/nodes depending on centring). |
void |
substract(float floatValue)
Decrements this field by a scalar (on the spot) |
void |
substract(SurfField field)
Decrements this field by another field (on the spot), which must indeed be a scalar field |
Methods inherited from class spis.Surf.SurfField.SurfField |
checkDim, checkSameMesh, checkSameMeshAndCentring, checkSameSubtype, getCentring, getName, getSm, getTime, setName, setTime |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ScalSurfField(SurfMesh surfMesh, Centring centring)
public ScalSurfField(SurfMesh surfMesh, Centring centring, FloatScalTable values)
public ScalSurfField(SurfMesh surfMesh, Centring centring, float value)
public ScalSurfField(SurfMesh surfMesh, Centring centring, ScalFunctionOfVect f)
public ScalSurfField(ScalSurfField f)
Method Detail |
public void mult(float factor)
mult
in class SurfField
public void mult(ScalSurfField scalField, float factor)
mult
in class SurfField
public void mult(ScalSurfField scalField)
mult
in class SurfField
public void divide(ScalSurfField scalField)
divide
in class SurfField
public void add(SurfField field)
add
in class SurfField
public void substract(SurfField field)
substract
in class SurfField
public void substract(float floatValue)
public void linComb(float a1, SurfField field, float a2)
linComb
in class SurfField
public ScalSurfField returnDivide(ScalSurfField scalField)
public void applyFunc(ScalFunctionOfScal f)
public SurfField getSimilar()
getSimilar
in class SurfField
public boolean isOfSameSubtype(SurfField f)
isOfSameSubtype
in class SurfField
public void equalTotalCurrent(SurfDistrib[] fluxes)
fluxes
- input surfqce distributionspublic void set(float value)
public void reset()
reset
in class SurfField
public void set(ScalSurfField inField)
public void set(ScalSurfField inField, ScalFunctionOfScal f)
public void set(ScalSurfField inField1, ScalSurfField inField2, ScalFunctionOf2Scal f)
public void set(ScalSurfField inField1, ScalSurfField inField2, float x3, ScalFunctionOf3Scal f)
public void set(ScalSurfField inField1, ScalSurfField inField2, ScalSurfField inField3, float x4, ScalFunctionOf4Scal f)
public void set(ScalSurfField inField1, ScalSurfField inField2, ScalSurfField inField3, ScalSurfField inField4, float x5, ScalFunctionOf5Scal f)
public void set(ScalFunctionOfNothing f)
public void set(ScalSurfField inField, int flag)
public FloatScalTable getTable()
public void setTable(FloatScalTable values)
public boolean isUniform(float uniformValue)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |