escript  Revision_
Data.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 
19 #ifndef __ESCRIPT_DATA_H__
20 #define __ESCRIPT_DATA_H__
21 
22 #include "system_dep.h"
23 #include "DataAbstract.h"
24 #include "DataException.h"
25 #include "DataTypes.h"
26 #include "EsysMPI.h"
27 #include "FunctionSpace.h"
28 #include "DataVectorOps.h"
29 #include <algorithm>
30 #include <string>
31 #include <sstream>
32 
33 #include <boost/python/object.hpp>
34 #include <boost/python/tuple.hpp>
35 #include <boost/math/special_functions/bessel.hpp>
36 
37 #ifndef ESCRIPT_MAX_DATA_RANK
38 #define ESCRIPT_MAX_DATA_RANK 4
39 #endif
40 
41 namespace escript {
42 
43 //
44 // Forward declaration for various implementations of Data.
45 class DataConstant;
46 class DataTagged;
47 class DataExpanded;
48 class DataLazy;
49 
63 class Data {
64 
65  public:
66 
76  Data();
77 
83  Data(const Data& inData);
84 
91  Data(const Data& inData,
92  const FunctionSpace& what);
93 
97  Data(const DataTypes::RealVectorType& value,
98  const DataTypes::ShapeType& shape,
99  const FunctionSpace& what,
100  bool expanded);
101 
113  Data(DataTypes::real_t value,
114  const DataTypes::ShapeType& dataPointShape,
115  const FunctionSpace& what,
116  bool expanded);
117 
129  explicit
130  Data(DataTypes::cplx_t value,
131  const DataTypes::ShapeType& dataPointShape,
132  const FunctionSpace& what,
133  bool expanded);
134 
142  Data(const Data& inData,
143  const DataTypes::RegionType& region);
144 
145 
156  Data(const WrappedArray& w, const FunctionSpace& what,
157  bool expanded);
158 
159 
169  Data(const boost::python::object& value,
170  const Data& other);
171 
192  Data(boost::python::object value,
193  boost::python::object par1=boost::python::object(),
194  boost::python::object par2=boost::python::object(),
195  boost::python::object par3=boost::python::object());
196 
197 
198 
199 
200 
205  explicit Data(DataAbstract* underlyingdata);
206 
210  explicit Data(DataAbstract_ptr underlyingdata);
211 
216  ~Data();
217 
221  void
222  copy(const Data& other);
223 
227  Data
228  copySelf() const;
229 
230 
234  Data
235  delay();
236 
240  void
241  delaySelf();
242 
243 
253  void
254  setProtection();
255 
261  bool
262  isProtected() const;
263 
264 
269  const boost::python::object
270  getValueOfDataPointAsTuple(int dataPointNo);
271 
276  void
277  setValueOfDataPointToPyObject(int dataPointNo, const boost::python::object& py_object);
278 
283  void
284  setValueOfDataPointToArray(int dataPointNo, const boost::python::object&);
285 
290  void
291  setValueOfDataPoint(int dataPointNo, const DataTypes::real_t);
292 
293  void
294  setValueOfDataPointC(int dataPointNo, const DataTypes::cplx_t);
295 
296 
300  const boost::python::object
301  getValueOfGlobalDataPointAsTuple(int procNo, int dataPointNo);
302 
303 
307  void
308  setTupleForGlobalDataPoint(int id, int proc, boost::python::object);
309 
315  int
316  getTagNumber(int dpno);
317 
318 
323  std::string
324  toString() const;
325 
330  void
331  expand();
332 
339  void
340  tag();
341 
346  void
347  resolve();
348 
354  bool
355  hasNaN();
356 
360  void
362 
366  void
368 
372  void
373  replaceNaNPython(boost::python::object obj);
374 
375 
376 
377 
385  void
386  requireWrite();
387 
393  bool
394  isExpanded() const;
395 
401  bool
402  actsExpanded() const;
403 
404 
409  bool
410  isTagged() const;
411 
416  bool
417  isConstant() const;
418 
422  bool
423  isLazy() const;
424 
428  bool
429  isReady() const;
430 
436  bool
437  isEmpty() const;
438 
443  bool
444  isComplex() const;
445 
450  inline
451  const FunctionSpace&
453  {
454  return m_data->getFunctionSpace();
455  }
456 
461  inline
462 // const AbstractDomain&
464  getDomain() const
465  {
466  return getFunctionSpace().getDomain();
467  }
468 
469 
475  inline
476 // const AbstractDomain&
477  Domain_ptr
479  {
481  }
482 
487  inline
488  unsigned int
490  {
491  return m_data->getRank();
492  }
493 
498  inline
499  int
501  {
503  }
508  inline
509  int
511  {
512  return m_data->getNumSamples();
513  }
514 
519  inline
520  int
522  {
523  return m_data->getNumDPPSample();
524  }
525 
531  inline
532  bool numSamplesEqual(int numDataPointsPerSample, int numSamples) const
533  {
534  return (isEmpty() ||
535  (numDataPointsPerSample==getNumDataPointsPerSample() && numSamples==getNumSamples()));
536  }
537 
543  inline
544  bool isDataPointShapeEqual(int rank, const int* dimensions) const
545  {
546  if (isEmpty())
547  return true;
548  const DataTypes::ShapeType givenShape(&dimensions[0],&dimensions[rank]);
549  return (getDataPointShape()==givenShape);
550  }
551 
556  int
557  getNoValues() const
558  {
559  return m_data->getNoValues();
560  }
561 
562 
567  void
568  dump(const std::string fileName) const;
569 
576  const boost::python::object
577  toListOfTuples(bool scalarastuple=true);
578 
579 
587  const DataTypes::real_t*
589 
590  const DataTypes::cplx_t*
592 
593 
603 
606 
607 
608 
615  const DataTypes::real_t*
616  getDataRO(DataTypes::real_t dummy=0) const;
617 
618  const DataTypes::cplx_t*
619  getDataRO(DataTypes::cplx_t dummy) const;
620 
621 
622 
629  inline
632  {
633  return m_data->getSampleDataByTag(tag, dummy);
634  }
635 
636  inline
639  {
640  return m_data->getSampleDataByTag(tag, dummy);
641  }
642 
643 
651  getDataPointRO(int sampleNo, int dataPointNo);
652 
660  getDataPointRW(int sampleNo, int dataPointNo);
661 
662 
663 
668  inline
670  getDataOffset(int sampleNo,
671  int dataPointNo)
672  {
673  return m_data->getPointOffset(sampleNo,dataPointNo);
674  }
675 
680  inline
681  const DataTypes::ShapeType&
683  {
684  return m_data->getShape();
685  }
686 
691  const boost::python::tuple
692  getShapeTuple() const;
693 
699  int
700  getDataPointSize() const;
701 
707  getLength() const;
708 
713  bool
714  hasNoSamples() const
715  {
716  return m_data->getNumSamples()==0;
717  }
718 
727  void
728  setTaggedValueByName(std::string name,
729  const boost::python::object& value);
730 
740  void
741  setTaggedValue(int tagKey,
742  const boost::python::object& value);
743 
754  void
755  setTaggedValueFromCPP(int tagKey,
756  const DataTypes::ShapeType& pointshape,
757  const DataTypes::RealVectorType& value,
758  int dataOffset=0);
759 
760 
761  void
762  setTaggedValueFromCPP(int tagKey,
763  const DataTypes::ShapeType& pointshape,
764  const DataTypes::CplxVectorType& value,
765  int dataOffset=0);
766 
771  void
772  copyWithMask(const Data& other,
773  const Data& mask);
774 
784  void
785  setToZero();
786 
793  Data
794  interpolate(const FunctionSpace& functionspace) const;
795 
796  Data
798  DataTypes::real_t undef, Data& B, DataTypes::real_t Bmin, DataTypes::real_t Bstep, Data& C,
799  DataTypes::real_t Cmin, DataTypes::real_t Cstep, bool check_boundaries);
800 
801  Data
803  DataTypes::real_t undef, Data& B, DataTypes::real_t Bmin, DataTypes::real_t Bstep,bool check_boundaries);
804 
805  Data
807  DataTypes::real_t undef,bool check_boundaries);
808 
809 
810  Data
811  interpolateFromTable3DP(boost::python::object table, DataTypes::real_t Amin, DataTypes::real_t Astep,
812  Data& B, DataTypes::real_t Bmin, DataTypes::real_t Bstep, Data& C, DataTypes::real_t Cmin, DataTypes::real_t Cstep, DataTypes::real_t undef,bool check_boundaries);
813 
814 
815  Data
816  interpolateFromTable2DP(boost::python::object table, DataTypes::real_t Amin, DataTypes::real_t Astep,
817  Data& B, DataTypes::real_t Bmin, DataTypes::real_t Bstep, DataTypes::real_t undef,bool check_boundaries);
818 
819  Data
820  interpolateFromTable1DP(boost::python::object table, DataTypes::real_t Amin, DataTypes::real_t Astep,
821  DataTypes::real_t undef,bool check_boundaries);
822 
823  Data
824  nonuniforminterp(boost::python::object in, boost::python::object out, bool check_boundaries);
825 
826  Data
827  nonuniformslope(boost::python::object in, boost::python::object out, bool check_boundaries);
828 
835  Data
836  gradOn(const FunctionSpace& functionspace) const;
837 
838  Data
839  grad() const;
840 
845  boost::python::object
846  integrateToTuple_const() const;
847 
848 
853  boost::python::object
855 
856 
857 
863  Data
864  oneOver() const;
870  Data
871  wherePositive() const;
872 
878  Data
879  whereNegative() const;
880 
886  Data
887  whereNonNegative() const;
888 
894  Data
895  whereNonPositive() const;
896 
902  Data
903  whereZero(DataTypes::real_t tol=0.0) const;
904 
910  Data
911  whereNonZero(DataTypes::real_t tol=0.0) const;
912 
925  Lsup();
926 
928  Lsup_const() const;
929 
930 
943  sup();
944 
946  sup_const() const;
947 
948 
961  inf();
962 
964  inf_const() const;
965 
966 
967 
973  Data
974  abs() const;
975 
981  Data
982  maxval() const;
983 
989  Data
990  minval() const;
991 
999  const boost::python::tuple
1000  minGlobalDataPoint() const;
1001 
1009  const boost::python::tuple
1010  maxGlobalDataPoint() const;
1011 
1012 
1013 
1020  Data
1021  sign() const;
1022 
1028  Data
1029  symmetric() const;
1030 
1036  Data
1037  antisymmetric() const;
1038 
1039 
1045  Data
1046  hermitian() const;
1047 
1053  Data
1054  antihermitian() const;
1055 
1061  Data
1062  trace(int axis_offset) const;
1063 
1069  Data
1070  transpose(int axis_offset) const;
1071 
1078  Data
1079  eigenvalues() const;
1080 
1090  const boost::python::tuple
1091  eigenvalues_and_eigenvectors(const DataTypes::real_t tol=1.e-12) const;
1092 
1098  Data
1099  swapaxes(const int axis0, const int axis1) const;
1100 
1106  Data
1107  erf() const;
1108 
1109 
1115  Data
1116  conjugate() const;
1117 
1118  Data
1119  real() const;
1120 
1121  Data
1122  imag() const;
1123 
1129  Data
1130  sin() const;
1131 
1137  Data
1138  cos() const;
1139 
1145  Data
1146  bessel(int order, DataTypes::real_t (*besselfunc) (int,DataTypes::real_t) );
1147 
1148 
1154  Data
1155  besselFirstKind(int order);
1156 
1162  Data
1163  besselSecondKind(int order);
1164 
1165 
1171  Data
1172  tan() const;
1173 
1179  Data
1180  asin() const;
1181 
1187  Data
1188  acos() const;
1189 
1195  Data
1196  atan() const;
1197 
1203  Data
1204  sinh() const;
1205 
1211  Data
1212  cosh() const;
1213 
1219  Data
1220  tanh() const;
1221 
1227  Data
1228  asinh() const;
1229 
1235  Data
1236  acosh() const;
1237 
1243  Data
1244  atanh() const;
1245 
1251  Data
1252  log10() const;
1253 
1259  Data
1260  log() const;
1261 
1267  Data
1268  exp() const;
1269 
1275  Data
1276  sqrt() const;
1277 
1283  Data
1284  neg() const;
1285 
1292  Data
1293  pos() const;
1294 
1302  Data
1303  powD(const Data& right) const;
1304 
1312  Data
1313  powO(const boost::python::object& right) const;
1314 
1323  Data
1324  rpowO(const boost::python::object& left) const;
1325 
1332  Data& operator+=(const Data& right);
1333  Data& operator+=(const boost::python::object& right);
1334 
1335  Data& operator=(const Data& other);
1336 
1343  Data& operator-=(const Data& right);
1344  Data& operator-=(const boost::python::object& right);
1345 
1352  Data& operator*=(const Data& right);
1353  Data& operator*=(const boost::python::object& right);
1354 
1361  Data& operator/=(const Data& right);
1362  Data& operator/=(const boost::python::object& right);
1363 
1368  Data truedivD(const Data& right);
1369 
1374  Data truedivO(const boost::python::object& right);
1375 
1380  Data rtruedivO(const boost::python::object& left);
1381 
1386  boost::python::object __add__(const boost::python::object& right);
1387 
1388 
1393  boost::python::object __sub__(const boost::python::object& right);
1394 
1399  boost::python::object __rsub__(const boost::python::object& right);
1400 
1405  boost::python::object __mul__(const boost::python::object& right);
1406 
1411  boost::python::object __div__(const boost::python::object& right);
1412 
1417  boost::python::object __rdiv__(const boost::python::object& right);
1418 
1422  Data
1423  matrixInverse() const;
1424 
1429  bool
1430  probeInterpolation(const FunctionSpace& functionspace) const;
1431 
1447  Data
1448  getItem(const boost::python::object& key) const;
1449 
1461  void
1462  setItemD(const boost::python::object& key,
1463  const Data& value);
1464 
1465  void
1466  setItemO(const boost::python::object& key,
1467  const boost::python::object& value);
1468 
1469  // These following public methods should be treated as private.
1470 
1476  template <class UnaryFunction>
1477  inline
1478  void
1479  unaryOp2(UnaryFunction operation);
1480 
1488  Data
1489  getSlice(const DataTypes::RegionType& region) const;
1490 
1499  void
1500  setSlice(const Data& value,
1501  const DataTypes::RegionType& region);
1502 
1507  void
1508  print(void);
1509 
1516  int
1517  get_MPIRank(void) const;
1518 
1525  int
1526  get_MPISize(void) const;
1527 
1533  MPI_Comm
1534  get_MPIComm(void) const;
1535 
1541  DataAbstract*
1542  borrowData(void) const;
1543 
1545  borrowDataPtr(void) const;
1546 
1548  borrowReadyPtr(void) const;
1549 
1550 
1551 
1561 
1564 
1567 
1570 
1571 
1583 
1586 
1587 
1592  size_t
1593  getNumberOfTaggedValues() const;
1594 
1595  /*
1596  * \brief make the data complex
1597  */
1598  void complicate();
1599 
1600  protected:
1601 
1602  private:
1603  void init_from_data_and_fs(const Data& inData,
1604  const FunctionSpace& functionspace);
1605 
1606 
1607 
1608 template <class BinaryOp>
1610 #ifdef ESYS_MPI
1611  lazyAlgWorker(DataTypes::real_t init, MPI_Op mpiop_type);
1612 #else
1614 #endif
1615 
1617  LsupWorker() const;
1618 
1620  supWorker() const;
1621 
1623  infWorker() const;
1624 
1625  boost::python::object
1626  integrateWorker() const;
1627 
1628  void
1629  calc_minGlobalDataPoint(int& ProcNo, int& DataPointNo) const;
1630 
1631  void
1632  calc_maxGlobalDataPoint(int& ProcNo, int& DataPointNo) const;
1633 
1634  // For internal use in Data.cpp only!
1635  // other uses should call the main entry points and allow laziness
1636  Data
1637  minval_nonlazy() const;
1638 
1639  // For internal use in Data.cpp only!
1640  Data
1641  maxval_nonlazy() const;
1642 
1643 
1650  inline
1651  void
1652  operandCheck(const Data& right) const
1653  {
1654  return m_data->operandCheck(*(right.m_data.get()));
1655  }
1656 
1662  template <class BinaryFunction>
1663  inline
1665  reduction(BinaryFunction operation,
1666  DataTypes::real_t initial_value) const;
1667 
1675  template <class BinaryFunction>
1676  inline
1677  Data
1678  dp_algorithm(BinaryFunction operation,
1679  DataTypes::real_t initial_value) const;
1680 
1686  void
1687  typeMatchLeft(Data& right) const;
1688 
1694  void
1695  typeMatchRight(const Data& right);
1696 
1702  void
1704  const DataTypes::ShapeType& shape,
1705  const FunctionSpace& what,
1706  bool expanded);
1707 
1708  void
1710  const DataTypes::ShapeType& shape,
1711  const FunctionSpace& what,
1712  bool expanded);
1713 
1714  void
1715  initialise(const WrappedArray& value,
1716  const FunctionSpace& what,
1717  bool expanded);
1718 
1719  void
1720  initialise(const DataTypes::real_t value,
1721  const DataTypes::ShapeType& shape,
1722  const FunctionSpace& what,
1723  bool expanded);
1724 
1725  void
1726  initialise(const DataTypes::cplx_t value,
1727  const DataTypes::ShapeType& shape,
1728  const FunctionSpace& what,
1729  bool expanded);
1730  //
1731  // flag to protect the data object against any update
1733  bool m_lazy;
1734 
1735  //
1736  // pointer to the actual data object
1737 // boost::shared_ptr<DataAbstract> m_data;
1739 
1740 // If possible please use getReadyPtr instead.
1741 // But see warning below.
1742  const DataReady*
1743  getReady() const
1744 {
1745  const DataReady* dr=dynamic_cast<const DataReady*>(m_data.get());
1746  ESYS_ASSERT(dr!=0, "error casting to DataReady.");
1747  return dr;
1748 }
1749 
1750  DataReady*
1752 {
1753  DataReady* dr=dynamic_cast<DataReady*>(m_data.get());
1754  ESYS_ASSERT(dr!=0, "error casting to DataReady.");
1755  return dr;
1756 }
1757 
1758 
1759 // Be wary of using this for local operations since it (temporarily) increases reference count.
1760 // If you are just using this to call a method on DataReady instead of DataAbstract consider using
1761 // getReady() instead
1764 {
1765  DataReady_ptr dr=REFCOUNTNS::dynamic_pointer_cast<DataReady>(m_data);
1766  ESYS_ASSERT(dr.get()!=0, "error casting to DataReady.");
1767  return dr;
1768 }
1769 
1771  getReadyPtr() const
1772 {
1773  const_DataReady_ptr dr=REFCOUNTNS::dynamic_pointer_cast<const DataReady>(m_data);
1774  ESYS_ASSERT(dr.get()!=0, "error casting to DataReady.");
1775  return dr;
1776 }
1777 
1778  // In the isShared() method below:
1779  // A problem would occur if m_data (the address pointed to) were being modified
1780  // while the call m_data->is_shared is being executed.
1781  //
1782  // Q: So why do I think this code can be thread safe/correct?
1783  // A: We need to make some assumptions.
1784  // 1. We assume it is acceptable to return true under some conditions when we aren't shared.
1785  // 2. We assume that no constructions or assignments which will share previously unshared
1786  // will occur while this call is executing. This is consistent with the way Data:: and C are written.
1787  //
1788  // This means that the only transition we need to consider, is when a previously shared object is
1789  // not shared anymore. ie. the other objects have been destroyed or a deep copy has been made.
1790  // In those cases the m_shared flag changes to false after m_data has completed changing.
1791  // For any threads executing before the flag switches they will assume the object is still shared.
1792  bool isShared() const
1793  {
1794 #ifdef SLOWSHARECHECK
1795  return m_data->isShared(); // single threadsafe check for this
1796 #else
1797  return !m_data.unique();
1798 #endif
1799  }
1800 
1802  {
1803  if (isLazy())
1804  {
1805  #ifdef _OPENMP
1806  if (omp_in_parallel())
1807  { // Yes this is throwing an exception out of an omp thread which is forbidden.
1808  throw DataException("Please do not call forceResolve() in a parallel region.");
1809  }
1810  #endif
1811  resolve();
1812  }
1813  }
1814 
1820  {
1821 #ifdef _OPENMP
1822  if (omp_in_parallel())
1823  {
1824  throw DataException("Programming error. Please do not run exclusiveWrite() in multi-threaded sections.");
1825  }
1826 #endif
1827  forceResolve();
1828  if (isShared())
1829  {
1830  DataAbstract* t=m_data->deepCopy();
1832  }
1833 #ifdef EXWRITECHK
1834  m_data->exclusivewritecalled=true;
1835 #endif
1836  }
1837 
1842  {
1843  if (isLazy() || isShared())
1844  {
1845  std::ostringstream oss;
1846  oss << "Programming error. ExclusiveWrite required - please call requireWrite() isLazy=" << isLazy() << " isShared()=" << isShared();
1847  throw DataException(oss.str());
1848  }
1849  }
1850 
1857  void set_m_data(DataAbstract_ptr p);
1858 
1859 
1860  void TensorSelfUpdateBinaryOperation(const Data& right, escript::ES_optype operation);
1861 
1862  friend class DataAbstract; // To allow calls to updateShareStatus
1863  friend class TestDomain; // so its getX will work quickly
1864 #ifdef IKNOWWHATIMDOING
1865  friend Data applyBinaryCFunction(boost::python::object cfunc, boost::python::tuple shape, escript::Data& d, escript::Data& e);
1866 #endif
1867  friend Data condEval(escript::Data& mask, escript::Data& trueval, escript::Data& falseval);
1868  friend Data randomData(const boost::python::tuple& shape, const FunctionSpace& what, long seed, const boost::python::tuple& filter);
1869 
1870 };
1871 
1872 
1873 #ifdef IKNOWWHATIMDOING
1874 Data
1875 applyBinaryCFunction(boost::python::object func, boost::python::tuple shape, escript::Data& d, escript::Data& e);
1876 #endif
1877 
1878 Data
1879 condEval(escript::Data& mask, escript::Data& trueval, escript::Data& falseval);
1880 
1881 
1882 
1886 Data randomData(const boost::python::tuple& shape,
1887  const FunctionSpace& what,
1888  long seed, const boost::python::tuple& filter);
1889 
1890 
1891 } // end namespace escript
1892 
1893 
1894 // No, this is not supposed to be at the top of the file
1895 // DataAbstact needs to be declared first, then DataReady needs to be fully declared
1896 // so that I can dynamic cast between them below.
1897 #include "DataReady.h"
1898 #include "DataLazy.h"
1899 #include "DataExpanded.h"
1900 #include "DataConstant.h"
1901 #include "DataTagged.h"
1902 
1903 namespace escript
1904 {
1905 
1906 
1907 
1908 inline
1911 {
1912  if (isLazy())
1913  {
1914  throw DataException("Error, attempt to acquire RW access to lazy data. Please call requireWrite() first.");
1915  }
1916 #ifdef EXWRITECHK
1917  if (!getReady()->exclusivewritecalled)
1918  {
1919  throw DataException("Error, call to Data::getSampleDataRW without a preceeding call to requireWrite/exclusiveWrite.");
1920  }
1921 #endif
1922  return getReady()->getSampleDataRW(sampleNo, dummy);
1923 }
1924 
1925 inline
1928 {
1929  if (isLazy())
1930  {
1931  throw DataException("Error, attempt to acquire RW access to lazy data. Please call requireWrite() first.");
1932  }
1933 #ifdef EXWRITECHK
1934  if (!getReady()->exclusivewritecalled)
1935  {
1936  throw DataException("Error, call to Data::getSampleDataRW without a preceeding call to requireWrite/exclusiveWrite.");
1937  }
1938 #endif
1939  return getReady()->getSampleDataRW(sampleNo, dummy);
1940 }
1941 
1942 
1943 inline
1944 const DataTypes::real_t*
1946 {
1947  DataLazy* l=dynamic_cast<DataLazy*>(m_data.get());
1948  if (l!=0)
1949  {
1950  size_t offset=0;
1951  const DataTypes::RealVectorType* res=l->resolveSample(sampleNo,offset);
1952  return &((*res)[offset]);
1953  }
1954  return getReady()->getSampleDataRO(sampleNo, dummy);
1955 }
1956 
1957 inline
1958 const DataTypes::cplx_t*
1960 {
1961  DataLazy* l=dynamic_cast<DataLazy*>(m_data.get());
1962  if (l!=0)
1963  {
1964  throw DataException("Programming error: complex lazy objects are not supported.");
1965  }
1966  return getReady()->getSampleDataRO(sampleNo, dummy);
1967 }
1968 
1969 
1970 inline
1971 const DataTypes::real_t*
1973 {
1974  if (isLazy())
1975  {
1976  throw DataException("Programmer error - getDataRO must not be called on Lazy Data.");
1977  }
1978  if (getNumSamples()==0)
1979  {
1980  return 0;
1981  }
1982  else
1983  {
1984  return &(getReady()->getTypedVectorRO(0)[0]);
1985  }
1986 }
1987 
1988 inline
1989 const DataTypes::cplx_t*
1991 {
1992  if (isLazy())
1993  {
1994  throw DataException("Programmer error - getDataRO must not be called on Lazy Data.");
1995  }
1996  if (getNumSamples()==0)
1997  {
1998  return 0;
1999  }
2000  else
2001  {
2002  return &(getReady()->getTypedVectorRO(dummy)[0]);
2003  }
2004 }
2005 
2006 
2011 {
2012  return pow(y,x);
2013 }
2014 
2020 Data operator+(const Data& left, const Data& right);
2021 
2027 Data operator-(const Data& left, const Data& right);
2028 
2034 Data operator*(const Data& left, const Data& right);
2035 
2041 Data operator/(const Data& left, const Data& right);
2042 
2049 Data operator+(const Data& left, const boost::python::object& right);
2050 
2057 Data operator-(const Data& left, const boost::python::object& right);
2058 
2065 Data operator*(const Data& left, const boost::python::object& right);
2066 
2073 Data operator/(const Data& left, const boost::python::object& right);
2074 
2081 Data operator+(const boost::python::object& left, const Data& right);
2082 
2089 Data operator-(const boost::python::object& left, const Data& right);
2090 
2097 Data operator*(const boost::python::object& left, const Data& right);
2098 
2105 Data operator/(const boost::python::object& left, const Data& right);
2106 
2107 
2108 
2113 std::ostream& operator<<(std::ostream& o, const Data& data);
2114 
2123 Data
2125  Data& arg_1,
2126  int axis_offset=0,
2127  int transpose=0);
2128 
2134 inline
2135 Data
2136 Data::truedivD(const Data& right)
2137 {
2138  return *this / right;
2139 }
2140 
2146 inline
2147 Data
2148 Data::truedivO(const boost::python::object& right)
2149 {
2150  Data tmp(right, getFunctionSpace(), false);
2151  return truedivD(tmp);
2152 }
2153 
2159 inline
2160 Data
2161 Data::rtruedivO(const boost::python::object& left)
2162 {
2163  Data tmp(left, getFunctionSpace(), false);
2164  return tmp.truedivD(*this);
2165 }
2166 
2167 
2168 
2176 template <class BinaryFunction>
2177 inline
2179 Data::reduction(BinaryFunction operation, DataTypes::real_t initial_value) const
2180 {
2181  if (isExpanded()) {
2182  DataExpanded* leftC=dynamic_cast<DataExpanded*>(m_data.get());
2183  ESYS_ASSERT(leftC!=0, "Programming error - casting to DataExpanded.");
2184 
2185  DataExpanded& data=*leftC;
2186  int i,j;
2187  int numDPPSample=data.getNumDPPSample();
2188  int numSamples=data.getNumSamples();
2189  DataTypes::real_t global_current_value=initial_value;
2190  DataTypes::real_t local_current_value;
2191  const auto& vec=data.getTypedVectorRO(typename BinaryFunction::first_argument_type(0));
2192  const DataTypes::ShapeType& shape=data.getShape();
2193  // calculate the reduction operation value for each data point
2194  // reducing the result for each data-point into the current_value variables
2195  #pragma omp parallel private(local_current_value)
2196  {
2197  local_current_value=initial_value;
2198  #pragma omp for private(i,j) schedule(static)
2199  for (i=0;i<numSamples;i++) {
2200  for (j=0;j<numDPPSample;j++) {
2201  local_current_value=operation(local_current_value,escript::reductionOpVector(vec,shape,data.getPointOffset(i,j),operation,initial_value));
2202 
2203  }
2204  }
2205  #pragma omp critical
2206  global_current_value=operation(global_current_value,local_current_value);
2207  }
2208  return global_current_value;
2209  } else if (isTagged()) {
2210  DataTagged* leftC=dynamic_cast<DataTagged*>(m_data.get());
2211  ESYS_ASSERT(leftC!=0, "Programming error - casting to DataTagged.");
2212 
2213  DataTagged& data=*leftC;
2214  DataTypes::real_t current_value=initial_value;
2215 
2216  const auto& vec=data.getTypedVectorRO(typename BinaryFunction::first_argument_type(0));
2217  const DataTypes::ShapeType& shape=data.getShape();
2218  const DataTagged::DataMapType& lookup=data.getTagLookup();
2219  const std::list<int> used=data.getFunctionSpace().getListOfTagsSTL();
2220  for (std::list<int>::const_iterator i=used.begin();i!=used.end();++i)
2221  {
2222  int tag=*i;
2223  if (tag==0) // check for the default tag
2224  {
2225  current_value=operation(current_value,escript::reductionOpVector(vec,shape,data.getDefaultOffset(),operation,initial_value));
2226  }
2227  else
2228  {
2229  DataTagged::DataMapType::const_iterator it=lookup.find(tag);
2230  if (it!=lookup.end())
2231  {
2232  current_value=operation(current_value,escript::reductionOpVector(vec,shape,it->second,operation,initial_value));
2233  }
2234  }
2235  }
2236  return current_value;
2237  } else if (isConstant()) {
2238  DataConstant* leftC=dynamic_cast<DataConstant*>(m_data.get());
2239  ESYS_ASSERT(leftC!=0, "Programming error - casting to DataConstant.");
2240  return escript::reductionOpVector(leftC->getTypedVectorRO(typename BinaryFunction::first_argument_type(0)),leftC->getShape(),0,operation,initial_value);
2241  } else if (isEmpty()) {
2242  throw DataException("Error - Operations (algorithm) not permitted on instances of DataEmpty.");
2243  } else if (isLazy()) {
2244  throw DataException("Error - Operations not permitted on instances of DataLazy.");
2245  } else {
2246  throw DataException("Error - Data encapsulates an unknown type.");
2247  }
2248 }
2249 
2258 template <class BinaryFunction>
2259 inline
2260 Data
2261 Data::dp_algorithm(BinaryFunction operation, DataTypes::real_t initial_value) const
2262 {
2263  if (isEmpty()) {
2264  throw DataException("Error - Operations (dp_algorithm) not permitted on instances of DataEmpty.");
2265  }
2266  else if (isExpanded()) {
2268  DataExpanded* dataE=dynamic_cast<DataExpanded*>(m_data.get());
2269  DataExpanded* resultE=dynamic_cast<DataExpanded*>(result.m_data.get());
2270  ESYS_ASSERT(dataE!=0, "Programming error - casting data to DataExpanded.");
2271  ESYS_ASSERT(resultE!=0, "Programming error - casting result to DataExpanded.");
2272 
2273 
2274 
2275  int i,j;
2276  int numSamples=dataE->getNumSamples();
2277  int numDPPSample=dataE->getNumDPPSample();
2278  // DataArrayView dataView=data.getPointDataView();
2279  // DataArrayView resultView=result.getPointDataView();
2280  const auto& dataVec=dataE->getTypedVectorRO(initial_value);
2281  const DataTypes::ShapeType& shape=dataE->getShape();
2282  auto& resultVec=resultE->getTypedVectorRW(initial_value);
2283  // perform the operation on each data-point and assign
2284  // this to the corresponding element in result
2285  #pragma omp parallel for private(i,j) schedule(static)
2286  for (i=0;i<numSamples;i++) {
2287  for (j=0;j<numDPPSample;j++) {
2288  resultVec[resultE->getPointOffset(i,j)] =
2289  escript::reductionOpVector(dataVec, shape, dataE->getPointOffset(i,j),operation,initial_value);
2290 
2291  }
2292  }
2293  //escript::dp_algorithm(*dataE,*resultE,operation,initial_value);
2294  return result;
2295  }
2296  else if (isTagged()) {
2297  DataTagged* dataT=dynamic_cast<DataTagged*>(m_data.get());
2298  ESYS_ASSERT(dataT!=0, "Programming error - casting data to DataTagged.");
2299  DataTypes::RealVectorType defval(1);
2300  defval[0]=0;
2301  DataTagged* resultT=new DataTagged(getFunctionSpace(), DataTypes::scalarShape, defval, dataT);
2302 
2303 
2304  const DataTypes::ShapeType& shape=dataT->getShape();
2305  const auto& vec=dataT->getTypedVectorRO(initial_value);
2306  const DataTagged::DataMapType& lookup=dataT->getTagLookup();
2307  for (DataTagged::DataMapType::const_iterator i=lookup.begin(); i!=lookup.end(); i++) {
2308  resultT->getDataByTagRW(i->first,0) =
2309  escript::reductionOpVector(vec,shape,dataT->getOffsetForTag(i->first),operation,initial_value);
2310  }
2311  resultT->getTypedVectorRW(initial_value)[resultT->getDefaultOffset()] = escript::reductionOpVector(dataT->getTypedVectorRO(initial_value),dataT->getShape(),dataT->getDefaultOffset(),operation,initial_value);
2312 
2313 
2314 
2315 
2316  //escript::dp_algorithm(*dataT,*resultT,operation,initial_value);
2317  return Data(resultT); // note: the Data object now owns the resultT pointer
2318  }
2319  else if (isConstant()) {
2321  DataConstant* dataC=dynamic_cast<DataConstant*>(m_data.get());
2322  DataConstant* resultC=dynamic_cast<DataConstant*>(result.m_data.get());
2323  ESYS_ASSERT(dataC!=0, "Programming error - casting data to DataConstant.");
2324  ESYS_ASSERT(resultC!=0, "Programming error - casting result to DataConstant.");
2325 
2326  DataConstant& data=*dataC;
2327  resultC->getTypedVectorRW(initial_value)[0] =
2328  escript::reductionOpVector(data.getTypedVectorRO(initial_value),data.getShape(),0,operation,initial_value);
2329 
2330  //escript::dp_algorithm(*dataC,*resultC,operation,initial_value);
2331  return result;
2332  } else if (isLazy()) {
2333  throw DataException("Error - Operations not permitted on instances of DataLazy.");
2334  } else {
2335  throw DataException("Error - Data encapsulates an unknown type.");
2336  }
2337 }
2338 
2339 
2347 Data
2348 C_TensorBinaryOperation(Data const &arg_0,
2349  Data const &arg_1,
2350  ES_optype operation);
2351 
2352 
2353 Data
2354 C_TensorUnaryOperation(Data const &arg_0,
2355  escript::ES_optype operation,
2356  DataTypes::real_t tol=0);
2357 
2358 } // namespace escript
2359 
2360 #endif // __ESCRIPT_DATA_H__
2361 
Definition: FunctionSpace.h:34
std::ostream & operator<<(std::ostream &o, const Data &data)
Output operator.
Definition: Data.cpp:3427
void typeMatchLeft(Data &right) const
Convert the data type of the RHS to match this.
Definition: Data.cpp:3273
DataAbstract_ptr m_data
Definition: Data.h:1738
DataTypes::RealVectorType::size_type getLength() const
Return the number of doubles stored for this Data.
Definition: Data.cpp:1241
const boost::python::object toListOfTuples(bool scalarastuple=true)
returns the values of the object as a list of tuples (one for each datapoint).
Definition: Data.cpp:1252
DataTypes::real_t * getSampleDataByTag(int tag, DataTypes::real_t dummy=0)
Return the sample data for the given tag. If an attempt is made to access data that isn&#39;t tagged an e...
Definition: Data.h:631
Data sqrt() const
Return the square root of each data point of this Data object.
Definition: Data.cpp:1999
void setItemO(const boost::python::object &key, const boost::python::object &value)
Definition: Data.cpp:3234
Data antihermitian() const
Return the anti-hermitian part of a matrix which is half the matrix minus its hermitian.
Definition: Data.cpp:2564
Data interpolateFromTable1D(const WrappedArray &table, DataTypes::real_t Amin, DataTypes::real_t Astep, DataTypes::real_t undef, bool check_boundaries)
Definition: Data.cpp:4505
boost::python::object __add__(const boost::python::object &right)
wrapper for python add operation
Definition: Data.cpp:5615
const_DataReady_ptr getReadyPtr() const
Definition: Data.h:1771
void checkExclusiveWrite()
checks if caller can have exclusive write to the object
Definition: Data.h:1841
boost::python::object __rsub__(const boost::python::object &right)
wrapper for python reverse subtract operation
Definition: Data.cpp:5663
std::string toString() const
Write the data as a string. For large amounts of data, a summary is printed.
Definition: Data.cpp:4384
void setToZero()
set all values to zero
Definition: Data.cpp:742
DataTypes::real_t rpow(DataTypes::real_t x, DataTypes::real_t y)
Definition: Data.h:2010
ElementType & reference
Definition: DataVectorAlt.h:50
DataTypes::real_t inf()
Return the minimum value of this Data object.
Definition: Data.cpp:2104
void replaceNaN(DataTypes::real_t value)
replaces all NaN values with value
Definition: Data.cpp:2201
unsigned int getDataPointRank() const
Return the rank of the point data.
Definition: Data.h:489
int MPI_Op
Definition: EsysMPI.h:43
Data delay()
produce a delayed evaluation version of this Data.
Definition: Data.cpp:713
Data & operator*=(const Data &right)
Overloaded operator *=.
Definition: Data.cpp:2981
void tag()
If possible convert this Data to DataTagged. This will only allow Constant data to be converted to ta...
Definition: Data.cpp:1087
bool isDataPointShapeEqual(int rank, const int *dimensions) const
Returns true if the shape matches the vector (dimensions[0],..., dimensions[rank-1]). DataEmpty always returns true.
Definition: Data.h:544
void set_m_data(DataAbstract_ptr p)
Modify the data abstract hosted by this Data object For internal use only. Passing a pointer to null ...
Definition: Data.cpp:557
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
boost::python::object integrateToTuple()
Calculate the integral over the function space domain as a python tuple.
Definition: Data.cpp:1637
Data getSlice(const DataTypes::RegionType &region) const
Return a Data object containing the specified slice of this Data object.
Definition: Data.cpp:3226
DataTypes::real_t supWorker() const
Definition: Data.cpp:2293
boost::shared_ptr< AbstractDomain > Domain_ptr
Definition: AbstractDomain.h:36
Data sign() const
Return the sign of each data point of this Data object. -1 for negative values, zero for zero values...
Definition: Data.cpp:1959
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
int getDataPointSize() const
Return the size of the data point. It is the product of the data point shape dimensions.
Definition: Data.cpp:1234
Definition: AbstractContinuousDomain.cpp:22
Data imag() const
Definition: Data.cpp:1826
Data atan() const
Return the atan of each data point of this Data object.
Definition: Data.cpp:1884
Data log10() const
Return the log to base 10 of each data point of this Data object.
Definition: Data.cpp:1945
Data pos() const
Return the identity of each data point of this Data object. Simply returns this object unmodified...
Definition: Data.cpp:1980
boost::shared_ptr< const DataReady > const_DataReady_ptr
Definition: DataAbstract.h:59
void setItemD(const boost::python::object &key, const Data &value)
Copies slice from value into this Data object.
Definition: Data.cpp:3242
Data operator-(const Data &left, const Data &right)
Operator- Takes two Data objects.
Definition: Data.cpp:3103
MPI_Comm get_MPIComm(void) const
return the MPI rank number of the local data MPI_COMM_WORLD is assumed and returned.
Definition: Data.cpp:5187
DataTypes::real_t sup_const() const
Definition: Data.cpp:2051
Data besselSecondKind(int order)
Return the Bessel function of the second kind for each data point of this Data object.
Definition: Data.cpp:1689
void print(void)
print the data values to stdout. Used for debugging
Definition: Data.cpp:5127
Data interpolateFromTable3DP(boost::python::object table, DataTypes::real_t Amin, DataTypes::real_t Astep, Data &B, DataTypes::real_t Bmin, DataTypes::real_t Bstep, Data &C, DataTypes::real_t Cmin, DataTypes::real_t Cstep, DataTypes::real_t undef, bool check_boundaries)
Definition: Data.cpp:4477
void typeMatchRight(const Data &right)
Convert the data type of this to match the RHS.
Definition: Data.cpp:3293
void setSlice(const Data &value, const DataTypes::RegionType &region)
Copy the specified slice from the given value into this Data object.
Definition: Data.cpp:3258
DataConstant stores a single data point which represents the entire function space.
Definition: DataConstant.h:37
static const ShapeType scalarShape
Use this instead of creating empty shape objects for scalars.
Definition: DataTypes.h:46
void setValueOfDataPointToPyObject(int dataPointNo, const boost::python::object &py_object)
sets the values of a data-point from a python object on this process
Definition: Data.cpp:1433
DataTypes::RealVectorType::const_reference getDataPointRO(int sampleNo, int dataPointNo)
Return a reference into the DataVector which points to the specified data point.
Definition: Data.cpp:4453
bool isLazy() const
Return true if this Data is lazy.
Definition: Data.cpp:1029
Data C_TensorUnaryOperation(Data const &arg_0, escript::ES_optype operation, DataTypes::real_t tol=0)
Definition: Data.cpp:5769
DataAbstract_ptr borrowDataPtr(void) const
Definition: Data.cpp:4369
Data real() const
Definition: Data.cpp:1807
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataConstant.cpp:602
void setTaggedValueByName(std::string name, const boost::python::object &value)
Assign the given value to the tag assocciated with name. Implicitly converts this object to type Data...
Definition: Data.cpp:3321
Give a short description of what DataExpanded does.
Definition: DataExpanded.h:43
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataTagged.cpp:1384
Data sinh() const
Return the sinh of each data point of this Data object.
Definition: Data.cpp:1891
Data atanh() const
Return the atanh of each data point of this Data object.
Definition: Data.cpp:1938
DataReady_ptr getReadyPtr()
Definition: Data.h:1763
void TensorSelfUpdateBinaryOperation(const Data &right, escript::ES_optype operation)
Definition: Data.cpp:6220
DataTypes::RealVectorType::reference getDataByTagRW(int tag, DataTypes::RealVectorType::size_type i, DataTypes::real_t dummy=0)
getDataByTag
Definition: DataTagged.cpp:875
const_Domain_ptr getDomain() const
Returns the function space domain.
Definition: FunctionSpace.cpp:102
Data rpowO(const boost::python::object &left) const
Return the given power of each data point of this boost python object.
Definition: Data.cpp:3067
friend Data randomData(const boost::python::tuple &shape, const FunctionSpace &what, long seed, const boost::python::tuple &filter)
Create a new Expanded Data object filled with pseudo-random data.
DataTypes::real_t lazyAlgWorker(DataTypes::real_t init)
Data interpolateFromTable1DP(boost::python::object table, DataTypes::real_t Amin, DataTypes::real_t Astep, DataTypes::real_t undef, bool check_boundaries)
Definition: Data.cpp:4496
std::list< int > getListOfTagsSTL() const
Returns an stl list of the tags used in this function space.
Definition: FunctionSpace.cpp:286
(Testing use only) Provides a domain to wrap a collection of values.
Definition: TestDomain.h:41
void setTaggedValueFromCPP(int tagKey, const DataTypes::ShapeType &pointshape, const DataTypes::RealVectorType &value, int dataOffset=0)
Assign the given value to the tag. Implicitly converts this object to type DataTagged if it is consta...
Definition: Data.cpp:3378
Data nonuniformslope(boost::python::object in, boost::python::object out, bool check_boundaries)
Definition: Data.cpp:5048
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:42
boost::python::object __sub__(const boost::python::object &right)
wrapper for python subtract operation
Definition: Data.cpp:5639
Data interpolateFromTable2DP(boost::python::object table, DataTypes::real_t Amin, DataTypes::real_t Astep, Data &B, DataTypes::real_t Bmin, DataTypes::real_t Bstep, DataTypes::real_t undef, bool check_boundaries)
Definition: Data.cpp:4487
Data acos() const
Return the acos of each data point of this Data object.
Definition: Data.cpp:1876
Simulates a full dataset accessible via sampleNo and dataPointNo.
Definition: DataTagged.h:44
bool probeInterpolation(const FunctionSpace &functionspace) const
Returns true if this can be interpolated to functionspace.
Definition: Data.cpp:1200
boost::shared_ptr< DataAbstract > DataAbstract_ptr
Definition: DataAbstract.h:51
DataTypes::real_t * getSampleDataRW(DataTypes::RealVectorType::size_type sampleNo, DataTypes::real_t dummy=0)
Return the sample data for the given sample number.
Definition: DataReady.h:181
Data getItem(const boost::python::object &key) const
Returns a slice from this Data object.
Definition: Data.cpp:3212
void initialise(const DataTypes::RealVectorType &value, const DataTypes::ShapeType &shape, const FunctionSpace &what, bool expanded)
Construct a Data object of the appropriate type.
Definition: Data.cpp:586
Data maxval() const
Return the maximum value of each data point of this Data object.
Definition: Data.cpp:2403
void setValueOfDataPointC(int dataPointNo, const DataTypes::cplx_t)
Definition: Data.cpp:1550
Data cos() const
Return the cos of each data point of this Data object.
Definition: Data.cpp:1855
const DataTypes::real_t * getDataRO(DataTypes::real_t dummy=0) const
Return a pointer to the beginning of the underlying data.
Definition: Data.h:1972
Data C_GeneralTensorProduct(Data &arg_0, Data &arg_1, int axis_offset=0, int transpose=0)
Compute a tensor product of two Data objects.
Definition: Data.cpp:3434
bool m_protected
Definition: Data.h:1732
Data cosh() const
Return the cosh of each data point of this Data object.
Definition: Data.cpp:1898
void setValueOfDataPoint(int dataPointNo, const DataTypes::real_t)
sets the values of a data-point on this process
Definition: Data.cpp:1529
Data interpolate(const FunctionSpace &functionspace) const
Interpolates this onto the given functionspace and returns the result as a Data object.
Definition: Data.cpp:1194
Data matrixInverse() const
return inverse of matricies.
Definition: Data.cpp:3039
Data & operator/=(const Data &right)
Overloaded operator /=.
Definition: Data.cpp:3008
DataReady * getReady()
Definition: Data.h:1751
Data copySelf() const
Return a pointer to a deep copy of this object.
Definition: Data.cpp:697
void resolve()
If this data is lazy, then convert it to ready data. What type of ready data depends on the expressio...
Definition: Data.cpp:1113
bool isEmpty() const
Return true if this Data holds an instance of DataEmpty. This is _not_ the same as asking if the obj...
Definition: Data.cpp:1015
Data tanh() const
Return the tanh of each data point of this Data object.
Definition: Data.cpp:1905
void calc_minGlobalDataPoint(int &ProcNo, int &DataPointNo) const
Definition: Data.cpp:2750
void operandCheck(const Data &right) const
Check *this and the right operand are compatible. Throws an exception if they aren&#39;t.
Definition: Data.h:1652
DataAbstract * borrowData(void) const
return the object produced by the factory, which is a DataConstant or DataExpanded TODO Ownership of ...
Definition: Data.cpp:4362
Data erf() const
Return the error function erf of each data point of this Data object.
Definition: Data.cpp:1913
const DataTypes::ShapeType & getShape() const
Return the shape information for the point data.
Definition: DataAbstract.h:631
int getNumSamples() const
Return the number of samples.
Definition: DataAbstract.h:612
int getNumDPPSample() const
Return the number of data points per sample.
Definition: DataAbstract.h:601
DataTypes::real_t infWorker() const
Definition: Data.cpp:2336
int getNoValues() const
Return the number of values in the shape for this object.
Definition: Data.h:557
Describes binary operations performed on DataVector.
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
Data rtruedivO(const boost::python::object &left)
Newer style division operator for python.
Definition: Data.h:2161
const boost::python::tuple maxGlobalDataPoint() const
Return the (sample number, data-point number) of the data point with the minimum component value in t...
Definition: Data.cpp:2828
const DataTypes::real_t * getSampleDataRO(DataTypes::RealVectorType::size_type sampleNo, DataTypes::real_t dummy=0) const
Return the sample data for the given sample no. Please do not use this unless you NEED to access samp...
Definition: Data.h:1945
std::map< int, int > DataMapType
Definition: DataTagged.h:57
Data powD(const Data &right) const
Return the given power of each data point of this Data object.
Definition: Data.cpp:3081
void replaceNaNPython(boost::python::object obj)
replaces all NaN values with value
Definition: Data.cpp:2221
Data trace(int axis_offset) const
Return the trace of a matrix.
Definition: Data.cpp:2604
DataTypes::RealVectorType::size_type getOffsetForTag(int tag) const
getOffsetForTag
Definition: DataTagged.cpp:853
const boost::python::tuple minGlobalDataPoint() const
Return the (sample number, data-point number) of the data point with the minimum component value in t...
Definition: Data.cpp:2736
Data minval_nonlazy() const
Definition: Data.cpp:2381
int get_MPISize(void) const
return the MPI rank number of the local data MPI_COMM_WORLD is assumed and the result of MPI_Comm_ran...
Definition: Data.cpp:5163
const DataTypes::ShapeType & getDataPointShape() const
Return a reference to the data point shape.
Definition: Data.h:682
const FunctionSpace & getFunctionSpace() const
Return the function space.
Definition: Data.h:452
void delaySelf()
convert the current data into lazy data.
Definition: Data.cpp:724
Data transpose(int axis_offset) const
Transpose each data point of this Data object around the given axis.
Definition: Data.cpp:2659
int get_MPIRank(void) const
return the MPI rank number of the local data MPI_COMM_WORLD is assumed and the result of MPI_Comm_siz...
Definition: Data.cpp:5175
DataTypes::RealVectorType::reference getDataAtOffsetRW(DataTypes::RealVectorType::size_type i, DataTypes::real_t dummy=0)
Definition: Data.cpp:4422
void expand()
Whatever the current Data type make this into a DataExpanded.
Definition: Data.cpp:1063
DataTypes::real_t reduction(BinaryFunction operation, DataTypes::real_t initial_value) const
Perform the specified reduction algorithm on every element of every data point in this Data object ac...
Definition: Data.h:2179
Data operator+(const Data &left, const Data &right)
Operator+ Takes two Data objects.
Definition: Data.cpp:3093
Data represents a collection of datapoints.
Definition: Data.h:63
Data whereZero(DataTypes::real_t tol=0.0) const
Return a Data with a 1 for 0 values and a 0 for +ive or -ive values.
Definition: Data.cpp:1180
DataTypes::RealVectorType::reference getDataPointRW(int sampleNo, int dataPointNo)
Return a reference into the DataVector which points to the specified data point.
Definition: Data.cpp:4469
Data asinh() const
Return the asinh of each data point of this Data object.
Definition: Data.cpp:1924
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:595
ES_optype
Definition: ES_optype.h:26
Data asin() const
Return the asin of each data point of this Data object.
Definition: Data.cpp:1869
bool isConstant() const
Return true if this Data is constant.
Definition: Data.cpp:1022
void setValueOfDataPointToArray(int dataPointNo, const boost::python::object &)
sets the values of a data-point from a array-like object on this process
Definition: Data.cpp:1486
bool isComplex() const
True if components of this data are stored as complex.
Definition: Data.cpp:1043
bool isShared() const
Definition: Data.h:1792
bool numSamplesEqual(int numDataPointsPerSample, int numSamples) const
Returns true if the number of data points per sample and the number of samples match the respective a...
Definition: Data.h:532
const DataTypes::RealVectorType * resolveSample(int sampleNo, size_t &roffset) const
Compute the value of the expression for the given sample.
Definition: DataLazy.cpp:1532
DataReady_ptr borrowReadyPtr(void) const
Definition: Data.cpp:4376
Data acosh() const
Return the acosh of each data point of this Data object.
Definition: Data.cpp:1931
Data wherePositive() const
Return a Data with a 1 for +ive values and a 0 for 0 or -ive values.
Definition: Data.cpp:1136
bool actsExpanded() const
Return true if this Data is expanded or resolves to expanded. That is, if it has a separate value for...
Definition: Data.cpp:1001
Data & operator=(const Data &other)
Definition: Data.cpp:2946
void forceResolve()
Definition: Data.h:1801
DataTypes::cplx_t * getSampleDataByTag(int tag, DataTypes::cplx_t dummy)
Definition: Data.h:638
virtual DataAbstract * deepCopy() const =0
Return a deep copy of the current object.
void requireWrite()
Ensures data is ready for write access. This means that the data will be resolved if lazy and will be...
Definition: Data.cpp:1122
DataTypes::real_t Lsup_const() const
Definition: Data.cpp:2006
int getNumDataPointsPerSample() const
Return the number of data points per sample.
Definition: Data.h:521
const DataReady * getReady() const
Definition: Data.h:1743
DataTypes::RealVectorType::size_type getDefaultOffset() const
Returns the offset in the structure which stores the default value.
Definition: DataTagged.h:693
DataTypes::real_t * getSampleDataRW(DataTypes::RealVectorType::size_type sampleNo, DataTypes::real_t dummy=0)
Return the sample data for the given sample no. Please do not use this unless you NEED to access samp...
Definition: Data.h:1910
int MPI_Comm
Definition: EsysMPI.h:41
Data hermitian() const
Return the hermitian part of a matrix which is half the matrix plus its adjoint.
Definition: Data.cpp:2537
Data oneOver() const
Returns 1./ Data object.
Definition: Data.cpp:1129
virtual DataTypes::RealVectorType & getTypedVectorRW(DataTypes::real_t dummy)
These versions use the type system rather than method name to determine return type.
Definition: DataTagged.cpp:1377
DataTypes::real_t LsupWorker() const
Definition: Data.cpp:2236
Data minval() const
Return the minimum value of each data point of this Data object.
Definition: Data.cpp:2412
Data C_TensorBinaryOperation(Data const &arg_0, Data const &arg_1, ES_optype operation)
Compute a tensor operation with two Data objects.
Definition: Data.cpp:6044
bool m_lazy
Definition: Data.h:1733
DataTypes::real_t sup()
Return the maximum value of this Data object.
Definition: Data.cpp:2065
boost::python::object integrateWorker() const
Definition: Data.cpp:1648
void setTupleForGlobalDataPoint(int id, int proc, boost::python::object)
Set the value of a global data point.
Definition: Data.cpp:1441
const DataTypes::real_t * getSampleDataRO(DataTypes::RealVectorType::size_type sampleNo, DataTypes::real_t dummy=0) const
Definition: DataReady.h:195
int getNumSamples() const
Return the number of samples.
Definition: Data.h:510
boost::python::object __div__(const boost::python::object &right)
wrapper for python divide operation
Definition: Data.cpp:5712
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const =0
Data abs() const
Return the absolute value of each data point of this Data object.
Definition: Data.cpp:1966
Data grad() const
Definition: Data.cpp:1223
friend Data condEval(escript::Data &mask, escript::Data &trueval, escript::Data &falseval)
Data dp_algorithm(BinaryFunction operation, DataTypes::real_t initial_value) const
Reduce each data-point in this Data object using the given operation. Return a Data object with the s...
Definition: Data.h:2261
void copy(const Data &other)
Make this object a deep copy of "other".
Definition: Data.cpp:704
Wraps an expression tree of other DataObjects. The data will be evaluated when required.
Definition: DataLazy.h:47
std::complex< real_t > cplx_t
complex data type
Definition: DataTypes.h:53
DataTypes::real_t inf_const() const
Definition: Data.cpp:2090
const boost::python::tuple eigenvalues_and_eigenvectors(const DataTypes::real_t tol=1.e-12) const
Return the eigenvalues and corresponding eigenvcetors of the symmetric part at each data point of thi...
Definition: Data.cpp:2710
void init_from_data_and_fs(const Data &inData, const FunctionSpace &functionspace)
Definition: Data.cpp:433
DataTypes::RealVectorType::const_reference getDataAtOffsetRO(DataTypes::RealVectorType::size_type i, DataTypes::real_t dummy=0)
Return a pointer to the beginning of the datapoint at the specified offset. TODO Eventually these sho...
Definition: Data.cpp:4430
int getTagNumber(int dpno)
Return the tag number associated with the given data-point.
Definition: Data.cpp:3417
Domain_ptr getDomainPython() const
Return the function space domain. Internal use only! This gets around some python difficulties by cas...
Definition: FunctionSpace.cpp:108
Definition: DataException.h:26
void complicate()
Definition: Data.cpp:5760
Data nonuniforminterp(boost::python::object in, boost::python::object out, bool check_boundaries)
Definition: Data.cpp:4972
virtual const DataTypes::RealVectorType & getTypedVectorRO(DataTypes::real_t dummy) const
Definition: DataExpanded.cpp:1233
Data maxval_nonlazy() const
Definition: Data.cpp:2392
DataTypes::real_t reductionOpVector(const DataTypes::RealVectorType &left, const DataTypes::ShapeType &leftShape, DataTypes::RealVectorType::size_type offset, BinaryFunction operation, DataTypes::real_t initial_value)
Perform the given data point reduction operation on the data point specified by the given offset into...
Definition: DataVectorOps.h:1361
Data powO(const boost::python::object &right) const
Return the given power of each data point of this boost python object.
Definition: Data.cpp:3074
Data whereNonNegative() const
Return a Data with a 1 for +ive or 0 values and a 0 for -ive values.
Definition: Data.cpp:1158
Data exp() const
Return the exponential function of each data point of this Data object.
Definition: Data.cpp:1992
Data operator*(const AbstractSystemMatrix &left, const Data &right)
Definition: AbstractSystemMatrix.cpp:59
void exclusiveWrite()
if another object is sharing out member data make a copy to work with instead. This code should only ...
Definition: Data.h:1819
Data whereNegative() const
Return a Data with a 1 for -ive values and a 0 for +ive or 0 values.
Definition: Data.cpp:1147
bool isTagged() const
Return true if this Data is tagged.
Definition: Data.cpp:1008
Definition: DataAbstract.h:61
bool hasNoSamples() const
Return true if this object contains no samples. This is not the same as isEmpty() ...
Definition: Data.h:714
Data conjugate() const
For complex values return the conjugate values. For non-complex data return a copy.
Definition: Data.cpp:1787
const_Domain_ptr getDomain() const
Return the domain.
Definition: Data.h:464
Data interpolateFromTable2D(const WrappedArray &table, DataTypes::real_t Amin, DataTypes::real_t Astep, DataTypes::real_t undef, Data &B, DataTypes::real_t Bmin, DataTypes::real_t Bstep, bool check_boundaries)
Definition: Data.cpp:4633
const ElementType & const_reference
Definition: DataVectorAlt.h:51
void dump(const std::string fileName) const
dumps the object into a netCDF file
Definition: Data.cpp:5141
void setProtection()
switches on update protection
Definition: Data.cpp:1049
const FunctionSpace & getFunctionSpace() const
Return the function space associated with this Data object.
Definition: DataAbstract.h:624
Data besselFirstKind(int order)
Return the Bessel function of the first kind for each data point of this Data object.
Definition: Data.cpp:1682
boost::shared_ptr< DataReady > DataReady_ptr
Definition: DataAbstract.h:56
boost::python::object __rdiv__(const boost::python::object &right)
wrapper for python reverse divide operation
Definition: Data.cpp:5736
bool hasNaN()
returns return true if data contains NaN.
Definition: Data.cpp:2190
DataTypes::RealVectorType::size_type getDataOffset(int sampleNo, int dataPointNo)
Return the offset for the given sample and point within the sample.
Definition: Data.h:670
Data operator/(const Data &left, const Data &right)
Operator/ Takes two Data objects.
Definition: Data.cpp:3122
bool isExpanded() const
Return true if this Data is expanded.
Definition: Data.cpp:994
Data whereNonPositive() const
Return a Data with a 1 for -ive or 0 values and a 0 for +ive values.
Definition: Data.cpp:1169
Data()
Default constructor. Creates a DataEmpty object.
Definition: Data.cpp:249
void copyWithMask(const Data &other, const Data &mask)
Copy other Data object into this Data object where mask is positive.
Definition: Data.cpp:764
boost::python::object __mul__(const boost::python::object &right)
wrapper for python multiply operation
Definition: Data.cpp:5688
size_t getNumberOfTaggedValues() const
For tagged Data returns the number of tags with values. For non-tagged data will return 0 (even Data ...
Definition: Data.cpp:5562
Data neg() const
Return the negation of each data point of this Data object.
Definition: Data.cpp:1973
const boost::python::tuple getShapeTuple() const
Return the data point shape as a tuple of integers.
Definition: Data.cpp:672
const DataMapType & getTagLookup() const
getTagLookup
Definition: DataTagged.h:731
Data truedivO(const boost::python::object &right)
Newer style division operator for python.
Definition: Data.h:2148
bool isReady() const
Return true if this data is ready.
Definition: Data.cpp:1036
Data symmetric() const
Return the symmetric part of a matrix which is half the matrix plus its transpose.
Definition: Data.cpp:2478
#define ESYS_ASSERT(a, b)
EsysAssert is a MACRO that will throw an exception if the boolean condition specified is false...
Definition: Assert.h:78
Definition: WrappedArray.h:31
DataTypes::RealVectorType & getExpandedVectorReference(DataTypes::real_t dummy=0)
Ensures that the Data is expanded and returns its underlying vector Does not check for exclusive writ...
Definition: Data.cpp:5544
int getNumDataPoints() const
Return the number of data points.
Definition: Data.h:500
Data antisymmetric() const
Return the antisymmetric part of a matrix which is half the matrix minus its transpose.
Definition: Data.cpp:2501
Data sin() const
Return the sin of each data point of this Data object.
Definition: Data.cpp:1848
~Data()
Destructor.
Definition: Data.cpp:549
void unaryOp2(UnaryFunction operation)
Perform the given unary operation on every element of every data point in this Data object...
Data gradOn(const FunctionSpace &functionspace) const
Calculates the gradient of the data at the data points of functionspace. If functionspace is not pres...
Definition: Data.cpp:1206
const boost::python::object getValueOfDataPointAsTuple(int dataPointNo)
Return the value of a data point as a python tuple.
Definition: Data.cpp:1394
Data interpolateFromTable3D(const WrappedArray &table, DataTypes::real_t Amin, DataTypes::real_t Astep, DataTypes::real_t undef, Data &B, DataTypes::real_t Bmin, DataTypes::real_t Bstep, Data &C, DataTypes::real_t Cmin, DataTypes::real_t Cstep, bool check_boundaries)
Definition: Data.cpp:4789
bool isProtected() const
Returns true, if the data object is protected against update.
Definition: Data.cpp:1055
Data log() const
Return the natural log of each data point of this Data object.
Definition: Data.cpp:1952
Data truedivD(const Data &right)
Newer style division operator for python.
Definition: Data.h:2136
boost::shared_ptr< const AbstractDomain > const_Domain_ptr
Definition: AbstractDomain.h:39
Data whereNonZero(DataTypes::real_t tol=0.0) const
Return a Data with a 0 for 0 values and a 1 for +ive or -ive values.
Definition: Data.cpp:1187
DataTypes::real_t Lsup()
Return the maximum absolute value of this Data object.
Definition: Data.cpp:2016
Data & operator-=(const Data &right)
Overloaded operator -=.
Definition: Data.cpp:2954
boost::python::object integrateToTuple_const() const
Calculate the integral over the function space domain as a python tuple.
Definition: Data.cpp:1626
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:50
void calc_maxGlobalDataPoint(int &ProcNo, int &DataPointNo) const
Definition: Data.cpp:2838
Data eigenvalues() const
Return the eigenvalues of the symmetric part at each data point of this Data object in increasing val...
Definition: Data.cpp:2683
Data bessel(int order, DataTypes::real_t(*besselfunc)(int, DataTypes::real_t))
Bessel worker function.
Definition: Data.cpp:1696
void setTaggedValue(int tagKey, const boost::python::object &value)
Assign the given value to the tag. Implicitly converts this object to type DataTagged if it is consta...
Definition: Data.cpp:3338
const boost::python::object getValueOfGlobalDataPointAsTuple(int procNo, int dataPointNo)
Return a data point across all processors as a python tuple.
Definition: Data.cpp:1573
Data swapaxes(const int axis0, const int axis1) const
swaps the components axis0 and axis1
Definition: Data.cpp:2421
Domain_ptr getDomainPython() const
Return the domain. TODO: For internal use only. This should be removed.
Definition: Data.h:478
Data tan() const
Return the tan of each data point of this Data object.
Definition: Data.cpp:1862
Data & operator+=(const Data &right)
Overloaded operator +=.
Definition: Data.cpp:2918