/[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 2064 by jfenwick, Thu Nov 20 04:06:34 2008 UTC revision 3031 by jfenwick, Thu May 27 04:04:33 2010 UTC
# Line 1  Line 1 
1    
2  /*******************************************************  /*******************************************************
3  *  *
4  * Copyright (c) 2003-2008 by University of Queensland  * Copyright (c) 2003-2010 by University of Queensland
5  * Earth Systems Science Computational Center (ESSCC)  * Earth Systems Science Computational Center (ESSCC)
6  * http://www.uq.edu.au/esscc  * http://www.uq.edu.au/esscc
7  *  *
# Line 24  Line 24 
24  #include "DataVector.h"  #include "DataVector.h"
25  #include "paso/Paso_MPI.h"  #include "paso/Paso_MPI.h"
26  #include "EscriptParams.h"  #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>
 #include <boost/python/numeric.hpp>  
42  #include <boost/smart_ptr.hpp>  #include <boost/smart_ptr.hpp>
43  #include <boost/version.hpp>  #include <boost/version.hpp>
44    
# Line 45  using namespace boost::python; Line 46  using namespace boost::python;
46    
47  /*! \mainpage Esys Documentation  /*! \mainpage Esys Documentation
48   *   *
49   * \version 1.0.0   * \version 3.0.0
50   *   *
51   * - \ref escript   * - \ref escript
52   *   *
# Line 53  using namespace boost::python; Line 54  using namespace boost::python;
54   *   *
55   * - \ref finley   * - \ref finley
56   *   *
57   * - <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>
58   *   *
59   */   */
60    
# Line 61  using namespace boost::python; Line 62  using namespace boost::python;
62   * Escript is the python module that contains the interfaces   * Escript is the python module that contains the interfaces
63   * to the C++ side of escript.   * to the C++ side of escript.
64   *   *
65   * \version 1.0.0   *
66   *   *
67   * \section class_desc Class Description:   * \section class_desc Class Description:
68   * Data   * Data
# Line 79  using namespace boost::python; Line 80  using namespace boost::python;
80    
81  BOOST_PYTHON_MODULE(escriptcpp)  BOOST_PYTHON_MODULE(escriptcpp)
82  {  {
 // This feature was added in boost v1.34  
 #if ((BOOST_VERSION/100)%1000 > 33) || (BOOST_VERSION/100000 >1)  
 //#if ((BOOST_VERSION/100)%1000) > 33  
   // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures  
   docstring_options docopt(true, true, false);  
 #endif  
83    
84    def("setNumberOfThreads",escript::setNumberOfThreads);    #if BOOST_VERSION >= 103500
85    def("getNumberOfThreads",escript::getNumberOfThreads);  // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
86      docstring_options docopt(true,true,false);
87      #endif
88    
89      def("setNumberOfThreads",escript::setNumberOfThreads,"Use of this method is strongly discouraged.");
90      def("getNumberOfThreads",escript::getNumberOfThreads,"Return the maximum number of threads"
91    " available to OpenMP.");
92    def("releaseUnusedMemory",escript::releaseUnusedMemory);    def("releaseUnusedMemory",escript::releaseUnusedMemory);
93    def("blocktimer_initialize",blocktimer_initialize);    def("blocktimer_initialize",blocktimer_initialize);
94    def("blocktimer_reportSortByName",blocktimer_reportSortByName);    def("blocktimer_reportSortByName",blocktimer_reportSortByName);
95    def("blocktimer_reportSortByTime",blocktimer_reportSortByTime);    def("blocktimer_reportSortByTime",blocktimer_reportSortByTime);
96    def("blocktimer_increment",blocktimer_increment);    def("blocktimer_increment",blocktimer_increment);
97    def("blocktimer_time",blocktimer_time);    def("blocktimer_time",blocktimer_time);
98    def("getVersion",escript::getSvnVersion);    def("getVersion",escript::getSvnVersion,"This method will only report accurate version numbers for clean checkouts.");
99    def("printParallelThreadCounts",escript::printParallelThreadCnt);    def("printParallelThreadCounts",escript::printParallelThreadCnt);
100    def("getMPISizeWorld",escript::getMPISizeWorld);    def("getMPISizeWorld",escript::getMPISizeWorld,"Return number of MPI processes in the job.");
101    def("getMPIRankWorld",escript::getMPIRankWorld);    def("getMPIRankWorld",escript::getMPIRankWorld,"Return the rank of this process in the MPI World.");
102      def("MPIBarrierWorld",escript::MPIBarrierWorld,"Wait until all MPI processes have reached this point.");
103      def("getMPIWorldMax",escript::getMPIWorldMax,"\nEach MPI process calls this function with a"
104    " value for arg1. The maximum value is computed and returned.\n\n:rtype: int");
105      def("getMPIWorldSum",escript::getMPIWorldSum,"\nEach MPI process calls this function with a"
106    " value for arg1. The values are added up and the total value is returned.\n\n:rtype: int");
107      def("getMachinePrecision",escript::getMachinePrecision);
108      def("getMaxFloat",escript::getMaxFloat);
109      def("_saveDataCSV",escript::saveDataCSV, (args("filename","arg","sep","csep"), arg("append")=false),
110    "Saves data objects passed in a python dictionary to a file.\n"
111    "The data objects must be over the same domain and be able to be interpolated to the same FunctionSpace.\n"
112    "If one of the dictionary keys is named ``mask``, then only samples where ``mask`` has a positive\n"
113    "value will be written to the file.\n\n"
114    "A header line giving the names of each column will be output first.\n"
115    "The keys given in the dictionary will be used to name columns.\n"
116    "Then the data will be output, one line per sample (for all data).\n"
117    "That is, items in each column will be printed in the same order.\n"
118    "So you can be sure that values in the same row correspond to the same input value.\n"
119    "\n:param filename:\n:type filename: ``string``\n"
120    ":param arg: dictionary of named `Data` objects. If one is called ``mask`` it must be scalar data."
121    "\n:type arg: ``dict``\n"
122    ":param sep:separator for columns (defaults to \", \"\n:type sep:``string``\n"
123    ":param csep:separator for fields within data object (defaults to \"_\"\n:type csep:``string``\n"
124    ":param append: If True, write to the end of ``filename``\n:type append: ``string``\n");
125    
126    
127    //    //
128    // Interface for AbstractDomain    // Interface for AbstractDomain
129    //    //
130    class_<escript::AbstractDomain, escript::Domain_ptr>("Domain","Base class for all domains.",no_init)    class_<escript::AbstractDomain, escript::Domain_ptr>("Domain","Base class for all domains.",no_init)
131       .def("setTagMap",&escript::AbstractDomain::setTagMap)       .def("getStatus",&escript::AbstractDomain::getStatus,"The status of a domain changes whenever the domain is modified\n\n:rtype: int")
132       .def("getTag",&escript::AbstractDomain::getTag)       .def("setTagMap",&escript::AbstractDomain::setTagMap,args("name","tag"),
133       .def("isValidTagName",&escript::AbstractDomain::isValidTagName)  "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
134       .def("showTagNames",&escript::AbstractDomain::showTagNames)  ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")
135       .def("getX",&escript::AbstractDomain::getX)       .def("getTag",&escript::AbstractDomain::getTag,args("name"),":return: tag id for "
136       .def("getDim",&escript::AbstractDomain::getDim)  "``name``\n:rtype: ``string``")
137       .def("getNormal",&escript::AbstractDomain::getNormal)       .def("isValidTagName",&escript::AbstractDomain::isValidTagName,args("name"),
138       .def("getSize",&escript::AbstractDomain::getSize)  ":return: True is ``name`` corresponds to a tag\n:rtype: ``bool``")
139       .def("saveVTK",&escript::AbstractDomain::saveVTK)       .def("showTagNames",&escript::AbstractDomain::showTagNames,":return: A space separated list of tag names\n:rtype: ``string``")
140       .def("saveDX",&escript::AbstractDomain::saveDX)       .def("getX",&escript::AbstractDomain::getX,":rtype: `Data`\n:return: Locations in the"
141       .def("getMPISize",&escript::AbstractDomain::getMPISize)  "`Domain`. FunctionSpace is chosen appropriately")
142       .def("getMPIRank",&escript::AbstractDomain::getMPIRank)       .def("getDim",&escript::AbstractDomain::getDim,":rtype: `int`\n:return: Spatial dimension of the `Domain`")
143       .def("MPIBarrier",&escript::AbstractDomain::MPIBarrier)       .def("getNormal",&escript::AbstractDomain::getNormal,":rtype: `escript`\n:return: Boundary normals")
144       .def("onMasterProcessor",&escript::AbstractDomain::onMasterProcessor)       .def("getSize",&escript::AbstractDomain::getSize,":return: the local size of samples. The function space is chosen appropriately\n:rtype: `Data`")
145         .def("saveVTK",&escript::AbstractDomain::saveVTK,args("filename","arg", "metadata"
146    , "metadata_schema"),
147    ":param filename: \n:type filename: ``string``\n:param arg: items to be added"
148    "\n:type arg: ``dict``\n:param metadata: string representing some meta data to be added\n:type metadata: ``string``"
149    "\n:param metadata_schema: schema type for metadata\n:type metadata_schema: ``string``")
150         .def("dump",&escript::AbstractDomain::dump,args("filename"),"Dumps the domain to a file"
151    ":param filename:\n:type filename: string")
152         .def("saveDX",&escript::AbstractDomain::saveDX,args("filename","arg"),"Saves a dictonary of Data objects to an OpenDX input file.\n\n:param filename:\n:type filename: ``string``"
153    "\n:param arg:\n:type arg: `dict`")
154         .def("getMPISize",&escript::AbstractDomain::getMPISize,":return: the number of processes used for this `Domain`\n:rtype: ``int``")
155         .def("getMPIRank",&escript::AbstractDomain::getMPIRank,":return: the rank of this process\n:rtype: ``int``")
156         .def("MPIBarrier",&escript::AbstractDomain::MPIBarrier,"Wait until all processes have reached this point")
157         .def("onMasterProcessor",&escript::AbstractDomain::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`")
158    
159       .def(self == self)       .def(self == self)
160       .def(self != self);       .def(self != self);
# Line 126  BOOST_PYTHON_MODULE(escriptcpp) Line 163  BOOST_PYTHON_MODULE(escriptcpp)
163    // Interface for AbstractContinuousDomain    // Interface for AbstractContinuousDomain
164    //    //
165    class_<escript::AbstractContinuousDomain, bases<escript::AbstractDomain> >("ContinuousDomain","Class representing continuous domains",no_init)    class_<escript::AbstractContinuousDomain, bases<escript::AbstractDomain> >("ContinuousDomain","Class representing continuous domains",no_init)
166         .def("getSystemMatrixTypeId",&escript::AbstractContinuousDomain::getSystemMatrixTypeId)         .def("getSystemMatrixTypeId",&escript::AbstractContinuousDomain::getSystemMatrixTypeId,
167         .def("getTransportTypeId",&escript::AbstractContinuousDomain::getTransportTypeId);  args("solver", "preconditioner", "package", "symmetry"),
168    ":return: the identifier of the matrix type to be used for the global stiffness matrix "
169    "when a particular solver package and symmetric matrix is used.\n"
170    ":rtype: int")
171           .def("getTransportTypeId",&escript::AbstractContinuousDomain::getTransportTypeId,
172    args("solver", "preconditioner", "package", "symmetry"));
173    
174    
175      //
176      // Interface for TestDomain
177      //
178      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>());
179    
180      // This is the only python visible way to get a TestDomain
181      def("getTestDomainFunctionSpace",&escript::getTestDomainFunctionSpace, args("dpps",
182     "samples"),
183    "For testing only. May be removed without notice.");
184    
185    //    //
186    // Interface for FunctionSpace    // Interface for FunctionSpace
187    //    //
188    class_<escript::FunctionSpace> fs_definer("FunctionSpace","",init<>());   // Doco goes in the empty string param    class_<escript::FunctionSpace> fs_definer("FunctionSpace","A FunctionSpace describes which points from the `Domain` to use to represent functions.",init<>());    // Doco goes in the empty string param
189    fs_definer.def("getDim",&escript::FunctionSpace::getDim);    fs_definer.def("getDim",&escript::FunctionSpace::getDim,":return: the spatial dimension of the underlying domain.\n:rtype: int");
190  //   fs_definer.def("getDomain",&escript::FunctionSpace::getDomain,  //   fs_definer.def("getDomain",&escript::FunctionSpace::getDomain,
191  //                  return_internal_reference<>());  //                  return_internal_reference<>());
192    fs_definer.def("getDomain",&escript::FunctionSpace::getDomainPython);    fs_definer.def("getDomain",&escript::FunctionSpace::getDomainPython,":return: the underlying `Domain` for this FunctionSpace.\n:rtype: `Domain`");
193    fs_definer.def("getX",&escript::FunctionSpace::getX);    fs_definer.def("getX",&escript::FunctionSpace::getX,"\n:return: a function whose values are its input coordinates. ie an identity function.\n:rtype: `Data`");
194    fs_definer.def("getNormal",&escript::FunctionSpace::getNormal);    fs_definer.def("getNormal",&escript::FunctionSpace::getNormal,":return: the surface normal field.\n\n:rtype: `Data`");
195    fs_definer.def("getSize",&escript::FunctionSpace::getSize);    fs_definer.def("getSize",&escript::FunctionSpace::getSize,":return: sample size\n:rtype: `Data`");
196    fs_definer.def("setTags",&escript::FunctionSpace::setTags);    fs_definer.def("setTags",&escript::FunctionSpace::setTags,args("newtag","mask"),
197    "Set tags according to a mask\n\n:param newtag: tag number to set\n:type newtag: non-zero ``int``\n:param mask: Samples which correspond to positive values in the mask will be set to ``newtag``.\n:type mask: scalar `Data`");
198      fs_definer.def("setTags",&escript::FunctionSpace::setTagsByString,args("newtag","mask"),
199    "Set tags according to a mask\n\n:param newtag: tag name to set\n:type newtag: string\n:param mask: Samples which correspond to positive values in the mask will be set to ``newtag``.\n:type mask: scalar `Data`");
200    fs_definer.def("getTagFromDataPointNo",    fs_definer.def("getTagFromDataPointNo",
201                   &escript::FunctionSpace::getTagFromDataPointNo);                   &escript::FunctionSpace::getTagFromDataPointNo,":return: the tag associated with the given sample number.\n:rtype: int");
202    fs_definer.def("getReferenceIDFromDataPointNo", &escript::FunctionSpace::getReferenceIDFromDataPointNo);    fs_definer.def("getReferenceIDFromDataPointNo", &escript::FunctionSpace::getReferenceIDFromDataPointNo,args("dataPointNo"),":return: the reference number associated with ``dataPointNo``\n:rtype: int ");
203    fs_definer.def("getListOfTags",&escript::FunctionSpace::getListOfTags);    fs_definer.def("getListOfTags",&escript::FunctionSpace::getListOfTags,":return: a list of the tags used in this function space\n:rtype: ``list``");
204      fs_definer.def("getApproximationOrder", &escript::FunctionSpace::getApproximationOrder,":return: the approximation order refering to the maximum degree of a polynomial which can be represenred exactly in interplation and/or integration.\n:rtype: ``int``");
205    fs_definer.def("__str__", &escript::FunctionSpace::toString);    fs_definer.def("__str__", &escript::FunctionSpace::toString);
206    fs_definer.def(self == self);    fs_definer.def(self == self);
207    fs_definer.def(self != self);    fs_definer.def(self != self);
# Line 153  BOOST_PYTHON_MODULE(escriptcpp) Line 210  BOOST_PYTHON_MODULE(escriptcpp)
210    //    //
211    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<>() )    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<>() )
212      // various constructors for Data objects      // various constructors for Data objects
     .def(init<const numeric::array&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))  
213      .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")))
214      .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")))
215      .def(init<const escript::Data&, const escript::FunctionSpace&>(args("value","what")))      .def(init<const escript::Data&, const escript::FunctionSpace&>(args("value","what")))
# Line 161  BOOST_PYTHON_MODULE(escriptcpp) Line 217  BOOST_PYTHON_MODULE(escriptcpp)
217      // 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
218      // reference. In this case return_internal_reference.      // reference. In this case return_internal_reference.
219      .def("__str__",&escript::Data::toString)      .def("__str__",&escript::Data::toString)
220  //     .def("getDomain",&escript::Data::getDomain,return_internal_reference<>())      .def("getDomain",&escript::Data::getDomainPython,":rtype: `Domain`")
221      .def("getDomain",&escript::Data::getDomainPython)      .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_value_policy<copy_const_reference>(),":rtype: `FunctionSpace`")
222      .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_value_policy<copy_const_reference>())      .def("isEmpty",&escript::Data::isEmpty,"Is this object an instance of ``DataEmpty``\n\n:rtype: ``bool``\n:note: This is not the same thing as asking if the object contains datapoints.")
223      .def("isEmpty",&escript::Data::isEmpty)      .def("isProtected",&escript::Data::isProtected,"Can this instance be modified.\n:rtype: ``bool``")
224      .def("isProtected",&escript::Data::isProtected)      .def("setProtection",&escript::Data::setProtection,"Disallow modifications to this data object\n\n:note: This method does not allow you to undo protection.")
225      .def("setProtection",&escript::Data::setProtection)      .def("getShape",&escript::Data::getShapeTuple,"\nReturns the shape of the datapoints in this object as a python tuple. Scalar data has the shape ``()``\n\n:rtype: ``tuple``")
226      .def("getShape",&escript::Data::getShapeTuple)      .def("getRank",&escript::Data::getDataPointRank,":return: the number of indicies required to address a component of a datapoints\n:rtype: positive ``int``")
227      .def("getRank",&escript::Data::getDataPointRank)      .def("dump",&escript::Data::dump,args("fileName"),"Save the data as a netCDF file\n\n:param fileName: \n:type fileName: ``string``")
228      .def("dump",&escript::Data::dump)      .def("toListOfTuples",&escript::Data::toListOfTuples, (arg("scalarastuple")=false),
229      .def("copyWithMask",&escript::Data::copyWithMask)  "Return the datapoints of this object in a list. Each datapoint is stored as a tuple.\n\n"
230      .def("setTaggedValue",&escript::Data::setTaggedValue)  ":param scalarastuple: if True, scalar data will be wrapped as a tuple."
231      .def("setTaggedValue",&escript::Data::setTaggedValueByName)  " True => [(0), (1), (2)]; False => [0, 1, 2]")
232      .def("getNumberOfDataPoints",&escript::Data::getNumDataPoints)      .def("copyWithMask",&escript::Data::copyWithMask,args("other","mask"),
233      .def("isExpanded",&escript::Data::isExpanded)  "Selectively copy values from ``other`` `Data`."
234      .def("isTagged",&escript::Data::isTagged)  "Datapoints which correspond to postive values in ``mask`` will be copied from ``other``\n"
235      .def("isConstant",&escript::Data::isConstant)  "\n:param other: source of values\n"
236      .def("isLazy",&escript::Data::isLazy)  ":type other: `Data`\n:param mask:\n:type mask: Scalar `Data`")
237      .def("isReady",&escript::Data::isReady)      .def("setTaggedValue",&escript::Data::setTaggedValue,args("tagKey","value"),
238      .def("expand",&escript::Data::expand)  "Set the value of tagged Data.\n\n:param tagKey: tag to update\n:type tagKey: ``int``\n")
239      .def("tag",&escript::Data::tag)      .def("setTaggedValue",&escript::Data::setTaggedValueByName,args("name","value"),":param name: tag to update\n:type name: ``string``\n"
240      .def("resolve",&escript::Data::resolve)  ":param value: value to set tagged data to\n:type value: ``object`` which acts like an array, ``tuple`` or ``list``\n")
241      .def("copy",&escript::Data::copy)      .def("getNumberOfDataPoints",&escript::Data::getNumDataPoints,":rtype: ``int``\n:return: Number of datapoints in the object")
242      .def("copy",&escript::Data::copySelf,return_value_policy<manage_new_object>())      .def("isExpanded",&escript::Data::isExpanded,":rtype: ``bool``\n:return: True if this ``Data`` is expanded.")
243      .def("delay",&escript::Data::delay)      .def("isTagged",&escript::Data::isTagged,":rtype: ``bool``\n:return: True if this ``Data`` is expanded.")
244      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToPyObject)      .def("isConstant",&escript::Data::isConstant,":rtype: ``bool``\n:return: True if this ``Data`` is an instance of ``DataConstant``\n:note: This does not mean the data is immutable.")
245        .def("isLazy",&escript::Data::isLazy,":rtype: ``bool``\n:return: True if this ``Data`` is lazy.")
246        .def("isReady",&escript::Data::isReady,":rtype: ``bool``\n:return: True if this ``Data`` is not lazy.")
247        .def("expand",&escript::Data::expand,"Convert the data to expanded representation if it is not expanded already.")
248        .def("tag",&escript::Data::tag,"Convert data to tagged representation if it is not already tagged or expanded")
249        .def("resolve",&escript::Data::resolve,"Convert the data to non-lazy representation.")
250        .def("copy",&escript::Data::copy,args("other"),"Make this object a copy of ``other``\n"
251    "\n:note: The two objects will act independently from now on. That is, changing ``other`` "
252    "after this call will not change this object and vice versa.")
253        .def("copy",&escript::Data::copySelf,":note: In the no argument form, a new object will be returned which is an independent copy of this object.")
254        .def("delay",&escript::Data::delay,"Convert this object into lazy representation")
255        .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToPyObject,args("dataPointNo","value"))
256      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToArray)      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToArray)
257      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPoint)      .def("setValueOfDataPoint",&escript::Data::setValueOfDataPoint,"\nModify the value of a single datapoint.\n\n:param dataPointNo:\n"
258      .def("getValueOfDataPoint",&escript::Data::getValueOfDataPoint)  ":type dataPointNo: int\n:param value: \n:type value: ``float`` or an object which acts like an array, ``tuple`` or ``list``\n:warning: Use of this operation is discouraged. It prevents some optimisations from operating.")
259      .def("getValueOfGlobalDataPoint",&escript::Data::getValueOfGlobalDataPoint)      .def("getTupleForDataPoint",&escript::Data::getValueOfDataPointAsTuple,args("dataPointNo"),
260      .def("setToZero",&escript::Data::setToZero)  ":return: Value of the specified datapoint\n:rtype: ``tuple``\n:param dataPointNo: datapoint to access\n:type dataPointNo: ``int``")
261      .def("interpolate",&escript::Data::interpolate)      .def("getTupleForGlobalDataPoint",&escript::Data::getValueOfGlobalDataPointAsTuple,args("procNo","dataPointNo"),"Get a specific datapoint from a specific process\n\n"
262      .def("minGlobalDataPoint",&escript::Data::minGlobalDataPoint)  ":rtype: ``tuple``\n:param procNo: MPI rank of the process\n:type procNo: positive ``int``"
263      .def("saveDX",&escript::Data::saveDX)  "\n:param dataPointNo: datapoint to access\n:type dataPointNo: int")
264      .def("saveVTK",&escript::Data::saveVTK)      .def("setToZero",&escript::Data::setToZero,"After this call the object will store values of the same shape as before but all components will be zero.")
265      .def("getTagNumber",&escript::Data::getTagNumber)      .def("interpolate",&escript::Data::interpolate,args("functionspace"),"Interpolate this object's values into a new functionspace.")
266        .def("interpolateTable", &escript::Data::interpolateFromTable2DP,
267    (arg("table"),arg("Amin"),arg("Astep"), arg("B"), arg("Bmin"), arg("Bstep"), arg("undef")=1.e50, arg("check_boundaries")=false),
268    "Creates a new Data object by interpolating using the source data (which are\n"
269    "looked up in ``table``)\n``A`` must be the outer dimension on the table\n\n"
270    ":param table: two dimensional collection of values\n"
271    ":param Amin: The base of locations in table\n:type Amin: float\n"
272    ":param Astep: size of gap between each item in the table\n:type Astep: float\n"
273    ":param undef: upper bound on interpolated values\n:type undef: float\n"
274    ":param B: Scalar representing the second coordinate to be mapped into the table\n"
275    ":type B: `Data`\n"
276    ":param Bmin: The base of locations in table for 2nd dimension\n:type Bmin: float\n"
277    ":param Bstep: size of gap between each item in the table for 2nd dimension\n:type Bstep: float\n"
278    ":param check_boundaries: if true, then values outside the boundaries will be rejected. If false, then boundary values will be used.\n"
279    ":raise RuntimeError(DataException): if the cordinates do not map into the table or if the interpolated value is above ``undef``"
280    "\n:rtype: `Data`"
281    )
282        .def("interpolateTable", &escript::Data::interpolateFromTable1DP,
283    (arg("table"),arg("Amin"),arg("Astep"), arg("undef")=1.e50, arg("check_boundaries")=false),
284    "Creates a new Data object by interpolating using the source data (which are\n"
285    "looked up in ``table``)\n\n"
286    ":param table: one dimensional collection of values\n"
287    ":param Amin: The base of locations in table\n:type Amin: float\n"
288    ":param Astep: size of gap between each item in the table\n:type Astep: float\n"
289    ":param undef: upper bound on interpolated values\n:type undef: float\n"
290    ":param check_boundaries: if true, then values outside the boundaries will be rejected. If false, then boundary values will be used.\n"
291    ":raise RuntimeError(DataException): if the cordinates do not map into the table or if the interpolated value is above ``undef``"
292    "\n:rtype: `Data`"
293    )
294    
295    
296        .def("minGlobalDataPoint",&escript::Data::minGlobalDataPoint,"Please consider using getInfLocator() from pdetools instead.")
297        .def("maxGlobalDataPoint",&escript::Data::maxGlobalDataPoint, "Please consider using getSupLocator() from pdetools instead.")
298        .def("saveDX",&escript::Data::saveDX,args("fileName"),"Save the object in DX format.\n\n"
299    ":param fileName: filename\n:type fileName: string")
300        .def("saveVTK",&escript::Data::saveVTK, args("fileName"),"Save the object in VTK format.\n\n"
301    ":param fileName: \n:type fileName: string")
302        .def("getTagNumber",&escript::Data::getTagNumber,args("dpno"),"Return tag number for the specified datapoint\n\n:rtype: int\n:param dpno: datapoint number\n:type dpno: int")
303      // Unary functions for Data      // Unary functions for Data
304      .def("_interpolate",&escript::Data::interpolate)      .def("_interpolate",&escript::Data::interpolate)
305      .def("_grad",&escript::Data::gradOn)      .def("_grad",&escript::Data::gradOn)
# Line 235  BOOST_PYTHON_MODULE(escriptcpp) Line 339  BOOST_PYTHON_MODULE(escriptcpp)
339      .def("_eigenvalues",&escript::Data::eigenvalues)      .def("_eigenvalues",&escript::Data::eigenvalues)
340      .def("_eigenvalues_and_eigenvectors",&escript::Data::eigenvalues_and_eigenvectors,(arg("tol")=1.e-13))      .def("_eigenvalues_and_eigenvectors",&escript::Data::eigenvalues_and_eigenvectors,(arg("tol")=1.e-13))
341      // functions returning a single real number:      // functions returning a single real number:
342      .def("_Lsup",&escript::Data::Lsup)      .def("_Lsup",&escript::Data::Lsup,":return: the Lsup-norm of the object\n:rtype: float\n:note: If the ``Data`` contains no values, zero will be returned instead.")
343      .def("_sup",&escript::Data::sup)      .def("_sup",&escript::Data::sup,":return: the maximum value over all data points.\n:rtype: float\n:note: If the ``Data`` contains no values a large negative value will be returned instead.")
344      .def("_inf",&escript::Data::inf)      .def("_inf",&escript::Data::inf,":return: minimum value over all components and all data points\n:rtype: float\n:note: If the ``Data`` contains no values a large positive value will be returned instead.")
345      .def("_integrate",&escript::Data::integrate)      .def("_integrateToTuple",&escript::Data::integrateToTuple,":return: Calculate the integral over the function space domain as a python tuple\n:rtype: tuple")
   
346      // following implements the python abs operator      // following implements the python abs operator
347      .def("__abs__",&escript::Data::abs)      .def("__abs__",&escript::Data::abs,":return: absolute value\n\n:rtype: `Data`")
348      // following implements the python "-" negation operator      // following implements the python "-" negation operator
349      .def("__neg__",&escript::Data::neg)      .def("__neg__",&escript::Data::neg, ":return: negation of the values in this object\n:rtype: `Data`")
350      // following implements the python "+" identity operator      // following implements the python "+" identity operator
351      .def("__pos__",&escript::Data::pos)      .def("__pos__",&escript::Data::pos, "\nThe unary + operator\n\n:rtype: `Data`")
352      // following two functions implement the python [] operator      // following two functions implement the python [] operator
353      .def("__getitem__",&escript::Data::getItem)      .def("__getitem__",&escript::Data::getItem,"Used by the python [] operator\n\n:rtype: `Data`")
354      .def("__setitem__",&escript::Data::setItemO)      .def("__setitem__",&escript::Data::setItemO,"Used by the python [] operator")
355      .def("__setitem__",&escript::Data::setItemD)      .def("__setitem__",&escript::Data::setItemD,"Used by the python [] operator")
356      // following two functions implement the python ** operator      // following two functions implement the python ** operator
357      .def("__pow__",&escript::Data::powO)      .def("__pow__",&escript::Data::powO,"Used by the python ** operator\n\n:rtype: `Data`")
358      .def("__pow__",&escript::Data::powD)      .def("__pow__",&escript::Data::powD)
359      .def("__rpow__",&escript::Data::rpowO)      .def("__rpow__",&escript::Data::rpowO,"\nUsed by the python ** operator\n\n:rtype: `Data`")
360      // NOTE:: The order of these declarations is important. Anything      // NOTE:: The order of these declarations is important. Anything
361      // declared before the generic declaration isn't found so the generic      // declared before the generic declaration isn't found so the generic
362      // version will be called.      // version will be called.
# Line 282  BOOST_PYTHON_MODULE(escriptcpp) Line 385  BOOST_PYTHON_MODULE(escriptcpp)
385      .def(self /= self)      .def(self /= self)
386      // Need scope resolution due to a bug either in the compiler or      // Need scope resolution due to a bug either in the compiler or
387      // the boost code. This calls operator << for Data.      // the boost code. This calls operator << for Data.
388      .def(self_ns::str(self));      .def(self_ns::str(self))
389        .def("_inverse", &escript::Data::matrixInverse, ":return: inverse of square matricies\n");
390    
391    
392    //    //
393    // Factory methods for function space    // Factory methods for function space
394    //    //
395    def("ContinuousFunction",escript::continuousFunction);    def("ContinuousFunction",escript::continuousFunction,args("domain"),
396    def("ReducedContinuousFunction",escript::reducedContinuousFunction);  ":return: a continuous FunctionSpace (overlapped node values)\n"
397    def("Function",escript::function);  ":rtype: `FunctionSpace`");
398    def("ReducedFunction",escript::reducedFunction);    def("ReducedContinuousFunction",escript::reducedContinuousFunction,args("domain"),
399    def("FunctionOnBoundary",escript::functionOnBoundary);  ":return: a continuous with reduced order FunctionSpace (overlapped node values on reduced element order)\n"
400    def("ReducedFunctionOnBoundary",escript::reducedFunctionOnBoundary);  ":rtype: `FunctionSpace`");
401    def("FunctionOnContactZero",escript::functionOnContactZero);    def("Function",escript::function,args("domain"),":return: a function `FunctionSpace`\n"
402    def("ReducedFunctionOnContactZero",escript::reducedFunctionOnContactZero);  ":rtype: `FunctionSpace`");
403    def("FunctionOnContactOne",escript::functionOnContactOne);    def("ReducedFunction",escript::reducedFunction, args("domain"),":return: a function FunctionSpace with reduced integration order\n:rtype: `FunctionSpace`");
404    def("ReducedFunctionOnContactOne",escript::reducedFunctionOnContactOne);    def("FunctionOnBoundary",escript::functionOnBoundary, args("domain"), ":return: a function on boundary FunctionSpace\n:rtype: `FunctionSpace`");
405    def("Solution",escript::solution);    def("ReducedFunctionOnBoundary",escript::reducedFunctionOnBoundary, args("domain"),
406    def("ReducedSolution",escript::reducedSolution);  ":return: a function on boundary FunctionSpace with reduced integration order\n"
407    def("DiracDeltaFunction",escript::diracDeltaFunction);  ":rtype: `FunctionSpace`");
408      def("FunctionOnContactZero",escript::functionOnContactZero, args("domain"), ":return: Return a FunctionSpace on left side of contact\n:rtype: `FunctionSpace`");
409      def("ReducedFunctionOnContactZero",escript::reducedFunctionOnContactZero, args("domain"),
410     ":return: a FunctionSpace  on left side of contact with reduced integration order\n:rtype: `FunctionSpace`");
411      def("FunctionOnContactOne",escript::functionOnContactOne, args("domain"), ":return: Return a FunctionSpace on right side of contact\n:rtype: `FunctionSpace`");
412      def("ReducedFunctionOnContactOne",escript::reducedFunctionOnContactOne, args("domain"),
413     ":return: Return a FunctionSpace on right side of contact with reduced integration order\n"
414    ":rtype: `FunctionSpace`");
415      def("Solution",escript::solution, args("domain"), ":rtype: `FunctionSpace`");
416      def("ReducedSolution",escript::reducedSolution, args("domain"), ":rtype: `FunctionSpace`");
417      def("DiracDeltaFunction",escript::diracDeltaFunction, args("domain"), ":rtype: `FunctionSpace`");
418    
419    
420    
421    
422    
423    //    //
424    // Factory methods for Data    // Factory methods for Data
425    //    //
426    def("load",escript::load);    def("load",escript::load, args("fileName","domain"), "reads Data on domain from file in netCDF format\n\n:param fileName:\n:type fileName: ``string``\n:param domain:\n:type domain: `Domain`");
427    def("loadIsConfigured",escript::loadConfigured);    def("loadIsConfigured",escript::loadConfigured,":return: True if the load function is configured.");
428    def("Scalar",escript::Scalar,    def("Scalar",escript::Scalar,
429        (arg("value")=0.0,        (arg("value")=0.0,
430         arg("what")=escript::FunctionSpace(),         arg("what")=escript::FunctionSpace(),
431         arg("expanded")=false));         arg("expanded")=false),
432    "Construct a Data object containing scalar data-points.\n\n:param value: scalar value for all points\n"
433    "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
434    ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
435    ":type expanded: ``bool``");
436    def("Vector",escript::Vector,    def("Vector",escript::Vector,
437        (arg("value")=0.0,        (arg("value")=0.0,
438         arg("what")=escript::FunctionSpace(),         arg("what")=escript::FunctionSpace(),
439         arg("expanded")=false));         arg("expanded")=false),
440    "Construct a Data object containing rank1 data-points.\n\n:param value: scalar value for all points\n"
441    "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
442    ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
443    ":type expanded: ``bool``");
444     def("Vector", escript::VectorFromObj,
445          (arg("value"),
446        arg("what")=escript::FunctionSpace(),
447        arg("expanded")=false));
448    def("Tensor",escript::Tensor,    def("Tensor",escript::Tensor,
449        (arg("value")=0.0,        (arg("value")=0.0,
450         arg("what")=escript::FunctionSpace(),         arg("what")=escript::FunctionSpace(),
451         arg("expanded")=false));         arg("expanded")=false),
452    "Construct a Data object containing rank2 data-points.\n\n:param value: scalar value for all points\n"
453    "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
454    ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
455    ":type expanded: ``bool``");
456     def("Tensor", escript::TensorFromObj,
457          (arg("value"),
458        arg("what")=escript::FunctionSpace(),
459        arg("expanded")=false));
460    def("Tensor3",escript::Tensor3,    def("Tensor3",escript::Tensor3,
461        (arg("value")=0.0,        (arg("value")=0.0,
462         arg("what")=escript::FunctionSpace(),         arg("what")=escript::FunctionSpace(),
463         arg("expanded")=false));         arg("expanded")=false),
464    "Construct a Data object containing rank3 data-points.\n\n:param value: scalar value for all points\n"
465    "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
466    ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
467    ":type expanded: ``bool``"
468    );
469     def("Tensor3", escript::Tensor3FromObj,
470          (arg("value"),
471        arg("what")=escript::FunctionSpace(),
472        arg("expanded")=false));
473    def("Tensor4",escript::Tensor4,    def("Tensor4",escript::Tensor4,
474        (arg("value")=0.0,        (arg("value")=0.0,
475         arg("what")=escript::FunctionSpace(),         arg("what")=escript::FunctionSpace(),
476         arg("expanded")=false));         arg("expanded")=false),
477    "Construct a Data object containing rank4 data-points.\n\n:param value: scalar value for all points\n"
478    "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
479    ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
480    ":type expanded: ``bool``"
481    );
482     def("Tensor4", escript::Tensor4FromObj,
483          (arg("value"),
484        arg("what")=escript::FunctionSpace(),
485        arg("expanded")=false));
486    
487    //    //
488    // Binary operators    // Binary operators
489    //    //
490    def("C_GeneralTensorProduct",escript::C_GeneralTensorProduct,    def("C_GeneralTensorProduct",escript::C_GeneralTensorProduct,
491        (arg("arg0")=escript::Data(),        (arg("arg0"),
492         arg("arg1")=escript::Data(),         arg("arg1"),
493         arg("axis_offset")=0,         arg("axis_offset")=0,
494         arg("transpose")=0));         arg("transpose")=0),
495    "Compute a tensor product of two Data objects.\n\n:rtype: `Data`\n:param arg0:\n"
496    ":param arg1:\n:param axis_offset:\n:type axis_offset: ``int``\n"
497    ":param transpose: 0: transpose neither, 1: transpose arg0, 2: transpose arg1\n"
498    ":type transpose: int");
499    
500    //    //
501    // Interface for AbstractSystemMatrix    // Interface for AbstractSystemMatrix
502    //    //
503    class_<escript::AbstractSystemMatrix>("Operator","",init<>())    // Doco goes in the empty string param    class_<escript::AbstractSystemMatrix>("Operator","",init<>())    // Doco goes in the empty string param
504       .def("isEmpty",&escript::AbstractSystemMatrix::isEmpty)       .def("isEmpty",&escript::AbstractSystemMatrix::isEmpty,":rtype: ``bool``\n"
505       .def("solve",&escript::AbstractSystemMatrix::solve)  ":return: True if matrix is empty")
506       .def("of",&escript::AbstractSystemMatrix::vectorMultiply)       .def("solve",&escript::AbstractSystemMatrix::solve, args("in","options"),
507       .def("saveMM",&escript::AbstractSystemMatrix::saveMM)  ":return: the solution *u* of the linear system *this*u=in*\n\n:param in:\n:type in: `Data`")
508       .def("saveHB",&escript::AbstractSystemMatrix::saveHB)       .def("of",&escript::AbstractSystemMatrix::vectorMultiply,args("right"),
509       .def("resetValues",&escript::AbstractSystemMatrix::resetValues)  "matrix*vector multiplication")
510         .def("saveMM",&escript::AbstractSystemMatrix::saveMM, args("fileName"),
511    "writes the matrix to a file using the Matrix Market file format")
512         .def("saveHB",&escript::AbstractSystemMatrix::saveHB, args("filename"),
513    "writes the matrix to a file using the Harwell-Boeing file format")
514         .def("resetValues",&escript::AbstractSystemMatrix::resetValues, "resets the matrix entries")
515       .def(self*other<escript::Data>());       .def(self*other<escript::Data>());
516    //    //
517    // Interface for AbstractTransportProblem    // Interface for AbstractTransportProblem
518    //    //
519    class_<escript::AbstractTransportProblem>("TransportProblem","",init<>())    // Doco goes in the empty string param    class_<escript::AbstractTransportProblem>("TransportProblem","",init<>())    // Doco goes in the empty string param
520       .def("isEmpty",&escript::AbstractTransportProblem::isEmpty)       .def("isEmpty",&escript::AbstractTransportProblem::isEmpty,":rtype: ``int``")
521       .def("solve",&escript::AbstractTransportProblem::solve)       .def("solve",&escript::AbstractTransportProblem::solve, args("u0","source","dt", "options"),
522       .def("setInitialValue",&escript::AbstractTransportProblem::setInitialValue)  "returns the solution *u* for a time step *dt>0* with initial value u0\n\n:rtype: `Data`\n"
523       .def("insertConstraint",&escript::AbstractTransportProblem::insertConstraint)  ":param source:\n:type source: `Data`")
524       .def("reset",&escript::AbstractTransportProblem::resetTransport)       .def("insertConstraint",&escript::AbstractTransportProblem::insertConstraint,
525    args("source", "q", "r","factor"),
526    "inserts constraint *u_{,t}=r* where *q>0*  into the problem using a weighting factor")
527         .def("reset",&escript::AbstractTransportProblem::resetTransport,
528    "resets the transport operator typically as they have been updated.")
529       .def("resetValues",&escript::AbstractTransportProblem::resetTransport)       .def("resetValues",&escript::AbstractTransportProblem::resetTransport)
530       .def("getSafeTimeStepSize",&escript::AbstractTransportProblem::getSafeTimeStepSize)       .def("getSafeTimeStepSize",&escript::AbstractTransportProblem::getSafeTimeStepSize)
531       .def("getUnlimitedTimeStepSize",&escript::AbstractTransportProblem::getUnlimitedTimeStepSize);       .def("getUnlimitedTimeStepSize",&escript::AbstractTransportProblem::getUnlimitedTimeStepSize);
532    
533    // Functions to modify global parameters    // Functions to modify global parameters
534    def("setEscriptParamInt",escript::setEscriptParamInt,    def("setEscriptParamInt",escript::setEscriptParamInt,
535        (arg("value")=0));        (arg("name"), arg("value")=0), "Modify the value of an escript tuning parameter\n\n"
536    ":param name:\n:type name: ``string``\n:param value:\n:type value: ``int``");
537    def("getEscriptParamInt",escript::getEscriptParamInt,    def("getEscriptParamInt",escript::getEscriptParamInt,
538        (arg("sentinel")=0));        (arg("name"),arg("sentinel")=0), "Read the value of an escript tuning paramter\n\n"
539    ":param name: parameter to lookup\n:type name: ``string``\n:param sentinel: Value to be returned if ``name`` is not a known parameter\n"
540    ":type sentinel: ``int``");
541      def("listEscriptParams",escript::listEscriptParams,":return: A list of pairs (p,d) where p is the name of a parameter for escript and d is a description.");
542    
543    
544      def("resolveGroup", escript::resolveGroup);
545    
546    #ifdef IKNOWWHATIMDOING
547    
548      def("applyBinaryCFunction", escript::applyBinaryCFunction, (arg("function"), arg("outshape"),
549    arg("in1"),
550    arg("in2"))
551    );
552    #endif
553    
554      def("condEval", escript::condEval, (arg("mask"), arg("trueval"), arg("falseval")));
555    
556    //    //
557    // Register esysExceptionTranslator    // Register esysExceptionTranslator
558    //    //
559    register_exception_translator<esysUtils::EsysException>(&esysUtils::esysExceptionTranslator);    register_exception_translator<esysUtils::EsysException>(&esysUtils::esysExceptionTranslator);
   
560  }  }
Legend:
Removed from v.2064  
changed lines
  Added in v.3031
  ViewVC Help
Powered by ViewVC 1.1.26