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. Acknowledgement of the program authors must be made in any |
10 |
* publication of scientific results based in part on use of the |
11 |
* program. An acceptable form of acknowledgement is citation of |
12 |
* the article in which the program was described (Matthew |
13 |
* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher |
14 |
* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented |
15 |
* Parallel Simulation Engine for Molecular Dynamics," |
16 |
* J. Comput. Chem. 26, pp. 252-271 (2005)) |
17 |
* |
18 |
* 2. Redistributions of source code must retain the above copyright |
19 |
* notice, this list of conditions and the following disclaimer. |
20 |
* |
21 |
* 3. Redistributions in binary form must reproduce the above copyright |
22 |
* notice, this list of conditions and the following disclaimer in the |
23 |
* documentation and/or other materials provided with the |
24 |
* distribution. |
25 |
* |
26 |
* This software is provided "AS IS," without a warranty of any |
27 |
* kind. All express or implied conditions, representations and |
28 |
* warranties, including any implied warranty of merchantability, |
29 |
* fitness for a particular purpose or non-infringement, are hereby |
30 |
* excluded. The University of Notre Dame and its licensors shall not |
31 |
* be liable for any damages suffered by licensee as a result of |
32 |
* using, modifying or distributing the software or its |
33 |
* derivatives. In no event will the University of Notre Dame or its |
34 |
* licensors be liable for any lost revenue, profit or data, or for |
35 |
* direct, indirect, special, consequential, incidental or punitive |
36 |
* damages, however caused and regardless of the theory of liability, |
37 |
* arising out of the use of or inability to use software, even if the |
38 |
* University of Notre Dame has been advised of the possibility of |
39 |
* such damages. |
40 |
*/ |
41 |
|
42 |
#ifndef BRAINS_EXCLUDE_HPP |
43 |
|
44 |
#define BRAINS_EXCLUDE_HPP |
45 |
|
46 |
#include <iostream> |
47 |
#include <set> |
48 |
#include <utility> |
49 |
#include <vector> |
50 |
|
51 |
namespace oopse { |
52 |
|
53 |
/** |
54 |
* @class Exclude Exclude.hpp "brains/Exclude.hpp" |
55 |
* @brief Exclude class maintains the exclusion list of the simulation by the global indices of the |
56 |
* atoms. The exclusion list will be passed to fortran in a plain array. |
57 |
*/ |
58 |
class Exclude { |
59 |
public: |
60 |
|
61 |
Exclude() : modified_(false) {} |
62 |
|
63 |
|
64 |
/** Adds a pair into this Exclude class */ |
65 |
void addPair(int i, int j); |
66 |
|
67 |
void addPairs(std::set<int>& set1, std::set<int>& set2); |
68 |
template<typename IterType1, typename IterType2> |
69 |
void addPairs(IterType1 iter1_first, IterType1 iter1_last, IterType2 iter2_first, IterType2 iter2_last); |
70 |
|
71 |
/** Remove a pair from Exclude class */ |
72 |
void removePair(int i, int j); |
73 |
|
74 |
void removePairs(std::set<int>& set1, std::set<int>& set2); |
75 |
template<typename IterType1, typename IterType2> |
76 |
void removePairs(IterType1 iter1_first, IterType1 iter1_last, IterType2 iter2_first, IterType2 iter2_last); |
77 |
|
78 |
/** Checks whether pair (i, j) is in this Exclude class */ |
79 |
bool hasPair(int i, int j); |
80 |
|
81 |
/** Returns the number of exclusion pair */ |
82 |
int getSize(); |
83 |
|
84 |
/** Returns the size of exclusion list */ |
85 |
int getSizeOfExcludeList(); |
86 |
|
87 |
/** Returns the exclusion pairs in a plain array*/ |
88 |
int *getExcludeList(); |
89 |
|
90 |
/** write out the exclusion list to an ostream */ |
91 |
friend std::ostream& operator <<(std::ostream& o, Exclude& e); |
92 |
|
93 |
private: |
94 |
|
95 |
std::set < std::pair<int, int> > excludeSet_; |
96 |
std::vector <int> excludeList_; |
97 |
bool modified_; |
98 |
}; |
99 |
|
100 |
} //end namespace oopse |
101 |
|
102 |
#endif // __EXCLUDE_H__ |