esys.modellib.geometry.VectorConstrainer

Package esys :: Package modellib :: Module geometry :: Class VectorConstrainer

[show private | hide private]

Type VectorConstrainer

    object --+        
             |        
LinkableObject --+    
                 |    
      ParameterSet --+
                     |
                    VectorConstrainer

Creates a characteristic function for the location of constraints for a scalar value.

Method Summary
	`__init__(self, debug)`
	`location_of_constraint(self)` Returns the mask of the location of constraint.
Inherited from ParameterSet
	`__delattr__(self, name)` Removes the attribute name.
	`__iter__(self)` Creates an iterator over the parameter and their values.
	`__repr__(self)`
	`declareParameter(self, **parameters)` Declares a new parameter(s) and its (their) initial value.
	`declareParameters(self, parameters)` Declares a set of parameters.
	`fromDom(cls, doc)` (Class method)
	`releaseParameters(self, name)` Removes parameter name from the paramameters.
	`showParameters(self)` Returns a descrition of the parameters.
	`toDom(self, document, node)` `toDom` method of ParameterSet class.
	`writeXML(self, ostream)` Writes the object as an XML object into an output stream.
Inherited from LinkableObject
	`__getattr__(self, name)` Returns the value of attribute name.
	`__setattr__(self, name, value)` Sets the value for attribute name.
	`getAttributeObject(self, name)` Return the object stored for attribute name.
	`hasAttribute(self, name)` Returns True if self as attribute name.
	`trace(self, msg)` If debugging is on, print the message, otherwise do nothing
Inherited from object
	`__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
	`__str__(x)` x.__str__() <==> str(x)

Instance Variable Summary
	`back (in)`: list of three boolean.
	`bottom (in)`: list of three boolean.
	`domain (in)`: rectangular domain
	`front (in)`: list of three boolean.
	`left (in)`: list of three boolean.
	`location_of_constraint (callable)`: object that defines the location of the constraints for each vector component.
	`right (in)`: list of three boolean.
	`top (in)`: list of three boolean.

Class Variable Summary
Inherited from LinkableObject
`count`	`number_sequence` = `<itertools.count object at 0x401ff100>`

Instance Method Details

location_of_constraint(self)

Returns the mask of the location of constraint.

Instance Variable Details

back (in)

list of three boolean. left[i]==True sets a constraint for the i-th component at the back face of the domain (x[2]=max x[2]), default is [False,False,False]

bottom (in)

list of three boolean. left[i]==True sets a constraint for the i-th component at the bottom face of the domain (x[1]=min x[1]), default is [False,False,False]

domain (in)

rectangular domain

front (in)

list of three boolean. left[i]==True sets a constraint for the i-th component at the front face of the domain (x[2]=min x[2]), default is [False,False,False]

left (in)

list of three boolean. left[i]==True sets a constraint for the i-th component at the left face of the domain (x[0]=min x[0]), default is [False,False,False]

location_of_constraint (callable)

object that defines the location of the constraints for each vector component.

In the case that the spatial dimension is two, thh arguments front and back as well as the third component of each argument is ignored.

right (in)

list of three boolean. left[i]==True sets a constraint for the i-th component at the right face of the domain (x[0]=max x[0]), default is [False,False,False]

top (in)

list of three boolean. left[i]==True sets a constraint for the i-th component at the top face of the domain (x[1]=min x[1]), default is [False,False,False]

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

http://epydoc.sf.net