Commit 1b44cb9e authored by Jason Swails's avatar Jason Swails
Browse files

Fix up some of the documentation and add the usesPeriodicBoundaryConditions to

the barostats and andersen thermostat.
parent 92d5b9a7
...@@ -117,6 +117,13 @@ public: ...@@ -117,6 +117,13 @@ public:
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
} }
/**
* Returns whether or not this force makes use of periodic boundary
* conditions.
*
* @returns true if force uses PBC and false otherwise
*/
bool usesPeriodicBoundaryConditions() const {return false;}
protected: protected:
ForceImpl* createImpl() const; ForceImpl* createImpl() const;
private: private:
......
...@@ -61,6 +61,13 @@ public: ...@@ -61,6 +61,13 @@ public:
void setFrequency(int freq) { void setFrequency(int freq) {
frequency = freq; frequency = freq;
} }
/**
* Returns whether or not this force makes use of periodic boundary
* conditions.
*
* @returns true if force uses PBC and false otherwise
*/
bool usesPeriodicBoundaryConditions() const {return false;}
protected: protected:
ForceImpl* createImpl() const; ForceImpl* createImpl() const;
private: private:
......
...@@ -527,7 +527,7 @@ public: ...@@ -527,7 +527,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const { bool usesPeriodicBoundaryConditions() const {
return nonbondedMethod == CustomGBForce::CutoffPeriodic; return nonbondedMethod == CustomGBForce::CutoffPeriodic;
......
...@@ -447,7 +447,7 @@ public: ...@@ -447,7 +447,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const { bool usesPeriodicBoundaryConditions() const {
return nonbondedMethod == CustomHbondForce::CutoffPeriodic; return nonbondedMethod == CustomHbondForce::CutoffPeriodic;
......
...@@ -465,7 +465,7 @@ public: ...@@ -465,7 +465,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const { bool usesPeriodicBoundaryConditions() const {
return nonbondedMethod == CustomManyParticleForce::CutoffPeriodic; return nonbondedMethod == CustomManyParticleForce::CutoffPeriodic;
......
...@@ -468,7 +468,7 @@ public: ...@@ -468,7 +468,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const { bool usesPeriodicBoundaryConditions() const {
return nonbondedMethod == CustomNonbondedForce::CutoffPeriodic; return nonbondedMethod == CustomNonbondedForce::CutoffPeriodic;
......
...@@ -209,7 +209,7 @@ public: ...@@ -209,7 +209,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const {return false;} bool usesPeriodicBoundaryConditions() const {return false;}
protected: protected:
......
...@@ -188,7 +188,7 @@ public: ...@@ -188,7 +188,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const { bool usesPeriodicBoundaryConditions() const {
return nonbondedMethod == GBSAOBCForce::CutoffPeriodic; return nonbondedMethod == GBSAOBCForce::CutoffPeriodic;
......
...@@ -233,7 +233,7 @@ public: ...@@ -233,7 +233,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const { bool usesPeriodicBoundaryConditions() const {
return nonbondedMethod == GBVIForce::CutoffPeriodic; return nonbondedMethod == GBVIForce::CutoffPeriodic;
......
...@@ -106,7 +106,7 @@ public: ...@@ -106,7 +106,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const {return false;} bool usesPeriodicBoundaryConditions() const {return false;}
protected: protected:
......
...@@ -103,7 +103,7 @@ public: ...@@ -103,7 +103,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const {return false;} bool usesPeriodicBoundaryConditions() const {return false;}
protected: protected:
......
...@@ -171,6 +171,13 @@ public: ...@@ -171,6 +171,13 @@ public:
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
} }
/**
* Returns whether or not this force makes use of periodic boundary
* conditions.
*
* @returns true if force uses PBC and false otherwise
*/
bool usesPeriodicBoundaryConditions() const {return true;}
protected: protected:
ForceImpl* createImpl() const; ForceImpl* createImpl() const;
private: private:
......
...@@ -127,6 +127,13 @@ public: ...@@ -127,6 +127,13 @@ public:
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
} }
/**
* Returns whether or not this force makes use of periodic boundary
* conditions.
*
* @returns true if force uses PBC and false otherwise
*/
bool usesPeriodicBoundaryConditions() const {return true;}
protected: protected:
ForceImpl* createImpl() const; ForceImpl* createImpl() const;
private: private:
......
...@@ -224,6 +224,13 @@ public: ...@@ -224,6 +224,13 @@ public:
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
} }
/**
* Returns whether or not this force makes use of periodic boundary
* conditions.
*
* @returns true if force uses PBC and false otherwise
*/
bool usesPeriodicBoundaryConditions() const {return true;}
protected: protected:
ForceImpl* createImpl() const; ForceImpl* createImpl() const;
private: private:
......
...@@ -356,7 +356,7 @@ public: ...@@ -356,7 +356,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const { bool usesPeriodicBoundaryConditions() const {
return nonbondedMethod == NonbondedForce::CutoffPeriodic || return nonbondedMethod == NonbondedForce::CutoffPeriodic ||
......
...@@ -112,7 +112,7 @@ public: ...@@ -112,7 +112,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const {return false;} bool usesPeriodicBoundaryConditions() const {return false;}
protected: protected:
......
...@@ -121,7 +121,7 @@ public: ...@@ -121,7 +121,7 @@ public:
* Returns whether or not this force makes use of periodic boundary * Returns whether or not this force makes use of periodic boundary
* conditions. * conditions.
* *
* @returns true if nonbondedMethod uses PBC and false otherwise * @returns true if force uses PBC and false otherwise
*/ */
bool usesPeriodicBoundaryConditions() const {return false;} bool usesPeriodicBoundaryConditions() const {return false;}
protected: protected:
......
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