picard_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://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_PICARD_H_
#define __H2D_SOLVER_PICARD_H_

#include "global.h"
#include "projections/ogprojection.h"
#include "discrete_problem.h"
#include "views/scalar_view.h"

namespace Hermes
{
  namespace Hermes2D
  {
    template<typename Scalar>
    class HERMES_API PicardSolver : public NonlinearSolver<Scalar>, public Hermes::Hermes2D::Mixins::SettableSpaces<Scalar>, public Hermes::Mixins::OutputAttachable, public Hermes::Hermes2D::Mixins::MatrixRhsOutput<Scalar>, public Hermes::Hermes2D::Mixins::StateQueryable
    {
    public:
      PicardSolver();
      PicardSolver(DiscreteProblem<Scalar>* dp);
      PicardSolver(const WeakForm<Scalar>* wf, const Space<Scalar>* space);
      PicardSolver(const WeakForm<Scalar>* wf, Hermes::vector<const Space<Scalar>*> spaces);
      ~PicardSolver();

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

      void set_verbose_output_linear_solver(bool verbose_output_to_set);

      void solve(Scalar* coeff_vec = NULL);

      void solve(Solution<Scalar>* initial_guess);

      void solve(Hermes::vector<Solution<Scalar>*> initial_guess);

      virtual void set_time(double time);
      virtual void set_time_step(double time_step);

      virtual void set_spaces(Hermes::vector<const Space<Scalar>*> spaces);
      virtual void set_space(const Space<Scalar>* space);
      virtual Hermes::vector<const Space<Scalar>*> get_spaces() const;

      void use_Anderson_acceleration(bool to_set);
    
      void set_picard_tol(double tol);
      void set_picard_max_iter(int max_iter);
      void set_num_last_vector_used(int num);
      void set_anderson_beta(double beta);

      void set_weak_formulation(const WeakForm<Scalar>* wf);
    private:
      void init();
      bool verbose_output_linear_solver;

      SparseMatrix<Scalar>* matrix;

      Vector<Scalar>* rhs;

      LinearMatrixSolver<Scalar>* linear_solver;

      const bool own_dp;

      double tol;
      int max_iter;
      int num_last_vectors_used;
      bool anderson_is_on;
      double anderson_beta;
    };
  }
}
#endif