Class TrivialEnvironment

java.lang.Object
  TrivialEnvironment

All Implemented Interfaces:

IEnvironment

public class TrivialEnvironment
extends java.lang.Object
implements IEnvironment

2d box with no scalar fields of a fixed (at construction time) width and height

Since:

1.0

Constructor Summary

TrivialEnvironment()

TrivialEnvironment(double lfWidth, double lfHeight)

Method Summary

IBoundary	getBoundary() Gets boundary interface
int	getDimensionality() dimensionality of space in which environment is embedded
double	getFieldVal(int nWhichField, double[] arrLoc) Gets a particular field value at a particular location Invalid for this class Figure out how to declare exceptions in interface definitions
double[]	getFieldVals(double[] arrLoc) Gets all field values for a particular location as a vector Invalid for this class Figure out how to declare exceptions in interface definitions
double[]	getGradient(int nWhichField, double[] arrLoc) Gradient at a particular location for a given field
void	getGradient(int nWhichField, double[] arrLoc, double[] arrRslt) Gradient at a particular location for a given field
int	getNumScalars() number of scalar fields over environment
void	initializeVars(double lfWidth, double lfHeight)
IEnvironment	makeCopy()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrivialEnvironment

public TrivialEnvironment()

TrivialEnvironment

public TrivialEnvironment(double lfWidth,
                          double lfHeight)

Method Detail

makeCopy

public IEnvironment makeCopy()

Specified by:

makeCopy in interface IEnvironment

initializeVars

public void initializeVars(double lfWidth,
                           double lfHeight)

getDimensionality

public int getDimensionality()

dimensionality of space in which environment is embedded

Specified by:

getDimensionality in interface IEnvironment

getNumScalars

public int getNumScalars()

number of scalar fields over environment

Specified by:

getNumScalars in interface IEnvironment

getFieldVal

public double getFieldVal(int nWhichField,
                          double[] arrLoc)

Gets a particular field value at a particular location Invalid for this class Figure out how to declare exceptions in interface definitions

Specified by:

getFieldVal in interface IEnvironment

getGradient

public double[] getGradient(int nWhichField,
                            double[] arrLoc)

Gradient at a particular location for a given field

Specified by:

getGradient in interface IEnvironment

Parameters:

nWhichField - field to take gradient of

arrLoc - place at which to take gradient

Returns:

gradient (of proper dimensionality) as a double []

getGradient

public void getGradient(int nWhichField,
                        double[] arrLoc,
                        double[] arrRslt)

Gradient at a particular location for a given field

Specified by:

getGradient in interface IEnvironment

Parameters:

nWhichField - field to take gradient of

arrLoc - place at which to take gradient

arrRslt - gradient (of proper dimensionality) as a double []

getFieldVals

public double[] getFieldVals(double[] arrLoc)

Gets all field values for a particular location as a vector Invalid for this class Figure out how to declare exceptions in interface definitions

Specified by:

getFieldVals in interface IEnvironment

Parameters:

arrLoc - invalid for this class

Returns:

null -- invalid for this class

getBoundary

public IBoundary getBoundary()

Gets boundary interface

Specified by:

getBoundary in interface IEnvironment