multi_dimensional_fixpoint_solver.h

/* Copyright (C) 2004-2012 MBSim Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * Contact: martin.o.foerg@googlemail.com
 */
 
#ifndef NUMERICS_MULTI_DIMENSIONAL_FIXPOINT_SOLVER_H_
#define NUMERICS_MULTI_DIMENSIONAL_FIXPOINT_SOLVER_H_
 
#include <fmatvec/fmatvec.h>
 
#include <mbsim/numerics/functions/criteria_functions.h>
 
namespace MBSim {
 
  class MultiDimensionalFixpointSolver {
    public:
      MultiDimensionalFixpointSolver();
 
      /*
       * \brief constructor
       * \param fct pointer to used fix-point-function
       */
      MultiDimensionalFixpointSolver(Function<fmatvec::Vec(fmatvec::Vec)> *function_);
 
      virtual ~MultiDimensionalFixpointSolver()= default;;
 
      /* GETTER / SETTER */
      void setFunction(Function<fmatvec::Vec(fmatvec::Vec)> *function_) {function = function_;}
      int getInfo() {
        return info;
      }
      std::vector<double> getNorms() {
        return norms;
      }
      double getNumberOfIterations() {
        return iter;
      }
      double getNumberOfMaximalIterations() {
        return itermax;
      }
      void setNumberOfMaximalIterations(int itermax_) {
        itermax = itermax_;
      }
      void setCriteriaFunction(CriteriaFunction * criteria_) {
        criteria = criteria_;
      }
      /*******************/
 
      fmatvec::Vec solve(const fmatvec::Vec &initialGuess);
 
    private:
      Function<fmatvec::Vec(fmatvec::Vec)> *function{0};
 
      /*
       * \brief criteria function
       *
       * This function defines the criteria when to stop the fixpoint iteration
       */
      CriteriaFunction *criteria{0};
 
      int iter{0};
 
      double itermax{1e3};
 
      std::vector<double> norms;
 
      int info{1};
  };
 
} /* namespace MBSim */
#endif /* MULTI_DIMENSIONAL_FIXPOINT_SOLVER_H_ */