Module and Class Hierarchies

[show private | hide private]

[frames | no frames]

Module Hierarchy

esys
- bruce
  - bruce
- escript
  - benchmark
  - escript
  - esysXML: A simple tool to handle parameters for a simulation in easy way.
  - linearPDEs: The module provides an interface to define and solve linear partial differential equations (PDEs) within escript.
  - modelframe: Environment for implementing models in escript
  - oldrunmodel
  - pdetools: Provides some tools related to PDEs.
  - runmodel: commandline utility to take an xml file, parse it, and run a simulation.
  - symbols: some tools supporting the usage of symbols.
  - test_linearPDEs: Test suite for linearPDEs class...
  - test_pdetools: Test suite for the pdetools module...
  - test_symbols: Test suite for the symbols.py module
  - test_util: Test suite for the util.py module.
  - test_util_base: basic tests for util.py
  - test_util_binary_no_tagged_data: test for unary operations without tagged data
  - test_util_binary_with_tagged_data: test for binary operations with tagged data
  - test_util_overloaded_binary_no_tagged_data: test for util operations for overloaded operations without tagged data
  - test_util_overloaded_binary_with_tagged_data: test for util operations for overloaded operations with tagged data
  - test_util_reduction_no_tagged_data: test for util operations for reduction operations without tagged data
  - test_util_reduction_with_tagged_data: test for util operations for reduction operations with tagged data
  - test_util_slicing_no_tagged_data: test for util operations for slicing operations without tagged data
  - test_util_slicing_with_tagged_data: test for util operations for slicing operations with tagged data
  - test_util_spatial_functions: basic tests for functions in util.py effecting the spatial distribution
  - test_util_unary_no_tagged_data: test for util operations for unary operations without tagged data
  - test_util_unary_with_tagged_data: test for util operations for unary operations without tagged data
  - test_xml
  - timeseries: Time serieas analysis
  - util: Utility functions for escript
- finley
  - finley
  - finleybench: some benchmarks for tetsing the finley solver.
- modellib
  - darcy
  - flow
  - geometry
  - input
  - materials
  - probe
  - temperature
  - tsunami
  - visualization
- pyvisi: Initialisation of the pyvisi base package
  - axes: Class and functions associated with a pyvisi Axes object
  - camera: Class and functions associated with a pyvisi Camera object
  - common: Variables common to all classes and functions
  - image: Class and functions associated with a pyvisi Image objects
  - item: This is the file of the base class for items within a scene
  - plane: The classes associated with Planes
  - plot: Base class and functions associated with a pyvisi Plot objects
  - renderer: This is the file for the base Renderer class
  - renderers: __init__ file to make the renderers/ directory into a package
    - gnuplot: Initialisation of the gnuplot renderer module
      - arrow_plot: Class and functions associated with a pyvisi ArrowPlot objects (gnuplot)
      - axes: Class and functions associated with a pyvisi Axes object
      - camera: Class and functions associated with a pyvisi Camera object
      - common: Variables common to all classes and functions
      - contour_plot: Class and functions associated with a pyvisi ContourPlot objects (gnuplot)
      - item: This is the file of the base class for items within a scene
      - line_plot: Class and functions associated with a pyvisi LinePlot objects (gnuplot)
      - mesh_plot: Class and functions associated with a pyvisi MeshPlot objects (gnuplot)
      - offset_plot: Class and functions associated with a pyvisi OffsetPlot objects (gnuplot)
      - plane: The classes associated with Planes
      - plot: Class and functions associated with a pyvisi Plot objects (gnuplot)
      - renderer: This is the file for the Renderer class
      - scatter_plot: Class and functions associated with a pyvisi ScatterPlot objects (gnuplot)
      - scatter_plot_3d: Class and functions associated with a pyvisi ScatterPlot3D objects (gnuplot)
      - scene: Class and functions associated with a pyvisi Scene (gnuplot)
      - surface_plot: Class and functions associated with a pyvisi SurfacePlot objects (gnuplot)
      - text: Class and functions associated with a pyvisi Text object
    - opendx: Initialisation of the opendx renderer module
      - axes: Brief introduction to what the file contains/does
      - camera: Brief introduction to what the file contains/does
      - common: Variables common to all classes and functions
      - image: Brief introduction to what the file contains/does
      - item: Brief introduction to what the file contains/does
      - plane: Brief introduction to what the file contains/does
      - plot: Brief introduction to what the file contains/does
      - renderer: Brief introduction to what the file contains/does
      - scene: Brief introduction to what the file contains/does
      - text: Brief introduction to what the file contains/does
    - plplot: Initialisation of the plplot renderer module
      - axes: Brief introduction to what the file contains/does
      - camera: Brief introduction to what the file contains/does
      - common: Variables common to all classes and functions
      - image: Brief introduction to what the file contains/does
      - item: Brief introduction to what the file contains/does
      - plane: Brief introduction to what the file contains/does
      - plot: This file contains all of the classes for the various plotting objects.
      - renderer: Brief introduction to what the file contains/does
      - scene: Brief introduction to what the file contains/does
      - text: Brief introduction to what the file contains/does
    - povray: Initialisation of the povray renderer module
      - axes: Class and functions associated with a pyvisi Axes object
      - camera: Class and functions associated with a pyvisi Camera object
      - common: Variables common to all classes and functions
      - image: Class and functions associated with a pyvisi Image objects
      - item: This is the file of the base class for items within a scene
      - plane: The classes associated with Planes
      - plot: Class and functions associated with a pyvisi Plot objects
      - renderer: This is the file for the Renderer class
      - scene: Class and functions associated with a pyvisi Scene
      - text: Class and functions associated with a pyvisi Text object
    - vtk: Initialisation of vtk renderer module
      - arrow_plot: Class and functions associated with a pyvisi ArrowPlot objects
      - arrow_plot_3d: Class and functions associated with a pyvisi ArrowPlot3D objects
      - axes: Class and functions associated with a pyvisi Axes object
      - ball_plot: Class and functions associated with a pyvisi BallPlot objects
      - box: The classes associated with Boxes
      - camera: Class and functions associated with a pyvisi Camera object
      - common: Variables common to all classes and functions
      - contour_plot: Class and functions associated with a pyvisi ContourPlot objects
      - ellipsoid_plot: Class and functions associated with a pyvisi EllipsoidPlot objects
      - image: Class and functions associated with a pyvisi Image objects
      - isosurface_plot: Class and functions associated with a pyvisi IsosurfacePlot objects
      - item: This is the file of the base class for items within a scene
      - line_plot: Class and functions associated with a pyvisi LinePlot objects
      - offset_plot: Class and functions associated with a pyvisi OffsetPlot objects
      - plane: The classes associated with Planes
      - plot: Class and functions associated with a pyvisi Plot objects
      - renderer: This is the file for the vtk Renderer class
      - scene: Class and functions associated with a pyvisi Scene
      - surface_plot: Class and functions associated with a pyvisi SurfacePlot objects
      - text: Class and functions associated with a pyvisi Text object
  - scene: Class and functions associated with a pyvisi Scene
  - text: Class and functions associated with a pyvisi Text object
  - utils: Initialisation of the pyvisi utilities
    - utils: Pyvisi utility functions

Class Hierarchy

__builtin__.object: The most base type
- esys.escript.benchmark.Benchmark: runs a bunch of similar BenchmarkProblems with a bunch of Options
- esys.escript.benchmark.BenchmarkFilter: object to filter the characteristcs returned by Bechmark runs.
  - esys.finley.finleybench.FinleyFilter: defines a filter for FinleyProblem characteristics
- esys.escript.benchmark.BenchmarkProblem: something that can be run and returns a list of characteristics such as timing, Mflops, error, etc.
  - esys.finley.finleybench.FinleyProblem: The general benchmark problem for Finley
    - esys.finley.finleybench.RegularFinleyProblem: base class for finley problem on a rectangular mesh
- esys.escript.benchmark.BenchmarkSuite: framework to run a bunch of Benchmarks with the object to create a table of statistics.
- esys.pyvisi.item.Item: This is the base class for items within a scene
  - esys.pyvisi.camera.Camera: Camera class
  - esys.pyvisi.image.Image: Image class.
    - esys.pyvisi.image.BmpImage: Subclass of Image class to explicitly handle bmp images
    - esys.pyvisi.image.JpegImage: Subclass of Image class to explicitly handle jpeg images
    - esys.pyvisi.image.PbmImage: Subclass of Image class to explicitly handle pbm images
    - esys.pyvisi.image.PdfImage: Subclass of Image class to explicitly handle pdf images
    - esys.pyvisi.image.PngImage: Subclass of Image class to explicitly handle png images
    - esys.pyvisi.image.PnmImage: Subclass of Image class to explicitly handle pnm images
    - esys.pyvisi.image.PsImage: Subclass of Image class to explicitly handle ps images
    - esys.pyvisi.image.TiffImage: Subclass of Image class to explicitly handle tiff images
  - esys.pyvisi.renderers.gnuplot.item.Item: This is the base class for items within a scene
    - esys.pyvisi.renderers.gnuplot.camera.Camera: Camera class
    - esys.pyvisi.renderers.gnuplot.plane.Plane: Generic class for Plane objects
    - esys.pyvisi.renderers.gnuplot.plot.Plot: Abstract plot class
      - esys.pyvisi.renderers.gnuplot.arrow_plot.ArrowPlot: Arrow field plot
      - esys.pyvisi.renderers.gnuplot.axes.Axes: Axes class
      - esys.pyvisi.renderers.gnuplot.contour_plot.ContourPlot: Contour plot
      - esys.pyvisi.renderers.gnuplot.line_plot.LinePlot: Line plot
      - esys.pyvisi.renderers.gnuplot.mesh_plot.MeshPlot: Mesh plot
      - esys.pyvisi.renderers.gnuplot.offset_plot.OffsetPlot: Offset plot
      - esys.pyvisi.renderers.gnuplot.scatter_plot.ScatterPlot: Scatter plot
      - esys.pyvisi.renderers.gnuplot.scatter_plot_3d.ScatterPlot3D: Scatter Plot in three dimensions.
    - esys.pyvisi.renderers.gnuplot.text.Text: Text
  - esys.pyvisi.renderers.opendx.item.Item: Brief introduction to what the class does
    - esys.pyvisi.renderers.opendx.camera.Camera: Brief introduction to what the class does
    - esys.pyvisi.renderers.opendx.plane.Plane: Brief introduction to what the class does
    - esys.pyvisi.renderers.opendx.plot.Plot: Brief introduction to what the class does
      - esys.pyvisi.renderers.opendx.plot.ArrowPlot: Brief introduction to what the class does
      - esys.pyvisi.renderers.opendx.axes.Axes: Brief introduction to what the class does
      - esys.pyvisi.renderers.opendx.plot.ContourPlot: Brief introduction to what the class does
      - esys.pyvisi.renderers.opendx.plot.LinePlot: Brief introduction to what the class does
    - esys.pyvisi.renderers.opendx.text.Text: Brief introduction to what the class does
  - esys.pyvisi.renderers.plplot.item.Item: This is the base class for items within a scene
    - esys.pyvisi.renderers.plplot.camera.Camera: Brief introduction to what the class does
    - esys.pyvisi.renderers.plplot.image.Image: Image class.
      - esys.pyvisi.renderers.plplot.image.BmpImage: Subclass of Image class to explicitly handle bmp images
      - esys.pyvisi.renderers.plplot.image.JpegImage: Subclass of Image class to explicitly handle jpeg images
      - esys.pyvisi.renderers.plplot.image.PbmImage: Subclass of Image class to explicitly handle pbm images
      - esys.pyvisi.renderers.plplot.image.PdfImage: Subclass of Image class to explicitly handle pdf images
      - esys.pyvisi.renderers.plplot.image.PngImage: Subclass of Image class to explicitly handle png images
      - esys.pyvisi.renderers.plplot.image.PnmImage: Subclass of Image class to explicitly handle pnm images
      - esys.pyvisi.renderers.plplot.image.PsImage: Subclass of Image class to explicitly handle ps images
      - esys.pyvisi.renderers.plplot.image.TiffImage: Subclass of Image class to explicitly handle tiff images
    - esys.pyvisi.renderers.plplot.plane.Plane: Brief introduction to what the class does
    - esys.pyvisi.renderers.plplot.text.Text: Brief introduction to what the class does
  - esys.pyvisi.renderers.povray.item.Item: This is the base class for items within a scene
    - esys.pyvisi.renderers.povray.camera.Camera: Camera class
    - esys.pyvisi.renderers.povray.image.Image: Image class.
      - esys.pyvisi.renderers.povray.image.JpegImage: Subclass of Image class to explicitly handle jpeg images
    - esys.pyvisi.renderers.povray.plane.Plane: Generic class for Plane objects
    - esys.pyvisi.renderers.povray.plot.Plot: Abstract plot class
      - esys.pyvisi.renderers.povray.plot.ArrowPlot: Arrow field plot
      - esys.pyvisi.renderers.povray.plot.ArrowPlot3D: Arrow field plot in three dimensions
      - esys.pyvisi.renderers.povray.axes.Axes: Axes class
      - esys.pyvisi.renderers.povray.plot.BallPlot: Ball plot
      - esys.pyvisi.renderers.povray.plot.ContourPlot: Contour plot
      - esys.pyvisi.renderers.povray.plot.LinePlot: Line plot
    - esys.pyvisi.renderers.povray.text.Text: Text
  - esys.pyvisi.renderers.vtk.item.Item: This is the base class for items within a scene
    - esys.pyvisi.renderers.vtk.box.Box: Generic class for Box objects
      - esys.pyvisi.renderers.vtk.box.ClipBox: Clip box class: used to clip data sets with a box
    - esys.pyvisi.renderers.vtk.camera.Camera: Camera class
    - esys.pyvisi.renderers.vtk.image.Image: Image class.
      - esys.pyvisi.renderers.vtk.image.BmpImage: Subclass of Image class to explicitly handle bmp images
      - esys.pyvisi.renderers.vtk.image.JpegImage: Subclass of Image class to explicitly handle jpeg images
      - esys.pyvisi.renderers.vtk.image.PdfImage: Subclass of Image class to explicitly handle pdf images
      - esys.pyvisi.renderers.vtk.image.PngImage: Subclass of Image class to explicitly handle png images
      - esys.pyvisi.renderers.vtk.image.PnmImage: Subclass of Image class to explicitly handle pnm (ppm, pgm, pbm) images
      - esys.pyvisi.renderers.vtk.image.PsImage: Subclass of Image class to explicitly handle ps images
      - esys.pyvisi.renderers.vtk.image.TiffImage: Subclass of Image class to explicitly handle tiff images
    - esys.pyvisi.renderers.vtk.plane.Plane: Generic class for Plane objects
      - esys.pyvisi.renderers.vtk.plane.ClipPlane: Class for planes used to clip datasets
      - esys.pyvisi.renderers.vtk.plane.CutPlane: Cut plane class: used to cut data sets with a plane
    - esys.pyvisi.renderers.vtk.plot.Plot: Abstract plot class
      - esys.pyvisi.renderers.vtk.arrow_plot.ArrowPlot: Arrow field plot
      - esys.pyvisi.renderers.vtk.arrow_plot_3d.ArrowPlot3D: Arrow field plot in three dimensions
      - esys.pyvisi.renderers.vtk.axes.Axes: Axes class
      - esys.pyvisi.renderers.vtk.ball_plot.BallPlot: Ball plot
      - esys.pyvisi.renderers.vtk.contour_plot.ContourPlot: Contour plot
      - esys.pyvisi.renderers.vtk.ellipsoid_plot.EllipsoidPlot: Ellipsoid plot
      - esys.pyvisi.renderers.vtk.isosurface_plot.IsosurfacePlot: Isosurface plot
      - esys.pyvisi.renderers.vtk.line_plot.LinePlot: Line plot
      - esys.pyvisi.renderers.vtk.offset_plot.OffsetPlot: Offset plot
      - esys.pyvisi.renderers.vtk.surface_plot.SurfacePlot: Surface plot
    - esys.pyvisi.renderers.vtk.text.Text: Text
  - esys.pyvisi.plane.Plane: Generic class for Plane objects
  - esys.pyvisi.plot.Plot: Abstract plot class
    - esys.pyvisi.plot.ArrowPlot: Arrow field plot
    - esys.pyvisi.axes.Axes: Axes class
    - esys.pyvisi.plot.BallPlot: Ball plot
    - esys.pyvisi.plot.ContourPlot: Contour plot
    - esys.pyvisi.plot.EllipsoidPlot: Ellipsoid plot
    - esys.pyvisi.plot.IsosurfacePlot: Isosurface plot
    - esys.pyvisi.plot.LinePlot: Line plot
    - esys.pyvisi.plot.ScatterPlot: Scatter plot
    - esys.pyvisi.plot.ScatterPlot3D: Three dimensional scatter plot
    - esys.pyvisi.plot.SurfacePlot: Surface plot
  - esys.pyvisi.text.Text: Text
- esys.escript.linearPDEs.LinearPDE: This class is used to define a general linear, steady, second order PDE for an unknown function u on a given domain defined through a Domain object.
  - esys.escript.linearPDEs.AdvectivePDE: In cases of PDEs dominated by the advection terms B and C against the adevctive terms A up-winding has been used.
  - esys.escript.linearPDEs.Helmholtz: Class to define a Helmhotz equation problem, which is genear LinearPDE of the form
  - esys.escript.linearPDEs.LameEquation: Class to define a Lame equation problem:
  - esys.escript.linearPDEs.Poisson: Class to define a Poisson equation problem, which is genear LinearPDE of the form
- esys.escript.modelframe.LinkableObject: An object that allows to link its attributes to attributes of other objects via a Link object.
  - esys.escript.modelframe.ParameterSet: A class which allows to emphazise attributes to be written and read to XML
    - esys.modellib.probe.EvaluateExpression: Return the evaluation of an expression at current time t and locations in the domain
    - esys.modellib.geometry.FinleyReader: Generates a mesh over a rectangular domain finley.
    - esys.modellib.input.GaussianProfile: Generates a Gaussian profile at center x_c, width width and height A over a domain
    - esys.modellib.materials.GravityForce: Sets a gravity force of given direction in given domain:
    - esys.modellib.input.InterpolatedTimeProfile: Returns values at each time.
    - esys.modellib.input.InterpolateOverBox: Returns values at each time.
    - esys.modellib.materials.MaterialTable: A simple matrial table which allows setting physical ivar of a model
      - esys.modellib.materials.SimpleFluidMaterial: A simple matrial table which allows setting physical ivar of a model.
      - esys.modellib.materials.SimpleSolidMaterial: A simple matrial table which allows setting physical parameters of a model.
    - esys.escript.modelframe.Model: A Model object represents a processess marching over time until a finalizing condition is fullfilled.
      - esys.modellib.tsunami.Bathymetry: generates the bathymetry data within a region on the earth
      - esys.modellib.geometry.ConstrainValue: selects values for a given distribution to be used as a constrain.
      - esys.modellib.darcy.DarcyFlow
      - esys.modellib.input.LinearCombination: Returns a linear combination of the f0*v0+f1*v1+f2*v2+f3*v3+f4*v4
      - esys.escript.test_xml.Messenger
      - esys.modellib.tsunami.OceanRegion: generates the ocean region with a coast line and a bathymetry
      - esys.modellib.tsunami.OceanRegionCollector
      - esys.escript.test_xml.ODETEST: implements a solver for the ODE du/dt=a*u+f(t) we use a implicit euler scheme : u_n-u_{n-1}= dt*a u_n + st*f(t_n) to get u_n we run an iterative process u_{n.k}=u_{n-1}+dt*(a u_{n.i-1} + f(t_n)) input for this model are step size dt, end time tend and a value for a, f and initial value for u.
      - esys.modellib.probe.Probe: Tests values against a expression which may depend on time and spatial coordinates.
      - esys.modellib.input.Sequencer: Runs through time until t_end is reached.
      - esys.escript.modelframe.Simulation: A Simulation object is special Model which runs a sequence of Models.
      - esys.modellib.flow.SteadyIncompressibleFlow: -\left(\eta\left(v_{i,j}+v_{j,i} ight) ight)_{,j}+p_{,i}=F_i
      - esys.modellib.tsunami.SurfMovie: movie from a wave propagation on the sea
      - esys.modellib.temperature.TemperatureAdvection: The conservation of internal heat energy is given by
      - esys.modellib.tsunami.TsunamiInDeepWater: Runs the deep water tsunami model based on a simplfied form of the shallow water equation.
      - esys.modellib.tsunami.TsunamiSource: defines a wave in Gaussean form between start and end.
      - esys.modellib.visualization.Visualization: Generic visualization of scalar, vector and tensorial data (not implemeted yet)
        
        esys.modellib.visualization.ArrowPlot: Arrow/vector/quiver plots
        esys.modellib.visualization.EllipsoidPlot: Ellipsoid plots
        esys.modellib.visualization.ShadePlot: Shaded contour plots
        esys.modellib.visualization.WriteVTK: Writes data into VTK files for further processing.
    - esys.modellib.geometry.RectangularDomain: Generates a mesh over a rectangular domain finley.
    - esys.modellib.geometry.ScalarConstrainer: Creates a characteristic function for the location of constraints for a scalar value.
    - esys.modellib.materials.SimpleEarthModel: B simple matrial table run convection models:
    - esys.modellib.geometry.VectorConstrainer: Creates a characteristic function for the location of constraints for a scalar value.
- esys.escript.benchmark.Options: defines a set of options to be used to run a BenchmarkProblem
  - esys.finley.finleybench.FinleyOptions: finley solver options to be handed over to paso
- esys.escript.linearPDEs.PDECoefficient: A class for describing a PDE coefficient
- esys.pyvisi.renderer.Renderer: A generic object holding a renderer of a Scene().
  - esys.pyvisi.renderers.gnuplot.renderer.Renderer: A generic object holding a renderer of a Scene().
  - esys.pyvisi.renderers.opendx.renderer.Renderer: Brief introduction to what the class does
  - esys.pyvisi.renderers.plplot.renderer.Renderer: Generic object holding a renderer of a Scene()
  - esys.pyvisi.renderers.povray.renderer.Renderer: A generic object holding a renderer of a Scene().
  - esys.pyvisi.renderers.vtk.renderer.Renderer: A generic object holding a renderer of a Scene().
- esys.pyvisi.scene.Scene: The main object controlling the scene.
  - esys.pyvisi.renderers.gnuplot.scene.Scene: The main object controlling the scene.
  - esys.pyvisi.renderers.opendx.scene.Scene: Brief introduction to what the class does
  - esys.pyvisi.renderers.plplot.scene.Scene: The main object controlling the scene.
  - esys.pyvisi.renderers.povray.scene.Scene: The main object controlling the scene.
  - esys.pyvisi.renderers.vtk.scene.Scene: The main object controlling the scene.
- esys.escript.util.Symbol: Symbol class.
  - esys.escript.util.DependendSymbol: DependendSymbol extents L{Symbol} by modifying the == operator to allow two instances to be equal.
    - esys.escript.util.Abs_Symbol: Symbol representing the result of the absolute value function
    - esys.escript.util.Acos_Symbol: Symbol representing the result of the inverse cosine function
    - esys.escript.util.Acosh_Symbol: Symbol representing the result of the inverse hyperolic cosine function
    - esys.escript.util.Add_Symbol: Symbol representing the sum of two arguments.
    - esys.escript.util.Asin_Symbol: Symbol representing the result of the inverse sine function
    - esys.escript.util.Asinh_Symbol: Symbol representing the result of the inverse hyperbolic sine function
    - esys.escript.util.Atan_Symbol: Symbol representing the result of the inverse tangent function
    - esys.escript.util.Atanh_Symbol: Symbol representing the result of the inverse hyperbolic tangent function
    - esys.escript.util.Cos_Symbol: Symbol representing the result of the cosine function
    - esys.escript.util.Cosh_Symbol: Symbol representing the result of the hyperbolic cosine function
    - esys.escript.util.Exp_Symbol: Symbol representing the result of the exponential function
    - esys.escript.util.GeneralTensorProduct_Symbol: Symbol representing the quotient of two arguments.
    - esys.escript.util.GetSlice_Symbol: Symbol representing getting a slice for a Symbol
    - esys.escript.util.Grad_Symbol: Symbol representing the result of the gradient operator
    - esys.escript.util.Integrate_Symbol: Symbol representing the result of the spatial integration operator
    - esys.escript.util.Interpolate_Symbol: Symbol representing the result of the interpolation operator
    - esys.escript.util.Inverse_Symbol: Symbol representing the result of the inverse function
    - esys.escript.util.Log_Symbol: Symbol representing the result of the natural logarithm function
    - esys.escript.util.Maxval_Symbol: Symbol representing the result of the maximum value function
    - esys.escript.util.Minval_Symbol: Symbol representing the result of the minimum value function
    - esys.escript.util.Mult_Symbol: Symbol representing the product of two arguments.
    - esys.escript.util.Power_Symbol: Symbol representing the first argument to the power of the second argument.
    - esys.escript.util.Quotient_Symbol: Symbol representing the quotient of two arguments.
    - esys.escript.util.Sin_Symbol: Symbol representing the result of the sine function
    - esys.escript.util.Sinh_Symbol: Symbol representing the result of the hyperbolic sine function
    - esys.escript.util.Sqrt_Symbol: Symbol representing the result of the square root function
    - esys.escript.util.Tan_Symbol: Symbol representing the result of the tangent function
    - esys.escript.util.Tanh_Symbol: Symbol representing the result of the hyperbolic tangent function
    - esys.escript.util.Trace_Symbol: Symbol representing the result of the trace function
    - esys.escript.util.Transpose_Symbol: Symbol representing the result of the transpose function
    - esys.escript.util.WhereNegative_Symbol: Symbol representing the result of the mask of positive values function
    - esys.escript.util.WherePositive_Symbol: Symbol representing the result of the mask of positive values function
    - esys.escript.util.WhereZero_Symbol: Symbol representing the result of the mask of zero entries function
- unittest.TestCase: A class whose instances are single test cases.
  - esys.escript.test_xml.LinkTestCase
  - esys.escript.test_xml.ModeltoDomTestCase
  - esys.escript.test_xml.ParamaterSetTestCase
  - esys.escript.test_xml.SimulationTestCase
  - esys.escript.test_linearPDEs.Test_linearPDEs
    - esys.escript.test_linearPDEs.Test_LinearPDE
    - esys.escript.test_linearPDEs.Test_Poisson
  - esys.escript.test_pdetools.Test_pdetools
  - esys.escript.test_symbols.Test_symbols
  - esys.escript.test_util_base.Test_util_base: basic tests on util.py
    - esys.escript.test_util_binary_no_tagged_data.Test_util_binary_no_tagged_data: test for the binary operation add, mult, ...,inner, without tagged data
      - esys.escript.test_util.Test_util_binary: test for all binary operation
        
        esys.escript.test_util.Test_util: all tests
      - esys.escript.test_util.Test_util_no_tagged_data: all tests without tagged data
    - esys.escript.test_util.Test_util_binary_still_failing: these binary opereations still fail! (see Mantis 0000053)
    - esys.escript.test_util_binary_with_tagged_data.Test_util_binary_with_tagged_data: test for the operation add, mult, ..., inner, outer ...
      - esys.escript.test_util.Test_util_binary: test for all binary operation
        
        esys.escript.test_util.Test_util: all tests
      - esys.escript.test_util.Test_util_with_tagged_data: test for all operations without tagged data
    - esys.escript.test_util_overloaded_binary_no_tagged_data.Test_util_overloaded_binary_no_tagged_data: test for the overloaded operation +,*,-,** without tagged data
      - esys.escript.test_util.Test_util_no_tagged_data: all tests without tagged data
      - esys.escript.test_util.Test_util_overloaded_binary: test for all overloaded operation
        
        esys.escript.test_util.Test_util: all tests
    - esys.escript.test_util.Test_util_overloaded_binary_still_failing: these overloaded operations still fail!
    - esys.escript.test_util_overloaded_binary_with_tagged_data.Test_util_overloaded_binary_with_tagged_data: test for the overloaded operation +,*,-,** with tagged data
      - esys.escript.test_util.Test_util_overloaded_binary: test for all overloaded operation
        
        esys.escript.test_util.Test_util: all tests
      - esys.escript.test_util.Test_util_with_tagged_data: test for all operations without tagged data
    - esys.escript.test_util_reduction_no_tagged_data.Test_util_reduction_no_tagged_data: test for reduction operation Lsup,sup,inf.
      - esys.escript.test_util.Test_util_no_tagged_data: all tests without tagged data
      - esys.escript.test_util.Test_util_reduction: test for reduction operation Lsup,sup,inf for all data types
        
        esys.escript.test_util.Test_util: all tests
    - esys.escript.test_util_reduction_with_tagged_data.Test_util_reduction_with_tagged_data: test for reduction operation Lsup,sup,inf with tagged data only
      - esys.escript.test_util.Test_util_reduction: test for reduction operation Lsup,sup,inf for all data types
        
        esys.escript.test_util.Test_util: all tests
      - esys.escript.test_util.Test_util_with_tagged_data: test for all operations without tagged data
    - esys.escript.test_util_slicing_no_tagged_data.Test_util_slicing_no_tagged_data: test for slicing operations.
      - esys.escript.test_util.Test_util_no_tagged_data: all tests without tagged data
    - esys.escript.test_util_slicing_with_tagged_data.Test_util_slicing_with_tagged_data: test for slicing operations for tagged data are tested.
      - esys.escript.test_util.Test_util_with_tagged_data: test for all operations without tagged data
    - esys.escript.test_util_unary_no_tagged_data.Test_util_unary_no_tagged_data: test for unary operations.
      - esys.escript.test_util.Test_util_no_tagged_data: all tests without tagged data
      - esys.escript.test_util.Test_util_unary: all unary tests
        
        esys.escript.test_util.Test_util: all tests
    - esys.escript.test_util_unary_with_tagged_data.Test_util_unary_with_tagged_data: test for unary operations.
      - esys.escript.test_util.Test_util_unary: all unary tests
        
        esys.escript.test_util.Test_util: all tests
      - esys.escript.test_util.Test_util_with_tagged_data: test for all operations without tagged data
  - esys.escript.test_util_spatial_functions.Test_Util_SpatialFunctions
  - esys.escript.test_xml.XMLDocumentTestCase
- __builtin__.type: type(object) -> the object's type type(name, bases, dict) -> a new type
esys.escript.esysXML.ESySParameters: Is an object to store simulation parameters in the form of a tree and access their values in an easy form
esys.escript.modelframe.Link: A Link makes an attribute of an object callable:
esys.escript.pdetools.Locator: Locator provides access to the values of data objects at a given spatial coordinate x.
esys.escript.pdetools.NoPDE: solves the following problem for u:
esys.escript.pdetools.Projector: The Projector is a factory which projects a discontiuous function onto a continuous function on the a given domain.
esys.escript.pdetools.TimeIntegrationManager: a simple mechanism to manage time dependend values.
esys.escript.timeseries.TimeSeriesBase: The TimeSeriesBase class is the base class for all class of the TimeSeries module.
- esys.escript.timeseries.Reader: reads a list of input streams and creates a time series for each input stream but on the same Controler where the first column is used to create the time nodes
- esys.escript.timeseries.TimeSeriesBaseDataset: provides an interface for accessing a set of linearly ordered data.
  - esys.escript.timeseries.TimeSeries: makes TimeSeriesBaseDataset look like a TimeSeries and introduces operations Any implementation of a TimeSeriesControlerView must provide the getControler method which returns the controler
    - esys.escript.timeseries.Controler: controls a set of TimeSeries
    - esys.escript.timeseries.DataCatcher: collects data into a time series.
    - esys.escript.timeseries.TimeSeriesFilter: a TimeSeriesFilter is a TimeSeries taht is created trough a TimeSeriesOperator
      - esys.escript.timeseries.Exp
      - esys.escript.timeseries.TimeSeriesAdd: adds two TimeSeries
      - esys.escript.timeseries.TimeSeriesAddScalar: adds a single value to a TimeSeries
      - esys.escript.timeseries.TimeSeriesCumulativeSum: cummulative sum of the time series values
      - esys.escript.timeseries.TimeSeriesDiv: divides two TimeSeries
      - esys.escript.timeseries.TimeSeriesDivScalar: divides a scalar be a TimeSerie
      - esys.escript.timeseries.TimeSeriesMult: multiplies two TimeSeries
      - esys.escript.timeseries.TimeSeriesMultScalar: multiplies a TimeSeries with a single value
      - esys.escript.timeseries.TimeSeriesPower: raise one TimeSeries to the power of an other TimeSeries
      - esys.escript.timeseries.TimeSeriesPowerScalar: raises a TimeSerie to the power of a scalar
    - esys.escript.timeseries.TimeSeriesShift: creates a shift of the time series, i.e.
  - esys.escript.timeseries.TimeSeriesBaseBuffer: An inplementation of TimeSeriesBaseDataset which actually is storing data into a numarray buffer
- esys.escript.timeseries.TimeSeriesControlerView: A TimeSeriesControlerView is attached to a Controler and moves forward in time by increasing the id of the last processed datum.
  - esys.escript.timeseries.TimeSeries: makes TimeSeriesBaseDataset look like a TimeSeries and introduces operations Any implementation of a TimeSeriesControlerView must provide the getControler method which returns the controler
    - esys.escript.timeseries.Controler: controls a set of TimeSeries
    - esys.escript.timeseries.DataCatcher: collects data into a time series.
    - esys.escript.timeseries.TimeSeriesFilter: a TimeSeriesFilter is a TimeSeries taht is created trough a TimeSeriesOperator
      - esys.escript.timeseries.Exp
      - esys.escript.timeseries.TimeSeriesAdd: adds two TimeSeries
      - esys.escript.timeseries.TimeSeriesAddScalar: adds a single value to a TimeSeries
      - esys.escript.timeseries.TimeSeriesCumulativeSum: cummulative sum of the time series values
      - esys.escript.timeseries.TimeSeriesDiv: divides two TimeSeries
      - esys.escript.timeseries.TimeSeriesDivScalar: divides a scalar be a TimeSerie
      - esys.escript.timeseries.TimeSeriesMult: multiplies two TimeSeries
      - esys.escript.timeseries.TimeSeriesMultScalar: multiplies a TimeSeries with a single value
      - esys.escript.timeseries.TimeSeriesPower: raise one TimeSeries to the power of an other TimeSeries
      - esys.escript.timeseries.TimeSeriesPowerScalar: raises a TimeSerie to the power of a scalar
    - esys.escript.timeseries.TimeSeriesShift: creates a shift of the time series, i.e.
  - esys.escript.timeseries.TimeSeriesOperator: a TimeSeriesOperator decribes an operation acting on list of TimeSeries time_series_args.
    - esys.escript.timeseries.Plotter
    - esys.escript.timeseries.TimeSeriesFilter: a TimeSeriesFilter is a TimeSeries taht is created trough a TimeSeriesOperator
      - esys.escript.timeseries.Exp
      - esys.escript.timeseries.TimeSeriesAdd: adds two TimeSeries
      - esys.escript.timeseries.TimeSeriesAddScalar: adds a single value to a TimeSeries
      - esys.escript.timeseries.TimeSeriesCumulativeSum: cummulative sum of the time series values
      - esys.escript.timeseries.TimeSeriesDiv: divides two TimeSeries
      - esys.escript.timeseries.TimeSeriesDivScalar: divides a scalar be a TimeSerie
      - esys.escript.timeseries.TimeSeriesMult: multiplies two TimeSeries
      - esys.escript.timeseries.TimeSeriesMultScalar: multiplies a TimeSeries with a single value
      - esys.escript.timeseries.TimeSeriesPower: raise one TimeSeries to the power of an other TimeSeries
      - esys.escript.timeseries.TimeSeriesPowerScalar: raises a TimeSerie to the power of a scalar
    - esys.escript.timeseries.Writer: writes the time series into an output strim ostream which mast have the writeline method.
esys.modellib.tsunami.Coastline: defines a coast line by a Polyline within a RegionOnEarthSurface
esys.modellib.tsunami.EarthTriangulation
esys.modellib.tsunami.GridData: this object is used to store data on grid.
esys.modellib.tsunami.PointOnEarthSurface: coordinates of a point on the surface of the Earth
esys.modellib.tsunami.Polyline: defines set of segments through a list of coordinates
esys.modellib.tsunami.RegionOnEarthSurface: defines an region by a south,east and north,west corner
exceptions.Exception: Common base class for all exceptions.
- esys.escript.modelframe.FailedTimeStepError: Exception which is thrown if the time step fails because of a step size that have been choosen to be too large.
- esys.escript.modelframe.IterationDivergenceError: Exception which is thrown if there is no convergence of the iteration process at a time step.
- esys.escript.modelframe.NonPositiveStepSizeError: Exception which is thrown if the step size is not positive.
- esys.escript.modelframe.SimulationBreakDownError: Exception which is thrown if the simulation does not manage to progress in time.
- exceptions.StandardError: Base class for all standard Python exceptions.
  - exceptions.AssertionError: Assertion failed.
  - exceptions.ValueError: Inappropriate argument value (of correct type).
    - esys.escript.linearPDEs.IllegalCoefficient: raised if an illegal coefficient of the general ar particular PDE is requested.
    - esys.escript.linearPDEs.IllegalCoefficientValue: raised if an incorrect value for a coefficient is used.
    - esys.escript.linearPDEs.UndefinedPDEError: raised if a PDE is not fully defined yet.

Generated by Epydoc 2.1 on Thu Apr 27 11:16:32 2006

http://epydoc.sf.net