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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3697 - (hide annotations)
Mon Nov 28 04:52:00 2011 UTC (7 years, 4 months ago) by caltinay
Original Path: branches/ripleygmg_from_3668/ripley/src/ripleycpp.cpp
File size: 10481 byte(s)
[x] Rectangle node id's and weipa compatibility
[ ] Brick...

1 caltinay 3670
2     /*******************************************************
3     *
4     * Copyright (c) 2003-2011 by University of Queensland
5     * 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 3691 escript::Domain_ptr _brick(int n0, int n1, int n2, double l0, double l1, double l2, int d0, int d1, int d2)
32     {
33     return escript::Domain_ptr(new Brick(n0, n1, n2, l0, l1, l2, d0, d1, d2));
34     }
35 caltinay 3670
36 caltinay 3691 escript::Domain_ptr _rectangle(int n0, int n1, double l0, double l1, int d0, int d1)
37     {
38     return escript::Domain_ptr(new Rectangle(n0, n1, l0, l1, d0, d1));
39     }
40 caltinay 3670
41 caltinay 3691 }
42 caltinay 3670
43 caltinay 3691 /**
44     \page ripley Ripley
45     Ripley is the python module name that contains the interfaces
46     to the C++ wrapper to ripley.
47 caltinay 3670 */
48    
49     BOOST_PYTHON_MODULE(ripleycpp)
50     {
51     // This feature was added in boost v1.34
52     #if ((BOOST_VERSION/100)%1000 > 34) || (BOOST_VERSION/100000 >1)
53 caltinay 3691 // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
54     docstring_options docopt(true, true, false);
55 caltinay 3670 #endif
56    
57 caltinay 3691 register_exception_translator<ripley::RipleyException>(&(esysUtils::esysExceptionTranslator));
58 caltinay 3670
59 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),
60     "Creates a hexagonal mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2].\n\n"
61     ":param n0: number of elements in direction 0\n:type n0: ``int``\n"
62     ":param n1: number of elements in direction 1\n:type n1: ``int``\n"
63     ":param n2: number of elements in direction 2\n:type n2: ``int``\n"
64     ":param l0: length of side 0\n:type l0: ``float``\n"
65     ":param l1: length of side 1\n:type l1: ``float``\n"
66     ":param l2: length of side 2\n:type l2: ``float``\n"
67     ":param d0: number of subdivisions in direction 0\n:type d0: ``int``\n"
68     ":param d1: number of subdivisions in direction 1\n:type d1: ``int``\n"
69     ":param d2: number of subdivisions in direction 2\n:type d2: ``int``");
70 caltinay 3670
71 caltinay 3691 def("Rectangle", ripley::_rectangle, (arg("n0"),arg("n1"),arg("l0")=1.0,arg("l1")=1.0,arg("d0")=1,arg("d1")=1),
72     "Creates a rectangular mesh with n0 x n1 elements over the rectangle [0,l0] x [0,l1].\n\n"
73     ":param n0: number of elements in direction 0\n:type n0: ``int``\n"
74     ":param n1: number of elements in direction 1\n:type n1: ``int``\n"
75     ":param l0: length of side 0\n:type l0: ``float``\n"
76     ":param l1: length of side 1\n:type l1: ``float``\n"
77     ":param d0: number of subdivisions in direction 0\n:type d0: ``int``\n"
78     ":param d1: number of subdivisions in direction 1\n:type d1: ``int``");
79 caltinay 3670
80 caltinay 3691 def("LoadMesh", ripley::RipleyDomain::loadMesh, (arg("filename")),
81     "Loads a ripley domain from a dump file" ":rtype: `Domain`");
82 caltinay 3670
83 caltinay 3691 def("ReadMesh", ripley::RipleyDomain::readMesh, (arg("filename")),
84     "Reads a ripley domain from a file created by write().\n\n"
85     ":rtype: `RipleyDomain`\n:param filename:\n:type filename: ``string``\n");
86 caltinay 3670
87 caltinay 3691 class_<ripley::RipleyDomain, bases<escript::AbstractContinuousDomain> >
88     ("RipleyDomain", "", no_init)
89     .def("write", &ripley::RipleyDomain::write, args("filename"),
90     "Writes the current mesh to a file with the given name. It can subsequently be recovered using ReadMesh().")
91     .def("print_mesh_info", &ripley::RipleyDomain::Print_Mesh_Info, (arg("full")=false),
92     "Prints out a summary about the mesh.\n"
93     ":param full: whether to output additional data\n:type full: ``bool``")
94     .def("dump", &ripley::RipleyDomain::dump, args("filename"),
95     "Dumps the mesh to a file with the given name.")
96     .def("getDescription", &ripley::RipleyDomain::getDescription,
97 caltinay 3670 ":return: a description for this domain\n:rtype: ``string``")
98 caltinay 3691 .def("getDim", &ripley::RipleyDomain::getDim, ":rtype: ``int``")
99     .def("getDataShape", &ripley::RipleyDomain::getDataShape, args("functionSpaceCode"),
100 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``")
101 caltinay 3691 .def("getNumDataPointsGlobal", &ripley::RipleyDomain::getNumDataPointsGlobal,
102 caltinay 3670 ":return: the number of data points summed across all MPI processes\n"
103     ":rtype: ``int``")
104 caltinay 3691 .def("addPDEToSystem",&ripley::RipleyDomain::addPDEToSystem,
105     args("mat", "rhs", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
106 caltinay 3670 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
107     ":param mat:\n:type mat: `OperatorAdapter`\n:param rhs:\n:type rhs: `Data`\n"
108     ":param A:\n:type A: `Data`\n"
109     ":param B:\n:type B: `Data`\n"
110     ":param C:\n:type C: `Data`\n"
111     ":param D:\n:type D: `Data`\n"
112     ":param X:\n:type X: `Data`\n"
113     ":param Y:\n:type Y: `Data`\n"
114     ":param d:\n:type d: `Data`\n"
115     ":param d_contact:\n:type d_contact: `Data`\n"
116     ":param y_contact:\n:type y_contact: `Data`\n"
117     )
118 caltinay 3691 .def("addPDEToLumpedSystem",&ripley::RipleyDomain::addPDEToLumpedSystem,
119 caltinay 3670 args("mat", "D", "d"),
120     "adds a PDE onto the lumped stiffness matrix\n\n"
121     ":param mat:\n:type mat: `Data`\n"
122     ":param D:\n:type D: `Data`\n"
123     ":param d:\n:type d: `Data`\n"
124     ":param useHRZ:\n:type useHRZ: bool\n"
125     )
126 caltinay 3691 .def("addPDEToRHS",&ripley::RipleyDomain::addPDEToRHS,
127 caltinay 3670 args("rhs", "X", "Y", "y", "y_contact"),
128     "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
129     ":param rhs:\n:type rhs: `Data`\n"
130     ":param X:\n:type X: `Data`\n"
131     ":param Y:\n:type Y: `Data`\n"
132     ":param y:\n:type y: `Data`\n"
133     ":param y_contact:\n:type y_contact: `Data`"
134     )
135 caltinay 3691 .def("addPDEToTransportProblem",&ripley::RipleyDomain::addPDEToTransportProblem,
136 caltinay 3670 args( "tp", "source", "M", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
137     ":param tp:\n:type tp: `TransportProblemAdapter`\n"
138     ":param source:\n:type source: `Data`\n"
139     ":param M:\n:type M: `Data`\n"
140     ":param A:\n:type A: `Data`\n"
141     ":param B:\n:type B: `Data`\n"
142     ":param C:\n:type C: `Data`\n"
143     ":param D:\n:type D: `Data`\n"
144     ":param X:\n:type X: `Data`\n"
145     ":param Y:\n:type Y: `Data`\n"
146     ":param d:\n:type d: `Data`\n"
147     ":param y:\n:type y: `Data`\n"
148     ":param d_contact:\n:type d_contact: `Data`\n"
149     ":param y_contact:\n:type y_contact: `Data`\n"
150     )
151 caltinay 3691 .def("newOperator",&ripley::RipleyDomain::newSystemMatrix,
152 caltinay 3670 args("row_blocksize", "row_functionspace", "column_blocksize", "column_functionspace", "type"),
153     "creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros\n\n"
154     ":param row_blocksize:\n:type row_blocksize: ``int``\n"
155     ":param row_functionspace:\n:type row_functionspace: `FunctionSpace`\n"
156     ":param column_blocksize:\n:type column_blocksize: ``int``\n"
157     ":param column_functionspace:\n:type column_functionspace: `FunctionSpace`\n"
158     ":param type:\n:type type: ``int``\n"
159     )
160 caltinay 3691 .def("newTransportProblem",&ripley::RipleyDomain::newTransportProblem,
161 caltinay 3670 args("theta", "blocksize", "functionspace", "type"),
162     "creates a TransportProblemAdapter\n\n"
163     ":param theta:\n:type theta: ``float``\n"
164     ":param blocksize:\n:type blocksize: ``int``\n"
165     ":param functionspace:\n:type functionspace: `FunctionSpace`\n"
166     ":param type:\n:type type: ``int``\n"
167     )
168 caltinay 3691 .def("getSystemMatrixTypeId",&ripley::RipleyDomain::getSystemMatrixTypeId,
169 caltinay 3670 args("solver", "preconditioner", "package", "symmetry"),
170 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"
171 caltinay 3670 ":rtype: ``int``\n"
172     ":param solver:\n:type solver: ``int``\n"
173     ":param preconditioner:\n:type preconditioner: ``int``\n"
174     ":param package:\n:type package: ``int``\n"
175     ":param symmetry:\n:type symmetry: ``int``\n"
176     )
177 caltinay 3691 .def("getTransportTypeId",&ripley::RipleyDomain::getTransportTypeId,
178 caltinay 3670 args("solver", "preconditioner", "package", "symmetry"),
179 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"
180 caltinay 3670 ":rtype: ``int``\n"
181     ":param solver:\n:type solver: ``int``\n"
182     ":param preconditioner:\n:type preconditioner: ``int``\n"
183     ":param package:\n:type package: ``int``\n"
184     ":param symmetry:\n:type symmetry: ``int``\n"
185     )
186 caltinay 3691 // .def("setX",&ripley::RipleyDomain::setNewX,
187     //args("arg"), "assigns new location to the domain\n\n:param arg:\n:type arg: `Data`")
188     .def("getX",&ripley::RipleyDomain::getX, ":return: locations in the FEM nodes\n\n"
189 caltinay 3670 ":rtype: `Data`")
190 caltinay 3691 .def("getNormal",&ripley::RipleyDomain::getNormal,
191 caltinay 3670 ":return: boundary normals at the quadrature point on the face elements\n"
192     ":rtype: `Data`")
193 caltinay 3691 .def("getSize",&ripley::RipleyDomain::getSize,":return: the element size\n"
194 caltinay 3670 ":rtype: `Data`")
195 caltinay 3691 .def("setTagMap",&ripley::RipleyDomain::setTagMap,args("name","tag"),
196 caltinay 3670 "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
197     ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")
198 caltinay 3691 .def("getTag",&ripley::RipleyDomain::getTag,args("name"),":return: tag id for "
199 caltinay 3670 "``name``\n:rtype: ``string``")
200 caltinay 3691 .def("isValidTagName",&ripley::RipleyDomain::isValidTagName,args("name"),
201     ":return: True if ``name`` corresponds to a tag, otherwise False\n:rtype: ``bool``")
202     .def("showTagNames",&ripley::RipleyDomain::showTagNames,":return: A space separated list of tag names\n:rtype: ``string``")
203     .def("getMPISize",&ripley::RipleyDomain::getMPISize,":return: the number of processes used for this `Domain`\n:rtype: ``int``")
204     .def("getMPIRank",&ripley::RipleyDomain::getMPIRank,":return: the rank of this process\n:rtype: ``int``")
205     .def("MPIBarrier",&ripley::RipleyDomain::MPIBarrier,"Wait until all processes have reached this point")
206     .def("onMasterProcessor",&ripley::RipleyDomain::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`");
207 caltinay 3670
208 caltinay 3691 class_<ripley::Brick, bases<ripley::RipleyDomain> >("RipleyBrick", "", no_init);
209 caltinay 3670
210 caltinay 3691 class_<ripley::Rectangle, bases<ripley::RipleyDomain> >("RipleyRectangle", "", no_init);
211    
212 caltinay 3670 }
213    

  ViewVC Help
Powered by ViewVC 1.1.26