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

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

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

trunk/esys2/escript/src/Data/DataAbstract.h revision 121 by jgs, Fri May 6 04:26:16 2005 UTC trunk/escript/src/DataAbstract.h revision 800 by gross, Tue Aug 8 11:23:18 2006 UTC
# Line 1  Line 1 
1  // $Id$  // $Id$
2  /*  /*
3   ******************************************************************************   ************************************************************
4   *                                                                            *   *          Copyright 2006 by ACcESS MNRF                   *
5   *       COPYRIGHT  ACcESS 2004 -  All Rights Reserved                        *   *                                                          *
6   *                                                                            *   *              http://www.access.edu.au                    *
7   * This software is the property of ACcESS. No part of this code              *   *       Primary Business: Queensland, Australia            *
8   * may be copied in any form or by any means without the expressed written    *   *  Licensed under the Open Software License version 3.0    *
9   * consent of ACcESS.  Copying, use or modification of this software          *   *     http://www.opensource.org/licenses/osl-3.0.php       *
10   * by any unauthorised person is illegal unless that person has a software    *   *                                                          *
11   * license agreement with ACcESS.                                             *   ************************************************************
12   *                                                                            *  
  ******************************************************************************  
13  */  */
14                                                                              
15  #if !defined escript_DataAbstract_20040315_H  #if !defined escript_DataAbstract_20040315_H
16  #define escript_DataAbstract_20040315_H  #define escript_DataAbstract_20040315_H
17    #include "system_dep.h"
18    
19  #include "escript/Data/DataException.h"  #include "DataArrayView.h"
20  #include "escript/Data/DataArrayView.h"  #include "DataArray.h"
21  #include "escript/Data/DataArray.h"  #include "FunctionSpace.h"
 #include "escript/Data/FunctionSpace.h"  
22    
 #include <iostream>  
23  #include <boost/scoped_ptr.hpp>  #include <boost/scoped_ptr.hpp>
24  #include <functional>  #include <boost/python/numeric.hpp>
25    
26  #include <string>  #include <string>
27    #include <fstream>
28    
29  namespace escript {  namespace escript {
30    
# Line 58  class DataAbstract { Line 58  class DataAbstract {
58    
59       \param what - Input - A description of what this data represents.       \param what - Input - A description of what this data represents.
60    */    */
61      ESCRIPT_DLL_API
62    DataAbstract(const FunctionSpace& what);    DataAbstract(const FunctionSpace& what);
63    
64    /**    /**
65      \brief      \brief
66      Destructor for DataAbstract.      Destructor for DataAbstract.
67    */    */
68      ESCRIPT_DLL_API
69    virtual    virtual
70    ~DataAbstract();    ~DataAbstract();
71    
# Line 71  class DataAbstract { Line 73  class DataAbstract {
73       \brief       \brief
74       Write the data as a string.       Write the data as a string.
75    */    */
76      ESCRIPT_DLL_API
77    virtual    virtual
78    std::string    std::string
79    toString() const = 0;    toString() const = 0;
# Line 79  class DataAbstract { Line 82  class DataAbstract {
82       \brief       \brief
83       Return the number of data points per sample.       Return the number of data points per sample.
84    */    */
85      ESCRIPT_DLL_API
86    int    int
87    getNumDPPSample() const;    getNumDPPSample() const;
88    
# Line 86  class DataAbstract { Line 90  class DataAbstract {
90       \brief       \brief
91       Return the number of samples.       Return the number of samples.
92    */    */
93      ESCRIPT_DLL_API
94    int    int
95    getNumSamples() const;    getNumSamples() const;
96    
# Line 95  class DataAbstract { Line 100  class DataAbstract {
100       the shape information for each data point although it also may be used       the shape information for each data point although it also may be used
101       to manipulate the point data.       to manipulate the point data.
102    */    */
103      ESCRIPT_DLL_API
104    DataArrayView&    DataArrayView&
105    getPointDataView();    getPointDataView();
106    
107      ESCRIPT_DLL_API
108    const DataArrayView&    const DataArrayView&
109    getPointDataView() const;    getPointDataView() const;
110    
# Line 110  class DataAbstract { Line 117  class DataAbstract {
117       \param sampleNo - Input - sample number.       \param sampleNo - Input - sample number.
118       \param dataPointNo - Input - data point number.       \param dataPointNo - Input - data point number.
119     */     */
120      ESCRIPT_DLL_API
121    virtual    virtual
122    ValueType::size_type    ValueType::size_type
123    getPointOffset(int sampleNo,    getPointOffset(int sampleNo,
# Line 119  class DataAbstract { Line 127  class DataAbstract {
127       \brief       \brief
128       Return the sample data for the given sample number.       Return the sample data for the given sample number.
129    */    */
130      ESCRIPT_DLL_API
131    double*    double*
132    getSampleData(ValueType::size_type sampleNo);    getSampleData(ValueType::size_type sampleNo);
133    
# Line 126  class DataAbstract { Line 135  class DataAbstract {
135       \brief       \brief
136       Return the number of doubles stored for this Data object.       Return the number of doubles stored for this Data object.
137    */    */
138      ESCRIPT_DLL_API
139    virtual    virtual
140    ValueType::size_type    ValueType::size_type
141    getLength() const = 0;    getLength() const = 0;
# Line 135  class DataAbstract { Line 145  class DataAbstract {
145       Return the sample data for the given tag key.       Return the sample data for the given tag key.
146       NB: If the data isn't tagged an exception will be thrown.       NB: If the data isn't tagged an exception will be thrown.
147    */    */
148      ESCRIPT_DLL_API
149    virtual    virtual
150    double*    double*
151    getSampleDataByTag(int tag);    getSampleDataByTag(int tag);
# Line 151  class DataAbstract { Line 162  class DataAbstract {
162       \param value - Input - value to assign to data-points associated with       \param value - Input - value to assign to data-points associated with
163                              the given reference number.                              the given reference number.
164    */    */
165      ESCRIPT_DLL_API
166    virtual    virtual
167    void    void
168    setRefValue(int ref,    setRefValue(int ref,
# Line 168  class DataAbstract { Line 180  class DataAbstract {
180       \param value - Output - object to receive data-points associated with       \param value - Output - object to receive data-points associated with
181                               the given reference number.                               the given reference number.
182    */    */
183      ESCRIPT_DLL_API
184    virtual    virtual
185    void    void
186    getRefValue(int ref,    getRefValue(int ref,
# Line 180  class DataAbstract { Line 193  class DataAbstract {
193    
194       \param right - Input - The right hand side.       \param right - Input - The right hand side.
195    */    */
196      ESCRIPT_DLL_API
197    void    void
198    operandCheck(const DataAbstract& right) const;    operandCheck(const DataAbstract& right) const;
199    
# Line 187  class DataAbstract { Line 201  class DataAbstract {
201       \brief       \brief
202       Return true if a valid sample point number.       Return true if a valid sample point number.
203    */    */
204      ESCRIPT_DLL_API
205    bool    bool
206    validSamplePointNo(int samplePointNo) const;    validSamplePointNo(int samplePointNo) const;
207    
# Line 194  class DataAbstract { Line 209  class DataAbstract {
209       \brief       \brief
210       Return true if a valid sample number.       Return true if a valid sample number.
211    */    */
212      ESCRIPT_DLL_API
213    bool    bool
214    validSampleNo(int sampleNo) const;    validSampleNo(int sampleNo) const;
215    
# Line 206  class DataAbstract { Line 222  class DataAbstract {
222       \param sampleNo - Input - the sample number.       \param sampleNo - Input - the sample number.
223       \param dataPointNo - Input - the data point number.       \param dataPointNo - Input - the data point number.
224    */    */
225      ESCRIPT_DLL_API
226    virtual    virtual
227    DataArrayView    DataArrayView
228    getDataPoint(int sampleNo,    getDataPoint(int sampleNo,
# Line 215  class DataAbstract { Line 232  class DataAbstract {
232       \brief       \brief
233       Return the function space associated with this Data object.       Return the function space associated with this Data object.
234    */    */
235      ESCRIPT_DLL_API
236    const    const
237    FunctionSpace&    FunctionSpace&
238    getFunctionSpace() const;    getFunctionSpace() const;
# Line 225  class DataAbstract { Line 243  class DataAbstract {
243    
244       NB: The caller is responsible for managing the object created.       NB: The caller is responsible for managing the object created.
245    */    */
246      ESCRIPT_DLL_API
247    virtual    virtual
248    DataAbstract*    DataAbstract*
249    getSlice(const DataArrayView::RegionType& region) const = 0;    getSlice(const DataArrayView::RegionType& region) const = 0;
# Line 236  class DataAbstract { Line 255  class DataAbstract {
255       \param value - Input - Data to copy from       \param value - Input - Data to copy from
256       \param region - Input - Region to copy.       \param region - Input - Region to copy.
257    */    */
258      ESCRIPT_DLL_API
259    virtual    virtual
260    void    void
261    setSlice(const DataAbstract* value,    setSlice(const DataAbstract* value,
# Line 248  class DataAbstract { Line 268  class DataAbstract {
268       The original data point value is used for all values of the new       The original data point value is used for all values of the new
269       data point.       data point.
270    */    */
271      ESCRIPT_DLL_API
272    virtual    virtual
273    void    void
274    reshapeDataPoint(const ShapeType& shape) = 0;    reshapeDataPoint(const ShapeType& shape) = 0;
# Line 264  class DataAbstract { Line 285  class DataAbstract {
285       \param tagKey - Input - Integer key.       \param tagKey - Input - Integer key.
286       \param value - Input - Single DataArrayView value to be assigned to the tag.       \param value - Input - Single DataArrayView value to be assigned to the tag.
287    */    */
288      ESCRIPT_DLL_API
289    virtual    virtual
290    void    void
291    setTaggedValue(int tagKey,    setTaggedValue(int tagKey,
292                   const DataArrayView& value);                   const DataArrayView& value);
293    
294      /**
295        \brief
296        Archive the underlying data values to the file referenced
297        by ofstream. A count of the number of values expected to be written
298        is provided as a cross-check.
299    
300        The return value indicates success (0) or otherwise (1).
301      */
302      ESCRIPT_DLL_API
303      virtual
304      int
305      archiveData(std::ofstream& archiveFile,
306                  const ValueType::size_type noValues) const;
307    
308      /**
309        \brief
310        Extract the number of values specified by noValues from the file
311        referenced by ifstream to the underlying data structure.
312    
313        The return value indicates success (0) or otherwise (1).
314      */
315      ESCRIPT_DLL_API
316      virtual
317      int
318      extractData(std::ifstream& archiveFile,
319                  const ValueType::size_type noValues);
320    
321      /**
322         \brief
323         Copy the numarray object to the data points in this object.
324    
325         Description:
326         Copy the numarray object to the data points in this object.
327    
328         \param value Input - new values for the data points
329      */
330      ESCRIPT_DLL_API
331      virtual void
332      copyAll(const boost::python::numeric::array& value);
333    
334      /**
335         \brief
336         Return the tag number associated with the given data-point number.
337    
338         If the object cannot be referenced by tag numbers, an exception
339         will be thrown.
340      */
341      ESCRIPT_DLL_API
342      virtual
343      int
344      getTagNumber(int dpno);
345    
346      /**
347         \brief
348         Computes a symmetric matrix (A + AT) / 2
349    
350         \param ev - Output - a symmetric matrix
351    
352      */
353      ESCRIPT_DLL_API
354      virtual void
355      symmetric(DataAbstract* ev);
356    
357      /**
358         \brief
359         Computes a nonsymmetric matrix (A - AT) / 2
360    
361         \param ev - Output - a nonsymmetric matrix
362    
363      */
364      ESCRIPT_DLL_API
365      virtual void
366      nonsymmetric(DataAbstract* ev);
367    
368      /**
369         \brief
370         Computes the trace of a matrix
371    
372         \param ev - Output - the trace of a matrix
373    
374      */
375      ESCRIPT_DLL_API
376      virtual void
377      trace(DataAbstract* ev, int axis_offset);
378    
379      /**
380         \brief
381         Transpose each data point of this Data object around the given axis.
382    
383         \param ev - Output - the transpose of a matrix
384    
385      */
386      ESCRIPT_DLL_API
387      virtual void
388      transpose(DataAbstract* ev, int axis_offset);
389    
390      /**
391         \brief
392         swaps components axis_offset and axis_offset+1
393    
394         \param ev - Output - swapped components
395    
396      */
397      ESCRIPT_DLL_API
398      virtual void
399      swap(DataAbstract* ev, int axis_offset);
400    
401      /**
402         \brief
403         solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
404    
405         \param ev - Output - eigenvalues in increasing order at each data point
406    
407      */
408      ESCRIPT_DLL_API
409      virtual void
410      eigenvalues(DataAbstract* ev);
411    
412      /**
413         \brief
414         solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V
415    
416         \param ev - Output - eigenvalues in increasing order at each data point
417         \param V - Output - corresponding eigenvectors. They are normalized such that their length is one
418                             and the first nonzero component is positive.
419         \param tol - Input - eigenvalue with relative distance tol are treated as equal.
420    
421      */
422    
423      ESCRIPT_DLL_API
424      virtual void
425      eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);
426    
427   protected:   protected:
428    
429    /**    /**
# Line 278  class DataAbstract { Line 433  class DataAbstract {
433       \param input - Input - The point data view. DataAbstract takes ownership       \param input - Input - The point data view. DataAbstract takes ownership
434       of the DataArrayView provided. It will delete it when it is destructed.       of the DataArrayView provided. It will delete it when it is destructed.
435    */    */
436      ESCRIPT_DLL_API
437    void    void
438    setPointDataView(const DataArrayView& input);    setPointDataView(const DataArrayView& input);
439    
440      ESCRIPT_DLL_API
441    void    void
442    resetPointDataView();    resetPointDataView();
443    
# Line 366  DataAbstract::getPointDataView() Line 523  DataAbstract::getPointDataView()
523  {  {
524    return *(m_pointDataView.get());    return *(m_pointDataView.get());
525  }  }
   
526  } // end of namespace  } // end of namespace
527    
528  #endif  #endif

Legend:
Removed from v.121  
changed lines
  Added in v.800

  ViewVC Help
Powered by ViewVC 1.1.26