src/primitives/DirectionalAtom.hpp

/*
 * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
 * 
 * Contact: oopse@oopse.org
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 * All we ask is that proper credit is given for our work, which includes
 * - but is not limited to - adding the above copyright notice to the beginning
 * of your source code files, and to any copyright notice that you may distribute
 * with programs based on this work.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

/**
 * @file DirectionalAtom.hpp
 * @author    tlin
 * @date  10/23/2004
 * @version 1.0
 */ 

#ifndef PRIMITIVES_DIRECTIONALATOM_HPP
#define PRIMITIVES_DIRECTIONALATOM_HPP

#include "primitives/Atom.hpp"
#include "types/DirectionalAtomType.hpp"
namespace oopse{
    class DirectionalAtom : public Atom {
        public:
            DirectionalAtom(DirectionalAtomType* dAtomType);
            /**
             * Returns the inertia tensor of this stuntdouble
             * @return the inertia tensor of this stuntdouble
             */ 
            virtual Mat3x3d getI();


           /**
             * Sets  the previous rotation matrix of this stuntdouble
             * @param a  new rotation matrix 
             */         
           virtual void setPrevA(const RotMat3x3d& a);
           
           /**
             * Sets  the current rotation matrix of this stuntdouble
             * @param a  new rotation matrix 
             */         
            virtual void setA(const RotMat3x3d& a);

           /**
             * Sets  the rotation matrix of this stuntdouble in specified snapshot
             * @param a rotation matrix to be set 
             * @param snapshotNo 
             * @see #getA
             */         
            virtual void setA(const RotMat3x3d& a, int snapshotNo);

            /** 
             * Left multiple rotation matrix by another rotation matrix 
             * @param m a rotation matrix
             */
            void rotateBy(const RotMat3x3d& m);
            
            /** Sets the internal unit frame of this stuntdouble by three euler angles */
            void setUnitFrameFromEuler(double phi, double theta, double psi);

            /**
             * Returns the gradient of this stuntdouble
             * @return the gradient of this stuntdouble
             */ 
            virtual std::vector<double> getGrad();

            virtual void accept(BaseVisitor* v);

        protected:
            Mat3x3d inertiaTensor_;   /**< inertial tensor */    
            RotMat3x3d sU_;               /**< body fixed standard unit vector */
    };

}//namepace oopse

#endif //PRIMITIVES_DIRECTIONALATOM_HPP
Revision:	1692
Committed:	Mon Nov 1 20:15:58 2004 UTC (19 years, 8 months ago) by tim
File size:	3317 byte(s)
Log Message:	break, break and break.....
#	User	Rev	Content
1	tim	1692	/*
2			* Copyright (C) 2000-2004 Object Oriented Parallel Simulation Engine (OOPSE) project
3			*
4			* Contact: oopse@oopse.org
5			*
6			* This program is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU Lesser General Public License
8			* as published by the Free Software Foundation; either version 2.1
9			* of the License, or (at your option) any later version.
10			* All we ask is that proper credit is given for our work, which includes
11			* - but is not limited to - adding the above copyright notice to the beginning
12			* of your source code files, and to any copyright notice that you may distribute
13			* with programs based on this work.
14			*
15			* This program is distributed in the hope that it will be useful,
16			* but WITHOUT ANY WARRANTY; without even the implied warranty of
17			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			* GNU Lesser General Public License for more details.
19			*
20			* You should have received a copy of the GNU Lesser General Public License
21			* along with this program; if not, write to the Free Software
22			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23			*
24			*/
25	gezelter	1490
26	tim	1692	/**
27			* @file DirectionalAtom.hpp
28			* @author tlin
29			* @date 10/23/2004
30			* @version 1.0
31			*/
32	gezelter	1490
33	tim	1692	#ifndef PRIMITIVES_DIRECTIONALATOM_HPP
34			#define PRIMITIVES_DIRECTIONALATOM_HPP
35
36	tim	1492	#include "primitives/Atom.hpp"
37	tim	1692	#include "types/DirectionalAtomType.hpp"
38			namespace oopse{
39			class DirectionalAtom : public Atom {
40			public:
41			DirectionalAtom(DirectionalAtomType* dAtomType);
42			/**
43			* Returns the inertia tensor of this stuntdouble
44			* @return the inertia tensor of this stuntdouble
45			*/
46			virtual Mat3x3d getI();
47	gezelter	1490
48
49	tim	1692	/**
50			* Sets the previous rotation matrix of this stuntdouble
51			* @param a new rotation matrix
52			*/
53			virtual void setPrevA(const RotMat3x3d& a);
54
55			/**
56			* Sets the current rotation matrix of this stuntdouble
57			* @param a new rotation matrix
58			*/
59			virtual void setA(const RotMat3x3d& a);
60	gezelter	1490
61	tim	1692	/**
62			* Sets the rotation matrix of this stuntdouble in specified snapshot
63			* @param a rotation matrix to be set
64			* @param snapshotNo
65			* @see #getA
66			*/
67			virtual void setA(const RotMat3x3d& a, int snapshotNo);
68	gezelter	1490
69	tim	1692	/**
70			* Left multiple rotation matrix by another rotation matrix
71			* @param m a rotation matrix
72			*/
73			void rotateBy(const RotMat3x3d& m);
74
75			/** Sets the internal unit frame of this stuntdouble by three euler angles */
76			void setUnitFrameFromEuler(double phi, double theta, double psi);
77	gezelter	1490
78	tim	1692	/**
79			* Returns the gradient of this stuntdouble
80			* @return the gradient of this stuntdouble
81			*/
82			virtual std::vector<double> getGrad();
83	gezelter	1490
84	tim	1692	virtual void accept(BaseVisitor* v);
85	gezelter	1490
86	tim	1692	protected:
87			Mat3x3d inertiaTensor_; /*< inertial tensor /
88			RotMat3x3d sU_; /*< body fixed standard unit vector /
89			};
90	gezelter	1490
91	tim	1692	}//namepace oopse
92	gezelter	1490
93	tim	1692	#endif //PRIMITIVES_DIRECTIONALATOM_HPP