src/brains/ForceManager.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]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
/**
 * @file ForceManager.hpp
 * @author tlin
 * @date 11/09/2004
 * @version 1.0
 */

#ifndef BRAINS_FORCEMANAGER_HPP
#define BRAINS_FORCEMANAGER_HPP

#include "brains/SimInfo.hpp"
#include "primitives/Molecule.hpp"
#include "nonbonded/Cutoffs.hpp"
#include "nonbonded/SwitchingFunction.hpp"
#include "nonbonded/InteractionManager.hpp"
#include "perturbations/Perturbation.hpp"
#include "parallel/ForceDecomposition.hpp"

#define PREPAIR_LOOP 0
#define PAIR_LOOP 1

using namespace std;
namespace OpenMD {
  /**
   * @class ForceManager ForceManager.hpp "brains/ForceManager.hpp"
   * ForceManager is responsible for calculating both the short range
   * (bonded) interactions and long range (non-bonded) interactions.
   *
   * @note the reason we delay some of the setup is that
   * initialization must wait until after the force field has been
   * parsed so that the atom types are known.
   */
  class ForceManager {

  public:
    ForceManager(SimInfo * info);                          
    virtual ~ForceManager() {}
    virtual void calcForces();
    void initialize();

  protected: 
    bool initialized_; 
    bool doParticlePot_;
    bool doElectricField_;
    bool doHeatFlux_;

    virtual void setupCutoffs();
    virtual void preCalculation();        
    virtual void shortRangeInteractions();
    virtual void longRangeInteractions();
    virtual void postCalculation();

    SimInfo* info_;        
    ForceField* forceField_;
    InteractionManager* interactionMan_;
    ForceDecomposition* fDecomp_;
    SwitchingFunction* switcher_;

    SwitchingFunctionType sft_;/**< Type of switching function in use */
    RealType rCut_;            /**< cutoff radius for non-bonded interactions */
    RealType rSwitch_;         /**< inner radius of switching function */
    CutoffMethod cutoffMethod_;/**< Cutoff Method for most non-bonded interactions */
    CutoffPolicy cutoffPolicy_;/**< Cutoff Policy for non-bonded interactions */

    map<Bend*, BendDataSet> bendDataSets;
    map<Torsion*, TorsionDataSet> torsionDataSets;
    map<Inversion*, InversionDataSet> inversionDataSets;
    vector<pair<int, int> > neighborList;

    vector<RealType> vdwScale_;
    vector<RealType> electrostaticScale_;

    Mat3x3d stressTensor;

    vector<Perturbation*> perturbations_;
  };
} 
#endif //BRAINS_FORCEMANAGER_HPP
Revision:	1808
Committed:	Mon Oct 22 20:42:10 2012 UTC (12 years, 6 months ago) by gezelter
File size:	4516 byte(s)
Log Message:	A bug fix in the electric field for the new electrostatic code. Also comment fixes for Doxygen
#	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	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	246	*/
42
43	gezelter	507	/**
44			* @file ForceManager.hpp
45			* @author tlin
46			* @date 11/09/2004
47			* @version 1.0
48			*/
49	gezelter	246
50			#ifndef BRAINS_FORCEMANAGER_HPP
51			#define BRAINS_FORCEMANAGER_HPP
52
53			#include "brains/SimInfo.hpp"
54	tim	749	#include "primitives/Molecule.hpp"
55	gezelter	1576	#include "nonbonded/Cutoffs.hpp"
56			#include "nonbonded/SwitchingFunction.hpp"
57	gezelter	1528	#include "nonbonded/InteractionManager.hpp"
58	jmarr	1780	#include "perturbations/Perturbation.hpp"
59	gezelter	1549	#include "parallel/ForceDecomposition.hpp"
60	gezelter	1469
61	gezelter	1545	#define PREPAIR_LOOP 0
62			#define PAIR_LOOP 1
63
64			using namespace std;
65	gezelter	1390	namespace OpenMD {
66	gezelter	507	/**
67			* @class ForceManager ForceManager.hpp "brains/ForceManager.hpp"
68	gezelter	1576	* ForceManager is responsible for calculating both the short range
69			* (bonded) interactions and long range (non-bonded) interactions.
70	gezelter	1126	*
71	gezelter	1576	* @note the reason we delay some of the setup is that
72			* initialization must wait until after the force field has been
73			* parsed so that the atom types are known.
74	gezelter	507	*/
75			class ForceManager {
76	gezelter	246
77	gezelter	507	public:
78	gezelter	1469	ForceManager(SimInfo * info);
79	gezelter	507	virtual ~ForceManager() {}
80	gezelter	1464	virtual void calcForces();
81	gezelter	1576	void initialize();
82	gezelter	246
83	gezelter	1576	protected:
84			bool initialized_;
85	gezelter	1711	bool doParticlePot_;
86	gezelter	1787	bool doElectricField_;
87	gezelter	1723	bool doHeatFlux_;
88	gezelter	246
89	gezelter	1576	virtual void setupCutoffs();
90	gezelter	1469	virtual void preCalculation();
91	gezelter	1546	virtual void shortRangeInteractions();
92			virtual void longRangeInteractions();
93	gezelter	1464	virtual void postCalculation();
94	gezelter	1576
95			SimInfo* info_;
96			ForceField* forceField_;
97			InteractionManager* interactionMan_;
98			ForceDecomposition* fDecomp_;
99			SwitchingFunction* switcher_;
100
101			SwitchingFunctionType sft_;/*< Type of switching function in use /
102			RealType rCut_; /*< cutoff radius for non-bonded interactions /
103			RealType rSwitch_; /*< inner radius of switching function /
104			CutoffMethod cutoffMethod_;/*< Cutoff Method for most non-bonded interactions /
105			CutoffPolicy cutoffPolicy_;/*< Cutoff Policy for non-bonded interactions /
106
107	gezelter	1545	map<Bend*, BendDataSet> bendDataSets;
108			map<Torsion*, TorsionDataSet> torsionDataSets;
109			map<Inversion*, InversionDataSet> inversionDataSets;
110	gezelter	1576	vector<pair<int, int> > neighborList;
111
112			vector<RealType> vdwScale_;
113			vector<RealType> electrostaticScale_;
114
115	gezelter	1723	Mat3x3d stressTensor;
116	jmarr	1780
117			vector<Perturbation*> perturbations_;
118	gezelter	507	};
119	gezelter	1545	}
120	gezelter	246	#endif //BRAINS_FORCEMANAGER_HPP