Tempus_SolutionStateMetaData_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_SolutionStateMetaData_impl_hpp
#define Tempus_SolutionStateMetaData_impl_hpp

namespace Tempus {

template <class Scalar>
SolutionStateMetaData<Scalar>::SolutionStateMetaData()
  : time_(0.0),
    iStep_(0),
    dt_(0.0),
    errorAbs_(0.0),
    errorRel_(0.0),
    errorRelNm1_(0.0),
    errorRelNm2_(0.0),
    order_(1),
    nFailures_(0),
    nRunningFailures_(0),
    nConsecutiveFailures_(0),
    tolRel_(1.0e-02),
    tolAbs_(0.0),
    xNormL2_(0.0),
    dxNormL2Rel_(0.0),
    dxNormL2Abs_(0.0),
    computeNorms_(false),
    solutionStatus_(WORKING),
    output_(false),
    outputScreen_(false),
    isSynced_(true),
    isInterpolated_(false),
    accuracy_(0.0)
{
}

template <class Scalar>
SolutionStateMetaData<Scalar>::SolutionStateMetaData(
    const Scalar time, const int iStep, const Scalar dt, const Scalar errorAbs,
    const Scalar errorRel, const Scalar errorRelNm1, const Scalar errorRelNm2,
    const int order, const int nFailures, const int nRunningFailures,
    const int nConsecutiveFailures, const Scalar tolRel, const Scalar tolAbs,
    const Scalar xNormL2, const Scalar dxNormL2Rel, const Scalar dxNormL2Abs,
    const bool computeNorms, const Status solutionStatus, const bool output,
    const bool outputScreen, const bool isSynced, const bool isInterpolated,
    const Scalar accuracy)
  : time_(time),
    iStep_(iStep),
    dt_(dt),
    errorAbs_(errorAbs),
    errorRel_(errorRel),
    errorRelNm1_(errorRelNm1),
    errorRelNm2_(errorRelNm2),
    order_(order),
    nFailures_(nFailures),
    nRunningFailures_(nRunningFailures),
    nConsecutiveFailures_(nConsecutiveFailures),
    tolRel_(tolRel),
    tolAbs_(tolAbs),
    xNormL2_(xNormL2),
    dxNormL2Rel_(dxNormL2Rel),
    dxNormL2Abs_(dxNormL2Abs),
    computeNorms_(computeNorms),
    solutionStatus_(solutionStatus),
    output_(output),
    outputScreen_(outputScreen),
    isSynced_(isSynced),
    isInterpolated_(isInterpolated),
    accuracy_(accuracy)
{
}

template <class Scalar>
SolutionStateMetaData<Scalar>::SolutionStateMetaData(
    const SolutionStateMetaData<Scalar>& ssmd)
  : time_(ssmd.time_),
    iStep_(ssmd.iStep_),
    dt_(ssmd.dt_),
    errorAbs_(ssmd.errorAbs_),
    errorRel_(ssmd.errorRel_),
    errorRelNm1_(ssmd.errorRelNm1_),
    errorRelNm2_(ssmd.errorRelNm2_),
    order_(ssmd.order_),
    nFailures_(ssmd.nFailures_),
    nRunningFailures_(ssmd.nRunningFailures_),
    nConsecutiveFailures_(ssmd.nConsecutiveFailures_),
    tolRel_(ssmd.tolRel_),
    tolAbs_(ssmd.tolAbs_),
    dxNormL2Rel_(ssmd.dxNormL2Rel_),
    dxNormL2Abs_(ssmd.dxNormL2Abs_),
    computeNorms_(ssmd.computeNorms_),
    solutionStatus_(ssmd.solutionStatus_),
    output_(ssmd.output_),
    outputScreen_(ssmd.outputScreen_),
    isSynced_(ssmd.isSynced_),
    isInterpolated_(ssmd.isInterpolated_),
    accuracy_(ssmd.accuracy_)
{
}

template <class Scalar>
Teuchos::RCP<SolutionStateMetaData<Scalar> >
SolutionStateMetaData<Scalar>::clone() const
{
  Teuchos::RCP<SolutionStateMetaData<Scalar> > md =
      rcp(new SolutionStateMetaData<Scalar>(
          time_, iStep_, dt_, errorAbs_, errorRel_, errorRelNm1_, errorRelNm2_,
          order_, nFailures_, nRunningFailures_, nConsecutiveFailures_, tolRel_,
          tolAbs_, xNormL2_, dxNormL2Rel_, dxNormL2Abs_, computeNorms_,
          solutionStatus_, output_, outputScreen_, isSynced_, isInterpolated_,
          accuracy_));

  return md;
}

template <class Scalar>
void SolutionStateMetaData<Scalar>::copy(
    const Teuchos::RCP<const SolutionStateMetaData<Scalar> >& ssmd)
{
  time_                 = ssmd->time_;
  iStep_                = ssmd->iStep_;
  dt_                   = ssmd->dt_;
  errorAbs_             = ssmd->errorAbs_;
  errorRel_             = ssmd->errorRel_;
  errorRelNm1_          = ssmd->errorRelNm1_;
  errorRelNm2_          = ssmd->errorRelNm2_;
  order_                = ssmd->order_;
  nFailures_            = ssmd->nFailures_;
  nRunningFailures_     = ssmd->nRunningFailures_;
  nConsecutiveFailures_ = ssmd->nConsecutiveFailures_;
  tolRel_ = ssmd->tolRel_, tolAbs_ = ssmd->tolAbs_, xNormL2_ = ssmd->xNormL2_,
  dxNormL2Rel_ = ssmd->dxNormL2Rel_, dxNormL2Abs_ = ssmd->dxNormL2Abs_,
  computeNorms_ = ssmd->computeNorms_, solutionStatus_ = ssmd->solutionStatus_;
  output_         = ssmd->output_;
  outputScreen_   = ssmd->outputScreen_;
  isSynced_       = ssmd->isSynced_;
  isInterpolated_ = ssmd->isInterpolated_;
  accuracy_       = ssmd->accuracy_;
}

template <class Scalar>
std::string SolutionStateMetaData<Scalar>::description() const
{
  std::string name = "Tempus::SolutionStateMetaData";
  return (name);
}

template <class Scalar>
void SolutionStateMetaData<Scalar>::describe(
    Teuchos::FancyOStream& out, const Teuchos::EVerbosityLevel verbLevel) const
{
  auto l_out = Teuchos::fancyOStream(out.getOStream());
  Teuchos::OSTab ostab(*l_out, 2, this->description());
  l_out->setOutputToRootOnly(0);

  *l_out << "\n--- " << this->description() << " ---" << std::endl;

  if (verbLevel >= Teuchos::VERB_MEDIUM) {
    *l_out << "  time           = " << time_ << std::endl
           << "  iStep          = " << iStep_ << std::endl
           << "  dt             = " << dt_ << std::endl
           << "  errorAbs       = " << errorAbs_ << std::endl
           << "  errorRel       = " << errorRel_ << std::endl
           << "  errorRelNm1    = " << errorRelNm1_ << std::endl
           << "  errorRelNm2    = " << errorRelNm2_ << std::endl
           << "  order          = " << order_ << std::endl
           << "  nFailures      = " << nFailures_ << std::endl
           << "  nRunningFailures = " << nRunningFailures_ << std::endl
           << "  nConsecutiveFailures = " << nConsecutiveFailures_ << std::endl
           << "  tolRel         = " << tolRel_ << std::endl
           << "  tolAbs         = " << tolAbs_ << std::endl
           << "  xNormL2        = " << xNormL2_ << std::endl
           << "  dxNormL2Rel    = " << dxNormL2Rel_ << std::endl
           << "  dxNormL2Abs    = " << dxNormL2Abs_ << std::endl
           << "  computeNorms   = " << computeNorms_ << std::endl
           << "  solutionStatus = " << toString(solutionStatus_) << std::endl
           << "  output         = " << output_ << std::endl
           << "  outputScreen   = " << outputScreen_ << std::endl
           << "  isSynced       = " << isSynced_ << std::endl
           << "  isInterpolated = " << isInterpolated_ << std::endl
           << "  accuracy       = " << accuracy_ << std::endl;
  }
  *l_out << std::string(this->description().length() + 8, '-') << std::endl;
}

}  // namespace Tempus
#endif  // Tempus_SolutionStateMetaData_impl_hpp