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 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 created random number of generator*/
        int myRank_; /**@todo Fixed Me */
};

}
#endif

#endif 
Revision:	2082
Committed:	Mon Mar 7 22:39:33 2005 UTC (19 years, 4 months ago) by tim
File size:	2970 byte(s)
Log Message:	Fixing a bug in BitSet.cpp
#	User	Rev	Content
1	tim	2072	/*
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	tim	2076
47	tim	2072	#include "utils/simError.h"
48	tim	2076	#include "math/RandNumGen.hpp"
49	tim	2072	#ifdef IS_MPI
50
51			namespace oopse {
52
53
54
55			/**
56			* @class ParallelRandNumGen a parallel random number generator
57	tim	2082	* @note use SeqRandNumGen if you want a non-parallel random number generator.
58	tim	2072	*/
59	tim	2076	class ParallelRandNumGen : public RandNumGen{
60	tim	2072	public:
61			typedef unsigned long uint32;
62
63			ParallelRandNumGen( const uint32& oneSeed);
64	tim	2076
65	tim	2072	ParallelRandNumGen();
66
67	tim	2076	virtual void seed( const uint32 oneSeed );
68	tim	2072
69	tim	2076	virtual void seed();
70	tim	2072
71			private:
72	tim	2077
73			ParallelRandNumGen(const ParallelRandNumGen&);
74			ParallelRandNumGen& operator =(const ParallelRandNumGen&);
75	tim	2072
76			static int nCreatedRNG_; /*< number of created random number of generator/
77	tim	2082	int myRank_; /*@todo Fixed Me /
78	tim	2072	};
79
80			}
81			#endif
82
83			#endif