src/minimizers/MinimizerCreator.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 MINIMIZERS_MINIMIZERCREATOR_HPP 
#define MINIMIZERS_MINIMIZERCREATOR_HPP

#include <string>

namespace OpenMD {

  class Minimizer;
  class SimInfo;
  /**
   * @class Minimizer
   * @todo document
   */
  class MinimizerCreator {
  public:
    MinimizerCreator(const std::string& ident) : ident_(ident) {}
    virtual ~MinimizerCreator() {}
        
    const std::string& getIdent() const { return ident_; }

    virtual Minimizer* create(SimInfo* info) const = 0;
            
  private:
    std::string ident_;
  };

  /**
   * @class MinimizerBuilder
   * @todo document
   */
  template<class ConcreteMinimizer>
  class MinimizerBuilder : public MinimizerCreator {
  public:
    MinimizerBuilder(const std::string& ident) : MinimizerCreator(ident) {}
    virtual  Minimizer* create(SimInfo* info) const {return new ConcreteMinimizer(info);}
  };

}

#endif //MINIMIZERS_MINIMIZERCREATOR_HPP

Revision:	1465
Committed:	Fri Jul 9 23:08:25 2010 UTC (14 years, 10 months ago) by chuckv
File size:	3022 byte(s)
Log Message:	Creating busticated version of OpenMD
#	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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	246	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	246	* 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	gezelter	1390	*
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	gezelter	246	*/
41
42			#ifndef MINIMIZERS_MINIMIZERCREATOR_HPP
43			#define MINIMIZERS_MINIMIZERCREATOR_HPP
44
45			#include <string>
46
47	gezelter	1390	namespace OpenMD {
48	gezelter	246
49	gezelter	507	class Minimizer;
50			class SimInfo;
51			/**
52			* @class Minimizer
53			* @todo document
54			*/
55			class MinimizerCreator {
56			public:
57			MinimizerCreator(const std::string& ident) : ident_(ident) {}
58			virtual ~MinimizerCreator() {}
59	tim	385
60	gezelter	507	const std::string& getIdent() const { return ident_; }
61	gezelter	246
62	gezelter	507	virtual Minimizer* create(SimInfo* info) const = 0;
63	gezelter	246
64	gezelter	507	private:
65			std::string ident_;
66			};
67	gezelter	246
68	gezelter	507	/**
69			* @class MinimizerBuilder
70			* @todo document
71			*/
72			template<class ConcreteMinimizer>
73			class MinimizerBuilder : public MinimizerCreator {
74			public:
75			MinimizerBuilder(const std::string& ident) : MinimizerCreator(ident) {}
76			virtual Minimizer* create(SimInfo* info) const {return new ConcreteMinimizer(info);}
77			};
78	gezelter	246
79			}
80
81			#endif //MINIMIZERS_MINIMIZERCREATOR_HPP
82