escript  Revision_
DataFactory.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_DataFactory_20040721_H
19 #define escript_DataFactory_20040721_H
20 
21 #include "system_dep.h"
22 
23 #include "AbstractDomain.h"
24 #include "FunctionSpace.h"
25 #include "Data.h"
26 
27 #include <boost/python/object.hpp>
28 
29 namespace escript {
30 
47 ESCRIPT_DLL_API Data
48 Scalar(double value,
49  const FunctionSpace& what=FunctionSpace(),
50  bool expanded=false);
51 
52 
63 ESCRIPT_DLL_API Data
65  const FunctionSpace& what=FunctionSpace(),
66  bool expanded=false);
67 
72 Data
73 ScalarFromObj(boost::python::object o,
74  const FunctionSpace& what=FunctionSpace(),
75  bool expanded=false);
76 
77 
83 ESCRIPT_DLL_API Data
84 Vector(double value,
85  const FunctionSpace& what=FunctionSpace(),
86  bool expanded=false);
87 
89 Data
90 VectorFromObj(boost::python::object o,
91  const FunctionSpace& what=FunctionSpace(),
92  bool expanded=false);
93 
99 ESCRIPT_DLL_API Data
100 Tensor(double value,
101  const FunctionSpace& what=FunctionSpace(),
102  bool expanded=false);
103 
105 Data
106 TensorFromObj(boost::python::object o,
107  const FunctionSpace& what=FunctionSpace(),
108  bool expanded=false);
114 ESCRIPT_DLL_API Data
115 Tensor3(double value,
116  const FunctionSpace& what=FunctionSpace(),
117  bool expanded=false);
118 
120 Data
121 Tensor3FromObj(boost::python::object o,
122  const FunctionSpace& what=FunctionSpace(),
123  bool expanded=false);
124 
130 ESCRIPT_DLL_API Data
131 Tensor4(double value,
132  const FunctionSpace& what=FunctionSpace(),
133  bool expanded=false);
134 
136 Data
137 Tensor4FromObj(boost::python::object o,
138  const FunctionSpace& what=FunctionSpace(),
139  bool expanded=false);
140 
145 ESCRIPT_DLL_API Data
146 load(const std::string fileName,
147  const AbstractDomain& domain);
152 ESCRIPT_DLL_API bool
154 
162 ESCRIPT_DLL_API Data
163 convertToData(const boost::python::object& value,
164  const FunctionSpace& what=FunctionSpace());
165 
166 
167 } // end of namespace
168 
169 #endif
escript::Tensor3C
Data Tensor3C(DataTypes::cplx_t value, const FunctionSpace &what, bool expanded)
Definition: DataFactory.cpp:164
escript::DataTypes::maxRank
static const int maxRank
The maximum number of dimensions a datapoint can have.
Definition: DataTypes.h:68
DataFactory.h
ESCRIPT_DLL_API
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:28
escript::Tensor4FromObj
Data Tensor4FromObj(bp::object o, const FunctionSpace &what, bool expanded)
Definition: DataFactory.cpp:209
escript::loadConfigured
bool loadConfigured()
returns true if the load funtion is configured.
Definition: DataFactory.cpp:704
escript::FunctionSpace::getNumSamples
DataTypes::dim_t getNumSamples() const
Returns the number of samples.
Definition: FunctionSpace.h:171
escript::DataTypes::DataVectorAlt
Definition: DataVectorAlt.h:59
escript::ScalarFromObj
Data ScalarFromObj(boost::python::object o, const FunctionSpace &what, bool expanded)
Python interface for the Scalar factory.
Definition: DataFactory.cpp:75
escript::TensorFromObj
Data TensorFromObj(bp::object o, const FunctionSpace &what, bool expanded)
Definition: DataFactory.cpp:133
escript::checkResult
bool checkResult(int res, int &mres, const JMPI &info)
Everyone puts in their error code and everyone gets the largest one.
Definition: EsysMPI.cpp:120
escript::FunctionSpace
Definition: FunctionSpace.h:45
escript::FunctionSpace::getDomain
const_Domain_ptr getDomain() const
Returns the function space domain.
Definition: FunctionSpace.cpp:101
system_dep.h
escript::convertToData
Data convertToData(const bp::object &value, const FunctionSpace &what)
Definition: DataFactory.cpp:713
escript::Scalar
Data Scalar(DataTypes::cplx_t value, const FunctionSpace &what, bool expanded)
Return a Data object containing scalar data-points. ie: rank 0 data-points.
Definition: DataFactory.cpp:67
escript::DataTagged
Simulates a full dataset accessible via sampleNo and dataPointNo.
Definition: DataTagged.h:55
escript::Data
Data represents a collection of datapoints.
Definition: Data.h:62
escript::DataException
Definition: DataException.h:37
escript::FunctionSpace::getNumDataPointsPerSample
int getNumDataPointsPerSample() const
Definition: FunctionSpace.h:180
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:87
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
AbstractDomain.h
escript::Data::isEmpty
bool isEmpty() const
Definition: Data.cpp:1135
escript::Tensor3
Data Tensor3(double value, const FunctionSpace &what, bool expanded)
Return a Data object containing tensor3 datapoints. ie: rank 3 data-points.
Definition: DataFactory.cpp:158
NCHelper.h
escript::DataTypes::RealVectorType
escript::DataTypes::DataVectorAlt< real_t > RealVectorType
Vector to store underlying data.
Definition: DataVector.h:42
escript::load
Data load(const std::string fileName, const AbstractDomain &domain)
reads Data on domain from file in netCDF format
Definition: DataFactory.cpp:494
escript::Tensor4C
Data Tensor4C(DataTypes::cplx_t value, const FunctionSpace &what, bool expanded)
Definition: DataFactory.cpp:202
escript
Definition: AbstractContinuousDomain.cpp:22
escript::Tensor
Data Tensor(double value, const FunctionSpace &what, bool expanded)
Return a Data object containing tensor datapoints. ie: rank 2 data-points.
Definition: DataFactory.cpp:120
escript::Vector
Data Vector(double value, const FunctionSpace &what, bool expanded)
Return a Data object containing vector data-points. ie: rank 1 data-points.
Definition: DataFactory.cpp:96
escript::TensorC
Data TensorC(DataTypes::cplx_t value, const FunctionSpace &what, bool expanded)
Definition: DataFactory.cpp:126
escript::FunctionSpace::borrowSampleReferenceIDs
const DataTypes::dim_t * borrowSampleReferenceIDs() const
Returns a borrowed reference to the list of sample reference IDs.
Definition: FunctionSpace.cpp:197
escript::VectorFromObj
Data VectorFromObj(bp::object o, const FunctionSpace &what, bool expanded)
Definition: DataFactory.cpp:102
Data.h
escript::Tensor3FromObj
Data Tensor3FromObj(bp::object o, const FunctionSpace &what, bool expanded)
Definition: DataFactory.cpp:171
escript::shipString
bool shipString(const char *src, char **dest, MPI_Comm &comm)
Definition: EsysMPI.cpp:174
escript::DataTypes::cplx_t
std::complex< real_t > cplx_t
complex data type
Definition: DataTypes.h:76
escript::Scalar
Data Scalar(double value, const FunctionSpace &what, bool expanded)
A collection of factory functions for creating Data objects which contain data points of various shap...
Definition: DataFactory.cpp:60
escript::Tensor4
Data Tensor4(double value, const FunctionSpace &what, bool expanded)
Return a Data object containing tensor4 datapoints. ie: rank 4 data-points.
Definition: DataFactory.cpp:196
FunctionSpace.h