votca 2024-dev
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
votca::csg::BeadTriple Class Reference

A triplet of tree Beads. More...

#include <beadtriple.h>

Inheritance diagram for votca::csg::BeadTriple:
Inheritance graph
[legend]
Collaboration diagram for votca::csg::BeadTriple:
Collaboration graph
[legend]

Public Member Functions

 BeadTriple ()=default
 
 BeadTriple (Bead *bead1, Bead *bead2, Bead *bead3, Eigen::Vector3d r12, Eigen::Vector3d r13, Eigen::Vector3d r23)
 
virtual ~BeadTriple ()=default
 
const Beadbead1 ()
 return the beads
 
const Beadbead2 ()
 
const Beadbead3 ()
 
Eigen::Vector3d & r12 ()
 the vector connecting two beads
 
Eigen::Vector3d & r13 ()
 
Eigen::Vector3d & r23 ()
 
double & dist12 ()
 the distance of the beads
 
double & dist13 ()
 
double & dist23 ()
 

Protected Attributes

Eigen::Vector3d r12_
 
Eigen::Vector3d r13_
 
Eigen::Vector3d r23_
 
double dist12_
 
double dist13_
 
double dist23_
 

Detailed Description

A triplet of tree Beads.

Definition at line 32 of file beadtriple.h.

Constructor & Destructor Documentation

◆ BeadTriple() [1/2]

votca::csg::BeadTriple::BeadTriple ( )
default

◆ BeadTriple() [2/2]

votca::csg::BeadTriple::BeadTriple ( Bead bead1,
Bead bead2,
Bead bead3,
Eigen::Vector3d  r12,
Eigen::Vector3d  r13,
Eigen::Vector3d  r23 
)
inline

Definition at line 35 of file beadtriple.h.

◆ ~BeadTriple()

virtual votca::csg::BeadTriple::~BeadTriple ( )
virtualdefault

Member Function Documentation

◆ bead1()

const Bead * votca::csg::BeadTriple::bead1 ( )
inline

return the beads

Definition at line 48 of file beadtriple.h.

◆ bead2()

const Bead * votca::csg::BeadTriple::bead2 ( )
inline

Definition at line 49 of file beadtriple.h.

◆ bead3()

const Bead * votca::csg::BeadTriple::bead3 ( )
inline

Definition at line 50 of file beadtriple.h.

◆ dist12()

double & votca::csg::BeadTriple::dist12 ( )
inline

the distance of the beads

Definition at line 57 of file beadtriple.h.

◆ dist13()

double & votca::csg::BeadTriple::dist13 ( )
inline

Definition at line 58 of file beadtriple.h.

◆ dist23()

double & votca::csg::BeadTriple::dist23 ( )
inline

Definition at line 59 of file beadtriple.h.

◆ r12()

Eigen::Vector3d & votca::csg::BeadTriple::r12 ( )
inline

the vector connecting two beads

Definition at line 53 of file beadtriple.h.

◆ r13()

Eigen::Vector3d & votca::csg::BeadTriple::r13 ( )
inline

Definition at line 54 of file beadtriple.h.

◆ r23()

Eigen::Vector3d & votca::csg::BeadTriple::r23 ( )
inline

Definition at line 55 of file beadtriple.h.

Member Data Documentation

◆ dist12_

double votca::csg::BeadTriple::dist12_
protected

Definition at line 65 of file beadtriple.h.

◆ dist13_

double votca::csg::BeadTriple::dist13_
protected

Definition at line 66 of file beadtriple.h.

◆ dist23_

double votca::csg::BeadTriple::dist23_
protected

Definition at line 67 of file beadtriple.h.

◆ r12_

Eigen::Vector3d votca::csg::BeadTriple::r12_
protected

Definition at line 62 of file beadtriple.h.

◆ r13_

Eigen::Vector3d votca::csg::BeadTriple::r13_
protected

Definition at line 63 of file beadtriple.h.

◆ r23_

Eigen::Vector3d votca::csg::BeadTriple::r23_
protected

Definition at line 64 of file beadtriple.h.


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