/[escript]/trunk/doc/user/faultsystem.tex
ViewVC logotype

Diff of /trunk/doc/user/faultsystem.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2675 by gross, Mon Sep 21 02:32:17 2009 UTC revision 2676 by gross, Mon Sep 21 08:06:37 2009 UTC
# Line 254  applies a shift \var{shift} and a consec Line 254  applies a shift \var{shift} and a consec
254  \end{methoddesc}  \end{methoddesc}
255    
256  \begin{methoddesc}[FaultSystem]{getMaxValue}{f\optional{, tol=1.e-8}}  \begin{methoddesc}[FaultSystem]{getMaxValue}{f\optional{, tol=1.e-8}}
257  returns the maximum value of \var{f}, the fault where the maximum is found and the location on the fault in fault coordinates. \var{f} must be a \Scalar. When the maximum is calculated only \DataSamplePoints are considered  returns the tag of the fault of where \var{f} takes the maximum value and a \class{Locator} object which can be used to collect values from \Data objects at the location where the maximum is taken, e.g.
258    \begin{python}
259    fs=FaultSystem()
260    f=Scalar(..)
261    t, loc=fs.getMaxValue(f)
262    print `maximum value of f on the fault %s is %s at location.'%(t,loc(f),loc.getX())
263    \end{python}
264    \var{f} must be a \Scalar. When the maximum is calculated only \DataSamplePoints are considered
265  which are on a fault in the fault system in the sense of condition~\ref{eq:2D line 3} or \ref{eq:3D line 3}, respectively. In the case no \DataSamplePoints is found the returned tag is \var{None} and  which are on a fault in the fault system in the sense of condition~\ref{eq:2D line 3} or \ref{eq:3D line 3}, respectively. In the case no \DataSamplePoints is found the returned tag is \var{None} and
266  the maximum value as well as the location of the maximum value are undefined.  the maximum value as well as the location of the maximum value are undefined.
267  \end{methoddesc}  \end{methoddesc}
268    
269  \begin{methoddesc}[FaultSystem]{getMinValue}{f\optional{, tol=1.e-8}}  \begin{methoddesc}[FaultSystem]{getMinValue}{f\optional{, tol=1.e-8}}
270  returns the minimum value of \var{f}, the fault where the minimum is found and the location on the fault in fault coordinates. \var{f} must be a \Scalar. When the minimum is calculated only \DataSamplePoints are considered  returns the tag of the fault of where \var{f} takes the minimum value and a \class{Locator} object which can be used to collect values from \Data objects at the location where the minimum is taken, e.g.
271    \begin{python}
272    fs=FaultSystem()
273    f=Scalar(..)
274    t, loc=fs.getMinValue(f)
275    print `minimum value of f on the fault %s is %s at location.'%(t,loc(f),loc.getX())
276    \end{python}
277    \var{f} must be a \Scalar. When the minimum is calculated only \DataSamplePoints are considered
278  which are on a fault in the fault system in the sense of condition~\ref{eq:2D line 3} or \ref{eq:3D line 3}, respectively. In the case no \DataSamplePoints is found the returned tag is \var{None} and  which are on a fault in the fault system in the sense of condition~\ref{eq:2D line 3} or \ref{eq:3D line 3}, respectively. In the case no \DataSamplePoints is found the returned tag is \var{None} and
279  the minimum value as well as the location of the mimimum value are undefined.  the minimum value as well as the location of the minimum value are undefined.
280  \end{methoddesc}  \end{methoddesc}
281    
282  \begin{methoddesc}[FaultSystem]{getParametrization}{x,tag \optional{\optional{, tol=1.e-8}, outsider=None}}  \begin{methoddesc}[FaultSystem]{getParametrization}{x,tag \optional{\optional{, tol=1.e-8}, outsider=None}}

Legend:
Removed from v.2675  
changed lines
  Added in v.2676

  ViewVC Help
Powered by ViewVC 1.1.26