1 |
gezelter |
507 |
/* |
2 |
gezelter |
246 |
* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. |
3 |
tim |
122 |
* |
4 |
gezelter |
246 |
* The University of Notre Dame grants you ("Licensee") a |
5 |
|
|
* non-exclusive, royalty free, license to use, modify and |
6 |
|
|
* redistribute this software in source and binary code form, provided |
7 |
|
|
* that the following conditions are met: |
8 |
|
|
* |
9 |
gezelter |
1390 |
* 1. Redistributions of source code must retain the above copyright |
10 |
gezelter |
246 |
* notice, this list of conditions and the following disclaimer. |
11 |
|
|
* |
12 |
gezelter |
1390 |
* 2. Redistributions in binary form must reproduce the above copyright |
13 |
gezelter |
246 |
* notice, this list of conditions and the following disclaimer in the |
14 |
|
|
* documentation and/or other materials provided with the |
15 |
|
|
* distribution. |
16 |
|
|
* |
17 |
|
|
* This software is provided "AS IS," without a warranty of any |
18 |
|
|
* kind. All express or implied conditions, representations and |
19 |
|
|
* warranties, including any implied warranty of merchantability, |
20 |
|
|
* fitness for a particular purpose or non-infringement, are hereby |
21 |
|
|
* excluded. The University of Notre Dame and its licensors shall not |
22 |
|
|
* be liable for any damages suffered by licensee as a result of |
23 |
|
|
* using, modifying or distributing the software or its |
24 |
|
|
* derivatives. In no event will the University of Notre Dame or its |
25 |
|
|
* licensors be liable for any lost revenue, profit or data, or for |
26 |
|
|
* direct, indirect, special, consequential, incidental or punitive |
27 |
|
|
* damages, however caused and regardless of the theory of liability, |
28 |
|
|
* arising out of the use of or inability to use software, even if the |
29 |
|
|
* University of Notre Dame has been advised of the possibility of |
30 |
|
|
* such damages. |
31 |
gezelter |
1390 |
* |
32 |
|
|
* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your |
33 |
|
|
* research, please cite the appropriate papers when you publish your |
34 |
|
|
* work. Good starting points are: |
35 |
|
|
* |
36 |
|
|
* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005). |
37 |
|
|
* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006). |
38 |
gezelter |
1850 |
* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008). |
39 |
gezelter |
1665 |
* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010). |
40 |
|
|
* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011). |
41 |
tim |
122 |
*/ |
42 |
gezelter |
246 |
|
43 |
tim |
122 |
#ifndef BRAINS_SNAPSHOT_HPP |
44 |
|
|
#define BRAINS_SNAPSHOT_HPP |
45 |
tim |
137 |
|
46 |
|
|
#include <vector> |
47 |
|
|
|
48 |
tim |
155 |
#include "brains/DataStorage.hpp" |
49 |
gezelter |
1757 |
#include "nonbonded/NonBondedInteraction.hpp" |
50 |
gezelter |
246 |
#include "brains/Stats.hpp" |
51 |
tim |
137 |
|
52 |
gezelter |
1764 |
using namespace std; |
53 |
gezelter |
1390 |
namespace OpenMD{ |
54 |
tim |
122 |
|
55 |
gezelter |
1760 |
/** |
56 |
|
|
* FrameData is a structure for holding system-wide dynamic data |
57 |
|
|
* about the simulation. |
58 |
|
|
*/ |
59 |
|
|
|
60 |
gezelter |
1715 |
struct FrameData { |
61 |
gezelter |
1760 |
int id; /**< identification number of the snapshot */ |
62 |
|
|
RealType currentTime; /**< current time */ |
63 |
|
|
Mat3x3d hmat; /**< axes of the periodic box in matrix form */ |
64 |
|
|
Mat3x3d invHmat; /**< the inverse of the Hmat matrix */ |
65 |
gezelter |
1858 |
Mat3x3d bBox; /**< axes of a bounding box in matrix form */ |
66 |
|
|
Mat3x3d invBbox; /**< the inverse of the bounding box */ |
67 |
gezelter |
1760 |
bool orthoRhombic; /**< is this an orthorhombic periodic box? */ |
68 |
|
|
RealType totalEnergy; /**< total energy of this frame */ |
69 |
gezelter |
1764 |
RealType translationalKinetic; /**< translational kinetic energy of this frame */ |
70 |
|
|
RealType rotationalKinetic; /**< rotational kinetic energy of this frame */ |
71 |
gezelter |
1760 |
RealType kineticEnergy; /**< kinetic energy of this frame */ |
72 |
|
|
RealType potentialEnergy; /**< potential energy of this frame */ |
73 |
gezelter |
1757 |
RealType shortRangePotential; /**< short-range contributions to the potential*/ |
74 |
gezelter |
1760 |
RealType longRangePotential; /**< long-range contributions to the potential */ |
75 |
|
|
RealType bondPotential; /**< bonded contribution to the potential */ |
76 |
|
|
RealType bendPotential; /**< angle-bending contribution to the potential */ |
77 |
|
|
RealType torsionPotential; /**< dihedral (torsion angle) contribution to the potential */ |
78 |
|
|
RealType inversionPotential; /**< inversion (planarity) contribution to the potential */ |
79 |
|
|
potVec lrPotentials; /**< breakdown of long-range potentials by family */ |
80 |
|
|
potVec excludedPotentials; /**< breakdown of excluded potentials by family */ |
81 |
|
|
RealType restraintPotential; /**< potential energy of restraints */ |
82 |
|
|
RealType rawPotential; /**< unrestrained potential energy (when restraints are applied) */ |
83 |
gezelter |
1774 |
RealType xyArea; /**< XY area of this frame */ |
84 |
gezelter |
1764 |
RealType volume; /**< total volume of this frame */ |
85 |
|
|
RealType pressure; /**< pressure of this frame */ |
86 |
gezelter |
1760 |
RealType temperature; /**< temperature of this frame */ |
87 |
gezelter |
1764 |
pair<RealType, RealType> thermostat; /**< thermostat variables */ |
88 |
gezelter |
1715 |
RealType electronicTemperature; /**< temperature of the electronic degrees of freedom */ |
89 |
gezelter |
1764 |
pair<RealType, RealType> electronicThermostat; /**< thermostat variables for electronic degrees of freedom */ |
90 |
|
|
Mat3x3d barostat; /**< barostat matrix */ |
91 |
gezelter |
1760 |
Vector3d COM; /**< location of system center of mass */ |
92 |
|
|
Vector3d COMvel; /**< system center of mass velocity */ |
93 |
|
|
Vector3d COMw; /**< system center of mass angular velocity */ |
94 |
gezelter |
1764 |
Mat3x3d inertiaTensor; /**< inertia tensor for entire system */ |
95 |
|
|
RealType gyrationalVolume; /**< gyrational volume for entire system */ |
96 |
|
|
RealType hullVolume; /**< hull volume for entire system */ |
97 |
gezelter |
1760 |
Mat3x3d stressTensor; /**< stress tensor */ |
98 |
|
|
Mat3x3d pressureTensor; /**< pressure tensor */ |
99 |
|
|
Vector3d systemDipole; /**< total system dipole moment */ |
100 |
|
|
Vector3d conductiveHeatFlux; /**< heat flux vector (conductive only) */ |
101 |
gezelter |
1764 |
Vector3d convectiveHeatFlux; /**< heat flux vector (convective only) */ |
102 |
|
|
RealType conservedQuantity; /**< anything conserved by the integrator */ |
103 |
gezelter |
1715 |
}; |
104 |
|
|
|
105 |
|
|
|
106 |
gezelter |
507 |
/** |
107 |
gezelter |
1760 |
* @class Snapshot |
108 |
|
|
* @brief The Snapshot class is a repository storing dynamic data during a |
109 |
|
|
* Simulation. Every Snapshot contains FrameData (for global information) |
110 |
|
|
* as well as DataStorage (one for Atoms, one for RigidBodies, and one for |
111 |
|
|
* CutoffGroups). |
112 |
gezelter |
507 |
*/ |
113 |
|
|
class Snapshot { |
114 |
gezelter |
1760 |
|
115 |
|
|
public: |
116 |
gezelter |
1764 |
Snapshot(int nAtoms, int nRigidbodies, int nCutoffGroups); |
117 |
|
|
Snapshot(int nAtoms, int nRigidbodies, int nCutoffGroups, int storageLayout); |
118 |
gezelter |
507 |
/** Returns the id of this Snapshot */ |
119 |
gezelter |
1764 |
int getID(); |
120 |
gezelter |
507 |
/** Sets the id of this Snapshot */ |
121 |
gezelter |
1764 |
void setID(int id); |
122 |
tim |
137 |
|
123 |
gezelter |
1764 |
/** sets the state of the computed properties to false */ |
124 |
|
|
void clearDerivedProperties(); |
125 |
tim |
152 |
|
126 |
gezelter |
1764 |
int getSize(); |
127 |
gezelter |
507 |
/** Returns the number of atoms */ |
128 |
gezelter |
1764 |
int getNumberOfAtoms(); |
129 |
gezelter |
507 |
/** Returns the number of rigid bodies */ |
130 |
gezelter |
1764 |
int getNumberOfRigidBodies(); |
131 |
gezelter |
1544 |
/** Returns the number of rigid bodies */ |
132 |
gezelter |
1764 |
int getNumberOfCutoffGroups(); |
133 |
gezelter |
1544 |
|
134 |
gezelter |
507 |
/** Returns the H-Matrix */ |
135 |
gezelter |
1764 |
Mat3x3d getHmat(); |
136 |
gezelter |
507 |
/** Sets the H-Matrix */ |
137 |
gezelter |
1764 |
void setHmat(const Mat3x3d& m); |
138 |
|
|
/** Returns the inverse H-Matrix */ |
139 |
|
|
Mat3x3d getInvHmat(); |
140 |
gezelter |
1858 |
|
141 |
|
|
/** Returns the Bounding Box */ |
142 |
|
|
Mat3x3d getBoundingBox(); |
143 |
|
|
/** Sets the Bounding Box */ |
144 |
|
|
void setBoundingBox(const Mat3x3d& m); |
145 |
|
|
/** Returns the inverse Bounding Box*/ |
146 |
|
|
Mat3x3d getInvBoundingBox(); |
147 |
gezelter |
246 |
|
148 |
gezelter |
1764 |
RealType getVolume(); |
149 |
gezelter |
1774 |
RealType getXYarea(); |
150 |
gezelter |
1764 |
void setVolume(const RealType vol); |
151 |
tim |
152 |
|
152 |
gezelter |
1764 |
/** Wrapping the vector according to periodic boundary condition*/ |
153 |
|
|
void wrapVector(Vector3d& v); |
154 |
chuckv |
1302 |
|
155 |
gezelter |
1562 |
/** Scaling a vector to multiples of the periodic box */ |
156 |
|
|
Vector3d scaleVector(Vector3d &v); |
157 |
|
|
|
158 |
gezelter |
1764 |
void setCOM(const Vector3d &com); |
159 |
|
|
void setCOMvel(const Vector3d &comVel); |
160 |
|
|
void setCOMw(const Vector3d &comw); |
161 |
gezelter |
1562 |
|
162 |
gezelter |
1104 |
Vector3d getCOM(); |
163 |
|
|
Vector3d getCOMvel(); |
164 |
|
|
Vector3d getCOMw(); |
165 |
gezelter |
246 |
|
166 |
gezelter |
1764 |
RealType getTime(); |
167 |
|
|
void increaseTime(const RealType dt); |
168 |
|
|
void setTime(const RealType time); |
169 |
tim |
152 |
|
170 |
gezelter |
1764 |
void setBondPotential(const RealType bp); |
171 |
|
|
void setBendPotential(const RealType bp); |
172 |
|
|
void setTorsionPotential(const RealType tp); |
173 |
|
|
void setInversionPotential(const RealType ip); |
174 |
|
|
RealType getBondPotential(); |
175 |
|
|
RealType getBendPotential(); |
176 |
|
|
RealType getTorsionPotential(); |
177 |
|
|
RealType getInversionPotential(); |
178 |
tim |
152 |
|
179 |
gezelter |
1764 |
RealType getShortRangePotential(); |
180 |
tim |
152 |
|
181 |
gezelter |
1764 |
void setLongRangePotential(const potVec lrPot); |
182 |
|
|
RealType getLongRangePotential(); |
183 |
|
|
potVec getLongRangePotentials(); |
184 |
gezelter |
1760 |
|
185 |
gezelter |
1764 |
void setExcludedPotentials(const potVec exPot); |
186 |
|
|
potVec getExcludedPotentials(); |
187 |
|
|
|
188 |
|
|
void setRestraintPotential(const RealType rp); |
189 |
|
|
RealType getRestraintPotential(); |
190 |
gezelter |
1760 |
|
191 |
gezelter |
1764 |
void setRawPotential(const RealType rp); |
192 |
|
|
RealType getRawPotential(); |
193 |
gezelter |
1760 |
|
194 |
gezelter |
1764 |
RealType getPotentialEnergy(); |
195 |
|
|
RealType getKineticEnergy(); |
196 |
|
|
RealType getTranslationalKineticEnergy(); |
197 |
|
|
RealType getRotationalKineticEnergy(); |
198 |
|
|
void setKineticEnergy(const RealType ke); |
199 |
|
|
void setTranslationalKineticEnergy(const RealType tke); |
200 |
|
|
void setRotationalKineticEnergy(const RealType rke); |
201 |
|
|
RealType getTotalEnergy(); |
202 |
|
|
void setTotalEnergy(const RealType te); |
203 |
|
|
RealType getConservedQuantity(); |
204 |
|
|
void setConservedQuantity(const RealType cq); |
205 |
|
|
RealType getTemperature(); |
206 |
|
|
void setTemperature(const RealType temp); |
207 |
|
|
RealType getElectronicTemperature(); |
208 |
|
|
void setElectronicTemperature(const RealType eTemp); |
209 |
|
|
RealType getPressure(); |
210 |
|
|
void setPressure(const RealType pressure); |
211 |
gezelter |
1760 |
|
212 |
gezelter |
1764 |
Mat3x3d getPressureTensor(); |
213 |
|
|
void setPressureTensor(const Mat3x3d& pressureTensor); |
214 |
gezelter |
1760 |
|
215 |
gezelter |
1764 |
Mat3x3d getStressTensor(); |
216 |
|
|
void setStressTensor(const Mat3x3d& stressTensor); |
217 |
gezelter |
1760 |
|
218 |
gezelter |
1764 |
Vector3d getConductiveHeatFlux(); |
219 |
|
|
void setConductiveHeatFlux(const Vector3d& chf); |
220 |
gezelter |
1760 |
|
221 |
gezelter |
1764 |
Vector3d getConvectiveHeatFlux(); |
222 |
|
|
void setConvectiveHeatFlux(const Vector3d& chf); |
223 |
gezelter |
1760 |
|
224 |
gezelter |
1764 |
Vector3d getHeatFlux(); |
225 |
gezelter |
1760 |
|
226 |
gezelter |
1764 |
Vector3d getSystemDipole(); |
227 |
|
|
void setSystemDipole(const Vector3d& bd); |
228 |
gezelter |
1760 |
|
229 |
gezelter |
1764 |
pair<RealType, RealType> getThermostat(); |
230 |
|
|
void setThermostat(const pair<RealType, RealType>& thermostat); |
231 |
gezelter |
1760 |
|
232 |
gezelter |
1764 |
pair<RealType, RealType> getElectronicThermostat(); |
233 |
|
|
void setElectronicThermostat(const pair<RealType, RealType>& eThermostat); |
234 |
gezelter |
246 |
|
235 |
gezelter |
1764 |
Mat3x3d getBarostat(); |
236 |
|
|
void setBarostat(const Mat3x3d& barostat); |
237 |
gezelter |
1021 |
|
238 |
gezelter |
1764 |
Mat3x3d getInertiaTensor(); |
239 |
|
|
void setInertiaTensor(const Mat3x3d& inertiaTensor); |
240 |
gezelter |
1715 |
|
241 |
gezelter |
1764 |
RealType getGyrationalVolume(); |
242 |
|
|
void setGyrationalVolume(const RealType gv); |
243 |
gezelter |
1715 |
|
244 |
gezelter |
1764 |
RealType getHullVolume(); |
245 |
|
|
void setHullVolume(const RealType hv); |
246 |
|
|
|
247 |
|
|
void setOrthoTolerance(RealType orthoTolerance); |
248 |
gezelter |
1715 |
|
249 |
gezelter |
507 |
DataStorage atomData; |
250 |
|
|
DataStorage rigidbodyData; |
251 |
gezelter |
1540 |
DataStorage cgData; |
252 |
gezelter |
1764 |
FrameData frameData; |
253 |
gezelter |
1540 |
|
254 |
gezelter |
1764 |
bool hasTotalEnergy; |
255 |
|
|
bool hasTranslationalKineticEnergy; |
256 |
|
|
bool hasRotationalKineticEnergy; |
257 |
|
|
bool hasKineticEnergy; |
258 |
|
|
bool hasShortRangePotential; |
259 |
|
|
bool hasLongRangePotential; |
260 |
gezelter |
1774 |
bool hasPotentialEnergy; |
261 |
|
|
bool hasXYarea; |
262 |
gezelter |
1764 |
bool hasVolume; |
263 |
|
|
bool hasPressure; |
264 |
|
|
bool hasTemperature; |
265 |
|
|
bool hasElectronicTemperature; |
266 |
|
|
bool hasCOM; |
267 |
|
|
bool hasCOMvel; |
268 |
|
|
bool hasCOMw; |
269 |
|
|
bool hasPressureTensor; |
270 |
|
|
bool hasSystemDipole; |
271 |
|
|
bool hasConvectiveHeatFlux; |
272 |
|
|
bool hasInertiaTensor; |
273 |
|
|
bool hasGyrationalVolume; |
274 |
|
|
bool hasHullVolume; |
275 |
|
|
bool hasConservedQuantity; |
276 |
gezelter |
1858 |
bool hasBoundingBox; |
277 |
gezelter |
1764 |
|
278 |
gezelter |
507 |
private: |
279 |
gezelter |
1021 |
RealType orthoTolerance_; |
280 |
gezelter |
1764 |
|
281 |
gezelter |
507 |
}; |
282 |
tim |
122 |
|
283 |
gezelter |
507 |
typedef DataStorage (Snapshot::*DataStoragePointer); |
284 |
tim |
122 |
} |
285 |
|
|
#endif //BRAINS_SNAPSHOT_HPP |