Tempus_StepperSubcycling_impl.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_StepperSubcycling_impl_hpp
#define Tempus_StepperSubcycling_impl_hpp

#include "Thyra_VectorStdOps.hpp"

#include "Tempus_StepperForwardEuler.hpp"
#include "Tempus_StepperSubcyclingModifierDefault.hpp"
#include "Tempus_TimeStepControlStrategyConstant.hpp"
#include "Tempus_TimeStepControlStrategyBasicVS.hpp"
#include "Tempus_IntegratorObserverSubcycling.hpp"
#include "Tempus_IntegratorObserverNoOp.hpp"

namespace Tempus {

template <class Scalar>
StepperSubcycling<Scalar>::StepperSubcycling()
{
  using Teuchos::ParameterList;
  using Teuchos::RCP;

  this->setStepperName("Subcycling");
  this->setStepperType("Subcycling");
  this->setUseFSAL(false);
  this->setICConsistency("None");
  this->setICConsistencyCheck(false);

  this->setAppAction(Teuchos::null);
  scIntegrator_ = Teuchos::rcp(new IntegratorBasic<Scalar>());

  scIntegrator_->setObserver(
      Teuchos::rcp(new IntegratorObserverNoOp<Scalar>()));

  RCP<ParameterList> tempusPL = Teuchos::rcp_const_cast<Teuchos::ParameterList>(
      scIntegrator_->getValidParameters());

  {  // Set default subcycling Stepper to Forward Euler.
    tempusPL->sublist("Default Integrator")
        .set("Stepper Name", "Default Subcycling Stepper");
    RCP<ParameterList> stepperPL = Teuchos::parameterList();
    stepperPL->set("Stepper Type", "Forward Euler");
    tempusPL->set("Default Subcycling Stepper", *stepperPL);

    auto stepperFE = Teuchos::rcp(new StepperForwardEuler<Scalar>());
    setSubcyclingStepper(stepperFE);
  }

  // Keep the default SolutionHistory settings:
  //  * 'Storage Type' = "Undo"
  //  * 'Storage Limit' = 2
  // Also
  //  * No checkpointing within the subcycling, but can restart from
  //    failed subcycle step.

  // Keep the default TimeStepControl settings for subcycling:
  //  * Finish exactly on the full timestep.
  //  * No solution output during the subcycling.
  //  * Variable time step size.
  // Set the default initial time step size.
  {
    tempusPL->sublist("Default Integrator")
        .sublist("Time Step Control")
        .set("Initial Time Step", std::numeric_limits<Scalar>::max());
  }

  scIntegrator_->setTimeStepControl();
  this->setSubcyclingPrintDtChanges(false);
}

template <class Scalar>
StepperSubcycling<Scalar>::StepperSubcycling(
    const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
    const Teuchos::RCP<IntegratorBasic<Scalar> >& scIntegrator, bool useFSAL,
    std::string ICConsistency, bool ICConsistencyCheck,
    const Teuchos::RCP<StepperSubcyclingAppAction<Scalar> >& stepperSCAppAction)
{
  this->setStepperName("Subcycling");
  this->setStepperType("Subcycling");
  this->setUseFSAL(useFSAL);
  this->setICConsistency(ICConsistency);
  this->setICConsistencyCheck(ICConsistencyCheck);
  this->setAppAction(stepperSCAppAction);
  scIntegrator_ = scIntegrator;
  this->setSubcyclingPrintDtChanges(false);

  if (appModel != Teuchos::null) {
    this->setModel(appModel);
    this->initialize();
  }
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingStepper(
    Teuchos::RCP<Stepper<Scalar> > stepper)
{
  scIntegrator_->setStepper(stepper);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingMinTimeStep(Scalar MinTimeStep)
{
  scIntegrator_->getNonConstTimeStepControl()->setMinTimeStep(MinTimeStep);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingInitTimeStep(Scalar InitTimeStep)
{
  scIntegrator_->getNonConstTimeStepControl()->setInitTimeStep(InitTimeStep);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingMaxTimeStep(Scalar MaxTimeStep)
{
  scIntegrator_->getNonConstTimeStepControl()->setMaxTimeStep(MaxTimeStep);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingMaxFailures(int MaxFailures)
{
  scIntegrator_->getNonConstTimeStepControl()->setMaxFailures(MaxFailures);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingMaxConsecFailures(
    int MaxConsecFailures)
{
  scIntegrator_->getNonConstTimeStepControl()->setMaxConsecFailures(
      MaxConsecFailures);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingScreenOutputIndexInterval(int i)
{
  scIntegrator_->setScreenOutputIndexInterval(i);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingScreenOutputIndexList(
    std::string s)
{
  scIntegrator_->setScreenOutputIndexList(s);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingTimeStepControlStrategy(
    Teuchos::RCP<TimeStepControlStrategy<Scalar> > tscs)
{
  scIntegrator_->getNonConstTimeStepControl()->setTimeStepControlStrategy(tscs);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingIntegratorObserver(
    Teuchos::RCP<IntegratorObserver<Scalar> > obs)
{
  scIntegrator_->setObserver(obs);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSubcyclingPrintDtChanges(bool printDtChanges)
{
  scIntegrator_->getNonConstTimeStepControl()->setPrintDtChanges(
      printDtChanges);
  this->isInitialized_ = false;
}

template <class Scalar>
Teuchos::RCP<const Stepper<Scalar> >
StepperSubcycling<Scalar>::getSubcyclingStepper() const
{
  return scIntegrator_->getStepper();
}

template <class Scalar>
Scalar StepperSubcycling<Scalar>::getSubcyclingMinTimeStep() const
{
  return scIntegrator_->getTimeStepControl()->getMinTimeStep();
}

template <class Scalar>
Scalar StepperSubcycling<Scalar>::getSubcyclingInitTimeStep() const
{
  return scIntegrator_->getTimeStepControl()->getInitTimeStep();
}

template <class Scalar>
Scalar StepperSubcycling<Scalar>::getSubcyclingMaxTimeStep() const
{
  return scIntegrator_->getTimeStepControl()->getMaxTimeStep();
}

template <class Scalar>
std::string StepperSubcycling<Scalar>::getSubcyclingStepType() const
{
  return scIntegrator_->getTimeStepControl()->getStepType();
}

template <class Scalar>
int StepperSubcycling<Scalar>::getSubcyclingMaxFailures() const
{
  return scIntegrator_->getTimeStepControl()->getMaxFailures();
}

template <class Scalar>
int StepperSubcycling<Scalar>::getSubcyclingMaxConsecFailures() const
{
  return scIntegrator_->getTimeStepControl()->getMaxConsecFailures();
}

template <class Scalar>
int StepperSubcycling<Scalar>::getSubcyclingScreenOutputIndexInterval() const
{
  return scIntegrator_->getScreenOutputIndexInterval();
}

template <class Scalar>
std::string StepperSubcycling<Scalar>::getSubcyclingScreenOutputIndexList()
    const
{
  return scIntegrator_->getScreenOutputIndexListString();
}

template <class Scalar>
Teuchos::RCP<TimeStepControlStrategy<Scalar> >
StepperSubcycling<Scalar>::getSubcyclingTimeStepControlStrategy() const
{
  return scIntegrator_->getTimeStepControl()->getTimeStepControlStrategy();
}

template <class Scalar>
Teuchos::RCP<IntegratorObserver<Scalar> >
StepperSubcycling<Scalar>::getSubcyclingIntegratorObserver() const
{
  return scIntegrator_->getObserver();
}

template <class Scalar>
bool StepperSubcycling<Scalar>::getSubcyclingPrintDtChanges() const
{
  return scIntegrator_->getTimeStepControl()->getPrintDtChanges();
}

template <class Scalar>
void StepperSubcycling<Scalar>::setModel(
    const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel)
{
  scIntegrator_->setModel(appModel);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setNonConstModel(
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& appModel)
{
  setModel(appModel);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setAppAction(
    Teuchos::RCP<StepperSubcyclingAppAction<Scalar> > appAction)
{
  if (appAction == Teuchos::null) {
    // Create default appAction
    stepperSCAppAction_ =
        Teuchos::rcp(new StepperSubcyclingModifierDefault<Scalar>());
  }
  else {
    stepperSCAppAction_ = appAction;
  }
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::initialize()
{
  Teuchos::RCP<Teuchos::FancyOStream> out = this->getOStream();
  bool isValidSetup                       = true;

  if (!(this->getICConsistency() == "None" ||
        this->getICConsistency() == "Zero" ||
        this->getICConsistency() == "App" ||
        this->getICConsistency() == "Consistent")) {
    isValidSetup = false;
    *out << "The IC consistency does not have a valid value!\n"
         << "('None', 'Zero', 'App' or 'Consistent')\n"
         << "  ICConsistency  = " << this->getICConsistency() << "\n";
  }
  scIntegrator_->initialize();

  if (stepperSCAppAction_ == Teuchos::null) {
    isValidSetup = false;
    *out << "The Subcycling AppAction is not set!\n";
  }

  if (isValidSetup)
    this->isInitialized_ = true;  // Only place it is set to true.
  else
    this->describe(*out, Teuchos::VERB_MEDIUM);
}

template <class Scalar>
bool StepperSubcycling<Scalar>::isExplicit() const
{
  return scIntegrator_->getStepper()->isExplicit();
}

template <class Scalar>
bool StepperSubcycling<Scalar>::isImplicit() const
{
  return scIntegrator_->getStepper()->isImplicit();
}

template <class Scalar>
bool StepperSubcycling<Scalar>::isExplicitImplicit() const
{
  return scIntegrator_->getStepper()->isExplicitImplicit();
}

template <class Scalar>
bool StepperSubcycling<Scalar>::isOneStepMethod() const
{
  return scIntegrator_->getStepper()->isOneStepMethod();
}

template <class Scalar>
bool StepperSubcycling<Scalar>::isMultiStepMethod() const
{
  return scIntegrator_->getStepper()->isMultiStepMethod();
}

template <class Scalar>
Scalar StepperSubcycling<Scalar>::getOrder() const
{
  return scIntegrator_->getStepper()->getOrder();
}

template <class Scalar>
Scalar StepperSubcycling<Scalar>::getOrderMin() const
{
  return scIntegrator_->getStepper()->getOrderMin();
}

template <class Scalar>
Scalar StepperSubcycling<Scalar>::getOrderMax() const
{
  return scIntegrator_->getStepper()->getOrderMax();
}

template <class Scalar>
OrderODE StepperSubcycling<Scalar>::getOrderODE() const
{
  return scIntegrator_->getStepper()->getOrderODE();
}

template <class Scalar>
Scalar StepperSubcycling<Scalar>::getInitTimeStep(
    const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory) const
{
  return scIntegrator_->getStepper()->getInitTimeStep(solutionHistory);
}

template <class Scalar>
void StepperSubcycling<Scalar>::setInitialGuess(
    Teuchos::RCP<const Thyra::VectorBase<Scalar> > initialGuess)
{
  scIntegrator_->getStepper()->setInitialGuess(initialGuess);
  this->isInitialized_ = false;
}

template <class Scalar>
void StepperSubcycling<Scalar>::setInitialConditions(
    const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory)
{
  scIntegrator_->getStepper()->setInitialConditions(solutionHistory);
  scIntegrator_->setSolutionHistory(solutionHistory);
}

template <class Scalar>
void StepperSubcycling<Scalar>::setSolver(
    Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > solver)
{
  scIntegrator_->getStepper()->setSolver(solver);
  this->isInitialized_ = false;
}

template <class Scalar>
Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >
StepperSubcycling<Scalar>::getSolver() const
{
  return scIntegrator_->getStepper()->getSolver();
}

template <class Scalar>
void StepperSubcycling<Scalar>::takeStep(
    const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory)
{
  using Teuchos::RCP;

  TEMPUS_FUNC_TIME_MONITOR("Tempus::StepperSubcycling::takeStep()");
  {
    TEUCHOS_TEST_FOR_EXCEPTION(
        solutionHistory->getNumStates() < 2, std::logic_error,
        "Error - StepperSubcycling<Scalar>::takeStep(...)\n"
            << "Need at least two SolutionStates for Subcycling.\n"
            << "  Number of States = " << solutionHistory->getNumStates()
            << "\nTry setting in \"Solution History\" \"Storage Type\" = "
            << "\"Undo\"\n"
            << "  or \"Storage Type\" = \"Static\" and \"Storage Limit\" = "
            << "\"2\"\n");

    RCP<StepperSubcycling<Scalar> > thisStepper = Teuchos::rcpFromRef(*this);
    stepperSCAppAction_->execute(
        solutionHistory, thisStepper,
        StepperSubcyclingAppAction<Scalar>::ACTION_LOCATION::BEGIN_STEP);
    RCP<SolutionState<Scalar> > currentState =
        solutionHistory->getCurrentState();
    RCP<SolutionState<Scalar> > workingState =
        solutionHistory->getWorkingState();

    auto scTSC = scIntegrator_->getNonConstTimeStepControl();
    scTSC->setInitTime(currentState->getTime());
    scTSC->setInitIndex(0);
    scTSC->setFinalTime(workingState->getTime());

    auto subcyclingState = currentState->clone();
    subcyclingState->setTimeStep(scTSC->getInitTimeStep());
    subcyclingState->setOrder(scIntegrator_->getStepper()->getOrder());
    subcyclingState->setIndex(0);
    subcyclingState->setNFailures(0);
    subcyclingState->setNRunningFailures(0);
    subcyclingState->setNConsecutiveFailures(0);
    subcyclingState->setOutput(false);
    subcyclingState->setOutputScreen(false);

    TEUCHOS_TEST_FOR_EXCEPTION(
        !subcyclingState->getIsSynced(), std::logic_error,
        "Error - StepperSubcycling<Scalar>::takeStep(...)\n"
        "        Subcycling requires the the solution is synced!\n"
        "        (i.e., x, xDot, and xDotDot at the same time level.\n");

    auto scSH = rcp(new Tempus::SolutionHistory<Scalar>());
    scSH->setName("Subcycling States");
    scSH->setStorageType(Tempus::STORAGE_TYPE_STATIC);
    scSH->setStorageLimit(3);
    scSH->addState(subcyclingState);

    scIntegrator_->setSolutionHistory(scSH);

    bool pass = scIntegrator_->advanceTime();

    RCP<SolutionState<Scalar> > scCS = scSH->getCurrentState();

    RCP<Thyra::VectorBase<Scalar> > x   = workingState->getX();
    RCP<Thyra::VectorBase<Scalar> > scX = scCS->getX();
    Thyra::V_V(x.ptr(), *(scX));

    RCP<Thyra::VectorBase<Scalar> > xDot = workingState->getXDot();
    if (xDot != Teuchos::null) {
      RCP<Thyra::VectorBase<Scalar> > scXDot = scCS->getXDot();
      Thyra::V_V(xDot.ptr(), *(scXDot));
    }

    RCP<Thyra::VectorBase<Scalar> > xDotDot = workingState->getXDotDot();
    if (xDotDot != Teuchos::null) {
      RCP<Thyra::VectorBase<Scalar> > scXDotDot = scCS->getXDotDot();
      Thyra::V_V(xDotDot.ptr(), *(scXDotDot));
    }

    if (pass == true)
      workingState->setSolutionStatus(Status::PASSED);
    else
      workingState->setSolutionStatus(Status::FAILED);
    workingState->setOrder(scCS->getOrder());
    workingState->computeNorms(currentState);
    scSH->clear();
    stepperSCAppAction_->execute(
        solutionHistory, thisStepper,
        StepperSubcyclingAppAction<Scalar>::ACTION_LOCATION::END_STEP);
  }
  return;
}

template <class Scalar>
Teuchos::RCP<Tempus::StepperState<Scalar> >
StepperSubcycling<Scalar>::getDefaultStepperState()
{
  Teuchos::RCP<Tempus::StepperState<Scalar> > stepperState =
      rcp(new StepperState<Scalar>(this->getStepperType()));
  return stepperState;
}

template <class Scalar>
void StepperSubcycling<Scalar>::describe(
    Teuchos::FancyOStream& out, const Teuchos::EVerbosityLevel verbLevel) const
{
  out.setOutputToRootOnly(0);
  out << std::endl;
  Stepper<Scalar>::describe(out, verbLevel);

  out << "--- StepperSubcycling ---\n";
  out << "  stepperSCAppAction = " << stepperSCAppAction_ << std::endl;
  out << "  scIntegrator      = " << scIntegrator_ << std::endl;
  out << "-------------------------" << std::endl;
  scIntegrator_->getStepper()->describe(out, verbLevel);
}

template <class Scalar>
Teuchos::RCP<const Teuchos::ParameterList>
StepperSubcycling<Scalar>::getValidParameters() const
{
  TEUCHOS_TEST_FOR_EXCEPTION(
      true, std::logic_error,
      "Error - StepperSubcycling<Scalar>::getValidParameters()\n"
      "  is not implemented yet.\n");

  return this->getValidParametersBasic();
}

// Nonmember constructor - ModelEvaluator and ParameterList
// ------------------------------------------------------------------------
template <class Scalar>
Teuchos::RCP<StepperSubcycling<Scalar> > createStepperSubcycling(
    const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model,
    Teuchos::RCP<Teuchos::ParameterList> pl)
{
  auto stepper = Teuchos::rcp(new StepperSubcycling<Scalar>());

  TEUCHOS_TEST_FOR_EXCEPTION(
      pl != Teuchos::null, std::logic_error,
      "Error - Construction of StepperSubcycling with a ParameterList\n"
      "is not implemented yet!\n");

  if (pl != Teuchos::null) {
    stepper->setStepperValues(pl);
  }

  if (model != Teuchos::null) {
    stepper->setModel(model);
    stepper->initialize();
  }

  return stepper;
}

}  // namespace Tempus
#endif  // Tempus_StepperSubcycling_impl_hpp