Domain class

Next: FunctionSpace class Up: esys.escript Classes Previous: esys.escript Classes Contents Index

Domain class

$\begin{classdesc}{Domain}{} A \class{Domain}\xspace object is used to describe a... ... to be subclassed in order to provide a complete implementation. \end{classdesc}$
The following methods are available:
$\begin{methoddesc}[Domain]{getDim}{} returns the spatial dimension of the \class{Domain}\xspace . \end{methoddesc}$

$\begin{methoddesc}[Domain]{dump}{filename} dumps the \class{Domain}\xspace into the file \var{filename}. \end{methoddesc}$

$\begin{methoddesc}[Domain]{getX}{} returns the locations in the \class{Domain}\x... ...ically it will be in the general \class{FunctionSpace}\xspace . \end{methoddesc}$

$\begin{methoddesc}[Domain]{setX}{newX} assigns a new location to the \class{Doma... ...to be used depends on the \class{Domain}\xspace implementation. \end{methoddesc}$

$\begin{methoddesc}[Domain]{getNormal}{} returns the surface normals on the boundary of the \class{Domain}\xspace as \class{Data}\xspace object. \end{methoddesc}$

$\begin{methoddesc}[Domain]{getSize}{} returns the local sample size, e.g. the element diameter, as \class{Data}\xspace object. \end{methoddesc}$

$\begin{methoddesc}[Domain]{setTagMap}{tag_name, tag} defines a mapping of the tag name \var{tag_name} to the \var{tag}. \end{methoddesc}$

$\begin{methoddesc}[Domain]{getTag}{tag_name} returns the tag associated with the tag name \var{tag_name}. \end{methoddesc}$

$\begin{methoddesc}[Domain]{isValidTagName}{tag_name} return \constant{True}\xspace if \var{tag_name} is a valid tag name. \end{methoddesc}$

$\begin{methoddesc}[Domain]{__eq__}{arg} (python == operator) returns \constant{T... ...the same domain. Otherwise \constant{False}\xspace is returned. \end{methoddesc}$

$\begin{methoddesc}[Domain]{__ne__}{arg} (python != operator) returns \constant{T... ...he same domain. Otherwise \constant{False}\xspace is returned. \end{methoddesc}$

$\begin{methoddesc}[Domain]{__str__}{arg} (python str() function) returns string representation of the \class{Domain}\xspace . \end{methoddesc}$

$\begin{methoddesc}[Domain]{onMasterProcessor)}{} returns \constant{True}\xspace ... ...not enabled the return value is always \constant{True}\xspace . \end{methoddesc}$

$\begin{methoddesc}[Domain]{getMPISize}{} returns the number of {\it MPI}\index{... ...ing Interface!MPI}\xspace support is not enabled 1 is returned. \end{methoddesc}$

$\begin{methoddesc}[Domain]{getMPIRank}{} returns the rank of the processor exec... ...ing Interface!MPI}\xspace support is not enabled 0 is returned. \end{methoddesc}$

$\begin{methoddesc}[Domain]{MPIBarrier}{} executes barrier synchronization within... ...MPI}\xspace support is not enabled, this command does nothing. \end{methoddesc}$

Next: FunctionSpace class Up: esys.escript Classes Previous: esys.escript Classes Contents Index

esys@esscc.uq.edu.au