/[escript]/trunk/escript/src/DataTagged.h
ViewVC logotype

Diff of /trunk/escript/src/DataTagged.h

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

revision 513 by jgs, Mon Feb 13 04:46:51 2006 UTC revision 615 by elspeth, Wed Mar 22 02:12:00 2006 UTC
# Line 1  Line 1 
1  // $Id$  // $Id$
2    
3  /*  /*
4   ******************************************************************************   ************************************************************
5   *                                                                            *   *          Copyright 2006 by ACcESS MNRF                   *
6   *       COPYRIGHT  ACcESS 2004 -  All Rights Reserved                        *   *                                                          *
7   *                                                                            *   *              http://www.access.edu.au                    *
8   * This software is the property of ACcESS. No part of this code              *   *       Primary Business: Queensland, Australia            *
9   * may be copied in any form or by any means without the expressed written    *   *  Licensed under the Open Software License version 3.0    *
10   * consent of ACcESS.  Copying, use or modification of this software          *   *     http://www.opensource.org/licenses/osl-3.0.php       *
11   * by any unauthorised person is illegal unless that person has a software    *   *                                                          *
12   * license agreement with ACcESS.                                             *   ************************************************************
  *                                                                            *  
  ******************************************************************************  
13  */  */
14    
15  #if !defined escript_DataTagged_20040615_H  #if !defined escript_DataTagged_20040615_H
# Line 97  class DataTagged : public DataAbstract { Line 95  class DataTagged : public DataAbstract {
95       \param shape - Input - The shape of each data-point.       \param shape - Input - The shape of each data-point.
96       \param tags - Input - An array of tags, one for each sample number.       \param tags - Input - An array of tags, one for each sample number.
97       \param data - The data values for each tag.       \param data - The data values for each tag.
98        NB: no unit testing yet
99    */    */
100    DataTagged(const FunctionSpace& what,    DataTagged(const FunctionSpace& what,
101               const DataArrayView::ShapeType &shape,               const DataArrayView::ShapeType &shape,
# Line 332  class DataTagged : public DataAbstract { Line 331  class DataTagged : public DataAbstract {
331       Factory method that returns a newly created DataTagged object generated       Factory method that returns a newly created DataTagged object generated
332       by taking the specified slice from this DataTagged object.       by taking the specified slice from this DataTagged object.
333       The caller is reponsible for managing the returned object.       The caller is reponsible for managing the returned object.
334        T
335    */    */
336    virtual    virtual
337    DataAbstract*    DataAbstract*
# Line 342  class DataTagged : public DataAbstract { Line 342  class DataTagged : public DataAbstract {
342       Slice Constructor for DataTagged.       Slice Constructor for DataTagged.
343    
344       Description:       Description:
      Slice Constructor for DataTagged.  
345       Creates a DataTagged object which is the specified slice       Creates a DataTagged object which is the specified slice
346       from another DataTagged object.       from the given DataTagged object.
347       \param other - Input - DataTagged object to copy from.       \param other - Input - DataTagged object to slice from.
348       \param region - Input - Region to copy.       \param region - Input - Region to slice.
349        T
350    */    */
351    DataTagged(const DataTagged& other,    DataTagged(const DataTagged& other,
352           const DataArrayView::RegionType& region);           const DataArrayView::RegionType& region);
# Line 356  class DataTagged : public DataAbstract { Line 356  class DataTagged : public DataAbstract {
356       setSlice       setSlice
357    
358       Description:       Description:
359       Copy the specified region from the given Data object into this object.       Copy the given Data object into the specified region in this object.
360       \param other - Input - Data object to copy from.       \param other - Input - Data object to copy from.
361       \param region - Input - Region to copy (NB: must have same shape as this!).       \param region - Input - Region to copy into (NB: must have same shape as other!).
362        T
363    */    */
364    virtual    virtual
365    void    void
# Line 403  class DataTagged : public DataAbstract { Line 404  class DataTagged : public DataAbstract {
404    extractData(std::ifstream& archiveFile,    extractData(std::ifstream& archiveFile,
405                const DataArrayView::ValueType::size_type noValues);                const DataArrayView::ValueType::size_type noValues);
406    
407      /**
408         \brief
409         solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
410    
411         \param ev - Output - eigenvalues in increasing order at each data point
412    
413      */
414      virtual void
415      eigenvalues(DataAbstract* ev);
416    
417      /**
418         \brief
419         solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V
420    
421         \param ev - Output - eigenvalues in increasing order at each data point
422         \param V - Output - corresponding eigenvectors. They are normalized such that their length is one
423                             and the first nonzero component is positive.
424         \param tol - Input - eigenvalue with relative distance tol are treated as equal.
425    
426      */
427    
428      virtual void
429      eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);
430    
431    
432   protected:   protected:
433    
434   private:   private:

Legend:
Removed from v.513  
changed lines
  Added in v.615

  ViewVC Help
Powered by ViewVC 1.1.26