newton_solver.h

// This file is part of Hermes2D
//
// Copyright (c) 2009 hp-FEM group at the University of Nevada, Reno (UNR).
// Email: hpfem-group@unr.edu, home page: http://www.hpfem.org/.
//
// Hermes2D is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published
// by the Free Software Foundation; either version 2 of the License,
// or (at your option) any later version.
//
// Hermes2D is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Hermes2D; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#ifndef __H2D_SOLVER_NEWTON_H_
#define __H2D_SOLVER_NEWTON_H_

#include "solvers/newton_matrix_solver.h"
#include "solver.h"

namespace Hermes
{
  namespace Hermes2D
  {
    // Just call solve().<br>
    // Get the solution vector from the solver.<br>
    // Translate the solution vector into the previously initialized Solution<double> using the static method vector_to_solution.<br>
    template<typename Scalar>
    class HERMES_API NewtonSolver :
      public Hermes::Hermes2D::Solver<Scalar>,
      public Hermes::Solvers::NewtonMatrixSolver < Scalar >
    {
    public:
      NewtonSolver();
      NewtonSolver(DiscreteProblem<Scalar>* dp);
      NewtonSolver(WeakFormSharedPtr<Scalar> wf, SpaceSharedPtr<Scalar> space);
      NewtonSolver(WeakFormSharedPtr<Scalar> wf, std::vector<SpaceSharedPtr<Scalar> > spaces);
      virtual ~NewtonSolver();

      // See the base class for details, the following serves only for avoiding C++ name-hiding.
      using Solver<Scalar>::solve;

      virtual void solve(Scalar* coeff_vec);

      Scalar* get_sln_vector();

      virtual void set_spaces(std::vector<SpaceSharedPtr<Scalar> > spaces);

      virtual void set_weak_formulation(WeakFormSharedPtr<Scalar> wf);

      virtual void set_verbose_output(bool to_set);

      virtual void assemble_residual(bool store_previous_residual);
      virtual bool assemble_jacobian(bool store_previous_jacobian);
      virtual bool assemble(bool store_previous_jacobian, bool store_previous_residual);

      virtual void init_solving(Scalar* coeff_vec);

      virtual bool isOkay() const;
      inline std::string getClassName() const { return "NewtonSolver"; }
    };
  }
}
#endif