[Csp-commits] APPLICATIONS/CSPSim/Include DynamicalSystem.h,1.7,1.8

[<mk...@us...>]

Update of /cvsroot/csp/APPLICATIONS/CSPSim/Include
In directory sc8-pr-cvs1:/tmp/cvs-serv3557

Modified Files:
	DynamicalSystem.h 
Log Message:


Index: DynamicalSystem.h
===================================================================
RCS file: /cvsroot/csp/APPLICATIONS/CSPSim/Include/DynamicalSystem.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** DynamicalSystem.h	19 Jul 2003 14:08:25 -0000	1.7
--- DynamicalSystem.h	19 Jul 2003 14:14:23 -0000	1.8
***************
*** 31,40 ****
  #include "NumericalMethod.h"
  
! class DynamicalSystem: public VectorField {
  	NumericalMethod* _numericalMethod;
  public:
  	DynamicalSystem(unsigned short dimension = 0);
  	virtual ~DynamicalSystem();
  	void setNumericalMethod(NumericalMethod* pnumericalMethod);
  	std::vector<double> const& flow(std::vector<double>& y0, double t0, double dt) const;
  };
--- 31,63 ----
  #include "NumericalMethod.h"
  
! 
! /**
!  * DynamicalSystem is a base class for physics models that can
!  * be solved by numerical integration.  The dynamical variables
!  * are stored in a vector field, and are integrated by an 
!  * associated numerical method (e.g. Runge-Kutta).  The _f()
!  * function of VectorField provides the driving term, which
!  * must be implemented in derived classes.  Implementations of 
!  * _f() typically involve evaluation of one or more BaseDynamics
!  * instances to determine the total force and moment acting on
!  * the body at each instant.
!  *
!  */
! class DynamicalSystem: protected VectorField {
  	NumericalMethod* _numericalMethod;
  public:
  	DynamicalSystem(unsigned short dimension = 0);
  	virtual ~DynamicalSystem();
+ 	
+ 	/**
+ 	 * Set the numerical integration method used to integrate
+ 	 * the equations of motion.
+ 	 */
  	void setNumericalMethod(NumericalMethod* pnumericalMethod);
+ 
+ 	/**
+ 	 * Integrate the model over a specified time interval (dt) given
+ 	 * a set of initial conditions (y0, t0).
+ 	 */
  	std::vector<double> const& flow(std::vector<double>& y0, double t0, double dt) const;
  };