applications/staticProps/SpatialStatistics.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, 234107 (2008).          
 * [4] Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [4] , Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011). *
 *  Created by Charles F. Vardeman II on 11/26/05.
 *  @author  Charles F. Vardeman II 
 *  @version $Id: SlabStatistics.hpp 1850 2013-02-20 15:39:39Z gezelter $
 *
 */
#ifndef APPLICATIONS_STATICPROPS_SPATIALSTATISTICS_HPP
#define APPLICATIONS_STATICPROPS_SPATIALSTATISTICS_HPP

#include <string>
#include <vector>
#include <fstream>

#include "applications/staticProps/StaticAnalyser.hpp"
#include "selection/SelectionEvaluator.hpp"
#include "selection/SelectionManager.hpp"
#include "utils/Accumulator.hpp"

using namespace std;
namespace OpenMD {
  
  enum OutputDataType {
    odtReal,
    odtVector3,
    odtUnknownDataType
  };

  enum OutputDataHandling {
    odhAverage,
    odhTotal,
    odhLastValue,
    odhUnknownDataHandling
  };

  struct OutputData {
    string title;
    string units;
    OutputDataType dataType;
    OutputDataHandling dataHandling;
    vector<BaseAccumulator*> accumulator;
  };
    
  class SpatialStatistics : public StaticAnalyser {
    
  public:
    SpatialStatistics(SimInfo* info, const string& filename, const string& sele, int nbins);    
    ~SpatialStatistics();

    void addOutputData(OutputData* dat) {data_.push_back(dat);}
    virtual void process();
    virtual void processFrame(int frame);
    virtual int getBin(Vector3d pos)=0;
    virtual void processStuntDouble(StuntDouble* sd, int bin)=0;
    virtual void writeOutput();
    
  protected:
    OutputData* beginOutputData(vector<OutputData*>::iterator& i);
    OutputData* nextOutputData(vector<OutputData*>::iterator& i);
    void writeData(ostream& os, OutputData* dat, unsigned int bin);
    void writeStdDev(ostream& os, OutputData* dat, unsigned int bin);

    Snapshot* currentSnapshot_;    
    int nProcessed_;
    string selectionScript_;
    SelectionEvaluator evaluator_;
    SelectionManager seleMan_;    
    int nBins_; 
    OutputData* counts_;
    vector<OutputData*> data_;
  };

  class SlabStatistics : public SpatialStatistics {
  public: 
    SlabStatistics(SimInfo* info, const string& filename, const string& sele, int nbins);
    virtual int getBin(Vector3d pos);
    virtual void processFrame(int frame);
  protected:
    OutputData* z_;
    Mat3x3d hmat_;
    RealType volume_;

  };

  class ShellStatistics : public SpatialStatistics {
  public: 
    ShellStatistics(SimInfo* info, const string& filename, const string& sele, int nbins);
    virtual int getBin(Vector3d pos);

    void setCoordinateOrigin(Vector3d co) { coordinateOrigin_ = co; }
    void setBinWidth(RealType bw) { binWidth_ = bw; }

  protected:
    OutputData* r_;
    Vector3d coordinateOrigin_;
    RealType binWidth_;
  };
  
}
#endif


Revision:	1865
Committed:	Wed Apr 17 18:24:08 2013 UTC (12 years ago) by gezelter
File size:	4820 byte(s)
Log Message:	Adding spatial statistics analysers.
#	Content
1	/*
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	* 1. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
12	* 2. Redistributions in binary form must reproduce the above copyright
13	* 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	*
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, 234107 (2008).
39	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40	* [4] , Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011). *
41	* Created by Charles F. Vardeman II on 11/26/05.
42	* @author Charles F. Vardeman II
43	* @version $Id: SlabStatistics.hpp 1850 2013-02-20 15:39:39Z gezelter $
44	*
45	*/
46	#ifndef APPLICATIONS_STATICPROPS_SPATIALSTATISTICS_HPP
47	#define APPLICATIONS_STATICPROPS_SPATIALSTATISTICS_HPP
48
49	#include <string>
50	#include <vector>
51	#include <fstream>
52
53	#include "applications/staticProps/StaticAnalyser.hpp"
54	#include "selection/SelectionEvaluator.hpp"
55	#include "selection/SelectionManager.hpp"
56	#include "utils/Accumulator.hpp"
57
58	using namespace std;
59	namespace OpenMD {
60
61	enum OutputDataType {
62	odtReal,
63	odtVector3,
64	odtUnknownDataType
65	};
66
67	enum OutputDataHandling {
68	odhAverage,
69	odhTotal,
70	odhLastValue,
71	odhUnknownDataHandling
72	};
73
74	struct OutputData {
75	string title;
76	string units;
77	OutputDataType dataType;
78	OutputDataHandling dataHandling;
79	vector<BaseAccumulator*> accumulator;
80	};
81
82	class SpatialStatistics : public StaticAnalyser {
83
84	public:
85	SpatialStatistics(SimInfo* info, const string& filename, const string& sele, int nbins);
86	~SpatialStatistics();
87
88	void addOutputData(OutputData* dat) {data_.push_back(dat);}
89	virtual void process();
90	virtual void processFrame(int frame);
91	virtual int getBin(Vector3d pos)=0;
92	virtual void processStuntDouble(StuntDouble* sd, int bin)=0;
93	virtual void writeOutput();
94
95	protected:
96	OutputData* beginOutputData(vector<OutputData*>::iterator& i);
97	OutputData* nextOutputData(vector<OutputData*>::iterator& i);
98	void writeData(ostream& os, OutputData* dat, unsigned int bin);
99	void writeStdDev(ostream& os, OutputData* dat, unsigned int bin);
100
101	Snapshot* currentSnapshot_;
102	int nProcessed_;
103	string selectionScript_;
104	SelectionEvaluator evaluator_;
105	SelectionManager seleMan_;
106	int nBins_;
107	OutputData* counts_;
108	vector<OutputData*> data_;
109	};
110
111	class SlabStatistics : public SpatialStatistics {
112	public:
113	SlabStatistics(SimInfo* info, const string& filename, const string& sele, int nbins);
114	virtual int getBin(Vector3d pos);
115	virtual void processFrame(int frame);
116	protected:
117	OutputData* z_;
118	Mat3x3d hmat_;
119	RealType volume_;
120
121	};
122
123	class ShellStatistics : public SpatialStatistics {
124	public:
125	ShellStatistics(SimInfo* info, const string& filename, const string& sele, int nbins);
126	virtual int getBin(Vector3d pos);
127
128	void setCoordinateOrigin(Vector3d co) { coordinateOrigin_ = co; }
129	void setBinWidth(RealType bw) { binWidth_ = bw; }
130
131	protected:
132	OutputData* r_;
133	Vector3d coordinateOrigin_;
134	RealType binWidth_;
135	};
136
137	}
138	#endif
139
140
141