votca::csg::BeadPair Class Reference

A particle pair. More...

#include <beadpair.h>

Collaboration diagram for votca::csg::BeadPair:

Public Member Functions
	BeadPair ()=default
	BeadPair (Bead *bead1, Bead *bead2, Eigen::Vector3d r)
Bead *	first ()
Bead *	second ()
const Eigen::Vector3d &	r () const
	the vector connecting two beads
double	dist () const
	the distance of the beads

Protected Attributes
std::pair< Bead *, Bead * >	pair_
Eigen::Vector3d	r_
double	dist_

Detailed Description

A particle pair.

This class defines a particle pair. The future plan is, that the Pair class can be overloaded and Particle list creates these inherited pairs.

Definition at line 35 of file beadpair.h.

Constructor & Destructor Documentation

BeadPair() [1/2]

votca::csg::BeadPair::BeadPair ( )

default

BeadPair() [2/2]

votca::csg::BeadPair::BeadPair ( Bead * bead1, Bead * bead2, Eigen::Vector3d r )

inline

Definition at line 38 of file beadpair.h.

Member Function Documentation

dist()

double votca::csg::BeadPair::dist ( ) const

inline

the distance of the beads

Definition at line 48 of file beadpair.h.

first()

Bead * votca::csg::BeadPair::first ( )

inline

Definition at line 43 of file beadpair.h.

r()

const Eigen::Vector3d & votca::csg::BeadPair::r ( ) const

inline

the vector connecting two beads

Definition at line 46 of file beadpair.h.

second()

Bead * votca::csg::BeadPair::second ( )

inline

Definition at line 44 of file beadpair.h.

Member Data Documentation

dist_

double votca::csg::BeadPair::dist_

protected

Definition at line 54 of file beadpair.h.

pair_

std::pair<Bead *, Bead *> votca::csg::BeadPair::pair_

protected

Definition at line 51 of file beadpair.h.

r_

Eigen::Vector3d votca::csg::BeadPair::r_

protected

Definition at line 53 of file beadpair.h.

---

The documentation for this class was generated from the following file:

• csg/include/votca/csg/beadpair.h