AbstractOdeSystemWithAnalyticJacobian.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2010
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 
00029 
00030 #ifndef _ABSTRACTODESYSTEMWITHANALYTICJACOBIAN_HPP_
00031 #define _ABSTRACTODESYSTEMWITHANALYTICJACOBIAN_HPP_
00032 
00033 #include "Exception.hpp"
00034 #include "AbstractOdeSystem.hpp"
00035 
00042 class AbstractOdeSystemWithAnalyticJacobian : public AbstractOdeSystem
00043 {
00044 public:
00045 
00051     AbstractOdeSystemWithAnalyticJacobian(unsigned numberOfStateVariables = 0)
00052         : AbstractOdeSystem(numberOfStateVariables)
00053     {
00054         mUseAnalyticJacobian = true;
00055     }
00056 
00065     virtual void AnalyticJacobian(const std::vector<double>& rSolutionGuess,
00066                                   double** jacobian,
00067                                   double time,
00068                                   double timeStep) = 0;
00069 
00070 };
00071 
00072 #endif //_ABSTRACTODESYSTEMWITHANALYTICJACOBIAN_HPP_

Generated by  doxygen 1.6.2