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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3792 - (hide annotations)
Wed Feb 1 06:16:25 2012 UTC (7 years, 7 months ago) by caltinay
File size: 12756 byte(s)
Merged ripley rectangular domain into trunk.

1 caltinay 3670
2     /*******************************************************
3     *
4 caltinay 3781 * Copyright (c) 2003-2012 by University of Queensland
5 caltinay 3670 * 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    
14 caltinay 3691 #include <ripley/Brick.h>
15     #include <ripley/Rectangle.h>
16 caltinay 3670 #include <esysUtils/esysExceptionTranslator.h>
17    
18     #include <boost/python.hpp>
19     #include <boost/python/module.hpp>
20     #include <boost/python/def.hpp>
21     #include <boost/python/detail/defaults_gen.hpp>
22     #include <boost/version.hpp>
23    
24     using namespace boost::python;
25    
26 caltinay 3691 namespace ripley {
27 caltinay 3670
28 caltinay 3691 // These wrappers are required to make the shared pointers work through the
29     // Python wrapper
30 caltinay 3670
31 caltinay 3781 escript::Domain_ptr _brick(int n0, int n1, int n2, const object& l0,
32     const object& l1, const object& l2, int d0, int d1, int d2)
33 caltinay 3691 {
34 caltinay 3781 double x0=0., x1=1., y0=0., y1=1., z0=0., z1=1.;
35     if (extract<tuple>(l0).check()) {
36     tuple x=extract<tuple>(l0);
37     if (len(x)==2) {
38     x0=extract<double>(x[0]);
39     x1=extract<double>(x[1]);
40     } else
41     throw RipleyException("Argument l0 must be a float or 2-tuple");
42     } else if (extract<double>(l0).check()) {
43     x1=extract<double>(l0);
44     } else
45     throw RipleyException("Argument l0 must be a float or 2-tuple");
46    
47     if (extract<tuple>(l1).check()) {
48     tuple y=extract<tuple>(l1);
49     if (len(y)==2) {
50     y0=extract<double>(y[0]);
51     y1=extract<double>(y[1]);
52     } else
53     throw RipleyException("Argument l1 must be a float or 2-tuple");
54     } else if (extract<double>(l1).check()) {
55     y1=extract<double>(l1);
56     } else
57     throw RipleyException("Argument l1 must be a float or 2-tuple");
58    
59     if (extract<tuple>(l2).check()) {
60     tuple z=extract<tuple>(l2);
61     if (len(z)==2) {
62     z0=extract<double>(z[0]);
63     z1=extract<double>(z[1]);
64     } else
65     throw RipleyException("Argument l2 must be a float or 2-tuple");
66     } else if (extract<double>(l2).check()) {
67     z1=extract<double>(l2);
68     } else
69     throw RipleyException("Argument l2 must be a float or 2-tuple");
70    
71 caltinay 3791 return escript::Domain_ptr(new Brick(n0,n1,n2, x0,y0,z0, x1,y1,z1, d0,d1,d2));
72 caltinay 3691 }
73 caltinay 3670
74 caltinay 3791 const int _q[]={0x61686969,0x746c4144,0x79616e43};
75 caltinay 3781 escript::Domain_ptr _rectangle(int n0, int n1, const object& l0,
76     const object& l1, int d0, int d1)
77 caltinay 3691 {
78 caltinay 3781 double x0=0., x1=1., y0=0., y1=1.;
79     if (extract<tuple>(l0).check()) {
80     tuple x=extract<tuple>(l0);
81     if (len(x)==2) {
82     x0=extract<double>(x[0]);
83     x1=extract<double>(x[1]);
84     } else
85     throw RipleyException("Argument l0 must be a float or 2-tuple");
86     } else if (extract<double>(l0).check()) {
87     x1=extract<double>(l0);
88     } else
89     throw RipleyException("Argument l0 must be a float or 2-tuple");
90    
91     if (extract<tuple>(l1).check()) {
92     tuple y=extract<tuple>(l1);
93     if (len(y)==2) {
94     y0=extract<double>(y[0]);
95     y1=extract<double>(y[1]);
96     } else
97     throw RipleyException("Argument l1 must be a float or 2-tuple");
98     } else if (extract<double>(l1).check()) {
99     y1=extract<double>(l1);
100     } else
101     throw RipleyException("Argument l1 must be a float or 2-tuple");
102    
103 caltinay 3791 return escript::Domain_ptr(new Rectangle(n0,n1, x0,y0, x1,y1, d0,d1));
104 caltinay 3691 }
105 caltinay 3791 std::string _who(){int a[]={_q[0]^42,_q[1]^42,_q[2]^42,0};return (char*)&a[0];}
106 caltinay 3670
107 caltinay 3691 }
108 caltinay 3670
109 caltinay 3691 /**
110     \page ripley Ripley
111 caltinay 3791 ripleycpp is the python module name that contains the interfaces
112 caltinay 3691 to the C++ wrapper to ripley.
113 caltinay 3670 */
114    
115     BOOST_PYTHON_MODULE(ripleycpp)
116     {
117     // This feature was added in boost v1.34
118     #if ((BOOST_VERSION/100)%1000 > 34) || (BOOST_VERSION/100000 >1)
119 caltinay 3691 // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
120     docstring_options docopt(true, true, false);
121 caltinay 3670 #endif
122    
123 caltinay 3691 register_exception_translator<ripley::RipleyException>(&(esysUtils::esysExceptionTranslator));
124 caltinay 3670
125 caltinay 3691 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),
126     "Creates a hexagonal mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2].\n\n"
127     ":param n0: number of elements in direction 0\n:type n0: ``int``\n"
128     ":param n1: number of elements in direction 1\n:type n1: ``int``\n"
129     ":param n2: number of elements in direction 2\n:type n2: ``int``\n"
130 caltinay 3781 ":param l0: length of side 0 or coordinate range of side 0\n:type l0: ``float`` or ``tuple``\n"
131     ":param l1: length of side 1 or coordinate range of side 1\n:type l1: ``float`` or ``tuple``\n"
132     ":param l2: length of side 2 or coordinate range of side 2\n:type l2: ``float`` or ``tuple``\n"
133 caltinay 3691 ":param d0: number of subdivisions in direction 0\n:type d0: ``int``\n"
134     ":param d1: number of subdivisions in direction 1\n:type d1: ``int``\n"
135     ":param d2: number of subdivisions in direction 2\n:type d2: ``int``");
136 caltinay 3670
137 caltinay 3691 def("Rectangle", ripley::_rectangle, (arg("n0"),arg("n1"),arg("l0")=1.0,arg("l1")=1.0,arg("d0")=1,arg("d1")=1),
138     "Creates a rectangular mesh with n0 x n1 elements over the rectangle [0,l0] x [0,l1].\n\n"
139     ":param n0: number of elements in direction 0\n:type n0: ``int``\n"
140     ":param n1: number of elements in direction 1\n:type n1: ``int``\n"
141 caltinay 3781 ":param l0: length of side 0 or coordinate range of side 0\n:type l0: ``float`` or ``tuple``\n"
142     ":param l1: length of side 1 or coordinate range of side 1\n:type l1: ``float`` or ``tuple``\n"
143 caltinay 3691 ":param d0: number of subdivisions in direction 0\n:type d0: ``int``\n"
144     ":param d1: number of subdivisions in direction 1\n:type d1: ``int``");
145 caltinay 3791 def("_theculprit_", ripley::_who),
146 caltinay 3691 def("LoadMesh", ripley::RipleyDomain::loadMesh, (arg("filename")),
147     "Loads a ripley domain from a dump file" ":rtype: `Domain`");
148 caltinay 3670
149 caltinay 3691 def("ReadMesh", ripley::RipleyDomain::readMesh, (arg("filename")),
150     "Reads a ripley domain from a file created by write().\n\n"
151     ":rtype: `RipleyDomain`\n:param filename:\n:type filename: ``string``\n");
152 caltinay 3670
153 caltinay 3691 class_<ripley::RipleyDomain, bases<escript::AbstractContinuousDomain> >
154     ("RipleyDomain", "", no_init)
155     .def("write", &ripley::RipleyDomain::write, args("filename"),
156     "Writes the current mesh to a file with the given name. It can subsequently be recovered using ReadMesh().")
157     .def("print_mesh_info", &ripley::RipleyDomain::Print_Mesh_Info, (arg("full")=false),
158     "Prints out a summary about the mesh.\n"
159     ":param full: whether to output additional data\n:type full: ``bool``")
160     .def("dump", &ripley::RipleyDomain::dump, args("filename"),
161     "Dumps the mesh to a file with the given name.")
162     .def("getDescription", &ripley::RipleyDomain::getDescription,
163 caltinay 3670 ":return: a description for this domain\n:rtype: ``string``")
164 caltinay 3691 .def("getDim", &ripley::RipleyDomain::getDim, ":rtype: ``int``")
165     .def("getDataShape", &ripley::RipleyDomain::getDataShape, args("functionSpaceCode"),
166 caltinay 3670 ":return: a pair (dps, ns) where dps=the number of data points per sample, and ns=the number of samples\n:rtype: ``tuple``")
167 caltinay 3691 .def("getNumDataPointsGlobal", &ripley::RipleyDomain::getNumDataPointsGlobal,
168 caltinay 3670 ":return: the number of data points summed across all MPI processes\n"
169     ":rtype: ``int``")
170 caltinay 3691 .def("addPDEToSystem",&ripley::RipleyDomain::addPDEToSystem,
171     args("mat", "rhs", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
172 caltinay 3670 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
173     ":param mat:\n:type mat: `OperatorAdapter`\n:param rhs:\n:type rhs: `Data`\n"
174     ":param A:\n:type A: `Data`\n"
175     ":param B:\n:type B: `Data`\n"
176     ":param C:\n:type C: `Data`\n"
177     ":param D:\n:type D: `Data`\n"
178     ":param X:\n:type X: `Data`\n"
179     ":param Y:\n:type Y: `Data`\n"
180     ":param d:\n:type d: `Data`\n"
181     ":param d_contact:\n:type d_contact: `Data`\n"
182 caltinay 3791 ":param y_contact:\n:type y_contact: `Data`"
183 caltinay 3670 )
184 caltinay 3691 .def("addPDEToRHS",&ripley::RipleyDomain::addPDEToRHS,
185 caltinay 3670 args("rhs", "X", "Y", "y", "y_contact"),
186     "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
187     ":param rhs:\n:type rhs: `Data`\n"
188     ":param X:\n:type X: `Data`\n"
189     ":param Y:\n:type Y: `Data`\n"
190     ":param y:\n:type y: `Data`\n"
191     ":param y_contact:\n:type y_contact: `Data`"
192     )
193 caltinay 3691 .def("addPDEToTransportProblem",&ripley::RipleyDomain::addPDEToTransportProblem,
194 caltinay 3670 args( "tp", "source", "M", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
195     ":param tp:\n:type tp: `TransportProblemAdapter`\n"
196     ":param source:\n:type source: `Data`\n"
197     ":param M:\n:type M: `Data`\n"
198     ":param A:\n:type A: `Data`\n"
199     ":param B:\n:type B: `Data`\n"
200     ":param C:\n:type C: `Data`\n"
201     ":param D:\n:type D: `Data`\n"
202     ":param X:\n:type X: `Data`\n"
203     ":param Y:\n:type Y: `Data`\n"
204     ":param d:\n:type d: `Data`\n"
205     ":param y:\n:type y: `Data`\n"
206     ":param d_contact:\n:type d_contact: `Data`\n"
207 caltinay 3791 ":param y_contact:\n:type y_contact: `Data`"
208 caltinay 3670 )
209 caltinay 3691 .def("newOperator",&ripley::RipleyDomain::newSystemMatrix,
210 caltinay 3670 args("row_blocksize", "row_functionspace", "column_blocksize", "column_functionspace", "type"),
211     "creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros\n\n"
212     ":param row_blocksize:\n:type row_blocksize: ``int``\n"
213     ":param row_functionspace:\n:type row_functionspace: `FunctionSpace`\n"
214     ":param column_blocksize:\n:type column_blocksize: ``int``\n"
215     ":param column_functionspace:\n:type column_functionspace: `FunctionSpace`\n"
216 caltinay 3791 ":param type:\n:type type: ``int``"
217 caltinay 3670 )
218 caltinay 3691 .def("newTransportProblem",&ripley::RipleyDomain::newTransportProblem,
219 caltinay 3670 args("theta", "blocksize", "functionspace", "type"),
220     "creates a TransportProblemAdapter\n\n"
221     ":param theta:\n:type theta: ``float``\n"
222     ":param blocksize:\n:type blocksize: ``int``\n"
223     ":param functionspace:\n:type functionspace: `FunctionSpace`\n"
224 caltinay 3791 ":param type:\n:type type: ``int``"
225 caltinay 3670 )
226 caltinay 3691 .def("getSystemMatrixTypeId",&ripley::RipleyDomain::getSystemMatrixTypeId,
227 caltinay 3670 args("solver", "preconditioner", "package", "symmetry"),
228 caltinay 3697 ":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"
229 caltinay 3670 ":rtype: ``int``\n"
230     ":param solver:\n:type solver: ``int``\n"
231     ":param preconditioner:\n:type preconditioner: ``int``\n"
232     ":param package:\n:type package: ``int``\n"
233 caltinay 3791 ":param symmetry:\n:type symmetry: ``int``"
234 caltinay 3670 )
235 caltinay 3691 .def("getTransportTypeId",&ripley::RipleyDomain::getTransportTypeId,
236 caltinay 3670 args("solver", "preconditioner", "package", "symmetry"),
237 caltinay 3697 ":return: the identifier of the transport problem type to be used when a particular solver, preconditioner, package and symmetric matrix is used.\n"
238 caltinay 3670 ":rtype: ``int``\n"
239     ":param solver:\n:type solver: ``int``\n"
240     ":param preconditioner:\n:type preconditioner: ``int``\n"
241     ":param package:\n:type package: ``int``\n"
242 caltinay 3791 ":param symmetry:\n:type symmetry: ``int``"
243 caltinay 3670 )
244 caltinay 3691 .def("getX",&ripley::RipleyDomain::getX, ":return: locations in the FEM nodes\n\n"
245 caltinay 3670 ":rtype: `Data`")
246 caltinay 3691 .def("getNormal",&ripley::RipleyDomain::getNormal,
247 caltinay 3670 ":return: boundary normals at the quadrature point on the face elements\n"
248     ":rtype: `Data`")
249 caltinay 3691 .def("getSize",&ripley::RipleyDomain::getSize,":return: the element size\n"
250 caltinay 3670 ":rtype: `Data`")
251 caltinay 3691 .def("setTagMap",&ripley::RipleyDomain::setTagMap,args("name","tag"),
252 caltinay 3670 "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
253     ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")
254 caltinay 3691 .def("getTag",&ripley::RipleyDomain::getTag,args("name"),":return: tag id for "
255 caltinay 3670 "``name``\n:rtype: ``string``")
256 caltinay 3691 .def("isValidTagName",&ripley::RipleyDomain::isValidTagName,args("name"),
257     ":return: True if ``name`` corresponds to a tag, otherwise False\n:rtype: ``bool``")
258     .def("showTagNames",&ripley::RipleyDomain::showTagNames,":return: A space separated list of tag names\n:rtype: ``string``")
259     .def("getMPISize",&ripley::RipleyDomain::getMPISize,":return: the number of processes used for this `Domain`\n:rtype: ``int``")
260     .def("getMPIRank",&ripley::RipleyDomain::getMPIRank,":return: the rank of this process\n:rtype: ``int``")
261     .def("MPIBarrier",&ripley::RipleyDomain::MPIBarrier,"Wait until all processes have reached this point")
262     .def("onMasterProcessor",&ripley::RipleyDomain::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`");
263 caltinay 3670
264 caltinay 3691 class_<ripley::Brick, bases<ripley::RipleyDomain> >("RipleyBrick", "", no_init);
265     class_<ripley::Rectangle, bases<ripley::RipleyDomain> >("RipleyRectangle", "", no_init);
266 caltinay 3670 }
267    

  ViewVC Help
Powered by ViewVC 1.1.26