src/brains/Snapshot.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
  
#ifndef BRAINS_SNAPSHOT_HPP
#define BRAINS_SNAPSHOT_HPP

#include <vector>

#include "brains/DataStorage.hpp"
#include "nonbonded/NonBondedInteraction.hpp"
#include "brains/Stats.hpp"

using namespace std;
namespace OpenMD{

  /**
   * FrameData is a structure for holding system-wide dynamic data
   * about the simulation.
   */
  
  struct FrameData {
    int id;                       /**< identification number of the snapshot */
    RealType currentTime;         /**< current time */
    Mat3x3d  hmat;                /**< axes of the periodic box in matrix form */
    Mat3x3d  invHmat;             /**< the inverse of the Hmat matrix */
    bool     orthoRhombic;        /**< is this an orthorhombic periodic box? */
    RealType totalEnergy;         /**< total energy of this frame */
    RealType translationalKinetic; /**< translational kinetic energy of this frame */
    RealType rotationalKinetic;   /**< rotational kinetic energy of this frame */
    RealType kineticEnergy;       /**< kinetic energy of this frame */
    RealType potentialEnergy;     /**< potential energy of this frame */
    RealType shortRangePotential; /**< short-range contributions to the potential*/
    RealType longRangePotential;  /**< long-range contributions to the potential */
    RealType bondPotential;       /**< bonded contribution to the potential */
    RealType bendPotential;       /**< angle-bending contribution to the potential */
    RealType torsionPotential;    /**< dihedral (torsion angle) contribution to the potential */
    RealType inversionPotential;  /**< inversion (planarity) contribution to the potential */
    potVec   lrPotentials;        /**< breakdown of long-range potentials by family */
    potVec   excludedPotentials;  /**< breakdown of excluded potentials by family */
    RealType restraintPotential;  /**< potential energy of restraints */
    RealType rawPotential;        /**< unrestrained potential energy (when restraints are applied) */
    RealType xyArea;              /**< XY area of this frame */
    RealType volume;              /**< total volume of this frame */
    RealType pressure;            /**< pressure of this frame */
    RealType temperature;         /**< temperature of this frame */
    pair<RealType, RealType> thermostat;    /**< thermostat variables */
    RealType electronicTemperature; /**< temperature of the electronic degrees of freedom */
    pair<RealType, RealType> electronicThermostat; /**< thermostat variables for electronic degrees of freedom */
    Mat3x3d  barostat;            /**< barostat matrix */
    Vector3d COM;                 /**< location of system center of mass */
    Vector3d COMvel;              /**< system center of mass velocity */
    Vector3d COMw;                /**< system center of mass angular velocity */
    Mat3x3d  inertiaTensor;       /**< inertia tensor for entire system */
    RealType gyrationalVolume;    /**< gyrational volume for entire system */
    RealType hullVolume;          /**< hull volume for entire system */
    Mat3x3d  stressTensor;        /**< stress tensor */
    Mat3x3d  pressureTensor;      /**< pressure tensor */
    Vector3d systemDipole;        /**< total system dipole moment */
    Vector3d conductiveHeatFlux;  /**< heat flux vector (conductive only) */
    Vector3d convectiveHeatFlux;  /**< heat flux vector (convective only) */
    RealType conservedQuantity;   /**< anything conserved by the integrator */
  };


  /**
   * @class Snapshot 
   * @brief The Snapshot class is a repository storing dynamic data during a
   * Simulation.  Every Snapshot contains FrameData (for global information)
   * as well as DataStorage (one for Atoms, one for RigidBodies, and one for 
   * CutoffGroups).
   */
  class Snapshot {

  public:            
    Snapshot(int nAtoms, int nRigidbodies, int nCutoffGroups);
    Snapshot(int nAtoms, int nRigidbodies, int nCutoffGroups, int storageLayout);    
    /** Returns the id of this Snapshot */
    int      getID();
    /** Sets the id of this Snapshot */
    void     setID(int id);

    /** sets the state of the computed properties to false */
    void     clearDerivedProperties();

    int      getSize();
    /** Returns the number of atoms */
    int      getNumberOfAtoms();
    /** Returns the number of rigid bodies */
    int      getNumberOfRigidBodies();
    /** Returns the number of rigid bodies */
    int      getNumberOfCutoffGroups();

    /** Returns the H-Matrix */
    Mat3x3d  getHmat();
    /** Sets the H-Matrix */
    void     setHmat(const Mat3x3d& m);
    /** Returns the inverse H-Matrix */
    Mat3x3d  getInvHmat();
            
    RealType getVolume();
    RealType getXYarea();
    void     setVolume(const RealType vol);

    /** Wrapping the vector according to periodic boundary condition*/
    void     wrapVector(Vector3d& v);

    /** Scaling a vector to multiples of the periodic box */
    Vector3d scaleVector(Vector3d &v);

    void     setCOM(const Vector3d &com);
    void     setCOMvel(const Vector3d &comVel);
    void     setCOMw(const Vector3d &comw);

    Vector3d getCOM();
    Vector3d getCOMvel();
    Vector3d getCOMw();
            
    RealType getTime();
    void     increaseTime(const RealType dt);
    void     setTime(const RealType time);

    void     setBondPotential(const RealType bp);
    void     setBendPotential(const RealType bp);
    void     setTorsionPotential(const RealType tp);
    void     setInversionPotential(const RealType ip);
    RealType getBondPotential();
    RealType getBendPotential();
    RealType getTorsionPotential();
    RealType getInversionPotential();

    RealType getShortRangePotential();

    void     setLongRangePotential(const potVec lrPot);
    RealType getLongRangePotential();
    potVec   getLongRangePotentials();

    void     setExcludedPotentials(const potVec exPot);
    potVec   getExcludedPotentials();
   
    void     setRestraintPotential(const RealType rp);
    RealType getRestraintPotential();

    void     setRawPotential(const RealType rp);
    RealType getRawPotential();

    RealType getPotentialEnergy();
    RealType getKineticEnergy();
    RealType getTranslationalKineticEnergy();
    RealType getRotationalKineticEnergy();
    void     setKineticEnergy(const RealType ke);
    void     setTranslationalKineticEnergy(const RealType tke);
    void     setRotationalKineticEnergy(const RealType rke);
    RealType getTotalEnergy();
    void     setTotalEnergy(const RealType te);
    RealType getConservedQuantity();
    void     setConservedQuantity(const RealType cq);
    RealType getTemperature();
    void     setTemperature(const RealType temp);
    RealType getElectronicTemperature();
    void     setElectronicTemperature(const RealType eTemp);
    RealType getPressure();
    void     setPressure(const RealType pressure);

    Mat3x3d  getPressureTensor();
    void     setPressureTensor(const Mat3x3d& pressureTensor);

    Mat3x3d  getStressTensor();
    void     setStressTensor(const Mat3x3d& stressTensor);

    Vector3d getConductiveHeatFlux();
    void     setConductiveHeatFlux(const Vector3d& chf);

    Vector3d getConvectiveHeatFlux();
    void     setConvectiveHeatFlux(const Vector3d& chf);

    Vector3d getHeatFlux();
    
    Vector3d getSystemDipole();
    void     setSystemDipole(const Vector3d& bd);

    pair<RealType, RealType> getThermostat();
    void setThermostat(const pair<RealType, RealType>& thermostat);

    pair<RealType, RealType> getElectronicThermostat();
    void setElectronicThermostat(const pair<RealType, RealType>& eThermostat);
            
    Mat3x3d  getBarostat();
    void     setBarostat(const Mat3x3d& barostat);

    Mat3x3d  getInertiaTensor();
    void     setInertiaTensor(const Mat3x3d& inertiaTensor);

    RealType getGyrationalVolume();
    void     setGyrationalVolume(const RealType gv);

    RealType getHullVolume();
    void     setHullVolume(const RealType hv);
    
    void     setOrthoTolerance(RealType orthoTolerance);

    DataStorage atomData;
    DataStorage rigidbodyData;
    DataStorage cgData;
    FrameData   frameData;

    bool hasTotalEnergy;         
    bool hasTranslationalKineticEnergy;    
    bool hasRotationalKineticEnergy;    
    bool hasKineticEnergy;    
    bool hasShortRangePotential;
    bool hasLongRangePotential;
    bool hasPotentialEnergy;    
    bool hasXYarea;
    bool hasVolume;         
    bool hasPressure;       
    bool hasTemperature;    
    bool hasElectronicTemperature;
    bool hasCOM;             
    bool hasCOMvel;
    bool hasCOMw;
    bool hasPressureTensor;    
    bool hasSystemDipole;    
    bool hasConvectiveHeatFlux;
    bool hasInertiaTensor;
    bool hasGyrationalVolume;
    bool hasHullVolume;
    bool hasConservedQuantity;

  private:
    RealType orthoTolerance_;
    
  };

  typedef DataStorage (Snapshot::*DataStoragePointer); 
}
#endif //BRAINS_SNAPSHOT_HPP
Revision:	1774
Committed:	Wed Aug 8 16:03:02 2012 UTC (12 years, 8 months ago) by gezelter
File size:	11113 byte(s)
Log Message:	Cleaning up RNEMD log, adding XY area to Snapshot
#	User	Rev	Content
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			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (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			bool orthoRhombic; /*< is this an orthorhombic periodic box? /
66			RealType totalEnergy; /*< total energy of this frame /
67	gezelter	1764	RealType translationalKinetic; /*< translational kinetic energy of this frame /
68			RealType rotationalKinetic; /*< rotational kinetic energy of this frame /
69	gezelter	1760	RealType kineticEnergy; /*< kinetic energy of this frame /
70			RealType potentialEnergy; /*< potential energy of this frame /
71	gezelter	1757	RealType shortRangePotential; /*< short-range contributions to the potential/
72	gezelter	1760	RealType longRangePotential; /*< long-range contributions to the potential /
73			RealType bondPotential; /*< bonded contribution to the potential /
74			RealType bendPotential; /*< angle-bending contribution to the potential /
75			RealType torsionPotential; /*< dihedral (torsion angle) contribution to the potential /
76			RealType inversionPotential; /*< inversion (planarity) contribution to the potential /
77			potVec lrPotentials; /*< breakdown of long-range potentials by family /
78			potVec excludedPotentials; /*< breakdown of excluded potentials by family /
79			RealType restraintPotential; /*< potential energy of restraints /
80			RealType rawPotential; /*< unrestrained potential energy (when restraints are applied) /
81	gezelter	1774	RealType xyArea; /*< XY area of this frame /
82	gezelter	1764	RealType volume; /*< total volume of this frame /
83			RealType pressure; /*< pressure of this frame /
84	gezelter	1760	RealType temperature; /*< temperature of this frame /
85	gezelter	1764	pair<RealType, RealType> thermostat; /*< thermostat variables /
86	gezelter	1715	RealType electronicTemperature; /*< temperature of the electronic degrees of freedom /
87	gezelter	1764	pair<RealType, RealType> electronicThermostat; /*< thermostat variables for electronic degrees of freedom /
88			Mat3x3d barostat; /*< barostat matrix /
89	gezelter	1760	Vector3d COM; /*< location of system center of mass /
90			Vector3d COMvel; /*< system center of mass velocity /
91			Vector3d COMw; /*< system center of mass angular velocity /
92	gezelter	1764	Mat3x3d inertiaTensor; /*< inertia tensor for entire system /
93			RealType gyrationalVolume; /*< gyrational volume for entire system /
94			RealType hullVolume; /*< hull volume for entire system /
95	gezelter	1760	Mat3x3d stressTensor; /*< stress tensor /
96			Mat3x3d pressureTensor; /*< pressure tensor /
97			Vector3d systemDipole; /*< total system dipole moment /
98			Vector3d conductiveHeatFlux; /*< heat flux vector (conductive only) /
99	gezelter	1764	Vector3d convectiveHeatFlux; /*< heat flux vector (convective only) /
100			RealType conservedQuantity; /*< anything conserved by the integrator /
101	gezelter	1715	};
102
103
104	gezelter	507	/**
105	gezelter	1760	* @class Snapshot
106			* @brief The Snapshot class is a repository storing dynamic data during a
107			* Simulation. Every Snapshot contains FrameData (for global information)
108			* as well as DataStorage (one for Atoms, one for RigidBodies, and one for
109			* CutoffGroups).
110	gezelter	507	*/
111			class Snapshot {
112	gezelter	1760
113			public:
114	gezelter	1764	Snapshot(int nAtoms, int nRigidbodies, int nCutoffGroups);
115			Snapshot(int nAtoms, int nRigidbodies, int nCutoffGroups, int storageLayout);
116	gezelter	507	/** Returns the id of this Snapshot */
117	gezelter	1764	int getID();
118	gezelter	507	/** Sets the id of this Snapshot */
119	gezelter	1764	void setID(int id);
120	tim	137
121	gezelter	1764	/** sets the state of the computed properties to false */
122			void clearDerivedProperties();
123	tim	152
124	gezelter	1764	int getSize();
125	gezelter	507	/** Returns the number of atoms */
126	gezelter	1764	int getNumberOfAtoms();
127	gezelter	507	/** Returns the number of rigid bodies */
128	gezelter	1764	int getNumberOfRigidBodies();
129	gezelter	1544	/** Returns the number of rigid bodies */
130	gezelter	1764	int getNumberOfCutoffGroups();
131	gezelter	1544
132	gezelter	507	/** Returns the H-Matrix */
133	gezelter	1764	Mat3x3d getHmat();
134	gezelter	507	/** Sets the H-Matrix */
135	gezelter	1764	void setHmat(const Mat3x3d& m);
136			/** Returns the inverse H-Matrix */
137			Mat3x3d getInvHmat();
138	gezelter	246
139	gezelter	1764	RealType getVolume();
140	gezelter	1774	RealType getXYarea();
141	gezelter	1764	void setVolume(const RealType vol);
142	tim	152
143	gezelter	1764	/** Wrapping the vector according to periodic boundary condition*/
144			void wrapVector(Vector3d& v);
145	chuckv	1302
146	gezelter	1562	/** Scaling a vector to multiples of the periodic box */
147			Vector3d scaleVector(Vector3d &v);
148
149	gezelter	1764	void setCOM(const Vector3d &com);
150			void setCOMvel(const Vector3d &comVel);
151			void setCOMw(const Vector3d &comw);
152	gezelter	1562
153	gezelter	1104	Vector3d getCOM();
154			Vector3d getCOMvel();
155			Vector3d getCOMw();
156	gezelter	246
157	gezelter	1764	RealType getTime();
158			void increaseTime(const RealType dt);
159			void setTime(const RealType time);
160	tim	152
161	gezelter	1764	void setBondPotential(const RealType bp);
162			void setBendPotential(const RealType bp);
163			void setTorsionPotential(const RealType tp);
164			void setInversionPotential(const RealType ip);
165			RealType getBondPotential();
166			RealType getBendPotential();
167			RealType getTorsionPotential();
168			RealType getInversionPotential();
169	tim	152
170	gezelter	1764	RealType getShortRangePotential();
171	tim	152
172	gezelter	1764	void setLongRangePotential(const potVec lrPot);
173			RealType getLongRangePotential();
174			potVec getLongRangePotentials();
175	gezelter	1760
176	gezelter	1764	void setExcludedPotentials(const potVec exPot);
177			potVec getExcludedPotentials();
178
179			void setRestraintPotential(const RealType rp);
180			RealType getRestraintPotential();
181	gezelter	1760
182	gezelter	1764	void setRawPotential(const RealType rp);
183			RealType getRawPotential();
184	gezelter	1760
185	gezelter	1764	RealType getPotentialEnergy();
186			RealType getKineticEnergy();
187			RealType getTranslationalKineticEnergy();
188			RealType getRotationalKineticEnergy();
189			void setKineticEnergy(const RealType ke);
190			void setTranslationalKineticEnergy(const RealType tke);
191			void setRotationalKineticEnergy(const RealType rke);
192			RealType getTotalEnergy();
193			void setTotalEnergy(const RealType te);
194			RealType getConservedQuantity();
195			void setConservedQuantity(const RealType cq);
196			RealType getTemperature();
197			void setTemperature(const RealType temp);
198			RealType getElectronicTemperature();
199			void setElectronicTemperature(const RealType eTemp);
200			RealType getPressure();
201			void setPressure(const RealType pressure);
202	gezelter	1760
203	gezelter	1764	Mat3x3d getPressureTensor();
204			void setPressureTensor(const Mat3x3d& pressureTensor);
205	gezelter	1760
206	gezelter	1764	Mat3x3d getStressTensor();
207			void setStressTensor(const Mat3x3d& stressTensor);
208	gezelter	1760
209	gezelter	1764	Vector3d getConductiveHeatFlux();
210			void setConductiveHeatFlux(const Vector3d& chf);
211	gezelter	1760
212	gezelter	1764	Vector3d getConvectiveHeatFlux();
213			void setConvectiveHeatFlux(const Vector3d& chf);
214	gezelter	1760
215	gezelter	1764	Vector3d getHeatFlux();
216	gezelter	1760
217	gezelter	1764	Vector3d getSystemDipole();
218			void setSystemDipole(const Vector3d& bd);
219	gezelter	1760
220	gezelter	1764	pair<RealType, RealType> getThermostat();
221			void setThermostat(const pair<RealType, RealType>& thermostat);
222	gezelter	1760
223	gezelter	1764	pair<RealType, RealType> getElectronicThermostat();
224			void setElectronicThermostat(const pair<RealType, RealType>& eThermostat);
225	gezelter	246
226	gezelter	1764	Mat3x3d getBarostat();
227			void setBarostat(const Mat3x3d& barostat);
228	gezelter	1021
229	gezelter	1764	Mat3x3d getInertiaTensor();
230			void setInertiaTensor(const Mat3x3d& inertiaTensor);
231	gezelter	1715
232	gezelter	1764	RealType getGyrationalVolume();
233			void setGyrationalVolume(const RealType gv);
234	gezelter	1715
235	gezelter	1764	RealType getHullVolume();
236			void setHullVolume(const RealType hv);
237
238			void setOrthoTolerance(RealType orthoTolerance);
239	gezelter	1715
240	gezelter	507	DataStorage atomData;
241			DataStorage rigidbodyData;
242	gezelter	1540	DataStorage cgData;
243	gezelter	1764	FrameData frameData;
244	gezelter	1540
245	gezelter	1764	bool hasTotalEnergy;
246			bool hasTranslationalKineticEnergy;
247			bool hasRotationalKineticEnergy;
248			bool hasKineticEnergy;
249			bool hasShortRangePotential;
250			bool hasLongRangePotential;
251	gezelter	1774	bool hasPotentialEnergy;
252			bool hasXYarea;
253	gezelter	1764	bool hasVolume;
254			bool hasPressure;
255			bool hasTemperature;
256			bool hasElectronicTemperature;
257			bool hasCOM;
258			bool hasCOMvel;
259			bool hasCOMw;
260			bool hasPressureTensor;
261			bool hasSystemDipole;
262			bool hasConvectiveHeatFlux;
263			bool hasInertiaTensor;
264			bool hasGyrationalVolume;
265			bool hasHullVolume;
266			bool hasConservedQuantity;
267
268	gezelter	507	private:
269	gezelter	1021	RealType orthoTolerance_;
270	gezelter	1764
271	gezelter	507	};
272	tim	122
273	gezelter	507	typedef DataStorage (Snapshot::*DataStoragePointer);
274	tim	122	}
275			#endif //BRAINS_SNAPSHOT_HPP