src/restraints/ObjectRestraint.hpp

/*
 * Copyright (c) 2009 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.
 */
 
#ifndef RESTRAINTS_OBJECTRESTRAINT_HPP
#define RESTRAINTS_OBJECTRESTRAINT_HPP

#include "restraints/Restraint.hpp"
#include "math/Vector3.hpp"
#include "math/SquareMatrix3.hpp"

namespace oopse {
  /**
   * @class ObjectRestraint 
   *
   * ObjectRestraint is the basic harmonic restraint for the 
   * degrees of freedom of a StuntDouble 
   *
   * In the ideal structure:
   * 
   * k_[twist,swing] are the two spring constants of the restraining 
   * potential
   */
  class ObjectRestraint : public Restraint {
    
  public:
    
    ObjectRestraint() : Restraint() { }

    void setReferenceStructure(Vector3d refPos) {
      refPos_ = refPos;
    }
  
    void setReferenceStructure(Vector3d refPos, RotMat3x3d refA) {
      refPos_ = refPos;
      refA_ = refA;
    }
    
    void calcForce(Vector3d struc);
    void calcForce(Vector3d struc, RotMat3x3d A);    

    Vector3d getRestraintForce() { return force_; }
    Vector3d getRestraintTorque() { return torque_; }
                    
  private:    
    Vector3d refPos_;
    RotMat3x3d refA_;

    Vector3d force_;
    Vector3d torque_;
  };
}
#endif
Revision:	1360
Committed:	Mon Sep 7 16:31:51 2009 UTC (15 years, 7 months ago) by cli2
File size:	3193 byte(s)
Log Message:	Added new restraint infrastructure Added MolecularRestraints Added ObjectRestraints Added RestraintStamp Updated thermodynamic integration to use ObjectRestraints Added Quaternion mathematics for twist swing decompositions Significantly updated RestWriter and RestReader to use dump-like files Added selections for x, y, and z coordinates of atoms Removed monolithic Restraints class Fixed a few bugs in gradients of Euler angles in DirectionalAtom and RigidBody Added some rotational capabilities to prinicpalAxisCalculator
#	Content
1	/*
2	* Copyright (c) 2009 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	#ifndef RESTRAINTS_OBJECTRESTRAINT_HPP
43	#define RESTRAINTS_OBJECTRESTRAINT_HPP
44
45	#include "restraints/Restraint.hpp"
46	#include "math/Vector3.hpp"
47	#include "math/SquareMatrix3.hpp"
48
49	namespace oopse {
50	/**
51	* @class ObjectRestraint
52	*
53	* ObjectRestraint is the basic harmonic restraint for the
54	* degrees of freedom of a StuntDouble
55	*
56	* In the ideal structure:
57	*
58	* k_[twist,swing] are the two spring constants of the restraining
59	* potential
60	*/
61	class ObjectRestraint : public Restraint {
62
63	public:
64
65	ObjectRestraint() : Restraint() { }
66
67	void setReferenceStructure(Vector3d refPos) {
68	refPos_ = refPos;
69	}
70
71	void setReferenceStructure(Vector3d refPos, RotMat3x3d refA) {
72	refPos_ = refPos;
73	refA_ = refA;
74	}
75
76	void calcForce(Vector3d struc);
77	void calcForce(Vector3d struc, RotMat3x3d A);
78
79	Vector3d getRestraintForce() { return force_; }
80	Vector3d getRestraintTorque() { return torque_; }
81
82	private:
83	Vector3d refPos_;
84	RotMat3x3d refA_;
85
86	Vector3d force_;
87	Vector3d torque_;
88	};
89	}
90	#endif