Tempus_StepperRKAppAction.hpp

Go to the documentation of this file.

// @HEADER
// ****************************************************************************
//                Tempus: Copyright (2017) Sandia Corporation
//
// Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
// ****************************************************************************
// @HEADER

#ifndef Tempus_StepperRKAppAction_hpp
#define Tempus_StepperRKAppAction_hpp

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


namespace Tempus {

// Forward Declaration for recursive includes (this AppAction <--> Stepper)
template<class Scalar> class StepperRKBase;

/** \brief Application Action for StepperRKBase.
 *
 *  This class provides a means to apply various actions with the
 *  RK time step.  The data available to this class is solution
 *  variables (through SolutionHistory), and stepper data (through
 *  the Stepper).  It allows the application to just observe this
 *  data (i.e., use but not change the data) to change any of it
 *  (USER BEWARE!).
 *
 *  The locations of the RK AppActions (ACTION_LOCATION) in takeStep
 *  are documented in each of the RK Algorithm sections:
 *  StepperExplicitRK, StepperDIRK and StepperIMEX_RK.
 */
template<class Scalar>
class StepperRKAppAction
{
public:

  /// Indicates the location of application action (see algorithm).
  enum ACTION_LOCATION {
    BEGIN_STEP,           ///< At the beginning of the step.
    BEGIN_STAGE,          ///< At the beginning of the stage.
    BEFORE_SOLVE,         ///< Before the implicit solve.
    AFTER_SOLVE,          ///< After the implicit solve.
    BEFORE_EXPLICIT_EVAL, ///< Before the explicit evaluation.
    END_STAGE,            ///< At the end of the stage.
    END_STEP              ///< At the end of the step.
  };

  /// Constructor
  StepperRKAppAction(){}

  /// Destructor
  virtual ~StepperRKAppAction(){}

  /// Execute application action for RK Stepper.
  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