src/brains/Exclude.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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */
 
#ifndef BRAINS_EXCLUDE_HPP

#define BRAINS_EXCLUDE_HPP

#include <iostream>
#include <set>
#include <utility>
#include <vector>

namespace oopse {

  /**
   * @class Exclude Exclude.hpp "brains/Exclude.hpp"
   * @brief Exclude class maintains the exclusion list of the simulation by the global indices of the 
   * atoms. The exclusion list will be passed to fortran in a plain array.
   */
  class Exclude {
  public:

    Exclude() : modified_(false) {}


    /** Adds a pair into this Exclude class */
    void addPair(int i, int j);

    /** Remove a pair from Exclude class */
    void removePair(int i, int j);

    /** Checks whether pair (i, j) is in this Exclude class */
    bool hasPair(int i, int j);

    /** Returns the number of exclusion pair */
    int getSize();

    /** Returns the size of exclusion list */
    int getSizeOfExcludeList();

    /** Returns the exclusion pairs in a plain array*/
    int *getExcludeList();

    /** write out the exclusion list to an ostream */
    friend std::ostream& operator <<(std::ostream& o, Exclude& e);

  private:

    std::set < std::pair<int, int> > excludeSet_;
    std::vector <int> excludeList_;
    bool modified_;
  };

}      //end namespace oopse

#endif // __EXCLUDE_H__
Revision:	507
Committed:	Fri Apr 15 22:04:00 2005 UTC (20 years ago) by gezelter
File size:	3320 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* 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	gezelter	2
44	gezelter	246	#define BRAINS_EXCLUDE_HPP
45
46			#include <iostream>
47	gezelter	2	#include <set>
48			#include <utility>
49	gezelter	246	#include <vector>
50	gezelter	2
51	gezelter	246	namespace oopse {
52	gezelter	2
53	gezelter	507	/**
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	gezelter	2
61	gezelter	507	Exclude() : modified_(false) {}
62	gezelter	2
63
64	gezelter	507	/** Adds a pair into this Exclude class */
65			void addPair(int i, int j);
66	gezelter	2
67	gezelter	507	/** Remove a pair from Exclude class */
68			void removePair(int i, int j);
69	gezelter	2
70	gezelter	507	/** Checks whether pair (i, j) is in this Exclude class */
71			bool hasPair(int i, int j);
72	gezelter	246
73	gezelter	507	/** Returns the number of exclusion pair */
74			int getSize();
75	gezelter	246
76	gezelter	507	/** Returns the size of exclusion list */
77			int getSizeOfExcludeList();
78	gezelter	246
79	gezelter	507	/** Returns the exclusion pairs in a plain array*/
80			int *getExcludeList();
81	gezelter	246
82	gezelter	507	/** write out the exclusion list to an ostream */
83			friend std::ostream& operator <<(std::ostream& o, Exclude& e);
84	gezelter	246
85	gezelter	507	private:
86	gezelter	246
87	gezelter	507	std::set < std::pair<int, int> > excludeSet_;
88			std::vector <int> excludeList_;
89			bool modified_;
90			};
91	gezelter	246
92			} //end namespace oopse
93
94	gezelter	2	#endif // __EXCLUDE_H__