ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/OOPSE-2.0/src/brains/Exclude.hpp
(Generate patch)

Comparing trunk/OOPSE-2.0/src/brains/Exclude.hpp (file contents):
Revision 1490 by gezelter, Fri Sep 24 04:16:43 2004 UTC vs.
Revision 1930 by gezelter, Wed Jan 12 22:41:40 2005 UTC

# Line 1 | Line 1
1 < #ifndef __EXCLUDE_H__
2 < #define __EXCLUDE_H__
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 < using namespace std;
51 > namespace oopse {
52  
53 < class Exclude{
54 <  
55 < public:
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();
14 <  
15 <  void addPair(int i, int j);
16 <  int  hasPair(int i, int j);
17 <  void printMe( void );
18 <  int  getSize( void );  
19 <  int* getFortranArray( void );
20 <  static Exclude* Instance();
21 <
22 < protected:
61 >            Exclude() : modified_(false) {}
62  
24  set<pair<int, int> > excludeSet;
25  int* exPairs;
26  bool newFortranArrayNeeded;
27  Exclude();
63  
64 < private:
65 <  static Exclude* _instance;  
64 >            /** Adds a pair into this Exclude class */
65 >            void addPair(int i, int j);
66  
67 < };    
67 >            /** Remove a pair from Exclude class */
68 >            void removePair(int i, int j);
69  
70 +            /** Checks whether pair (i, j) is in this Exclude class */
71 +            bool hasPair(int i, int j);
72 +
73 +            /** Returns the number of exclusion pair */
74 +            int getSize();
75 +
76 +            /** Returns the size of exclusion list */
77 +            int getSizeOfExcludeList();
78 +
79 +            /** Returns the exclusion pairs in a plain array*/
80 +            int *getExcludeList();
81 +
82 +            /** write out the exclusion list to an ostream */
83 +            friend std::ostream& operator <<(std::ostream& o, Exclude& e);
84 +
85 +        private:
86 +
87 +            std::set < std::pair<int, int> > excludeSet_;
88 +            std::vector <int> excludeList_;
89 +            bool modified_;
90 +    };
91 +
92 + }      //end namespace oopse
93 +
94   #endif // __EXCLUDE_H__

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines