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. 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.
 */
 
/**
 * @file ForceManager.hpp
 * @author tlin
 * @date 11/09/2004
 * @time 10:36am
 * @version 1.0
 */

#ifndef BRAINS_FORCEMANAGER_HPP
#define BRAINS_FORCEMANAGER_HPP

#include "brains/SimInfo.hpp"

namespace oopse {

  /**
   * @class ForceManager ForceManager.hpp "brains/ForceManager.hpp"
   * ForceManager is responsible for calculating the short range interactions (c++) and
   * long range interactions(fortran). If fortran side is not setup before the force calculation,
   * call SimInfo's update function to settle it down. 
   * @note the reason we delay fortran side's setup is that some applications (Dump2XYZ etc.) 
   * may not need force calculation, why bother? 
   */
  class ForceManager {

  public:
    ForceManager(SimInfo * info) : info_(info) {}
        
    virtual ~ForceManager() {}

    //public virtual function should be avoided
    /**@todo need refactory */
    virtual void calcForces(bool needPotential, bool needStress);

    virtual void init() {}
  protected:

    virtual void preCalculation();
        
    virtual void calcShortRangeInteraction();

    virtual void calcLongRangeInteraction(bool needPotential, bool needStress);

    virtual void postCalculation();
 
    SimInfo * info_;        

  };

} //end namespace oopse
#endif //BRAINS_FORCEMANAGER_HPP
Revision:	2204
Committed:	Fri Apr 15 22:04:00 2005 UTC (19 years, 2 months ago) by gezelter
File size:	3377 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	User	Rev	Content
1	gezelter	2204	/*
2	gezelter	1930	* 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	gezelter	2204	/**
43			* @file ForceManager.hpp
44			* @author tlin
45			* @date 11/09/2004
46			* @time 10:36am
47			* @version 1.0
48			*/
49	gezelter	1930
50			#ifndef BRAINS_FORCEMANAGER_HPP
51			#define BRAINS_FORCEMANAGER_HPP
52
53			#include "brains/SimInfo.hpp"
54
55			namespace oopse {
56
57	gezelter	2204	/**
58			* @class ForceManager ForceManager.hpp "brains/ForceManager.hpp"
59			* ForceManager is responsible for calculating the short range interactions (c++) and
60			* long range interactions(fortran). If fortran side is not setup before the force calculation,
61			* call SimInfo's update function to settle it down.
62			* @note the reason we delay fortran side's setup is that some applications (Dump2XYZ etc.)
63			* may not need force calculation, why bother?
64			*/
65			class ForceManager {
66	gezelter	1930
67	gezelter	2204	public:
68			ForceManager(SimInfo * info) : info_(info) {}
69	gezelter	1930
70	gezelter	2204	virtual ~ForceManager() {}
71	gezelter	1930
72	gezelter	2204	//public virtual function should be avoided
73			/*@todo need refactory /
74			virtual void calcForces(bool needPotential, bool needStress);
75	gezelter	1930
76	gezelter	2204	virtual void init() {}
77			protected:
78	gezelter	1930
79	gezelter	2204	virtual void preCalculation();
80	gezelter	1930
81	gezelter	2204	virtual void calcShortRangeInteraction();
82	gezelter	1930
83	gezelter	2204	virtual void calcLongRangeInteraction(bool needPotential, bool needStress);
84	gezelter	1930
85	gezelter	2204	virtual void postCalculation();
86	gezelter	1930
87	gezelter	2204	SimInfo * info_;
88	gezelter	1930
89	gezelter	2204	};
90	gezelter	1930
91			} //end namespace oopse
92			#endif //BRAINS_FORCEMANAGER_HPP