SimpleNewtonNonlinearSolver.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 SIMPLENEWTONNONLINEARSOLVER_HPP_
00031 #define SIMPLENEWTONNONLINEARSOLVER_HPP_
00032 
00033 #include "LinearSystem.hpp"
00034 #include "AbstractNonlinearSolver.hpp"
00035 #include <vector>
00036 
00040 class SimpleNewtonNonlinearSolver : public AbstractNonlinearSolver
00041 {
00042 private :
00043     double mLinearSolverRelativeTolerance;   
00044     double mTolerance;                       
00045     bool mWriteStats;                        
00047     std::vector<double> mTestDampingValues;  
00049 public :
00050 
00056     SimpleNewtonNonlinearSolver(double linearSolverRelativeTolerance = 1e-6);
00057 
00061     virtual ~SimpleNewtonNonlinearSolver();
00062 
00108     virtual Vec Solve(PetscErrorCode (*pComputeResidual)(SNES,Vec,Vec,void*),
00109                       PetscErrorCode (*pComputeJacobian)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),
00110                       Vec initialGuess,
00111                       void* pContext);
00112 
00118     void SetTolerance(double tolerance);
00119 
00125     void SetWriteStats(bool writeStats = true)
00126     {
00127         mWriteStats = writeStats;
00128     }
00129 };
00130 
00131 #endif /*SIMPLENEWTONNONLINEARSOLVER_HPP_*/