Package esys :: Package escript :: Module symbols
[hide private]
[frames] | no frames]

Module symbols


Author: Lutz Gross, l.gross@uq.edu.au

Copyright: Copyright (c) 2003-2009 by University of Queensland Earth Systems Science Computational Center (ESSCC) http://www.uq.edu.au/esscc Primary Business: Queensland, Australia

License: Licensed under the Open Software License version 3.0 http://www.opensource.org/licenses/osl-3.0.php

Functions [hide private]
Symbol
ScalarSymbol(dim=None)
Returns a rank 0 Symbol.
Symbol
Tensor3Symbol(dim=3)
Returns a tensor Symbol of rank 3 and spatial dimension dim.
Symbol
Tensor4Symbol(dim=3)
Returns a tensor Symbol of rank 4 and spatial dimension dim.
Symbol
TensorSymbol(dim=3)
Returns a tensor Symbol of rank 2 and spatial dimension dim.
Symbol
VectorSymbol(dim=3)
Returns a vector Symbol of rank 1 and spatial dimension dim.
Variables [hide private]
  __url__ = 'https://launchpad.net/escript-finley'
Function Details [hide private]

ScalarSymbol(dim=None)

 

Returns a rank 0 Symbol.

Parameters:
  • dim (None, int or any object with a getDim method) - 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.
Returns: Symbol
a Symbol of rank 0

Tensor3Symbol(dim=3)

 

Returns a tensor Symbol of rank 3 and spatial dimension dim.

Parameters:
  • dim (int or any object with a getDim method) - spatial dimension or an object that has the getDim method defining the spatial dimension
Returns: Symbol
a Symbol of shape (dim,dim,dim)

Tensor4Symbol(dim=3)

 

Returns a tensor Symbol of rank 4 and spatial dimension dim.

Parameters:
  • dim (int or any object with a getDim method) - spatial dimension or an object that has the getDim method defining the spatial dimension
Returns: Symbol
a Symbol of shape (dim,dim,dim,dim)

TensorSymbol(dim=3)

 

Returns a tensor Symbol of rank 2 and spatial dimension dim.

Parameters:
  • dim (int or any object with a getDim method) - spatial dimension or an object that has the getDim method defining the spatial dimension
Returns: Symbol
a Symbol of shape (dim,dim)

VectorSymbol(dim=3)

 

Returns a vector Symbol of rank 1 and spatial dimension dim.

Parameters:
  • dim (int or any object with a getDim method) - spatial dimension or an object that has the getDim method defining the spatial dimension
Returns: Symbol
a Symbol of shape (dim,)