Skip to content

Commit

Permalink
Merge 'trilinos/Trilinos:develop' (36a5fcb) into 'tcad-charon/Trilino…
Browse files Browse the repository at this point in the history 
…s:develop' (9040d5d).

* trilinos-develop:
  Tempus: Fixes for Subcycling and Deprecated Code
  • Loading branch information
Jenkins Pipeline committed Jun 14, 2020
2 parents 9040d5d + 36a5fcb commit 3b3055d
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 53 deletions.
2 changes: 1 addition & 1 deletion packages/tempus/doc/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.

INPUT = index.dox ../src ../test
INPUT = index.dox ../src ../test ../unit_test

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Expand Down
7 changes: 5 additions & 2 deletions packages/tempus/src/Tempus_StepperSubcycling_impl.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,13 +346,13 @@ Teuchos::RCP<StepperObserver<Scalar> >
StepperSubcycling<Scalar>::getObserver() const
{ return stepperSCObserver_; }
#endif

template<class Scalar>
void StepperSubcycling<Scalar>::setAppAction(
Teuchos::RCP<StepperSubcyclingAppAction<Scalar> > appAction)
{
if (appAction == Teuchos::null) {
// Create default appAction
// Create default appAction
stepperSCAppAction_ =
Teuchos::rcp(new StepperSubcyclingModifierDefault<Scalar>());
} else {
Expand Down Expand Up @@ -590,7 +590,10 @@ void StepperSubcycling<Scalar>::describe(
Stepper<Scalar>::describe(out, verbLevel);

out << "--- StepperSubcycling ---\n";
#ifndef TEMPUS_HIDE_DEPRECATED_CODE
out << " stepperSCObserver = " << stepperSCObserver_ << std::endl;
#endif
out << " stepperSCAppAction = " << stepperSCAppAction_ << std::endl;
out << " scIntegrator = " << scIntegrator_ << std::endl;
out << "-------------------------" << std::endl;
scIntegrator_->getStepper()->describe(out, verbLevel);
Expand Down
100 changes: 50 additions & 50 deletions packages/tempus/unit_test/Tempus_UnitTest_Subcycling.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ TEUCHOS_UNIT_TEST(Subcycling, Default_Construction)
TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());

// Default values for construction.
#ifndef TEMPUS_DEPRECATED_CODE
#ifndef TEMPUS_HIDE_DEPRECATED_CODE
auto obs = rcp(new Tempus::StepperSubcyclingObserver<double>());
#endif
auto modifier = rcp(new Tempus::StepperSubcyclingModifierDefault<double>());
auto modifier = rcp(new Tempus::StepperSubcyclingModifierDefault<double>());
auto solver = rcp(new Thyra::NOXNonlinearSolver());
solver->setParameterList(Tempus::defaultSolverParameters());

Expand Down Expand Up @@ -129,23 +129,23 @@ TEUCHOS_UNIT_TEST(Subcycling, MaxTimeStepDoesNotChangeDuring_takeStep)
}


// ************************************************************
// ************************************************************
// ************************************************************
// ************************************************************
class StepperSubcyclingModifierTest
: virtual public Tempus::StepperSubcyclingModifierBase<double>
{
public:

/// Constructor
/// Constructor
StepperSubcyclingModifierTest()
: testBEGIN_STEP(false), testEND_STEP(false),
testCurrentValue(-0.99), testWorkingValue(-0.99),
testDt(1.5), testType("")
{}
/// Destructor
/// Destructor
virtual ~StepperSubcyclingModifierTest(){}

/// Modify Subcycling Stepper at action location.
/// Modify Subcycling Stepper at action location.
virtual void modify(
Teuchos::RCP<Tempus::SolutionHistory<double> > sh,
Teuchos::RCP<Tempus::StepperSubcycling<double> > stepper,
Expand All @@ -161,7 +161,7 @@ class StepperSubcyclingModifierTest
stepper->setStepperType(testType);
break;
}
case StepperSubcyclingAppAction<double>::END_STEP:
case StepperSubcyclingAppAction<double>::END_STEP:
{
testEND_STEP = true;
auto x = sh->getWorkingState()->getX();
Expand All @@ -186,10 +186,10 @@ class StepperSubcyclingModifierTest

TEUCHOS_UNIT_TEST(Subcycling, AppAction_Modifier)
{
// Setup the SinCosModel ------------------------------------
// Setup the SinCosModel ------------------------------------
auto model = rcp(new Tempus_Test::SinCosModel<double>());

// Setup Stepper for field solve ----------------------------
// Setup Stepper for field solve ----------------------------
auto stepper = rcp(new Tempus::StepperSubcycling<double>());
auto sf = Teuchos::rcp(new Tempus::StepperFactory<double>());
auto stepperFE = sf->createStepperForwardEuler(model, Teuchos::null);
Expand All @@ -207,7 +207,7 @@ TEUCHOS_UNIT_TEST(Subcycling, AppAction_Modifier)
stepper->setSubcyclingPrintDtChanges(true);
stepper->initialize();

// Setup TimeStepControl ------------------------------------
// Setup TimeStepControl ------------------------------------
auto timeStepControl = rcp(new Tempus::TimeStepControl<double>());
timeStepControl->setStepType ("Constant");
timeStepControl->setInitIndex(0);
Expand All @@ -216,34 +216,34 @@ TEUCHOS_UNIT_TEST(Subcycling, AppAction_Modifier)
timeStepControl->setInitTimeStep(15.0);
timeStepControl->initialize();

// Setup initial condition SolutionState --------------------
// Setup initial condition SolutionState --------------------
Thyra::ModelEvaluatorBase::InArgs<double> inArgsIC =
stepper->getModel()->getNominalValues();
auto icSolution = rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x());
auto icState = Tempus::createSolutionStateX(icSolution);
icState->setTime (timeStepControl->getInitTime());;
icState->setIndex (timeStepControl->getInitIndex());
icState->setTimeStep(0.0); // dt for ICs are indicated by zero.
icState->setSolutionStatus(Tempus::Status::PASSED); // ICs are passing.
icState->setTimeStep(0.0); // dt for ICs are indicated by zero.
icState->setSolutionStatus(Tempus::Status::PASSED); // ICs are passing.

// Setup SolutionHistory ------------------------------------
// Setup SolutionHistory ------------------------------------
auto solutionHistory = rcp(new Tempus::SolutionHistory<double>());
solutionHistory->setName("Forward States");
solutionHistory->setStorageType(Tempus::STORAGE_TYPE_STATIC);
solutionHistory->setStorageLimit(2);
solutionHistory->addState(icState);

// Take one time step.
// Take one time step.
stepper->setInitialConditions(solutionHistory);
solutionHistory->initWorkingState();
solutionHistory->getWorkingState()->setTimeStep(15.0);
stepper->takeStep(solutionHistory);

// Testing that each ACTION_LOCATION has been called.
// Testing that each ACTION_LOCATION has been called.
TEST_COMPARE(modifier->testBEGIN_STEP, ==, true);
TEST_COMPARE(modifier->testEND_STEP, ==, true);

// Testing that values can be set through the Modifier.
// Testing that values can be set through the Modifier.
auto x = solutionHistory->getCurrentState()->getX();
TEST_FLOATING_EQUALITY(modifier->testCurrentValue, get_ele(*(x), 0), 1.0e-15);
x = solutionHistory->getWorkingState()->getX();
Expand All @@ -254,24 +254,24 @@ TEUCHOS_UNIT_TEST(Subcycling, AppAction_Modifier)
TEST_COMPARE(modifier->testType, ==, "Subcycling - Modifier");
}

// ************************************************************
// ************************************************************
// ************************************************************
// ************************************************************
class StepperSubcyclingObserverTest
: virtual public Tempus::StepperSubcyclingObserverBase<double>
{
public:

/// Constructor
/// Constructor
StepperSubcyclingObserverTest()
: testBEGIN_STEP(false), testEND_STEP(false),
testCurrentValue(-0.99), testWorkingValue(-0.99),
testDt(15.0), testType("Subcyling")
{}

/// Destructor
/// Destructor
virtual ~StepperSubcyclingObserverTest(){}

/// Observe Subcycling Stepper at action location.
/// Observe Subcycling Stepper at action location.
virtual void observe(
Teuchos::RCP<const Tempus::SolutionHistory<double> > sh,
Teuchos::RCP<const Tempus::StepperSubcycling<double> > stepper,
Expand Down Expand Up @@ -308,10 +308,10 @@ class StepperSubcyclingObserverTest

TEUCHOS_UNIT_TEST(Subcycling, AppAction_Observer)
{
// Setup the SinCosModel ------------------------------------
// Setup the SinCosModel ------------------------------------
auto model = rcp(new Tempus_Test::SinCosModel<double>());

// Setup Stepper for field solve ----------------------------
// Setup Stepper for field solve ----------------------------
auto stepper = rcp(new Tempus::StepperSubcycling<double>());
auto sf = Teuchos::rcp(new Tempus::StepperFactory<double>());
auto stepperFE = sf->createStepperForwardEuler(model, Teuchos::null);
Expand All @@ -329,7 +329,7 @@ TEUCHOS_UNIT_TEST(Subcycling, AppAction_Observer)
stepper->setSubcyclingPrintDtChanges(true);
stepper->initialize();

// Setup TimeStepControl ------------------------------------
// Setup TimeStepControl ------------------------------------
auto timeStepControl = rcp(new Tempus::TimeStepControl<double>());
timeStepControl->setStepType ("Constant");
timeStepControl->setInitIndex(0);
Expand All @@ -338,34 +338,34 @@ TEUCHOS_UNIT_TEST(Subcycling, AppAction_Observer)
timeStepControl->setInitTimeStep(15.0);
timeStepControl->initialize();

// Setup initial condition SolutionState --------------------
// Setup initial condition SolutionState --------------------
Thyra::ModelEvaluatorBase::InArgs<double> inArgsIC =
stepper->getModel()->getNominalValues();
auto icSolution = rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x());
auto icState = Tempus::createSolutionStateX(icSolution);
icState->setTime (timeStepControl->getInitTime());;
icState->setIndex (timeStepControl->getInitIndex());
icState->setTimeStep(0.0); // dt for ICs are indicated by zero.
icState->setSolutionStatus(Tempus::Status::PASSED); // ICs are passing.
icState->setTimeStep(0.0); // dt for ICs are indicated by zero.
icState->setSolutionStatus(Tempus::Status::PASSED); // ICs are passing.

// Setup SolutionHistory ------------------------------------
// Setup SolutionHistory ------------------------------------
auto solutionHistory = rcp(new Tempus::SolutionHistory<double>());
solutionHistory->setName("Forward States");
solutionHistory->setStorageType(Tempus::STORAGE_TYPE_STATIC);
solutionHistory->setStorageLimit(2);
solutionHistory->addState(icState);

// Take one time step.
// Take one time step.
stepper->setInitialConditions(solutionHistory);
solutionHistory->initWorkingState();
solutionHistory->getWorkingState()->setTimeStep(15.0);
stepper->takeStep(solutionHistory);

// Testing that each ACTION_LOCATION has been called.
// Testing that each ACTION_LOCATION has been called.
TEST_COMPARE(observer->testBEGIN_STEP, ==, true);
TEST_COMPARE(observer->testEND_STEP, ==, true);

// Testing that values can be observed through the observer.
// Testing that values can be observed through the observer.
auto x = solutionHistory->getCurrentState()->getX();
TEST_FLOATING_EQUALITY(observer->testCurrentValue, get_ele(*(x), 0), 1.0e-15);
x = solutionHistory->getWorkingState()->getX();
Expand All @@ -375,24 +375,24 @@ TEUCHOS_UNIT_TEST(Subcycling, AppAction_Observer)
TEST_COMPARE(observer->testType, ==, "Subcyling");
}

// ************************************************************
// ************************************************************
// ************************************************************
// ************************************************************
class StepperSubcyclingModifierXTest
: virtual public Tempus::StepperSubcyclingModifierXBase<double>
{
public:

/// Constructor
/// Constructor
StepperSubcyclingModifierXTest()
: testX_BEGIN_STEP(false), testXDOT_END_STEP(false),
testX(-0.99), testXDot(-0.99),
testDt(1.5), testTime(1.5)
{}

/// Destructor
/// Destructor
virtual ~StepperSubcyclingModifierXTest(){}

/// Modify Subcycling Stepper at action location.
/// Modify Subcycling Stepper at action location.
virtual void modify(
Teuchos::RCP<Thyra::VectorBase<double> > x,
const double time, const double dt,
Expand Down Expand Up @@ -429,10 +429,10 @@ class StepperSubcyclingModifierXTest

TEUCHOS_UNIT_TEST(Subcycling, AppAction_ModifierX)
{
// Setup the SinCosModel ------------------------------------
// Setup the SinCosModel ------------------------------------
auto model = rcp(new Tempus_Test::SinCosModel<double>());

// Setup Stepper for field solve ----------------------------
// Setup Stepper for field solve ----------------------------
auto stepper = rcp(new Tempus::StepperSubcycling<double>());
auto sf = Teuchos::rcp(new Tempus::StepperFactory<double>());
auto stepperFE = sf->createStepperForwardEuler(model, Teuchos::null);
Expand All @@ -450,7 +450,7 @@ TEUCHOS_UNIT_TEST(Subcycling, AppAction_ModifierX)
stepper->setSubcyclingPrintDtChanges(true);
stepper->initialize();

// Setup TimeStepControl ------------------------------------
// Setup TimeStepControl ------------------------------------
auto timeStepControl = rcp(new Tempus::TimeStepControl<double>());
timeStepControl->setStepType ("Constant");
timeStepControl->setInitIndex(0);
Expand All @@ -459,44 +459,44 @@ TEUCHOS_UNIT_TEST(Subcycling, AppAction_ModifierX)
timeStepControl->setInitTimeStep(15.0);
timeStepControl->initialize();

// Setup initial condition SolutionState --------------------
// Setup initial condition SolutionState --------------------
Thyra::ModelEvaluatorBase::InArgs<double> inArgsIC =
stepper->getModel()->getNominalValues();
auto icSolution = rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x());
auto icSolutionDot = rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x_dot());
auto icState = Tempus::createSolutionStateX(icSolution,icSolutionDot);
icState->setTime (timeStepControl->getInitTime());;
icState->setIndex (timeStepControl->getInitIndex());
icState->setTimeStep(0.0); // dt for ICs are indicated by zero.
icState->setSolutionStatus(Tempus::Status::PASSED); // ICs are passing.
icState->setTimeStep(0.0); // dt for ICs are indicated by zero.
icState->setSolutionStatus(Tempus::Status::PASSED); // ICs are passing.

// Setup SolutionHistory ------------------------------------
// Setup SolutionHistory ------------------------------------
auto solutionHistory = rcp(new Tempus::SolutionHistory<double>());
solutionHistory->setName("Forward States");
solutionHistory->setStorageType(Tempus::STORAGE_TYPE_STATIC);
solutionHistory->setStorageLimit(2);
solutionHistory->addState(icState);

// Take one time step.
// Take one time step.
stepper->setInitialConditions(solutionHistory);
solutionHistory->initWorkingState();
solutionHistory->getWorkingState()->setTimeStep(15.0);
stepper->takeStep(solutionHistory);

// Take one time step.
// Take one time step.
stepper->setInitialConditions(solutionHistory);
solutionHistory->initWorkingState();
solutionHistory->getWorkingState()->setTimeStep(15.0);
stepper->takeStep(solutionHistory);

// Testing that each ACTION_LOCATION has been called.
// Testing that each ACTION_LOCATION has been called.
TEST_COMPARE(modifierX->testX_BEGIN_STEP, ==, true);
TEST_COMPARE(modifierX->testXDOT_END_STEP, ==, true);

// Testing that values can be set through the Modifier.
// Testing that values can be set through the Modifier.
auto x = solutionHistory->getCurrentState()->getX();
TEST_FLOATING_EQUALITY(modifierX->testX, get_ele(*(x), 0), 1.0e-15);
// Temporary memory for xDot is not guarranteed to exist outside the Stepper.
// Temporary memory for xDot is not guarranteed to exist outside the Stepper.
auto xDot = stepper->getStepperXDot(solutionHistory->getWorkingState());
TEST_FLOATING_EQUALITY(modifierX->testXDot, get_ele(*(xDot), 0),1.0e-15);
auto Dt = solutionHistory->getWorkingState()->getTimeStep();
Expand Down

0 comments on commit 3b3055d

Please sign in to comment.