/[escript]/trunk/ripley/src/ripleycpp.cpp
ViewVC logotype

Contents of /trunk/ripley/src/ripleycpp.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4277 - (show annotations)
Wed Mar 6 01:30:41 2013 UTC (6 years, 1 month ago) by caltinay
File size: 17703 byte(s)
Implemented claimed support for mixing data with different resolutions.

1
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2013 by University of Queensland
5 * http://www.uq.edu.au
6 *
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 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development since 2012 by School of Earth Sciences
13 *
14 *****************************************************************************/
15
16 #include <ripley/Brick.h>
17 #include <ripley/Rectangle.h>
18 #include <esysUtils/esysExceptionTranslator.h>
19
20 #include <boost/python.hpp>
21 #include <boost/python/module.hpp>
22 #include <boost/python/def.hpp>
23 #include <boost/python/detail/defaults_gen.hpp>
24 #include <boost/version.hpp>
25
26 using namespace boost::python;
27
28 namespace ripley {
29
30 escript::Data readBinaryGrid(std::string filename, escript::FunctionSpace fs,
31 const object& pyFirst, const object& pyNum, const object& pyMultiplier,
32 const object& pyShape, double fill=0.)
33 {
34 int dim=fs.getDim();
35 std::vector<int> first(dim), numValues(dim), multiplier(dim), shape;
36
37 if (extract<tuple>(pyFirst).check() || extract<list>(pyFirst).check()) {
38 if (len(pyFirst)==dim) {
39 for (int i=0; i<dim; i++) {
40 first[i]=extract<int>(pyFirst[i]);
41 }
42 } else
43 throw RipleyException("Argument 'first' has wrong length");
44 } else
45 throw RipleyException("Argument 'first' must be a tuple or list");
46
47 if (extract<tuple>(pyNum).check() || extract<list>(pyNum).check()) {
48 if (len(pyNum)==dim) {
49 for (int i=0; i<dim; i++) {
50 numValues[i]=extract<int>(pyNum[i]);
51 }
52 } else
53 throw RipleyException("Argument 'numValues' has wrong length");
54 } else
55 throw RipleyException("Argument 'numValues' must be a tuple or list");
56
57 if (extract<tuple>(pyShape).check() || extract<list>(pyShape).check()) {
58 for (int i=0; i<len(pyShape); i++) {
59 shape.push_back(extract<int>(pyShape[i]));
60 }
61 } else
62 throw RipleyException("Argument 'shape' must be a tuple or list");
63
64 if (extract<tuple>(pyMultiplier).check() || extract<list>(pyMultiplier).check()) {
65 if (len(pyMultiplier)==dim) {
66 for (int i=0; i<dim; i++) {
67 multiplier[i]=extract<int>(pyMultiplier[i]);
68 }
69 } else
70 throw RipleyException("Argument 'multiplier' has wrong length");
71 } else
72 throw RipleyException("Argument 'multiplier' must be a tuple or list");
73
74 const RipleyDomain* dom=dynamic_cast<const RipleyDomain*>(fs.getDomain().get());
75 if (!dom)
76 throw RipleyException("Function space must be on a ripley domain");
77
78
79 escript::Data res(fill, shape, fs, true);
80
81 dom->readBinaryGrid(res, filename, first, numValues, multiplier);
82 return res;
83 }
84
85 escript::Data readNcGrid(std::string filename, std::string varname,
86 escript::FunctionSpace fs, const object& pyFirst, const object& pyNum,
87 const object& pyMultiplier, const object& pyShape, double fill=0.)
88 {
89 int dim=fs.getDim();
90 std::vector<int> first(dim), numValues(dim), multiplier(dim), shape;
91
92 if (extract<tuple>(pyFirst).check() || extract<list>(pyFirst).check()) {
93 if (len(pyFirst)==dim) {
94 for (int i=0; i<dim; i++) {
95 first[i]=extract<int>(pyFirst[i]);
96 }
97 } else
98 throw RipleyException("Argument 'first' has wrong length");
99 } else
100 throw RipleyException("Argument 'first' must be a tuple or list");
101
102 if (extract<tuple>(pyNum).check() || extract<list>(pyNum).check()) {
103 if (len(pyNum)==dim) {
104 for (int i=0; i<dim; i++) {
105 numValues[i]=extract<int>(pyNum[i]);
106 }
107 } else
108 throw RipleyException("Argument 'numValues' has wrong length");
109 } else
110 throw RipleyException("Argument 'numValues' must be a tuple or list");
111
112 if (extract<tuple>(pyMultiplier).check() || extract<list>(pyMultiplier).check()) {
113 if (len(pyMultiplier)==dim) {
114 for (int i=0; i<dim; i++) {
115 multiplier[i]=extract<int>(pyMultiplier[i]);
116 }
117 } else
118 throw RipleyException("Argument 'multiplier' has wrong length");
119 } else
120 throw RipleyException("Argument 'multiplier' must be a tuple or list");
121
122 if (extract<tuple>(pyShape).check() || extract<list>(pyShape).check()) {
123 for (int i=0; i<len(pyShape); i++) {
124 shape.push_back(extract<int>(pyShape[i]));
125 }
126 } else
127 throw RipleyException("Argument 'shape' must be a tuple or list");
128
129 const RipleyDomain* dom=dynamic_cast<const RipleyDomain*>(fs.getDomain().get());
130 if (!dom)
131 throw RipleyException("Function space must be on a ripley domain");
132
133
134 escript::Data res(fill, shape, fs, true);
135
136 dom->readNcGrid(res, filename, varname, first, numValues, multiplier);
137 return res;
138 }
139
140 // These wrappers are required to make the shared pointers work through the
141 // Python wrapper
142
143 // The double for n? is just to keep python happy when people need to deal with
144 // truediv
145 escript::Domain_ptr _brick(double _n0, double _n1, double _n2, const object& l0,
146 const object& l1, const object& l2, int d0, int d1, int d2)
147 {
148 int n0=static_cast<int>(_n0), n1=static_cast<int>(_n1), n2=static_cast<int>(_n2);
149 double x0=0., x1=1., y0=0., y1=1., z0=0., z1=1.;
150 if (extract<tuple>(l0).check()) {
151 tuple x=extract<tuple>(l0);
152 if (len(x)==2) {
153 x0=extract<double>(x[0]);
154 x1=extract<double>(x[1]);
155 } else
156 throw RipleyException("Argument l0 must be a float or 2-tuple");
157 } else if (extract<double>(l0).check()) {
158 x1=extract<double>(l0);
159 } else
160 throw RipleyException("Argument l0 must be a float or 2-tuple");
161
162 if (extract<tuple>(l1).check()) {
163 tuple y=extract<tuple>(l1);
164 if (len(y)==2) {
165 y0=extract<double>(y[0]);
166 y1=extract<double>(y[1]);
167 } else
168 throw RipleyException("Argument l1 must be a float or 2-tuple");
169 } else if (extract<double>(l1).check()) {
170 y1=extract<double>(l1);
171 } else
172 throw RipleyException("Argument l1 must be a float or 2-tuple");
173
174 if (extract<tuple>(l2).check()) {
175 tuple z=extract<tuple>(l2);
176 if (len(z)==2) {
177 z0=extract<double>(z[0]);
178 z1=extract<double>(z[1]);
179 } else
180 throw RipleyException("Argument l2 must be a float or 2-tuple");
181 } else if (extract<double>(l2).check()) {
182 z1=extract<double>(l2);
183 } else
184 throw RipleyException("Argument l2 must be a float or 2-tuple");
185
186 return escript::Domain_ptr(new Brick(n0,n1,n2, x0,y0,z0, x1,y1,z1, d0,d1,d2));
187 }
188
189 const int _q[]={0x61686969,0x746c4144,0x79616e43};
190 escript::Domain_ptr _rectangle(double _n0, double _n1, const object& l0,
191 const object& l1, int d0, int d1)
192 {
193 int n0=static_cast<int>(_n0), n1=static_cast<int>(_n1);
194 double x0=0., x1=1., y0=0., y1=1.;
195 if (extract<tuple>(l0).check()) {
196 tuple x=extract<tuple>(l0);
197 if (len(x)==2) {
198 x0=extract<double>(x[0]);
199 x1=extract<double>(x[1]);
200 } else
201 throw RipleyException("Argument l0 must be a float or 2-tuple");
202 } else if (extract<double>(l0).check()) {
203 x1=extract<double>(l0);
204 } else
205 throw RipleyException("Argument l0 must be a float or 2-tuple");
206
207 if (extract<tuple>(l1).check()) {
208 tuple y=extract<tuple>(l1);
209 if (len(y)==2) {
210 y0=extract<double>(y[0]);
211 y1=extract<double>(y[1]);
212 } else
213 throw RipleyException("Argument l1 must be a float or 2-tuple");
214 } else if (extract<double>(l1).check()) {
215 y1=extract<double>(l1);
216 } else
217 throw RipleyException("Argument l1 must be a float or 2-tuple");
218
219 return escript::Domain_ptr(new Rectangle(n0,n1, x0,y0, x1,y1, d0,d1));
220 }
221 std::string _who(){int a[]={_q[0]^42,_q[1]^42,_q[2]^42,0};return (char*)&a[0];}
222
223 } // end of namespace
224
225
226 BOOST_PYTHON_MODULE(ripleycpp)
227 {
228 // This feature was added in boost v1.34
229 #if ((BOOST_VERSION/100)%1000 > 34) || (BOOST_VERSION/100000 >1)
230 // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
231 docstring_options docopt(true, true, false);
232 #endif
233
234 register_exception_translator<ripley::RipleyException>(&(esysUtils::esysExceptionTranslator));
235
236 scope().attr("__doc__") = "To use this module, please import esys.ripley";
237
238 def("Brick", ripley::_brick, (arg("n0"),arg("n1"),arg("n2"),arg("l0")=1.0,arg("l1")=1.0,arg("l2")=1.0,arg("d0")=-1,arg("d1")=-1,arg("d2")=-1),
239 "Creates a hexagonal mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2].\n\n"
240 ":param n0: number of elements in direction 0\n:type n0: ``int``\n"
241 ":param n1: number of elements in direction 1\n:type n1: ``int``\n"
242 ":param n2: number of elements in direction 2\n:type n2: ``int``\n"
243 ":param l0: length of side 0 or coordinate range of side 0\n:type l0: ``float`` or ``tuple``\n"
244 ":param l1: length of side 1 or coordinate range of side 1\n:type l1: ``float`` or ``tuple``\n"
245 ":param l2: length of side 2 or coordinate range of side 2\n:type l2: ``float`` or ``tuple``\n"
246 ":param d0: number of subdivisions in direction 0\n:type d0: ``int``\n"
247 ":param d1: number of subdivisions in direction 1\n:type d1: ``int``\n"
248 ":param d2: number of subdivisions in direction 2\n:type d2: ``int``");
249
250 def("Rectangle", ripley::_rectangle, (arg("n0"),arg("n1"),arg("l0")=1.0,arg("l1")=1.0,arg("d0")=-1,arg("d1")=-1),
251 "Creates a rectangular mesh with n0 x n1 elements over the rectangle [0,l0] x [0,l1].\n\n"
252 ":param n0: number of elements in direction 0\n:type n0: ``int``\n"
253 ":param n1: number of elements in direction 1\n:type n1: ``int``\n"
254 ":param l0: length of side 0 or coordinate range of side 0\n:type l0: ``float`` or ``tuple``\n"
255 ":param l1: length of side 1 or coordinate range of side 1\n:type l1: ``float`` or ``tuple``\n"
256 ":param d0: number of subdivisions in direction 0\n:type d0: ``int``\n"
257 ":param d1: number of subdivisions in direction 1\n:type d1: ``int``");
258 def("_theculprit_", ripley::_who);
259 def("LoadMesh", ripley::RipleyDomain::loadMesh, (arg("filename")),
260 "Loads a ripley domain from a dump file" ":rtype: `Domain`");
261
262 def("ReadMesh", ripley::RipleyDomain::readMesh, (arg("filename")),
263 "Reads a ripley domain from a file created by write().\n\n"
264 ":rtype: `RipleyDomain`\n:param filename:\n:type filename: ``string``\n");
265
266 def("_readBinaryGrid", &ripley::readBinaryGrid, (arg("filename"), arg("functionspace"), arg("first"), arg("numValues"), arg("multiplier"), arg("shape"), arg("fill")=0.));
267
268 def("_readNcGrid", &ripley::readNcGrid, (arg("filename"), arg("varname"), arg("functionspace"), arg("first"), arg("numValues"), arg("multiplier"), arg("shape"), arg("fill")=0.));
269
270 class_<ripley::RipleyDomain, bases<escript::AbstractContinuousDomain>, boost::noncopyable >
271 ("RipleyDomain", "", no_init)
272 .def("write", &ripley::RipleyDomain::write, args("filename"),
273 "Writes the current mesh to a file with the given name. It can subsequently be recovered using ReadMesh().")
274 .def("print_mesh_info", &ripley::RipleyDomain::Print_Mesh_Info, (arg("full")=false),
275 "Prints out a summary about the mesh.\n"
276 ":param full: whether to output additional data\n:type full: ``bool``")
277 .def("dump", &ripley::RipleyDomain::dump, args("filename"),
278 "Dumps the mesh to a file with the given name.")
279 .def("getDescription", &ripley::RipleyDomain::getDescription,
280 ":return: a description for this domain\n:rtype: ``string``")
281 .def("getDim", &ripley::RipleyDomain::getDim, ":rtype: ``int``")
282 .def("getDataShape", &ripley::RipleyDomain::getDataShape, args("functionSpaceCode"),
283 ":return: a pair (dps, ns) where dps=the number of data points per sample, and ns=the number of samples\n:rtype: ``tuple``")
284 .def("getNumDataPointsGlobal", &ripley::RipleyDomain::getNumDataPointsGlobal,
285 ":return: the number of data points summed across all MPI processes\n"
286 ":rtype: ``int``")
287 .def("addPDEToSystem",&ripley::RipleyDomain::addPDEToSystem,
288 args("mat", "rhs", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
289 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
290 ":param mat:\n:type mat: `OperatorAdapter`\n:param rhs:\n:type rhs: `Data`\n"
291 ":param A:\n:type A: `Data`\n"
292 ":param B:\n:type B: `Data`\n"
293 ":param C:\n:type C: `Data`\n"
294 ":param D:\n:type D: `Data`\n"
295 ":param X:\n:type X: `Data`\n"
296 ":param Y:\n:type Y: `Data`\n"
297 ":param d:\n:type d: `Data`\n"
298 ":param d_contact:\n:type d_contact: `Data`\n"
299 ":param y_contact:\n:type y_contact: `Data`"
300 )
301 .def("addPDEToRHS",&ripley::RipleyDomain::addPDEToRHS,
302 args("rhs", "X", "Y", "y", "y_contact"),
303 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
304 ":param rhs:\n:type rhs: `Data`\n"
305 ":param X:\n:type X: `Data`\n"
306 ":param Y:\n:type Y: `Data`\n"
307 ":param y:\n:type y: `Data`\n"
308 ":param y_contact:\n:type y_contact: `Data`"
309 )
310 .def("addPDEToTransportProblem",&ripley::RipleyDomain::addPDEToTransportProblem,
311 args( "tp", "source", "M", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
312 ":param tp:\n:type tp: `TransportProblemAdapter`\n"
313 ":param source:\n:type source: `Data`\n"
314 ":param M:\n:type M: `Data`\n"
315 ":param A:\n:type A: `Data`\n"
316 ":param B:\n:type B: `Data`\n"
317 ":param C:\n:type C: `Data`\n"
318 ":param D:\n:type D: `Data`\n"
319 ":param X:\n:type X: `Data`\n"
320 ":param Y:\n:type Y: `Data`\n"
321 ":param d:\n:type d: `Data`\n"
322 ":param y:\n:type y: `Data`\n"
323 ":param d_contact:\n:type d_contact: `Data`\n"
324 ":param y_contact:\n:type y_contact: `Data`"
325 )
326 .def("newOperator",&ripley::RipleyDomain::newSystemMatrix,
327 args("row_blocksize", "row_functionspace", "column_blocksize", "column_functionspace", "type"),
328 "creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros\n\n"
329 ":param row_blocksize:\n:type row_blocksize: ``int``\n"
330 ":param row_functionspace:\n:type row_functionspace: `FunctionSpace`\n"
331 ":param column_blocksize:\n:type column_blocksize: ``int``\n"
332 ":param column_functionspace:\n:type column_functionspace: `FunctionSpace`\n"
333 ":param type:\n:type type: ``int``"
334 )
335 .def("newTransportProblem",&ripley::RipleyDomain::newTransportProblem,
336 args("theta", "blocksize", "functionspace", "type"),
337 "creates a TransportProblemAdapter\n\n"
338 ":param theta:\n:type theta: ``float``\n"
339 ":param blocksize:\n:type blocksize: ``int``\n"
340 ":param functionspace:\n:type functionspace: `FunctionSpace`\n"
341 ":param type:\n:type type: ``int``"
342 )
343 .def("getSystemMatrixTypeId",&ripley::RipleyDomain::getSystemMatrixTypeId,
344 args("solver", "preconditioner", "package", "symmetry"),
345 ":return: the identifier of the matrix type to be used for the global stiffness matrix when a particular solver, package, preconditioner, and symmetric matrix is used.\n"
346 ":rtype: ``int``\n"
347 ":param solver:\n:type solver: ``int``\n"
348 ":param preconditioner:\n:type preconditioner: ``int``\n"
349 ":param package:\n:type package: ``int``\n"
350 ":param symmetry:\n:type symmetry: ``int``"
351 )
352 .def("getTransportTypeId",&ripley::RipleyDomain::getTransportTypeId,
353 args("solver", "preconditioner", "package", "symmetry"),
354 ":return: the identifier of the transport problem type to be used when a particular solver, preconditioner, package and symmetric matrix is used.\n"
355 ":rtype: ``int``\n"
356 ":param solver:\n:type solver: ``int``\n"
357 ":param preconditioner:\n:type preconditioner: ``int``\n"
358 ":param package:\n:type package: ``int``\n"
359 ":param symmetry:\n:type symmetry: ``int``"
360 )
361 .def("getX",&ripley::RipleyDomain::getX, ":return: locations in the FEM nodes\n\n"
362 ":rtype: `Data`")
363 .def("getNormal",&ripley::RipleyDomain::getNormal,
364 ":return: boundary normals at the quadrature point on the face elements\n"
365 ":rtype: `Data`")
366 .def("getSize",&ripley::RipleyDomain::getSize,":return: the element size\n"
367 ":rtype: `Data`")
368 .def("setTagMap",&ripley::RipleyDomain::setTagMap,args("name","tag"),
369 "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
370 ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")
371 .def("getTag",&ripley::RipleyDomain::getTag,args("name"),":return: tag id for "
372 "``name``\n:rtype: ``string``")
373 .def("isValidTagName",&ripley::RipleyDomain::isValidTagName,args("name"),
374 ":return: True if ``name`` corresponds to a tag, otherwise False\n:rtype: ``bool``")
375 .def("showTagNames",&ripley::RipleyDomain::showTagNames,":return: A space separated list of tag names\n:rtype: ``string``")
376 .def("getMPISize",&ripley::RipleyDomain::getMPISize,":return: the number of processes used for this `Domain`\n:rtype: ``int``")
377 .def("getMPIRank",&ripley::RipleyDomain::getMPIRank,":return: the rank of this process\n:rtype: ``int``")
378 .def("MPIBarrier",&ripley::RipleyDomain::MPIBarrier,"Wait until all processes have reached this point")
379 .def("onMasterProcessor",&ripley::RipleyDomain::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`");
380
381 class_<ripley::Brick, bases<ripley::RipleyDomain> >("RipleyBrick", "", no_init);
382 class_<ripley::Rectangle, bases<ripley::RipleyDomain> >("RipleyRectangle", "", no_init);
383 }
384

  ViewVC Help
Powered by ViewVC 1.1.26