src/lattice/LatticeCreator.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 LATTICE_LATTICECREATOR_HPP 
#define LATTICE_LATTICECREATOR_HPP

#include <string>

namespace OpenMD {

  class Lattice;

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

    virtual Lattice* create() const = 0;
            
  private:
    std::string ident_;
  };

  /**
   * @class LatticeBuilder
   * @todo document
   */
  template<class ConcreteLattice>
  class LatticeBuilder : public LatticeCreator {
  public:
    LatticeBuilder(const std::string& ident) : LatticeCreator(ident) {}
    virtual  Lattice* create() const {return new ConcreteLattice();}
  };

}

#endif //USETHEFORCE_FORCEFIELDCREATOR_HPP
Revision:	1390
Committed:	Wed Nov 25 20:02:06 2009 UTC (15 years, 5 months ago) by gezelter
File size:	2939 byte(s)
Log Message:	Almost all of the changes necessary to create OpenMD out of our old project (OOPSE-4)
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	482	* 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	482	* 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	482	* 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	482	*/
41
42	tim	484	#ifndef LATTICE_LATTICECREATOR_HPP
43	gezelter	482	#define LATTICE_LATTICECREATOR_HPP
44	tim	484
45	gezelter	482	#include <string>
46
47	gezelter	1390	namespace OpenMD {
48	gezelter	482
49	gezelter	507	class Lattice;
50	tim	484
51	gezelter	507	/**
52			* @class Lattice
53			* @todo document
54			*/
55			class LatticeCreator {
56			public:
57			LatticeCreator(const std::string& ident) : ident_(ident) {}
58			virtual ~LatticeCreator() {}
59	tim	484
60	gezelter	507	const std::string& getIdent() const { return ident_; }
61	tim	484
62	gezelter	507	virtual Lattice* create() const = 0;
63	tim	484
64	gezelter	507	private:
65			std::string ident_;
66			};
67	gezelter	482
68	gezelter	507	/**
69			* @class LatticeBuilder
70			* @todo document
71			*/
72			template<class ConcreteLattice>
73			class LatticeBuilder : public LatticeCreator {
74			public:
75			LatticeBuilder(const std::string& ident) : LatticeCreator(ident) {}
76			virtual Lattice* create() const {return new ConcreteLattice();}
77			};
78	gezelter	482
79			}
80	tim	484
81			#endif //USETHEFORCE_FORCEFIELDCREATOR_HPP