Skip to content

GitLab

"...ssh:/git@developer.sourcefind.cn:2222/tsoc/openmm.git" did not exist on "9966f134d166a9365211d4d4eb9a109c8a49631f"
Unverified Commit 726544fa authored by Peter Eastman's avatar Peter Eastman Committed by GitHub
Browse files

Clarified documentation on virtual sites (#4292)

parent ac1748ac
Show whitespace changes
Inline Side-by-side
Showing with 9 additions and 9 deletions
openmmapi/include/openmm/VirtualSite.h
View file @ 726544fa
...@@ -70,8 +70,8 @@ private: ...@@ -70,8 +70,8 @@ private:
/** /**
* This is a VirtualSite that computes the particle location as a weighted average * This is a VirtualSite that computes the particle location as a weighted average
* of two other particle's locations. Assuming the weights add up to 1, this means * of two other particle's locations. This means the virtual site is on the
* the virtual site is on the line passing through the two particles. * line passing through the two particles.
*/ */
class OPENMM_EXPORT TwoParticleAverageSite : public VirtualSite { class OPENMM_EXPORT TwoParticleAverageSite : public VirtualSite {
public: public:
...@@ -81,8 +81,8 @@ public: ...@@ -81,8 +81,8 @@ public:
* *
* @param particle1 the index of the first particle * @param particle1 the index of the first particle
* @param particle2 the index of the second particle * @param particle2 the index of the second particle
* @param weight1 the weight factor (between 0 and 1) for the first particle * @param weight1 the weight factor (typically between 0 and 1) for the first particle
* @param weight2 the weight factor (between 0 and 1) for the second particle * @param weight2 the weight factor (typically between 0 and 1) for the second particle
*/ */
TwoParticleAverageSite(int particle1, int particle2, double weight1, double weight2); TwoParticleAverageSite(int particle1, int particle2, double weight1, double weight2);
/** /**
...@@ -98,8 +98,8 @@ private: ...@@ -98,8 +98,8 @@ private:
/** /**
* This is a VirtualSite that computes the particle location as a weighted average * This is a VirtualSite that computes the particle location as a weighted average
* of three other particle's locations. Assuming the weights add up to 1, this means * of three other particle's locations. This means the virtual site is in the
* the virtual site is in the plane of the three particles. * plane of the three particles.
*/ */
class OPENMM_EXPORT ThreeParticleAverageSite : public VirtualSite { class OPENMM_EXPORT ThreeParticleAverageSite : public VirtualSite {
public: public:
...@@ -110,9 +110,9 @@ public: ...@@ -110,9 +110,9 @@ public:
* @param particle1 the index of the first particle * @param particle1 the index of the first particle
* @param particle2 the index of the second particle * @param particle2 the index of the second particle
* @param particle3 the index of the third particle * @param particle3 the index of the third particle
* @param weight1 the weight factor (between 0 and 1) for the first particle * @param weight1 the weight factor (typically between 0 and 1) for the first particle
* @param weight2 the weight factor (between 0 and 1) for the second particle * @param weight2 the weight factor (typically between 0 and 1) for the second particle
* @param weight3 the weight factor (between 0 and 1) for the third particle * @param weight3 the weight factor (typically between 0 and 1) for the third particle
*/ */
ThreeParticleAverageSite(int particle1, int particle2, int particle3, double weight1, double weight2, double weight3); ThreeParticleAverageSite(int particle1, int particle2, int particle3, double weight1, double weight2, double weight3);
/** /**
......
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