/[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

revision 3892 by jfenwick, Tue Apr 10 08:57:23 2012 UTC revision 4154 by jfenwick, Tue Jan 22 09:30:23 2013 UTC
# Line 1  Line 1 
1    
2  /*******************************************************  /*****************************************************************************
3  *  *
4  * Copyright (c) 2003-2010 by University of Queensland  * Copyright (c) 2003-2013 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 ESYS_MPI  #ifdef ESYS_MPI
# 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 262  args("arg"), "assigns new location to th Line 246  args("arg"), "assigns new location to th
246  ":rtype: `Data`")  ":rtype: `Data`")
247        .def("getSize",&dudley::MeshAdapter::getSize,":return: the element size\n"        .def("getSize",&dudley::MeshAdapter::getSize,":return: the element size\n"
248  ":rtype: `Data`")  ":rtype: `Data`")
       .def("saveDX",&dudley::MeshAdapter::saveDX,args("filename" ,"arg"),  
 "Saves a dictonary of Data objects to an OpenDX input file. The keywords are used as identifier"  
 "\n\n:param filename: \n:type filename: ``string``\n"  
 "\n:param arg: \n:type arg: ``dict``\n")  
       .def("saveVTK",&dudley::MeshAdapter::saveVTK,  
 args("filename" ,"arg",  "metadata", "metadata_schema"),  
 "Saves a dictonary of Data objects to an VTK XML input file. The keywords are used as identifier"  
 "\n\n:param filename:\n:type filename: ``string``\n"  
 ":param arg:\n:type arg: ``dict``\n"  
 ":param metadata:\n:type metadata: ``string``\n"  
 ":param metadata_schema:\n:type metadata_schema: ``string``\n"  
 )  
249        .def("setTagMap",&dudley::MeshAdapter::setTagMap,args("name","tag"),        .def("setTagMap",&dudley::MeshAdapter::setTagMap,args("name","tag"),
250  "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"  "Give a tag number a name.\n\n:param name: Name for the tag\n:type name: ``string``\n"
251  ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")  ":param tag: numeric id\n:type tag: ``int``\n:note: Tag names must be unique within a domain")

Legend:
Removed from v.3892  
changed lines
  Added in v.4154

  ViewVC Help
Powered by ViewVC 1.1.26