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