kinsol_interface.h

Go to the documentation of this file.

//-----------------------------------------------------------
//
//    Copyright (C) 2016 by the deal2lkit authors
//
//    This file is part of the deal2lkit library.
//
//    The deal2lkit library is free software; you can use it, 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.
//    The full text of the license can be found in the file LICENSE at
//    the top level of the deal2lkit distribution.
//
//-----------------------------------------------------------

#ifndef _d2k_kinsol_interface_h
#define _d2k_kinsol_interface_h

#include <deal2lkit/config.h>


#ifdef D2K_WITH_SUNDIALS

#include <nvector/nvector_serial.h>
#include <sundials/sundials_math.h>
#include <sundials/sundials_types.h>

#include <deal.II/base/config.h>
#include <deal.II/base/exceptions.h>
#include <deal.II/base/conditional_ostream.h>

#include <deal2lkit/parameter_acceptor.h>
#include <deal2lkit/utilities.h>

#ifdef DEAL_II_WITH_MPI
#include "mpi.h"
#endif

#include <kinsol/kinsol_impl.h>

using namespace dealii;

D2K_NAMESPACE_OPEN

template<typename VEC=Vector<double> >
class KINSOLInterface : public ParameterAcceptor
{
public:

#ifdef DEAL_II_WITH_MPI

  KINSOLInterface(const std::string name="",
                  const MPI_Comm mpi_comm = MPI_COMM_WORLD);

  MPI_Comm get_comm() const ;

#else

  KINSOLInterface(const std::string name="");

#endif

  ~KINSOLInterface();

  virtual void declare_parameters( ParameterHandler &prm );

  void initialize_solver( VEC &initial_guess );

  void set_scaling_vectors( const VEC &uscale, const VEC &fscale );

  void set_constraint_vector( const VEC &constraint );

  int solve( VEC &solution );

  std::function<shared_ptr<VEC>()> create_new_vector;

  std::function<int(const VEC &y, VEC &res)> residual;

  std::function<int(const VEC &y)> setup_jacobian;

  std::function<int(const VEC &res, VEC &dst)> solve_linear_system;

  std::function<int(const VEC &v, VEC &dst )> jacobian_vmult;

private:

  void set_functions_to_trigger_an_assert();

  std::string strategy;

  unsigned int max_iterations;

  double ftol;

  double steptol;

  double mbset;

  unsigned int system_size;

  bool is_initialized;

  bool scaling_is_set;

  unsigned int verbosity;

  bool use_internal_solver;

  N_Vector solution;

  N_Vector u_scale;

  N_Vector f_scale;

#ifdef DEAL_II_WITH_MPI

  unsigned int local_system_size;

  MPI_Comm communicator;
#endif

  ConditionalOStream pcout;

  void *kin_mem;


};

D2K_NAMESPACE_CLOSE

#endif

#endif