Tempus_StepperBackwardEulerAppActionComposite.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_StepperBackwardEulerAppActionComposite_hpp
#define Tempus_StepperBackwardEulerAppActionComposite_hpp

#include "Tempus_config.hpp"
#include "Tempus_StepperBackwardEulerAppAction.hpp"
#include "Tempus_TimeStepControl.hpp"
#include <vector>

namespace Tempus {

template <class Scalar>
class StepperBackwardEulerAppActionComposite
  : virtual public Tempus::StepperBackwardEulerAppAction<Scalar> {
 public:
  StepperBackwardEulerAppActionComposite();

  virtual ~StepperBackwardEulerAppActionComposite();

  virtual void execute(
      Teuchos::RCP<SolutionHistory<Scalar> > sh,
      Teuchos::RCP<StepperBackwardEuler<Scalar> > stepper,
      const typename StepperBackwardEulerAppAction<Scalar>::ACTION_LOCATION
          actLoc)
  {
    for (auto& a : appActions_) a->execute(sh, stepper, actLoc);
  }

  // Add AppAction to the AppAction vector.
  void addBackwardEulerAppAction(
      Teuchos::RCP<StepperBackwardEulerAppAction<Scalar> > appAction);
  {
    appActions_.push_back(appAction);
  }

  // Clear the AppAction vector.
  void clearBackwardEulerAppActions();
  {
    appActions_.clear();
  }

  // Return the size of the AppAction vector.
  std::size_t getSize() const { return appActions_.size(); }

 private:
  std::vector<Teuchos::RCP<StepperBackwardEulerAppAction<Scalar> > >
      appActions_;
};

}  // namespace Tempus
#endif  // Tempus_StepperBackwardEulerAppActionComposite_hpp