Home       Trees       Indices       Help   
Package esys :: Package modellib :: Module geometry :: Class VectorConstrainerOverBox
[hide private]
[frames] | no frames]

Class VectorConstrainerOverBox

                       object --+            
                                |            
escript.modelframe.LinkableObject --+        
                                    |        
      escript.modelframe.ParameterSet --+    
                                        |    
                 escript.modelframe.Model --+
                                            |
                                           VectorConstrainerOverBox
Creates a characteristic function for the location of constraints vector value. In the case that the spatial dimension is two, the arguments front and back as well as the third component of each argument is ignored.
Instance Methods [hide private]
 
__init__(self, **kwargs)
Creates a model.
 
__setOutput(self)
escript.Vector
location_of_constraint(self)
return the values used to constrain a solution
escript.Vector
value_of_constraint(self)
return the values used to constrain a solution

Inherited from escript.modelframe.Model: __str__, doFinalization, doInitialPostprocessing, doInitialStep, doInitialization, doStep, doStepPostprocessing, doStepPreprocessing, finalize, getSafeTimeStepSize, setUp, terminateInitialIteration, terminateIteration, toDom

Inherited from escript.modelframe.ParameterSet: __delattr__, __iter__, __repr__, checkLinkTargets, declareParameter, declareParameters, releaseParameters, showParameters, writeXML

Inherited from escript.modelframe.ParameterSet (private): _parametersToDom

Inherited from escript.modelframe.LinkableObject: __getattr__, __setattr__, getAttributeObject, hasAttribute, trace

Inherited from object: __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__

Class Methods [hide private]

Inherited from escript.modelframe.ParameterSet: fromDom

Class Variables [hide private]

Inherited from escript.modelframe.Model: UNDEF_DT

Instance Variables [hide private]
  back
list of three boolean.
  bottom
list of three boolean.
  domain
domain
  front
list of three boolean.
  left
list of three boolean.
  right
list of three boolean.
  tol
absolute tolerance for "x=max x" condition, default 1.e-8 (in).
  top
list of three boolean.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

 

Creates a model.

Just calls the parent constructor.

Overrides: object.__init__
(inherited documentation)

location_of_constraint(self)

 
return the values used to constrain a solution
Returns: escript.Vector
the mask marking the locations of the constraints

value_of_constraint(self)

 
return the values used to constrain a solution
Returns: escript.Vector
values to be used at the locations of the constraints. If value is not given None is rerturned.

Instance Variable Details [hide private]

back

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 [False,False,False] (in).

bottom

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 [False,False,False] (in).

front

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 [False,False,False] (in).

left

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 [False,False,False] (in).

right

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 [False,False,False] (in).

top

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 [False,False,False] (in).

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri May 25 00:38:46 2012 http://epydoc.sourceforge.net