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

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

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

trunk/escript/src/Data/DataExpanded.h revision 155 by jgs, Wed Nov 9 02:02:19 2005 UTC trunk/escript/src/DataExpanded.h revision 2653 by jfenwick, Tue Sep 8 04:26:30 2009 UTC
# Line 1  Line 1 
1  // $Id$  
2  /*  /*******************************************************
3   ******************************************************************************  *
4   *                                                                            *  * Copyright (c) 2003-2009 by University of Queensland
5   *       COPYRIGHT  ACcESS 2004 -  All Rights Reserved                        *  * Earth Systems Science Computational Center (ESSCC)
6   *                                                                            *  * http://www.uq.edu.au/esscc
7   * This software is the property of ACcESS. No part of this code              *  *
8   * may be copied in any form or by any means without the expressed written    *  * Primary Business: Queensland, Australia
9   * consent of ACcESS.  Copying, use or modification of this software          *  * Licensed under the Open Software License version 3.0
10   * by any unauthorised person is illegal unless that person has a software    *  * http://www.opensource.org/licenses/osl-3.0.php
11   * license agreement with ACcESS.                                             *  *
12   *                                                                            *  *******************************************************/
13   ******************************************************************************  
14  */  
                                                                             
15  #if !defined escript_DataExpanded_20040323_H  #if !defined escript_DataExpanded_20040323_H
16  #define escript_DataExpanded_20040323_H  #define escript_DataExpanded_20040323_H
17    #include "system_dep.h"
18    
19  #include "DataAbstract.h"  #include "DataReady.h"
20  #include "DataBlocks2D.h"  #include "DataBlocks2D.h"
 #include "DataArrayView.h"  
   
 #include <boost/scoped_ptr.hpp>  
 #include <boost/python/numeric.hpp>  
21    
22  namespace escript {  namespace escript {
23    
24  //  //
25  // Forward declarations of other Data types.  // Forward declarations of other Data types.
 class DataEmpty;  
26  class DataConstant;  class DataConstant;
27  class DataTagged;  class DataTagged;
28    
# Line 43  class DataTagged; Line 38  class DataTagged;
38     template must satisfy.     template must satisfy.
39  */  */
40    
41  class DataExpanded : public DataAbstract {  class DataExpanded : public DataReady {
42    
43    typedef DataReady parent;
44    
45   public:   public:
46    
# Line 58  class DataExpanded : public DataAbstract Line 55  class DataExpanded : public DataAbstract
55       this data object, where the number of data points is defined by       this data object, where the number of data points is defined by
56       the given function space.       the given function space.
57    
58       \param value - Input - A single data value.       \param value - Input - The value of a single data point.
59       \param what - Input - A description of what this data represents.       \param what - Input - A description of what this data represents.
60    */    */
61    DataExpanded(const boost::python::numeric::array& value,    ESCRIPT_DLL_API
62                 const FunctionSpace& what);    DataExpanded(const WrappedArray& value,
   
   /**  
      \brief  
      Alternative constructor for DataExpanded.  
   
      Description:  
      Alternative Constructor for DataExpanded.  
   
      The given single data value is copied to all the data points in  
      this data object, where the number of data points is defined by  
      the given function space.  
   
      \param value - Input - A single data value.  
      \param what - Input - A description of what this data represents.  
   */  
   DataExpanded(const DataArrayView& value,  
63                 const FunctionSpace& what);                 const FunctionSpace& what);
64    
65    /**    /**
# Line 89  class DataExpanded : public DataAbstract Line 70  class DataExpanded : public DataAbstract
70       \param other - Input - DataExpanded object to slice from.       \param other - Input - DataExpanded object to slice from.
71       \param region - Input - region to copy.       \param region - Input - region to copy.
72    */    */
73      ESCRIPT_DLL_API
74    DataExpanded(const DataExpanded& other,    DataExpanded(const DataExpanded& other,
75                 const DataArrayView::RegionType& region);                 const DataTypes::RegionType& region);
76    
77    /**    /**
78       \brief       \brief
# Line 101  class DataExpanded : public DataAbstract Line 83  class DataExpanded : public DataAbstract
83       \param what - Input - A description of what this data object represents.       \param what - Input - A description of what this data object represents.
84       \param shape - Input - the shape of each data-point.       \param shape - Input - the shape of each data-point.
85       \param data - the array of data values for the data-points.       \param data - the array of data values for the data-points.
86    
87    TODO Note that this constructor will also copy data to all points if it only contains enough elements to hold a single point.  ie this is the merge of two separate constructors.
88    */    */
89      ESCRIPT_DLL_API
90    DataExpanded(const FunctionSpace& what,    DataExpanded(const FunctionSpace& what,
91                 const DataArrayView::ShapeType &shape,                 const DataTypes::ShapeType &shape,
92                 const DataArrayView::ValueType &data);                 const DataTypes::ValueType &data);
93    
94    /**    /**
95       \brief       \brief
96       Copy constructor for DataExpanded.       Copy constructor for DataExpanded.
97       Performs a deep copy from another DataExpanded.       Performs a deep copy from another DataExpanded.
98    */    */
99      ESCRIPT_DLL_API
100    DataExpanded(const DataExpanded& other);    DataExpanded(const DataExpanded& other);
101    
102    /**    /**
# Line 118  class DataExpanded : public DataAbstract Line 104  class DataExpanded : public DataAbstract
104       Copy constructor for DataExpanded.       Copy constructor for DataExpanded.
105       Construct a DataExpanded from a DataConstant.       Construct a DataExpanded from a DataConstant.
106    */    */
107      ESCRIPT_DLL_API
108    DataExpanded(const DataConstant& other);    DataExpanded(const DataConstant& other);
109    
110    /**    /**
# Line 125  class DataExpanded : public DataAbstract Line 112  class DataExpanded : public DataAbstract
112       Copy constructor for DataExpanded.       Copy constructor for DataExpanded.
113       Construct a DataExpanded from a DataTagged.       Construct a DataExpanded from a DataTagged.
114    */    */
115      ESCRIPT_DLL_API
116    DataExpanded(const DataTagged& other);    DataExpanded(const DataTagged& other);
117    
118    /**    /**
119       \brief       \brief
120       Default destructor for DataExpanded.       Default destructor for DataExpanded.
121    */    */
122      ESCRIPT_DLL_API
123    virtual    virtual
124    ~DataExpanded();    ~DataExpanded();
125    
126      ESCRIPT_DLL_API
127      bool
128      isExpanded() const
129      {
130        return true;
131      };
132    
133      ESCRIPT_DLL_API
134      bool
135      actsExpanded() const
136      {
137        return true;
138      }
139    
140    /**    /**
141       \brief       \brief
142       Return a textual representation of the data.       Return a textual representation of the data.
143    */    */
144      ESCRIPT_DLL_API
145    virtual    virtual
146    std::string    std::string
147    toString() const;    toString() const;
148    
149    /**    /**
150         \brief Return a deep copy of the current object.
151      */
152      ESCRIPT_DLL_API
153      virtual
154      DataAbstract*
155      deepCopy();
156    
157    
158     /**
159       \brief       \brief
160       Reshape the data point if the data point is currently rank 0.       dumps the object into a netCDF file
      The original data point value is used for all values of the new  
      data point.  
161    */    */
162      ESCRIPT_DLL_API
163      virtual
164    void    void
165    reshapeDataPoint(const DataArrayView::ShapeType& shape);    dump(const std::string fileName) const;
166    
167     /**
168         \brief
169        sets all values to zero
170      */
171      ESCRIPT_DLL_API
172      virtual
173      void
174      setToZero();
175    
176    /**    /**
177       \brief       \brief
# Line 160  class DataExpanded : public DataAbstract Line 182  class DataExpanded : public DataAbstract
182       \param sampleNo - Input - sample number.       \param sampleNo - Input - sample number.
183       \param dataPointNo - Input - data point number.       \param dataPointNo - Input - data point number.
184    */    */
185      ESCRIPT_DLL_API
186    virtual    virtual
187    DataArrayView::ValueType::size_type    DataTypes::ValueType::size_type
188    getPointOffset(int sampleNo,    getPointOffset(int sampleNo,
189                   int dataPointNo) const;                   int dataPointNo) const;
190    
191      ESCRIPT_DLL_API
192      virtual
193      DataTypes::ValueType::size_type
194      getPointOffset(int sampleNo,
195                     int dataPointNo);
196    
197    /**    /**
198       \brief       \brief
199       Return a view into the data array for the data point specified.       Return a a reference to the underlying DataVector.
200      */
201    
202      ESCRIPT_DLL_API
203      DataTypes::ValueType&
204      getVectorRW();
205    
206      ESCRIPT_DLL_API
207      const DataTypes::ValueType&
208      getVectorRO() const;
209    
      NOTE: Construction of the DataArrayView is a relatively expensive  
      operation.  
210    
      \param sampleNo - Input - sample number.  
      \param dataPointNo - Input - data point number.  
      \return DataArrayView for the data point.  
   */  
   DataArrayView  
   getDataPoint(int sampleNo,  
                int dataPointNo);  
211    
212    /**    /**
213       \brief       \brief
214       Return the number of doubles stored for the Data.       Return the number of doubles stored for the Data.
215    */    */
216      ESCRIPT_DLL_API
217    virtual    virtual
218    ValueType::size_type    ValueType::size_type
219    getLength() const;    getLength() const;
# Line 195  class DataExpanded : public DataAbstract Line 225  class DataExpanded : public DataAbstract
225    
226       \param region - Input - Region to copy.       \param region - Input - Region to copy.
227    */    */
228      ESCRIPT_DLL_API
229    virtual    virtual
230    DataAbstract*    DataAbstract*
231    getSlice(const DataArrayView::RegionType& region) const;    getSlice(const DataTypes::RegionType& region) const;
232    
233    /**    /**
234       \brief       \brief
# Line 206  class DataExpanded : public DataAbstract Line 237  class DataExpanded : public DataAbstract
237       \param value - Input - Data object to copy from.       \param value - Input - Data object to copy from.
238       \param region - Input - Region to copy.       \param region - Input - Region to copy.
239    */    */
240      ESCRIPT_DLL_API
241    virtual    virtual
242    void    void
243    setSlice(const DataAbstract* value,    setSlice(const DataAbstract* value,
244             const DataArrayView::RegionType& region);             const DataTypes::RegionType& region);
245    
246      /**
247         \brief
248         setTaggedValue
249    
250         Description:
251         uses tag to set a new value
252    
253         \param tagKey - Input - Integer key.
254         \param pointshape - Input - The shape of the value parameter
255         \param value - Input -
256         \param dataOffset - Input - where in the value parameter to start reading the data point value.
257      */
258      void  
259      setTaggedValue(int tagKey,
260                 const DataTypes::ShapeType& pointshape,
261                     const DataTypes::ValueType& value,
262             int dataOffset=0);
263    
264    
265    
266    /**    /**
267       \brief       \brief
268       Assign the given value to all data-points associated with the given       Computes a symmetric matrix (A + AT) / 2
269       reference number.  
270         \param ev - Output - symmetric matrix
271    
272       A reference number corresponds to a sample, and thus to all data-points    */
273       in that sample.    ESCRIPT_DLL_API
274      virtual void
275      symmetric(DataAbstract* ev);
276    
277       If the given reference number does not correspond to any sample in this    /**
278       Data object, an exception will be thrown.       \brief
279         Computes a nonsymmetric matrix (A - AT) / 2
280    
281       If the given value is a different shape to this Data object, an exception       \param ev - Output - nonsymmetric matrix
      will be thrown.  
282    
      \param ref - Input - reference number which determines sample numebr to  
                           assign given values to.  
      \param value - Input - Value to assign to data-point associated with  
                             the given reference number.  
283    */    */
284    virtual    ESCRIPT_DLL_API
285    void    virtual void
286    setRefValue(int ref,    nonsymmetric(DataAbstract* ev);
               const DataArray& value);  
287    
288    /**    /**
289       \brief       \brief
290       Return the value of the first data-point in the sample associated with       Computes the trace of a matrix
      the given reference number.  
291    
292       A reference number corresponds to a sample, and thus to all data-points       \param ev - Output - trace of your matrix
293       in that sample. If there is more than one data-point per sample number       \param axis_offset -
      in this Data object, the value of the first data-point will be returned.  
294    
295       If the given reference number does not correspond to any sample in this    */
296       Data object, an exception will be thrown.    ESCRIPT_DLL_API
297      virtual void
298      trace(DataAbstract* ev, int axis_offset);
299    
300       If the given value is a different shape to this Data object, an exception    /**
301       will be thrown.       \brief
302         Transpose each data point of this Data object around the given axis.
303    
304       \param ref - Input - reference number which determines sample number to       \param ev - Output - transpose of your matrix
305                            read from.       \param axis_offset -
      \param value - Output - Object to receive data-points associated with  
                             the given reference number.  
306    */    */
307    virtual    ESCRIPT_DLL_API
308    void    virtual void
309    getRefValue(int ref,    transpose(DataAbstract* ev, int axis_offset);
               DataArray& value);  
310    
311    /**    /**
312      \brief       \brief
313      Archive the underlying data values to the file referenced       swaps components axis0 and axis1
     by ofstream. A count of the number of values expected to be written  
     is provided as a cross-check.  
314    
315      The return value indicates success (0) or otherwise (1).       \param ev - Output - swapped components
316         \param axis0
317         \param axis1
318    */    */
319    int    ESCRIPT_DLL_API
320    archiveData(std::ofstream& archiveFile,    virtual void
321                const DataArrayView::ValueType::size_type noValues) const;    swapaxes(DataAbstract* ev, int axis0, int axis1);
322    
323    
324    /**    /**
325      \brief       \brief
326      Extract the number of values specified by noValues from the file       solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
327      referenced by ifstream to the underlying data structure.  
328         \param ev - Output - eigenvalues in increasing order at each data point
329    
     The return value indicates success (0) or otherwise (1).  
330    */    */
331    int    ESCRIPT_DLL_API
332    extractData(std::ifstream& archiveFile,    virtual void
333                const DataArrayView::ValueType::size_type noValues);    eigenvalues(DataAbstract* ev);
334    
335      /**
336         \brief
337         solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V
338    
339         \param ev - Output - eigenvalues in increasing order at each data point
340         \param V - Output - corresponding eigenvectors. They are normalized such that their length is one
341                             and the first nonzero component is positive.
342         \param tol - Input - eigenvalue with relative distance tol are treated as equal.
343    
344      */
345    
346      ESCRIPT_DLL_API
347      virtual void
348      eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);
349    
350    /**
351     *      \brief
352     *           reorders data sample ordered by reference_ids to the ordering of the functions space
353     *
354     *                \param reference_ids - Input - reference_ids used for current ordering
355     *                  */
356      ESCRIPT_DLL_API
357      virtual void
358      reorderByReferenceIDs(int *reference_ids);
359    
360    
361    
362   protected:   protected:
363    
# Line 298  class DataExpanded : public DataAbstract Line 374  class DataExpanded : public DataAbstract
374       given shape and number of data points, and creates the corresponding       given shape and number of data points, and creates the corresponding
375       DataArrayView of this data.       DataArrayView of this data.
376    
      \param shape - Input - The shape of the point data.  
377       \param noSamples - Input - number of samples.       \param noSamples - Input - number of samples.
378       \param noDataPointsPerSample - Input - number of data points per sample.       \param noDataPointsPerSample - Input - number of data points per sample.
379    */    */
380    void    void
381    initialise(const DataArrayView::ShapeType& shape,    initialise(int noSamples,
              int noSamples,  
382               int noDataPointsPerSample);               int noDataPointsPerSample);
383    
384    /**    /**
# Line 317  class DataExpanded : public DataAbstract Line 391  class DataExpanded : public DataAbstract
391       \param value Input - A single data point value.       \param value Input - A single data point value.
392    */    */
393    void    void
394    copy(const DataArrayView& value);    copy(const DataConstant& value);
395    
396    
397    
398    /**    /**
399       \brief       \brief
400       Copy the given data point value given a numarray object to all data points in this object.       Copy the given data point value to all data points in this object.
   
      Description:  
      Copy the given data point value given a numarray object to all data points in this object.  
401    
402       \param value Input - A single data point value.       \param value Input - A single data point value.
403    */    */
404    
405    void    void
406    copy(const boost::python::numeric::array& value);    copy(const WrappedArray& value);
407    
408    
409    /**    /**
410       \brief       \brief
411       Copy the numarray object to the data points in this object.       Copy a double value to the data point dataPointNo of sample sampleNo in this object.
412    
413       Description:       Description:
414       Copy the numarray object to the data points in this object.       Copy a double value to the data point dataPointNo of sample sampleNo in this object.
415    
416       \param value Input - new values for the data points       \param sampleNo Input - sample number
417         \param dataPointNo Input - data point of the sample
418         \param value Input - new values for the data point
419    */    */
420    void    ESCRIPT_DLL_API
421    copyAll(const boost::python::numeric::array& value);    virtual void
422      copyToDataPoint(const int sampleNo, const int dataPointNo, const double value);
423    
424    
425      /**
426         \brief
427         Copy the value to the data point dataPointNo of sample sampleNo in this object.
428    
429         \param sampleNo Input - sample number
430         \param dataPointNo Input - data point of the sample
431         \param value Input - new values for the data point
432      */
433      ESCRIPT_DLL_API
434      virtual void
435      copyToDataPoint(const int sampleNo, const int dataPointNo, const WrappedArray& value);
436    
437    //    //
438    // The main data storage array, a 2D array of data blocks.    // The main data storage array, a 2D array of data blocks.

Legend:
Removed from v.155  
changed lines
  Added in v.2653

  ViewVC Help
Powered by ViewVC 1.1.26