class Box

A Rectangular Domain on an Integer Lattice

Inheritance:

Box


public members:

Constructors
Box ()
~Box ()
Box (const IntVect& small, const IntVect& big)
void define(const IntVect& small, const IntVect& big)
Box (const IntVect& small, const int* vec_len)
Box (const IntVect& small, const IntVect& big, const IntVect& typ)
Box (const IntVect& small, const IntVect& big, const IndexType& t)
Box (const Box& b)

Accessors
const IntVect& smallEnd () const
IntVect sideEnd(Side::LoHiSide a_side) const
int smallEnd (int dir) const
const IntVect& bigEnd () const
int bigEnd (int dir) const
const int* loVect () const
const int* hiVect () const
const int* getVect () const
long index (const IntVect& v) const

centering
IndexType ixType () const
IntVect type () const
IndexType::CellIndex type (int dir) const

size functions
const IntVect& size () const
int size (int dir) const
bool numPtsOK () const
long numPts () const
bool volumeOK () const
long volume () const
int longside (int& dir) const
int longside () const
int shortside (int& dir) const
int shortside () const

Comparison Functions
bool isEmpty () const
bool contains (const IntVect& p) const
bool contains (const Box& b) const
bool intersects (const Box& b) const
bool intersectsNotEmpty (const Box& b) const
bool sameSize (const Box& b) const
bool sameType (const Box &b) const
bool operator== (const Box& b) const
bool operator!= (const Box& b) const
bool cellCentered () const
bool operator < (const Box& rhs) const

Modification Functions
Box& operator= (const Box& b)
Box& setSmall (const IntVect& sm)
Box& setSmall (int dir, int sm_index)
Box& setBig (const IntVect& bg)
Box& setBig (int dir, int bg_index)
Box& setRange (int dir, int sm_index, int n_cells = 1)

centering type conversion functions
Box& convert (IndexType typ)
Box& convert (const IntVect& typ)
Box& convert (int dir, IndexType::CellIndex typ)
Box& surroundingNodes ()
Box& surroundingNodes (int dir)
friend Box surroundingNodes (const Box& b, int dir)
friend Box surroundingNodes (const Box& b)
Box& enclosedCells ()
Box& enclosedCells (int dir)
friend Box enclosedCells (const Box& b, int dir)
friend Box enclosedCells (const Box& b)

shift functions
Box& shift (int dir, int nzones)
Box& shift (const IntVect& iv)
Box& shiftHalf (int dir, int num_halfs)
Box& shiftHalf (const IntVect& iv)
Box& operator+= (const IntVect& v)
Box operator+ (const IntVect& v) const
Box& operator-= (const IntVect& v)
Box operator- (const IntVect& v) const

neighbor box functions
friend Box bdryBox(const Box& b, int dir, Side::LoHiSide a_sd, int len)
friend Box bdryLo (const Box& b, int dir, int len)
friend Box bdryHi (const Box& b, int dir, int len)
friend Box adjCellLo (const Box& b, int dir, int len)
friend Box adjCellHi (const Box& b, int dir, int len)

intersection functions
Box operator& (const Box&) const
Box& operator&= (const Box&)
friend Box adjCellBox (const Box& b, int dir, Side::LoHiSide a_side, int len)
Box& minBox (const Box& b)
friend Box minBox (const Box& b1, const Box& b2)

grow functions
Box& grow (int i)
friend Box grow (const Box& b, int i)
Box& grow (const IntVect& v)
friend Box grow (const Box& b, const IntVect& v)
Box& grow (int idir, int n_cell)
Box& growLo (int idir, int n_cell=1)
Box& growDir (int a_idir, const Side::LoHiSide& a_sd, int a_cell)
Box& growHi (int idir, int n_cell=1)

refinement
Box& refine (int refinement_ratio)
friend Box refine (const Box& b, int refinement_ratio)
Box& refine (const IntVect& refinement_ratio)
friend Box refine (const Box& b, const IntVect& refinement_ratio)

coarsening
Box& coarsen (int refinement_ratio)
friend Box coarsen (const Box& b, int refinement_ratio)
Box& coarsen (const IntVect& refinement_ratio)
friend Box coarsen (const Box& b, const IntVect& refinement_ratio)

misc
Box chop (int dir, int chop_pnt)

I/O Functions
friend std::ostream& operator<< (std::ostream& os, const Box& bx)
friend std::istream& operator>> (std::istream& os, Box& bx)
void p() const
void dumpOn (std::ostream& strm) const

Box Constants
void computeBoxLen ()

Documentation

A Box is an abstraction for defining discrete rectangular regions of SpaceDim-dimensioned indexing space. Boxes have an IndexType, which defines IndexType::CELL or IndexType::NODE based points for each direction and a low and high IntVect which defines the lower and upper corners of the Box. Boxes can exist in positive and negative indexing space.

There is a set of canonical Empty Boxes, once for each centering type. The cell-centered Empty Box can be accessed as Box::Empty.

Box is a dimension dependent class, so SpaceDim must be defined as either 1, 2, or 3 when compiling.

Box ()
The default constructor. The constructed Box is empty.

~Box ()
The destructor.

Box (const IntVect& small, const IntVect& big)
Construct cell-centered type Box. It is an error if small is greater than big.

void define (const IntVect& small, const IntVect& big)
Construct cell-centered type Box. It is an error if small is greater than big.

Box (const IntVect& small, const int* vec_len)
Construct Box with specified lengths. It is an error if the lengths are negative.

Box (const IntVect& small, const IntVect& big, const IntVect& typ)
Construct Box with given type. small and big are expected to be consistent with given type. It is an error if small is greater than big. It is an error if typ is not convertible to an IndexType.

Box (const IntVect& small, const IntVect& big, const IndexType& t)
Construct Box with given type. small and big are expected to be consistent with given type. It is an error if small is greater than big.

Box (const Box& b)
The copy constructor.

const IntVect& smallEnd () const
Returns the lower corner of this Box.

IntVect sideEnd (Side::LoHiSide a_side) const
return smallend if side is low, bigend if side is high.

int smallEnd (int dir) const
Returns the coordinate of the low end of this Box in the given direction. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

const IntVect& bigEnd () const
Returns the upper corner of this Box.

int bigEnd (int dir) const
Returns the coordinate of the high end of this Box in the given direction. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

const int* loVect () const
Returns a constant pointer to the array of low end coordinates. Useful for calls to Fortran. It should not be used in any other circumstances.

const int* hiVect () const
Returns a constant pointer the array of high end coordinates. Useful for calls to Fortran. It should not be used in any other circumstances.

const int* getVect () const
Returns a constant pointer to the array of coordinates in the Box. Useful for calls to Fortran, but otherwise too dangerous for use.

long index (const IntVect& v) const
Returns offset of point from smallend; i.e. index(smallend) -> 0, bigend would return volume()-1. Is used in accessing FArrayBox.

IndexType ixType () const
Return the indexing type of this Box.

IntVect type () const
Return the indexing type of this Box.

IndexType::CellIndex type (int dir) const
Return the indexing type of this Box in the specified direction. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

const IntVect& size () const
Return an IntVect containing the size of this Box in each coordinate direction.

int size (int dir) const
Return the size of this Box in the specified coordinate direction. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

bool numPtsOK () const
Is the number calculated by numPts() representable in a long?

long numPts () const
Return the volume, in indexing space, of region enclosed by this Box. This is identical to volume(). Abort()s if the number cannot be represented in a long.

bool volumeOK () const
Is the number calculated by volume() representable in a long?

long volume () const
Return the volume, in indexing space, of region enclosed by this Box. This is identical to numPts(). Abort()s if the number cannot be represented in a long.

int longside (int& dir) const
Returns length of the longest side of this Box. The argument dir is modified to give direction with longest side: 0...SpaceDim-1. Ignores type.

int longside () const
Returns length of the longest side of this Box. Ignores type.

int shortside (int& dir) const
Returns length of shortest side of this Box. The argument dir is modified to give direction with shortest side: 0...SpaceDim-1. Ignores type.

int shortside () const
Returns length of the shortest side of this Box. Ignores type.

bool isEmpty () const
Returns true if this Box is empty.

bool contains (const IntVect& p) const
Returns true if argument is contained within this Box. An empty Box does not contain and is not contained by any Box, including itself.

bool contains (const Box& b) const
Returns true if argument is contained within this Box. It is an error if the Boxes have different types. An empty Box does not contain any IntVect.

bool intersects (const Box& b) const
Returns true if this Box and the argument have non-null intersections. It is an error if the Boxes have different types. An empty Box does not intersect any Box, including itself.

bool intersectsNotEmpty (const Box& b) const
Returns true if this Box and the argument have non-null intersections. It is an error if the Boxes have different types. This routine does not perform the check to see if *this or b are empty boxes. It is the callers responsibility to ensure that this never happens. If you are unsure, the use the .intersects(..) routine.

bool sameSize (const Box& b) const
Returns true if this Box and the argument are the same size, ie translates of each other. It is an error if they have different types.

bool sameType (const Box &b) const
Returns true if this Box and the argument have same type.

bool operator== (const Box& b) const
Returns true if this Box and the argument are identical, including type.

bool operator!= (const Box& b) const
Returns true if this Box and the argument differ, including type.

bool cellCentered () const
Returns true if this Box is cell-centered in all indexing directions.

bool operator < (const Box& rhs) const
Returns true if this Box is lexigraphically less than rhs box. All comparison is based on lower box corner. In the name of coding efficiency, we do not handle the case where two boxes have the same lower left corner. In DEBUG mode, this is checked for with an assert.

Box& operator= (const Box& b)
The assignment operator.

Box& setSmall (const IntVect& sm)
Redefine the lower corner of this Box. It is an error if the specified corner is greater than the exisiting upper corner of this Box.

Box& setSmall (int dir, int sm_index)
Redefines the lower end of this Box in the specified coordinate direction. It is an error if the specified value is greater than the exisiting upper end of this Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

Box& setBig (const IntVect& bg)
Redefines the upper corner of this Box. It is an error if the specified corner is less than the exisiting lower corner of this Box.

Box& setBig (int dir, int bg_index)
Redefines the upper end of this Box in the specified coordinate direction. It is an error if the specified value is less than the exisiting lower end of this Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

Box& setRange (int dir, int sm_index, int n_cells = 1)
Set the entire range in a given direction, starting at sm_index with length n_cells. It is an error if n_cells <= 0.

Box& convert (IndexType typ)
Modifies this Box by converting from the current type into the argument type. This may change the Box coordinates:

type CELL -> NODE : increase coordinate by one on high end.

type NODE -> CELL : reduce coordinate by one on high end.

other type mappings make no change.

Box& convert (const IntVect& typ)
Modifies this Box by converting from the current type into the argument type. This may change the Box coordinates:
type CELL -> NODE : increase coordinate by one on high end.
type NODE -> CELL : reduce coordinate by one on high end.
other type mappings make no change. It is an error if typ is not convertible to an IndexType.

Box& convert (int dir, IndexType::CellIndex typ)
Modifies this Box by converting from the current type into the argument type. This may change the Box coordinates:

type CELL -> NODE : increase coordinate by one on high end.

type NODE -> CELL : reduce coordinate by one on high end.

Other type mappings make no change. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

Box& surroundingNodes ()
Modifies this Box by converting it to NODE type in all directions. This increases all components of the upper corner by one. The Empty Box is not modified by this function except for changing of type.

Box& surroundingNodes (int dir)
Modifies this Box by converting it to NODE type in given direction. This increases the component of the upper corner in the given direction by one. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.

friend Box surroundingNodes (const Box& b, int dir)
Returns a Box with NODE based coordinates in direction dir that encloses the argument Box. NOTE: equivalent to b.convert(dir,NODE). NOTE: error if b.type(dir) == NODE. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.

friend Box surroundingNodes (const Box& b)
Returns a Box with NODE based coordinates in all directions that encloses argument Box. The upper corner of the return Box will be one more in all components than the upper corner of the argument Box. The Empty Box is not modified by this function except for changing of type.

Box& enclosedCells ()
Modifies this Box by converting it to CELL type in all directions. This decreases all components of the upper corner by one. The Empty Box is not modified by this function except for changing of type.

Box& enclosedCells (int dir)
Modifies this Box by converting it to CELL type in given direction. This decreases the component of the upper corner in the given direction by one. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.

friend Box enclosedCells (const Box& b, int dir)
Returns a Box with CELL based coordinates in direction dir that is enclosed by argument Box. NOTE: equivalent to b.convert(dir,CELL). NOTE: error if b.type(dir) == CELL. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.

friend Box enclosedCells (const Box& b)
Returns a Box with CELL based coordinates in all directions that is enclosed by argument Box. The upper corner of the return Box will be one less in all components than the upper corner of the argument Box. The Empty Box is not modified by this function except for changing of type.

Box& shift (int dir, int nzones)
Modifies this Box by shifting it nzones indexing positions in coordinate direction dir. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function.

Box& shift (const IntVect& iv)
Modifies this Box by shifting. Equivalent to b.shift(0,iv[0]).shift(1,iv[1]) .... The Empty Box is not modified by this function.

Box& shiftHalf (int dir, int num_halfs)
This member modifies this Box by shifting by "half" indices, thereby converting the Box from type CELL to NODE or vice-versa. b.shiftHalf(0,1) shifts b to the right by 1/2 cells. b.shiftHalf(1,-3) shifts b in the -j direction by 3/2 cells. NOTE: If num_halfs is EVEN the shift is num_halfs/2 full zones and hence will not change the type. This is: b.shifthalf(4) == b.shift(2). Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.

Box& shiftHalf (const IntVect& iv)
Modifies this Box by shifting by half indices. Equivalent to b.shiftHalf(0,iv[0]).shiftHalf(1,iv[1]) ... The Empty Box is not modified by this function except for changing of type.

Box& operator+= (const IntVect& v)
Modifies this Box by shifting it by given IntVect. The Empty Box is not modified by this function.

Box operator+ (const IntVect& v) const
Returns a Box that is this Box shifted by the given IntVect. The Empty Box is not modified by this function.

Box& operator-= (const IntVect& v)
Modifies this Box by shifting it by given IntVect. The Empty Box is not modified by this function.

Box operator- (const IntVect& v) const
Returns a Box that is this Box shifted by the given IntVect. The Empty Box is not modified by this function.

friend Box bdryLo (const Box& b, int dir, int len)
Returns the edge-centered Box (in direction dir) defining the low side of the argument Box. The output Box will have the given length in the given direction. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The neighbor of an Empty Box is an Empty Box of the appropriate type.

friend Box bdryHi (const Box& b, int dir, int len)
Returns the edge-centered Box (in direction dir) defining the high side of the argument Box. The return Box will have the given length in the given direction. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The neighbor of an Empty Box is an Empty Box of the appropriate type.

friend Box adjCellLo (const Box& b, int dir, int len)
Returns the cell centered Box of the given length adjacent to the argument Box on the low end along the given coordinate direction. The return Box is identical to the argument Box in the other directions. The return Box and the argument Box have an empty intersection.

NOTE: len >= 1.

NOTE: Box retval = adjCellLo(b,dir,len) is equivalent to the following set of operations:

Box retval(b);

retval.convert(dir,Box::CELL);

retval.setrange(dir,retval.smallEnd(dir)-len,len);

Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The neighbor of an Empty Box is an Empty Box of the appropriate type.

friend Box adjCellHi (const Box& b, int dir, int len)
Returns the cell centered Box of the given length adjacent to the argument Box on the high end along the given coordinate direction. The return Box is identical to the argument Box in the other directions. The return Box and the argument Box have an empty intersection.

NOTE: len >= 1.

NOTE: Box retval = adjCellHi(b,dir,len) is equivalent to the following set of operations:

Box retval(b);

retval.convert(dir,Box::CELL);

retval.setrange(dir,retval.bigEnd(dir)+1,len);

Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The neighbor of an Empty Box is an Empty Box of the appropriate type.

Box operator& (const Box&) const
Returns the Box that is intersection of this Box and the argument Box. Intersection is commutative. The Boxes MUST be of same type. The intersection of the Empty Box and any Box is the Empty Box.

Box& operator&= (const Box&)
Modifies this Box by intersection with the argument Box. The Boxes MUST be of the same type. The intersection of the Empty Box and any Box is the Empty Box.

Box& minBox (const Box& b)
Modifies this Box to that of the minimum Box containing both this Box and the argument Box. Both Boxes must have identical type.

friend Box minBox (const Box& b1, const Box& b2)
Returns a Box that is the minimum Box containing both the argument Boxes. Both Boxes must have identical type.

Box& grow (int i)
Modifies this Box by growing it in all directions by given amount. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks the Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box.

friend Box grow (const Box& b, int i)
Returns a Box that is the argument Box grown in all directions by given amount. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks the Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box.

Box& grow (const IntVect& v)
Modifies this Box by growing it in each direction by specified amount. The Empty Box is not modified by this function. NOTE: components of iv may be negative, which would shrink this Box. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box.

friend Box grow (const Box& b, const IntVect& v)
Returns a Box that is the argument Box grown in each direction by specified amount. The Empty Box is not modified by this function. NOTE: components of iv may be negative, which would return a shrunken Box. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box.

Box& grow (int idir, int n_cell)
Modifies this Box by growing it on the low and high end by n_cell cells in direction idir. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks this Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

Box& growLo (int idir, int n_cell=1)
Modifies this Box by growing it on the low end by n_cell cells in direction idir. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks this Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

Box& growDir (int a_idir, const Side::LoHiSide& a_sd, int a_cell)
growLo if a_sd == Side::Lo
growHi if a_sd= = Side::Hi

Box& growHi (int idir, int n_cell=1)
Modifies this Box by growing it on the high end by n_cell cells in direction idir. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks the Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

Box& refine (int refinement_ratio)
Modifies this Box by refining it by given (positive) refinement ratio. The Empty Box is not modified by this function.

NOTE: if type(dir) = CELL centered: lo <- lo*ratio and hi <- (hi+1)*ratio - 1.

NOTE: if type(dir) = NODE centered: lo <- lo*ratio and hi <- hi*ratio.

friend Box refine (const Box& b, int refinement_ratio)
Returns a Box that is the argument Box refined by given (positive) refinement ratio. The Empty Box is not modified by this function.

NOTE: if type(dir) = CELL centered: lo <- lo*ratio and hi <- (hi+1)*ratio - 1.

NOTE: if type(dir) = NODE centered: lo <- lo*ratio and hi <- hi*ratio.

Box& refine (const IntVect& refinement_ratio)
Modifies this Box by refining it by given (positive) refinement ratio. The Empty Box is not modified by this function.

NOTE: if type(dir) = CELL centered: lo <- lo*ratio and hi <- (hi+1)*ratio - 1.

NOTE: if type(dir) = NODE centered: lo <- lo*ratio and hi <- hi*ratio.

friend Box refine (const Box& b, const IntVect& refinement_ratio)
Returns a Box that is the argument Box refined by given (positive) refinement ratio. The Empty Box is not modified by this function.

NOTE: if type(dir) = CELL centered: lo <- lo*ratio and hi <- (hi+1)*ratio - 1.

NOTE: if type(dir) = NODE centered: lo <- lo*ratio and hi <- hi*ratio.

Box& coarsen (int refinement_ratio)
Modifies this Box by coarsening it by given (positive) refinement ratio. The Empty Box is not modified by this function.

NOTE: if type(dir) = CELL centered: lo <- lo/ratio and hi <- hi/ratio.

NOTE: if type(dir) = NODE centered: lo <- lo/ratio and hi <- hi/ratio + ((hi%ratio)==0 ? 0 : 1).

That is, refinement of coarsened Box must contain the original Box.

friend Box coarsen (const Box& b, int refinement_ratio)
Returns a Box that is the argument Box coarsened by given (positive) refinement ratio. The Empty Box is not modified by this function.

NOTE: if type(dir) = CELL centered: lo <- lo/ratio and hi <- hi/ratio.

NOTE: if type(dir) = NODE centered: lo <- lo/ratio and hi <- hi/ratio + ((hi%ratio)==0 ? 0 : 1).

That is, refinement of coarsened Box must contain the original Box.

Box& coarsen (const IntVect& refinement_ratio)
Modifies this Box by coarsening by given (positive) refinement ratio. The Empty Box is not modified by this function.

NOTE: if type(dir) = CELL centered: lo <- lo/ratio and hi <- hi/ratio.

NOTE: if type(dir) = NODE centered: lo <- lo/ratio and hi <- hi/ratio + ((hi%ratio)==0 ? 0 : 1).

That is, refinement of coarsened Box must contain the original Box.

friend Box coarsen (const Box& b, const IntVect& refinement_ratio)
Returns a Box that is the argument Box coarsened by given (positive) refinement ratio. The Empty Box is not modified by this function.

NOTE: if type(dir) = CELL centered: lo <- lo/ratio and hi <- hi/ratio.

NOTE: if type(dir) = NODE centered: lo <- lo/ratio and hi <- hi/ratio + ((hi%ratio)==0 ? 0 : 1).

That is, refinement of coarsened Box must contain the original Box.

Box chop (int dir, int chop_pnt)
Chops the Box at the chop_pnt in the dir direction returns one Box, modifies the object Box. The union of the two is the original Box. The modified Box is the low end, the returned Box is the high end. If type(dir) = CELL, the Boxes are disjoint with the chop_pnt included in the high end (new Box). It is an ERROR if chop_pnt is the low end of the orig Box. If type(dir) = NODE, the chop_pnt is included in both Boxes but is the only point in common. It is also an error if the chop_pnt is an end node of the Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.

friend std::ostream& operator<< (std::ostream& os, const Box& bx)
Write an ASCII representation to the ostream.

friend std::istream& operator>> (std::istream& os, Box& bx)
Read from istream.

void p () const
print to pout()

void dumpOn (std::ostream& strm) const
Gives more detail than printOn. Useful for exiting due to an error.

void computeBoxLen ()
This is a canonical empty Box of cell-centered type.


this class has no child classes.

alphabetic index hierarchy of classes


Chombo

Copyright Notice

This software is copyright (C) by the Lawrence Berkeley National Laboratory. Permission is granted to reproduce this software for non-commercial purposes provided that this notice is left intact.

It is acknowledged that the U.S. Government has rights to this software under Contract DE-AC03-765F00098 between the U.S. Department of Energy and the University of California.

This software is provided as a professional and academic contribution for joint exchange. Thus it is experimental, is provided ``as is'', with no warranties of any kind whatsoever, no support, no promise of updates, or printed documentation. By using this software, you acknowledge that the Lawrence Berkeley National Laboratory and Regents of the University of California shall have no liability with respect to the infringement of other copyrights by any part of this software.