Tempus_StepperRKModifierXBase.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_StepperRKModifierXBase_hpp
#define Tempus_StepperRKModifierXBase_hpp

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

#include "Teuchos_SerialDenseVector.hpp"

namespace Tempus {

template<class Scalar>
class StepperRKModifierXBase
  : virtual public Tempus::StepperRKAppAction<Scalar>
{
private:

  /* \brief Adaptor execute function
   *
   *  This is an adaptor function to bridge between the AppAction
   *  interface and the ModifierX interface.  It is meant to be private
   *  and non-virtual as deriving from this class should only need to
   *  implement the modify function.
   *
   *  For the ModifierX interface, this adaptor maps the
   *  StepperRKAppAction::ACTION_LOCATION to the
   *  StepperRKModifierX::MODIFIERX_TYPE, and only pass the solution
   *  (\f$x\f$ and/or \f$\dot{x}\f$ and other parameters to the modify
   *  function.
   */
  void execute(
    Teuchos::RCP<SolutionHistory<Scalar> > sh,
    Teuchos::RCP<StepperRKBase<Scalar> > stepper,
    const typename StepperRKAppAction<Scalar>::ACTION_LOCATION actLoc)
  {
    using Teuchos::RCP;

    MODIFIER_TYPE modType = X_BEGIN_STEP;
    const int stageNumber = stepper->getStageNumber();
    Teuchos::SerialDenseVector<int,Scalar> c = stepper->getTableau()->c();
    RCP<SolutionState<Scalar> > workingState = sh->getWorkingState();
    const Scalar dt = workingState->getTimeStep();
    Scalar time = sh->getCurrentState()->getTime();
    if (stageNumber >= 0) time += c(stageNumber)*dt;
    RCP<Thyra::VectorBase<Scalar> > x = workingState->getX();

    switch(actLoc) {
      case StepperRKAppAction<Scalar>::BEGIN_STEP:
      {
        modType = X_BEGIN_STEP;
        break;
      }
      case StepperRKAppAction<Scalar>::BEGIN_STAGE:
      {
        modType = X_BEGIN_STAGE;
        break;
      }
      case StepperRKAppAction<Scalar>::BEFORE_SOLVE:
      {
        modType = X_BEFORE_SOLVE;
        break;
      }
      case StepperRKAppAction<Scalar>::AFTER_SOLVE:
      {
        modType = X_AFTER_SOLVE;
        break;
      }
      case StepperRKAppAction<Scalar>::BEFORE_EXPLICIT_EVAL:
      {
        modType = X_BEFORE_EXPLICIT_EVAL;
        break;
      }
      case StepperRKAppAction<Scalar>::END_STAGE:
      {
        modType = X_END_STAGE;
        break;
      }
      case StepperRKAppAction<Scalar>::END_STEP:
      {
        modType = X_END_STEP;
        time = workingState->getTime();
        break;
      }
      default:
        TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
        "Error - unknown action location.\n");
    }

    this->modify(x, time, dt, stageNumber, modType);
  }

public:

  enum MODIFIER_TYPE {
    X_BEGIN_STEP,           
    X_BEGIN_STAGE,          
    X_BEFORE_SOLVE,         
    X_AFTER_SOLVE,          
    X_BEFORE_EXPLICIT_EVAL, 
    X_END_STAGE,            
    X_END_STEP              
  };

  virtual void modify(
    Teuchos::RCP<Thyra::VectorBase<Scalar> > /* x */,
    const Scalar /* time */, const Scalar /* dt */,
    const int /* stageNumber */,
    const MODIFIER_TYPE modType) = 0;

};

} // namespace Tempus

#endif // Tempus_StepperRKModifierXBase_hpp