Package esys :: Package modellib :: Module geometry :: Class ScalarConstrainerOverBox

Class ScalarConstrainerOverBox

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

Creates a characteristic function for the location of constraints for a scalar value and selects the value from an initial value ate these locations.

In the case that the spatial dimension is two, the arguments front and back are ignored.

Instance Methods

[hide private]

__init__(self, **kwargs)
Creates a model.

__setOutput(self)

escript.Scalar

location_of_constraint(self)
return the values used to constrain a solution

escript.Scalar

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
True to set a constraint at the left face of the domain (x[2]=max x[2]), default False (in).

bottom
True to set a constraint at the left face of the domain (x[1]=max x[1]), default False (in).

domain
domain (in).

front
True to set a constraint at the left face of the domain (x[2]=min x[2]), default False (in).

left
True to set a constraint at the left face of the domain (x[0]=min x[0]), default False (in).

right
True to set a constraint at the left face of the domain (x[0]=max x[0]), default False (in).

tol
absolute tolerance for "x=max x" condition, default 1.e-8 (in).

top
True to set a constraint at the left face of the domain (x[1]=min x[1]), default False (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.Scalar: the mask marking the locations of the constraints

value_of_constraint(self)

return the values used to constrain a solution

Returns: escript.Scalar: values to be used at the locations of the constraints. If value is not given None is rerturned.

Class ScalarConstrainerOverBox

__init__(self, **kwargs) (Constructor)

location_of_constraint(self)

value_of_constraint(self)

init(self, **kwargs)
(Constructor)