escript  Revision_
DataEmpty.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 #ifndef __ESCRIPT_DATAEMPTY_H__
18 #define __ESCRIPT_DATAEMPTY_H__
19 
20 #include "system_dep.h"
21 #include "DataReady.h"
22 
23 namespace escript {
24 
33 class DataEmpty : public DataReady {
34 typedef DataReady parent;
35  public:
36 
46  DataEmpty();
47 
53  virtual
54  ~DataEmpty();
55 
61  virtual
62  std::string
63  toString() const;
64 
69  virtual
71  deepCopy() const;
72 
78  virtual
80  zeroedCopy() const;
81 
82 
92  virtual
94  getPointOffset(int sampleNo,
95  int dataPointNo) const;
96 
98  virtual
100  getPointOffset(int sampleNo,
101  int dataPointNo);
102 
109  virtual
111  getLength() const;
112 
121  virtual
122  DataAbstract*
123  getSlice(const DataTypes::RegionType& region) const;
124 
135  virtual
136  void
137  setSlice(const DataAbstract* value,
138  const DataTypes::RegionType& region);
139 
146  int
147  matrixInverse(DataAbstract* out) const;
148 
149  void
150  dump(const std::string fileName) const;
151 
153  bool
154  hasNaN() const
155  {
156  return false;
157  }
158 
160  void
162  {
163 
164  }
165 
167  void
169  {
170 
171  }
172 
177  bool
178  hasInf() const
179  {
180  return false;
181  }
182 
187  void
189  {
190  }
191 
196  void
198  {
199  }
200 
201 
202  protected:
203 
209  getVectorRW();
210 
211 
213  virtual const DataTypes::RealVectorType&
214  getVectorRO() const;
215 
218  getVectorRWC();
219 
220 
222  virtual const DataTypes::CplxVectorType&
223  getVectorROC() const;
224 
227 
228  virtual const DataTypes::RealVectorType&
229  getTypedVectorRO(DataTypes::real_t dummy) const;
230 
233 
234  virtual const DataTypes::CplxVectorType&
235  getTypedVectorRO(DataTypes::cplx_t dummy) const;
236 
237 
238  private:
239 
240 // /**
241 /* \brief
242  Throw a standard exception. This function is called if an attempt
243  is made to use functions of DataEmpty that are not valid.*/
244 // */
245 // void
246 // throwStandardException(const std::string& functionName) const;
247 
248 };
249 
250 } // end of namespace
251 
252 #endif // __ESCRIPT_DATAEMPTY_H__
253 
ESCRIPT_DLL_API
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:28
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:59
escript::DataTypes::real_t
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:73
escript::DataEmpty::dump
void dump(const std::string fileName) const
dumps the object into a netCDF file
Definition: DataEmpty.cpp:170
escript::DataEmpty::toString
virtual std::string toString() const
Return a textual representation of the Data object.
Definition: DataEmpty.cpp:46
escript::DataEmpty::getTypedVectorRO
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataEmpty.cpp:146
escript::DataTypes::DataVectorAlt< real_t >::size_type
DataTypes::vec_size_type size_type
Definition: DataVectorAlt.h:84
escript::DataTypes::DataVectorAlt< real_t >
escript::DataEmpty::getVectorRO
virtual const DataTypes::RealVectorType & getVectorRO() const
Definition: DataEmpty.cpp:116
escript::DataEmpty::matrixInverse
int matrixInverse(DataAbstract *out) const
invert square matricies
Definition: DataEmpty.cpp:101
escript::FunctionSpace
Definition: FunctionSpace.h:45
escript::DataEmpty::parent
DataReady parent
Definition: DataEmpty.h:57
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:87
escript::DataReady
Definition: DataReady.h:46
escript::DataEmpty::getVectorRW
virtual DataTypes::RealVectorType & getVectorRW()
Provide access to underlying storage. Internal use only!
Definition: DataEmpty.cpp:109
system_dep.h
escript::DataException
Definition: DataException.h:37
escript::DataAbstract::DataAbstract
DataAbstract(const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false, bool isCplx=false)
Constructor for DataAbstract.
Definition: DataAbstract.cpp:74
escript::DataEmpty::hasNaN
bool hasNaN() const
return true if data contains NaN.
Definition: DataEmpty.h:177
escript::DataTypes::RegionType
std::vector< std::pair< int, int > > RegionType
Definition: DataTypes.h:66
escript::DataEmpty::replaceNaN
void replaceNaN(DataTypes::real_t value)
replaces all NaN values with value
Definition: DataEmpty.h:184
escript::DataEmpty::replaceInf
void replaceInf(DataTypes::real_t value)
replaces all (+/-)Inf values with value
Definition: DataEmpty.h:211
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:65
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:139
escript::DataEmpty::deepCopy
virtual DataAbstract * deepCopy() const
Return a deep copy of the current object.
Definition: DataEmpty.cpp:53
escript
Definition: AbstractContinuousDomain.cpp:22
escript::DataAbstract
Definition: DataAbstract.h:72
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:81
escript::DataReady::DataReady
DataReady(const FunctionSpace &what, const ShapeType &shape, bool isDataEmpty=false)
Definition: DataReady.cpp:33
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:94
DataReady.h
escript::DataEmpty::getVectorROC
virtual const DataTypes::CplxVectorType & getVectorROC() const
Definition: DataEmpty.cpp:131
escript::DataEmpty::hasInf
bool hasInf() const
Return true if data contains Inf or -Inf.
Definition: DataEmpty.h:201
escript::DataTypes::cplx_t
std::complex< real_t > cplx_t
complex data type
Definition: DataTypes.h:76
escript::DataEmpty::DataEmpty
DataEmpty()
Default constructor for DataEmpty.
Definition: DataEmpty.cpp:35
DataEmpty.h
escript::DataEmpty::getVectorRWC
virtual DataTypes::CplxVectorType & getVectorRWC()
Definition: DataEmpty.cpp:124
DataException.h
escript::DataTypes::scalarShape
static const ShapeType scalarShape
Use this instead of creating empty shape objects for scalars.
Definition: DataTypes.h:69
escript::DataEmpty::~DataEmpty
virtual ~DataEmpty()
Destructor for DataEmpty.
Definition: DataEmpty.cpp:41