Represents atoms seen through the periodic boundaries. More...

#include <Image.h>

Public Member Functions
	Image ()
	Dummy constructor needed by some STL containers.
	Image (int num, int nTrans)
	Construct an image of atom n translated by translation number nTrans.

Public Attributes
int	number
	The number of the real atom.
int	nTranslation
	The number of the translation to apply to the real atom.

Detailed Description

Represents atoms seen through the periodic boundaries.

The Image structure is used by NeighborList to represent atoms seen through the periodic boundary conditions.

Definition at line 7 of file Image.h.

Constructor & Destructor Documentation

◆ Image() [1/2]

Image::Image ( )

inline

Dummy constructor needed by some STL containers.

Definition at line 9 of file Image.h.

9{};

◆ Image() [2/2]

Image::Image	(	int	num,
		int	nTrans )

inline

Construct an image of atom n translated by translation number nTrans.

Definition at line 11 of file Image.h.

12 : number(num),

13 nTranslation(nTrans) {}

Image::number

int number

The number of the real atom.

Definition Image.h:16

Image::nTranslation

int nTranslation

The number of the translation to apply to the real atom.

Definition Image.h:19

Member Data Documentation

◆ nTranslation

int Image::nTranslation

The number of the translation to apply to the real atom.

Definition at line 19 of file Image.h.

◆ number

int Image::number

The number of the real atom.

Definition at line 16 of file Image.h.

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

/home/runner/work/eOn/eOn/include/eon/potentials/EMT/Asap/Image.h

Public Member Functions