jabble
Class EquationSet

java.lang.Object
  extended by jabble.EquationSet
All Implemented Interfaces:
java.io.Serializable

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

Describes the set of equations to solve, together with the coordinates being used.

See Also:
Serialized Form

Constructor Summary
EquationSet(EquationSet equation, java.util.List<java.lang.String> newCoords, java.util.List<java.lang.String> newDiffs)
           
 
Method Summary
 jabble.BoundaryConditions getBoundaryConditions()
          Returns the boundary conditions that are defined with the equation set.
 double getConstant(java.lang.String constantName)
          Returns the value of the given constant.
 java.util.Set<java.lang.String> getConstants()
          Returns the scalar constants used by the equation.
 java.util.List<java.lang.String> getCoordinates()
          Returns the list of coordinates in the correct order.
 java.util.List<java.lang.String> getDifferentials()
          Returns the list of differentials for the coordinates, in the same order of the coordinates themselves.
 java.util.Map<java.lang.String,java.lang.String> getEquations()
          Returns a map that associates each field that is going to be evolved with its equation.
 java.util.List<java.lang.String> getFields()
          Returns the list of fields used by the equation.
 Grid getGrid()
          Returns the grid on which the equation was defined.
 java.util.List<java.lang.String> getStationaryFields()
          Returns the list of those fields that do not change in time.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EquationSet

public EquationSet(EquationSet equation,
                   java.util.List<java.lang.String> newCoords,
                   java.util.List<java.lang.String> newDiffs)
Method Detail

getGrid

public Grid getGrid()
Returns the grid on which the equation was defined.

Returns:
A Grid object.

getCoordinates

public java.util.List<java.lang.String> getCoordinates()
Returns the list of coordinates in the correct order.

Returns:
The names of the coordinates.

getStationaryFields

public java.util.List<java.lang.String> getStationaryFields()
Returns the list of those fields that do not change in time. Fields can be stationary, but also coordinates and differentials.

Returns:
The names of the stationary fields.

getDifferentials

public java.util.List<java.lang.String> getDifferentials()
Returns the list of differentials for the coordinates, in the same order of the coordinates themselves.

Returns:
The names of the differentials.

getFields

public java.util.List<java.lang.String> getFields()
Returns the list of fields used by the equation. Coordinates and differentials are not included.

Returns:
the names of the fields.

getEquations

public java.util.Map<java.lang.String,java.lang.String> getEquations()
Returns a map that associates each field that is going to be evolved with its equation.

Returns:
A map between field names and equations.

getConstants

public java.util.Set<java.lang.String> getConstants()
Returns the scalar constants used by the equation.

Returns:
The names of the constants.

getConstant

public double getConstant(java.lang.String constantName)
Returns the value of the given constant. TODO what happens if the constant is not defined?

Parameters:
constantName - the name of the constant
Returns:
the value of the constant.

getBoundaryConditions

public jabble.BoundaryConditions getBoundaryConditions()
Returns the boundary conditions that are defined with the equation set.

Returns:
The boundary conditions.