Home       Trees       Index       Help   
Package esys :: Package escript :: Module symbols
[show private | hide private]
[frames | no frames]

Module esys.escript.symbols

some tools supporting the usage of symbols.
Function Summary
Symbol ScalarSymbol(dim)
returns a rank 0 Symbol.
Symbol Tensor3Symbol(dim)
returns a tensor Symbol of rank 3 and spatial dimension dim
Symbol Tensor4Symbol(dim)
returns a tensor Symbol of rank 4 and spatial dimension dim
Symbol TensorSymbol(dim)
returns a tensor Symbol of rank 2 and spatial dimension dim
Symbol VectorSymbol(dim)
returns a vector Symbol of rank 1 and spatial dimension dim

Variable Summary
str __author__: name of author
str __copyright__: copyrights
str __date__: date of the version
str __license__: licence agreement
str __url__: url entry point on documentation
str __version__: version

Function Details

ScalarSymbol(dim=None)

returns a rank 0 Symbol.
Parameters:
dim - spatial dimension or an object that has the getDim method defining the spatial dimension. If dim=None, the spatial diminsion of the returned Symbol is undefined.
           (type=None, int or any object with a getDim method)
Returns:
a Symbol of rank 0.
           (type=Symbol)

Tensor3Symbol(dim=3)

returns a tensor Symbol of rank 3 and spatial dimension dim
Parameters:
dim - spatial dimension or an object that has the getDim method defining the spatial dimension.
           (type=int or any object with a getDim method)
Returns:
a Symbol of shape (dim,dim,dim)
           (type=Symbol)

Tensor4Symbol(dim=3)

returns a tensor Symbol of rank 4 and spatial dimension dim
Parameters:
dim - spatial dimension or an object that has the getDim method defining the spatial dimension.
           (type=int or any object with a getDim method)
Returns:
a Symbol of shape (dim,dim,dim,dim)
           (type=Symbol)

TensorSymbol(dim=3)

returns a tensor Symbol of rank 2 and spatial dimension dim
Parameters:
dim - spatial dimension or an object that has the getDim method defining the spatial dimension.
           (type=int or any object with a getDim method)
Returns:
a Symbol of shape (dim,dim)
           (type=Symbol)

VectorSymbol(dim=3)

returns a vector Symbol of rank 1 and spatial dimension dim
Parameters:
dim - spatial dimension or an object that has the getDim method defining the spatial dimension.
           (type=int or any object with a getDim method)
Returns:
a Symbol of shape (dim,)
           (type=Symbol)

Variable Details

__author__

name of author
Type:
str
Value:
'Lutz Gross, l.gross@uq.edu.au'

__copyright__

copyrights
Type:
str
Value:
'''  Copyright (c) 2006 by ACcESS MNRF
                    http://www.access.edu.au
                Primary Business: Queensland, Australia'''

__date__

date of the version
Type:
str
Value:
'$Date: 2006-03-23 20:55:31 +1000 (Thu, 23 Mar 2006) $'

__license__

licence agreement
Type:
str
Value:
'''Licensed under the Open Software License version 3.0
             http://www.opensource.org/licenses/osl-3.0.php'''

__url__

url entry point on documentation
Type:
str
Value:
'http://www.iservo.edu.au/esys/escript'

__version__

version
Type:
str
Value:
'$Revision: 637 $'

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Thu Apr 27 11:16:18 2006 http://epydoc.sf.net