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. 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 MATH_PARALLELRANDNUMGEN_HPP
#define MATH_PARALLELRANDNUMGEN_HPP

#include <vector>

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

namespace oopse {


/**
 * @class ParallelRandNumGen a parallel random number generator
 * @note use MTRand if you want a non-parallel random number generator in MPI enviroment
 */
class ParallelRandNumGen : public RandNumGen{
    public:
        typedef unsigned long uint32; 
        
        ParallelRandNumGen( const uint32& oneSeed);

        ParallelRandNumGen();
        
        virtual void seed( const uint32 oneSeed );
        
        virtual void seed();

    private:

        static int nCreatedRNG_; /**< number of created random number of generator*/

};

}
#endif

#endif 
Revision:	2076
Committed:	Wed Mar 2 15:36:14 2005 UTC (19 years, 4 months ago) by tim
File size:	2806 byte(s)
Log Message:	remove default parameter from MersenneTwister.hpp which causes all kinds of trouble. Refactory random number generator
#	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. 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 MATH_PARALLELRANDNUMGEN_HPP
43	#define MATH_PARALLELRANDNUMGEN_HPP
44
45	#include <vector>
46
47	#include "utils/simError.h"
48	#include "math/RandNumGen.hpp"
49	#ifdef IS_MPI
50
51	namespace oopse {
52
53
54
55	/**
56	* @class ParallelRandNumGen a parallel random number generator
57	* @note use MTRand if you want a non-parallel random number generator in MPI enviroment
58	*/
59	class ParallelRandNumGen : public RandNumGen{
60	public:
61	typedef unsigned long uint32;
62
63	ParallelRandNumGen( const uint32& oneSeed);
64
65	ParallelRandNumGen();
66
67	virtual void seed( const uint32 oneSeed );
68
69	virtual void seed();
70
71	private:
72
73	static int nCreatedRNG_; /*< number of created random number of generator/
74
75	};
76
77	}
78	#endif
79
80	#endif