nonlinear_implicit_system.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_NONLINEAR_IMPLICIT_SYSTEM_H
#define LIBMESH_NONLINEAR_IMPLICIT_SYSTEM_H

// Local Includes
#include "libmesh/implicit_system.h"

// C++ includes

namespace libMesh
{


// Forward declarations
class DiffSolver;
template<typename T> class NonlinearSolver;


// ------------------------------------------------------------
// NonlinearImplicitSystem class definition

class NonlinearImplicitSystem : public ImplicitSystem
{
public:

  NonlinearImplicitSystem (EquationSystems& es,
                           const std::string& name,
                           const unsigned int number);

  virtual ~NonlinearImplicitSystem ();

  typedef NonlinearImplicitSystem sys_type;

  typedef ImplicitSystem Parent;

  class ComputeResidual
  {
  public:
    virtual ~ComputeResidual () {}
    virtual void residual (const NumericVector<Number>& X,
                           NumericVector<Number>& R,
                           sys_type& S) = 0;
  };


  class ComputeJacobian
  {
  public:
    virtual ~ComputeJacobian () {}

    virtual void jacobian (const NumericVector<Number>& X,
                           SparseMatrix<Number>& J,
                           sys_type& S) = 0;
  };


  class ComputeBounds
  {
  public:
    virtual ~ComputeBounds () {}

    virtual void bounds (NumericVector<Number>& XL,
                         NumericVector<Number>& XU,
                         sys_type& S) = 0;
  };

  class ComputeVectorSubspace
  {
  public:
    virtual ~ComputeVectorSubspace () {}

    virtual void operator()(std::vector<NumericVector<Number>*>&sp, sys_type& s);
  };

  class ComputeResidualandJacobian
  {
  public:
    virtual ~ComputeResidualandJacobian () {}

    virtual void residual_and_jacobian (const NumericVector<Number>& X,
                                        NumericVector<Number>* R,
                                        SparseMatrix<Number>*  J,
                                        sys_type& S) = 0;
  };

  sys_type & system () { return *this; }

  virtual void clear ();

  virtual void reinit ();

  virtual void solve ();

  virtual std::pair<unsigned int, Real>
  get_linear_solve_parameters() const;

  virtual void assembly(bool get_residual, bool get_jacobian,
                        bool apply_heterogeneous_constraints = false);

  virtual std::string system_type () const { return "NonlinearImplicit"; }

  UniquePtr<NonlinearSolver<Number> > nonlinear_solver;

  UniquePtr<DiffSolver> diff_solver;

  unsigned int n_nonlinear_iterations() const { return _n_nonlinear_iterations; }

  Real final_nonlinear_residual() const { return _final_nonlinear_residual; }

  unsigned get_current_nonlinear_iteration_number() const;


protected:

  void set_solver_parameters();

  unsigned int _n_nonlinear_iterations;

  Real _final_nonlinear_residual;
};



} // namespace libMesh

// ------------------------------------------------------------
// NonlinearImplicitSystem inline methods


#endif // LIBMESH_NONLINEAR_IMPLICIT_SYSTEM_H