src/brains/BlockSnapshotManager.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]  Vardeman & Gezelter, in progress (2009).                        
 */
#ifndef BRAINS_BLOCKSNAPSHOTMANAGER_HPP
#define BRAINS_BLOCKSNAPSHOTMANAGER_HPP
#include <vector>

#include "brains/SnapshotManager.hpp"
namespace OpenMD {

  class SimInfo;
  class DumpReader;

  typedef std::pair<int, int> SnapshotBlock;

  /**
   * @class BlockSnapshotManager
   * @todo document
   */
  class BlockSnapshotManager : public SnapshotManager{

  public:
    BlockSnapshotManager(SimInfo* info, const std::string& filename, int storageLayout, long long int memSize, int blockCapacity = 2);
    ~BlockSnapshotManager();
        
    virtual Snapshot* getSnapshot(int id);


    /** Returns number of snapshot blocks in this BlockSnapshotManager*/
    int getNBlocks() {
      return blocks_.size();
    }

    SnapshotBlock getSnapshotBlock(int block) {
      return blocks_.at(block);
    }
        
    int getNActiveBlocks();

    void needCOMprops(bool ncp);


    bool isBlockActive(int block) {
      return  findActiveBlock(block) != activeBlocks_.end() ? true : false;
    }        

    bool loadBlock(int block);
        
    bool unloadBlock(int block);

    std::vector<int> getActiveBlocks();

    int getBlockCapacity() {
      return blockCapacity_;                
    }

    int getNFrames();
        
  private:

    std::vector<int>::iterator findActiveBlock(int block) {
      return std::find(activeBlocks_.begin(), activeBlocks_.end(), block);
    }

    bool hasZeroRefBlock();

    int getFirstZeroRefBlock();

    void internalLoad(int block);
    void internalUnload(int block);
    Snapshot* loadFrame(int frame);
        
    SimInfo* info_;
    int blockCapacity_;
    long long int memSize_;

    std::vector<Snapshot*> snapshots_;
    std::vector<SnapshotBlock> blocks_;        
    std::vector<int> activeBlocks_;
    std::vector<int> activeRefCount_;
        
    int nAtoms_;
    int nRigidBodies_;
    
    DumpReader* reader_;
    int nframes_;
    int nSnapshotPerBlock_;

  };

}

#endif
Revision:	1596
Committed:	Mon Jul 25 17:30:53 2011 UTC (13 years, 9 months ago) by gezelter
File size:	4057 byte(s)
Log Message:	Updated the BlockSnapshotManager to use a specified memory footprint in constructor and not to rely on physmem and residentMem to figure out free memory. DynamicProps is the only program that uses the BlockSnapshotManager, so substantial changes were needed there as well.
#	User	Rev	Content
1	tim	318	/*
2			* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3			*
4			* 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	tim	318	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	tim	318	* 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			* [4] Vardeman & Gezelter, in progress (2009).
40	tim	318	*/
41			#ifndef BRAINS_BLOCKSNAPSHOTMANAGER_HPP
42			#define BRAINS_BLOCKSNAPSHOTMANAGER_HPP
43	tim	323	#include <vector>
44	tim	318
45			#include "brains/SnapshotManager.hpp"
46	gezelter	1390	namespace OpenMD {
47	tim	318
48	gezelter	507	class SimInfo;
49			class DumpReader;
50	tim	318
51	gezelter	507	typedef std::pair<int, int> SnapshotBlock;
52	tim	318
53	gezelter	507	/**
54			* @class BlockSnapshotManager
55			* @todo document
56			*/
57			class BlockSnapshotManager : public SnapshotManager{
58	tim	318
59	gezelter	507	public:
60	gezelter	1596	BlockSnapshotManager(SimInfo* info, const std::string& filename, int storageLayout, long long int memSize, int blockCapacity = 2);
61	gezelter	507	~BlockSnapshotManager();
62	tim	318
63	gezelter	1249	virtual Snapshot* getSnapshot(int id);
64	tim	318
65	xsun	1215
66	gezelter	507	/** Returns number of snapshot blocks in this BlockSnapshotManager*/
67			int getNBlocks() {
68			return blocks_.size();
69			}
70	tim	318
71	gezelter	507	SnapshotBlock getSnapshotBlock(int block) {
72			return blocks_.at(block);
73			}
74	tim	318
75	gezelter	507	int getNActiveBlocks();
76	tim	351
77	gezelter	1106	void needCOMprops(bool ncp);
78
79
80	gezelter	507	bool isBlockActive(int block) {
81			return findActiveBlock(block) != activeBlocks_.end() ? true : false;
82			}
83	tim	351
84	gezelter	507	bool loadBlock(int block);
85	tim	318
86	gezelter	507	bool unloadBlock(int block);
87	tim	318
88	gezelter	507	std::vector<int> getActiveBlocks();
89	tim	318
90	gezelter	507	int getBlockCapacity() {
91			return blockCapacity_;
92			}
93	tim	318
94	gezelter	507	int getNFrames();
95	tim	318
96	gezelter	507	private:
97	tim	318
98	gezelter	507	std::vector<int>::iterator findActiveBlock(int block) {
99			return std::find(activeBlocks_.begin(), activeBlocks_.end(), block);
100			}
101	tim	351
102	gezelter	507	bool hasZeroRefBlock();
103	tim	351
104	gezelter	507	int getFirstZeroRefBlock();
105	tim	351
106	gezelter	507	void internalLoad(int block);
107			void internalUnload(int block);
108			Snapshot* loadFrame(int frame);
109	tim	318
110	gezelter	507	SimInfo* info_;
111			int blockCapacity_;
112	gezelter	1596	long long int memSize_;
113	tim	318
114	gezelter	507	std::vector<Snapshot*> snapshots_;
115			std::vector<SnapshotBlock> blocks_;
116			std::vector<int> activeBlocks_;
117			std::vector<int> activeRefCount_;
118	tim	318
119	gezelter	507	int nAtoms_;
120			int nRigidBodies_;
121	tim	318
122	gezelter	507	DumpReader* reader_;
123			int nframes_;
124			int nSnapshotPerBlock_;
125	tim	318
126	gezelter	507	};
127	tim	318
128			}
129
130			#endif