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
escript::DataTypes::maxRank
static const int maxRank
The maximum number of dimensions a datapoint can have.
Definition: DataTypes.h:68
escript::DataConstant::getLength
virtual DataTypes::RealVectorType::size_type getLength() const
Return the number of doubles stored for the Data object.
Definition: DataConstant.cpp:382
escript::DataConstant::hasInf
virtual bool hasInf() const
Return true if data contains Inf or -Inf.
Definition: DataConstant.cpp:235
MPI_Status
int MPI_Status
Definition: EsysMPI.h:43
ESCRIPT_DLL_API
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:28
escript::DataConstant::hermitian
virtual void hermitian(DataAbstract *ev)
Computes an hermitian matrix (A + A*) / 2.
Definition: DataConstant.cpp:467
escript::DataConstant::symmetric
virtual void symmetric(DataAbstract *ev)
Computes a symmetric matrix (A + AT) / 2.
Definition: DataConstant.cpp:433
escript::DataTypes::real_t
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:73
escript::DataConstant::swapaxes
virtual void swapaxes(DataAbstract *ev, int axis0, int axis1)
swaps components axis0 and axis1
Definition: DataConstant.cpp:514
escript::DataTypes::copySlice
void copySlice(VEC &left, const ShapeType &leftShape, typename VEC::size_type leftOffset, const VEC &other, const ShapeType &otherShape, typename VEC::size_type otherOffset, const RegionLoopRangeType &region)
Copy a data slice specified by the given region and offset from the "other" vector into the "left" ve...
Definition: DataVector.h:172
escript::DataConstant::getVectorRWC
DataTypes::CplxVectorType & getVectorRWC()
Definition: DataConstant.cpp:850
escript::DataConstant::transpose
virtual void transpose(DataAbstract *ev, int axis_offset)
Transpose each data point of this Data object around the given axis.
Definition: DataConstant.cpp:531
escript::DataConstant::getTypedVectorRO
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataConstant.cpp:870
escript::DataConstant::m_data_r
DataTypes::RealVectorType m_data_r
Definition: DataConstant.h:445
escript::DataConstant::getVectorRO
const DataTypes::RealVectorType & getVectorRO() const
Definition: DataConstant.cpp:844
escript::antihermitian
void antihermitian(const DataTypes::CplxVectorType &in, const DataTypes::ShapeType &inShape, typename DataTypes::CplxVectorType::size_type inOffset, DataTypes::CplxVectorType &ev, const DataTypes::ShapeType &evShape, typename DataTypes::CplxVectorType::size_type evOffset)
computes a antihermitian matrix from your square matrix A: (A - adjoint(A)) / 2
Definition: DataVectorOps.cpp:961
escript::DataConstant::parent
DataReady parent
Definition: DataConstant.h:61
CHECK_FOR_EX_WRITE
#define CHECK_FOR_EX_WRITE
Definition: DataConstant.cpp:50
escript::DataConstant::setToZero
virtual void setToZero()
sets all values to zero
Definition: DataConstant.cpp:598
escript::DataConstant::replaceInf
virtual void replaceInf(DataTypes::real_t value)
replaces all (+/-)Inf values with value
Definition: DataConstant.cpp:270
escript::DataTypes::checkShape
bool checkShape(const ShapeType &s1, const ShapeType &s2)
Test if two shapes are equal.
Definition: DataTypes.h:327
escript::DataConstant::getVectorRW
DataTypes::RealVectorType & getVectorRW()
Return a reference to the underlying DataVector.
Definition: DataConstant.cpp:837
escript::DataConstant
DataConstant stores a single data point which represents the entire function space.
Definition: DataConstant.h:48
escript::eigenvalues
void eigenvalues(const DataTypes::RealVectorType &in, const DataTypes::ShapeType &inShape, typename DataTypes::RealVectorType::size_type inOffset, DataTypes::RealVectorType &ev, const DataTypes::ShapeType &evShape, typename DataTypes::RealVectorType::size_type evOffset)
solves a local eigenvalue problem
Definition: DataVectorOps.h:637
escript::WrappedArray
Definition: WrappedArray.h:30
escript::DataTypes::DataVectorAlt::resize
void resize(const size_type newSize, const value_type newVal=0.0, const size_type newBlockSize=1)
Resize the DataVectorAlt to the given length "newSize". All current data is lost. All elements in the...
Definition: DataVectorAlt.h:313
escript::DataTypes::DataVectorAlt< cplx_t >::size_type
DataTypes::vec_size_type size_type
Definition: DataVectorAlt.h:84
escript::DataConstant::trace
virtual void trace(DataAbstract *ev, int axis_offset)
Computes the trace of a matrix.
Definition: DataConstant.cpp:496
escript::WrappedArray::isComplex
bool isComplex() const
Definition: WrappedArray.h:69
escript::symmetric
void symmetric(const VEC &in, const DataTypes::ShapeType &inShape, typename VEC::size_type inOffset, VEC &ev, const DataTypes::ShapeType &evShape, typename VEC::size_type evOffset)
computes a symmetric matrix from your square matrix A: (A + transpose(A)) / 2
Definition: DataVectorOps.h:101
escript::DataTypes::DataVectorAlt< real_t >
escript::transpose
void transpose(const VEC &in, const DataTypes::ShapeType &inShape, typename VEC::size_type inOffset, VEC &ev, const DataTypes::ShapeType &evShape, typename VEC::size_type evOffset, int axis_offset)
Transpose each data point of this Data object around the given axis.
Definition: DataVectorOps.h:341
escript::DataAbstract::getRank
unsigned int getRank() const
Return the rank information for the point data.
Definition: DataAbstract.h:663
escript::FunctionSpace
Definition: FunctionSpace.h:45
escript::DataTypes::getSliceRegionLoopRange
DataTypes::RegionLoopRangeType getSliceRegionLoopRange(const DataTypes::RegionType &region)
Modify region to copy from in order to deal with the case where one range in the region contains iden...
Definition: DataTypes.cpp:186
escript::DataConstant::hasNaN
bool hasNaN() const
Return true if the value contains a NaN.
Definition: DataConstant.cpp:151
escript::DataReady
Definition: DataReady.h:46
escript::DataConstant::getVectorROC
const DataTypes::CplxVectorType & getVectorROC() const
Definition: DataConstant.cpp:857
MPI_INT
#define MPI_INT
Definition: EsysMPI.h:44
escript::DataConstant::eigenvalues_and_eigenvectors
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:565
system_dep.h
escript::LapackInverseHelper
Definition: LapackInverseHelper.h:37
MPI_COMM_WORLD
#define MPI_COMM_WORLD
Definition: EsysMPI.h:46
escript::DataConstant::DataConstant
DataConstant(const WrappedArray &value, const FunctionSpace &what)
Constructor for DataConstant objects.
Definition: DataConstant.cpp:63
escript::DataException
Definition: DataException.h:37
escript::hermitian
void hermitian(const DataTypes::CplxVectorType &in, const DataTypes::ShapeType &inShape, DataTypes::CplxVectorType::size_type inOffset, DataTypes::CplxVectorType &ev, const DataTypes::ShapeType &evShape, DataTypes::CplxVectorType::size_type evOffset)
computes an hermitian matrix from your square matrix A: (A + adjoint(A)) / 2
Definition: DataVectorOps.cpp:914
escript::DataConstant::getTypedVectorRW
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:863
escript::DataTypes::ShapeType
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:65
escript::JMPI
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:70
escript::DataTypes::fillComplexFromReal
void fillComplexFromReal(const RealVectorType &r, CplxVectorType &c)
copy data from a real vector to a complex vector The complex vector will be resized as needed and any...
escript::DataTypes::copySliceFrom
void copySliceFrom(VEC &left, const ShapeType &leftShape, typename VEC::size_type leftOffset, const VEC &other, const ShapeType &otherShape, typename VEC::size_type otherOffset, const RegionLoopRangeType &region)
Copy data into a slice specified by the given region and offset in the left vector from the other vec...
Definition: DataVector.h:279
escript::DataConstant::deepCopy
virtual DataAbstract * deepCopy() const
Return a deep copy of the current object.
Definition: DataConstant.cpp:329
escript::DataTypes::RegionType
std::vector< std::pair< int, int > > RegionType
Definition: DataTypes.h:66
escript::DataTypes::noValues
int noValues(const ShapeType &shape)
Calculate the number of values in a datapoint with the given shape.
Definition: DataTypes.cpp:89
escript::DataAbstract::getShape
const DataTypes::ShapeType & getShape() const
Return the shape information for the point data.
Definition: DataAbstract.h:652
escript::DataTypes::getResultSliceShape
DataTypes::ShapeType getResultSliceShape(const RegionType &region)
Determine the shape of the specified slice region.
Definition: DataTypes.cpp:171
escript::DataTypes::DataVectorAlt::copyFromArray
void copyFromArray(const WrappedArray &value, size_type copies)
Populates the vector with the data from value. This method currently throws an exception if the speci...
Definition: DataVectorAlt.h:504
escript::DataConstant::isConstant
bool isConstant() const
Definition: DataConstant.h:130
escript::DataConstant::zeroedCopy
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:335
escript::matrix_inverse
int matrix_inverse(const DataTypes::RealVectorType &in, const DataTypes::ShapeType &inShape, DataTypes::RealVectorType::size_type inOffset, DataTypes::RealVectorType &out, const DataTypes::ShapeType &outShape, DataTypes::RealVectorType::size_type outOffset, int count, LapackInverseHelper &helper)
computes the inverses of square (up to 3x3) matricies
Definition: DataVectorOps.cpp:205
DataConstant.h
WrappedArray.h
escript::DataAbstract::m_iscompl
bool m_iscompl
Definition: DataAbstract.h:574
escript::DataConstant::m_data_c
DataTypes::CplxVectorType m_data_c
Definition: DataConstant.h:446
escript::DataConstant::toString
std::string toString() const
Write the data as a string.
Definition: DataConstant.cpp:320
escript::swapaxes
void swapaxes(const VEC &in, const DataTypes::ShapeType &inShape, typename VEC::size_type inOffset, VEC &ev, const DataTypes::ShapeType &evShape, typename VEC::size_type evOffset, int axis0, int axis1)
swaps the components axis0 and axis1.
Definition: DataVectorOps.h:486
escript::DataTypes::RegionLoopRangeType
std::vector< std::pair< int, int > > RegionLoopRangeType
Definition: DataTypes.h:67
escript::DataConstant::matrixInverse
virtual int matrixInverse(DataAbstract *out) const
invert square matricies
Definition: DataConstant.cpp:581
V
#define V(_K_, _I_)
Definition: ShapeFunctions.cpp:133
escript::DataConstant::getSlice
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:388
escript::DataConstant::dump
virtual void dump(const std::string fileName) const
dumps the object into a netCDF file
Definition: DataConstant.cpp:756
escript::DataConstant::complicate
void complicate()
Convert from real data to complex data.
Definition: DataConstant.cpp:888
escript
Definition: AbstractContinuousDomain.cpp:22
escript::DataTypes::DataVectorAlt::size
size_type size() const
Return the number of elements in this DataVectorAlt.
Definition: DataVectorAlt.h:237
escript::DataTypes::pointToString
std::string pointToString(const RealVectorType &data, const ShapeType &shape, int offset, const std::string &prefix)
Display a single value (with the specified shape) from the data.
escript::DataAbstract
Definition: DataAbstract.h:72
DataVectorOps.h
Describes binary operations performed on DataVector.
escript::DataConstant::setSlice
virtual void setSlice(const DataAbstract *value, const DataTypes::RegionType &region)
Copy the specified region from the given value.
Definition: DataConstant.cpp:394
escript::DataTypes::createShapeErrorMessage
std::string createShapeErrorMessage(const std::string &messagePrefix, const DataTypes::ShapeType &other, const DataTypes::ShapeType &thisShape)
Produce a string containing two shapes.
Definition: DataTypes.cpp:204
escript::FunctionSpace::getTypeCode
int getTypeCode() const
Returns the function space type code.
Definition: FunctionSpace.cpp:93
escript::DataConstant::eigenvalues
virtual void eigenvalues(DataAbstract *ev)
solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
Definition: DataConstant.cpp:548
escript::DataReady::DataReady
DataReady(const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false)
Definition: DataReady.cpp:33
escript::DataConstant::antisymmetric
virtual void antisymmetric(DataAbstract *ev)
Computes a nonsymmetric matrix (A - AT) / 2.
Definition: DataConstant.cpp:450
escript::DataConstant::antihermitian
virtual void antihermitian(DataAbstract *ev)
Computes an anti-hermitian matrix (A - A*) / 2.
Definition: DataConstant.cpp:481
escript::DataAbstract::isComplex
bool isComplex() const
true if the components of datapoints are complex
Definition: DataAbstract.cpp:68
escript::DataAbstract::getNoValues
unsigned int getNoValues() const
Return the number of values in the shape for this object.
Definition: DataAbstract.h:674
escript::DataConstant::replaceNaN
void replaceNaN(DataTypes::real_t value)
replaces all NaN values with value
Definition: DataConstant.cpp:186
Data.h
DataReady.h
escript::antisymmetric
void antisymmetric(const VEC &in, const DataTypes::ShapeType &inShape, typename VEC::size_type inOffset, VEC &ev, const DataTypes::ShapeType &evShape, typename VEC::size_type evOffset)
computes a antisymmetric matrix from your square matrix A: (A - transpose(A)) / 2
Definition: DataVectorOps.h:150
escript::DataConstant::getPointOffset
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:352
escript::DataAbstract::getFunctionSpace
const FunctionSpace & getFunctionSpace() const
Return the function space associated with this Data object.
Definition: DataAbstract.h:645
escript::DataTypes::cplx_t
std::complex< real_t > cplx_t
complex data type
Definition: DataTypes.h:76
escript::DataAbstract::ShapeType
DataTypes::ShapeType ShapeType
Definition: DataAbstract.h:77
escript::trace
void trace(const VEC &in, const DataTypes::ShapeType &inShape, typename VEC::size_type inOffset, VEC &ev, const DataTypes::ShapeType &evShape, typename VEC::size_type evOffset, int axis_offset)
computes the trace of a matrix
Definition: DataVectorOps.h:240
DataException.h
escript::eigenvalues_and_eigenvectors
void eigenvalues_and_eigenvectors(const DataTypes::RealVectorType &in, const DataTypes::ShapeType &inShape, DataTypes::RealVectorType::size_type inOffset, DataTypes::RealVectorType &ev, const DataTypes::ShapeType &evShape, DataTypes::RealVectorType::size_type evOffset, DataTypes::RealVectorType &V, const DataTypes::ShapeType &VShape, DataTypes::RealVectorType::size_type VOffset, const double tol=1.e-13)
solves a local eigenvalue problem
Definition: DataVectorOps.h:748