File: BondInteractionGroupPy.h

package info (click to toggle)
esys-particle 2.3.5%2Bdfsg2-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 13,132 kB
  • sloc: cpp: 81,480; python: 5,872; makefile: 1,259; sh: 313; perl: 225
file content (71 lines) | stat: -rw-r--r-- 1,957 bytes parent folder | download | duplicates (4)
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
/////////////////////////////////////////////////////////////
//                                                         //
// Copyright (c) 2003-2017 by The University of Queensland //
// Centre for Geoscience Computing                         //
// http://earth.uq.edu.au/centre-geoscience-computing      //
//                                                         //
// Primary Business: Brisbane, Queensland, Australia       //
// Licensed under the Open Software License version 3.0    //
// http://www.apache.org/licenses/LICENSE-2.0              //
//                                                         //
/////////////////////////////////////////////////////////////

#ifndef ESYS_LSMBONDINTERACTIONGROUPPY_H
#define ESYS_LSMBONDINTERACTIONGROUPPY_H

#include <Python/esys/lsm/InteractionGroupPy.h>
#include "Python/esys/lsm/ParticleIdPairSetPy.h"

namespace boost
{
  namespace python
  {
    class object;
  }
}

namespace esys
{
  namespace lsm
  {
    class LsmMpiPy;
    
    /**
     * Bond interaction group, delegates to an LsmMpiPy object.
     */
    class BondInteractionGroupPy : public InteractionGroupPy
    {
    public:

      BondInteractionGroupPy(
        LsmMpiPy          &lsm,
        const std::string &name
      );

      /**
       * Creates a bond between particles with specified ID's.
       * @param id1 Particle ID.
       * @param id2 Particle ID.
       */
      void createInteraction(int id1, int id2);

      /**
       * Creates bonds between specified pairs of particles.
       *
       * @param iterable Sequence of particle ID pairs.
       */
      void createInteractions(boost::python::object &iterable);

      /**
       * Return particle-id pairs indicating which particles
       * are bonded to one another.
       */
      ParticleIdPairSetPy getIdPairSet();
    };

    void exportBondInteractionGroup();

  } // namespace lsm
} // namespace esys

#endif // ESYS_LSMBONDINTERACTIONGROUPPY_H