Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #pragma once
      11             : 
      12             : // MOOSE includes
      13             : #include "Predictor.h"
      14             : 
      15             : namespace libMesh
      16             : {
      17             : template <typename T>
      18             : class NumericVector;
      19             : }
      20             : 
      21             : /**
      22             :  * Implements an explicit Adams predictor based on two old solution
      23             :  * vectors.
      24             :  */
      25             : class AdamsPredictor : public Predictor
      26             : {
      27             : public:
      28             :   static InputParameters validParams();
      29             : 
      30             :   AdamsPredictor(const InputParameters & parameters);
      31             : 
      32           0 :   virtual int order() override { return _order; }
      33             :   virtual void timestepSetup() override;
      34             :   virtual bool shouldApply() override;
      35             :   virtual void apply(NumericVector<Number> & sln) override;
      36          66 :   virtual NumericVector<Number> & solutionPredictor() override { return _solution_predictor; }
      37             : 
      38             : protected:
      39             :   int _order;
      40             :   NumericVector<Number> & _current_old_solution;
      41             :   NumericVector<Number> & _older_solution;
      42             :   NumericVector<Number> & _oldest_solution;
      43             :   NumericVector<Number> & _tmp_previous_solution;
      44             :   NumericVector<Number> & _tmp_residual_old;
      45             :   NumericVector<Number> & _tmp_third_vector;
      46             :   Real & _dt_older;
      47             :   Real & _dtstorage;
      48             : };