document Pointers class and LAMMPS_NS namespace

This commit is contained in:
Axel Kohlmeyer
2020-09-19 11:16:44 -04:00
parent 73c65d43e1
commit 89506efd23
3 changed files with 26 additions and 0 deletions

View File

@ -48,6 +48,20 @@ enum ExecutionSpace{Host,Device};
template <class T> class MyPoolChunk;
template <class T> class MyPage;
/** \class LAMMPS_NS::Pointers
* \brief Base class for LAMMPS features
*
* The Pointers class contains references to many of the pointers
* and members of the LAMMPS_NS::LAMMPS class. Derived classes thus
* gain access to the constituent class instances in the LAMMPS
* composite class and thus to the core functionality of LAMMPS.
*
* This kind of construct is needed, since the LAMMPS constructor
* should only be run once per LAMMPS instance and thus classes
* cannot be derived from LAMMPS itself. The Pointers class
* constructor instead only initializes the references to the
* LAMMPS class members it provides access to. */
class Pointers {
public:
Pointers(LAMMPS *ptr) :