unsteady_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_UNSTEADY_SOLVER_H
#define LIBMESH_UNSTEADY_SOLVER_H
 
// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/time_solver.h"
 
// C++ includes
#include <memory>
 
namespace libMesh
{
 
// Forward declarations
template <typename T> class NumericVector;
 
class UnsteadySolver : public TimeSolver
{
public:
  explicit
  UnsteadySolver (sys_type & s);
 
  virtual ~UnsteadySolver ();
 
  virtual void init () override;
 
  virtual void init_adjoints () override;
 
  virtual void init_data () override;
 
  virtual void reinit () override;
 
  virtual void solve () override;
 
  virtual void advance_timestep () override;
 
  void update();
 
  virtual std::pair<unsigned int, Real> adjoint_solve (const QoISet & qoi_indices) override;
 
  virtual void adjoint_advance_timestep () override;
 
  virtual void retrieve_timestep () override;
 
  virtual void integrate_qoi_timestep() override;
 
  virtual void integrate_adjoint_sensitivity(const QoISet & qois, const ParameterVector & parameter_vector, SensitivityData & sensitivities) override;
 
#ifdef LIBMESH_ENABLE_AMR
  virtual void integrate_adjoint_refinement_error_estimate(AdjointRefinementEstimator & /*adjoint_refinement_error_estimator*/, ErrorVector & /*QoI_elementwise_error*/) override;
#endif // LIBMESH_ENABLE_AMR
 
  virtual Real error_order () const = 0;
 
  virtual unsigned int time_order () const = 0;
 
  Number old_nonlinear_solution (const dof_id_type global_dof_number) const;
 
  std::shared_ptr<NumericVector<Number>> old_local_nonlinear_solution;
 
  virtual Real du(const SystemNorm & norm) const override;
 
  virtual bool is_steady() const override { return false; }
 
  void set_first_adjoint_step(bool first_adjoint_step_setting)
  {
    first_adjoint_step = first_adjoint_step_setting;
  }
 
  /*
   * A setter for the first_solver boolean. Useful for example if we are using
   * a nested time solver, and the outer solver wants to tell the inner one that
   * the initial conditions have already been handled.
   */
  void set_first_solve(bool first_solve_setting)
  {
    first_solve = first_solve_setting;
  }
 
protected:
 
  bool first_solve;
 
  bool first_adjoint_step;
 
  std::vector< std::unique_ptr<NumericVector<Number>> > old_adjoints;
 
  Real last_step_deltat;
  Real next_step_deltat;
};
 
 
 
} // namespace libMesh
 
 
#endif // LIBMESH_UNSTEADY_SOLVER_H