escript  Revision_
DataConstant.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2018 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_DataConstant_20040323_H
19 #define escript_DataConstant_20040323_H
20 #include "system_dep.h"
21 
22 #include "DataReady.h"
23 #include "WrappedArray.h"
24 
25 
26 namespace escript {
27 
37 class DataConstant : public DataReady {
38 typedef DataReady parent;
39  public:
40 
52  explicit DataConstant(const WrappedArray& value,
53  const FunctionSpace& what);
54 
55 
61  DataConstant(const DataConstant& other);
62 
63 
74  explicit DataConstant(const DataConstant& other,
75  const DataTypes::RegionType& region);
76 
88  explicit DataConstant(const FunctionSpace& what,
89  const DataTypes::ShapeType &shape,
90  const DataTypes::RealVectorType &data);
91 
92  explicit DataConstant(const FunctionSpace& what,
93  const DataTypes::ShapeType &shape,
94  const DataTypes::CplxVectorType &data);
95 
97  explicit DataConstant(const FunctionSpace& what,
98  const DataTypes::ShapeType &shape,
99  const DataTypes::real_t v);
100 
101  explicit DataConstant(const FunctionSpace& what,
102  const DataTypes::ShapeType &shape,
103  const DataTypes::cplx_t v);
104 
106  bool
107  isConstant() const
108  {
109  return true;
110  };
111 
116  bool
117  hasNaN() const;
118 
123  void
125 
127  void
129 
134  virtual bool
135  hasInf() const;
136 
141  virtual void
143 
148  virtual void
150 
151 
152 
158  std::string
159  toString() const;
160 
165  virtual
166  DataAbstract*
167  deepCopy() const;
168 
174  virtual
175  DataAbstract*
176  zeroedCopy() const;
177 
178 
184  virtual
185  void
186  dump(const std::string fileName) const;
187 
193  virtual
194  void
195  setToZero();
196 
207  virtual
209  getPointOffset(int sampleNo,
210  int dataPointNo) const;
211 
213  virtual
215  getPointOffset(int sampleNo,
216  int dataPointNo);
217 
223  virtual
225  getLength() const;
226 
235  virtual
236  DataAbstract*
237  getSlice(const DataTypes::RegionType& region) const;
238 
246  virtual
247  void
248  setSlice(const DataAbstract* value,
249  const DataTypes::RegionType& region);
250 
251 
260  virtual void
261  symmetric(DataAbstract* ev);
262 
271  virtual void
273 
282  virtual void
283  hermitian(DataAbstract* ev);
284 
293  virtual void
295 
305  virtual void
306  trace(DataAbstract* ev, int axis_offset);
307 
316  virtual void
317  transpose(DataAbstract* ev, int axis_offset);
318 
328  virtual void
329  swapaxes(DataAbstract* ev, int axis0, int axis1);
330 
331 
340  virtual void
342 
355  virtual void
356  eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);
357 
358 
365  virtual int
366  matrixInverse(DataAbstract* out) const;
367 
374  getVectorRW();
375 
376 
379  getVectorRO() const;
380 
383  getVectorRWC();
384 
385 
388  getVectorROC() const;
389 
390 
391 
395 
397  virtual const DataTypes::RealVectorType&
398  getTypedVectorRO(DataTypes::real_t dummy) const;
399 
403 
405  virtual const DataTypes::CplxVectorType&
406  getTypedVectorRO(DataTypes::cplx_t dummy) const;
407 
408 
409 
410 
415  void complicate();
416 
417  protected:
418 
419  private:
420  //
421  // the actual data
424 
425 };
426 
427 } // end of namespace
428 #endif
Definition: FunctionSpace.h:34
DataTypes::CplxVectorType & getVectorRWC()
Definition: DataConstant.cpp:851
DataTypes::RealVectorType m_data_r
Definition: DataConstant.h:422
virtual bool hasInf() const
Return true if data contains Inf or -Inf.
Definition: DataConstant.cpp:236
virtual void trace(DataAbstract *ev, int axis_offset)
Computes the trace of a matrix.
Definition: DataConstant.cpp:497
virtual void hermitian(DataAbstract *ev)
Computes an hermitian matrix (A + A*) / 2.
Definition: DataConstant.cpp:468
virtual void symmetric(DataAbstract *ev)
Computes a symmetric matrix (A + AT) / 2.
Definition: DataConstant.cpp:434
virtual void swapaxes(DataAbstract *ev, int axis0, int axis1)
swaps components axis0 and axis1
Definition: DataConstant.cpp:515
Definition: DataReady.h:35
DataTypes::vec_size_type size_type
Definition: DataVectorAlt.h:49
const DataTypes::RealVectorType & getVectorRO() const
Definition: DataConstant.cpp:845
std::vector< std::pair< int, int > > RegionType
Definition: DataTypes.h:43
Definition: AbstractContinuousDomain.cpp:22
const DataTypes::CplxVectorType & getVectorROC() const
Definition: DataConstant.cpp:858
virtual void setToZero()
sets all values to zero
Definition: DataConstant.cpp:599
virtual void replaceInf(DataTypes::real_t value)
replaces all (+/-)Inf values with value
Definition: DataConstant.cpp:271
DataConstant stores a single data point which represents the entire function space.
Definition: DataConstant.h:37
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataConstant.cpp:871
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:42
DataTypes::RealVectorType & getVectorRW()
Return a reference to the underlying DataVector.
Definition: DataConstant.cpp:838
DataConstant(const WrappedArray &value, const FunctionSpace &what)
Constructor for DataConstant objects.
Definition: DataConstant.cpp:64
bool hasNaN() const
Return true if the value contains a NaN.
Definition: DataConstant.cpp:152
virtual DataAbstract * zeroedCopy() const
Return an object with the same type, domain (and tags if appropriate) as this, but all values are zer...
Definition: DataConstant.cpp:336
bool isConstant() const
Definition: DataConstant.h:107
std::string toString() const
Write the data as a string.
Definition: DataConstant.cpp:321
DataTypes::CplxVectorType m_data_c
Definition: DataConstant.h:423
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: DataConstant.cpp:566
virtual DataTypes::RealVectorType & getTypedVectorRW(DataTypes::real_t dummy)
These versions use the type system rather than method name to determine return type.
Definition: DataConstant.cpp:864
virtual DataAbstract * deepCopy() const
Return a deep copy of the current object.
Definition: DataConstant.cpp:330
virtual void eigenvalues(DataAbstract *ev)
solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
Definition: DataConstant.cpp:549
virtual void dump(const std::string fileName) const
dumps the object into a netCDF file
Definition: DataConstant.cpp:757
virtual int matrixInverse(DataAbstract *out) const
invert square matricies
Definition: DataConstant.cpp:582
#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
Definition: DataAbstract.h:61
virtual DataAbstract * getSlice(const DataTypes::RegionType &region) const
Factory method that returns a newly created DataConstant object sliced from the specified region of t...
Definition: DataConstant.cpp:389
void complicate()
Convert from real data to complex data.
Definition: DataConstant.cpp:889
Definition: WrappedArray.h:31
virtual DataTypes::RealVectorType::size_type getPointOffset(int sampleNo, int dataPointNo) const
Return the offset for the given sample. This is a somewhat artificial notion but returns the offset i...
Definition: DataConstant.cpp:353
virtual void transpose(DataAbstract *ev, int axis_offset)
Transpose each data point of this Data object around the given axis.
Definition: DataConstant.cpp:532
virtual void setSlice(const DataAbstract *value, const DataTypes::RegionType &region)
Copy the specified region from the given value.
Definition: DataConstant.cpp:395
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:50
virtual DataTypes::RealVectorType::size_type getLength() const
Return the number of doubles stored for the Data object.
Definition: DataConstant.cpp:383
DataReady parent
Definition: DataConstant.h:38
virtual void antihermitian(DataAbstract *ev)
Computes an anti-hermitian matrix (A - A*) / 2.
Definition: DataConstant.cpp:482
virtual void antisymmetric(DataAbstract *ev)
Computes a nonsymmetric matrix (A - AT) / 2.
Definition: DataConstant.cpp:451
void replaceNaN(DataTypes::real_t value)
replaces all NaN values with value
Definition: DataConstant.cpp:187