ParM  parm
A molecular dynamics library
Public Member Functions | List of all members
AtomID Class Reference

A pointer to an Atom, that also knows its own index in an AtomVec. More...

#include <box.hpp>

Inheritance diagram for AtomID:
AtomRef Charged EisMclachlanAtom EpsSigAtom EpsSigExpAtom EpsSigExpDragAtom FixedForceRegionAtom IEpsISigCutAtom IEpsISigExpAtom IEpsRepsSigCutAtom IEpsRepsSigExpCutAtom IEpsSigCutAtom LoisLinAtom LoisOhernAtom

Public Member Functions

 AtomID ()
 Constructor not recommended: uses UINT_MAX for number, i.e. unknown. More...
 
 AtomID (Atom *a, uint n)
 Recommended constructor. More...
 
uint n () const
 
- Public Member Functions inherited from AtomRef
 AtomRef ()
 
 AtomRef (Atom *a)
 
Atomoperator* () const
 
Atomoperator-> () const
 
bool operator== (const AtomRef &other) const
 
bool operator== (const Atom *other) const
 
bool operator!= (const AtomRef &other) const
 
bool operator< (const AtomRef &other) const
 
bool operator<= (const AtomRef &other) const
 
bool operator>= (const AtomRef &other) const
 
bool operator> (const AtomRef &other) const
 
bool is_null ()
 

Detailed Description

A pointer to an Atom, that also knows its own index in an AtomVec.

This is used in many Interaction classes to compair atoms.

Constructor & Destructor Documentation

AtomID::AtomID ( )
inline

Constructor not recommended: uses UINT_MAX for number, i.e. unknown.

AtomID::AtomID ( Atom a,
uint  n 
)
inline

Recommended constructor.

Member Function Documentation

uint AtomID::n ( ) const
inline

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