escript  Revision_
DataEmpty.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2020 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-2017 by Centre for Geoscience Computing (GeoComp)
14 * Development from 2019 by School of Earth and Environmental Sciences
15 **
16 *****************************************************************************/
17 
18 #ifndef __ESCRIPT_DATAEMPTY_H__
19 #define __ESCRIPT_DATAEMPTY_H__
20 
21 #include "system_dep.h"
22 #include "DataReady.h"
23 
24 namespace escript {
25 
34 class DataEmpty : public DataReady {
35 typedef DataReady parent;
36  public:
37 
47  DataEmpty();
48 
54  virtual
55  ~DataEmpty();
56 
62  virtual
63  std::string
64  toString() const;
65 
70  virtual
72  deepCopy() const;
73 
79  virtual
81  zeroedCopy() const;
82 
83 
93  virtual
95  getPointOffset(int sampleNo,
96  int dataPointNo) const;
97 
99  virtual
101  getPointOffset(int sampleNo,
102  int dataPointNo);
103 
110  virtual
112  getLength() const;
113 
122  virtual
123  DataAbstract*
124  getSlice(const DataTypes::RegionType& region) const;
125 
136  virtual
137  void
138  setSlice(const DataAbstract* value,
139  const DataTypes::RegionType& region);
140 
147  int
148  matrixInverse(DataAbstract* out) const;
149 
150  void
151  dump(const std::string fileName) const;
152 
154  bool
155  hasNaN() const
156  {
157  return false;
158  }
159 
161  void
163  {
164 
165  }
166 
168  void
170  {
171 
172  }
173 
178  bool
179  hasInf() const
180  {
181  return false;
182  }
183 
188  void
190  {
191  }
192 
197  void
199  {
200  }
201 
202 
203  protected:
204 
210  getVectorRW();
211 
212 
214  virtual const DataTypes::RealVectorType&
215  getVectorRO() const;
216 
219  getVectorRWC();
220 
221 
223  virtual const DataTypes::CplxVectorType&
224  getVectorROC() const;
225 
228 
229  virtual const DataTypes::RealVectorType&
230  getTypedVectorRO(DataTypes::real_t dummy) const;
231 
234 
235  virtual const DataTypes::CplxVectorType&
236  getTypedVectorRO(DataTypes::cplx_t dummy) const;
237 
238 
239  private:
240 
241 // /**
242 /* \brief
243  Throw a standard exception. This function is called if an attempt
244  is made to use functions of DataEmpty that are not valid.*/
245 // */
246 // void
247 // throwStandardException(const std::string& functionName) const;
248 
249 };
250 
251 } // end of namespace
252 
253 #endif // __ESCRIPT_DATAEMPTY_H__
254 
ESCRIPT_DLL_API
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:30
escript::DataEmpty::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: DataEmpty.cpp:61
escript::DataTypes::real_t
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:51
escript::DataEmpty::dump
void dump(const std::string fileName) const
dumps the object into a netCDF file
Definition: DataEmpty.cpp:172
escript::DataEmpty::toString
virtual std::string toString() const
Return a textual representation of the Data object.
Definition: DataEmpty.cpp:48
escript::DataEmpty::getTypedVectorRO
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataEmpty.cpp:148
escript::DataTypes::DataVectorAlt::size_type
DataTypes::vec_size_type size_type
Definition: DataVectorAlt.h:50
escript::DataTypes::DataVectorAlt< real_t >
escript::DataEmpty::getVectorRO
virtual const DataTypes::RealVectorType & getVectorRO() const
Definition: DataEmpty.cpp:118
escript::DataEmpty::matrixInverse
int matrixInverse(DataAbstract *out) const
invert square matricies
Definition: DataEmpty.cpp:103
escript::FunctionSpace
Definition: FunctionSpace.h:36
escript::DataEmpty::parent
DataReady parent
Definition: DataEmpty.h:35
escript::DataEmpty::getSlice
virtual DataAbstract * getSlice(const DataTypes::RegionType &region) const
Factory method that returns a newly created DataEmpty sliced from the current Data object according t...
Definition: DataEmpty.cpp:89
escript::DataReady
Definition: DataReady.h:37
escript::DataEmpty::getVectorRW
virtual DataTypes::RealVectorType & getVectorRW()
Provide access to underlying storage. Internal use only!
Definition: DataEmpty.cpp:111
escript::DataException
Definition: DataException.h:28
escript::DataEmpty::replaceNaN
void replaceNaN(DataTypes::cplx_t value)
replaces all NaN values with value
Definition: DataEmpty.h:169
escript::DataEmpty::hasNaN
bool hasNaN() const
return true if data contains NaN.
Definition: DataEmpty.h:155
escript::DataEmpty::replaceInf
void replaceInf(DataTypes::cplx_t value)
replaces all (+/-)Inf values with value
Definition: DataEmpty.h:198
escript::DataEmpty
Implements the DataAbstract interface for an empty Data object.
Definition: DataEmpty.h:34
escript::DataTypes::RegionType
std::vector< std::pair< int, int > > RegionType
Definition: DataTypes.h:44
escript::DataEmpty::replaceNaN
void replaceNaN(DataTypes::real_t value)
replaces all NaN values with value
Definition: DataEmpty.h:162
escript::DataEmpty::replaceInf
void replaceInf(DataTypes::real_t value)
replaces all (+/-)Inf values with value
Definition: DataEmpty.h:189
escript::DataEmpty::getPointOffset
virtual DataTypes::RealVectorType::size_type getPointOffset(int sampleNo, int dataPointNo) const
Return the offset for the given sample. NB: This will throw an exception as obviously an empty Data o...
Definition: DataEmpty.cpp:67
escript::DataEmpty::getTypedVectorRW
virtual DataTypes::RealVectorType & getTypedVectorRW(DataTypes::real_t dummy)
These versions use the type system rather than method name to determine return type.
Definition: DataEmpty.cpp:141
escript::DataEmpty::deepCopy
virtual DataAbstract * deepCopy() const
Return a deep copy of the current object.
Definition: DataEmpty.cpp:55
escript
Definition: AbstractContinuousDomain.cpp:23
escript::DataAbstract
Definition: DataAbstract.h:63
escript::DataEmpty::getLength
virtual DataTypes::RealVectorType::size_type getLength() const
Return the number of doubles stored for the Data object. As this is an empty Data object,...
Definition: DataEmpty.cpp:83
escript::DataEmpty::setSlice
virtual void setSlice(const DataAbstract *value, const DataTypes::RegionType &region)
Set the current Data object according to the specified slice from the given input value....
Definition: DataEmpty.cpp:96
DataReady.h
escript::DataEmpty::getVectorROC
virtual const DataTypes::CplxVectorType & getVectorROC() const
Definition: DataEmpty.cpp:133
system_dep.h
escript::DataEmpty::hasInf
bool hasInf() const
Return true if data contains Inf or -Inf.
Definition: DataEmpty.h:179
escript::DataTypes::cplx_t
std::complex< real_t > cplx_t
complex data type
Definition: DataTypes.h:54
escript::DataEmpty::DataEmpty
DataEmpty()
Default constructor for DataEmpty.
Definition: DataEmpty.cpp:37
DataEmpty.h
escript::DataEmpty::getVectorRWC
virtual DataTypes::CplxVectorType & getVectorRWC()
Definition: DataEmpty.cpp:126
DataException.h
escript::DataTypes::scalarShape
static const ShapeType scalarShape
Use this instead of creating empty shape objects for scalars.
Definition: DataTypes.h:47
escript::DataEmpty::~DataEmpty
virtual ~DataEmpty()
Destructor for DataEmpty.
Definition: DataEmpty.cpp:43