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

Contents of /branches/trilinos_from_5897/dudley/src/CPPAdapter/dudleycpp.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 5963 - (show annotations)
Mon Feb 22 06:59:27 2016 UTC (3 years, 3 months ago) by caltinay
File size: 13601 byte(s)
sync and fix.

1
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2016 by The 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 2012-2013 by School of Earth Sciences
13 * Development from 2014 by Centre for Geoscience Computing (GeoComp)
14 *
15 *****************************************************************************/
16
17 #define ESNEEDPYTHON
18 #include "esysUtils/first.h"
19
20 #include "../Dudley.h"
21 #include "DudleyAdapterException.h"
22 #include "MeshAdapter.h"
23 #include "MeshAdapterFactory.h"
24
25 #include "esysUtils/Esys_MPI.h"
26 #include <escript/ExceptionTranslators.h>
27 #include <escript/AbstractContinuousDomain.h>
28
29 #include <boost/python.hpp>
30 #include <boost/python/def.hpp>
31 #include <boost/python/module.hpp>
32 #include <boost/python/detail/defaults_gen.hpp>
33 #include <boost/version.hpp>
34
35 using namespace boost::python;
36
37 BOOST_PYTHON_MODULE(dudleycpp)
38 {
39 // This feature was added in boost v1.34
40 #if ((BOOST_VERSION/100)%1000 > 34) || (BOOST_VERSION/100000 >1)
41 // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
42 docstring_options docopt(true, true, false);
43 #endif
44
45 scope().attr("__doc__") = "To use this module, please import esys.dudley";
46
47 register_exception_translator<dudley::DudleyAdapterException>(&escript::RuntimeErrorTranslator);
48
49 //
50 // NOTE: The return_value_policy is necessary for functions that
51 // return pointers.
52 //
53 def("LoadMesh",dudley::loadMesh,
54 (arg("fileName")="file.nc"),":rtype: `Domain`"
55 /* ,return_value_policy<manage_new_object>());*/
56 );
57
58 def("ReadMesh",dudley::readMesh,
59 (arg("fileName")="file.fly",arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1, arg("optimize")=true)
60 /* ,return_value_policy<manage_new_object>());*/
61 ,"Read a mesh from a file. For MPI parallel runs fan out the mesh to multiple processes.\n\n"
62 ":rtype: `Domain`\n:param fileName:\n:type fileName: ``string``\n"
63 ":param integrationOrder: order of the quadrature scheme. If *integrationOrder<0* the integration order is selected independently.\n"
64 ":type integrationOrder: ``int``\n"
65 ":param reducedIntegrationOrder: order of the quadrature scheme. If *reducedIntegrationOrder<0* the integration order is selected independently.\n"
66 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``");
67
68 def("ReadGmsh",dudley::readGmsh,
69 (arg("fileName")="file.msh",
70 arg("numDim"),
71 arg("integrationOrder")=-1,
72 arg("reducedIntegrationOrder")=-1,
73 arg("optimize")=true,
74 arg("useMacroElements")=false)
75 // ,return_value_policy<manage_new_object>());
76 ,"Read a gmsh mesh file\n\n"
77 ":rtype: `Domain`\n:param fileName:\n:type fileName: ``string``\n"
78 ":param integrationOrder: order of the quadrature scheme. If *integrationOrder<0* the integration order is selected independently.\n"
79 ":type integrationOrder: ``int``\n"
80 ":param reducedIntegrationOrder: order of the quadrature scheme. If *reducedIntegrationOrder<0* the integration order is selected independently.\n"
81 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``\n"
82 ":param useMacroElements: Enable the usage of macro elements instead of second order elements.\n:type useMacroElements: ``bool``"
83 );
84
85 def ("__Brick_driver",dudley::brick_driver,
86 arg("args"),
87 /*
88 (arg("n0")=1,arg("n1")=1,arg("n2")=1,
89 arg("order")=1,
90 arg("l0")=1.0,arg("l1")=1.0,arg("l2")=1.0,
91 arg("periodic0")=false,arg("periodic1")=false,arg("periodic2")=false,
92 arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1,
93 arg("useElementsOnFace")=false,
94 arg("useFullElementOrder")=false,
95 arg("optimize")=false)
96 */
97 "Creates a tetrahedral mesh by subdividing n0 x n1 x n2 rectangular elements over the brick [0,l0] x [0,l1] x [0,l2]."
98 "We accept floating point values for n0, n1 only to ease transition of scripts to python3 when the time comes."
99 ,"Creates a rectangular mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2]."
100 "\n\n:param n0: number of elements in direction 0\n:type n0: ``int``\n:param n1: number of elements in direction 1\n:type n1: ``int``\n"
101 ":param n2:number of elements in direction 2\n:type n2: ``int``\n"
102 ":param order: gives the order of shape function. Only for compatibility with finley, must be 1.\n"
103 ":param l0: length of side 0\n"
104 ":type l0: ``float``\n"
105 ":param l1: length of side 1\n"
106 ":type l1: ``float``\n"
107 ":param l2: length of side 2\n"
108 ":type l2: ``float``\n"
109 ":param periodic0: whether or not boundary conditions are periodic in direction 0\n:type periodic0: ``bool``\n"
110 ":param periodic1: whether or not boundary conditions are periodic in direction 1\n:type periodic1: ``bool``\n"
111 ":param periodic2: whether or not boundary conditions are periodic in direction 2\n:type periodic2: ``bool``\n"
112 ":param integrationOrder: order of the quadrature scheme. If integrationOrder<0 the integration order is selected independently.\n"
113 ":param reducedIntegrationOrder: order of the quadrature scheme. If reducedIntegrationOrder<0 the integration order is selected independently.\n"
114 ":param useElementsOnFace: Not used\n"
115 ":type useElementsOnFace: ``int``\n"
116 ":param useFullElementOrder: Whether or not to use Hex27 elements\n"":type useFullElementOrder: ``bool``\n"
117 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``"
118 );
119
120 def ("__Rectangle_driver",dudley::rectangle_driver,
121 arg("args"),
122 /*
123 (arg("n0")=1,arg("n1")=1,arg("order")=1,
124 arg("l0")=1.0,arg("l1")=1.0,
125 arg("periodic0")=false,arg("periodic1")=false,
126 arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1,
127 arg("useElementsOnFace")=false,
128 arg("useFullElementOrder")=false,
129 arg("optimize")=false)
130 */
131 "Creates a triangular mesh by subdividing n0 x n1 rectangular elements over the brick [0,l0] x [0,l1]."
132 "We accept floating point values for n0, n1 only to ease transition of scripts to python3 when the time comes."
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: Not used: ``bool``\n"
143 ":param useMacroElements: Enable the usage of first order macro elements.\n:type useMacroElements: ``bool``\n"
144 ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``"
145 );
146
147 class_<dudley::MeshAdapter, bases<escript::AbstractContinuousDomain> >
148 ("MeshAdapter","A concrete class representing a domain. For more details, please consult the c++ documentation.",init<optional <Dudley_Mesh*> >())
149 .def(init<const dudley::MeshAdapter&>())
150 .def("write",&dudley::MeshAdapter::write,args("filename"),
151 "Write the current mesh to a file with the given name.")
152 .def("print_mesh_info",&dudley::MeshAdapter::Print_Mesh_Info,(arg("full")=false),
153 ":param full:\n:type full: ``bool``")
154 .def("dump",&dudley::MeshAdapter::dump,args("fileName")
155 ,"dumps the mesh to a file with the given name.")
156 .def("getDescription",&dudley::MeshAdapter::getDescription,
157 ":return: a description for this domain\n:rtype: ``string``")
158 .def("getDim",&dudley::MeshAdapter::getDim,":rtype: ``int``")
159 .def("getDataShape",&dudley::MeshAdapter::getDataShape, args("functionSpaceCode"),
160 ":return: a pair (dps, ns) where dps=the number of data points per sample, and ns=the number of samples\n:rtype: ``tuple``")
161 .def("getNumDataPointsGlobal",&dudley::MeshAdapter::getNumDataPointsGlobal,
162 ":return: the number of data points summed across all MPI processes\n"
163 ":rtype: ``int``")
164 .def("addPDEToSystem",&dudley::MeshAdapter::addPDEToSystem,
165 args("mat", "rhs","A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
166 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
167 ":param mat:\n:type mat: `OperatorAdapter`\n:param rhs:\n:type rhs: `Data`\n"
168 ":param A:\n:type A: `Data`\n"
169 ":param B:\n:type B: `Data`\n"
170 ":param C:\n:type C: `Data`\n"
171 ":param D:\n:type D: `Data`\n"
172 ":param X:\n:type X: `Data`\n"
173 ":param Y:\n:type Y: `Data`\n"
174 ":param d:\n:type d: `Data`\n"
175 ":param d_contact:\n:type d_contact: `Data`\n"
176 ":param y_contact:\n:type y_contact: `Data`\n"
177 )
178 .def("addPDEToLumpedSystem",&dudley::MeshAdapter::addPDEToLumpedSystem,
179 args("mat", "D", "d"),
180 "adds a PDE onto the lumped stiffness matrix\n\n"
181 ":param mat:\n:type mat: `Data`\n"
182 ":param D:\n:type D: `Data`\n"
183 ":param d:\n:type d: `Data`\n"
184 ":param useHRZ:\n:type useHRZ: bool\n"
185 )
186 .def("addPDEToRHS",&dudley::MeshAdapter::addPDEToRHS,
187 args("rhs", "X", "Y", "y", "y_contact"),
188 "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
189 ":param rhs:\n:type rhs: `Data`\n"
190 ":param X:\n:type X: `Data`\n"
191 ":param Y:\n:type Y: `Data`\n"
192 ":param y:\n:type y: `Data`\n"
193 ":param y_contact:\n:type y_contact: `Data`"
194 )
195 .def("addPDEToTransportProblem",&dudley::MeshAdapter::addPDEToTransportProblem,
196 args( "tp", "source", "M", "A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
197 ":param tp:\n:type tp: `AbstractTransportProblem`\n"
198 ":param source:\n:type source: `Data`\n"
199 ":param M:\n:type M: `Data`\n"
200 ":param A:\n:type A: `Data`\n"
201 ":param B:\n:type B: `Data`\n"
202 ":param C:\n:type C: `Data`\n"
203 ":param D:\n:type D: `Data`\n"
204 ":param X:\n:type X: `Data`\n"
205 ":param Y:\n:type Y: `Data`\n"
206 ":param d:\n:type d: `Data`\n"
207 ":param y:\n:type y: `Data`\n"
208 ":param d_contact:\n:type d_contact: `Data`\n"
209 ":param y_contact:\n:type y_contact: `Data`\n"
210 )
211 .def("newOperator",&dudley::MeshAdapter::newSystemMatrix,
212 args("row_blocksize", "row_functionspace", "column_blocksize", "column_functionspace", "type"),
213 "creates a stiffness matrix and initializes it with zeros\n\n"
214 ":param row_blocksize:\n:type row_blocksize: ``int``\n"
215 ":param row_functionspace:\n:type row_functionspace: `FunctionSpace`\n"
216 ":param column_blocksize:\n:type column_blocksize: ``int``\n"
217 ":param column_functionspace:\n:type column_functionspace: `FunctionSpace`\n"
218 ":param type:\n:type type: ``int``\n"
219 )
220 .def("newTransportProblem",&dudley::MeshAdapter::newTransportProblem,
221 args("theta", "blocksize", "functionspace", "type"),
222 "creates a TransportProblem\n\n"
223 ":param theta:\n:type theta: ``float``\n"
224 ":param blocksize:\n:type blocksize: ``int``\n"
225 ":param functionspace:\n:type functionspace: `FunctionSpace`\n"
226 ":param type:\n:type type: ``int``\n"
227 )
228 .def("getSystemMatrixTypeId",&dudley::MeshAdapter::getSystemMatrixTypeId,
229 args("options"),
230 ":return: the identifier of the matrix type to be used for the global stiffness matrix when particular solver options are used.\n"
231 ":rtype: ``int``\n"
232 ":param options:\n:type options: `SolverBuddy`\n"
233 )
234 .def("getTransportTypeId",&dudley::MeshAdapter::getTransportTypeId,
235 args("solver", "preconditioner", "package", "symmetry"),
236 ":return: the identifier of the transport problem type to be used when a particular solver, preconditioner, package and symmetric matrix is used.\n"
237 ":rtype: ``int``\n"
238 ":param solver:\n:type solver: ``int``\n"
239 ":param preconditioner:\n:type preconditioner: ``int``\n"
240 ":param package:\n:type package: ``int``\n"
241 ":param symmetry:\n:type symmetry: ``int``\n"
242 )
243 .def("setX",&dudley::MeshAdapter::setNewX,
244 args("arg"), "assigns new location to the domain\n\n:param arg:\n:type arg: `Data`")
245 .def("getX",&dudley::MeshAdapter::getX, ":return: locations in the FEM nodes\n\n"
246 ":rtype: `Data`")
247 .def("getNormal",&dudley::MeshAdapter::getNormal,
248 ":return: boundary normals at the quadrature point on the face elements\n"
249 ":rtype: `Data`")
250 .def("getSize",&dudley::MeshAdapter::getSize,":return: the element size\n"
251 ":rtype: `Data`")
252 .def("setTagMap",&dudley::MeshAdapter::setTagMap,args("name","tag"),
253 "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
254 ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")
255 .def("getTag",&dudley::MeshAdapter::getTag,args("name"),":return: tag id for "
256 "``name``\n:rtype: ``string``")
257 .def("isValidTagName",&dudley::MeshAdapter::isValidTagName,args("name"),
258 ":return: True is ``name`` corresponds to a tag\n:rtype: ``bool``")
259 .def("showTagNames",&dudley::MeshAdapter::showTagNames,":return: A space separated list of tag names\n:rtype: ``string``")
260 .def("getMPISize",&dudley::MeshAdapter::getMPISize,":return: the number of processes used for this `Domain`\n:rtype: ``int``")
261 .def("getMPIRank",&dudley::MeshAdapter::getMPIRank,":return: the rank of this process\n:rtype: ``int``")
262 .def("MPIBarrier",&dudley::MeshAdapter::MPIBarrier,"Wait until all processes have reached this point")
263 .def("onMasterProcessor",&dudley::MeshAdapter::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`");
264 }
265

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/4.0fordebian/dudley/src/CPPAdapter/dudleycpp.cpp:5567-5588 /branches/diaplayground/dudley/src/CPPAdapter/dudleycpp.cpp:4940-5147 /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 /branches/symbolic_from_3470/dudley/src/CPPAdapter/dudleycpp.cpp:3471-3974 /branches/symbolic_from_3470/ripley/test/python/dudley/src/CPPAdapter/dudleycpp.cpp:3517-3974 /release/3.0/finley/src/CPPAdapter/finleycpp.cpp:2591-2601 /release/4.0/dudley/src/CPPAdapter/dudleycpp.cpp:5380-5406 /trunk/dudley/src/CPPAdapter/dudleycpp.cpp:5898-5962 /trunk/ripley/test/python/dudley/src/CPPAdapter/dudleycpp.cpp:3480-3515

  ViewVC Help
Powered by ViewVC 1.1.26