Tempus_StepperRKAppAction.hpp

Go to the documentation of this file.

//@HEADER
// *****************************************************************************
//          Tempus: Time Integration and Sensitivity Analysis Package
//
// Copyright 2017 NTESS and the Tempus contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
//@HEADER

#ifndef Tempus_StepperRKAppAction_hpp
#define Tempus_StepperRKAppAction_hpp

#include "Tempus_config.hpp"
#include "Tempus_SolutionHistory.hpp"

namespace Tempus {

// Forward Declaration
template <class Scalar>
class StepperRKBase;

template <class Scalar>
class StepperRKAppAction {
 public:
  enum ACTION_LOCATION {
    BEGIN_STEP,            
    BEGIN_STAGE,           
    BEFORE_SOLVE,          
    AFTER_SOLVE,           
    BEFORE_EXPLICIT_EVAL,  
    END_STAGE,             
    END_STEP               
  };

  StepperRKAppAction() {}

  virtual ~StepperRKAppAction() {}

  virtual void execute(
      Teuchos::RCP<SolutionHistory<Scalar> > sh,
      Teuchos::RCP<StepperRKBase<Scalar> > stepper,
      const typename StepperRKAppAction<Scalar>::ACTION_LOCATION actLoc) = 0;
};

}  // namespace Tempus

#endif  // Tempus_StepperRKAppAction_hpp