adaptive_time_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 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/first_order_unsteady_solver.h"

// C++ includes

namespace libMesh
{

// Forward declarations
class System;

class AdaptiveTimeSolver : public FirstOrderUnsteadySolver
{
public:
  typedef FirstOrderUnsteadySolver Parent;

  explicit
  AdaptiveTimeSolver (sys_type & s);

  virtual ~AdaptiveTimeSolver ();

  virtual void init() override;

  virtual void reinit() override;

  virtual void solve() override = 0;

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

  virtual void advance_timestep() override;

  virtual void adjoint_advance_timestep() override;

  virtual void retrieve_timestep() override;

  virtual void integrate_qoi_timestep() override = 0;

  virtual void integrate_adjoint_sensitivity(const QoISet & qois, const ParameterVector & parameter_vector, SensitivityData & sensitivities) override = 0;

#ifdef LIBMESH_ENABLE_AMR
  virtual void integrate_adjoint_refinement_error_estimate(AdjointRefinementEstimator & adjoint_refinement_error_estimator, ErrorVector & QoI_elementwise_error) override = 0;
#endif // LIBMESH_ENABLE_AMR

  virtual Real last_completed_timestep_size() override { return completed_timestep_size; };

  virtual Real error_order () const override;

  virtual bool element_residual (bool get_jacobian,
                                 DiffContext &) override;

  virtual bool side_residual (bool get_jacobian,
                              DiffContext &) override;

  virtual bool nonlocal_residual (bool get_jacobian,
                                  DiffContext &) override;

  virtual std::unique_ptr<DiffSolver> & diff_solver() override;

  virtual std::unique_ptr<LinearSolver<Number>> & linear_solver() override;

  std::unique_ptr<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;

  Real completed_timestep_size;

  bool global_tolerance;

protected:

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


} // namespace libMesh


#endif // LIBMESH_ADAPTIVE_TIME_SOLVER_H