ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/src/primitives/StuntDouble.hpp
(Generate patch)

Comparing trunk/src/primitives/StuntDouble.hpp (file contents):
Revision 1244 by chuckv, Wed Jan 3 20:47:00 2007 UTC vs.
Revision 1245 by chuckv, Tue May 27 16:39:06 2008 UTC

# Line 83 | Line 83 | namespace oopse{
83     * doesn't try to do something stupid like torque an Atom (The
84     * quotes above are from Spaceballs...)
85     *
86 <   * @note the dynamic data of stuntdouble will be stored outside of the class
86 >   * @note the dynamic data of stuntDouble will be stored outside of the class
87     */
88    class StuntDouble{
89    public:    
# Line 97 | Line 97 | namespace oopse{
97      virtual ~StuntDouble();
98          
99      /**
100 <     * Returns the global index of this stuntRealType.
101 <     * @return  the global index of this stuntdouble
100 >     * Returns the global index of this stuntDouble.
101 >     * @return  the global index of this stuntDouble
102       */
103      int getGlobalIndex() {
104        return globalIndex_;
105      }
106  
107      /**
108 <     * Sets the global index of this stuntRealType.
108 >     * Sets the global index of this stuntDouble.
109       * @param new global index to be set
110       */
111      void setGlobalIndex(int index) {
112        globalIndex_ = index;
113      }
114 <        
114 >    
115      /**
116 <     * Returns the local index of this stuntdouble
117 <     * @return the local index of this stuntdouble
116 >     * Returns the local index of this stuntDouble
117 >     * @return the local index of this stuntDouble
118       */
119      int getLocalIndex() {
120        return localIndex_;
121      }
122  
123      /**
124 <     * Sets the local index of this stuntdouble
124 >     * Sets the local index of this stuntDouble
125       * @param index new index to be set
126       */        
127      void setLocalIndex(int index) {
128        localIndex_ = index;
129      }
130 +    
131 +    int getGlobalIntegrableObjectIndex(){
132 +      return globalIntegrableObjectIndex_;
133 +    }
134 +    void setGlobalIntegrableObjectIndex(int index) {
135 +      globalIntegrableObjectIndex_ = index;
136 +    }
137  
131 –  int getGlobalIntegrableObjectIndex(){
132 –        return globalIntegrableObjectIndex_;
133 –  }
134 –  void setGlobalIntegrableObjectIndex(int index) {
135 –     globalIntegrableObjectIndex_ = index;
136 –  }
137 –
138      /**
139 <     * Sets the Snapshot Manager of this stuntdouble
139 >     * Sets the Snapshot Manager of this stuntDouble
140       */
141      void setSnapshotManager(SnapshotManager* sman) {
142        snapshotMan_ = sman;
143      }
144  
145      /**
146 <     * Tests if this stuntdouble is an atom
147 <     * @return true is this stuntdouble is an atom(or a directional atom), return false otherwise
146 >     * Tests if this stuntDouble is an atom
147 >     * @return true is this stuntDouble is an atom(or a directional atom), return false otherwise
148       */
149      bool isAtom(){
150        return objType_ == otAtom || objType_ == otDAtom;
151      }
152  
153      /**
154 <     * Tests if this stuntdouble is an directional atom
155 <     * @return true if this stuntdouble is an directional atom, return false otherwise
154 >     * Tests if this stuntDouble is an directional atom
155 >     * @return true if this stuntDouble is an directional atom, return false otherwise
156       */
157      bool isDirectionalAtom(){
158        return objType_ == otDAtom;
159      }
160  
161      /**
162 <     * Tests if this stuntdouble is a rigid body.
163 <     * @return true if this stuntdouble is a rigid body, otherwise return false
162 >     * Tests if this stuntDouble is a rigid body.
163 >     * @return true if this stuntDouble is a rigid body, otherwise return false
164       */
165      bool isRigidBody(){
166        return objType_ == otRigidBody;
167      }
168  
169      /**
170 <     * Tests if this stuntdouble is a directional one.
171 <     * @return true is this stuntdouble is a directional atom or a rigid body, return false otherwise
170 >     * Tests if this stuntDouble is a directional one.
171 >     * @return true is this stuntDouble is a directional atom or a rigid body, return false otherwise
172       */
173      bool isDirectional(){
174        return isDirectionalAtom() || isRigidBody();
# Line 198 | Line 198 | namespace oopse{
198      }
199  
200      /**
201 <     * Returns the previous position of this stuntdouble
202 <     * @return the position of this stuntdouble
201 >     * Returns the previous position of this stuntDouble
202 >     * @return the position of this stuntDouble
203       */    
204      Vector3d getPrevPos() {
205        return ((snapshotMan_->getPrevSnapshot())->*storage_).position[localIndex_];
206      }
207        
208      /**
209 <     * Returns the current position of this stuntdouble
210 <     * @return the position of this stuntdouble
209 >     * Returns the current position of this stuntDouble
210 >     * @return the position of this stuntDouble
211       */    
212      Vector3d getPos() {
213        return ((snapshotMan_->getCurrentSnapshot())->*storage_).position[localIndex_];
214      }
215  
216      /**
217 <     * Returns the position of this stuntdouble in specified snapshot
218 <     * @return the position of this stuntdouble
217 >     * Returns the position of this stuntDouble in specified snapshot
218 >     * @return the position of this stuntDouble
219       * @param snapshotNo
220       */    
221      Vector3d getPos(int snapshotNo) {
# Line 223 | Line 223 | namespace oopse{
223      }
224  
225      /**
226 <     * Sets  the previous position of this stuntdouble
226 >     * Sets  the previous position of this stuntDouble
227       * @param pos  new position
228       * @see #getPos
229       */        
# Line 232 | Line 232 | namespace oopse{
232      }
233        
234      /**
235 <     * Sets  the current position of this stuntdouble
235 >     * Sets  the current position of this stuntDouble
236       * @param pos  new position
237       */        
238      void setPos(const Vector3d& pos) {
# Line 242 | Line 242 | namespace oopse{
242      }
243  
244      /**
245 <     * Sets  the position of this stuntdouble in specified snapshot
245 >     * Sets  the position of this stuntDouble in specified snapshot
246       * @param pos position to be set
247       * @param snapshotNo
248       * @see #getPos
# Line 254 | Line 254 | namespace oopse{
254      }
255        
256      /**
257 <     * Returns the previous velocity of this stuntdouble
258 <     * @return the velocity of this stuntdouble
257 >     * Returns the previous velocity of this stuntDouble
258 >     * @return the velocity of this stuntDouble
259       */    
260      Vector3d getPrevVel() {
261        return ((snapshotMan_->getPrevSnapshot())->*storage_).velocity[localIndex_];
262      }
263        
264      /**
265 <     * Returns the current velocity of this stuntdouble
266 <     * @return the velocity of this stuntdouble
265 >     * Returns the current velocity of this stuntDouble
266 >     * @return the velocity of this stuntDouble
267       */    
268      Vector3d getVel() {
269        return ((snapshotMan_->getCurrentSnapshot())->*storage_).velocity[localIndex_];
270      }
271  
272      /**
273 <     * Returns the velocity of this stuntdouble in specified snapshot
274 <     * @return the velocity of this stuntdouble
273 >     * Returns the velocity of this stuntDouble in specified snapshot
274 >     * @return the velocity of this stuntDouble
275       * @param snapshotNo
276       */    
277      Vector3d getVel(int snapshotNo) {
# Line 279 | Line 279 | namespace oopse{
279      }
280  
281      /**
282 <     * Sets  the previous velocity of this stuntdouble
282 >     * Sets  the previous velocity of this stuntDouble
283       * @param vel  new velocity
284       * @see #getVel
285       */        
# Line 288 | Line 288 | namespace oopse{
288      }
289        
290      /**
291 <     * Sets  the current velocity of this stuntdouble
291 >     * Sets  the current velocity of this stuntDouble
292       * @param vel  new velocity
293       */        
294      void setVel(const Vector3d& vel) {
# Line 296 | Line 296 | namespace oopse{
296      }
297  
298      /**
299 <     * Sets  the velocity of this stuntdouble in specified snapshot
299 >     * Sets  the velocity of this stuntDouble in specified snapshot
300       * @param vel velocity to be set
301       * @param snapshotNo
302       * @see #getVel
# Line 306 | Line 306 | namespace oopse{
306      }
307  
308      /**
309 <     * Returns the previous rotation matrix of this stuntdouble
310 <     * @return the rotation matrix of this stuntdouble
309 >     * Returns the previous rotation matrix of this stuntDouble
310 >     * @return the rotation matrix of this stuntDouble
311       */    
312      RotMat3x3d getPrevA() {
313        return ((snapshotMan_->getPrevSnapshot())->*storage_).aMat[localIndex_];
314      }
315        
316      /**
317 <     * Returns the current rotation matrix of this stuntdouble
318 <     * @return the rotation matrix of this stuntdouble
317 >     * Returns the current rotation matrix of this stuntDouble
318 >     * @return the rotation matrix of this stuntDouble
319       */    
320      RotMat3x3d getA() {
321        return ((snapshotMan_->getCurrentSnapshot())->*storage_).aMat[localIndex_];
322      }
323  
324      /**
325 <     * Returns the rotation matrix of this stuntdouble in specified snapshot
325 >     * Returns the rotation matrix of this stuntDouble in specified snapshot
326       *
327 <     * @return the rotation matrix of this stuntdouble
327 >     * @return the rotation matrix of this stuntDouble
328       * @param snapshotNo
329       */    
330      RotMat3x3d getA(int snapshotNo) {
# Line 332 | Line 332 | namespace oopse{
332      }
333  
334      /**
335 <     * Sets  the previous rotation matrix of this stuntdouble
335 >     * Sets  the previous rotation matrix of this stuntDouble
336       * @param a  new rotation matrix
337       * @see #getA
338       */        
# Line 341 | Line 341 | namespace oopse{
341      }
342        
343      /**
344 <     * Sets  the current rotation matrix of this stuntdouble
344 >     * Sets  the current rotation matrix of this stuntDouble
345       * @param a  new rotation matrix
346       */        
347      virtual void setA(const RotMat3x3d& a) {
# Line 349 | Line 349 | namespace oopse{
349      }
350  
351      /**
352 <     * Sets  the rotation matrix of this stuntdouble in specified snapshot
352 >     * Sets  the rotation matrix of this stuntDouble in specified snapshot
353       * @param a rotation matrix to be set
354       * @param snapshotNo
355       * @see #getA
# Line 359 | Line 359 | namespace oopse{
359      }      
360  
361      /**
362 <     * Returns the previous angular momentum of this stuntdouble (body-fixed).
363 <     * @return the angular momentum of this stuntdouble
362 >     * Returns the previous angular momentum of this stuntDouble (body-fixed).
363 >     * @return the angular momentum of this stuntDouble
364       */    
365      Vector3d getPrevJ() {
366        return ((snapshotMan_->getPrevSnapshot())->*storage_).angularMomentum[localIndex_];
367      }
368        
369      /**
370 <     * Returns the current angular momentum of this stuntdouble (body -fixed).
371 <     * @return the angular momentum of this stuntdouble
370 >     * Returns the current angular momentum of this stuntDouble (body -fixed).
371 >     * @return the angular momentum of this stuntDouble
372       */    
373      Vector3d getJ() {
374        return ((snapshotMan_->getCurrentSnapshot())->*storage_).angularMomentum[localIndex_];
375      }
376  
377      /**
378 <     * Returns the angular momentum of this stuntdouble in specified snapshot (body-fixed).
379 <     * @return the angular momentum of this stuntdouble
378 >     * Returns the angular momentum of this stuntDouble in specified snapshot (body-fixed).
379 >     * @return the angular momentum of this stuntDouble
380       * @param snapshotNo
381       */    
382      Vector3d getJ(int snapshotNo) {
# Line 384 | Line 384 | namespace oopse{
384      }
385  
386      /**
387 <     * Sets  the previous angular momentum of this stuntdouble (body-fixed).
387 >     * Sets  the previous angular momentum of this stuntDouble (body-fixed).
388       * @param angMom  new angular momentum
389       * @see #getJ
390       */        
# Line 393 | Line 393 | namespace oopse{
393      }
394        
395      /**
396 <     * Sets  the current angular momentum of this stuntdouble (body-fixed).
396 >     * Sets  the current angular momentum of this stuntDouble (body-fixed).
397       * @param angMom  new angular momentum
398       */        
399      void setJ(const Vector3d& angMom) {
# Line 401 | Line 401 | namespace oopse{
401      }
402  
403      /**
404 <     * Sets the angular momentum of this stuntdouble in specified snapshot(body-fixed).
404 >     * Sets the angular momentum of this stuntDouble in specified snapshot(body-fixed).
405       * @param angMom angular momentum to be set
406       * @param snapshotNo
407       * @see #getJ
# Line 411 | Line 411 | namespace oopse{
411      }
412      
413      /**
414 <     * Returns system Center of Mass for stuntdouble frame from snapshot
414 >     * Returns system Center of Mass for stuntDouble frame from snapshot
415       *
416       */
417      Vector3d getCOM(){
# Line 419 | Line 419 | namespace oopse{
419      }
420      
421      /**
422 <      * Returns system Center of Mass velocity for stuntdouble frame from snapshot
422 >      * Returns system Center of Mass velocity for stuntDouble frame from snapshot
423       *
424       */
425      
# Line 428 | Line 428 | namespace oopse{
428      }
429      
430      /**
431 <      * Returns system Center of Mass angular momentum for stuntdouble frame from snapshot
431 >      * Returns system Center of Mass angular momentum for stuntDouble frame from snapshot
432       *
433       */
434      Vector3d getCOMw(){
# Line 436 | Line 436 | namespace oopse{
436      }
437      
438   /**
439 <     * Returns system Center of Mass for stuntdouble frame from snapshot
439 >     * Returns system Center of Mass for stuntDouble frame from snapshot
440       *
441       */
442      Vector3d getCOM(int snapshotNo){
# Line 444 | Line 444 | namespace oopse{
444      }
445      
446      /**
447 <      * Returns system Center of Mass velocity for stuntdouble frame from snapshot
447 >      * Returns system Center of Mass velocity for stuntDouble frame from snapshot
448       *
449       */
450      
# Line 453 | Line 453 | namespace oopse{
453      }
454      
455      /**
456 <      * Returns system Center of Mass angular momentum for stuntdouble frame from snapshot
456 >      * Returns system Center of Mass angular momentum for stuntDouble frame from snapshot
457       *
458       */
459      Vector3d getCOMw(int snapshotNo){
# Line 461 | Line 461 | namespace oopse{
461      }
462  
463      /**
464 <     * Returns the previous quaternion of this stuntdouble
465 <     * @return the quaternion of this stuntdouble
464 >     * Returns the previous quaternion of this stuntDouble
465 >     * @return the quaternion of this stuntDouble
466       */    
467      Quat4d getPrevQ() {
468        return ((snapshotMan_->getPrevSnapshot())->*storage_).aMat[localIndex_].toQuaternion();
469      }
470        
471      /**
472 <     * Returns the current quaternion of this stuntdouble
473 <     * @return the quaternion of this stuntdouble
472 >     * Returns the current quaternion of this stuntDouble
473 >     * @return the quaternion of this stuntDouble
474       */    
475      Quat4d getQ() {
476        return ((snapshotMan_->getCurrentSnapshot())->*storage_).aMat[localIndex_].toQuaternion();
477      }
478  
479      /**
480 <     * Returns the quaternion of this stuntdouble in specified snapshot
481 <     * @return the quaternion of this stuntdouble
480 >     * Returns the quaternion of this stuntDouble in specified snapshot
481 >     * @return the quaternion of this stuntDouble
482       * @param snapshotNo
483       */    
484      Quat4d getQ(int snapshotNo) {
# Line 486 | Line 486 | namespace oopse{
486      }
487  
488      /**
489 <     * Sets  the previous quaternion of this stuntdouble
489 >     * Sets  the previous quaternion of this stuntDouble
490       * @param q  new quaternion
491       * @note actual storage data is rotation matrix
492       */        
# Line 495 | Line 495 | namespace oopse{
495      }
496        
497      /**
498 <     * Sets  the current quaternion of this stuntdouble
498 >     * Sets  the current quaternion of this stuntDouble
499       * @param q  new quaternion
500       * @note actual storage data is rotation matrix
501       */        
# Line 504 | Line 504 | namespace oopse{
504      }
505  
506      /**
507 <     * Sets  the quaternion of this stuntdouble in specified snapshot
507 >     * Sets  the quaternion of this stuntDouble in specified snapshot
508       *
509       * @param q quaternion to be set
510       * @param snapshotNo
# Line 515 | Line 515 | namespace oopse{
515      }
516  
517      /**
518 <     * Returns the previous euler angles of this stuntdouble
519 <     * @return the euler angles of this stuntdouble
518 >     * Returns the previous euler angles of this stuntDouble
519 >     * @return the euler angles of this stuntDouble
520       */    
521      Vector3d getPrevEuler() {
522        return ((snapshotMan_->getPrevSnapshot())->*storage_).aMat[localIndex_].toEulerAngles();
523      }
524        
525      /**
526 <     * Returns the current euler angles of this stuntdouble
527 <     * @return the euler angles of this stuntdouble
526 >     * Returns the current euler angles of this stuntDouble
527 >     * @return the euler angles of this stuntDouble
528       */    
529      Vector3d getEuler() {
530        return ((snapshotMan_->getCurrentSnapshot())->*storage_).aMat[localIndex_].toEulerAngles();
531      }
532  
533      /**
534 <     * Returns the euler angles of this stuntdouble in specified snapshot.
535 <     * @return the euler angles of this stuntdouble
534 >     * Returns the euler angles of this stuntDouble in specified snapshot.
535 >     * @return the euler angles of this stuntDouble
536       * @param snapshotNo
537       */    
538      Vector3d getEuler(int snapshotNo) {
# Line 540 | Line 540 | namespace oopse{
540      }
541  
542      /**
543 <     * Sets  the previous euler angles of this stuntRealType.
543 >     * Sets  the previous euler angles of this stuntDouble.
544       * @param euler  new euler angles
545       * @see #getEuler
546       * @note actual storage data is rotation matrix        
# Line 550 | Line 550 | namespace oopse{
550      }
551        
552      /**
553 <     * Sets  the current euler angles of this stuntdouble
553 >     * Sets  the current euler angles of this stuntDouble
554       * @param euler  new euler angles
555       */        
556      void setEuler(const Vector3d& euler) {
# Line 558 | Line 558 | namespace oopse{
558      }
559  
560      /**
561 <     * Sets  the euler angles  of this stuntdouble in specified snapshot
561 >     * Sets  the euler angles  of this stuntDouble in specified snapshot
562       *
563       * @param euler euler angles to be set
564       * @param snapshotNo
# Line 569 | Line 569 | namespace oopse{
569      }
570        
571      /**
572 <     * Returns the previous unit vectors of this stuntdouble
573 <     * @return the unit vectors of this stuntdouble
572 >     * Returns the previous unit vectors of this stuntDouble
573 >     * @return the unit vectors of this stuntDouble
574       */    
575      RotMat3x3d getPrevElectroFrame() {
576        return ((snapshotMan_->getPrevSnapshot())->*storage_).electroFrame[localIndex_];
577      }
578        
579      /**
580 <     * Returns the current unit vectors of this stuntdouble
581 <     * @return the unit vectors of this stuntdouble
580 >     * Returns the current unit vectors of this stuntDouble
581 >     * @return the unit vectors of this stuntDouble
582       */    
583      RotMat3x3d getElectroFrame() {
584        return ((snapshotMan_->getCurrentSnapshot())->*storage_).electroFrame[localIndex_];
585      }
586  
587      /**
588 <     * Returns the unit vectors of this stuntdouble in specified snapshot
588 >     * Returns the unit vectors of this stuntDouble in specified snapshot
589       *
590 <     * @return the unit vectors of this stuntdouble
590 >     * @return the unit vectors of this stuntDouble
591       * @param snapshotNo
592       */    
593      RotMat3x3d getElectroFrame(int snapshotNo) {
# Line 595 | Line 595 | namespace oopse{
595      }
596  
597      /**
598 <     * Returns the previous force of this stuntdouble
599 <     * @return the force of this stuntdouble
598 >     * Returns the previous force of this stuntDouble
599 >     * @return the force of this stuntDouble
600       */    
601      Vector3d getPrevFrc() {
602        return ((snapshotMan_->getPrevSnapshot())->*storage_).force[localIndex_];
603      }
604        
605      /**
606 <     * Returns the current force of this stuntdouble
607 <     * @return the force of this stuntdouble
606 >     * Returns the current force of this stuntDouble
607 >     * @return the force of this stuntDouble
608       */    
609      Vector3d getFrc() {
610        return ((snapshotMan_->getCurrentSnapshot())->*storage_).force[localIndex_];
611      }
612  
613      /**
614 <     * Returns the force of this stuntdouble in specified snapshot
614 >     * Returns the force of this stuntDouble in specified snapshot
615       *
616 <     * @return the force of this stuntdouble
616 >     * @return the force of this stuntDouble
617       * @param snapshotNo
618       */    
619      Vector3d getFrc(int snapshotNo) {
# Line 621 | Line 621 | namespace oopse{
621      }
622  
623      /**
624 <     * Sets  the previous force of this stuntdouble
624 >     * Sets  the previous force of this stuntDouble
625       *
626       * @param frc  new force
627       * @see #getFrc
# Line 631 | Line 631 | namespace oopse{
631      }
632        
633      /**
634 <     * Sets  the current force of this stuntdouble
634 >     * Sets  the current force of this stuntDouble
635       * @param frc  new force
636       */        
637      void setFrc(const Vector3d& frc) {
# Line 639 | Line 639 | namespace oopse{
639      }
640  
641      /**
642 <     * Sets  the force of this stuntdouble in specified snapshot
642 >     * Sets  the force of this stuntDouble in specified snapshot
643       *
644       * @param frc force to be set
645       * @param snapshotNo
# Line 650 | Line 650 | namespace oopse{
650      }
651  
652      /**
653 <     * Adds force into the previous force of this stuntdouble
653 >     * Adds force into the previous force of this stuntDouble
654       *
655       * @param frc  new force
656       * @see #getFrc
# Line 660 | Line 660 | namespace oopse{
660      }
661        
662      /**
663 <     * Adds force into the current force of this stuntdouble
663 >     * Adds force into the current force of this stuntDouble
664       * @param frc  new force
665       */        
666      void addFrc(const Vector3d& frc) {
# Line 668 | Line 668 | namespace oopse{
668      }
669  
670      /**
671 <     * Adds force into the force of this stuntdouble in specified snapshot
671 >     * Adds force into the force of this stuntDouble in specified snapshot
672       *
673       * @param frc force to be set
674       * @param snapshotNo
# Line 679 | Line 679 | namespace oopse{
679      }
680  
681      /**
682 <     * Returns the previous torque of this stuntdouble
683 <     * @return the torque of this stuntdouble
682 >     * Returns the previous torque of this stuntDouble
683 >     * @return the torque of this stuntDouble
684       */    
685      Vector3d getPrevTrq() {
686        return ((snapshotMan_->getPrevSnapshot())->*storage_).torque[localIndex_];
687      }
688        
689      /**
690 <     * Returns the current torque of this stuntdouble
691 <     * @return the torque of this stuntdouble
690 >     * Returns the current torque of this stuntDouble
691 >     * @return the torque of this stuntDouble
692       */    
693      Vector3d getTrq() {
694        return ((snapshotMan_->getCurrentSnapshot())->*storage_).torque[localIndex_];
695      }
696  
697      /**
698 <     * Returns the torque of this stuntdouble in specified snapshot
698 >     * Returns the torque of this stuntDouble in specified snapshot
699       *
700 <     * @return the torque of this stuntdouble
700 >     * @return the torque of this stuntDouble
701       * @param snapshotNo
702       */    
703      Vector3d getTrq(int snapshotNo) {
# Line 705 | Line 705 | namespace oopse{
705      }
706  
707      /**
708 <     * Sets  the previous torque of this stuntdouble
708 >     * Sets  the previous torque of this stuntDouble
709       *
710       * @param trq  new torque
711       * @see #getTrq
# Line 715 | Line 715 | namespace oopse{
715      }
716        
717      /**
718 <     * Sets  the current torque of this stuntdouble
718 >     * Sets  the current torque of this stuntDouble
719       * @param trq  new torque
720       */        
721      void setTrq(const Vector3d& trq) {
# Line 723 | Line 723 | namespace oopse{
723      }
724  
725      /**
726 <     * Sets  the torque of this stuntdouble in specified snapshot
726 >     * Sets  the torque of this stuntDouble in specified snapshot
727       *
728       * @param trq torque to be set
729       * @param snapshotNo
# Line 734 | Line 734 | namespace oopse{
734      }
735  
736      /**
737 <     * Adds torque into the previous torque of this stuntdouble
737 >     * Adds torque into the previous torque of this stuntDouble
738       *
739       * @param trq  new torque
740       * @see #getTrq
# Line 744 | Line 744 | namespace oopse{
744      }
745        
746      /**
747 <     * Adds torque into the current torque of this stuntdouble
747 >     * Adds torque into the current torque of this stuntDouble
748       * @param trq  new torque
749       */        
750      void addTrq(const Vector3d& trq) {
# Line 752 | Line 752 | namespace oopse{
752      }
753  
754      /**
755 <     * Adds torque into the torque of this stuntdouble in specified snapshot
755 >     * Adds torque into the torque of this stuntDouble in specified snapshot
756       *
757       * @param trq torque to be add
758       * @param snapshotNo
# Line 764 | Line 764 | namespace oopse{
764  
765  
766      /**
767 <     * Returns the previous z-angle of this stuntdouble
768 <     * @return the z-angle of this stuntdouble
767 >     * Returns the previous z-angle of this stuntDouble
768 >     * @return the z-angle of this stuntDouble
769       */    
770      RealType getPrevZangle() {
771        return ((snapshotMan_->getPrevSnapshot())->*storage_).zAngle[localIndex_];
772      }
773        
774      /**
775 <     * Returns the current z-angle of this stuntdouble
776 <     * @return the z-angle of this stuntdouble
775 >     * Returns the current z-angle of this stuntDouble
776 >     * @return the z-angle of this stuntDouble
777       */    
778      RealType getZangle() {
779        return ((snapshotMan_->getCurrentSnapshot())->*storage_).zAngle[localIndex_];
780      }
781  
782      /**
783 <     * Returns the z-angle of this stuntdouble in specified snapshot
784 <     * @return the z-angle of this stuntdouble
783 >     * Returns the z-angle of this stuntDouble in specified snapshot
784 >     * @return the z-angle of this stuntDouble
785       * @param snapshotNo
786       */    
787      RealType getZangle(int snapshotNo) {
# Line 789 | Line 789 | namespace oopse{
789      }
790  
791      /**
792 <     * Sets  the previous z-angle of this stuntdouble
792 >     * Sets  the previous z-angle of this stuntDouble
793       * @param angle  new z-angle
794       * @see #getZangle
795       */        
# Line 798 | Line 798 | namespace oopse{
798      }
799        
800      /**
801 <     * Sets  the current z-angle of this stuntdouble
801 >     * Sets  the current z-angle of this stuntDouble
802       * @param angle  new z-angle
803       */        
804      void setZangle(RealType angle) {
# Line 806 | Line 806 | namespace oopse{
806      }
807  
808      /**
809 <     * Sets  the z-angle of this stuntdouble in specified snapshot
809 >     * Sets  the z-angle of this stuntDouble in specified snapshot
810       * @param angle z-angle to be set
811       * @param snapshotNo
812       * @see #getZangle
# Line 816 | Line 816 | namespace oopse{
816      }
817  
818      /**
819 <     * Adds z-angle into the previous z-angle of this stuntdouble
819 >     * Adds z-angle into the previous z-angle of this stuntDouble
820       * @param angle  new z-angle
821       * @see #getZangle
822       */        
# Line 825 | Line 825 | namespace oopse{
825      }
826        
827      /**
828 <     * Adds z-angle into the current z-angle of this stuntdouble
828 >     * Adds z-angle into the current z-angle of this stuntDouble
829       * @param angle  new z-angle
830       */        
831      void addZangle(RealType angle) {
# Line 833 | Line 833 | namespace oopse{
833      }
834  
835      /**
836 <     * Adds z-angle into the z-angle of this stuntdouble in specified snapshot
836 >     * Adds z-angle into the z-angle of this stuntDouble in specified snapshot
837       * @param angle z-angle to be add
838       * @param snapshotNo
839       * @see #getZangle
# Line 842 | Line 842 | namespace oopse{
842        ((snapshotMan_->getSnapshot(snapshotNo))->*storage_).zAngle[localIndex_] += angle;
843      }      
844  
845 <    /** Set the force of this stuntdouble to zero */
845 >    /** Set the force of this stuntDouble to zero */
846      void zeroForcesAndTorques();
847      /**
848 <     * Returns the inertia tensor of this stuntdouble
849 <     * @return the inertia tensor of this stuntdouble
848 >     * Returns the inertia tensor of this stuntDouble
849 >     * @return the inertia tensor of this stuntDouble
850       */
851      virtual Mat3x3d getI() = 0;
852  
853      /**
854 <     * Returns the gradient of this stuntdouble
855 <     * @return the gradient of this stuntdouble
854 >     * Returns the gradient of this stuntDouble
855 >     * @return the gradient of this stuntDouble
856       */
857      virtual std::vector<RealType> getGrad() = 0;
858  
859      /**
860 <     * Tests the  if this stuntdouble is a  linear rigidbody
860 >     * Tests the  if this stuntDouble is a  linear rigidbody
861       *
862 <     * @return true if this stuntdouble is a  linear rigidbody, otherwise return false
862 >     * @return true if this stuntDouble is a  linear rigidbody, otherwise return false
863       * @note atom and directional atom will always return false
864       *
865       * @see #linearAxis
# Line 879 | Line 879 | namespace oopse{
879        return linearAxis_;
880      }
881  
882 <    /** Returns the mass of this stuntdouble */
882 >    /** Returns the mass of this stuntDouble */
883      RealType getMass() {
884        return mass_;
885      }
# Line 892 | Line 892 | namespace oopse{
892        mass_ = mass;
893      }
894  
895 <    /** Returns the name of this stuntdouble */
895 >    /** Returns the name of this stuntDouble */
896      virtual std::string getType() = 0;
897          
898 <    /** Sets the name of this stuntRealType*/
898 >    /** Sets the name of this stuntDouble*/
899      virtual void setType(const std::string& name) {}
900  
901      /**
# Line 923 | Line 923 | namespace oopse{
923      Vector3d body2Lab(const Vector3d& v, int frame){
924        return getA(frame).transpose() * v;
925      }
926 +
927      /**
928 +     * Returns the previous particle potential of this stuntDouble
929 +     * @return the particle potential of this stuntDouble
930 +     */    
931 +    RealType getPrevParticlePot() {
932 +      return ((snapshotMan_->getPrevSnapshot())->*storage_).particlePot[localIndex_];
933 +    }
934 +      
935 +    /**
936 +     * Returns the current particle potential of this stuntDouble
937 +     * @return the particle potential of this stuntDouble
938 +     */    
939 +    RealType getParticlePot() {
940 +      return ((snapshotMan_->getCurrentSnapshot())->*storage_).particlePot[localIndex_];
941 +    }
942 +
943 +    /**
944 +     * Returns the particle potential of this stuntDouble in specified snapshot
945 +     * @return the particle potential of this stuntDouble
946 +     * @param snapshotNo
947 +     */    
948 +    RealType getParticlePot(int snapshotNo) {
949 +      return ((snapshotMan_->getSnapshot(snapshotNo))->*storage_).particlePot[localIndex_];
950 +    }
951 +
952 +    /**
953 +     * Sets  the previous particle potential of this stuntDouble
954 +     * @param po tnew particle potential
955 +     * @see #getParticlePot
956 +     */        
957 +    void setPrevParticlePot(RealType pot) {
958 +      ((snapshotMan_->getPrevSnapshot())->*storage_).particlePot[localIndex_] = pot;
959 +    }
960 +      
961 +    /**
962 +     * Sets  the current velocity of this stuntDouble
963 +     * @param vel  new velocity
964 +     */        
965 +    void setParticlePot(RealType pot) {
966 +      ((snapshotMan_->getCurrentSnapshot())->*storage_).particlePot[localIndex_] = pot;
967 +    }
968 +
969 +    /**
970 +     * Sets  the particle potential of this stuntDouble in specified snapshot
971 +     * @param pot potential to be set
972 +     * @param snapshotNo
973 +     * @see #getVel
974 +     */        
975 +    void setParticlePot(RealType pot, int snapshotNo) {
976 +      ((snapshotMan_->getSnapshot(snapshotNo))->*storage_).particlePot[localIndex_] = pot;
977 +    }
978 +
979 +    /**
980       * <p>
981       * The purpose of the Visitor Pattern is to encapsulate an operation that you want to perform on
982       * the elements of a data structure. In this way, you can change the operation being performed

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines