src/integrators/LangevinHullForceManager.hpp

/*
 * Copyright (c) 2008, 2010 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, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
#ifndef INTEGRATOR_LANGEVINHULLFORCEMANAGER_HPP
#define INTEGRATOR_LANGEVINHULLFORCEMANAGER_HPP

#include "brains/ForceManager.hpp"
#include "brains/Thermo.hpp"
#include "primitives/Molecule.hpp"
#include "integrators/Velocitizer.hpp"
#include "math/Hull.hpp"
#include "math/Triangle.hpp"
#include "math/SeqRandNumGen.hpp"

using namespace std;
namespace OpenMD {
   
  /**
   * @class LangevinHullForceManager
   * Force manager for NPT Langevin Hull Dynamics applying friction
   * and random forces as well as torques.  Stochastic force is
   * determined by the area of surface triangles on the convex hull.
   * See: Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011),
   *      and Kohanoff et al. CHEMPHYSCHEM 6, 1848-1852 (2005).
   */
  class LangevinHullForceManager : public ForceManager{
    
  public:
    LangevinHullForceManager(SimInfo * info);
    virtual ~LangevinHullForceManager();
    
  protected:
    virtual void postCalculation();
    
  private:
    vector<Vector3d> genTriangleForces(int nTriangles, RealType variance);
    
    Globals* simParams;
    SeqRandNumGen randNumGen_;    
    Velocitizer* veloMunge;
    
    RealType dt_;
    RealType targetTemp_;
    RealType targetPressure_; 
    RealType viscosity_;
    
    RealType variance_;
    
    enum HullTypeEnum {
      hullConvex,
      hullAlphaShape,
      hullUnknown
    };
    
    map<string, HullTypeEnum> stringToEnumMap_;
    HullTypeEnum hullType_;
    
    bool doThermalCoupling_;
    bool doPressureCoupling_;
    
    Hull* surfaceMesh_;
    vector<StuntDouble*> localSites_;
  };
  
} //end namespace OpenMD
#endif //LANGEVINHULL_FORCEMANAGER

Revision:	1879
Committed:	Sun Jun 16 15:15:42 2013 UTC (11 years, 11 months ago) by gezelter
File size:	3855 byte(s)
Log Message:	MERGE OpenMD development 1783:1878 into trunk
#	User	Rev	Content
1	kstocke1	1526	/*
2			* Copyright (c) 2008, 2010 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	gezelter	1879	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
39	gezelter	1782	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	kstocke1	1526	*/
42
43			#ifndef INTEGRATOR_LANGEVINHULLFORCEMANAGER_HPP
44			#define INTEGRATOR_LANGEVINHULLFORCEMANAGER_HPP
45
46			#include "brains/ForceManager.hpp"
47			#include "brains/Thermo.hpp"
48			#include "primitives/Molecule.hpp"
49			#include "integrators/Velocitizer.hpp"
50			#include "math/Hull.hpp"
51			#include "math/Triangle.hpp"
52			#include "math/SeqRandNumGen.hpp"
53
54	gezelter	1879	using namespace std;
55	kstocke1	1526	namespace OpenMD {
56
57			/**
58			* @class LangevinHullForceManager
59	gezelter	1879	* Force manager for NPT Langevin Hull Dynamics applying friction
60			* and random forces as well as torques. Stochastic force is
61			* determined by the area of surface triangles on the convex hull.
62			* See: Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011),
63			* and Kohanoff et al. CHEMPHYSCHEM 6, 1848-1852 (2005).
64	kstocke1	1526	*/
65			class LangevinHullForceManager : public ForceManager{
66
67			public:
68			LangevinHullForceManager(SimInfo * info);
69	gezelter	1879	virtual ~LangevinHullForceManager();
70	kstocke1	1526
71			protected:
72			virtual void postCalculation();
73
74			private:
75	gezelter	1879	vector<Vector3d> genTriangleForces(int nTriangles, RealType variance);
76
77	kstocke1	1526	Globals* simParams;
78			SeqRandNumGen randNumGen_;
79			Velocitizer* veloMunge;
80	gezelter	1879
81	kstocke1	1526	RealType dt_;
82			RealType targetTemp_;
83			RealType targetPressure_;
84			RealType viscosity_;
85	gezelter	1879
86	kstocke1	1526	RealType variance_;
87	gezelter	1879
88			enum HullTypeEnum {
89	kstocke1	1526	hullConvex,
90			hullAlphaShape,
91			hullUnknown
92			};
93
94	gezelter	1879	map<string, HullTypeEnum> stringToEnumMap_;
95	kstocke1	1526	HullTypeEnum hullType_;
96
97	gezelter	1879	bool doThermalCoupling_;
98			bool doPressureCoupling_;
99
100	kstocke1	1526	Hull* surfaceMesh_;
101	gezelter	1879	vector<StuntDouble*> localSites_;
102	kstocke1	1526	};
103
104			} //end namespace OpenMD
105			#endif //LANGEVINHULL_FORCEMANAGER
106