/[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

revision 1796 by jfenwick, Wed Sep 17 01:45:46 2008 UTC revision 2548 by jfenwick, Mon Jul 20 06:20:06 2009 UTC
# Line 1  Line 1 
1    
 /* $Id$ */  
   
2  /*******************************************************  /*******************************************************
3   *  *
4   *           Copyright 2003-2007 by ACceSS MNRF  * Copyright (c) 2003-2009 by University of Queensland
5   *       Copyright 2007 by University of Queensland  * Earth Systems Science Computational Center (ESSCC)
6   *  * http://www.uq.edu.au/esscc
7   *                http://esscc.uq.edu.au  *
8   *        Primary Business: Queensland, Australia  * Primary Business: Queensland, Australia
9   *  Licensed under the Open Software License version 3.0  * Licensed under the Open Software License version 3.0
10   *     http://www.opensource.org/licenses/osl-3.0.php  * http://www.opensource.org/licenses/osl-3.0.php
11   *  *
12   *******************************************************/  *******************************************************/
13    
14    
15  #include "Data.h"  #include "Data.h"
16  #include "FunctionSpace.h"  #include "FunctionSpace.h"
# Line 23  Line 22 
22  #include "AbstractSystemMatrix.h"  #include "AbstractSystemMatrix.h"
23  #include "AbstractTransportProblem.h"  #include "AbstractTransportProblem.h"
24  #include "DataVector.h"  #include "DataVector.h"
25    #include "paso/Paso_MPI.h"
26    #include "EscriptParams.h"
27    #include "TestDomain.h"
28    
29    
30  extern "C" {  extern "C" {
31  #include "escript/blocktimer.h"  #include "esysUtils/blocktimer.h"
32  }  }
33    
34  #include "esysUtils/esysExceptionTranslator.h"  #include "esysUtils/esysExceptionTranslator.h"
35    
36    #include <boost/version.hpp>
37  #include <boost/python.hpp>  #include <boost/python.hpp>
38  #include <boost/python/module.hpp>  #include <boost/python/module.hpp>
39  #include <boost/python/def.hpp>  #include <boost/python/def.hpp>
40  #include <boost/python/object.hpp>  #include <boost/python/object.hpp>
41  #include <boost/python/tuple.hpp>  #include <boost/python/tuple.hpp>
42  #include <boost/python/numeric.hpp>  #include <boost/python/numeric.hpp>
43    #include <boost/smart_ptr.hpp>
44    #include <boost/version.hpp>
45    
46  using namespace boost::python;  using namespace boost::python;
47    
48  /*! \mainpage Esys Documentation  /*! \mainpage Esys Documentation
49   *   *
50   * \version 1.0.0   * \version 2.9.0
51   *   *
52   * - \ref escript   * - \ref escript
53   *   *
# Line 49  using namespace boost::python; Line 55  using namespace boost::python;
55   *   *
56   * - \ref finley   * - \ref finley
57   *   *
58   * - <a href=http://iservo.edu.au/esys/epydoc/index.html>Python module documentation (epydoc generated)</a>   * - <a href="../../epydoc/index.html">Python module documentation (epydoc generated)</a>
59   *   *
60   */   */
61    
# Line 57  using namespace boost::python; Line 63  using namespace boost::python;
63   * Escript is the python module that contains the interfaces   * Escript is the python module that contains the interfaces
64   * to the C++ side of escript.   * to the C++ side of escript.
65   *   *
66   * \version 1.0.0   *
67   *   *
68   * \section class_desc Class Description:   * \section class_desc Class Description:
69   * Data   * Data
# Line 75  using namespace boost::python; Line 81  using namespace boost::python;
81    
82  BOOST_PYTHON_MODULE(escriptcpp)  BOOST_PYTHON_MODULE(escriptcpp)
83  {  {
84    // This feature was added in boost v1.34
85    #if ((BOOST_VERSION/100)%1000 > 34) || (BOOST_VERSION/100000 >1)
86    //#if ((BOOST_VERSION/100)%1000) > 34
87      // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
88      #if BOOST_VERSION > 103399
89      docstring_options docopt(true, true, false);
90      #endif
91    #endif
92    
93    def("setNumberOfThreads",escript::setNumberOfThreads);    def("setNumberOfThreads",escript::setNumberOfThreads);
94    def("getNumberOfThreads",escript::getNumberOfThreads);    def("getNumberOfThreads",escript::getNumberOfThreads);
95    def("releaseUnusedMemory",escript::releaseUnusedMemory);    def("releaseUnusedMemory",escript::releaseUnusedMemory);
# Line 85  BOOST_PYTHON_MODULE(escriptcpp) Line 100  BOOST_PYTHON_MODULE(escriptcpp)
100    def("blocktimer_time",blocktimer_time);    def("blocktimer_time",blocktimer_time);
101    def("getVersion",escript::getSvnVersion);    def("getVersion",escript::getSvnVersion);
102    def("printParallelThreadCounts",escript::printParallelThreadCnt);    def("printParallelThreadCounts",escript::printParallelThreadCnt);
103      def("getMPISizeWorld",escript::getMPISizeWorld);
104      def("getMPIRankWorld",escript::getMPIRankWorld);
105      def("MPIBarrierWorld",escript::MPIBarrierWorld);
106      def("getMPIWorldMax",escript::getMPIWorldMax);
107      def("getMachinePrecision",escript::getMachinePrecision);
108      def("getMaxFloat",escript::getMaxFloat);
109    //    //
110    // Interface for AbstractDomain    // Interface for AbstractDomain
111    //    //
112    class_<escript::AbstractDomain>("Domain",no_init)    class_<escript::AbstractDomain, escript::Domain_ptr>("Domain","Base class for all domains.",no_init)
113         .def("getStatus",&escript::AbstractDomain::getStatus)
114       .def("setTagMap",&escript::AbstractDomain::setTagMap)       .def("setTagMap",&escript::AbstractDomain::setTagMap)
115       .def("getTag",&escript::AbstractDomain::getTag)       .def("getTag",&escript::AbstractDomain::getTag)
116       .def("isValidTagName",&escript::AbstractDomain::isValidTagName)       .def("isValidTagName",&escript::AbstractDomain::isValidTagName)
117       .def("showTagNames",&escript::AbstractDomain::showTagNames)       .def("showTagNames",&escript::AbstractDomain::showTagNames)
118       .def("getX",&escript::AbstractDomain::getX)       .def("getX",&escript::AbstractDomain::getX)
119         .def("getDim",&escript::AbstractDomain::getDim)
120       .def("getNormal",&escript::AbstractDomain::getNormal)       .def("getNormal",&escript::AbstractDomain::getNormal)
121       .def("getSize",&escript::AbstractDomain::getSize)       .def("getSize",&escript::AbstractDomain::getSize)
122       .def("saveVTK",&escript::AbstractDomain::saveVTK)       .def("saveVTK",&escript::AbstractDomain::saveVTK)
123         .def("dump",&escript::AbstractDomain::dump)
124       .def("saveDX",&escript::AbstractDomain::saveDX)       .def("saveDX",&escript::AbstractDomain::saveDX)
125       .def("getMPISize",&escript::AbstractDomain::getMPISize)       .def("getMPISize",&escript::AbstractDomain::getMPISize)
126       .def("getMPIRank",&escript::AbstractDomain::getMPIRank)       .def("getMPIRank",&escript::AbstractDomain::getMPIRank)
127         .def("MPIBarrier",&escript::AbstractDomain::MPIBarrier)
128         .def("onMasterProcessor",&escript::AbstractDomain::onMasterProcessor)
129    
130       .def(self == self)       .def(self == self)
131       .def(self != self);       .def(self != self);
# Line 109  BOOST_PYTHON_MODULE(escriptcpp) Line 133  BOOST_PYTHON_MODULE(escriptcpp)
133    //    //
134    // Interface for AbstractContinuousDomain    // Interface for AbstractContinuousDomain
135    //    //
136    class_<escript::AbstractContinuousDomain, bases<escript::AbstractDomain> >("ContinuousDomain",no_init)    class_<escript::AbstractContinuousDomain, bases<escript::AbstractDomain> >("ContinuousDomain","Class representing continuous domains",no_init)
137         .def("getSystemMatrixTypeId",&escript::AbstractContinuousDomain::getSystemMatrixTypeId);         .def("getSystemMatrixTypeId",&escript::AbstractContinuousDomain::getSystemMatrixTypeId)
138           .def("getTransportTypeId",&escript::AbstractContinuousDomain::getTransportTypeId);
139    
140    
141      //
142      // Interface for TestDomain
143      //
144      class_ <escript::TestDomain, bases<escript::AbstractDomain> >("TestDomain", "Test Class for domains with no structure. May be removed from future releases without notice.", init<int,int>());
145    
146      // This is the only python visible way to get a TestDomain
147      def("getTestDomainFunctionSpace",&escript::getTestDomainFunctionSpace, "For testing only. May be removed without notice.");
148    
149    //    //
150    // Interface for FunctionSpace    // Interface for FunctionSpace
151    //    //
152    class_<escript::FunctionSpace> fs_definer("FunctionSpace",init<>());    class_<escript::FunctionSpace> fs_definer("FunctionSpace","",init<>());   // Doco goes in the empty string param
153    fs_definer.def("getDim",&escript::FunctionSpace::getDim);    fs_definer.def("getDim",&escript::FunctionSpace::getDim);
154    fs_definer.def("getDomain",&escript::FunctionSpace::getDomain,  //   fs_definer.def("getDomain",&escript::FunctionSpace::getDomain,
155                   return_internal_reference<>());  //                  return_internal_reference<>());
156      fs_definer.def("getDomain",&escript::FunctionSpace::getDomainPython);
157    fs_definer.def("getX",&escript::FunctionSpace::getX);    fs_definer.def("getX",&escript::FunctionSpace::getX);
158    fs_definer.def("getNormal",&escript::FunctionSpace::getNormal);    fs_definer.def("getNormal",&escript::FunctionSpace::getNormal);
159    fs_definer.def("getSize",&escript::FunctionSpace::getSize);    fs_definer.def("getSize",&escript::FunctionSpace::getSize);
# Line 133  BOOST_PYTHON_MODULE(escriptcpp) Line 168  BOOST_PYTHON_MODULE(escriptcpp)
168    //    //
169    // Interface for Data    // Interface for Data
170    //    //
171    class_<escript::Data>("Data","TEST DOCUMENTATION",init<>())    class_<escript::Data>("Data","Represents a collection of datapoints. It is used to store the values of a function. For more details please consult the c++ class documentation.",init<>() )
172      // various constructors for Data objects      // various constructors for Data objects
     .def(init<const numeric::array&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))  
173      .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")))
174      .def(init<const double, const tuple&, optional<const escript::FunctionSpace&, bool> >(args("value","shape","what","expand")))      .def(init<const double, const tuple&, optional<const escript::FunctionSpace&, bool> >(args("value","shape","what","expand")))
175      .def(init<const escript::Data&, const escript::FunctionSpace&>(args("value","what")))      .def(init<const escript::Data&, const escript::FunctionSpace&>(args("value","what")))
# Line 143  BOOST_PYTHON_MODULE(escriptcpp) Line 177  BOOST_PYTHON_MODULE(escriptcpp)
177      // 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
178      // reference. In this case return_internal_reference.      // reference. In this case return_internal_reference.
179      .def("__str__",&escript::Data::toString)      .def("__str__",&escript::Data::toString)
180      .def("getDomain",&escript::Data::getDomain,return_internal_reference<>())      .def("getDomain",&escript::Data::getDomainPython)
181      .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_internal_reference<>())      .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_value_policy<copy_const_reference>())
182      .def("isEmpty",&escript::Data::isEmpty)      .def("isEmpty",&escript::Data::isEmpty)
183      .def("isProtected",&escript::Data::isProtected)      .def("isProtected",&escript::Data::isProtected)
184      .def("setProtection",&escript::Data::setProtection)      .def("setProtection",&escript::Data::setProtection)
185      .def("getShape",&escript::Data::getShapeTuple)      .def("getShape",&escript::Data::getShapeTuple)
186      .def("getRank",&escript::Data::getDataPointRank)      .def("getRank",&escript::Data::getDataPointRank)
187      .def("dump",&escript::Data::dump)      .def("dump",&escript::Data::dump)
188        .def("toListOfTuples",&escript::Data::toListOfTuples, (arg("scalarastuple")=true))
189      .def("copyWithMask",&escript::Data::copyWithMask)      .def("copyWithMask",&escript::Data::copyWithMask)
190      .def("setTaggedValue",&escript::Data::setTaggedValue)      .def("setTaggedValue",&escript::Data::setTaggedValue)
191      .def("setTaggedValue",&escript::Data::setTaggedValueByName)      .def("setTaggedValue",&escript::Data::setTaggedValueByName)
192      .def("getNumberOfDataPoints",&escript::Data::getNumDataPoints)      .def("getNumberOfDataPoints",&escript::Data::getNumDataPoints)
193      .def("isExpanded",&escript::Data::isExpanded)      .def("isExpanded",&escript::Data::isExpanded)
194      .def("isTagged",&escript::Data::isTagged)      .def("isTagged",&escript::Data::isTagged)
195        .def("isConstant",&escript::Data::isConstant)
196        .def("isLazy",&escript::Data::isLazy)
197        .def("isReady",&escript::Data::isReady)
198      .def("expand",&escript::Data::expand)      .def("expand",&escript::Data::expand)
199      .def("tag",&escript::Data::tag)      .def("tag",&escript::Data::tag)
200        .def("resolve",&escript::Data::resolve)
201      .def("copy",&escript::Data::copy)      .def("copy",&escript::Data::copy)
202        .def("copy",&escript::Data::copySelf)
203        .def("delay",&escript::Data::delay)
204      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToPyObject)      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToPyObject)
205      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToArray)      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToArray)
206      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPoint)      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPoint)
207      .def("getValueOfDataPoint",&escript::Data::getValueOfDataPoint)      .def("getTupleForDataPoint",&escript::Data::getValueOfDataPointAsTuple)
208      .def("getValueOfGlobalDataPoint",&escript::Data::getValueOfGlobalDataPoint)      .def("getTupleForGlobalDataPoint",&escript::Data::getValueOfGlobalDataPointAsTuple)
209      .def("setToZero",&escript::Data::setToZero)      .def("setToZero",&escript::Data::setToZero)
210      .def("interpolate",&escript::Data::interpolate)      .def("interpolate",&escript::Data::interpolate)
211      .def("minGlobalDataPoint",&escript::Data::minGlobalDataPoint)      .def("minGlobalDataPoint",&escript::Data::minGlobalDataPoint)
212        .def("maxGlobalDataPoint",&escript::Data::maxGlobalDataPoint)
213      .def("saveDX",&escript::Data::saveDX)      .def("saveDX",&escript::Data::saveDX)
214      .def("saveVTK",&escript::Data::saveVTK)      .def("saveVTK",&escript::Data::saveVTK)
215      .def("getTagNumber",&escript::Data::getTagNumber)      .def("getTagNumber",&escript::Data::getTagNumber)
# Line 213  BOOST_PYTHON_MODULE(escriptcpp) Line 255  BOOST_PYTHON_MODULE(escriptcpp)
255      .def("_Lsup",&escript::Data::Lsup)      .def("_Lsup",&escript::Data::Lsup)
256      .def("_sup",&escript::Data::sup)      .def("_sup",&escript::Data::sup)
257      .def("_inf",&escript::Data::inf)      .def("_inf",&escript::Data::inf)
258      .def("_integrate",&escript::Data::integrate)      .def("_integrateToTuple",&escript::Data::integrateToTuple)
259    
260      // following implements the python abs operator      // following implements the python abs operator
261      .def("__abs__",&escript::Data::abs)      .def("__abs__",&escript::Data::abs)
# Line 314  BOOST_PYTHON_MODULE(escriptcpp) Line 356  BOOST_PYTHON_MODULE(escriptcpp)
356    //    //
357    // Interface for AbstractSystemMatrix    // Interface for AbstractSystemMatrix
358    //    //
359    class_<escript::AbstractSystemMatrix>("Operator",init<>())    class_<escript::AbstractSystemMatrix>("Operator","",init<>())    // Doco goes in the empty string param
360       .def("isEmpty",&escript::AbstractSystemMatrix::isEmpty)       .def("isEmpty",&escript::AbstractSystemMatrix::isEmpty)
361       .def("solve",&escript::AbstractSystemMatrix::solve)       .def("solve",&escript::AbstractSystemMatrix::solve)
362       .def("of",&escript::AbstractSystemMatrix::vectorMultiply)       .def("of",&escript::AbstractSystemMatrix::vectorMultiply)
# Line 325  BOOST_PYTHON_MODULE(escriptcpp) Line 367  BOOST_PYTHON_MODULE(escriptcpp)
367    //    //
368    // Interface for AbstractTransportProblem    // Interface for AbstractTransportProblem
369    //    //
370    class_<escript::AbstractTransportProblem>("TransportProblem",init<>())    class_<escript::AbstractTransportProblem>("TransportProblem","",init<>())    // Doco goes in the empty string param
371       .def("isEmpty",&escript::AbstractTransportProblem::isEmpty)       .def("isEmpty",&escript::AbstractTransportProblem::isEmpty)
372       .def("solve",&escript::AbstractTransportProblem::solve)       .def("solve",&escript::AbstractTransportProblem::solve)
373       .def("setInitialValue",&escript::AbstractTransportProblem::setInitialValue)       .def("setInitialValue",&escript::AbstractTransportProblem::setInitialValue)
374       .def("insertConstraint",&escript::AbstractTransportProblem::insertConstraint)       .def("insertConstraint",&escript::AbstractTransportProblem::insertConstraint)
375       .def("reset",&escript::AbstractTransportProblem::resetTransport)       .def("reset",&escript::AbstractTransportProblem::resetTransport)
376       .def("getSafeTimeStepSize",&escript::AbstractTransportProblem::getSafeTimeStepSize);       .def("resetValues",&escript::AbstractTransportProblem::resetTransport)
377         .def("getSafeTimeStepSize",&escript::AbstractTransportProblem::getSafeTimeStepSize)
378         .def("getUnlimitedTimeStepSize",&escript::AbstractTransportProblem::getUnlimitedTimeStepSize);
379    
380      // Functions to modify global parameters
381      def("setEscriptParamInt",escript::setEscriptParamInt,
382          (arg("value")=0));
383      def("getEscriptParamInt",escript::getEscriptParamInt,
384          (arg("sentinel")=0));
385      def("listEscriptParams",escript::listEscriptParams);
386    
387    //    //
388    // Register esysExceptionTranslator    // Register esysExceptionTranslator
389    //    //
390    register_exception_translator<esysUtils::EsysException>(&esysUtils::esysExceptionTranslator);    register_exception_translator<esysUtils::EsysException>(&esysUtils::esysExceptionTranslator);
   
391  }  }

Legend:
Removed from v.1796  
changed lines
  Added in v.2548

  ViewVC Help
Powered by ViewVC 1.1.26