ParM  parm
A molecular dynamics library
Public Member Functions | List of all members
Box Class Referenceabstract

The virtual interface for the shape of the space and its boundaries. More...

#include <box.hpp>

Inheritance diagram for Box:
InfiniteBox OriginBox SCBox LeesEdwardsBox WalledBox2D

Public Member Functions

virtual Vec diff (Vec r1, Vec r2)=0
 Distance between two points, given boundary conditions. More...
 
virtual flt V ()=0
 Volume. Can return NaN. More...
 
virtual ~Box ()
 

Detailed Description

The virtual interface for the shape of the space and its boundaries.

Examples:
hardspheres.cpp, and LJatoms.cpp.

Constructor & Destructor Documentation

virtual Box::~Box ( )
inlinevirtual

Member Function Documentation

virtual Vec Box::diff ( Vec  r1,
Vec  r2 
)
pure virtual

Distance between two points, given boundary conditions.

This is the main function that Box exists for.

Implemented in WalledBox2D, SCBox, LeesEdwardsBox, OriginBox, and InfiniteBox.

Examples:
hardspheres.cpp, and LJatoms.cpp.
virtual flt Box::V ( )
pure virtual

Volume. Can return NaN.

Implemented in WalledBox2D, SCBox, OriginBox, OriginBox, and InfiniteBox.


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