src/types/QuarticTorsionType.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 QuarticTorsionType.hpp
 * @author    tlin
 * @date  11/01/2004
 * @version 1.0
 */ 

#ifndef TYPES_QUARTICTORSIONTYPE_HPP
#define TYPES_QUARTICTORSIONTYPE_HPP

#include "types/TorsionType.hpp"

namespace oopse {
  /**
   * @class QuarticTorsionType 
   * @todo document
   */
  class QuarticTorsionType : public TorsionType {
    
  public:
           
    QuarticTorsionType(RealType k4, RealType k3, RealType k2, RealType k1, 
                       RealType k0) : k4_(k4), k3_(k3), k2_(k2), k1_(k1), 
                                      k0_(k0){
    }
    
    void setForceConstant(RealType k4, RealType k3, RealType k2, RealType k1, 
                          RealType k0) {
      k4_ = k4;
      k3_ = k3;
      k2_ = k2;
      k1_ = k1;
      k0_ = k0;      
    }

    void getForceConstant(RealType& k4, RealType& k3, RealType& k2, 
                          RealType& k1, RealType& k0) {
      k4 = k4_;
      k3 = k3_;
      k2 = k2_;
      k1 = k1_;
      k0 = k0_;
    }

    virtual void calcForce(RealType cosPhi, RealType& V, RealType& dVdcosPhi){ 
      RealType cosPhi2 = cosPhi * cosPhi;
      RealType cosPhi3 = cosPhi2 * cosPhi;
      RealType cosPhi4 = cosPhi3 * cosPhi;
            
      V =k0_ + k1_ * cosPhi + k2_*cosPhi2 + k3_*cosPhi3 + k4_*cosPhi4;
      dVdcosPhi = k1_ + 2.0*k2_ * cosPhi + 3.0 * k3_*cosPhi2 + 4.0*k4_*cosPhi3;
    }        
        
  private:
    RealType k4_;
    RealType k3_;
    RealType k2_;
    RealType k1_;
    RealType k0_;
  };

}//end namespace oopse
#endif //TYPES_QUADRATICTORSIONTYPE_HPP

Revision:	3175
Committed:	Mon Jul 16 13:33:10 2007 UTC (16 years, 11 months ago) by gezelter
File size:	3642 byte(s)
Log Message:	Formatting to prettify the code
#	Content
1	/*
2	* 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	/**
43	* @file QuarticTorsionType.hpp
44	* @author tlin
45	* @date 11/01/2004
46	* @version 1.0
47	*/
48
49	#ifndef TYPES_QUARTICTORSIONTYPE_HPP
50	#define TYPES_QUARTICTORSIONTYPE_HPP
51
52	#include "types/TorsionType.hpp"
53
54	namespace oopse {
55	/**
56	* @class QuarticTorsionType
57	* @todo document
58	*/
59	class QuarticTorsionType : public TorsionType {
60
61	public:
62
63	QuarticTorsionType(RealType k4, RealType k3, RealType k2, RealType k1,
64	RealType k0) : k4_(k4), k3_(k3), k2_(k2), k1_(k1),
65	k0_(k0){
66	}
67
68	void setForceConstant(RealType k4, RealType k3, RealType k2, RealType k1,
69	RealType k0) {
70	k4_ = k4;
71	k3_ = k3;
72	k2_ = k2;
73	k1_ = k1;
74	k0_ = k0;
75	}
76
77	void getForceConstant(RealType& k4, RealType& k3, RealType& k2,
78	RealType& k1, RealType& k0) {
79	k4 = k4_;
80	k3 = k3_;
81	k2 = k2_;
82	k1 = k1_;
83	k0 = k0_;
84	}
85
86	virtual void calcForce(RealType cosPhi, RealType& V, RealType& dVdcosPhi){
87	RealType cosPhi2 = cosPhi * cosPhi;
88	RealType cosPhi3 = cosPhi2 * cosPhi;
89	RealType cosPhi4 = cosPhi3 * cosPhi;
90
91	V =k0_ + k1_ * cosPhi + k2_cosPhi2 + k3_cosPhi3 + k4_*cosPhi4;
92	dVdcosPhi = k1_ + 2.0k2_ cosPhi + 3.0 * k3_cosPhi2 + 4.0k4_*cosPhi3;
93	}
94
95	private:
96	RealType k4_;
97	RealType k3_;
98	RealType k2_;
99	RealType k1_;
100	RealType k0_;
101	};
102
103	}//end namespace oopse
104	#endif //TYPES_QUADRATICTORSIONTYPE_HPP
105