Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus_IntegratorObserverBasic_impl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ****************************************************************************
3 // Tempus: Copyright (2017) Sandia Corporation
4 //
5 // Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
6 // ****************************************************************************
7 // @HEADER
8 
9 #ifndef Tempus_IntegratorObserverBasic_impl_hpp
10 #define Tempus_IntegratorObserverBasic_impl_hpp
11 
12 #include "Tempus_Stepper.hpp"
13 
14 namespace Tempus {
15 
16 template<class Scalar>
18 
19 template<class Scalar>
21 
22 template<class Scalar>
25 
26  std::time_t begin = std::time(nullptr);
27  const Teuchos::RCP<Teuchos::FancyOStream> out = integrator.getOStream();
28  Teuchos::OSTab ostab(out,0,"ScreenOutput");
29  *out << "\nTempus - IntegratorBasic\n"
30  << std::asctime(std::localtime(&begin)) << "\n"
31  << " Stepper = " << integrator.getStepper()->description() << "\n"
32  << " Simulation Time Range [" << integrator.getTimeStepControl()->getInitTime()
33  << ", " << integrator.getTimeStepControl()->getFinalTime() << "]\n"
34  << " Simulation Index Range [" << integrator.getTimeStepControl()->getInitIndex()
35  << ", " << integrator.getTimeStepControl()->getFinalIndex() << "]\n"
36  << "============================================================================\n"
37  << " Step Time dt Abs Error Rel Error Order nFail dCompTime"
38  << std::endl;
39 }
40 
41 template<class Scalar>
43 observeStartTimeStep(const Integrator<Scalar>& /* integrator */){}
44 
45 template<class Scalar>
47 observeNextTimeStep(const Integrator<Scalar>& /* integrator */){}
48 
49 template<class Scalar>
51 observeBeforeTakeStep(const Integrator<Scalar>& /* integrator */){}
52 
53 template<class Scalar>
55 observeAfterTakeStep(const Integrator<Scalar>& /* integrator */){}
56 
57 template<class Scalar>
60 
61 template<class Scalar>
64 
65  using Teuchos::RCP;
66  RCP<SolutionStateMetaData<Scalar> > csmd =
67  integrator.getSolutionHistory()->getCurrentState()->getMetaData();
68 
69  if ((csmd->getOutputScreen() == true) or
70  (csmd->getOutput() == true) or
71  (csmd->getTime() == integrator.getTimeStepControl()->getFinalTime())) {
72 
73  const Scalar steppertime = integrator.getStepperTimer()->totalElapsedTime();
74  // reset the stepper timer
75  integrator.getStepperTimer()->reset();
76 
77  const Teuchos::RCP<Teuchos::FancyOStream> out = integrator.getOStream();
78  Teuchos::OSTab ostab(out,0,"ScreenOutput");
79  *out<<std::scientific
80  <<std::setw( 6)<<std::setprecision(3)<<csmd->getIStep()
81  <<std::setw(11)<<std::setprecision(3)<<csmd->getTime()
82  <<std::setw(11)<<std::setprecision(3)<<csmd->getDt()
83  <<std::setw(11)<<std::setprecision(3)<<csmd->getErrorAbs()
84  <<std::setw(11)<<std::setprecision(3)<<csmd->getErrorRel()
85  <<std::fixed <<std::setw( 7)<<std::setprecision(1)<<csmd->getOrder()
86  <<std::scientific<<std::setw( 7)<<std::setprecision(3)<<csmd->getNFailures()
87  <<std::setw(11)<<std::setprecision(3)<<steppertime
88  <<std::endl;
89  }
90 
91 }
92 
93 template<class Scalar>
96 
97  std::string exitStatus;
98  //const Scalar runtime = integrator.getIntegratorTimer()->totalElapsedTime();
99  if (integrator.getSolutionHistory()->getCurrentState()->getSolutionStatus() ==
100  Status::FAILED or integrator.getStatus() == Status::FAILED) {
101  exitStatus = "Time integration FAILURE!";
102  } else {
103  exitStatus = "Time integration complete.";
104  }
105  std::time_t end = std::time(nullptr);
106  const Scalar runtime = integrator.getIntegratorTimer()->totalElapsedTime();
107  const Teuchos::RCP<Teuchos::FancyOStream> out = integrator.getOStream();
108  Teuchos::OSTab ostab(out,0,"ScreenOutput");
109  *out << "============================================================================\n"
110  << " Total runtime = " << runtime << " sec = "
111  << runtime/60.0 << " min\n"
112  << std::asctime(std::localtime(&end))
113  << exitStatus << "\n"
114  << std::endl;
115 }
116 
117 } // namespace Tempus
118 #endif // Tempus_IntegratorObserverBasic_impl_hpp
virtual Teuchos::RCP< Teuchos::Time > getStepperTimer() const =0
virtual Teuchos::RCP< Teuchos::Time > getIntegratorTimer() const =0
Returns the IntegratorTimer_ for this Integrator.
virtual void observeEndIntegrator(const Integrator< Scalar > &integrator) override
Observe the end of the time integrator.
virtual void observeNextTimeStep(const Integrator< Scalar > &integrator) override
Observe after the next time step size is selected.
virtual Teuchos::RCP< const TimeStepControl< Scalar > > getTimeStepControl() const =0
Returns the TimeStepControl for this Integrator.
virtual void observeStartIntegrator(const Integrator< Scalar > &integrator) override
Observe the beginning of the time integrator.
virtual Tempus::Status getStatus() const =0
Get the Status.
virtual void observeAfterCheckTimeStep(const Integrator< Scalar > &integrator) override
Observe after checking time step. Observer can still fail the time step here.
Thyra Base interface for time integrators. Time integrators are designed to advance the solution from...
virtual void observeStartTimeStep(const Integrator< Scalar > &integrator) override
Observe the beginning of the time step loop.
virtual void observeAfterTakeStep(const Integrator< Scalar > &integrator) override
Observe after Stepper takes step.
virtual void observeEndTimeStep(const Integrator< Scalar > &integrator) override
Observe the end of the time step loop.
virtual void observeBeforeTakeStep(const Integrator< Scalar > &integrator) override
Observe before Stepper takes step.
virtual Teuchos::RCP< Stepper< Scalar > > getStepper() const =0
Get the stepper.
virtual Teuchos::RCP< const SolutionHistory< Scalar > > getSolutionHistory() const =0
Returns the SolutionHistory for this Integrator.