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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

branches/domexper/dudley/src/CPPAdapter/dudleycpp.cpp revision 3114 by jfenwick, Fri Aug 27 05:26:25 2010 UTC trunk/dudley/src/CPPAdapter/dudleycpp.cpp revision 3994 by jfenwick, Wed Sep 26 07:38:38 2012 UTC
# Line 1  Line 1 
1    
2  /*******************************************************  /*****************************************************************************
3  *  *
4  * Copyright (c) 2003-2010 by University of Queensland  * Copyright (c) 2003-2012 by University of Queensland
5  * Earth Systems Science Computational Center (ESSCC)  * http://www.uq.edu.au
 * http://www.uq.edu.au/esscc  
6  *  *
7  * Primary Business: Queensland, Australia  * Primary Business: Queensland, Australia
8  * Licensed under the Open Software License version 3.0  * Licensed under the Open Software License version 3.0
9  * http://www.opensource.org/licenses/osl-3.0.php  * 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 PASO_MPI  #ifdef ESYS_MPI
18  #include <mpi.h>  #include "esysUtils/Esys_MPI.h"
 #include "paso/Paso_MPI.h"  
19  #endif  #endif
20  extern "C" {  extern "C" {
21  #include "../Dudley.h"  #include "../Dudley.h"
22  }  }
23    
24    #include <pasowrap/SystemMatrixAdapter.h>
25    #include <pasowrap/TransportProblemAdapter.h>
26    
27  #include "MeshAdapter.h"  #include "MeshAdapter.h"
28  #include "MeshAdapterFactory.h"  #include "MeshAdapterFactory.h"
 #include "SystemMatrixAdapter.h"  
 #include "TransportProblemAdapter.h"  
29    
30  #include "DudleyAdapterException.h"  #include "DudleyAdapterException.h"
31  // #include "esysUtils/EsysException.h"  // #include "esysUtils/EsysException.h"
# Line 39  extern "C" { Line 41  extern "C" {
41    
42  using namespace boost::python;  using namespace boost::python;
43    
 /**  
    \page dudley Dudley  
    Dudley is the python module name that contains the interfaces  
    to the C++ wrapper to dudley.  
   
    \version 1.0.0  
   
    \section class_desc Class Description:  
    Data  
   
    \section class_limits Class Limitations:  
    None  
   
    \section class_conds Class Conditions of Use:  
    None  
   
    \section throws Throws:  
    None  
   
 */  
   
44  BOOST_PYTHON_MODULE(dudleycpp)  BOOST_PYTHON_MODULE(dudleycpp)
45  {  {
46  // This feature was added in boost v1.34  // This feature was added in boost v1.34
# Line 68  BOOST_PYTHON_MODULE(dudleycpp) Line 49  BOOST_PYTHON_MODULE(dudleycpp)
49    docstring_options docopt(true, true, false);    docstring_options docopt(true, true, false);
50  #endif  #endif
51    
52      scope().attr("__doc__") = "To use this module, please import esys.dudley";  
53      
54      
55    //    //
56    // NOTE: The return_value_policy is necessary for functions that    // NOTE: The return_value_policy is necessary for functions that
57    // return pointers.    // return pointers.
# Line 115  BOOST_PYTHON_MODULE(dudleycpp) Line 99  BOOST_PYTHON_MODULE(dudleycpp)
99        arg("useElementsOnFace")=false,        arg("useElementsOnFace")=false,
100        arg("useFullElementOrder")=false,        arg("useFullElementOrder")=false,
101        arg("optimize")=false)        arg("optimize")=false)
102  ,"Creates a rectangular mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2]."  ,"Creates a tetrahedral mesh by subdividing n0 x n1 x n2 rectangular elements over the brick [0,l0] x [0,l1] x [0,l2]."
103    "We accept floating point values for n0, n1 only to ease transition of scripts to python3 when the time comes."
104  "\n\n:param n0:\n:type n0:\n:param n1:\n:type n1:\n:param n2:\n:type n2:\n"  "\n\n:param n0:\n:type n0:\n:param n1:\n:type n1:\n:param n2:\n:type n2:\n"
105  ":param order: =1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.\n"  ":param order: =1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.\n"
106  ":param l0: length of side 0\n:param l1:\n:param l2:\n"  ":param l0: length of side 0\n:param l1:\n:param l2:\n"
# Line 137  BOOST_PYTHON_MODULE(dudleycpp) Line 122  BOOST_PYTHON_MODULE(dudleycpp)
122        arg("useElementsOnFace")=false,        arg("useElementsOnFace")=false,
123        arg("useFullElementOrder")=false,        arg("useFullElementOrder")=false,
124        arg("optimize")=false)        arg("optimize")=false)
125  ,"Creates a rectangular mesh with n0 x n1 elements over the brick [0,l0] x [0,l1]."  ,"Creates a triangular mesh by subdividing n0 x n1 rectangular elements over the brick [0,l0] x [0,l1]."
126    "We accept floating point values for n0, n1 only to ease transition of scripts to python3 when the time comes."
127  "\n\n:param n0:\n:type n0:\n:param n1:\n:type n1:\n"  "\n\n:param n0:\n:type n0:\n:param n1:\n:type n1:\n"
128  ":param order: =1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.\n"  ":param order: =1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.\n"
129  ":param l0: length of side 0\n:param l1:\n"  ":param l0: length of side 0\n:param l1:\n"
# Line 152  BOOST_PYTHON_MODULE(dudleycpp) Line 138  BOOST_PYTHON_MODULE(dudleycpp)
138  ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``"  ":param optimize: Enable optimisation of node labels\n:type optimize: ``bool``"
139  );  );
140    
   def("Merge",dudley::meshMerge,args("meshList")  
 //       ,return_value_policy<manage_new_object>());  
 ,"Merges a list of meshes into one mesh.\n\n:rtype: `Domain`"  
   );  
   
   def("GlueFaces",dudley::glueFaces,  
       (arg("meshList"),arg("safetyFactor")=0.2,  
       arg("tolerance")=1.e-8,  
       arg("optimize")=true)  
 //       ,return_value_policy<manage_new_object>());  
 ,"Detects matching faces in the mesh, removes them from the mesh and joins the elements touched by the face elements."  
     );  
   
   def("JoinFaces",dudley::joinFaces,  
       (arg("meshList"), arg("safetyFactor")=0.2,  
       arg("tolerance")=1.e-8,  
       arg("optimize")=true)  
 //       ,return_value_policy<manage_new_object>());  
 ,"Detects matching faces in the mesh and replaces them by joint elements."  
     );  
   
   
141    class_<dudley::MeshAdapter, bases<escript::AbstractContinuousDomain> >    class_<dudley::MeshAdapter, bases<escript::AbstractContinuousDomain> >
142        ("MeshAdapter","A concrete class representing a domain. For more details, please consult the c++ documentation.",init<optional <Dudley_Mesh*> >())        ("MeshAdapter","A concrete class representing a domain. For more details, please consult the c++ documentation.",init<optional <Dudley_Mesh*> >())
143        .def(init<const dudley::MeshAdapter&>())        .def(init<const dudley::MeshAdapter&>())
# Line 192  BOOST_PYTHON_MODULE(dudleycpp) Line 156  BOOST_PYTHON_MODULE(dudleycpp)
156  ":return: the number of data points summed across all MPI processes\n"  ":return: the number of data points summed across all MPI processes\n"
157  ":rtype: ``int``")  ":rtype: ``int``")
158        .def("addPDEToSystem",&dudley::MeshAdapter::addPDEToSystem,        .def("addPDEToSystem",&dudley::MeshAdapter::addPDEToSystem,
159  args("mat", "rhs","A", "B", "C", "D", "X", "Y", "d", "y"),  args("mat", "rhs","A", "B", "C", "D", "X", "Y", "d", "y", "d_contact", "y_contact"),
160  "adds a PDE onto the stiffness matrix mat and a rhs\n\n"  "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
161  ":param mat:\n:type mat: `OperatorAdapter`\n:param rhs:\n:type rhs: `Data`\n"  ":param mat:\n:type mat: `OperatorAdapter`\n:param rhs:\n:type rhs: `Data`\n"
162  ":param A:\n:type A: `Data`\n"  ":param A:\n:type A: `Data`\n"
# Line 202  args("mat", "rhs","A", "B", "C", "D", "X Line 166  args("mat", "rhs","A", "B", "C", "D", "X
166  ":param X:\n:type X: `Data`\n"  ":param X:\n:type X: `Data`\n"
167  ":param Y:\n:type Y: `Data`\n"  ":param Y:\n:type Y: `Data`\n"
168  ":param d:\n:type d: `Data`\n"  ":param d:\n:type d: `Data`\n"
169    ":param d_contact:\n:type d_contact: `Data`\n"
170    ":param y_contact:\n:type y_contact: `Data`\n"
171  )  )
172        .def("addPDEToLumpedSystem",&dudley::MeshAdapter::addPDEToLumpedSystem,        .def("addPDEToLumpedSystem",&dudley::MeshAdapter::addPDEToLumpedSystem,
173  args("mat", "D", "d"),  args("mat", "D", "d"),
174  "adds a PDE onto the lumped stiffness matrix\n\n"  "adds a PDE onto the lumped stiffness matrix\n\n"
175  ":param mat:\n:type mat: `Data`\n"  ":param mat:\n:type mat: `Data`\n"
176  ":param D:\n:type D: `Data`\n"  ":param D:\n:type D: `Data`\n"
177  ":param d:\n:type d: `Data`\n")  ":param d:\n:type d: `Data`\n"
178    ":param useHRZ:\n:type useHRZ: bool\n"
179    )
180        .def("addPDEToRHS",&dudley::MeshAdapter::addPDEToRHS,        .def("addPDEToRHS",&dudley::MeshAdapter::addPDEToRHS,
181  args("rhs", "X", "Y", "y", "y_contact"),  args("rhs", "X", "Y", "y", "y_contact"),
182  "adds a PDE onto the stiffness matrix mat and a rhs\n\n"  "adds a PDE onto the stiffness matrix mat and a rhs\n\n"
# Line 303  args("filename" ,"arg",  "metadata", "me Line 271  args("filename" ,"arg",  "metadata", "me
271        .def("MPIBarrier",&dudley::MeshAdapter::MPIBarrier,"Wait until all processes have reached this point")        .def("MPIBarrier",&dudley::MeshAdapter::MPIBarrier,"Wait until all processes have reached this point")
272        .def("onMasterProcessor",&dudley::MeshAdapter::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`");        .def("onMasterProcessor",&dudley::MeshAdapter::onMasterProcessor,":return: True if this code is executing on the master process\n:rtype: `bool`");
273    
   class_<dudley::SystemMatrixAdapter, bases<escript::AbstractSystemMatrix> >  
       ("OperatorAdapter","A concrete class representing an operator. For more details, please see the c++ documentation.", no_init)  
       .def("print_matrix_info",&dudley::SystemMatrixAdapter::Print_Matrix_Info,(arg("full")=false),"prints information about a system matrix")  
       .def("nullifyRowsAndCols",&dudley::SystemMatrixAdapter::nullifyRowsAndCols)  
       .def("resetValues",&dudley::SystemMatrixAdapter::resetValues, "resets the matrix entries")  
       .def("saveMM",&dudley::SystemMatrixAdapter::saveMM,args("fileName"),  
 "writes the matrix to a file using the Matrix Market file format")  
       .def("saveHB",&dudley::SystemMatrixAdapter::saveHB, args("filename"),  
 "writes the matrix to a file using the Harwell-Boeing file format");  
   
   class_<dudley::TransportProblemAdapter, bases<escript::AbstractTransportProblem> >  
       ("TransportProblemAdapter","",no_init)  
       .def("getSafeTimeStepSize",&dudley::TransportProblemAdapter::getSafeTimeStepSize)  
       .def("getUnlimitedTimeStepSize",&dudley::TransportProblemAdapter::getUnlimitedTimeStepSize)  
       .def("resetTransport",&dudley::TransportProblemAdapter::resetTransport,  
 "resets the transport operator typically as they have been updated");  
274  }  }

Legend:
Removed from v.3114  
changed lines
  Added in v.3994

  ViewVC Help
Powered by ViewVC 1.1.26