escript  Revision_
DataExpanded.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2016 by The University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Apache License, version 2.0
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development 2012-2013 by School of Earth Sciences
13 * Development from 2014 by Centre for Geoscience Computing (GeoComp)
14 *
15 *****************************************************************************/
16 
17 
18 #if !defined escript_DataExpanded_20040323_H
19 #define escript_DataExpanded_20040323_H
20 #include "system_dep.h"
21 
22 #include "DataReady.h"
23 
24 namespace escript {
25 
26 //
27 // Forward declarations of other Data types.
28 class DataConstant;
29 class DataTagged;
30 
43 class DataExpanded : public DataReady {
44 
45 typedef DataReady parent;
46 
47  public:
48 
64  explicit DataExpanded(const WrappedArray& value,
65  const FunctionSpace& what);
66 
76  explicit DataExpanded(const DataExpanded& other,
77  const DataTypes::RegionType& region);
78 
92  explicit DataExpanded(const FunctionSpace& what,
93  const DataTypes::ShapeType &shape,
94  const DataTypes::RealVectorType &data);
95 
96 
98  explicit DataExpanded(const FunctionSpace& what,
99  const DataTypes::ShapeType &shape,
100  const DataTypes::CplxVectorType &data);
101 
102 
103 
105  explicit DataExpanded(const FunctionSpace& what,
106  const DataTypes::ShapeType &shape,
107  const DataTypes::real_t data);
108 
110  explicit DataExpanded(const FunctionSpace& what,
111  const DataTypes::ShapeType &shape,
112  const DataTypes::cplx_t data);
113 
114 
121  DataExpanded(const DataExpanded& other);
122 
129  explicit DataExpanded(const DataConstant& other);
130 
137  explicit DataExpanded(const DataTagged& other);
138 
144  virtual
145  ~DataExpanded();
146 
148  bool
149  isExpanded() const
150  {
151  return true;
152  };
153 
155  bool
156  actsExpanded() const
157  {
158  return true;
159  }
160 
165  bool
166  hasNaN() const;
167 
172  void
174 
176  void
178 
184  virtual
185  std::string
186  toString() const;
187 
192  virtual
193  DataAbstract*
194  deepCopy() const;
195 
196 
202  virtual
203  void
204  dump(const std::string fileName) const;
205 
206 
213  virtual int
214  matrixInverse(DataAbstract* out) const;
215 
221  virtual
222  void
223  setToZero();
224 
235  virtual
237  getPointOffset(int sampleNo,
238  int dataPointNo) const;
239 
240 // ESCRIPT_DLL_API
241 // virtual
242 // DataTypes::RealVectorType::size_type
243 // getPointOffset(int sampleNo,
244 // int dataPointNo);
245 
253  getVectorRW();
254 
257  getVectorRO() const;
258 
261  getVectorRWC();
262 
265  getVectorROC() const;
266 
269 
270  virtual const DataTypes::RealVectorType&
271  getTypedVectorRO(DataTypes::real_t dummy) const;
272 
275 
276  virtual const DataTypes::CplxVectorType&
277  getTypedVectorRO(DataTypes::cplx_t dummy) const;
278 
284  virtual
286  getLength() const;
287 
296  virtual
297  DataAbstract*
298  getSlice(const DataTypes::RegionType& region) const;
299 
308  virtual
309  void
310  setSlice(const DataAbstract* value,
311  const DataTypes::RegionType& region);
312 
325  void
326  setTaggedValue(int tagKey,
327  const DataTypes::ShapeType& pointshape,
328  const DataTypes::RealVectorType& value,
329  int dataOffset=0);
330 
331  void
332  setTaggedValue(int tagKey,
333  const DataTypes::ShapeType& pointshape,
334  const DataTypes::CplxVectorType& value,
335  int dataOffset=0);
336 
345  virtual void
346  symmetric(DataAbstract* ev);
347 
356  virtual void
358 
367  virtual void
368  hermitian(DataAbstract* ev);
369 
378  virtual void
380 
381 
382 
392  virtual void
393  trace(DataAbstract* ev, int axis_offset);
394 
403  virtual void
404  transpose(DataAbstract* ev, int axis_offset);
405 
415  virtual void
416  swapaxes(DataAbstract* ev, int axis0, int axis1);
417 
418 
427  virtual void
429 
442  virtual void
443  eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);
444 
452  virtual void
453  reorderByReferenceIDs(DataTypes::dim_t *reference_ids);
454 
456  void
457  complicate();
458  protected:
459 
460  private:
461 
477  void
478  initialise(int noSamples,
479  int noDataPointsPerSample,
480  bool cplx
481  );
482 
492  void
493  copy(const DataConstant& value);
494 
495 
496 
504  void
505  copy(const WrappedArray& value);
506 
507 
520  virtual void
521  copyToDataPoint(const int sampleNo, const int dataPointNo, const DataTypes::real_t value);
522 
524  virtual void
525  copyToDataPoint(const int sampleNo, const int dataPointNo, const DataTypes::cplx_t value);
526 
527 
537  virtual void
538  copyToDataPoint(const int sampleNo, const int dataPointNo, const WrappedArray& value);
539 
540  //
541  // The main data storage array, a 2D array of data blocks.
542  // noSamples * noDataPointsPerSample
545 };
546 
547 } // end of namespace
548 
549 #endif
virtual void swapaxes(DataAbstract *ev, int axis0, int axis1)
swaps components axis0 and axis1
Definition: DataExpanded.cpp:872
Definition: FunctionSpace.h:34
DataTypes::RealVectorType m_data_r
Definition: DataExpanded.h:543
virtual DataAbstract * deepCopy() const
Return a deep copy of the current object.
Definition: DataExpanded.cpp:250
virtual void symmetric(DataAbstract *ev)
Computes a symmetric matrix (A + AT) / 2.
Definition: DataExpanded.cpp:661
DataReady parent
Definition: DataExpanded.h:45
void setTaggedValue(int tagKey, const DataTypes::ShapeType &pointshape, const DataTypes::RealVectorType &value, int dataOffset=0)
setTaggedValue
Definition: DataExpanded.cpp:1107
DataTypes::CplxVectorType m_data_c
Definition: DataExpanded.h:544
virtual void setToZero()
sets all values to zero
Definition: DataExpanded.cpp:1019
virtual DataTypes::RealVectorType & getTypedVectorRW(DataTypes::real_t dummy)
These versions use the type system rather than method name to determine return type.
Definition: DataExpanded.cpp:1227
Definition: DataReady.h:35
DataTypes::vec_size_type size_type
Definition: DataVectorAlt.h:49
std::vector< std::pair< int, int > > RegionType
Definition: DataTypes.h:43
Definition: AbstractContinuousDomain.cpp:22
virtual void trace(DataAbstract *ev, int axis_offset)
Computes the trace of a matrix.
Definition: DataExpanded.cpp:795
virtual void dump(const std::string fileName) const
dumps the object into a netCDF file
Definition: DataExpanded.cpp:1038
virtual void antihermitian(DataAbstract *ev)
Computes an antihermitian matrix (A - A*) / 2.
Definition: DataExpanded.cpp:766
DataConstant stores a single data point which represents the entire function space.
Definition: DataConstant.h:37
DataExpanded(const WrappedArray &value, const FunctionSpace &what)
Constructor for DataExpanded.
Definition: DataExpanded.cpp:49
virtual void eigenvalues(DataAbstract *ev)
solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
Definition: DataExpanded.cpp:911
Give a short description of what DataExpanded does.
Definition: DataExpanded.h:43
virtual int matrixInverse(DataAbstract *out) const
invert square matricies
Definition: DataExpanded.cpp:981
void complicate()
Definition: DataExpanded.cpp:500
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:42
Simulates a full dataset accessible via sampleNo and dataPointNo.
Definition: DataTagged.h:44
bool actsExpanded() const
Return true if this Data is expanded or resolves to expanded. That is, if it has a separate value for...
Definition: DataExpanded.h:156
virtual void copyToDataPoint(const int sampleNo, const int dataPointNo, const DataTypes::real_t value)
Copy a double value to the data point dataPointNo of sample sampleNo in this object.
Definition: DataExpanded.cpp:572
const DataTypes::CplxVectorType & getVectorROC() const
Definition: DataExpanded.cpp:1222
virtual DataAbstract * getSlice(const DataTypes::RegionType &region) const
Factory method that returns a newly created DataExpanded. The caller is reponsible for managing the o...
Definition: DataExpanded.cpp:255
virtual void transpose(DataAbstract *ev, int axis_offset)
Transpose each data point of this Data object around the given axis.
Definition: DataExpanded.cpp:834
virtual std::string toString() const
Return a textual representation of the data.
Definition: DataExpanded.cpp:453
virtual void antisymmetric(DataAbstract *ev)
Computes a antisymmetric matrix (A - AT) / 2.
Definition: DataExpanded.cpp:699
const DataTypes::RealVectorType & getVectorRO() const
Definition: DataExpanded.cpp:1211
void copy(const DataConstant &value)
Copy the given data point value to all data points in this object.
Definition: DataExpanded.cpp:297
virtual DataTypes::RealVectorType::size_type getPointOffset(int sampleNo, int dataPointNo) const
Return the offset for the given given data point. This returns the offset in bytes for the given poin...
Definition: DataExpanded.cpp:481
bool hasNaN() const
Return true if any value in the data contains a NaN.
Definition: DataExpanded.cpp:370
virtual void hermitian(DataAbstract *ev)
Computes an hermitian matrix (A + A*) / 2.
Definition: DataExpanded.cpp:741
virtual void reorderByReferenceIDs(DataTypes::dim_t *reference_ids)
reorders data sample ordered by reference_ids to the ordering of the functions space ...
Definition: DataExpanded.cpp:1172
#define V(_K_, _I_)
Definition: ShapeFunctions.cpp:120
std::complex< real_t > cplx_t
complex data type
Definition: DataTypes.h:53
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:29
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataExpanded.cpp:1233
virtual void eigenvalues_and_eigenvectors(DataAbstract *ev, DataAbstract *V, const double tol=1.e-13)
solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V ...
Definition: DataExpanded.cpp:950
Definition: DataAbstract.h:61
DataTypes::RealVectorType & getVectorRW()
Return a a reference to the underlying DataVector.
Definition: DataExpanded.cpp:1205
virtual ~DataExpanded()
Default destructor for DataExpanded.
Definition: DataExpanded.cpp:246
Definition: WrappedArray.h:31
virtual void setSlice(const DataAbstract *value, const DataTypes::RegionType &region)
Copy the specified region from the given value.
Definition: DataExpanded.cpp:260
bool isExpanded() const
Definition: DataExpanded.h:149
void replaceNaN(DataTypes::real_t value)
replaces all NaN values with value
Definition: DataExpanded.cpp:406
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:50
index_t dim_t
Definition: DataTypes.h:64
DataTypes::CplxVectorType & getVectorRWC()
Definition: DataExpanded.cpp:1216
void initialise(int noSamples, int noDataPointsPerSample, bool cplx)
Common initialisation called from constructors.
Definition: DataExpanded.cpp:351
virtual DataTypes::RealVectorType::size_type getLength() const
Return the number of doubles stored for the Data.
Definition: DataExpanded.cpp:511