 # Diff of /trunk/doc/user/escript.tex

revision 624 by gross, Fri Mar 17 05:48:59 2006 UTC revision 625 by gross, Thu Mar 23 00:41:25 2006 UTC
# Line 1  Line 1

1  % $Id$  % $Id$
2    %
4    %               http://www.access.edu.au
5    %         Primary Business: Queensland, Australia.
8    %
9
10
11  \chapter{The module \escript}  \chapter{The module \escript}
12
# Line 297  Otherwise \False is returned. Line 304  Otherwise \False is returned.
304  returns string represention of the \Domain.  returns string represention of the \Domain.
305  \end{methoddesc}  \end{methoddesc}
306
307  \section{\Domain class}  \section{\FunctionSpace class}
308  \begin{classdesc}{FunctionSpace}{}  \begin{classdesc}{FunctionSpace}{}
309  \FunctionSpace objects are used to define properties of \Data objects, such as continuity. \FunctionSpace objects  \FunctionSpace objects are used to define properties of \Data objects, such as continuity. \FunctionSpace objects
310  are instantiated by generator functions. \Data objects in particular \FunctionSpace are  are instantiated by generator functions. \Data objects in particular \FunctionSpace are
# Line 392  for the solution approximation. Line 399  for the solution approximation.
399  The following table shows binary and unitary operations that can be applied to  The following table shows binary and unitary operations that can be applied to
400  \Data objects:  \Data objects:
401  \begin{tableii}{l|l}{textrm}{expression}{Description}  \begin{tableii}{l|l}{textrm}{expression}{Description}
402  \lineii{+\var{arg1}} {just \var{arg} \index{+}}  \lineii{+\var{arg0}} {just \var{arg} \index{+}}
403  \lineii{-\var{arg1}} {swapping the sign\index{-}}  \lineii{-\var{arg0}} {swapping the sign\index{-}}
404  \lineii{\var{arg1}+\var{arg2}} {adds \var{arg1} and \var{arg2} \index{+}}  \lineii{\var{arg0}+\var{arg1}} {adds \var{arg0} and \var{arg1} \index{+}}
405  \lineii{\var{arg1}*\var{arg2}} {multiplies \var{arg1} and \var{arg2} \index{*}}  \lineii{\var{arg0}*\var{arg1}} {multiplies \var{arg0} and \var{arg1} \index{*}}
406  \lineii{\var{arg1}-\var{arg2}} {difference \var{arg2} from\var{arg2} \index{-}}  \lineii{\var{arg0}-\var{arg1}} {difference \var{arg1} from\var{arg1} \index{-}}
407  \lineii{\var{arg1}/\var{arg2}} {ratio \var{arg1} by \var{arg2} \index{/}}  \lineii{\var{arg0}/\var{arg1}} {ratio \var{arg0} by \var{arg1} \index{/}}
408  \lineii{\var{arg1}**\var{arg2}} {raises \var{arg1} to the power of \var{arg2} \index{**}}  \lineii{\var{arg0}**\var{arg1}} {raises \var{arg0} to the power of \var{arg1} \index{**}}
409  \end{tableii}  \end{tableii}
410  At least one of the arguments \var{arg1} or \var{arg2} must be a  At least one of the arguments \var{arg0} or \var{arg1} must be a
411  \Data object. One of the arguments may be an object that can be  \Data object. One of the arguments may be an object that can be
412  converted into a \Data object. If \var{arg1} or \var{arg2} are  converted into a \Data object. If \var{arg0} or \var{arg1} are
413  defined on different \FunctionSpace an attempt is made to embed \var{arg1}  defined on different \FunctionSpace an attempt is made to embed \var{arg0}
414  into the \FunctionSpace of \var{arg2} or to embed \var{arg2} into  into the \FunctionSpace of \var{arg1} or to embed \var{arg1} into
415  the \FunctionSpace of \var{arg1}. Boths arguments must have the same  the \FunctionSpace of \var{arg0}. Boths arguments must have the same
416  \Shape or one of the arguments my be of rank 0 or \Shape (1,). In the  \Shape or one of the arguments my be of rank 0. In the
417  latter case it is assumed that the particular argument is of the same  latter case it is assumed that the particular argument is of the same
418  \Shape as the other argument but constant over all components.  \Shape as the other argument but constant over all components.
419
420  The returned \Data object has the same \Shape and is defined on  The returned \Data object has the same \Shape and is defined on
421  the \DataSamplePoints as \var{arg1} or \var{arg2}.  the \DataSamplePoints as \var{arg0} or \var{arg1}.
422
423  The following table shows the update operations that can be applied to  The following table shows the update operations that can be applied to
424  \Data objects:  \Data objects:
425  \begin{tableii}{l|l}{textrm}{expression}{Description}  \begin{tableii}{l|l}{textrm}{expression}{Description}
426  \lineii{\var{arg1}+=\var{arg2}} {adds \var{arg1} to \var{arg2} \index{+}}  \lineii{\var{arg0}+=\var{arg2}} {adds \var{arg0} to \var{arg2} \index{+}}
427  \lineii{\var{arg1}*=\var{arg2}} {multiplies \var{arg1} with \var{arg2} \index{*}}  \lineii{\var{arg0}*=\var{arg2}} {multiplies \var{arg0} with \var{arg2} \index{*}}
428  \lineii{\var{arg1}-=\var{arg2}} {subtracts \var{arg2} from\var{arg2} \index{-}}  \lineii{\var{arg0}-=\var{arg2}} {subtracts \var{arg2} from\var{arg2} \index{-}}
429  \lineii{\var{arg1}/=\var{arg2}} {divides \var{arg1} by \var{arg2} \index{/}}  \lineii{\var{arg0}/=\var{arg2}} {divides \var{arg0} by \var{arg2} \index{/}}
430    \lineii{\var{arg0}**=\var{arg2}} {raises \var{arg0} by \var{arg2} \index{**}}
431  \end{tableii}  \end{tableii}
432  \var{arg1} must be a \Data object. \var{arg1} must be a  \var{arg0} must be a \Data object. \var{arg1} must be a
433  \Data object or an object that can be converted into a  \Data object or an object that can be converted into a
434  \Data object. \var{arg1} must have the same \Shape like  \Data object. \var{arg1} must have the same \Shape like
435  \var{arg1} or has rank 0 or \Shape (1,).  In the latter case it is  \var{arg1} or has rank 0.  In the latter case it is
436  assumed that the values of \var{arg1} are constant for all  assumed that the values of \var{arg1} are constant for all
437  components. \var{arg2} must be defined on the same \DataSamplePoints as  components. \var{arg1} must be defined in the same \FunctionSpace as
438  \var{arg1} or it must be possible to interpolate \var{arg2} onto the  \var{arg0} or it must be possible to interpolate \var{arg1} onto the
439  \DataSamplePoints where \var{arg1} is held.  \FunctionSpace of \var{arg1}.
440
441  The \Data class supports getting slices as well as assigning new values to components in an existing  The \Data class supports getting slices as well as assigning new values to components in an existing
442  \Data object. \index{slicing}  \Data object. \index{slicing}

Legend:
 Removed from v.624 changed lines Added in v.625