spis.Vol.VolMesh
Class Centring

java.lang.Object
  extended byspis.Vol.VolMesh.Centring
All Implemented Interfaces:
java.io.Serializable

public class Centring
extends java.lang.Object
implements java.io.Serializable

Class Name : Centring
Project ref : SPIS project
File name : Centring.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 : Definition of the centring of a field (Vol ou Surf).
A field can centred on elements:
- of dimension 3
- of dimension 2
- of dimension 1
- of dimension 0
They can centred on elements:
- volumic elements (in which the plasma dynamics is modelled)
- surfacic elements (= volume boundaries, by definition)
- linear elements (this concept may not be used)
- nodes (points)
In 3D these concepts are identical, but in 2D volumic elements (in which the plasma dynamics is modelled) are of dimension 2, this is why these concepts are to be distinguished. Several methods thus provides values for these different concepts.
NB: for now, this class is used both for the centring of Volume and Surface fields, which is somewhat inconsistent with the separation of Volume and Surface Meshes and Fields

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

Field Summary
private  int absDim
          absolute dimension of centring elements (3=3D elements, 2=2D ...)
private  Geom geom
          pointer to the space geometry definition (to get the space dimension
private  int relDim
          relative dimension of centring elements (going down): 0=volumes, -1=surfaces...
 
Constructor Summary
Centring(Centring cent)
          Copy constructor
Centring(Geom geometry, int absoluteDim)
          One of the two default constructors: Geometry is first, absolute dimension follows.
Centring(int relativeDimension, Geom geometry)
          One of the two default constructors: first relative dimension, then Geometry.
 
Method Summary
 void checkHasRelDim(int relDim_)
           
 int getAbsDim()
          returns absolute dimension.
 Geom getGeom()
          returns the geometry of this Centring
 int getRelDim()
          Returns relative dimension (down).
 boolean isIdentical(Centring cent)
          tests whether centring is identical
 void setAbsDim(int d)
          Sets absolute dimension.
 void setRelDim(int d)
          Sets relative dimension (down).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

geom

private Geom geom
pointer to the space geometry definition (to get the space dimension


absDim

private int absDim
absolute dimension of centring elements (3=3D elements, 2=2D ...)


relDim

private int relDim
relative dimension of centring elements (going down): 0=volumes, -1=surfaces... (even for surface meshes where 0 cannot be met thus) but in 2D, volumes relDim is 2

Constructor Detail

Centring

public Centring(Geom geometry,
                int absoluteDim)
One of the two default constructors: Geometry is first, absolute dimension follows.


Centring

public Centring(int relativeDimension,
                Geom geometry)
One of the two default constructors: first relative dimension, then Geometry.


Centring

public Centring(Centring cent)
Copy constructor

Method Detail

checkHasRelDim

public void checkHasRelDim(int relDim_)

getAbsDim

public int getAbsDim()
returns absolute dimension.


getRelDim

public int getRelDim()
Returns relative dimension (down).
0=volumes, -1=surfaces ... but in 2D volumes are 2D.


setRelDim

public void setRelDim(int d)
Sets relative dimension (down).
0=volumes, -1=surfaces ... (even for surface meshes where 0 cannot be met thus)... but in 2D, volumes absolute dimension is 2.
Status: under development


setAbsDim

public void setAbsDim(int d)
Sets absolute dimension.


isIdentical

public boolean isIdentical(Centring cent)
tests whether centring is identical


getGeom

public Geom getGeom()
returns the geometry of this Centring