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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

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 /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 /trunk/ripley/test/python/dudley/src/CPPAdapter/dudleycpp.cpp:3480-3515

  ViewVC Help
Powered by ViewVC 1.1.26