All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface AT.Ac.univie.imp.loeffler.pde.threeD.fd.ConstGrid

public interface ConstGrid
extends Cloneable
Interface to the constant methods of class Grid.

Author:
Gerald Loeffler (Gerald.Loeffler@univie.ac.at)
See Also:
Grid

Method Index

 o add(ConstGrid)
create a new grid that is the sum of this grid and the given grid.
 o clone()
clone this grid
 o get(int, int, int)
returns the element at the specified position.
 o isBoundary(int, int, int)
determines if the specified element is at the boundary of the grid.
 o isInterior(int, int, int)
determines if the specified element is in the interior of the grid.
 o newInstance(int, double)
create a new grid with exactly the same handling of the boundary (i.e.
 o size()
returns the size of the grid, i.e.

Methods

 o get
 public abstract double get(int x,
                            int y,
                            int z)
returns the element at the specified position.

Parameters:
x - the x index of the element (0 <= x < size())
y - the y index of the element (0 <= y < size())
z - the z index of the element (0 <= z < size())
Returns:
the element (a double value) at the specified position
 o size
 public abstract int size()
returns the size of the grid, i.e. the number of elements in each of the 3 directions of the grid.

Returns:
the size
 o isInterior
 public abstract boolean isInterior(int x,
                                    int y,
                                    int z)
determines if the specified element is in the interior of the grid.

Parameters:
x - the x index of the element
y - the y index of the element
z - the z index of the element
Returns:
true if the element is in the interior of the grid, false otherwise
 o isBoundary
 public abstract boolean isBoundary(int x,
                                    int y,
                                    int z)
determines if the specified element is at the boundary of the grid.

Parameters:
x - the x index of the element
y - the y index of the element
z - the z index of the element
Returns:
true if the element is at the boundary of the grid, false otherwise
 o newInstance
 public abstract Grid newInstance(int size,
                                  double value)
create a new grid with exactly the same handling of the boundary (i.e. of the same tzpe as this object) but of an arbitrary size and set all interior elements to a given value.

Parameters:
size - the size of the grid which is to be created ( > 0)
value - the value to which all interior grid elements are to be set
Returns:
the newly constructed grid
 o clone
 public abstract Object clone()
clone this grid

Overrides:
clone in class Object
 o add
 public abstract Grid add(ConstGrid grid)
create a new grid that is the sum of this grid and the given grid. Only the interiors of the two grids are added. The types of the two grids must be identical and the handling of the boundary is copied from this grid.

Parameters:
grid - the grid to add to this grid
Returns:
the newly constructed grid that is the sum of the grids

All Packages  Class Hierarchy  This Package  Previous  Next  Index