Package esys :: Package modellib :: Module geometry :: Class VectorConstrainerAtBoxVertex
[hide private]
[frames] | no frames]

Class VectorConstrainerAtBoxVertex

                       object --+            
                                |            
escript.modelframe.LinkableObject --+        
                                    |        
      escript.modelframe.ParameterSet --+    
                                        |    
                 escript.modelframe.Model --+
                                            |
                                           VectorConstrainerAtBoxVertex

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.LinkableObject: __getattr__, __setattr__, getAttributeObject, hasAttribute, trace

Inherited from object: __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__

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]
  comp_mask
list of three boolean.
  domain
domain
  tol
absolute tolerance for "x=left, front, bottom vertex" condition, default 1.e-8 (in).
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]

comp_mask

list of three boolean. comp_mask[i]==True sets a constraint for the i-th component at the left, front, bottom vertex, default [False,False,False] (in).