votca 2024.2-dev
Loading...
Searching...
No Matches
votca::csg::TriclinicBox Class Reference

#include <triclinicbox.h>

Inheritance diagram for votca::csg::TriclinicBox:
Collaboration diagram for votca::csg::TriclinicBox:

Public Member Functions

Eigen::Vector3d BCShortestConnection (const Eigen::Vector3d &r_i, const Eigen::Vector3d &r_j) const final
 
virtual std::unique_ptr< BoundaryConditionClone () const final
 Safe way to allow child classes to be copied.
 
eBoxtype getBoxType () const noexcept final
 
- Public Member Functions inherited from votca::csg::BoundaryCondition
virtual ~BoundaryCondition ()=default
 
void setBox (const Eigen::Matrix3d &box) noexcept
 
const Eigen::Matrix3d & getBox () const noexcept
 
double getShortestBoxDimension () const
 Self explanatory gets the shortest dimension of the boundary conditions.
 
virtual double BoxVolume () const noexcept
 

Additional Inherited Members

- Public Types inherited from votca::csg::BoundaryCondition
enum  eBoxtype { typeAuto = 0 , typeTriclinic , typeOrthorhombic , typeOpen }
 
- Protected Attributes inherited from votca::csg::BoundaryCondition
Eigen::Matrix3d box_
 

Detailed Description

Definition at line 27 of file triclinicbox.h.

Member Function Documentation

◆ BCShortestConnection()

Eigen::Vector3d votca::csg::TriclinicBox::BCShortestConnection ( const Eigen::Vector3d & r_i,
const Eigen::Vector3d & r_j ) const
finalvirtual

get shortest connection vector between r_i and r_j with respect to the (periodic) box

Returns
shortest distance vector

Implements votca::csg::BoundaryCondition.

Definition at line 34 of file triclinicbox.cc.

◆ Clone()

virtual std::unique_ptr< BoundaryCondition > votca::csg::TriclinicBox::Clone ( ) const
inlinefinalvirtual

Safe way to allow child classes to be copied.

The child classes must use the same method and override it with their type for this to work.

Returns
standard pointer to child class

Implements votca::csg::BoundaryCondition.

Definition at line 33 of file triclinicbox.h.

◆ getBoxType()

eBoxtype votca::csg::TriclinicBox::getBoxType ( ) const
inlinefinalvirtualnoexcept

Implements votca::csg::BoundaryCondition.

Definition at line 37 of file triclinicbox.h.


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