Tempus_StepperLeapfrogModifierXBase.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_StepperLeapfrogModifierXBase_hpp
#define Tempus_StepperLeapfrogModifierXBase_hpp

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

namespace Tempus {

template <class Scalar>
class StepperLeapfrogModifierXBase
  : virtual public Tempus::StepperLeapfrogAppAction<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
   *  StepperLeapfrogAppAction::ACTION_LOCATION to the
   *  StepperLeapfrogModifierX::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<StepperLeapfrog<Scalar> > stepper,
      const typename StepperLeapfrogAppAction<Scalar>::ACTION_LOCATION actLoc)
  {
    using Teuchos::RCP;

    MODIFIER_TYPE modType                    = X_BEGIN_STEP;
    RCP<SolutionState<Scalar> > workingState = sh->getWorkingState();
    const Scalar time                        = workingState->getTime();
    const Scalar dt                          = workingState->getTimeStep();
    RCP<Thyra::VectorBase<Scalar> > x;

    switch (actLoc) {
      case StepperLeapfrogAppAction<Scalar>::BEGIN_STEP: {
        modType = X_BEGIN_STEP;
        x       = workingState->getX();
        break;
      }
      case StepperLeapfrogAppAction<Scalar>::BEFORE_X_UPDATE: {
        modType = X_BEFORE_X_UPDATE;
        x       = workingState->getX();
        break;
      }
      case StepperLeapfrogAppAction<Scalar>::BEFORE_EXPLICIT_EVAL: {
        modType = X_BEFORE_EXPLICIT_EVAL;
        x       = workingState->getX();
        break;
      }
      case StepperLeapfrogAppAction<Scalar>::BEFORE_XDOT_UPDATE: {
        modType = X_BEFORE_XDOT_UPDATE;
        x       = workingState->getX();
        break;
      }
      case StepperLeapfrogAppAction<Scalar>::END_STEP: {
        modType = X_END_STEP;
        x       = workingState->getX();
        break;
      }
      default:
        TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
                                   "Error - unknown action location.\n");
    }

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

 public:
  enum MODIFIER_TYPE {
    X_BEGIN_STEP,            
    X_BEFORE_X_UPDATE,       
    X_BEFORE_EXPLICIT_EVAL,  
    X_BEFORE_XDOT_UPDATE,    
    X_END_STEP               
  };

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

}  // namespace Tempus

#endif  // Tempus_StepperLeapfrogModifierXBase_hpp