File: HexAggregateInsertGenerator3DPy.cc

package info (click to toggle)
python-demgengeo 0.99~bzr106-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,552 kB
  • sloc: cpp: 12,251; python: 1,251; makefile: 261; sh: 26
file content (94 lines) | stat: -rw-r--r-- 4,445 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/////////////////////////////////////////////////////////////
//                                                         //
// Copyright (c) 2007-2011 by The University of Queensland //
// Earth Systems Science Computational Centre (ESSCC)      //
// http://www.uq.edu.au/esscc                              //
//                                                         //
// Primary Business: Brisbane, Queensland, Australia       //
// Licensed under the Open Software License version 3.0    //
// http://www.opensource.org/licenses/osl-3.0.php          //
//                                                         //
/////////////////////////////////////////////////////////////

#include <boost/version.hpp>
#include <iostream>
#include <sstream>
#include "HexAggregateInsertGenerator3DPy.h"

using namespace boost::python;

   using boost::python::arg;
   void exportHexAggregateInsertGenerator3D()
   {
     // Check that Boost 1.34.0 or higher is being used.
     // If so, disable auto-generation of C++ signatures for Epydoc
     // (which stumbles over indentation in the auto-generated strings).
     #if ((BOOST_VERSION / 100000 >= 1) \
         && (BOOST_VERSION / 100 % 1000 >= 34)) \
         || (BOOST_VERSION / 100000 >= 2)
       boost::python::docstring_options no_autogen(true,false);
     #endif

      class_<HexAggregateInsertGenerator3D, bases<InsertGenerator3D> >(
        "HexAggregateInsertGenerator3D",
        "A particle packing algorithm for filling L{AVolume3D} spaces with hexahedral aggregates of particles",
        init<>()
      )
      .def(init<const HexAggregateInsertGenerator3D &>())
      .def(
	   init<double,double,int,int,double,bool>(
	   ( arg("minRadius"), arg("maxRadius"), arg("insertFails"), arg("maxIterations"), arg("tolerance"),arg("seed") ),
	  "Initialises a particle packer in preparation for filling a\n"
          "L{AVolume3D} with hexahedral aggregates whose bounding sphere radii are in the specified range.\n"
          "The algorithm consists of two stages: \n"
          "1) the L{AVolume3D} is packed with particles of a specified radius range,\n"
          "2) each particle is replaced with a hexahedral grain of particles of equal size\n"
          "@type minRadius: double\n"
          "@kwarg minRadius: the minimum radius of particles to pack\n"
          "@type maxRadius: double\n"
          "@kwarg maxRadius: the maximum radius of particles to pack\n"
          "@type insertFails: int\n"
          "@kwarg insertFails: the number of particle insertion failures before the packer terminates\n"
          "@type maxIterations: int\n"
          "@kwarg maxIterations: the maximum number of iterations of the solver\n"
          "@type tolerance: double\n"
          "@kwarg tolerance: the overlap tolerance permitted\n"
          "@type seed: bool\n"
          "@kwarg seed: randomize the random number generator if True\n"
          "@rtype: void\n"
        )
      )
      .def(
        "generatePacking",
        &HexAggregateInsertGenerator3D::generatePacking3,
        ( arg("volume"), arg("ntable"), arg("groupID")=0 ),
	"Generates a particle assembly to fill the specified volume with\n"
	"hexahedral aggregrates whose constituent particles have the specified particle tag\n"
        "@type volume: L{AVolume3D}\n"
        "@kwarg volume: the 3D volume to fill with particles\n"
        "@type ntable: L{MNTable3D}\n"
        "@kwarg ntable: the neighbours table particles are inserted into\n"
        "@type groupID: int\n"
        "@kwarg groupID: the group ID assigned to particles (default: 0)\n"
        "@rtype: void\n"
      )
      .def(
        "generatePacking",
        &HexAggregateInsertGenerator3D::generatePacking4,
        ( arg("volume"), arg("ntable"), arg("groupID")=0, arg("tag") ),
        "@type tag: int\n"
        "@kwarg tag: the tag assigned to the generated particles\n"
        " (optional if not followed by C{list})\n"
      )
      .def(
        "generatePackingMaxVolume",
        &HexAggregateInsertGenerator3D::generatePackingMaxVolume,
        ( arg("volume"), arg("ntable"), arg("groupID")=0, arg("tag"), arg("maxVolume") ),
	"Fill the specified L{AVolume3D} with particles until the accumulated particle volume exceeds the specified C{maxVolume}.\n"
        "@type maxVolume: float\n"
        "@kwarg maxVolume: the maximum cumulative volume of the inserted particles\n"
      )
      .def(self_ns::str(self))
      ;
    }