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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2061 - (show annotations)
Wed Nov 19 03:40:21 2008 UTC (10 years, 4 months ago) by jfenwick
Original Path: trunk/finley/src/CPPAdapter/finleycpp.cpp
File size: 7567 byte(s)
Fixing some warnings from epydoc.
Disabled c++ signatures in python docstrings.
Removed references to Bruce in epydoc and the users guide.
1
2 /*******************************************************
3 *
4 * Copyright (c) 2003-2008 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
15 #ifdef PASO_MPI
16 #include <mpi.h>
17 #include "paso/Paso_MPI.h"
18 #endif
19 extern "C" {
20 #include "../Finley.h"
21 }
22
23 #include "MeshAdapter.h"
24 #include "MeshAdapterFactory.h"
25 #include "SystemMatrixAdapter.h"
26 #include "TransportProblemAdapter.h"
27
28 #include "FinleyAdapterException.h"
29 // #include "esysUtils/EsysException.h"
30 #include "esysUtils/esysExceptionTranslator.h"
31
32 #include "escript/AbstractContinuousDomain.h"
33
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
39 using namespace boost::python;
40
41 /**
42 \page finley Finley
43 Finley is the python module name that contains the interfaces
44 to the C++ wrapper to finley.
45
46 \version 1.0.0
47
48 \section class_desc Class Description:
49 Data
50
51 \section class_limits Class Limitations:
52 None
53
54 \section class_conds Class Conditions of Use:
55 None
56
57 \section throws Throws:
58 None
59
60 */
61
62 //
63 // The BOOST_PYTHON_FUNCTION_OVERLOADS macro generates function overloads for optional
64 // arguments to the respective finley functions.
65 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
66 //
67 // NOTE: If the number of arguments to the finley functions change
68 // the magic numbers in the BOOST_PYTHON_FUNCTION_OVERLOADS call
69 // must change.
70 //
71 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
72 // BOOST_PYTHON_FUNCTION_OVERLOADS(readMesh_overloads,finley::readMesh,1,2)
73 // BOOST_PYTHON_FUNCTION_OVERLOADS(brick_overloads,finley::brick,0,12)
74 // BOOST_PYTHON_FUNCTION_OVERLOADS(rectangle_overloads,finley::rectangle,0,9)
75 // BOOST_PYTHON_FUNCTION_OVERLOADS(interval_overloads,finley::interval,0,6)
76 // BOOST_PYTHON_FUNCTION_OVERLOADS(glueFaces_overloads,finley::glueFaces,1,3)
77 // BOOST_PYTHON_FUNCTION_OVERLOADS(joinFaces_overloads,finley::joinFaces,1,3)
78
79 BOOST_PYTHON_MODULE(finleycpp)
80 {
81 // params are: bool show_user_defined, bool show_py_signatures, bool show_cpp_signatures
82 docstring_options docopt(true, true, false);
83
84 //
85 // NOTE: The return_value_policy is necessary for functions that
86 // return pointers.
87 //
88 register_exception_translator<finley::FinleyAdapterException>(&(esysUtils::esysExceptionTranslator));
89
90 def("LoadMesh",finley::loadMesh,
91 (arg("fileName")="file.nc")
92 /* ,return_value_policy<manage_new_object>());*/
93 );
94
95 def("ReadMesh",finley::readMesh,
96 (arg("fileName")="file.fly",arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1, arg("optimize")=true)
97 /* ,return_value_policy<manage_new_object>());*/
98 );
99
100 def("ReadGmsh",finley::readGmsh,
101 (arg("fileName")="file.msh",arg("numDim"), arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1, arg("optimize")=true)
102 // ,return_value_policy<manage_new_object>());
103 );
104
105 def ("Brick",finley::brick,
106 (arg("n0")=1,arg("n1")=1,arg("n2")=1,
107 arg("order")=1,
108 arg("l0")=1.0,arg("l1")=1.0,arg("l2")=1.0,
109 arg("periodic0")=false,arg("periodic1")=false,arg("periodic2")=false,
110 arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1,
111 arg("useElementsOnFace")=false,
112 arg("useFullElementOrder")=false,
113 arg("optimize")=false)
114 // ,return_value_policy<manage_new_object>());
115 );
116
117 def ("Rectangle",finley::rectangle,
118 (arg("n0")=1,arg("n1")=1,arg("order")=1,
119 arg("l0")=1.0,arg("l1")=1.0,
120 arg("periodic0")=false,arg("periodic1")=false,
121 arg("integrationOrder")=-1, arg("reducedIntegrationOrder")=-1,
122 arg("useElementsOnFace")=false,
123 arg("useFullElementOrder")=false,
124 arg("optimize")=false)
125 // ,return_value_policy<manage_new_object>());
126 );
127
128 def("Merge",finley::meshMerge
129 // ,return_value_policy<manage_new_object>());
130 );
131
132 def("GlueFaces",finley::glueFaces,
133 (arg("safetyFactor")=0.2,
134 arg("tolerance")=1.e-8,
135 arg("optimize")=true)
136 // ,return_value_policy<manage_new_object>());
137 );
138
139 def("JoinFaces",finley::joinFaces,
140 (arg("safetyFactor")=0.2,
141 arg("tolerance")=1.e-8,
142 arg("optimize")=true)
143 // ,return_value_policy<manage_new_object>());
144 );
145
146
147 class_<finley::MeshAdapter, bases<escript::AbstractContinuousDomain> >
148 ("MeshAdapter","A concrete class representing a domain. For more details, please consult the c++ documentation.",init<optional <Finley_Mesh*> >())
149 .def(init<const finley::MeshAdapter&>())
150 .def("write",&finley::MeshAdapter::write)
151 .def("print_mesh_info",&finley::MeshAdapter::Print_Mesh_Info,(arg("full")=false))
152 .def("dump",&finley::MeshAdapter::dump)
153 .def("getDescription",&finley::MeshAdapter::getDescription)
154 .def("getDim",&finley::MeshAdapter::getDim)
155 .def("getDataShape",&finley::MeshAdapter::getDataShape)
156 .def("getNumDataPointsGlobal",&finley::MeshAdapter::getNumDataPointsGlobal)
157 .def("addPDEToSystem",&finley::MeshAdapter::addPDEToSystem)
158 .def("addPDEToLumpedSystem",&finley::MeshAdapter::addPDEToLumpedSystem)
159 .def("addPDEToRHS",&finley::MeshAdapter::addPDEToRHS)
160 .def("addPDEToTransportProblem",&finley::MeshAdapter::addPDEToTransportProblem)
161 .def("newOperator",&finley::MeshAdapter::newSystemMatrix)
162 .def("newTransportProblem",&finley::MeshAdapter::newTransportProblem)
163 .def("getSystemMatrixTypeId",&finley::MeshAdapter::getSystemMatrixTypeId)
164 .def("getTransportTypeId",&finley::MeshAdapter::getTransportTypeId)
165 .def("setX",&finley::MeshAdapter::setNewX)
166 .def("getX",&finley::MeshAdapter::getX)
167 .def("getNormal",&finley::MeshAdapter::getNormal)
168 .def("getSize",&finley::MeshAdapter::getSize)
169 .def("saveDX",&finley::MeshAdapter::saveDX)
170 .def("saveVTK",&finley::MeshAdapter::saveVTK)
171 .def("setTagMap",&finley::MeshAdapter::setTagMap)
172 .def("getTag",&finley::MeshAdapter::getTag)
173 .def("isValidTagName",&finley::MeshAdapter::isValidTagName)
174 .def("showTagNames",&finley::MeshAdapter::showTagNames)
175 .def("getMPISize",&finley::MeshAdapter::getMPISize)
176 .def("getMPIRank",&finley::MeshAdapter::getMPIRank)
177 .def("MPIBarrier",&finley::MeshAdapter::MPIBarrier)
178 .def("onMasterProcessor",&finley::MeshAdapter::onMasterProcessor);
179
180 class_<finley::SystemMatrixAdapter, bases<escript::AbstractSystemMatrix> >
181 ("OperatorAdapter","A concrete class representing an operator. For more details, please see the c++ documentation.", no_init)
182 .def("print_matrix_info",&finley::SystemMatrixAdapter::Print_Matrix_Info,(arg("full")=false))
183 .def("nullifyRowsAndCols",&finley::SystemMatrixAdapter::nullifyRowsAndCols)
184 .def("resetValues",&finley::SystemMatrixAdapter::resetValues)
185 .def("saveMM",&finley::SystemMatrixAdapter::saveMM)
186 .def("saveHB",&finley::SystemMatrixAdapter::saveHB);
187
188 class_<finley::TransportProblemAdapter, bases<escript::AbstractTransportProblem> >
189 ("TransportProblemAdapter","",no_init)
190 .def("getSafeTimeStepSize",&finley::TransportProblemAdapter::getSafeTimeStepSize)
191 .def("getUnlimitedTimeStepSize",&finley::TransportProblemAdapter::getUnlimitedTimeStepSize)
192 .def("resetTransport",&finley::TransportProblemAdapter::resetTransport);
193 }

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26