csp-commits

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

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

Modified Files:
	NumericalMethod.h 
Log Message:


Index: NumericalMethod.h
===================================================================
RCS file: /cvsroot/csp/APPLICATIONS/CSPSim/Include/NumericalMethod.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** NumericalMethod.h	30 Jun 2003 22:29:15 -0000	1.7
--- NumericalMethod.h	18 Jul 2003 21:16:41 -0000	1.8
***************
*** 32,50 ****
  
  
  class VectorField
  {
  protected:
  	unsigned short const m_dimension;
  public:
! 	VectorField(unsigned short dimension ):
! 	  m_dimension(dimension) {
! 	  }
  	unsigned short getDimension() const {
  		return m_dimension;
  	}
  	virtual std::vector<double> const& _f(double t, std::vector<double>& y) = 0;
  };
  
  
  class NumericalMethod {
  	bool m_bdeleteVF;
--- 32,74 ----
  
  
+ class NumericalMethod;
+ 
+ /**
+  * A simple class to represent a multidimensional vector
+  * field describing the kinetic parameters of a dynamical
+  * system.
+  */
  class VectorField
  {
+ 	friend class NumericalMethod;
  protected:
  	unsigned short const m_dimension;
  public:
! 	/**
! 	 * Construct a new vector field of the specified dimension.
! 	 */
! 	VectorField(unsigned short dimension):
! 		m_dimension(dimension) 
! 	{
! 	}
! 
! 	/**
! 	 * Return the dimension of the vector field.
! 	 */
  	unsigned short getDimension() const {
  		return m_dimension;
  	}
+ 
+ 	/**
+ 	 * Return the first derivative of the vector field at
+ 	 * the specified point.
+ 	 */
  	virtual std::vector<double> const& _f(double t, std::vector<double>& y) = 0;
  };
  
  
+ /**
+  * Abstract base class for numerical solvers of dynamical systems.
+  */
  class NumericalMethod {
  	bool m_bdeleteVF;