Package esys :: Package escript :: Module pdetools :: Class Locator
[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 which is closest to the given point x.

Instance Methods [hide private]
 
__call__(self, data)
Returns the value of data at the Locator of a Data object.
 
__init__(self, where, x=array([ 0., 0., 0.]))
Initializes a Locator to access values in Data objects on the Doamin or FunctionSpace for the sample point which is closest to the given point x.
 
__str__(self)
Returns the coordinates of the Locator as a string.
 
getFunctionSpace(self)
Returns the function space of the Locator.
 
getId(self, item=None)
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 [hide private]

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

 

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

Parameters:
  • where (escript.FunctionSpace) - function space
  • x (numpy.ndarray or list of numpy.ndarray) - location(s) of the Locator