src/math/ParallelRandNumGen.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 MATH_PARALLELRANDNUMGEN_HPP
#define MATH_PARALLELRANDNUMGEN_HPP

#include <vector>

#include "utils/simError.h"
#include "math/RandNumGen.hpp"

namespace OpenMD {
  
  /**
   * @class ParallelRandNumGen a parallel random number generator
   * @note use SeqRandNumGen if you want a non-parallel random number
   * generator.
   */
  class ParallelRandNumGen : public RandNumGen{
  public:
    typedef unsigned long uint32; 
    
    ParallelRandNumGen( const uint32& oneSeed);
    
    ParallelRandNumGen();
    
    virtual void seed( const uint32 oneSeed );
    
    virtual void seed();
    
  private:
    
    ParallelRandNumGen(const ParallelRandNumGen&);
    ParallelRandNumGen& operator =(const ParallelRandNumGen&);
    
    static int nCreatedRNG_; /**< number of random number 
                                generators created */
    int myRank_;
  };
  
}
#endif 
Revision:	1442
Committed:	Mon May 10 17:28:26 2010 UTC (14 years, 11 months ago) by gezelter
File size:	3001 byte(s)
Log Message:	Adding property set to svn entries
#	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, 24107 (2008).
39	* [4] Vardeman & Gezelter, in progress (2009).
40	*/
41
42	#ifndef MATH_PARALLELRANDNUMGEN_HPP
43	#define MATH_PARALLELRANDNUMGEN_HPP
44
45	#include <vector>
46
47	#include "utils/simError.h"
48	#include "math/RandNumGen.hpp"
49
50	namespace OpenMD {
51
52	/**
53	* @class ParallelRandNumGen a parallel random number generator
54	* @note use SeqRandNumGen if you want a non-parallel random number
55	* generator.
56	*/
57	class ParallelRandNumGen : public RandNumGen{
58	public:
59	typedef unsigned long uint32;
60
61	ParallelRandNumGen( const uint32& oneSeed);
62
63	ParallelRandNumGen();
64
65	virtual void seed( const uint32 oneSeed );
66
67	virtual void seed();
68
69	private:
70
71	ParallelRandNumGen(const ParallelRandNumGen&);
72	ParallelRandNumGen& operator =(const ParallelRandNumGen&);
73
74	static int nCreatedRNG_; /**< number of random number
75	generators created */
76	int myRank_;
77	};
78
79	}
80	#endif