/[escript]/trunk/finley/src/CPPAdapter/finleycpp.cpp
ViewVC logotype

Contents of /trunk/finley/src/CPPAdapter/finleycpp.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4114 - (show annotations)
Fri Dec 14 04:24:46 2012 UTC (6 years, 8 months ago) by caltinay
File size: 16940 byte(s)
Time to remove deprecated saveVTK/DX methods from Data and Domain.

1
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2012 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
17 #ifdef ESYS_MPI
18 #include "esysUtils/Esys_MPI.h"
19 #endif
20 extern "C" {
21 #include "../Finley.h"
22 }
23
24 #include <pasowrap/SystemMatrixAdapter.h>
25 #include <pasowrap/TransportProblemAdapter.h>
26
27
28 #include "MeshAdapter.h"
29 #include "MeshAdapterFactory.h"
30 // #include "SystemMatrixAdapter.h"
31 // #include "TransportProblemAdapter.h"
32
33 #include "FinleyAdapterException.h"
34 // #include "esysUtils/EsysException.h"
35 #include "esysUtils/esysExceptionTranslator.h"
36
37 #include "escript/AbstractContinuousDomain.h"
38
39 #include <boost/python.hpp>
40 #include <boost/python/module.hpp>
41 #include <boost/python/def.hpp>
42 #include <boost/python/detail/defaults_gen.hpp>
43 #include <boost/version.hpp>
44
45 using namespace boost::python;
46
47 //
48 // The BOOST_PYTHON_FUNCTION_OVERLOADS macro generates function overloads for optional
49 // arguments to the respective finley functions.
50 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
51 //
52 // NOTE: If the number of arguments to the finley functions change
53 // the magic numbers in the BOOST_PYTHON_FUNCTION_OVERLOADS call
54 // must change.
55 //
56 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
57 // BOOST_PYTHON_FUNCTION_OVERLOADS(readMesh_overloads,finley::readMesh,1,2)
58 // BOOST_PYTHON_FUNCTION_OVERLOADS(brick_overloads,finley::brick,0,12)
59 // BOOST_PYTHON_FUNCTION_OVERLOADS(rectangle_overloads,finley::rectangle,0,9)
60 // BOOST_PYTHON_FUNCTION_OVERLOADS(interval_overloads,finley::interval,0,6)
61 // BOOST_PYTHON_FUNCTION_OVERLOADS(glueFaces_overloads,finley::glueFaces,1,3)
62 // BOOST_PYTHON_FUNCTION_OVERLOADS(joinFaces_overloads,finley::joinFaces,1,3)
63
64 BOOST_PYTHON_MODULE(finleycpp)
65 {
66 // This feature was added in boost v1.34
67 #if ((BOOST_VERSION/100)%1000 > 34) || (BOOST_VERSION/100000 >1)
68 // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
69 docstring_options docopt(true, true, false);
70 #endif
71
72 scope().attr("__doc__") = "To use this module, please import esys.finley";
73
74
75 //
76 // NOTE: The return_value_policy is necessary for functions that
77 // return pointers.
78 //
79 register_exception_translator<finley::FinleyAdapterException>(&(esysUtils::esysExceptionTranslator));
80
81 def("LoadMesh",finley::loadMesh,
82 (arg("fileName")="file.nc"),":rtype: `Domain`"
83 /* ,return_value_policy<manage_new_object>());*/
84 );
85
86 def("ReadMesh",finley::readMesh,
87 (arg("fileName")="file.fly",arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1, arg("optimize")=true)
88 /* ,return_value_policy<manage_new_object>());*/
89 ,"Read a mesh from a file. For MPI parallel runs fan out the mesh to multiple processes.\n\n"
90 ":rtype: `Domain`\n:param fileName:\n:type fileName: ``string``\n"
91 ":param integrationOrder: order of the quadrature scheme. If *integrationOrder<0* the integration order is selected independently.\n"
92 ":type integrationOrder: ``int``\n"
93 ":param reducedIntegrationOrder: order of the quadrature scheme. If *reducedIntegrationOrder<0* the integration order is selected independently.\n"
94 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``");
95
96 def("ReadGmsh",finley::readGmsh,
97 (arg("fileName")="file.msh",
98 arg("numDim"),
99 arg("integrationOrder")=-1,
100 arg("reducedIntegrationOrder")=-1,
101 arg("optimize")=true,
102 arg("useMacroElements")=false)
103 // ,return_value_policy<manage_new_object>());
104 ,"Read a gmsh mesh file\n\n"
105 ":rtype: `Domain`\n:param fileName:\n:type fileName: ``string``\n"
106 ":param integrationOrder: order of the quadrature scheme. If *integrationOrder<0* the integration order is selected independently.\n"
107 ":type integrationOrder: ``int``\n"
108 ":param reducedIntegrationOrder: order of the quadrature scheme. If *reducedIntegrationOrder<0* the integration order is selected independently.\n"
109 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``\n"
110 ":param useMacroElements: Enable the usage of macro elements instead of second order elements.\n:type useMacroElements: ``bool``"
111 );
112
113 def ("__Brick_driver",finley::brick_driver,
114 (arg("params"))
115 ,"Creates a rectangular mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2]."
116 "\n\n:param n0:\n:type n0:\n:param n1:\n:type n1:\n:param n2:\n:type n2:\n"
117 ":param order: =1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.\n"
118 ":param l0: length of side 0\n:param l1:\n:param l2:\n"
119 ":param integrationOrder: order of the quadrature scheme. If integrationOrder<0 the integration order is selected independently.\n"
120 ":param reducedIntegrationOrder: order of the quadrature scheme. If reducedIntegrationOrder<0 the integration order is selected independently.\n"
121 ":param useElementsOnFace: whether or not to use elements on face\n"
122 ":type useElementsOnFace: ``int``"
123 ":param periodic0: whether or not boundary conditions are periodic\n"
124 ":param periodic1:\n:param periodic2:\n"
125 ":param useFullElementOrder:\n:param optimize:\n"
126 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``"
127 );
128
129 def ("__Rectangle_driver",finley::rectangle_driver,
130 (arg("args"))
131 // ,return_value_policy<manage_new_object>());
132 ,"Creates a rectangular mesh with n0 x n1 elements over the brick [0,l0] x [0,l1]."
133 "\n\n:param n0:\n:type n0:\n:param n1:\n:type n1:\n"
134 ":param order: =1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.\n"
135 ":param l0: length of side 0\n:param l1:\n"
136 ":param integrationOrder: order of the quadrature scheme. If integrationOrder<0 the integration order is selected independently.\n"
137 ":param reducedIntegrationOrder: order of the quadrature scheme. If reducedIntegrationOrder<0 the integration order is selected independently.\n"
138 ":param useElementsOnFace: whether or not to use elements on face\n"
139 ":type useElementsOnFace: ``int``"
140 ":param periodic0: whether or not boundary conditions are periodic\n"
141 ":param periodic1:\n"
142 ":param useFullElementOrder:\n:param optimize:\n"
143 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``"
144 );
145
146 def("Merge",finley::meshMerge,args("meshList")
147 // ,return_value_policy<manage_new_object>());
148 ,"Merges a list of meshes into one mesh.\n\n:rtype: `Domain`"
149 );
150
151 def("GlueFaces",finley::glueFaces,
152 (arg("meshList"),arg("safetyFactor")=0.2,
153 arg("tolerance")=1.e-8,
154 arg("optimize")=true)
155 // ,return_value_policy<manage_new_object>());
156 ,"Detects matching faces in the mesh, removes them from the mesh and joins the elements touched by the face elements."
157 );
158
159 def("JoinFaces",finley::joinFaces,
160 (arg("meshList"), arg("safetyFactor")=0.2,
161 arg("tolerance")=1.e-8,
162 arg("optimize")=true)
163 // ,return_value_policy<manage_new_object>());
164 ,"Detects matching faces in the mesh and replaces them by joint elements."
165 );
166
167
168 class_<finley::MeshAdapter, bases<escript::AbstractContinuousDomain> >
169 ("MeshAdapter","A concrete class representing a domain. For more details, please consult the c++ documentation.",init<optional <Finley_Mesh*> >())
170 .def(init<const finley::MeshAdapter&>())
171 .def("write",&finley::MeshAdapter::write,args("filename"),
172 "Write the current mesh to a file with the given name.")
173 .def("print_mesh_info",&finley::MeshAdapter::Print_Mesh_Info,(arg("full")=false),
174 ":param full:\n:type full: ``bool``")
175 .def("dump",&finley::MeshAdapter::dump,args("fileName")
176 ,"dumps the mesh to a file with the given name.")
177 .def("getDescription",&finley::MeshAdapter::getDescription,
178 ":return: a description for this domain\n:rtype: ``string``")
179 .def("getDim",&finley::MeshAdapter::getDim,":rtype: ``int``")
180 .def("getDataShape",&finley::MeshAdapter::getDataShape, args("functionSpaceCode"),
181 ":return: a pair (dps, ns) where dps=the number of data points per sample, and ns=the number of samples\n:rtype: ``tuple``")
182 .def("getNumDataPointsGlobal",&finley::MeshAdapter::getNumDataPointsGlobal,
183 ":return: the number of data points summed across all MPI processes\n"
184 ":rtype: ``int``")
185 .def("addPDEToSystem",&finley::MeshAdapter::addPDEToSystem,
186 args("mat", "rhs","A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
187 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
188 ":param mat:\n:type mat: `OperatorAdapter`\n:param rhs:\n:type rhs: `Data`\n"
189 ":param A:\n:type A: `Data`\n"
190 ":param B:\n:type B: `Data`\n"
191 ":param C:\n:type C: `Data`\n"
192 ":param D:\n:type D: `Data`\n"
193 ":param X:\n:type X: `Data`\n"
194 ":param Y:\n:type Y: `Data`\n"
195 ":param d:\n:type d: `Data`\n"
196 ":param d_contact:\n:type d_contact: `Data`\n"
197 ":param y_contact:\n:type y_contact: `Data`\n"
198 )
199 .def("addPDEToLumpedSystem",&finley::MeshAdapter::addPDEToLumpedSystem,
200 args("mat", "D", "d"),
201 "adds a PDE onto the lumped stiffness matrix\n\n"
202 ":param mat:\n:type mat: `Data`\n"
203 ":param D:\n:type D: `Data`\n"
204 ":param d:\n:type d: `Data`\n"
205 ":param useHRZ:\n:type useHRZ: bool\n")
206 .def("addPDEToRHS",&finley::MeshAdapter::addPDEToRHS,
207 args("rhs", "X", "Y", "y", "y_contact"),
208 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
209 ":param rhs:\n:type rhs: `Data`\n"
210 ":param X:\n:type X: `Data`\n"
211 ":param Y:\n:type Y: `Data`\n"
212 ":param y:\n:type y: `Data`\n"
213 ":param y_contact:\n:type y_contact: `Data`"
214 )
215 .def("addPDEToTransportProblem",&finley::MeshAdapter::addPDEToTransportProblem,
216 args( "tp", "source", "M", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
217 ":param tp:\n:type tp: `TransportProblemAdapter`\n"
218 ":param source:\n:type source: `Data`\n"
219 ":param M:\n:type M: `Data`\n"
220 ":param A:\n:type A: `Data`\n"
221 ":param B:\n:type B: `Data`\n"
222 ":param C:\n:type C: `Data`\n"
223 ":param D:\n:type D: `Data`\n"
224 ":param X:\n:type X: `Data`\n"
225 ":param Y:\n:type Y: `Data`\n"
226 ":param d:\n:type d: `Data`\n"
227 ":param y:\n:type y: `Data`\n"
228 ":param d_contact:\n:type d_contact: `Data`\n"
229 ":param y_contact:\n:type y_contact: `Data`\n"
230 )
231 .def("newOperator",&finley::MeshAdapter::newSystemMatrix,
232 args("row_blocksize", "row_functionspace", "column_blocksize", "column_functionspace", "type"),
233 "creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros\n\n"
234 ":param row_blocksize:\n:type row_blocksize: ``int``\n"
235 ":param row_functionspace:\n:type row_functionspace: `FunctionSpace`\n"
236 ":param column_blocksize:\n:type column_blocksize: ``int``\n"
237 ":param column_functionspace:\n:type column_functionspace: `FunctionSpace`\n"
238 ":param type:\n:type type: ``int``\n"
239 )
240 .def("newTransportProblem",&finley::MeshAdapter::newTransportProblem,
241 args("theta", "blocksize", "functionspace", "type"),
242 "creates a TransportProblemAdapter\n\n"
243 ":param theta:\n:type theta: ``float``\n"
244 ":param blocksize:\n:type blocksize: ``int``\n"
245 ":param functionspace:\n:type functionspace: `FunctionSpace`\n"
246 ":param type:\n:type type: ``int``\n"
247 )
248 .def("getSystemMatrixTypeId",&finley::MeshAdapter::getSystemMatrixTypeId,
249 args("solver", "preconditioner", "package", "symmetry"),
250 ":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"
251 ":rtype: ``int``\n"
252 ":param solver:\n:type solver: ``int``\n"
253 ":param preconditioner:\n:type preconditioner: ``int``\n"
254 ":param package:\n:type package: ``int``\n"
255 ":param symmetry:\n:type symmetry: ``int``\n"
256 )
257 .def("getTransportTypeId",&finley::MeshAdapter::getTransportTypeId,
258 args("solver", "preconditioner", "package", "symmetry"),
259 ":return: the identifier of the transport problem type to be used when a particular solver, perconditioner, package and symmetric matrix is used.\n"
260 ":rtype: ``int``\n"
261 ":param solver:\n:type solver: ``int``\n"
262 ":param preconditioner:\n:type preconditioner: ``int``\n"
263 ":param package:\n:type package: ``int``\n"
264 ":param symmetry:\n:type symmetry: ``int``\n"
265 )
266 .def("setX",&finley::MeshAdapter::setNewX,
267 args("arg"), "assigns new location to the domain\n\n:param arg:\n:type arg: `Data`")
268 .def("getX",&finley::MeshAdapter::getX, ":return: locations in the FEM nodes\n\n"
269 ":rtype: `Data`")
270 .def("getNormal",&finley::MeshAdapter::getNormal,
271 ":return: boundary normals at the quadrature point on the face elements\n"
272 ":rtype: `Data`")
273 .def("getSize",&finley::MeshAdapter::getSize,":return: the element size\n"
274 ":rtype: `Data`")
275 .def("setTagMap",&finley::MeshAdapter::setTagMap,args("name","tag"),
276 "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
277 ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")
278 .def("getTag",&finley::MeshAdapter::getTag,args("name"),":return: tag id for "
279 "``name``\n:rtype: ``string``")
280 .def("isValidTagName",&finley::MeshAdapter::isValidTagName,args("name"),
281 ":return: True is ``name`` corresponds to a tag\n:rtype: ``bool``")
282 .def("showTagNames",&finley::MeshAdapter::showTagNames,":return: A space separated list of tag names\n:rtype: ``string``")
283 .def("getMPISize",&finley::MeshAdapter::getMPISize,":return: the number of processes used for this `Domain`\n:rtype: ``int``")
284 .def("getMPIRank",&finley::MeshAdapter::getMPIRank,":return: the rank of this process\n:rtype: ``int``")
285 .def("MPIBarrier",&finley::MeshAdapter::MPIBarrier,"Wait until all processes have reached this point")
286 .def("onMasterProcessor",&finley::MeshAdapter::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`")
287 // .def("addDiracPoints", &finley::MeshAdapter::addDiracPoints,(arg("points"), arg("tags")=finley::EmptyPythonList),
288 // "adds points to support more Dirac delta function.\n\n"
289 // ":param points: list of points where Dirac delta function are to be defined. The location will be adjusted to\n"
290 // " to match the nearest node of the finite element mesh.\n:type points: ``list`` of ``list``s of ``floats``\n"
291 // ":param tags: list of tags to be assigned to the points.\n:type tags: ``list`` of ``int``s or ``strings``\n"
292 // )
293 // .def("addDiracPoint", &finley::MeshAdapter::addDiracPoint,(arg("point"), arg("tag")=-1),
294 // "adds a point to support more Dirac delta function.\n\n"
295 // ":param point: point where Dirac delta function are to be defined. The location will be adjusted to\n"
296 // " to match the nearest node of the finite element mesh.\n:type point: ``list`` of ``floats``\n"
297 // ":param tags: tag to be assigned to the point.\n:type tag: ``int``s or ``strings``\n"
298 // )
299 // .def("addDiracPoint", &finley::MeshAdapter::addDiracPointWithTagName,(arg("point"), arg("tag")),
300 // "adds a point to support more Dirac delta function.\n\n"
301 // ":param point: point where Dirac delta function are to be defined. The location will be adjusted to\n"
302 // " to match the nearest node of the finite element mesh.\n:type point: ``list`` of ``floats``\n"
303 // ":param tags: tag to be assigned to the point.\n:type tag: ``int``s or ``strings``\n"
304 // )
305 ;
306
307 // class_<finley::SystemMatrixAdapter, bases<escript::AbstractSystemMatrix> >
308 // ("OperatorAdapter","A concrete class representing an operator. For more details, please see the c++ documentation.", no_init)
309 // .def("print_matrix_info",&finley::SystemMatrixAdapter::Print_Matrix_Info,(arg("full")=false),"prints information about a system matrix")
310 // .def("nullifyRowsAndCols",&finley::SystemMatrixAdapter::nullifyRowsAndCols)
311 // .def("resetValues",&finley::SystemMatrixAdapter::resetValues, "resets the matrix entries")
312 // .def("saveMM",&finley::SystemMatrixAdapter::saveMM,args("fileName"),
313 // "writes the matrix to a file using the Matrix Market file format")
314 // .def("saveHB",&finley::SystemMatrixAdapter::saveHB, args("filename"),
315 // "writes the matrix to a file using the Harwell-Boeing file format");
316 //
317 // class_<finley::TransportProblemAdapter, bases<escript::AbstractTransportProblem> >
318 // ("TransportProblemAdapter","",no_init)
319 // .def("getSafeTimeStepSize",&finley::TransportProblemAdapter::getSafeTimeStepSize)
320 // .def("getUnlimitedTimeStepSize",&finley::TransportProblemAdapter::getUnlimitedTimeStepSize)
321 // .def("resetTransport",&finley::TransportProblemAdapter::resetTransport,
322 // "resets the transport operator typically as they have been updated");
323 }

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26