time_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 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_TIME_SOLVER_H
#define LIBMESH_TIME_SOLVER_H
 
// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"
 
// C++ includes
#include <memory>
 
namespace libMesh
{
 
// Forward Declarations
class DiffContext;
class DiffSolver;
class DifferentiablePhysics;
class DifferentiableSystem;
class ParameterVector;
class SensitivityData;
class SolutionHistory;
class SystemNorm;
class QoISet;
class AdjointRefinementEstimator;
class ErrorVector;
 
template <typename T>
class LinearSolver;
 
class TimeSolver : public ReferenceCountedObject<TimeSolver>
{
public:
  typedef DifferentiableSystem sys_type;
 
  explicit
  TimeSolver (sys_type & s);
 
  virtual ~TimeSolver ();
 
  virtual void init ();
 
  virtual void init_adjoints ();
 
  virtual void init_data ();
 
  virtual void reinit ();
 
  virtual void solve ();
 
  virtual void advance_timestep ();
 
  virtual std::pair<unsigned int, Real> adjoint_solve (const QoISet & qoi_indices);
 
  virtual void adjoint_advance_timestep ();
 
  virtual void retrieve_timestep();
 
  virtual void integrate_qoi_timestep();
 
  virtual void integrate_adjoint_sensitivity(const QoISet & qois, const ParameterVector & parameter_vector, SensitivityData & sensitivities);
 
#ifdef LIBMESH_ENABLE_AMR
  virtual void integrate_adjoint_refinement_error_estimate(AdjointRefinementEstimator & adjoint_refinement_error_estimator, ErrorVector & QoI_elementwise_error);
#endif // LIBMESH_ENABLE_AMR
 
  virtual bool element_residual (bool request_jacobian,
                                 DiffContext &) = 0;
 
  virtual bool side_residual (bool request_jacobian,
                              DiffContext &) = 0;
 
  virtual bool nonlocal_residual (bool request_jacobian,
                                  DiffContext &) = 0;
 
  virtual void before_timestep () {}
 
  const sys_type & system () const { return _system; }
 
  sys_type & system () { return _system; }
 
  virtual std::unique_ptr<DiffSolver> & diff_solver() { return _diff_solver; }
 
  virtual std::unique_ptr<LinearSolver<Number>> & linear_solver() { return _linear_solver; }
 
  bool quiet;
 
  virtual Real du(const SystemNorm & norm) const = 0;
 
  virtual bool is_steady() const = 0;
 
  unsigned int reduce_deltat_on_diffsolver_failure;
 
  void set_solution_history(const SolutionHistory & _solution_history);
 
  SolutionHistory & get_solution_history();
 
  bool is_adjoint() const
  { return _is_adjoint; }
 
  void set_is_adjoint(bool _is_adjoint_value)
  { _is_adjoint = _is_adjoint_value; }
 
  virtual Real last_completed_timestep_size();
 
protected:
 
  std::unique_ptr<DiffSolver> _diff_solver;
 
  std::unique_ptr<LinearSolver<Number>> _linear_solver;
 
  sys_type & _system;
 
  std::unique_ptr<SolutionHistory> solution_history;
 
  typedef bool (DifferentiablePhysics::*ResFuncType) (bool, DiffContext &);
 
  typedef void (DiffContext::*ReinitFuncType) (Real);
 
  Real last_deltat;
 
private:
 
  bool _is_adjoint;
 
};
 
 
} // namespace libMesh
 
 
#endif // LIBMESH_TIME_SOLVER_H