/[escript]/trunk/escript/src/DataConstant.h
ViewVC logotype

Annotation of /trunk/escript/src/DataConstant.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 854 - (hide annotations)
Thu Sep 21 05:29:42 2006 UTC (12 years, 11 months ago) by gross
File MIME type: text/plain
File size: 7295 byte(s)
Some modifications to the binary operations +,-,*/, pow. 
The code is a bit simpler now and more efficient has there is
no reseising required now. the resizing method has been removed as
it is very, very inefficient. Even serial code should be faster now.
It is now forbidden to do an inplace update of scalar data object with an object 
of rank >0 as this is very slow (and does not make much sense). 


1 jgs 102 //$Id$
2 jgs 82 /*
3 elspeth 615 ************************************************************
4     * Copyright 2006 by ACcESS MNRF *
5     * *
6     * http://www.access.edu.au *
7     * Primary Business: Queensland, Australia *
8     * Licensed under the Open Software License version 3.0 *
9     * http://www.opensource.org/licenses/osl-3.0.php *
10     * *
11     ************************************************************
12 jgs 82 */
13 jgs 480
14 jgs 102 #if !defined escript_DataConstant_20040323_H
15 jgs 82 #define escript_DataConstant_20040323_H
16 woo409 757 #include "system_dep.h"
17 jgs 82
18 jgs 474 #include "DataAbstract.h"
19     #include "DataArrayView.h"
20 jgs 82
21     #include <boost/python/numeric.hpp>
22    
23     namespace escript {
24 jgs 102
25 jgs 82 /**
26     \brief
27 jgs 102 DataConstant stores a single data point which represents the entire
28 jgs 82 function space.
29    
30     Description:
31 jgs 102 DataConstant stores a single data point which represents the entire
32 jgs 82 function space.
33     */
34 jgs 102 class DataConstant : public DataAbstract {
35 jgs 82
36     public:
37    
38     /**
39     \brief
40 jgs 102 Constructor for DataConstant objects.
41 jgs 82
42     Description:
43 jgs 102 Constructor for DataConstant objects.
44 jgs 82
45 jgs 102 \param value - Input - Data value for a single point.
46     \param what - Input - A description of what this data object represents.
47     */
48 woo409 757 ESCRIPT_DLL_API
49 jgs 102 DataConstant(const boost::python::numeric::array& value,
50     const FunctionSpace& what);
51 jgs 100
52 jgs 82 /**
53     \brief
54     Copy constructor. Performs a deep copy.
55     */
56 woo409 757 ESCRIPT_DLL_API
57 jgs 82 DataConstant(const DataConstant& other);
58 jgs 102
59 jgs 82 /**
60     \brief
61 jgs 102 Alternative constructor for DataConstant objects.
62 jgs 82
63     Description:
64 jgs 102 Alternative Constructor for DataConstant objects.
65     \param value - Input - Data value for a single point.
66     \param what - Input - A description of what this data object represents.
67 jgs 82 */
68 woo409 757 ESCRIPT_DLL_API
69 jgs 102 DataConstant(const DataArrayView& value,
70     const FunctionSpace& what);
71    
72 jgs 82 /**
73     \brief
74 jgs 102 Alternative constructor for DataConstant objects.
75 jgs 82
76     Description:
77 jgs 102 Alternative Constructor for DataConstant objects.
78     \param other - Input - Data object to copy from.
79     \param region - Input - region to copy.
80 jgs 82 */
81 woo409 757 ESCRIPT_DLL_API
82 jgs 102 DataConstant(const DataConstant& other,
83     const DataArrayView::RegionType& region);
84    
85 jgs 82 /**
86     \brief
87 jgs 119 Alternative constructor for DataConstant objects.
88    
89     Description:
90     Alternative Constructor for DataConstant objects.
91     \param what - Input - A description of what this data object represents.
92     \param shape - Input - the shape of each data-point.
93     \param data - the data values for each data-point.
94     */
95 woo409 757 ESCRIPT_DLL_API
96 jgs 119 DataConstant(const FunctionSpace& what,
97     const DataArrayView::ShapeType &shape,
98     const DataArrayView::ValueType &data);
99    
100     /**
101     \brief
102 jgs 82 Write the data as a string.
103     */
104 woo409 757 ESCRIPT_DLL_API
105 jgs 102 std::string
106     toString() const;
107    
108 jgs 82 /**
109     \brief
110 jgs 102 Return the offset for the given sample. This is a somewhat artificial notion
111 jgs 82 but returns the offset in bytes for the given point into the container
112     holding the point data. Only really necessary to avoid many DataArrayView
113     objects.
114 jgs 102 \param sampleNo - Input - sample number.
115     \param dataPointNo - Input - data point number for the sample.
116 jgs 82 */
117 woo409 757 ESCRIPT_DLL_API
118 jgs 102 virtual
119     DataArrayView::ValueType::size_type
120     getPointOffset(int sampleNo,
121     int dataPointNo) const;
122    
123 jgs 82 /**
124     \brief
125     Return a view into the data for the data point specified.
126 jgs 102 \param sampleNo - Input - sample number.
127     \param dataPointNo - Input - data point number for the sample.
128 jgs 82 */
129 woo409 757 ESCRIPT_DLL_API
130 jgs 102 virtual
131     DataArrayView
132     getDataPoint(int sampleNo,
133     int dataPointNo);
134    
135 jgs 82 /**
136     \brief
137 jgs 102 Return the number of doubles stored for the Data object.
138 jgs 82 */
139 woo409 757 ESCRIPT_DLL_API
140 jgs 102 virtual
141 jgs 117 DataArrayView::ValueType::size_type
142 jgs 102 getLength() const;
143    
144 jgs 82 /**
145     \brief
146 jgs 102 Factory method that returns a newly created DataConstant object
147     sliced from the specified region of this object.
148 jgs 82 The caller is reponsible for managing the object created.
149 jgs 102 \param region - Input - region to slice from this object.
150 jgs 82 */
151 woo409 757 ESCRIPT_DLL_API
152 jgs 102 virtual
153     DataAbstract*
154     getSlice(const DataArrayView::RegionType& region) const;
155    
156     /**
157 jgs 82 \brief
158     Copy the specified region from the given value.
159 jgs 102 \param value - Input - Data object to copy from.
160     \param region - Input - Region to copy.
161 jgs 82 */
162 woo409 757 ESCRIPT_DLL_API
163 jgs 102 virtual
164     void
165     setSlice(const DataAbstract* value,
166     const DataArrayView::RegionType& region);
167    
168 jgs 82 /**
169 jgs 123 \brief
170     Archive the underlying data values to the file referenced
171     by ofstream. A count of the number of values expected to be written
172     is provided as a cross-check.
173    
174     The return value indicates success (0) or otherwise (1).
175     */
176 woo409 757 ESCRIPT_DLL_API
177 jgs 123 int
178     archiveData(std::ofstream& archiveFile,
179     const DataArrayView::ValueType::size_type noValues) const;
180    
181     /**
182     \brief
183     Extract the number of values specified by noValues from the file
184     referenced by ifstream to the underlying data structure.
185    
186     The return value indicates success (0) or otherwise (1).
187     */
188 woo409 757 ESCRIPT_DLL_API
189 jgs 123 int
190     extractData(std::ifstream& archiveFile,
191     const DataArrayView::ValueType::size_type noValues);
192    
193 gross 580 /**
194     \brief
195 ksteube 775 Computes a symmetric matrix (A + AT) / 2
196    
197     \param ev - Output - symmetric matrix
198    
199     */
200 gross 800 ESCRIPT_DLL_API
201 ksteube 775 virtual void
202     symmetric(DataAbstract* ev);
203    
204     /**
205     \brief
206     Computes a nonsymmetric matrix (A - AT) / 2
207    
208     \param ev - Output - nonsymmetric matrix
209    
210     */
211 gross 800 ESCRIPT_DLL_API
212 ksteube 775 virtual void
213     nonsymmetric(DataAbstract* ev);
214    
215     /**
216     \brief
217     Computes the trace of a matrix
218    
219     \param ev - Output - trace of matrix
220    
221     */
222 gross 800 ESCRIPT_DLL_API
223 ksteube 775 virtual void
224 gross 800 trace(DataAbstract* ev, int axis_offset);
225 ksteube 775
226     /**
227     \brief
228     Transpose each data point of this Data object around the given axis.
229    
230     \param ev - Output - transpose of matrix
231    
232     */
233 gross 800 ESCRIPT_DLL_API
234 ksteube 775 virtual void
235     transpose(DataAbstract* ev, int axis_offset);
236    
237     /**
238     \brief
239 gross 804 swaps components axis0 and axis1
240 gross 800
241     \param ev - Output - swapped components
242    
243     */
244     ESCRIPT_DLL_API
245     virtual void
246 gross 804 swapaxes(DataAbstract* ev, int axis0, int axis1);
247 gross 800
248    
249     /**
250     \brief
251 gross 580 solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
252    
253     \param ev - Output - eigenvalues in increasing order at each data point
254    
255     */
256 woo409 757 ESCRIPT_DLL_API
257 gross 580 virtual void
258     eigenvalues(DataAbstract* ev);
259    
260     /**
261     \brief
262     solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V
263    
264     \param ev - Output - eigenvalues in increasing order at each data point
265     \param V - Output - corresponding eigenvectors. They are normalized such that their length is one
266     and the first nonzero component is positive.
267     \param tol - Input - eigenvalue with relative distance tol are treated as equal.
268    
269     */
270    
271 woo409 757 ESCRIPT_DLL_API
272 gross 580 virtual void
273     eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);
274    
275    
276 jgs 82 protected:
277    
278     private:
279     //
280 jgs 102 // the actual data
281 jgs 82 DataArrayView::ValueType m_data;
282 jgs 102
283 jgs 82 };
284    
285     } // end of namespace
286     #endif

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26