indii/fmri/hemodynamic/BalloonModel.hpp

#ifndef INDII_FMRI_HEMODYNAMIC_BALLOONMODEL_HPP
#define INDII_FMRI_HEMODYNAMIC_BALLOONMODEL_HPP

#include "indii/ml/aux/vector.hpp"
#include "indii/ml/ode/DifferentialModel.hpp"
#include "indii/ml/ode/FunctionCollection.hpp"
#include "indii/ml/ode/ParameterCollection.hpp"

namespace indii {
  namespace fmri {
    namespace hemodynamic {

/**
 * Abstract balloon %model.
 *
 * @author Lawrence Murray <lawrence@indii.org>
 * @version $Rev: 285 $
 * @date $Date: 2007-07-20 17:25:40 +0100 (Fri, 20 Jul 2007) $
 */
class BalloonModel : public indii::ml::ode::DifferentialModel,
    public indii::ml::ode::ParameterCollection,
    public indii::ml::ode::FunctionCollection {
public:
  /**
   * Constructor.
   *
   * @param dimensions Number of state variables.
   * @param numParameters Number of biophysical parameters.
   * @param numFunctions Number of biophysical functions.
   */
  BalloonModel(const unsigned int dimensions, const unsigned int numParameters,
      const unsigned int numFunctions);

  /**
   * Destructor.
   */
  virtual ~BalloonModel();

  /**
   * Provide a suggested initial state. This can be passed to the
   * constructor of the ordinary differential equation solver being
   * used on the %model, such as indii::ml::ode::AdaptiveRungeKutta.
   *
   * @return Suggested initial state for the system.
   */
  virtual indii::ml::aux::vector suggestInitialState() = 0;

};

    }
  }
}

#endif

---