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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2668 - (hide annotations)
Thu Sep 17 04:04:09 2009 UTC (10 years, 2 months ago) by gross
File size: 31823 byte(s)
some clarification in the table interpolation
1 jgs 102
2 ksteube 1312 /*******************************************************
3 ksteube 1811 *
4 jfenwick 2548 * Copyright (c) 2003-2009 by University of Queensland
5 ksteube 1811 * Earth Systems Science Computational Center (ESSCC)
6     * http://www.uq.edu.au/esscc
7     *
8     * Primary Business: Queensland, Australia
9     * Licensed under the Open Software License version 3.0
10     * http://www.opensource.org/licenses/osl-3.0.php
11     *
12     *******************************************************/
13 ksteube 1312
14 ksteube 1811
15 jgs 474 #include "Data.h"
16     #include "FunctionSpace.h"
17     #include "FunctionSpaceFactory.h"
18     #include "DataFactory.h"
19     #include "AbstractContinuousDomain.h"
20     #include "AbstractDomain.h"
21     #include "Utils.h"
22 jgs 480 #include "AbstractSystemMatrix.h"
23 gross 1364 #include "AbstractTransportProblem.h"
24 gross 797 #include "DataVector.h"
25 ksteube 1800 #include "paso/Paso_MPI.h"
26 jfenwick 1897 #include "EscriptParams.h"
27 jfenwick 2482 #include "TestDomain.h"
28 jgs 474
29 jfenwick 1872
30 ksteube 1312 extern "C" {
31 phornby 2078 #include "esysUtils/blocktimer.h"
32 ksteube 1312 }
33    
34 robwdcock 682 #include "esysUtils/esysExceptionTranslator.h"
35 jgs 102
36 gross 2100 #include <boost/version.hpp>
37 jgs 102 #include <boost/python.hpp>
38     #include <boost/python/module.hpp>
39     #include <boost/python/def.hpp>
40     #include <boost/python/object.hpp>
41     #include <boost/python/tuple.hpp>
42 jfenwick 1872 #include <boost/smart_ptr.hpp>
43 jfenwick 2064 #include <boost/version.hpp>
44 gross 285
45 jgs 102 using namespace boost::python;
46    
47 jgs 121 /*! \mainpage Esys Documentation
48     *
49 jfenwick 2602 * \version 3.0.0
50 jgs 121 *
51     * - \ref escript
52     *
53     * - \ref esys_exception "Esys Exception"
54     *
55     * - \ref finley
56     *
57 jfenwick 2283 * - <a href="../../epydoc/index.html">Python module documentation (epydoc generated)</a>
58 jgs 122 *
59 jgs 121 */
60 jgs 102
61 jgs 121 /*! \page escript Escript
62     * Escript is the python module that contains the interfaces
63     * to the C++ side of escript.
64     *
65 jfenwick 2459 *
66 jgs 121 *
67     * \section class_desc Class Description:
68     * Data
69     *
70     * \section class_limits Class Limitations:
71     * None
72     *
73     * \section class_conds Class Conditions of Use:
74     * None
75     *
76     * \section class_throws Throws:
77     * None
78     *
79     */
80 jgs 102
81     BOOST_PYTHON_MODULE(escriptcpp)
82     {
83 jfenwick 2625
84     #if BOOST_VERSION >= 103500
85     // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
86     docstring_options docopt(true,true,false);
87 gross 2100 #endif
88 jfenwick 2061
89 jfenwick 2607 def("setNumberOfThreads",escript::setNumberOfThreads,"Use of this method is strongly discouraged.");
90 jfenwick 2625 def("getNumberOfThreads",escript::getNumberOfThreads,"Return the maximum number of threads"
91     " available to OpenMP.");
92 gross 797 def("releaseUnusedMemory",escript::releaseUnusedMemory);
93 ksteube 1312 def("blocktimer_initialize",blocktimer_initialize);
94     def("blocktimer_reportSortByName",blocktimer_reportSortByName);
95     def("blocktimer_reportSortByTime",blocktimer_reportSortByTime);
96     def("blocktimer_increment",blocktimer_increment);
97     def("blocktimer_time",blocktimer_time);
98 jfenwick 2607 def("getVersion",escript::getSvnVersion,"This method will only report accurate version numbers for clean checkouts.");
99 ksteube 1561 def("printParallelThreadCounts",escript::printParallelThreadCnt);
100 jfenwick 2625 def("getMPISizeWorld",escript::getMPISizeWorld,"Return number of MPI processes in the job.");
101     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 gross 2100 def("getMachinePrecision",escript::getMachinePrecision);
108     def("getMaxFloat",escript::getMaxFloat);
109 jfenwick 2644 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     "\n:param filename:\n:type filename: ``string``\n"
118     ":param arg: dictionary of named `Data` objects. If one is called ``mask`` it must be scalar data."
119     "\n:type arg: ``dict``\n"
120     ":param sep:separator for columns (defaults to \", \"\n:type sep:``string``\n"
121     ":param csep:separator for fields within data object (defaults to \"_\"\n:type csep:``string``\n"
122     ":param append: If True, write to the end of ``filename``\n:type append: ``string``\n");
123 jfenwick 2635
124    
125 jgs 102 //
126     // Interface for AbstractDomain
127     //
128 jfenwick 2061 class_<escript::AbstractDomain, escript::Domain_ptr>("Domain","Base class for all domains.",no_init)
129 jfenwick 2625 .def("getStatus",&escript::AbstractDomain::getStatus,"The status of a domain changes whenever the domain is modified\n\n:rtype: int")
130     .def("setTagMap",&escript::AbstractDomain::setTagMap,args("name","tag"),
131     "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
132     ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")
133     .def("getTag",&escript::AbstractDomain::getTag,args("name"),":return: tag id for "
134     "``name``\n:rtype: ``string``")
135     .def("isValidTagName",&escript::AbstractDomain::isValidTagName,args("name"),
136     ":return: True is ``name`` corresponds to a tag\n:rtype: ``bool``")
137     .def("showTagNames",&escript::AbstractDomain::showTagNames,":return: A space separated list of tag names\n:rtype: ``string``")
138     .def("getX",&escript::AbstractDomain::getX,":rtype: `Data`\n:return: Locations in the"
139     "`Domain`. FunctionSpace is chosen appropriately")
140     .def("getDim",&escript::AbstractDomain::getDim,":rtype: `int`\n:return: Spatial dimension of the `Domain`")
141     .def("getNormal",&escript::AbstractDomain::getNormal,":rtype: `escript`\n:return: Boundary normals")
142     .def("getSize",&escript::AbstractDomain::getSize,":return: the local size of samples. The function space is chosen appropriately\n:rtype: `Data`")
143     .def("saveVTK",&escript::AbstractDomain::saveVTK,args("filename","arg", "metadata"
144     , "metadata_schema"),
145     ":param filename: \n:type filename: ``string``\n:param arg: items to be added"
146     "\n:type arg: ``dict``\n:param metadata: string representing some meta data to be added\n:type metadata: ``string``"
147     "\n:param metadata_schema: schema type for metadata\n:type metadata_schema: ``string``")
148     .def("dump",&escript::AbstractDomain::dump,args("filename"),"Dumps the domain to a file"
149     ":param filename:\n:type filename: string")
150     .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``"
151     "\n:param arg:\n:type arg: `dict`")
152     .def("getMPISize",&escript::AbstractDomain::getMPISize,":return: the number of processes used for this `Domain`\n:rtype: ``int``")
153     .def("getMPIRank",&escript::AbstractDomain::getMPIRank,":return: the rank of this process\n:rtype: ``int``")
154     .def("MPIBarrier",&escript::AbstractDomain::MPIBarrier,"Wait until all processes have reached this point")
155     .def("onMasterProcessor",&escript::AbstractDomain::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`")
156 ksteube 1312
157 jgs 102 .def(self == self)
158     .def(self != self);
159    
160     //
161     // Interface for AbstractContinuousDomain
162     //
163 jfenwick 2061 class_<escript::AbstractContinuousDomain, bases<escript::AbstractDomain> >("ContinuousDomain","Class representing continuous domains",no_init)
164 jfenwick 2625 .def("getSystemMatrixTypeId",&escript::AbstractContinuousDomain::getSystemMatrixTypeId,
165     args("solver", "preconditioner", "package", "symmetry"),
166     ":return: the identifier of the matrix type to be used for the global stiffness matrix "
167     "when a particular solver package and symmetric matrix is used.\n"
168     ":rtype: int")
169     .def("getTransportTypeId",&escript::AbstractContinuousDomain::getTransportTypeId,
170     args("solver", "preconditioner", "package", "symmetry"));
171 jgs 102
172 jfenwick 2482
173 jgs 102 //
174 jfenwick 2482 // Interface for TestDomain
175     //
176     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>());
177    
178     // This is the only python visible way to get a TestDomain
179 jfenwick 2625 def("getTestDomainFunctionSpace",&escript::getTestDomainFunctionSpace, args("dpps",
180     "samples"),
181     "For testing only. May be removed without notice.");
182 jfenwick 2482
183     //
184 jgs 102 // Interface for FunctionSpace
185     //
186 jfenwick 2625 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
187     fs_definer.def("getDim",&escript::FunctionSpace::getDim,":return: the spatial dimension of the underlying domain.\n:rtype: int");
188 jfenwick 1872 // fs_definer.def("getDomain",&escript::FunctionSpace::getDomain,
189     // return_internal_reference<>());
190 jfenwick 2625 fs_definer.def("getDomain",&escript::FunctionSpace::getDomainPython,":return: the underlying `Domain` for this FunctionSpace.\n:rtype: `Domain`");
191     fs_definer.def("getX",&escript::FunctionSpace::getX,"\n:return: a function whose values are its input coordinates. ie an identity function.\n:rtype: `Data`");
192     fs_definer.def("getNormal",&escript::FunctionSpace::getNormal,":return: the surface normal field.\n\n:rtype: `Data`");
193     fs_definer.def("getSize",&escript::FunctionSpace::getSize,":return: sample size\n:rtype: `Data`");
194     fs_definer.def("setTags",&escript::FunctionSpace::setTags,args("newtag","mask"),
195     "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`");
196 trankine 1426 fs_definer.def("getTagFromDataPointNo",
197 jfenwick 2625 &escript::FunctionSpace::getTagFromDataPointNo,":return: the tag associated with the given sample number.\n:rtype: int");
198     fs_definer.def("getReferenceIDFromDataPointNo", &escript::FunctionSpace::getReferenceIDFromDataPointNo,args("dataPointNo"),":return: the reference number associated with ``dataPointNo``\n:rtype: int ");
199     fs_definer.def("getListOfTags",&escript::FunctionSpace::getListOfTags,":return: a list of the tags used in this function space\n:rtype: ``list``");
200 phornby 1628 fs_definer.def("__str__", &escript::FunctionSpace::toString);
201 trankine 1426 fs_definer.def(self == self);
202     fs_definer.def(self != self);
203 jgs 102 //
204     // Interface for Data
205     //
206 jfenwick 2061 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<>() )
207 jgs 102 // various constructors for Data objects
208     .def(init<const object&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))
209     .def(init<const double, const tuple&, optional<const escript::FunctionSpace&, bool> >(args("value","shape","what","expand")))
210     .def(init<const escript::Data&, const escript::FunctionSpace&>(args("value","what")))
211     .def(init<const escript::Data&>())
212     // Note for Lutz, Need to specify the call policy in order to return a
213     // reference. In this case return_internal_reference.
214 ksteube 1312 .def("__str__",&escript::Data::toString)
215 jfenwick 2625 .def("getDomain",&escript::Data::getDomainPython,":rtype: `Domain`")
216     .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_value_policy<copy_const_reference>(),":rtype: `FunctionSpace`")
217     .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.")
218     .def("isProtected",&escript::Data::isProtected,"Can this instance be modified.\n:rtype: ``bool``")
219     .def("setProtection",&escript::Data::setProtection,"Disallow modifications to this data object\n\n:note: This method does not allow you to undo protection.")
220     .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``")
221     .def("getRank",&escript::Data::getDataPointRank,":return: the number of indicies required to address a component of a datapoints\n:rtype: positive ``int``")
222     .def("dump",&escript::Data::dump,args("fileName"),"Save the data as a netCDF file\n\n:param fileName: \n:type fileName: ``string``")
223     .def("toListOfTuples",&escript::Data::toListOfTuples, (arg("scalarastuple")=false),
224     "Return the datapoints of this object in a list. Each datapoint is stored as a tuple.\n\n"
225     ":param scalarastuple: if True, scalar data will be wrapped as a tuple."
226     " True => [(0), (1), (2)]; False => [0, 1, 2]")
227     .def("copyWithMask",&escript::Data::copyWithMask,args("other","mask"),
228     "Selectively copy values from ``other`` `Data`."
229     "Datapoints which correspond to postive values in ``mask`` will be copied from ``other``\n"
230     "\n:param other: source of values\n"
231     ":type other: `Data`\n:param mask:\n:type mask: Scalar `Data`")
232     .def("setTaggedValue",&escript::Data::setTaggedValue,args("tagKey","value"),
233     "Set the value of tagged Data.\n\n:param tagKey: tag to update\n:type tagKey: ``int``\n")
234     .def("setTaggedValue",&escript::Data::setTaggedValueByName,args("name","value"),":param name: tag to update\n:type name: ``string``\n"
235     ":param value: value to set tagged data to\n:type value: ``object`` which acts like an array, ``tuple`` or ``list``\n")
236     .def("getNumberOfDataPoints",&escript::Data::getNumDataPoints,":rtype: ``int``\n:return: Number of datapoints in the object")
237     .def("isExpanded",&escript::Data::isExpanded,":rtype: ``bool``\n:return: True if this ``Data`` is expanded.")
238     .def("isTagged",&escript::Data::isTagged,":rtype: ``bool``\n:return: True if this ``Data`` is expanded.")
239     .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.")
240     .def("isLazy",&escript::Data::isLazy,":rtype: ``bool``\n:return: True if this ``Data`` is lazy.")
241     .def("isReady",&escript::Data::isReady,":rtype: ``bool``\n:return: True if this ``Data`` is not lazy.")
242     .def("expand",&escript::Data::expand,"Convert the data to expanded representation if it is not expanded already.")
243     .def("tag",&escript::Data::tag,"Convert data to tagged representation if it is not already tagged or expanded")
244     .def("resolve",&escript::Data::resolve,"Convert the data to non-lazy representation.")
245     .def("copy",&escript::Data::copy,args("other"),"Make this object a copy of ``other``\n"
246     "\n:note: The two objects will act independently from now on. That is, changing ``other`` "
247     "after this call will not change this object and vice versa.")
248     .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.")
249     .def("delay",&escript::Data::delay,"Convert this object into lazy representation")
250     .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToPyObject,args("dataPointNo","value"))
251 gross 1034 .def("setValueOfDataPoint",&escript::Data::setValueOfDataPointToArray)
252 jfenwick 2625 .def("setValueOfDataPoint",&escript::Data::setValueOfDataPoint,"\nModify the value of a single datapoint.\n\n:param dataPointNo:\n"
253     ":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.")
254     .def("getTupleForDataPoint",&escript::Data::getValueOfDataPointAsTuple,args("dataPointNo"),
255     ":return: Value of the specified datapoint\n:rtype: ``tuple``\n:param dataPointNo: datapoint to access\n:type dataPointNo: ``int``")
256     .def("getTupleForGlobalDataPoint",&escript::Data::getValueOfGlobalDataPointAsTuple,args("procNo","dataPointNo"),"Get a specific datapoint from a specific process\n\n"
257     ":rtype: ``tuple``\n:param procNo: MPI rank of the process\n:type procNo: positive ``int``"
258     "\n:param dataPointNo: datapoint to access\n:type dataPointNo: int")
259     .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.")
260     .def("interpolate",&escript::Data::interpolate,args("functionspace"),"Interpolate this object's values into a new functionspace.")
261 jfenwick 2646 .def("interpolateTable", &escript::Data::interpolateFromTable2DP,
262 gross 2668 (arg("table"),arg("Amin"),arg("Astep"), arg("B"), arg("Bmin"), arg("Bstep"), arg("undef")=1.e50, arg("check_boundaries")=false),
263 jfenwick 2628 "Creates a new Data object by interpolating using the source data (which are\n"
264 jfenwick 2646 "looked up in ``table``)\n``A`` must be the outer dimension on the table\n\n"
265 jfenwick 2628 ":param table: two dimensional collection of values\n"
266     ":param Amin: The base of locations in table\n:type Amin: float\n"
267     ":param Astep: size of gap between each item in the table\n:type Astep: float\n"
268     ":param undef: upper bound on interpolated values\n:type undef: float\n"
269     ":param B: Scalar representing the second coordinate to be mapped into the table\n"
270     ":type B: `Data`\n"
271     ":param Bmin: The base of locations in table for 2nd dimension\n:type Bmin: float\n"
272     ":param Bstep: size of gap between each item in the table for 2nd dimension\n:type Bstep: float\n"
273 gross 2668 ":param check_boundaries: if true table boundaries are checked.\n"
274 jfenwick 2628 ":raise RuntimeError(DataException): if the cordinates do not map into the table or if the interpolated value is above ``undef``"
275     "\n:rtype: `Data`"
276     )
277 jfenwick 2646 .def("interpolateTable", &escript::Data::interpolateFromTable1DP,
278 gross 2668 (arg("table"),arg("Amin"),arg("Astep"), arg("undef")=1.e50, arg("check_boundaries")=false),
279 jfenwick 2646 "Creates a new Data object by interpolating using the source data (which are\n"
280     "looked up in ``table``)\n\n"
281     ":param table: one dimensional collection of values\n"
282     ":param Amin: The base of locations in table\n:type Amin: float\n"
283     ":param Astep: size of gap between each item in the table\n:type Astep: float\n"
284     ":param undef: upper bound on interpolated values\n:type undef: float\n"
285 gross 2668 ":param check_boundaries: if true table boundaries are checked.\n"
286 jfenwick 2646 ":raise RuntimeError(DataException): if the cordinates do not map into the table or if the interpolated value is above ``undef``"
287     "\n:rtype: `Data`"
288     )
289 jfenwick 2628
290 jfenwick 2646
291 gross 921 .def("minGlobalDataPoint",&escript::Data::minGlobalDataPoint)
292 jfenwick 2476 .def("maxGlobalDataPoint",&escript::Data::maxGlobalDataPoint)
293 jfenwick 2625 .def("saveDX",&escript::Data::saveDX,args("fileName"),"Save the object in DX format.\n\n"
294     ":param fileName: filename\n:type fileName: string")
295     .def("saveVTK",&escript::Data::saveVTK, args("fileName"),"Save the object in VTK format.\n\n"
296     ":param fileName: \n:type fileName: string")
297     .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")
298 gross 285 // Unary functions for Data
299     .def("_interpolate",&escript::Data::interpolate)
300     .def("_grad",&escript::Data::gradOn)
301     .def("_grad",&escript::Data::grad)
302     .def("_transpose",&escript::Data::transpose)
303     .def("_trace",&escript::Data::trace)
304     .def("_maxval",&escript::Data::maxval)
305     .def("_minval",&escript::Data::minval)
306 gross 698 .def("_wherePositive",&escript::Data::wherePositive)
307     .def("_whereNegative",&escript::Data::whereNegative)
308     .def("_whereNonNegative",&escript::Data::whereNonNegative)
309     .def("_whereNonPositive",&escript::Data::whereNonPositive)
310 jgs 571 .def("_whereZero",&escript::Data::whereZero,(arg("tol")=0.0))
311     .def("_whereNonZero",&escript::Data::whereNonZero,(arg("tol")=0.0))
312 ksteube 876 .def("_erf",&escript::Data::erf)
313 gross 285 .def("_sin",&escript::Data::sin)
314     .def("_cos",&escript::Data::cos)
315     .def("_tan",&escript::Data::tan)
316     .def("_asin",&escript::Data::asin)
317     .def("_acos",&escript::Data::acos)
318     .def("_atan",&escript::Data::atan)
319     .def("_sinh",&escript::Data::sinh)
320     .def("_cosh",&escript::Data::cosh)
321     .def("_tanh",&escript::Data::tanh)
322     .def("_asinh",&escript::Data::asinh)
323     .def("_acosh",&escript::Data::acosh)
324     .def("_atanh",&escript::Data::atanh)
325     .def("_exp",&escript::Data::exp)
326     .def("_sqrt",&escript::Data::sqrt)
327     .def("_log10",&escript::Data::log10)
328     .def("_log",&escript::Data::log)
329     .def("_sign",&escript::Data::sign)
330 ksteube 775 .def("_symmetric",&escript::Data::symmetric)
331     .def("_nonsymmetric",&escript::Data::nonsymmetric)
332 gross 800 .def("_trace",&escript::Data::trace)
333 gross 804 .def("_swap_axes",&escript::Data::swapaxes)
334 gross 576 .def("_eigenvalues",&escript::Data::eigenvalues)
335     .def("_eigenvalues_and_eigenvectors",&escript::Data::eigenvalues_and_eigenvectors,(arg("tol")=1.e-13))
336 gross 285 // functions returning a single real number:
337 jfenwick 2625 .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.")
338     .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.")
339     .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.")
340     .def("_integrateToTuple",&escript::Data::integrateToTuple,":return: Calculate the integral over the function space domain as a python tuple\n:rtype: tuple")
341 gross 285 // following implements the python abs operator
342 jfenwick 2625 .def("__abs__",&escript::Data::abs,":return: absolute value\n\n:rtype: `Data`")
343 jgs 102 // following implements the python "-" negation operator
344 jfenwick 2625 .def("__neg__",&escript::Data::neg, ":return: negation of the values in this object\n:rtype: `Data`")
345 jgs 102 // following implements the python "+" identity operator
346 jfenwick 2646 .def("__pos__",&escript::Data::pos, "\nThe unary + operator\n\n:rtype: `Data`")
347 jgs 102 // following two functions implement the python [] operator
348 jfenwick 2625 .def("__getitem__",&escript::Data::getItem,"Used by the python [] operator\n\n:rtype: `Data`")
349     .def("__setitem__",&escript::Data::setItemO,"Used by the python [] operator")
350     .def("__setitem__",&escript::Data::setItemD,"Used by the python [] operator")
351 jgs 102 // following two functions implement the python ** operator
352 jfenwick 2625 .def("__pow__",&escript::Data::powO,"Used by the python ** operator\n\n:rtype: `Data`")
353 jgs 102 .def("__pow__",&escript::Data::powD)
354 jfenwick 2625 .def("__rpow__",&escript::Data::rpowO,"\nUsed by the python ** operator\n\n:rtype: `Data`")
355 jgs 102 // NOTE:: The order of these declarations is important. Anything
356     // declared before the generic declaration isn't found so the generic
357     // version will be called.
358     .def(self + other<object>())
359     .def(other<object>() + self)
360     .def(self + self)
361 gross 285 .def(self += other<object>())
362     .def(self += self)
363    
364 jgs 102 .def(self - other<object>())
365     .def(other<object>() - self)
366     .def(self - self)
367 gross 285 .def(self -= other<object>())
368     .def(self -= self)
369    
370 jgs 102 .def(self * other<object>())
371     .def(other<object>() * self)
372     .def(self * self)
373 gross 285 .def(self *= other<object>())
374     .def(self *= self)
375    
376 jgs 102 .def(self / other<object>())
377     .def(other<object>() / self)
378     .def(self / self)
379 gross 285 .def(self /= other<object>())
380     .def(self /= self)
381 jgs 102 // Need scope resolution due to a bug either in the compiler or
382     // the boost code. This calls operator << for Data.
383     .def(self_ns::str(self));
384    
385 jfenwick 2635
386 jgs 102 //
387     // Factory methods for function space
388     //
389 jfenwick 2625 def("ContinuousFunction",escript::continuousFunction,args("domain"),
390     ":return: a continuous FunctionSpace (overlapped node values)\n"
391     ":rtype: `FunctionSpace`");
392     def("ReducedContinuousFunction",escript::reducedContinuousFunction,args("domain"),
393     ":return: a continuous with reduced order FunctionSpace (overlapped node values on reduced element order)\n"
394     ":rtype: `FunctionSpace`");
395     def("Function",escript::function,args("domain"),":return: a function `FunctionSpace`\n"
396     ":rtype: `FunctionSpace`");
397     def("ReducedFunction",escript::reducedFunction, args("domain"),":return: a function FunctionSpace with reduced integration order\n:rtype: `FunctionSpace`");
398     def("FunctionOnBoundary",escript::functionOnBoundary, args("domain"), ":return: a function on boundary FunctionSpace\n:rtype: `FunctionSpace`");
399     def("ReducedFunctionOnBoundary",escript::reducedFunctionOnBoundary, args("domain"),
400     ":return: a function on boundary FunctionSpace with reduced integration order\n"
401     ":rtype: `FunctionSpace`");
402     def("FunctionOnContactZero",escript::functionOnContactZero, args("domain"), ":return: Return a FunctionSpace on left side of contact\n:rtype: `FunctionSpace`");
403     def("ReducedFunctionOnContactZero",escript::reducedFunctionOnContactZero, args("domain"),
404     ":return: a FunctionSpace on left side of contact with reduced integration order\n:rtype: `FunctionSpace`");
405     def("FunctionOnContactOne",escript::functionOnContactOne, args("domain"), ":return: Return a FunctionSpace on right side of contact\n:rtype: `FunctionSpace`");
406     def("ReducedFunctionOnContactOne",escript::reducedFunctionOnContactOne, args("domain"),
407     ":return: Return a FunctionSpace on right side of contact with reduced integration order\n"
408     ":rtype: `FunctionSpace`");
409     def("Solution",escript::solution, args("domain"), ":rtype: `FunctionSpace`");
410     def("ReducedSolution",escript::reducedSolution, args("domain"), ":rtype: `FunctionSpace`");
411     def("DiracDeltaFunction",escript::diracDeltaFunction, args("domain"), ":rtype: `FunctionSpace`");
412 jgs 102
413 jfenwick 2635
414    
415    
416    
417 jgs 102 //
418     // Factory methods for Data
419     //
420 jfenwick 2625 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`");
421     def("loadIsConfigured",escript::loadConfigured,":return: True if the load function is configured.");
422 jgs 102 def("Scalar",escript::Scalar,
423     (arg("value")=0.0,
424     arg("what")=escript::FunctionSpace(),
425 jfenwick 2625 arg("expanded")=false),
426     "Construct a Data object containing scalar data-points.\n\n:param value: scalar value for all points\n"
427     "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
428     ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
429     ":type expanded: ``bool``");
430 jgs 102 def("Vector",escript::Vector,
431     (arg("value")=0.0,
432     arg("what")=escript::FunctionSpace(),
433 jfenwick 2625 arg("expanded")=false),
434     "Construct a Data object containing rank1 data-points.\n\n:param value: scalar value for all points\n"
435     "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
436     ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
437     ":type expanded: ``bool``");
438 jgs 102 def("Tensor",escript::Tensor,
439     (arg("value")=0.0,
440     arg("what")=escript::FunctionSpace(),
441 jfenwick 2625 arg("expanded")=false),
442     "Construct a Data object containing rank2 data-points.\n\n:param value: scalar value for all points\n"
443     "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
444     ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
445     ":type expanded: ``bool``");
446 jgs 102 def("Tensor3",escript::Tensor3,
447     (arg("value")=0.0,
448     arg("what")=escript::FunctionSpace(),
449 jfenwick 2625 arg("expanded")=false),
450     "Construct a Data object containing rank3 data-points.\n\n:param value: scalar value for all points\n"
451     "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
452     ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
453     ":type expanded: ``bool``"
454     );
455 jgs 102 def("Tensor4",escript::Tensor4,
456     (arg("value")=0.0,
457     arg("what")=escript::FunctionSpace(),
458 jfenwick 2625 arg("expanded")=false),
459     "Construct a Data object containing rank4 data-points.\n\n:param value: scalar value for all points\n"
460     "\n:rtype: `Data`\n:type value: float\n:param what: FunctionSpace for Data\n:type what: `FunctionSpace`\n"
461     ":param expanded: If True, a value is stored for each point. If False, more efficient representations may be used\n"
462     ":type expanded: ``bool``"
463     );
464 jgs 102
465     //
466 ksteube 813 // Binary operators
467     //
468     def("C_GeneralTensorProduct",escript::C_GeneralTensorProduct,
469 jfenwick 2626 (arg("arg0"),
470     arg("arg1"),
471 ksteube 813 arg("axis_offset")=0,
472 jfenwick 2625 arg("transpose")=0),
473     "Compute a tensor product of two Data objects.\n\n:rtype: `Data`\n:param arg0:\n"
474     ":param arg1:\n:param axis_offset:\n:type axis_offset: ``int``\n"
475     ":param transpose: 0: transpose neither, 1: transpose arg0, 2: transpose arg1\n"
476     ":type transpose: int");
477 ksteube 813
478     //
479 jgs 102 // Interface for AbstractSystemMatrix
480     //
481 jfenwick 2061 class_<escript::AbstractSystemMatrix>("Operator","",init<>()) // Doco goes in the empty string param
482 jfenwick 2625 .def("isEmpty",&escript::AbstractSystemMatrix::isEmpty,":rtype: ``bool``\n"
483     ":return: True if matrix is empty")
484     .def("solve",&escript::AbstractSystemMatrix::solve, args("in","options"),
485     ":return: the solution *u* of the linear system *this*u=in*\n\n:param in:\n:type in: `Data`")
486     .def("of",&escript::AbstractSystemMatrix::vectorMultiply,args("right"),
487     "matrix*vector multiplication")
488     .def("saveMM",&escript::AbstractSystemMatrix::saveMM, args("fileName"),
489     "writes the matrix to a file using the Matrix Market file format")
490     .def("saveHB",&escript::AbstractSystemMatrix::saveHB, args("filename"),
491     "writes the matrix to a file using the Harwell-Boeing file format")
492     .def("resetValues",&escript::AbstractSystemMatrix::resetValues, "resets the matrix entries")
493 jgs 102 .def(self*other<escript::Data>());
494 gross 1364 //
495     // Interface for AbstractTransportProblem
496     //
497 jfenwick 2061 class_<escript::AbstractTransportProblem>("TransportProblem","",init<>()) // Doco goes in the empty string param
498 jfenwick 2625 .def("isEmpty",&escript::AbstractTransportProblem::isEmpty,":rtype: ``int``")
499     .def("solve",&escript::AbstractTransportProblem::solve, args("source","dt", "options"),
500     "returns the solution *u* for a time step *dt>0*\n\n:rtype: `Data`\n"
501     ":param source:\n:type source: `Data`")
502     .def("setInitialValue",&escript::AbstractTransportProblem::setInitialValue, args("u"),
503     "sets the value for *u* at time *t=0*.")
504     .def("insertConstraint",&escript::AbstractTransportProblem::insertConstraint,
505     args("source", "q", "r","factor"),
506     "inserts constraint *u_{,t}=r* where *q>0* into the problem using a weighting factor")
507     .def("reset",&escript::AbstractTransportProblem::resetTransport,
508     "resets the transport operator typically as they have been updated.")
509 gross 1841 .def("resetValues",&escript::AbstractTransportProblem::resetTransport)
510 gross 1859 .def("getSafeTimeStepSize",&escript::AbstractTransportProblem::getSafeTimeStepSize)
511     .def("getUnlimitedTimeStepSize",&escript::AbstractTransportProblem::getUnlimitedTimeStepSize);
512 jgs 102
513 jfenwick 1897 // Functions to modify global parameters
514     def("setEscriptParamInt",escript::setEscriptParamInt,
515 jfenwick 2625 (arg("name"), arg("value")=0), "Modify the value of an escript tuning parameter\n\n"
516     ":param name:\n:type name: ``string``\n:param value:\n:type value: ``int``");
517 jfenwick 1897 def("getEscriptParamInt",escript::getEscriptParamInt,
518 jfenwick 2625 (arg("name"),arg("sentinel")=0), "Read the value of an escript tuning paramter\n\n"
519     ":param name: parameter to lookup\n:type name: ``string``\n:param sentinel: Value to be returned if ``name`` is not a known parameter\n"
520     ":type sentinel: ``int``");
521     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.");
522 jfenwick 1897
523 jgs 102 //
524     // Register esysExceptionTranslator
525     //
526     register_exception_translator<esysUtils::EsysException>(&esysUtils::esysExceptionTranslator);
527     }

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26