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_IMPLICIT_SYSTEM_H
#define LIBMESH_IMPLICIT_SYSTEM_H

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

// C++ includes
#include <cstddef>

namespace libMesh
{

// Forward declarations
template <typename T> class LinearSolver;
template <typename T> class SparseMatrix;



// ------------------------------------------------------------
// ImplicitSystem class definition

class ImplicitSystem : public ExplicitSystem
{
public:

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

  virtual ~ImplicitSystem ();

  typedef ImplicitSystem sys_type;

  sys_type & system () { return *this; }

  typedef ExplicitSystem Parent;

  virtual void clear ();

  virtual void reinit ();

  virtual void assemble ();

  //   /**
  //    * Assembles & solves the linear system Ax=b.
  //    */
  //   virtual void solve ();


  virtual void disable_cache ();

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

  virtual LinearSolver<Number> *get_linear_solver() const;

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

  virtual void release_linear_solver(LinearSolver<Number> *) const;

  virtual void assembly
    (bool /* get_residual */,
     bool /* get_jacobian */,
     bool /* apply_heterogeneous_constraints */ = false)
  { libmesh_not_implemented(); }

  virtual void assemble_residual_derivatives (const ParameterVector& parameters);

  virtual std::pair<unsigned int, Real>
  sensitivity_solve (const ParameterVector& parameters);

  virtual std::pair<unsigned int, Real>
  weighted_sensitivity_solve (const ParameterVector& parameters,
                              const ParameterVector& weights);

  virtual std::pair<unsigned int, Real>
  adjoint_solve (const QoISet& qoi_indices = QoISet());

  virtual std::pair<unsigned int, Real>
  weighted_sensitivity_adjoint_solve (const ParameterVector& parameters,
                                      const ParameterVector& weights,
                                      const QoISet& qoi_indices = QoISet());

  virtual void adjoint_qoi_parameter_sensitivity (const QoISet& qoi_indices,
                                                  const ParameterVector& parameters,
                                                  SensitivityData& sensitivities);

  virtual void forward_qoi_parameter_sensitivity (const QoISet& qoi_indices,
                                                  const ParameterVector& parameters,
                                                  SensitivityData& sensitivities);

  virtual void qoi_parameter_hessian(const QoISet& qoi_indices,
                                     const ParameterVector& parameters,
                                     SensitivityData& hessian);

  virtual void qoi_parameter_hessian_vector_product(const QoISet& qoi_indices,
                                                    const ParameterVector& parameters,
                                                    const ParameterVector& vector,
                                                    SensitivityData& product);

  typedef std::map<std::string, SparseMatrix<Number>* >::iterator        matrices_iterator;
  typedef std::map<std::string, SparseMatrix<Number>* >::const_iterator  const_matrices_iterator;

  SparseMatrix<Number> & add_matrix (const std::string& mat_name);

  bool have_matrix (const std::string& mat_name) const;

  const SparseMatrix<Number> * request_matrix (const std::string& mat_name) const;

  SparseMatrix<Number> * request_matrix (const std::string& mat_name);

  const SparseMatrix<Number> & get_matrix (const std::string& mat_name) const;

  SparseMatrix<Number> & get_matrix (const std::string& mat_name);

  virtual unsigned int n_matrices () const;

  SparseMatrix<Number> * matrix;



protected:

  virtual void init_data ();

  virtual void init_matrices ();



private:

  void add_system_matrix ();

  std::map<std::string, SparseMatrix<Number>* > _matrices;

  bool _can_add_matrices;
};



// ------------------------------------------------------------
// ImplicitSystem inline methods
inline
bool ImplicitSystem::have_matrix (const std::string& mat_name) const
{
  return (_matrices.count(mat_name));
}


inline
unsigned int ImplicitSystem::n_matrices () const
{
  return cast_int<unsigned int>(_matrices.size());
}

} // namespace libMesh

#endif // LIBMESH_IMPLICIT_SYSTEM_H