escript/src/escriptcpp.cpp

//$Id$
/*
 ************************************************************
 *          Copyright 2006 by ACcESS MNRF                   *
 *                                                          *
 *              http://www.access.edu.au                    *
 *       Primary Business: Queensland, Australia            *
 *  Licensed under the Open Software License version 3.0    *
 *     http://www.opensource.org/licenses/osl-3.0.php       *
 *                                                          *
 ************************************************************
*/

#include "Data.h"
#include "FunctionSpace.h"
#include "FunctionSpaceFactory.h"
#include "DataFactory.h"
#include "AbstractContinuousDomain.h"
#include "AbstractDomain.h"
#include "Utils.h"
#include "AbstractSystemMatrix.h"
#include "DataVector.h"

#include "esysUtils/esysExceptionTranslator.h"

#include <boost/python.hpp>
#include <boost/python/module.hpp>
#include <boost/python/def.hpp>
#include <boost/python/object.hpp>
#include <boost/python/tuple.hpp>
#include <boost/python/numeric.hpp>

using namespace boost::python;

/*! \mainpage Esys Documentation
 *
 * \version 1.0.0
 *
 * - \ref escript
 *
 * - \ref esys_exception "Esys Exception"
 *
 * - \ref finley
 *
 * - <a href=http://iservo.edu.au/esys/epydoc/index.html>Python module documentation (epydoc generated)</a>
 *
 */

/*! \page escript Escript
 * Escript is the python module that contains the interfaces
 * to the C++ side of escript.
 *
 * \version 1.0.0 
 *
 * \section class_desc Class Description:
 * Data
 *
 * \section class_limits Class Limitations:
 * None
 *
 * \section class_conds Class Conditions of Use:
 * None
 *
 * \section class_throws Throws:
 * None
 *
 */

BOOST_PYTHON_MODULE(escriptcpp)
{
  def("setNumberOfThreads",escript::setNumberOfThreads);
  def("getNumberOfThreads",escript::getNumberOfThreads);
  def("releaseUnusedMemory",escript::releaseUnusedMemory);


  //
  // Interface for AbstractDomain
  //
  class_<escript::AbstractDomain>("Domain",no_init)
     .def("getX",&escript::AbstractDomain::getX)
     .def("getNormal",&escript::AbstractDomain::getNormal)
     .def("getSize",&escript::AbstractDomain::getSize)
     .def("saveVTK",&escript::AbstractDomain::saveVTK)
     .def("saveDX",&escript::AbstractDomain::saveDX)
     .def(self == self)
     .def(self != self);

  //
  // Interface for AbstractContinuousDomain
  //
  class_<escript::AbstractContinuousDomain, bases<escript::AbstractDomain> >("ContinuousDomain",no_init)
       .def("getSystemMatrixTypeId",&escript::AbstractContinuousDomain::getSystemMatrixTypeId);

  //
  // Interface for FunctionSpace
  //
  class_<escript::FunctionSpace>("FunctionSpace",init<>())
     .def("getDim",&escript::FunctionSpace::getDim)
     .def("getDomain",&escript::FunctionSpace::getDomain,return_internal_reference<>())
     .def("getX",&escript::FunctionSpace::getX)
     .def("getNormal",&escript::FunctionSpace::getNormal)
     .def("getSize",&escript::FunctionSpace::getSize)
     .def("setTags",&escript::FunctionSpace::setTags)
     .def("getTagFromDataPointNo",&escript::FunctionSpace::getTagFromDataPointNo)
     .def("__str__",&escript::FunctionSpace::toString)
     .def(self == self)
     .def(self != self);
  //
  // Interface for Data
  //
  class_<escript::Data>("Data","TEST DOCUMENTATION",init<>())
    // various constructors for Data objects
    .def(init<const numeric::array&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))
    .def(init<const object&, optional<const escript::FunctionSpace&, bool> >(args("value","what","expand")))
    .def(init<const double, const tuple&, optional<const escript::FunctionSpace&, bool> >(args("value","shape","what","expand")))
    .def(init<const escript::Data&, const escript::FunctionSpace&>(args("value","what")))
    .def(init<const escript::Data&>())
    // Note for Lutz, Need to specify the call policy in order to return a
    // reference. In this case return_internal_reference.
    .def("__str__",&escript::Data::toString)
    .def("getDomain",&escript::Data::getDomain,return_internal_reference<>())
    .def("getFunctionSpace",&escript::Data::getFunctionSpace,return_internal_reference<>())
    .def("isEmpty",&escript::Data::isEmpty)
    .def("isProtected",&escript::Data::isProtected)
    .def("setProtection",&escript::Data::setProtection)
    .def("getShape",&escript::Data::getShapeTuple)
    .def("getRank",&escript::Data::getDataPointRank)
    .def("copyWithMask",&escript::Data::copyWithMask)
    .def("setTaggedValue",&escript::Data::setTaggedValue)
    .def("setRefValue",&escript::Data::setRefValue)
    .def("getRefValue",&escript::Data::getRefValue)
    .def("expand",&escript::Data::expand)
    .def("tag",&escript::Data::tag)
    .def("copy",&escript::Data::copy)
    .def("convertToNumArray",&escript::Data::convertToNumArray)
    .def("convertToNumArrayFromSampleNo",&escript::Data::convertToNumArrayFromSampleNo)
    .def("convertToNumArrayFromDPNo",&escript::Data::convertToNumArrayFromDPNo)
    .def("fillFromNumArray",&escript::Data::fillFromNumArray)
    .def("interpolate",&escript::Data::interpolate)
    .def("mindp",&escript::Data::mindp)
    .def("saveDX",&escript::Data::saveDX)
    .def("saveVTK",&escript::Data::saveVTK)
    .def("getTagNumber",&escript::Data::getTagNumber)
    .def("archiveData",&escript::Data::archiveData)
    .def("extractData",&escript::Data::extractData)
    // Unary functions for Data
    .def("_interpolate",&escript::Data::interpolate)
    .def("_grad",&escript::Data::gradOn)
    .def("_grad",&escript::Data::grad)
    .def("_transpose",&escript::Data::transpose)
    .def("_trace",&escript::Data::trace)
    .def("_maxval",&escript::Data::maxval)
    .def("_minval",&escript::Data::minval)
    .def("_wherePositive",&escript::Data::wherePositive)
    .def("_whereNegative",&escript::Data::whereNegative)
    .def("_whereNonNegative",&escript::Data::whereNonNegative)
    .def("_whereNonPositive",&escript::Data::whereNonPositive)
    .def("_whereZero",&escript::Data::whereZero,(arg("tol")=0.0))
    .def("_whereNonZero",&escript::Data::whereNonZero,(arg("tol")=0.0))
    .def("_erf",&escript::Data::erf)
    .def("_sin",&escript::Data::sin)
    .def("_cos",&escript::Data::cos)
    .def("_tan",&escript::Data::tan)
    .def("_asin",&escript::Data::asin)
    .def("_acos",&escript::Data::acos)
    .def("_atan",&escript::Data::atan)
    .def("_sinh",&escript::Data::sinh)
    .def("_cosh",&escript::Data::cosh)
    .def("_tanh",&escript::Data::tanh)
    .def("_asinh",&escript::Data::asinh)
    .def("_acosh",&escript::Data::acosh)
    .def("_atanh",&escript::Data::atanh)
    .def("_exp",&escript::Data::exp)
    .def("_sqrt",&escript::Data::sqrt)
    .def("_log10",&escript::Data::log10)
    .def("_log",&escript::Data::log)
    .def("_sign",&escript::Data::sign)
    .def("_symmetric",&escript::Data::symmetric)
    .def("_nonsymmetric",&escript::Data::nonsymmetric)
    .def("_trace",&escript::Data::trace)
    .def("_swap_axes",&escript::Data::swapaxes)
    .def("_eigenvalues",&escript::Data::eigenvalues)
    .def("_eigenvalues_and_eigenvectors",&escript::Data::eigenvalues_and_eigenvectors,(arg("tol")=1.e-13))
    // functions returning a single real number:
    .def("_Lsup",&escript::Data::Lsup)
    .def("_sup",&escript::Data::sup)
    .def("_inf",&escript::Data::inf)
    .def("_integrate",&escript::Data::integrate)

    // following implements the python abs operator
    .def("__abs__",&escript::Data::abs)
    // following implements the python "-" negation operator
    .def("__neg__",&escript::Data::neg)
    // following implements the python "+" identity operator
    .def("__pos__",&escript::Data::pos)
    // following two functions implement the python [] operator
    .def("__getitem__",&escript::Data::getItem)
    .def("__setitem__",&escript::Data::setItemO)
    .def("__setitem__",&escript::Data::setItemD)
    // following two functions implement the python ** operator
    .def("__pow__",&escript::Data::powO)
    .def("__pow__",&escript::Data::powD)
    .def("__rpow__",&escript::Data::rpowO)
    // NOTE:: The order of these declarations is important. Anything
    // declared before the generic declaration isn't found so the generic
    // version will be called. 
    .def(self + other<object>())
    .def(other<object>() + self)
    .def(self + self)
    .def(self += other<object>())
    .def(self += self)

    .def(self - other<object>())
    .def(other<object>() - self)
    .def(self - self)
    .def(self -= other<object>())
    .def(self -= self)

    .def(self * other<object>())
    .def(other<object>() * self)
    .def(self * self)
    .def(self *= other<object>())
    .def(self *= self)

    .def(self / other<object>())
    .def(other<object>() / self)
    .def(self / self)
    .def(self /= other<object>())
    .def(self /= self)
    // Need scope resolution due to a bug either in the compiler or
    // the boost code. This calls operator << for Data.
    .def(self_ns::str(self));

  //
  // Factory methods for function space
  //
  def("ContinuousFunction",escript::continuousFunction);
  def("Function",escript::function);
  def("FunctionOnBoundary",escript::functionOnBoundary);
  def("FunctionOnContactZero",escript::functionOnContactZero);
  def("FunctionOnContactOne",escript::functionOnContactOne);
  def("Solution",escript::solution);
  def("ReducedSolution",escript::reducedSolution);
  def("DiracDeltaFunction",escript::diracDeltaFunction);

  //
  // Factory methods for Data
  //
  def("Scalar",escript::Scalar,
      (arg("value")=0.0,
       arg("what")=escript::FunctionSpace(),
       arg("expanded")=false));
  def("Vector",escript::Vector,
      (arg("value")=0.0,
       arg("what")=escript::FunctionSpace(),
       arg("expanded")=false));
  def("Tensor",escript::Tensor,
      (arg("value")=0.0,
       arg("what")=escript::FunctionSpace(),
       arg("expanded")=false));
  def("Tensor3",escript::Tensor3,
      (arg("value")=0.0,
       arg("what")=escript::FunctionSpace(),
       arg("expanded")=false));
  def("Tensor4",escript::Tensor4,
      (arg("value")=0.0,
       arg("what")=escript::FunctionSpace(),
       arg("expanded")=false));

  //
  // Binary operators
  //
  def("C_GeneralTensorProduct",escript::C_GeneralTensorProduct,
      (arg("arg0")=escript::Data(),
       arg("arg1")=escript::Data(),
       arg("axis_offset")=0,
       arg("transpose")=0));

  //
  // Interface for AbstractSystemMatrix
  //
  class_<escript::AbstractSystemMatrix>("Operator",init<>())
     .def("isEmpty",&escript::AbstractSystemMatrix::isEmpty)
     .def("solve",&escript::AbstractSystemMatrix::solve)
     .def("of",&escript::AbstractSystemMatrix::vectorMultiply)
     .def("saveMM",&escript::AbstractSystemMatrix::saveMM)
     .def("saveHB",&escript::AbstractSystemMatrix::saveHB)
     .def("resetValues",&escript::AbstractSystemMatrix::resetValues)
     .def(self*other<escript::Data>());

  //
  // Register esysExceptionTranslator
  //
  register_exception_translator<esysUtils::EsysException>(&esysUtils::esysExceptionTranslator);

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