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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/esys2/escript/src/Data/escriptcpp.cpp revision 119 by jgs, Tue Apr 12 04:45:05 2005 UTC trunk/escript/src/escriptcpp.cpp revision 1118 by gross, Tue Apr 24 08:55:04 2007 UTC
# Line 1  Line 1 
1  //$Id$  //$Id$
2  /*=============================================================================  /*
3     ************************************************************
4   ******************************************************************************   *          Copyright 2006 by ACcESS MNRF                   *
5   *                                                                            *   *                                                          *
6   *       COPYRIGHT ACcESS 2004 -  All Rights Reserved                         *   *              http://www.access.edu.au                    *
7   *                                                                            *   *       Primary Business: Queensland, Australia            *
8   * This software is the property of ACcESS.  No part of this code             *   *  Licensed under the Open Software License version 3.0    *
9   * may be copied in any form or by any means without the expressed written    *   *     http://www.opensource.org/licenses/osl-3.0.php       *
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   ******************************************************************************  #include "Data.h"
15    #include "FunctionSpace.h"
16  ******************************************************************************/  #include "FunctionSpaceFactory.h"
17    #include "DataFactory.h"
18  #include "escript/Data/Data.h"  #include "AbstractContinuousDomain.h"
19  #include "escript/Data/FunctionSpace.h"  #include "AbstractDomain.h"
20  #include "escript/Data/FunctionSpaceFactory.h"  #include "Utils.h"
21  #include "escript/Data/DataFactory.h"  #include "AbstractSystemMatrix.h"
22  #include "escript/Data/AbstractContinuousDomain.h"  #include "DataVector.h"
23  #include "escript/Data/AbstractDomain.h"  
24  #include "esysUtils/esysExceptionTranslator.h"  #include "esysUtils/esysExceptionTranslator.h"
25    
26  #include <boost/python.hpp>  #include <boost/python.hpp>
# Line 28  Line 28 
28  #include <boost/python/def.hpp>  #include <boost/python/def.hpp>
29  #include <boost/python/object.hpp>  #include <boost/python/object.hpp>
30  #include <boost/python/tuple.hpp>  #include <boost/python/tuple.hpp>
31                                                                                                                                              #include <boost/python/numeric.hpp>
 using namespace boost::python;  
   
 /**  
    @memo  
    escript is the python module that contains the interfaces  
    to the C++ side of escript.  
   
    @version 1.0.0  
32    
33     @doc  using namespace boost::python;
   
    Class Description:  
    Data  
   
    Class Limitations:  
    None  
   
    Class Conditions of Use:  
    None  
34    
35     Throws:  /*! \mainpage Esys Documentation
36     None   *
37     * \version 1.0.0
38  */   *
39     * - \ref escript
40     *
41     * - \ref esys_exception "Esys Exception"
42     *
43     * - \ref finley
44     *
45     * - <a href=http://iservo.edu.au/esys/epydoc/index.html>Python module documentation (epydoc generated)</a>
46     *
47     */
48    
49    /*! \page escript Escript
50     * Escript is the python module that contains the interfaces
51     * to the C++ side of escript.
52     *
53     * \version 1.0.0
54     *
55     * \section class_desc Class Description:
56     * Data
57     *
58     * \section class_limits Class Limitations:
59     * None
60     *
61     * \section class_conds Class Conditions of Use:
62     * None
63     *
64     * \section class_throws Throws:
65     * None
66     *
67     */
68    
69  BOOST_PYTHON_MODULE(escriptcpp)  BOOST_PYTHON_MODULE(escriptcpp)
70  {  {
71      def("setNumberOfThreads",escript::setNumberOfThreads);
72      def("getNumberOfThreads",escript::getNumberOfThreads);
73      def("releaseUnusedMemory",escript::releaseUnusedMemory);
74    
75    
76    //    //
77    // Interface for AbstractDomain    // Interface for AbstractDomain
78    //    //
79    class_<escript::AbstractDomain>("Domain",no_init)    class_<escript::AbstractDomain>("Domain",no_init)
80         .def("setTagMap",&escript::AbstractDomain::setTagMap)
81         .def("getTag",&escript::AbstractDomain::getTag)
82         .def("isValidTagName",&escript::AbstractDomain::isValidTagName)
83         .def("showTagNames",&escript::AbstractDomain::showTagNames)
84       .def("getX",&escript::AbstractDomain::getX)       .def("getX",&escript::AbstractDomain::getX)
85       .def("getNormal",&escript::AbstractDomain::getNormal)       .def("getNormal",&escript::AbstractDomain::getNormal)
86       .def("getSize",&escript::AbstractDomain::getSize)       .def("getSize",&escript::AbstractDomain::getSize)
87         .def("saveVTK",&escript::AbstractDomain::saveVTK)
88         .def("saveDX",&escript::AbstractDomain::saveDX)
89       .def(self == self)       .def(self == self)
90       .def(self != self);       .def(self != self);
91    
# Line 78  BOOST_PYTHON_MODULE(escriptcpp) Line 100  BOOST_PYTHON_MODULE(escriptcpp)
100    //    //
101    class_<escript::FunctionSpace>("FunctionSpace",init<>())    class_<escript::FunctionSpace>("FunctionSpace",init<>())
102       .def("getDim",&escript::FunctionSpace::getDim)       .def("getDim",&escript::FunctionSpace::getDim)
103         .def("getDomain",&escript::FunctionSpace::getDomain,return_internal_reference<>())
104       .def("getX",&escript::FunctionSpace::getX)       .def("getX",&escript::FunctionSpace::getX)
105       .def("getNormal",&escript::FunctionSpace::getNormal)       .def("getNormal",&escript::FunctionSpace::getNormal)
106       .def("getSize",&escript::FunctionSpace::getSize)       .def("getSize",&escript::FunctionSpace::getSize)
107       .def("toString",&escript::FunctionSpace::toString)       .def("setTags",&escript::FunctionSpace::setTags)
108         .def("getTagFromDataPointNo",&escript::FunctionSpace::getTagFromDataPointNo)
109         .def("__str__",&escript::FunctionSpace::toString)
110       .def(self == self)       .def(self == self)
111       .def(self != self);       .def(self != self);
   
112    //    //
113    // Interface for Data    // Interface for Data
114    //    //
115    class_<escript::Data>("Data",init<>())    class_<escript::Data>("Data","TEST DOCUMENTATION",init<>())
116      // various constructors for Data objects      // various constructors for Data objects
117      .def(init<const numeric::array&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))      .def(init<const numeric::array&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))
118      .def(init<const object&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))      .def(init<const object&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))
# Line 97  BOOST_PYTHON_MODULE(escriptcpp) Line 121  BOOST_PYTHON_MODULE(escriptcpp)
121      .def(init<const escript::Data&>())      .def(init<const escript::Data&>())
122      // Note for Lutz, Need to specify the call policy in order to return a      // Note for Lutz, Need to specify the call policy in order to return a
123      // reference. In this case return_internal_reference.      // reference. In this case return_internal_reference.
124      .def("toString",&escript::Data::toString)      .def("__str__",&escript::Data::toString)
125      .def("getDomain",&escript::Data::getDomain,return_internal_reference<>())      .def("getDomain",&escript::Data::getDomain,return_internal_reference<>())
126      .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_internal_reference<>())      .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_internal_reference<>())
127      .def("isEmpty",&escript::Data::isEmpty)      .def("isEmpty",&escript::Data::isEmpty)
128        .def("isProtected",&escript::Data::isProtected)
129        .def("setProtection",&escript::Data::setProtection)
130      .def("getShape",&escript::Data::getShapeTuple)      .def("getShape",&escript::Data::getShapeTuple)
131      .def("getRank",&escript::Data::getDataPointRank)      .def("getRank",&escript::Data::getDataPointRank)
132        .def("dump",&escript::Data::dump)
133      .def("copyWithMask",&escript::Data::copyWithMask)      .def("copyWithMask",&escript::Data::copyWithMask)
134      .def("setTaggedValue",&escript::Data::setTaggedValue)      .def("setTaggedValue",&escript::Data::setTaggedValue)
135      .def("setRefValue",&escript::Data::setRefValue)      .def("setTaggedValue",&escript::Data::setTaggedValueByName)
136      .def("getRefValue",&escript::Data::getRefValue)      .def("getNumberOfDataPoints",&escript::Data::getNumDataPoints)
137      .def("expand",&escript::Data::expand)      .def("expand",&escript::Data::expand)
138      .def("tag",&escript::Data::tag)      .def("tag",&escript::Data::tag)
139        .def("copy",&escript::Data::copy)
140        .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToPyObject)
141        .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToArray)
142        .def("setValueOfDataPoint",&escript::Data::setValueOfDataPoint)
143        .def("getValueOfDataPoint",&escript::Data::getValueOfDataPoint)
144        .def("getValueOfGlobalDataPoint",&escript::Data::getValueOfGlobalDataPoint)
145        .def("setToZero",&escript::Data::setToZero)
146        .def("interpolate",&escript::Data::interpolate)
147        .def("minGlobalDataPoint",&escript::Data::minGlobalDataPoint)
148      .def("saveDX",&escript::Data::saveDX)      .def("saveDX",&escript::Data::saveDX)
149      .def("saveVTK",&escript::Data::saveVTK)      .def("saveVTK",&escript::Data::saveVTK)
150      .def("wherePositive",&escript::Data::wherePositive)      .def("getTagNumber",&escript::Data::getTagNumber)
     .def("whereNegative",&escript::Data::whereNegative)  
     .def("whereNonNegative",&escript::Data::whereNonNegative)  
     .def("whereNonPositive",&escript::Data::whereNonPositive)  
     .def("whereZero",&escript::Data::whereZero)  
     .def("whereNonZero",&escript::Data::whereNonZero)  
     // Unary functions for Data  
     .def("interpolate",&escript::Data::interpolate)  
     .def("grad",&escript::Data::gradOn)  
     .def("grad",&escript::Data::grad)  
     .def("convertToNumArray",&escript::Data::convertToNumArray)  
151      .def("archiveData",&escript::Data::archiveData)      .def("archiveData",&escript::Data::archiveData)
152      .def("extractData",&escript::Data::extractData)      .def("extractData",&escript::Data::extractData)
153      .def("integrate",&escript::Data::integrate)      // Unary functions for Data
154      .def("transpose",&escript::Data::transpose)      .def("_interpolate",&escript::Data::interpolate)
155      .def("trace",&escript::Data::trace)      .def("_grad",&escript::Data::gradOn)
156      .def("sin",&escript::Data::sin)      .def("_grad",&escript::Data::grad)
157      .def("cos",&escript::Data::cos)      .def("_transpose",&escript::Data::transpose)
158      .def("tan",&escript::Data::tan)      .def("_trace",&escript::Data::trace)
159      .def("log",&escript::Data::log)      .def("_maxval",&escript::Data::maxval)
160      .def("ln",&escript::Data::ln)      .def("_minval",&escript::Data::minval)
161      .def("Lsup",&escript::Data::Lsup)      .def("_wherePositive",&escript::Data::wherePositive)
162      .def("Linf",&escript::Data::Lsup)      .def("_whereNegative",&escript::Data::whereNegative)
163      .def("sup",&escript::Data::sup)      .def("_whereNonNegative",&escript::Data::whereNonNegative)
164      .def("inf",&escript::Data::inf)      .def("_whereNonPositive",&escript::Data::whereNonPositive)
165        .def("_whereZero",&escript::Data::whereZero,(arg("tol")=0.0))
166        .def("_whereNonZero",&escript::Data::whereNonZero,(arg("tol")=0.0))
167        .def("_erf",&escript::Data::erf)
168        .def("_sin",&escript::Data::sin)
169        .def("_cos",&escript::Data::cos)
170        .def("_tan",&escript::Data::tan)
171        .def("_asin",&escript::Data::asin)
172        .def("_acos",&escript::Data::acos)
173        .def("_atan",&escript::Data::atan)
174        .def("_sinh",&escript::Data::sinh)
175        .def("_cosh",&escript::Data::cosh)
176        .def("_tanh",&escript::Data::tanh)
177        .def("_asinh",&escript::Data::asinh)
178        .def("_acosh",&escript::Data::acosh)
179        .def("_atanh",&escript::Data::atanh)
180        .def("_exp",&escript::Data::exp)
181        .def("_sqrt",&escript::Data::sqrt)
182        .def("_log10",&escript::Data::log10)
183        .def("_log",&escript::Data::log)
184        .def("_sign",&escript::Data::sign)
185        .def("_symmetric",&escript::Data::symmetric)
186        .def("_nonsymmetric",&escript::Data::nonsymmetric)
187        .def("_trace",&escript::Data::trace)
188        .def("_swap_axes",&escript::Data::swapaxes)
189        .def("_eigenvalues",&escript::Data::eigenvalues)
190        .def("_eigenvalues_and_eigenvectors",&escript::Data::eigenvalues_and_eigenvectors,(arg("tol")=1.e-13))
191        // functions returning a single real number:
192        .def("_Lsup",&escript::Data::Lsup)
193        .def("_sup",&escript::Data::sup)
194        .def("_inf",&escript::Data::inf)
195        .def("_integrate",&escript::Data::integrate)
196    
197        // following implements the python abs operator
198      .def("__abs__",&escript::Data::abs)      .def("__abs__",&escript::Data::abs)
     .def("exp",&escript::Data::exp)  
     .def("sqrt",&escript::Data::sqrt)  
     .def("maxval",&escript::Data::maxval)  
     .def("minval",&escript::Data::minval)  
     .def("length",&escript::Data::length)  
     .def("sign",&escript::Data::sign)  
199      // following implements the python "-" negation operator      // following implements the python "-" negation operator
200      .def("__neg__",&escript::Data::neg)      .def("__neg__",&escript::Data::neg)
201      // following implements the python "+" identity operator      // following implements the python "+" identity operator
# Line 154  BOOST_PYTHON_MODULE(escriptcpp) Line 207  BOOST_PYTHON_MODULE(escriptcpp)
207      // following two functions implement the python ** operator      // following two functions implement the python ** operator
208      .def("__pow__",&escript::Data::powO)      .def("__pow__",&escript::Data::powO)
209      .def("__pow__",&escript::Data::powD)      .def("__pow__",&escript::Data::powD)
210        .def("__rpow__",&escript::Data::rpowO)
211      // NOTE:: The order of these declarations is important. Anything      // NOTE:: The order of these declarations is important. Anything
212      // declared before the generic declaration isn't found so the generic      // declared before the generic declaration isn't found so the generic
213      // version will be called.      // version will be called.
     .def(self += other<object>())  
     .def(self += self)  
214      .def(self + other<object>())      .def(self + other<object>())
215      .def(other<object>() + self)      .def(other<object>() + self)
216      .def(self + self)      .def(self + self)
217      .def(self -= other<object>())      .def(self += other<object>())
218      .def(self -= self)      .def(self += self)
219    
220      .def(self - other<object>())      .def(self - other<object>())
221      .def(other<object>() - self)      .def(other<object>() - self)
222      .def(self - self)      .def(self - self)
223      .def(self *= other<object>())      .def(self -= other<object>())
224      .def(self *= self)      .def(self -= self)
225    
226      .def(self * other<object>())      .def(self * other<object>())
227      .def(other<object>() * self)      .def(other<object>() * self)
228      .def(self * self)      .def(self * self)
229      .def(self /= other<object>())      .def(self *= other<object>())
230      .def(self /= self)      .def(self *= self)
231    
232      .def(self / other<object>())      .def(self / other<object>())
233      .def(other<object>() / self)      .def(other<object>() / self)
234      .def(self / self)      .def(self / self)
235        .def(self /= other<object>())
236        .def(self /= self)
237      // Need scope resolution due to a bug either in the compiler or      // Need scope resolution due to a bug either in the compiler or
238      // the boost code. This calls operator << for Data.      // the boost code. This calls operator << for Data.
239      .def(self_ns::str(self));      .def(self_ns::str(self));
# Line 185  BOOST_PYTHON_MODULE(escriptcpp) Line 242  BOOST_PYTHON_MODULE(escriptcpp)
242    // Factory methods for function space    // Factory methods for function space
243    //    //
244    def("ContinuousFunction",escript::continuousFunction);    def("ContinuousFunction",escript::continuousFunction);
245      def("ReducedContinuousFunction",escript::reducedContinuousFunction);
246    def("Function",escript::function);    def("Function",escript::function);
247      def("ReducedFunction",escript::reducedFunction);
248    def("FunctionOnBoundary",escript::functionOnBoundary);    def("FunctionOnBoundary",escript::functionOnBoundary);
249      def("ReducedFunctionOnBoundary",escript::reducedFunctionOnBoundary);
250    def("FunctionOnContactZero",escript::functionOnContactZero);    def("FunctionOnContactZero",escript::functionOnContactZero);
251      def("ReducedFunctionOnContactZero",escript::reducedFunctionOnContactZero);
252    def("FunctionOnContactOne",escript::functionOnContactOne);    def("FunctionOnContactOne",escript::functionOnContactOne);
253      def("ReducedFunctionOnContactOne",escript::reducedFunctionOnContactOne);
254    def("Solution",escript::solution);    def("Solution",escript::solution);
255    def("ReducedSolution",escript::reducedSolution);    def("ReducedSolution",escript::reducedSolution);
256    def("DiracDeltaFunction",escript::diracDeltaFunction);    def("DiracDeltaFunction",escript::diracDeltaFunction);
# Line 196  BOOST_PYTHON_MODULE(escriptcpp) Line 258  BOOST_PYTHON_MODULE(escriptcpp)
258    //    //
259    // Factory methods for Data    // Factory methods for Data
260    //    //
261      def("load",escript::load);
262      def("loadIsConfigured",escript::loadConfigured);
263    def("Scalar",escript::Scalar,    def("Scalar",escript::Scalar,
264        (arg("value")=0.0,        (arg("value")=0.0,
265         arg("what")=escript::FunctionSpace(),         arg("what")=escript::FunctionSpace(),
# Line 218  BOOST_PYTHON_MODULE(escriptcpp) Line 282  BOOST_PYTHON_MODULE(escriptcpp)
282         arg("expanded")=false));         arg("expanded")=false));
283    
284    //    //
285      // Binary operators
286      //
287      def("C_GeneralTensorProduct",escript::C_GeneralTensorProduct,
288          (arg("arg0")=escript::Data(),
289           arg("arg1")=escript::Data(),
290           arg("axis_offset")=0,
291           arg("transpose")=0));
292    
293      //
294    // Interface for AbstractSystemMatrix    // Interface for AbstractSystemMatrix
295    //    //
296    class_<escript::AbstractSystemMatrix>("Operator",init<>())    class_<escript::AbstractSystemMatrix>("Operator",init<>())
# Line 225  BOOST_PYTHON_MODULE(escriptcpp) Line 298  BOOST_PYTHON_MODULE(escriptcpp)
298       .def("solve",&escript::AbstractSystemMatrix::solve)       .def("solve",&escript::AbstractSystemMatrix::solve)
299       .def("of",&escript::AbstractSystemMatrix::vectorMultiply)       .def("of",&escript::AbstractSystemMatrix::vectorMultiply)
300       .def("saveMM",&escript::AbstractSystemMatrix::saveMM)       .def("saveMM",&escript::AbstractSystemMatrix::saveMM)
301       .def("setValue",&escript::AbstractSystemMatrix::setValue)       .def("saveHB",&escript::AbstractSystemMatrix::saveHB)
302       .def("resetSolver",&escript::AbstractSystemMatrix::resetSolver)       .def("resetValues",&escript::AbstractSystemMatrix::resetValues)
303       .def(self*other<escript::Data>());       .def(self*other<escript::Data>());
304    
305    //    //

Legend:
Removed from v.119  
changed lines
  Added in v.1118

  ViewVC Help
Powered by ViewVC 1.1.26