Package esys :: Package finley :: Module finleybench :: Class FinleyProblem
[show private | hide private]
[frames | no frames]

Type FinleyProblem

      object --+    
               |    
BenchmarkProblem --+
                   |
                  FinleyProblem

Known Subclasses:
RegularFinleyProblem

The general benchmark problem for Finley
Method Summary
escript.Domain getDomain(self)
returns the domain of the problem
LinearPDE,escript.Data getTestProblem(self, domain)
returns a PDEto be solved and an exact solution
pair of float run(self, options)
creates a domain and a PDE on this domain, solves it (with the given options) and returns the elapsed time and the error.
    Inherited from BenchmarkProblem
  __init__(self, name)
sets up a benchmark problem
str __str__(self)
returns the name of the benchmark suite
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Method Details

getDomain(self)

returns the domain of the problem
Returns:
a domain
           (type=escript.Domain)

getTestProblem(self, domain)

returns a PDEto be solved and an exact solution
Parameters:
domain - the PDE domain
           (type=escript.Domain)
Returns:
a linear PDE to be solved an a reference solution
           (type=LinearPDE,escript.Data)

run(self, options)

creates a domain and a PDE on this domain, solves it (with the given options) and returns the elapsed time and the error.
Parameters:
options - paso solver options
           (type=PasoOptions)
Returns:
elapsed time and the error of calculated solution
           (type=pair of float)
Overrides:
esys.escript.benchmark.BenchmarkProblem.run

Generated by Epydoc 2.1 on Thu Apr 27 11:16:14 2006 http://epydoc.sf.net