Commit 524bf8cb authored by Peter Eastman's avatar Peter Eastman
Browse files

Minor improvements to Doxygen comments

parent a82ce984
...@@ -168,13 +168,13 @@ public: ...@@ -168,13 +168,13 @@ public:
return queue; return queue;
} }
/** /**
* Get the array which contains the position and charge of each atom. * Get the array which contains the position (the xyz components) and charge (the w component) of each atom.
*/ */
OpenCLArray<mm_float4>& getPosq() { OpenCLArray<mm_float4>& getPosq() {
return *posq; return *posq;
} }
/** /**
* Get the array which contains the velocity and inverse mass of each atom. * Get the array which contains the velocity (the xyz components) and inverse mass (the w component) of each atom.
*/ */
OpenCLArray<mm_float4>& getVelm() { OpenCLArray<mm_float4>& getVelm() {
return *velm; return *velm;
......
...@@ -49,7 +49,8 @@ public: ...@@ -49,7 +49,8 @@ public:
return *posDelta; return *posDelta;
} }
/** /**
* Get the array which contains random values. * Get the array which contains random values. Each element is a float4, whose components
* are independent, normally distributed random numbers with mean 0 and variance 1.
*/ */
OpenCLArray<mm_float4>& getRandom() { OpenCLArray<mm_float4>& getRandom() {
return *random; return *random;
......
...@@ -51,13 +51,13 @@ namespace OpenMM { ...@@ -51,13 +51,13 @@ namespace OpenMM {
* 1. Data structures (e.g. neighbor lists) are calculated to allow nonbonded interactions to be evaluated * 1. Data structures (e.g. neighbor lists) are calculated to allow nonbonded interactions to be evaluated
* quickly. * quickly.
* *
* 2. calcForces() or calcEnergy() is called on each ForceImpl in the System. * 2. calcForcesAndEnergy() is called on each ForceImpl in the System.
* *
* 3. Finally, the default interaction kernel is invoked to calculate all interactions that were added * 3. Finally, the default interaction kernel is invoked to calculate all interactions that were added
* to it. * to it.
* *
* This sequence means that the default interaction kernel may depend on quantities that were calculated * This sequence means that the default interaction kernel may depend on quantities that were calculated
* by ForceImpls during calcForces() or calcEnergy(). * by ForceImpls during calcForcesAndEnergy().
*/ */
class OPENMM_EXPORT OpenCLNonbondedUtilities { class OPENMM_EXPORT OpenCLNonbondedUtilities {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment