Package esys :: Package modellib :: Module input :: Class GaussianProfile

[frames] | no frames]

Class GaussianProfile

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

Generates a Gaussian profile at center x_c, width width and height A over a domain

Instance Methods

__init__(self, **kwargs)
Creates a ParameterSet with given parameters.

out(self)
Generate the Gaussian profile

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

A
(in) height of the profile.

domain
domain

r
(in) radius of the circle (default = 0)

width
(in) width of the profile (default 0.1)

x_c
center of the Gaussian profile (default [0.,0.,0.])

Properties

Inherited from object: __class__

Method Details

init(self, **kwargs)
(Constructor)

Creates a ParameterSet with given parameters.

Overrides: object.__init__: (inherited documentation)

out(self)

Generate the Gaussian profile

Link against this method to get the output of this model.

Instance Variable Details

A

(in) height of the profile. A maybe a vector. (default 1.)

r

(in) radius of the circle (default = 0)

In the case that the spatial dimension is two, The third component of x_c is dropped.