src/types/UreyBradleyBendType.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 UreyBradleyBendType.hpp
 * @author    tlin
 * @date  11/01/2004
 * @version 1.0
 */ 
 
#ifndef TYPES_UREYBRADLEYBENDTYPE_HPP
#define TYPES_UREYBRADLEYBENDTYPE_HPP

#include "types/HarmonicBendType.hpp"
#include "types/HarmonicBondType.hpp"
namespace oopse {
  /**
   * @class UreyBradleyBendType 
   *
   * @todo documentation
   */
  class UreyBradleyBendType : public HarmonicBendType {
    
  public:
    
    UreyBradleyBendType(RealType theta0, RealType ktheta, RealType s0, 
                        RealType kub) : HarmonicBendType(theta0, ktheta), 
                                        hbt_(HarmonicBondType(s0, kub)){
    }
    
    RealType getUBForceConstant() {
      return hbt_.getForceConstant();
    }
    
    void setUBForceConstant(RealType kub) {
      hbt_.setForceConstant(kub);
    }
    
    RealType getUBLength() {
      return hbt_.getEquilibriumBondLength();
    }
    
    void setUBLength(RealType s) {
      hbt_.setEquilibriumBondLength(s);
    }
    
    HarmonicBondType* getHarmonicBondType() {
      return &hbt_;
    }
                
  private:
    
    RealType k_;
    HarmonicBondType hbt_;
  };
  
}//end namespace oopse
#endif //TYPES_UREYBRADLEYBENDTYPE_HPP


Revision:	3175
Committed:	Mon Jul 16 13:33:10 2007 UTC (17 years ago) by gezelter
File size:	3296 byte(s)
Log Message:	Formatting to prettify the code
#	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			/**
43			* @file UreyBradleyBendType.hpp
44			* @author tlin
45			* @date 11/01/2004
46			* @version 1.0
47			*/
48
49			#ifndef TYPES_UREYBRADLEYBENDTYPE_HPP
50			#define TYPES_UREYBRADLEYBENDTYPE_HPP
51
52			#include "types/HarmonicBendType.hpp"
53			#include "types/HarmonicBondType.hpp"
54			namespace oopse {
55	gezelter	2204	/**
56			* @class UreyBradleyBendType
57			*
58			* @todo documentation
59			*/
60			class UreyBradleyBendType : public HarmonicBendType {
61	gezelter	3175
62	gezelter	2204	public:
63	gezelter	3175
64			UreyBradleyBendType(RealType theta0, RealType ktheta, RealType s0,
65			RealType kub) : HarmonicBendType(theta0, ktheta),
66			hbt_(HarmonicBondType(s0, kub)){
67			}
68
69	tim	2759	RealType getUBForceConstant() {
70	gezelter	2204	return hbt_.getForceConstant();
71			}
72	gezelter	3175
73	tim	2759	void setUBForceConstant(RealType kub) {
74	gezelter	2204	hbt_.setForceConstant(kub);
75			}
76	gezelter	3175
77	tim	2759	RealType getUBLength() {
78	gezelter	2204	return hbt_.getEquilibriumBondLength();
79			}
80	gezelter	3175
81	tim	2759	void setUBLength(RealType s) {
82	gezelter	2204	hbt_.setEquilibriumBondLength(s);
83			}
84	gezelter	3175
85	gezelter	2204	HarmonicBondType* getHarmonicBondType() {
86			return &hbt_;
87			}
88	gezelter	1930
89	gezelter	2204	private:
90	gezelter	3175
91	tim	2759	RealType k_;
92	gezelter	2204	HarmonicBondType hbt_;
93			};
94	gezelter	3175
95	gezelter	1930	}//end namespace oopse
96			#endif //TYPES_UREYBRADLEYBENDTYPE_HPP
97
98