adaptive_time_solver.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_ADAPTIVE_TIME_SOLVER_H
#define LIBMESH_ADAPTIVE_TIME_SOLVER_H

// Local includes
#include "libmesh/system_norm.h"
#include "libmesh/unsteady_solver.h"

// C++ includes

namespace libMesh
{

// Forward declarations
class System;

// ------------------------------------------------------------
// Solver class definition
class AdaptiveTimeSolver : public UnsteadySolver
{
public:
  typedef UnsteadySolver Parent;

  explicit
  AdaptiveTimeSolver (sys_type& s);

  virtual ~AdaptiveTimeSolver ();

  virtual void init();

  virtual void reinit();

  virtual void solve() = 0;

  virtual void advance_timestep();

  virtual Real error_order () const;

  virtual bool element_residual (bool get_jacobian,
                                 DiffContext&);

  virtual bool side_residual (bool get_jacobian,
                              DiffContext&);

  virtual bool nonlocal_residual (bool get_jacobian,
                                  DiffContext&);

  virtual UniquePtr<DiffSolver> &diff_solver();

  virtual UniquePtr<LinearSolver<Number> > &linear_solver();

  UniquePtr<UnsteadySolver> core_time_solver;

  SystemNorm component_norm;

  std::vector<float> component_scale;

  Real target_tolerance;

  Real upper_tolerance;

  Real max_deltat;

  Real min_deltat;

  Real max_growth;

  bool global_tolerance;

protected:

  Real last_deltat;

  virtual Real calculate_norm(System &, NumericVector<Number> &);
};


} // namespace libMesh


#endif // LIBMESH_ADAPTIVE_TIME_SOLVER_H