Package esys :: Package escript :: Module pdetools :: Class Locator
[show private | hide private]
[frames | no frames]

Class Locator


Locator provides access to the values of data objects at a given spatial coordinate x.

In fact, a Locator object finds the sample in the set of samples of a given function space or domain where which is closest to the given point x.
Method Summary
  __init__(self, where, x)
Initializes a Locator to access values in Data objects on the Doamin or FunctionSpace where for the sample point which closest to the given point x.
  __call__(self, data)
Returns the value of data at the Locator of a Data object otherwise the object is returned.
  __str__(self)
Returns the coordinates of the Locator as a string.
  getFunctionSpace(self)
Returns the function space of the Locator.
  getId(self)
Returns the identifier of the location.
  getValue(self, data)
Returns the value of data at the Locator if data is a Data object otherwise the object is returned.
  getX(self)
Returns the exact coordinates of the Locator.

Method Details

__init__(self, where, x=array([0, 0, 0]))
(Constructor)

Initializes a Locator to access values in Data objects on the Doamin or FunctionSpace where for the sample point which closest to the given point x.

__call__(self, data)
(Call operator)

Returns the value of data at the Locator of a Data object otherwise the object is returned.

__str__(self)
(Informal representation operator)

Returns the coordinates of the Locator as a string.

getFunctionSpace(self)

Returns the function space of the Locator.

getId(self)

Returns the identifier of the location.

getValue(self, data)

Returns the value of data at the Locator if data is a Data object otherwise the object is returned.

getX(self)

Returns the exact coordinates of the Locator.

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