Package esys :: Package modellib :: Module materials :: Class GravityForce

[frames] | no frames]

Class GravityForce

                       object --+        
                                |        
escript.modelframe.LinkableObject --+    
                                    |    
      escript.modelframe.ParameterSet --+
                                        |
                                       GravityForce

Sets a gravity force of given direction in given domain:

Instance Methods

__init__(self, **kwargs)
initializes the set

gravity_force(self)
return the gravity force as density*gravity*direction

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

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

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

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

Class Methods

Inherited from escript.modelframe.ParameterSet: fromDom

Instance Variables

density
density, default 1 (in).

direction
the direction of gravity, default [1.,0.,0.] (in).

esys.escript.Domain

domain
domain of interest (in).

gravity
the gravity constant, default 9.81 (in).

Properties

Inherited from object: __class__

Method Details

init(self, **kwargs)
(Constructor)

initializes the set

Overrides: object.__init__