/[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/DataExpanded.h revision 921 by gross, Fri Jan 5 00:54:37 2007 UTC temp/escript/src/DataExpanded.h revision 1387 by trankine, Fri Jan 11 07:45:26 2008 UTC
# Line 1  Line 1 
1  // $Id$  
2  /*  /* $Id$ */
3   ************************************************************  
4   *          Copyright 2006 by ACcESS MNRF                   *  /*******************************************************
5   *                                                          *   *
6   *              http://www.access.edu.au                    *   *           Copyright 2003-2007 by ACceSS MNRF
7   *       Primary Business: Queensland, Australia            *   *       Copyright 2007 by University of Queensland
8   *  Licensed under the Open Software License version 3.0    *   *
9   *     http://www.opensource.org/licenses/osl-3.0.php       *   *                http://esscc.uq.edu.au
10   *                                                          *   *        Primary Business: Queensland, Australia
11   ************************************************************   *  Licensed under the Open Software License version 3.0
12  */   *     http://www.opensource.org/licenses/osl-3.0.php
13     *
14     *******************************************************/
15    
16  #if !defined escript_DataExpanded_20040323_H  #if !defined escript_DataExpanded_20040323_H
17  #define escript_DataExpanded_20040323_H  #define escript_DataExpanded_20040323_H
# Line 147  class DataExpanded : public DataAbstract Line 149  class DataExpanded : public DataAbstract
149    virtual    virtual
150    std::string    std::string
151    toString() const;    toString() const;
152     /**
153         \brief
154         dumps the object into a netCDF file
155      */
156      ESCRIPT_DLL_API
157      virtual
158      void
159      dump(const std::string fileName) const;
160    
161     /**
162         \brief
163        sets all values to zero
164      */
165      ESCRIPT_DLL_API
166      virtual
167      void
168      setToZero();
169    
170    /**    /**
171       \brief       \brief
# Line 214  class DataExpanded : public DataAbstract Line 233  class DataExpanded : public DataAbstract
233             const DataArrayView::RegionType& region);             const DataArrayView::RegionType& region);
234    
235    /**    /**
      \brief  
      Assign the given value to all data-points associated with the given  
      reference number.  
   
      A reference number corresponds to a sample, and thus to all data-points  
      in that sample.  
   
      If the given reference number does not correspond to any sample in this  
      Data object, an exception will be thrown.  
   
      If the given value is a different shape to this Data object, an exception  
      will be thrown.  
   
      \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.  
   */  
   ESCRIPT_DLL_API  
   virtual  
   void  
   setRefValue(int ref,  
               const DataArray& value);  
   
   /**  
      \brief  
      Return the value of the first data-point in the sample associated with  
      the given reference number.  
   
      A reference number corresponds to a sample, and thus to all data-points  
      in that sample. If there is more than one data-point per sample number  
      in this Data object, the value of the first data-point will be returned.  
   
      If the given reference number does not correspond to any sample in this  
      Data object, an exception will be thrown.  
   
      If the given value is a different shape to this Data object, an exception  
      will be thrown.  
   
      \param ref - Input - reference number which determines sample number to  
                           read from.  
      \param value - Output - Object to receive data-points associated with  
                             the given reference number.  
   */  
   ESCRIPT_DLL_API  
   virtual  
   void  
   getRefValue(int ref,  
               DataArray& value);  
   
   /**  
236      \brief      \brief
237      Archive the underlying data values to the file referenced      Archive the underlying data values to the file referenced
238      by ofstream. A count of the number of values expected to be written      by ofstream. A count of the number of values expected to be written
# Line 291  class DataExpanded : public DataAbstract Line 259  class DataExpanded : public DataAbstract
259    
260    /**    /**
261       \brief       \brief
262         setTaggedValue
263    
264         Description:
265         uses tag to set a new value
266    
267         \param tagKey - Input - Integer key.
268         \param value - Input - Single DataArrayView value to be assigned to the tag.
269      */
270      ESCRIPT_DLL_API
271      virtual
272      void
273      setTaggedValue(int tagKey,
274                     const DataArrayView& value);
275    
276      /**
277         \brief
278       Computes a symmetric matrix (A + AT) / 2       Computes a symmetric matrix (A + AT) / 2
279    
280       \param ev - Output - symmetric matrix       \param ev - Output - symmetric matrix
# Line 434  class DataExpanded : public DataAbstract Line 418  class DataExpanded : public DataAbstract
418    
419    /**    /**
420       \brief       \brief
421         Copy a double value to the data point dataPointNo of sample sampleNo in this object.
422    
423         Description:
424         Copy a double value to the data point dataPointNo of sample sampleNo in this object.
425    
426         \param sampleNo Input - sample number
427         \param dataPointNo Input - data point of the sample
428         \param value Input - new values for the data point
429      */
430      ESCRIPT_DLL_API
431      virtual void
432      copyToDataPoint(const int sampleNo, const int dataPointNo, const double value);
433    
434    
435      /**
436         \brief
437       Copy the numarray object to the data point dataPointNo of sample sampleNo in this object.       Copy the numarray object to the data point dataPointNo of sample sampleNo in this object.
438    
439       Description:       Description:

Legend:
Removed from v.921  
changed lines
  Added in v.1387

  ViewVC Help
Powered by ViewVC 1.1.26