/[escript]/trunk/escript/src/escriptcpp.cpp
ViewVC logotype

Annotation of /trunk/escript/src/escriptcpp.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 480 - (hide annotations)
Wed Feb 1 05:15:12 2006 UTC (13 years, 7 months ago) by jgs
File size: 10940 byte(s)
rationalise #includes and forward declarations

1 jgs 102 //$Id$
2     /*=============================================================================
3    
4     ******************************************************************************
5     * *
6     * COPYRIGHT ACcESS 2004 - All Rights Reserved *
7     * *
8     * This software is the property of ACcESS. No part of this code *
9     * may be copied in any form or by any means without the expressed written *
10     * consent of ACcESS. Copying, use or modification of this software *
11     * by any unauthorised person is illegal unless that *
12     * person has a software license agreement with ACcESS. *
13     * *
14     ******************************************************************************
15    
16     ******************************************************************************/
17    
18 jgs 474 #include "Data.h"
19     #include "DataVariable.h"
20     #include "FunctionSpace.h"
21     #include "FunctionSpaceFactory.h"
22     #include "DataFactory.h"
23     #include "AbstractContinuousDomain.h"
24     #include "AbstractDomain.h"
25     #include "Utils.h"
26 jgs 480 #include "AbstractSystemMatrix.h"
27 jgs 474
28 jgs 468 #include "esysExceptionTranslator.h"
29 jgs 102
30     #include <boost/python.hpp>
31     #include <boost/python/module.hpp>
32     #include <boost/python/def.hpp>
33     #include <boost/python/object.hpp>
34     #include <boost/python/tuple.hpp>
35 gross 285 #include <boost/python/numeric.hpp>
36    
37 jgs 102 using namespace boost::python;
38    
39 jgs 121 /*! \mainpage Esys Documentation
40     *
41     * \version 1.0.0
42     *
43     * - \ref escript
44     *
45     * - \ref esys_exception "Esys Exception"
46     *
47     * - \ref finley
48     *
49 cochrane 358 * - <a href=http://iservo.edu.au/esys/epydoc/index.html>Python module documentation (epydoc generated)</a>
50 jgs 122 *
51 jgs 121 */
52 jgs 102
53 jgs 121 /*! \page escript Escript
54     * Escript is the python module that contains the interfaces
55     * to the C++ side of escript.
56     *
57     * \version 1.0.0
58     *
59     * \section class_desc Class Description:
60     * Data
61     *
62     * \section class_limits Class Limitations:
63     * None
64     *
65     * \section class_conds Class Conditions of Use:
66     * None
67     *
68     * \section class_throws Throws:
69     * None
70     *
71     */
72 jgs 102
73     BOOST_PYTHON_MODULE(escriptcpp)
74     {
75 gross 391 def("setNumberOfThreads",escript::setNumberOfThreads);
76     def("getNumberOfThreads",escript::getNumberOfThreads);
77 jgs 102
78     //
79     // Interface for AbstractDomain
80     //
81     class_<escript::AbstractDomain>("Domain",no_init)
82     .def("getX",&escript::AbstractDomain::getX)
83     .def("getNormal",&escript::AbstractDomain::getNormal)
84     .def("getSize",&escript::AbstractDomain::getSize)
85 jgs 153 .def("saveVTK",&escript::AbstractDomain::saveVTK)
86     .def("saveDX",&escript::AbstractDomain::saveDX)
87 jgs 102 .def(self == self)
88     .def(self != self);
89    
90     //
91     // Interface for AbstractContinuousDomain
92     //
93     class_<escript::AbstractContinuousDomain, bases<escript::AbstractDomain> >("ContinuousDomain",no_init)
94     .def("getSystemMatrixTypeId",&escript::AbstractContinuousDomain::getSystemMatrixTypeId);
95    
96     //
97     // Interface for FunctionSpace
98     //
99     class_<escript::FunctionSpace>("FunctionSpace",init<>())
100     .def("getDim",&escript::FunctionSpace::getDim)
101 jgs 153 .def("getDomain",&escript::FunctionSpace::getDomain,return_internal_reference<>())
102 jgs 102 .def("getX",&escript::FunctionSpace::getX)
103     .def("getNormal",&escript::FunctionSpace::getNormal)
104     .def("getSize",&escript::FunctionSpace::getSize)
105 jgs 149 .def("getTagFromDataPointNo",&escript::FunctionSpace::getTagFromDataPointNo)
106 jgs 147 .def("__str__",&escript::FunctionSpace::toString)
107 jgs 102 .def(self == self)
108     .def(self != self);
109    
110     //
111 jgs 122 // Interface for DataVariable
112     //
113     class_<escript::DataVariable>("DataVariable",init<>())
114     .def(init<escript::Data*>())
115     .def("evaluate",&escript::DataVariable::evaluate)
116     .def("sum",&escript::DataVariable::sum)
117     .def("diff",&escript::DataVariable::diff);
118    
119     //
120 jgs 102 // Interface for Data
121     //
122 jgs 149 class_<escript::Data>("Data","TEST DOCUMENTATION",init<>())
123 jgs 102 // various constructors for Data objects
124     .def(init<const numeric::array&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))
125     .def(init<const object&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))
126     .def(init<const double, const tuple&, optional<const escript::FunctionSpace&, bool> >(args("value","shape","what","expand")))
127     .def(init<const escript::Data&, const escript::FunctionSpace&>(args("value","what")))
128     .def(init<const escript::Data&>())
129     // Note for Lutz, Need to specify the call policy in order to return a
130     // reference. In this case return_internal_reference.
131 gross 285 .def("__str__",&escript::Data::toString)
132 jgs 102 .def("getDomain",&escript::Data::getDomain,return_internal_reference<>())
133     .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_internal_reference<>())
134     .def("isEmpty",&escript::Data::isEmpty)
135     .def("getShape",&escript::Data::getShapeTuple)
136     .def("getRank",&escript::Data::getDataPointRank)
137     .def("copyWithMask",&escript::Data::copyWithMask)
138     .def("setTaggedValue",&escript::Data::setTaggedValue)
139 jgs 110 .def("setRefValue",&escript::Data::setRefValue)
140     .def("getRefValue",&escript::Data::getRefValue)
141 jgs 119 .def("expand",&escript::Data::expand)
142     .def("tag",&escript::Data::tag)
143 jgs 126 .def("copy",&escript::Data::copy)
144 jgs 117 .def("convertToNumArray",&escript::Data::convertToNumArray)
145 jgs 121 .def("convertToNumArrayFromSampleNo",&escript::Data::convertToNumArrayFromSampleNo)
146     .def("convertToNumArrayFromDPNo",&escript::Data::convertToNumArrayFromDPNo)
147 jgs 126 .def("fillFromNumArray",&escript::Data::fillFromNumArray)
148 gross 285 .def("interpolate",&escript::Data::interpolate)
149     .def("mindp",&escript::Data::mindp)
150    
151     .def("saveDX",&escript::Data::saveDX)
152     .def("saveVTK",&escript::Data::saveVTK)
153 jgs 149 .def("getTagNumber",&escript::Data::getTagNumber)
154 jgs 119 .def("archiveData",&escript::Data::archiveData)
155     .def("extractData",&escript::Data::extractData)
156 gross 285 // Unary functions for Data
157     .def("_interpolate",&escript::Data::interpolate)
158     .def("_grad",&escript::Data::gradOn)
159     .def("_grad",&escript::Data::grad)
160     .def("_transpose",&escript::Data::transpose)
161     .def("_trace",&escript::Data::trace)
162     .def("_maxval",&escript::Data::maxval)
163     .def("_minval",&escript::Data::minval)
164     .def("_wherePositive",&escript::Data::wherePositive)
165     .def("_whereNegative",&escript::Data::whereNegative)
166     .def("_whereNonNegative",&escript::Data::whereNonNegative)
167     .def("_whereNonPositive",&escript::Data::whereNonPositive)
168     .def("_whereZero",&escript::Data::whereZero)
169     .def("_whereNonZero",&escript::Data::whereNonZero)
170     .def("_sin",&escript::Data::sin)
171     .def("_cos",&escript::Data::cos)
172     .def("_tan",&escript::Data::tan)
173     .def("_asin",&escript::Data::asin)
174     .def("_acos",&escript::Data::acos)
175     .def("_atan",&escript::Data::atan)
176     .def("_sinh",&escript::Data::sinh)
177     .def("_cosh",&escript::Data::cosh)
178     .def("_tanh",&escript::Data::tanh)
179     .def("_asinh",&escript::Data::asinh)
180     .def("_acosh",&escript::Data::acosh)
181     .def("_atanh",&escript::Data::atanh)
182     .def("_exp",&escript::Data::exp)
183     .def("_sqrt",&escript::Data::sqrt)
184     .def("_log10",&escript::Data::log10)
185     .def("_log",&escript::Data::log)
186     .def("_sign",&escript::Data::sign)
187     // functions returning a single real number:
188     .def("_Lsup",&escript::Data::Lsup)
189     .def("_sup",&escript::Data::sup)
190     .def("_inf",&escript::Data::inf)
191     .def("_integrate",&escript::Data::integrate)
192    
193     // following implements the python abs operator
194 jgs 108 .def("__abs__",&escript::Data::abs)
195 jgs 102 // following implements the python "-" negation operator
196     .def("__neg__",&escript::Data::neg)
197     // following implements the python "+" identity operator
198     .def("__pos__",&escript::Data::pos)
199     // following two functions implement the python [] operator
200     .def("__getitem__",&escript::Data::getItem)
201     .def("__setitem__",&escript::Data::setItemO)
202     .def("__setitem__",&escript::Data::setItemD)
203     // following two functions implement the python ** operator
204     .def("__pow__",&escript::Data::powO)
205     .def("__pow__",&escript::Data::powD)
206     // NOTE:: The order of these declarations is important. Anything
207     // declared before the generic declaration isn't found so the generic
208     // version will be called.
209     .def(self + other<object>())
210     .def(other<object>() + self)
211     .def(self + self)
212 gross 285 .def(self += other<object>())
213     .def(self += self)
214    
215 jgs 102 .def(self - other<object>())
216     .def(other<object>() - self)
217     .def(self - self)
218 gross 285 .def(self -= other<object>())
219     .def(self -= self)
220    
221 jgs 102 .def(self * other<object>())
222     .def(other<object>() * self)
223     .def(self * self)
224 gross 285 .def(self *= other<object>())
225     .def(self *= self)
226    
227 jgs 102 .def(self / other<object>())
228     .def(other<object>() / self)
229     .def(self / self)
230 gross 285 .def(self /= other<object>())
231     .def(self /= self)
232 jgs 102 // Need scope resolution due to a bug either in the compiler or
233     // the boost code. This calls operator << for Data.
234     .def(self_ns::str(self));
235    
236     //
237     // Factory methods for function space
238     //
239     def("ContinuousFunction",escript::continuousFunction);
240     def("Function",escript::function);
241     def("FunctionOnBoundary",escript::functionOnBoundary);
242     def("FunctionOnContactZero",escript::functionOnContactZero);
243     def("FunctionOnContactOne",escript::functionOnContactOne);
244     def("Solution",escript::solution);
245     def("ReducedSolution",escript::reducedSolution);
246     def("DiracDeltaFunction",escript::diracDeltaFunction);
247    
248     //
249     // Factory methods for Data
250     //
251     def("Scalar",escript::Scalar,
252     (arg("value")=0.0,
253     arg("what")=escript::FunctionSpace(),
254     arg("expanded")=false));
255     def("Vector",escript::Vector,
256     (arg("value")=0.0,
257     arg("what")=escript::FunctionSpace(),
258     arg("expanded")=false));
259     def("Tensor",escript::Tensor,
260     (arg("value")=0.0,
261     arg("what")=escript::FunctionSpace(),
262     arg("expanded")=false));
263     def("Tensor3",escript::Tensor3,
264     (arg("value")=0.0,
265     arg("what")=escript::FunctionSpace(),
266     arg("expanded")=false));
267     def("Tensor4",escript::Tensor4,
268     (arg("value")=0.0,
269     arg("what")=escript::FunctionSpace(),
270     arg("expanded")=false));
271    
272     //
273     // Interface for AbstractSystemMatrix
274     //
275     class_<escript::AbstractSystemMatrix>("Operator",init<>())
276     .def("isEmpty",&escript::AbstractSystemMatrix::isEmpty)
277     .def("solve",&escript::AbstractSystemMatrix::solve)
278     .def("of",&escript::AbstractSystemMatrix::vectorMultiply)
279     .def("saveMM",&escript::AbstractSystemMatrix::saveMM)
280 jgs 123 .def("saveHB",&escript::AbstractSystemMatrix::saveHB)
281 jgs 149 .def("resetValues",&escript::AbstractSystemMatrix::resetValues)
282 jgs 102 .def(self*other<escript::Data>());
283    
284     //
285     // Register esysExceptionTranslator
286     //
287     register_exception_translator<esysUtils::EsysException>(&esysUtils::esysExceptionTranslator);
288    
289     }

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26