/[escript]/trunk/dudley/src/CPPAdapter/dudleycpp.cpp
ViewVC logotype

Annotation of /trunk/dudley/src/CPPAdapter/dudleycpp.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3911 - (hide annotations)
Thu Jun 14 01:01:03 2012 UTC (6 years, 11 months ago) by jfenwick
File size: 14037 byte(s)
Copyright changes
1 jgs 102
2 ksteube 1312 /*******************************************************
3 ksteube 1811 *
4 jfenwick 3911 * Copyright (c) 2003-2012 by University of Queensland
5 ksteube 1811 * 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 ksteube 1312
14 ksteube 1811
15 jfenwick 3231 #ifdef ESYS_MPI
16     #include "esysUtils/Esys_MPI.h"
17 ksteube 817 #endif
18 jgs 102 extern "C" {
19 jfenwick 3082 #include "../Dudley.h"
20 jgs 102 }
21 jgs 472
22 jfenwick 3675 #include <pasowrap/SystemMatrixAdapter.h>
23     #include <pasowrap/TransportProblemAdapter.h>
24    
25 jgs 203 #include "MeshAdapter.h"
26     #include "MeshAdapterFactory.h"
27 jgs 102
28 jfenwick 3086 #include "DudleyAdapterException.h"
29 gross 727 // #include "esysUtils/EsysException.h"
30 robwdcock 682 #include "esysUtils/esysExceptionTranslator.h"
31 jgs 102
32 robwdcock 682 #include "escript/AbstractContinuousDomain.h"
33 jgs 102
34     #include <boost/python.hpp>
35     #include <boost/python/module.hpp>
36     #include <boost/python/def.hpp>
37     #include <boost/python/detail/defaults_gen.hpp>
38 jfenwick 2064 #include <boost/version.hpp>
39 jgs 102
40     using namespace boost::python;
41    
42     /**
43 jfenwick 3082 \page dudley Dudley
44 jfenwick 3086 Dudley is the python module name that contains the interfaces
45 jfenwick 3082 to the C++ wrapper to dudley.
46 jgs 102
47 jgs 121 \version 1.0.0
48 jgs 102
49 jgs 121 \section class_desc Class Description:
50 jgs 102 Data
51    
52 jgs 121 \section class_limits Class Limitations:
53 jgs 102 None
54    
55 jgs 121 \section class_conds Class Conditions of Use:
56 jgs 102 None
57    
58 jgs 121 \section throws Throws:
59 jgs 102 None
60    
61     */
62    
63 jfenwick 3082 BOOST_PYTHON_MODULE(dudleycpp)
64 jgs 102 {
65 jfenwick 2064 // This feature was added in boost v1.34
66 phornby 2076 #if ((BOOST_VERSION/100)%1000 > 34) || (BOOST_VERSION/100000 >1)
67 jfenwick 2061 // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
68     docstring_options docopt(true, true, false);
69 jfenwick 2064 #endif
70 jgs 102
71     //
72     // NOTE: The return_value_policy is necessary for functions that
73     // return pointers.
74 gross 1382 //
75 jfenwick 3086 register_exception_translator<dudley::DudleyAdapterException>(&(esysUtils::esysExceptionTranslator));
76 jgs 102
77 jfenwick 3082 def("LoadMesh",dudley::loadMesh,
78 jfenwick 2625 (arg("fileName")="file.nc"),":rtype: `Domain`"
79 jfenwick 1872 /* ,return_value_policy<manage_new_object>());*/
80     );
81    
82 jfenwick 3082 def("ReadMesh",dudley::readMesh,
83 jfenwick 1872 (arg("fileName")="file.fly",arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1, arg("optimize")=true)
84     /* ,return_value_policy<manage_new_object>());*/
85 jfenwick 2625 ,"Read a mesh from a file. For MPI parallel runs fan out the mesh to multiple processes.\n\n"
86     ":rtype: `Domain`\n:param fileName:\n:type fileName: ``string``\n"
87     ":param integrationOrder: order of the quadrature scheme. If *integrationOrder<0* the integration order is selected independently.\n"
88     ":type integrationOrder: ``int``\n"
89     ":param reducedIntegrationOrder: order of the quadrature scheme. If *reducedIntegrationOrder<0* the integration order is selected independently.\n"
90     ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``");
91 jgs 102
92 jfenwick 3082 def("ReadGmsh",dudley::readGmsh,
93 gross 2722 (arg("fileName")="file.msh",
94     arg("numDim"),
95     arg("integrationOrder")=-1,
96     arg("reducedIntegrationOrder")=-1,
97     arg("optimize")=true,
98     arg("useMacroElements")=false)
99 jfenwick 1872 // ,return_value_policy<manage_new_object>());
100 jfenwick 2625 ,"Read a gmsh mesh file\n\n"
101     ":rtype: `Domain`\n:param fileName:\n:type fileName: ``string``\n"
102     ":param integrationOrder: order of the quadrature scheme. If *integrationOrder<0* the integration order is selected independently.\n"
103     ":type integrationOrder: ``int``\n"
104     ":param reducedIntegrationOrder: order of the quadrature scheme. If *reducedIntegrationOrder<0* the integration order is selected independently.\n"
105 gross 2722 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``\n"
106     ":param useMacroElements: Enable the usage of macro elements instead of second order elements.\n:type useMacroElements: ``bool``"
107     );
108 gross 934
109 jfenwick 3082 def ("Brick",dudley::brick,
110 jgs 102 (arg("n0")=1,arg("n1")=1,arg("n2")=1,
111     arg("order")=1,
112     arg("l0")=1.0,arg("l1")=1.0,arg("l2")=1.0,
113     arg("periodic0")=false,arg("periodic1")=false,arg("periodic2")=false,
114 gross 1059 arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1,
115 ksteube 1312 arg("useElementsOnFace")=false,
116     arg("useFullElementOrder")=false,
117 jfenwick 1872 arg("optimize")=false)
118 jfenwick 3469 ,"Creates a tetrahedral mesh by subdividing n0 x n1 x n2 rectangular elements over the brick [0,l0] x [0,l1] x [0,l2]."
119 jfenwick 3892 "We accept floating point values for n0, n1 only to ease transition of scripts to python3 when the time comes."
120 jfenwick 2625 "\n\n:param n0:\n:type n0:\n:param n1:\n:type n1:\n:param n2:\n:type n2:\n"
121 gross 2722 ":param order: =1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.\n"
122 jfenwick 2625 ":param l0: length of side 0\n:param l1:\n:param l2:\n"
123     ":param integrationOrder: order of the quadrature scheme. If integrationOrder<0 the integration order is selected independently.\n"
124     ":param reducedIntegrationOrder: order of the quadrature scheme. If reducedIntegrationOrder<0 the integration order is selected independently.\n"
125     ":param useElementsOnFace: whether or not to use elements on face\n"
126     ":type useElementsOnFace: ``int``"
127     ":param periodic0: whether or not boundary conditions are periodic\n"
128     ":param periodic1:\n:param periodic2:\n"
129     ":param useFullElementOrder:\n:param optimize:\n"
130 gross 2722 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``"
131 jfenwick 2625 );
132 jgs 102
133 jfenwick 3082 def ("Rectangle",dudley::rectangle,
134 jgs 102 (arg("n0")=1,arg("n1")=1,arg("order")=1,
135     arg("l0")=1.0,arg("l1")=1.0,
136     arg("periodic0")=false,arg("periodic1")=false,
137 gross 1059 arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1,
138 ksteube 1312 arg("useElementsOnFace")=false,
139     arg("useFullElementOrder")=false,
140 jfenwick 1872 arg("optimize")=false)
141 jfenwick 3469 ,"Creates a triangular mesh by subdividing n0 x n1 rectangular elements over the brick [0,l0] x [0,l1]."
142 jfenwick 3892 "We accept floating point values for n0, n1 only to ease transition of scripts to python3 when the time comes."
143 jfenwick 2625 "\n\n:param n0:\n:type n0:\n:param n1:\n:type n1:\n"
144 gross 2722 ":param order: =1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.\n"
145 jfenwick 2625 ":param l0: length of side 0\n:param l1:\n"
146     ":param integrationOrder: order of the quadrature scheme. If integrationOrder<0 the integration order is selected independently.\n"
147     ":param reducedIntegrationOrder: order of the quadrature scheme. If reducedIntegrationOrder<0 the integration order is selected independently.\n"
148     ":param useElementsOnFace: whether or not to use elements on face\n"
149     ":type useElementsOnFace: ``int``"
150     ":param periodic0: whether or not boundary conditions are periodic\n"
151     ":param periodic1:\n"
152 gross 2722 ":param useFullElementOrder:\n:param optimize:\n"
153     ":param useMacroElements: Enable the usage of first order macro elements.\n:type useMacroElements: ``bool``\n"
154     ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``"
155     );
156 jgs 102
157 jfenwick 3082 class_<dudley::MeshAdapter, bases<escript::AbstractContinuousDomain> >
158 jfenwick 3086 ("MeshAdapter","A concrete class representing a domain. For more details, please consult the c++ documentation.",init<optional <Dudley_Mesh*> >())
159 jfenwick 3082 .def(init<const dudley::MeshAdapter&>())
160     .def("write",&dudley::MeshAdapter::write,args("filename"),
161 jfenwick 2625 "Write the current mesh to a file with the given name.")
162 jfenwick 3082 .def("print_mesh_info",&dudley::MeshAdapter::Print_Mesh_Info,(arg("full")=false),
163 jfenwick 2625 ":param full:\n:type full: ``bool``")
164 jfenwick 3082 .def("dump",&dudley::MeshAdapter::dump,args("fileName")
165 jfenwick 2625 ,"dumps the mesh to a file with the given name.")
166 jfenwick 3082 .def("getDescription",&dudley::MeshAdapter::getDescription,
167 jfenwick 2625 ":return: a description for this domain\n:rtype: ``string``")
168 jfenwick 3082 .def("getDim",&dudley::MeshAdapter::getDim,":rtype: ``int``")
169     .def("getDataShape",&dudley::MeshAdapter::getDataShape, args("functionSpaceCode"),
170 jfenwick 2625 ":return: a pair (dps, ns) where dps=the number of data points per sample, and ns=the number of samples\n:rtype: ``tuple``")
171 jfenwick 3082 .def("getNumDataPointsGlobal",&dudley::MeshAdapter::getNumDataPointsGlobal,
172 jfenwick 2625 ":return: the number of data points summed across all MPI processes\n"
173     ":rtype: ``int``")
174 jfenwick 3082 .def("addPDEToSystem",&dudley::MeshAdapter::addPDEToSystem,
175 jfenwick 3269 args("mat", "rhs","A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
176 jfenwick 2625 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
177     ":param mat:\n:type mat: `OperatorAdapter`\n:param rhs:\n:type rhs: `Data`\n"
178     ":param A:\n:type A: `Data`\n"
179     ":param B:\n:type B: `Data`\n"
180     ":param C:\n:type C: `Data`\n"
181     ":param D:\n:type D: `Data`\n"
182     ":param X:\n:type X: `Data`\n"
183     ":param Y:\n:type Y: `Data`\n"
184     ":param d:\n:type d: `Data`\n"
185 jfenwick 3269 ":param d_contact:\n:type d_contact: `Data`\n"
186     ":param y_contact:\n:type y_contact: `Data`\n"
187 jfenwick 2625 )
188 jfenwick 3082 .def("addPDEToLumpedSystem",&dudley::MeshAdapter::addPDEToLumpedSystem,
189 jfenwick 2625 args("mat", "D", "d"),
190     "adds a PDE onto the lumped stiffness matrix\n\n"
191     ":param mat:\n:type mat: `Data`\n"
192     ":param D:\n:type D: `Data`\n"
193 gross 3379 ":param d:\n:type d: `Data`\n"
194     ":param useHRZ:\n:type useHRZ: bool\n"
195     )
196 jfenwick 3082 .def("addPDEToRHS",&dudley::MeshAdapter::addPDEToRHS,
197 jfenwick 2625 args("rhs", "X", "Y", "y", "y_contact"),
198     "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
199     ":param rhs:\n:type rhs: `Data`\n"
200     ":param X:\n:type X: `Data`\n"
201     ":param Y:\n:type Y: `Data`\n"
202     ":param y:\n:type y: `Data`\n"
203 jfenwick 3269 ":param y_contact:\n:type y_contact: `Data`"
204 jfenwick 2625 )
205 jfenwick 3082 .def("addPDEToTransportProblem",&dudley::MeshAdapter::addPDEToTransportProblem,
206 jfenwick 2625 args( "tp", "source", "M", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
207     ":param tp:\n:type tp: `TransportProblemAdapter`\n"
208     ":param source:\n:type source: `Data`\n"
209     ":param M:\n:type M: `Data`\n"
210     ":param A:\n:type A: `Data`\n"
211     ":param B:\n:type B: `Data`\n"
212     ":param C:\n:type C: `Data`\n"
213     ":param D:\n:type D: `Data`\n"
214     ":param X:\n:type X: `Data`\n"
215     ":param Y:\n:type Y: `Data`\n"
216     ":param d:\n:type d: `Data`\n"
217     ":param y:\n:type y: `Data`\n"
218     ":param d_contact:\n:type d_contact: `Data`\n"
219     ":param y_contact:\n:type y_contact: `Data`\n"
220     )
221 jfenwick 3082 .def("newOperator",&dudley::MeshAdapter::newSystemMatrix,
222 jfenwick 2625 args("row_blocksize", "row_functionspace", "column_blocksize", "column_functionspace", "type"),
223     "creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros\n\n"
224     ":param row_blocksize:\n:type row_blocksize: ``int``\n"
225     ":param row_functionspace:\n:type row_functionspace: `FunctionSpace`\n"
226     ":param column_blocksize:\n:type column_blocksize: ``int``\n"
227     ":param column_functionspace:\n:type column_functionspace: `FunctionSpace`\n"
228     ":param type:\n:type type: ``int``\n"
229     )
230 jfenwick 3082 .def("newTransportProblem",&dudley::MeshAdapter::newTransportProblem,
231 jfenwick 2625 args("theta", "blocksize", "functionspace", "type"),
232     "creates a TransportProblemAdapter\n\n"
233     ":param theta:\n:type theta: ``float``\n"
234     ":param blocksize:\n:type blocksize: ``int``\n"
235     ":param functionspace:\n:type functionspace: `FunctionSpace`\n"
236     ":param type:\n:type type: ``int``\n"
237     )
238 jfenwick 3082 .def("getSystemMatrixTypeId",&dudley::MeshAdapter::getSystemMatrixTypeId,
239 jfenwick 2625 args("solver", "preconditioner", "package", "symmetry"),
240     ":return: the identifier of the matrix type to be used for the global stiffness matrix when a particular solver, package, perconditioner, and symmetric matrix is used.\n"
241     ":rtype: ``int``\n"
242     ":param solver:\n:type solver: ``int``\n"
243     ":param preconditioner:\n:type preconditioner: ``int``\n"
244     ":param package:\n:type package: ``int``\n"
245     ":param symmetry:\n:type symmetry: ``int``\n"
246     )
247 jfenwick 3082 .def("getTransportTypeId",&dudley::MeshAdapter::getTransportTypeId,
248 jfenwick 2625 args("solver", "preconditioner", "package", "symmetry"),
249     ":return: the identifier of the transport problem type to be used when a particular solver, perconditioner, package and symmetric matrix is used.\n"
250     ":rtype: ``int``\n"
251     ":param solver:\n:type solver: ``int``\n"
252     ":param preconditioner:\n:type preconditioner: ``int``\n"
253     ":param package:\n:type package: ``int``\n"
254     ":param symmetry:\n:type symmetry: ``int``\n"
255     )
256 jfenwick 3082 .def("setX",&dudley::MeshAdapter::setNewX,
257 jfenwick 2625 args("arg"), "assigns new location to the domain\n\n:param arg:\n:type arg: `Data`")
258 jfenwick 3082 .def("getX",&dudley::MeshAdapter::getX, ":return: locations in the FEM nodes\n\n"
259 jfenwick 2625 ":rtype: `Data`")
260 jfenwick 3082 .def("getNormal",&dudley::MeshAdapter::getNormal,
261 jfenwick 2625 ":return: boundary normals at the quadrature point on the face elements\n"
262     ":rtype: `Data`")
263 jfenwick 3082 .def("getSize",&dudley::MeshAdapter::getSize,":return: the element size\n"
264 jfenwick 2625 ":rtype: `Data`")
265 jfenwick 3082 .def("saveDX",&dudley::MeshAdapter::saveDX,args("filename" ,"arg"),
266 jfenwick 2625 "Saves a dictonary of Data objects to an OpenDX input file. The keywords are used as identifier"
267     "\n\n:param filename: \n:type filename: ``string``\n"
268     "\n:param arg: \n:type arg: ``dict``\n")
269 jfenwick 3082 .def("saveVTK",&dudley::MeshAdapter::saveVTK,
270 jfenwick 2625 args("filename" ,"arg", "metadata", "metadata_schema"),
271     "Saves a dictonary of Data objects to an VTK XML input file. The keywords are used as identifier"
272     "\n\n:param filename:\n:type filename: ``string``\n"
273     ":param arg:\n:type arg: ``dict``\n"
274     ":param metadata:\n:type metadata: ``string``\n"
275     ":param metadata_schema:\n:type metadata_schema: ``string``\n"
276     )
277 jfenwick 3082 .def("setTagMap",&dudley::MeshAdapter::setTagMap,args("name","tag"),
278 jfenwick 2625 "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
279     ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")
280 jfenwick 3082 .def("getTag",&dudley::MeshAdapter::getTag,args("name"),":return: tag id for "
281 jfenwick 2625 "``name``\n:rtype: ``string``")
282 jfenwick 3082 .def("isValidTagName",&dudley::MeshAdapter::isValidTagName,args("name"),
283 jfenwick 2625 ":return: True is ``name`` corresponds to a tag\n:rtype: ``bool``")
284 jfenwick 3082 .def("showTagNames",&dudley::MeshAdapter::showTagNames,":return: A space separated list of tag names\n:rtype: ``string``")
285     .def("getMPISize",&dudley::MeshAdapter::getMPISize,":return: the number of processes used for this `Domain`\n:rtype: ``int``")
286     .def("getMPIRank",&dudley::MeshAdapter::getMPIRank,":return: the rank of this process\n:rtype: ``int``")
287     .def("MPIBarrier",&dudley::MeshAdapter::MPIBarrier,"Wait until all processes have reached this point")
288     .def("onMasterProcessor",&dudley::MeshAdapter::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`");
289 jgs 102
290     }

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/lapack2681/finley/src/CPPAdapter/finleycpp.cpp:2682-2741 /branches/pasowrap/dudley/src/CPPAdapter/dudleycpp.cpp:3661-3674 /branches/py3_attempt2/dudley/src/CPPAdapter/dudleycpp.cpp:3871-3891 /branches/restext/finley/src/CPPAdapter/finleycpp.cpp:2610-2624 /branches/ripleygmg_from_3668/dudley/src/CPPAdapter/dudleycpp.cpp:3669-3791 /branches/stage3.0/finley/src/CPPAdapter/finleycpp.cpp:2569-2590 /release/3.0/finley/src/CPPAdapter/finleycpp.cpp:2591-2601

  ViewVC Help
Powered by ViewVC 1.1.26