Tutorial_Regression_Tester.hpp

Go to the documentation of this file.

 
#include <iostream>
#include <cmath>
 
#include "Teuchos_RCP.hpp"
#include "Teuchos_as.hpp"
 
#include "Thyra_VectorBase.hpp"
#include "Thyra_VectorStdOps.hpp"
#include "Thyra_DefaultSpmdVectorSpace.hpp"
#include "Thyra_DetachedVectorView.hpp"
 
#include "Tempus_SolutionState.hpp"
 
inline bool tutorialRegressionTest(
    const Teuchos::RCP<Thyra::VectorBase<double> >& x_n,
    std::ostream& out = std::cout,
    const double relTol = Teuchos::as<double>(1.0e-8))
{
  out << std::scientific;
  auto x_regress = x_n->clone_v();
  {
    Thyra::DetachedVectorView<double> x_regress_view(*x_regress);
    x_regress_view[0] = Teuchos::as<double>(-1.59496108218721311);
    x_regress_view[1] = Teuchos::as<double>( 0.96359412806611255);
  }
 
  auto x_error = x_n->clone_v();
  Thyra::V_VmV(x_error.ptr(), *x_n, *x_regress);
 
  const double x_L2norm_error   = Thyra::norm_2(*x_error);
  const double x_L2norm_regress = Thyra::norm_2(*x_regress);
  const double relError = x_L2norm_error / x_L2norm_regress;
 
  out << "Relative L2 Norm of the error (regression) = "
      << relError << std::endl;
 
  if (x_L2norm_error > relTol * x_L2norm_regress) {
    out << "FAILED regression constraint!" << std::endl;
    return false;
  }
 
  return true;
}
 
inline bool tutorialRegressionTest(
    const Teuchos::RCP<Tempus::SolutionState<double> >& solState,
    std::ostream& out = std::cout,
    const double relTol = Teuchos::as<double>(1.0e-8))
{
  return tutorialRegressionTest(solState->getX(), out, relTol);
}
 
template<int N>
inline bool tutorialRegressionTest(
    const double (&x_n)[N],
    std::ostream& out = std::cout,
    const double relTol = Teuchos::as<double>(1.0e-8))
{
  Teuchos::RCP<const Thyra::VectorSpaceBase<double> > xSpace =
    Thyra::defaultSpmdVectorSpace<double>(N);
  Teuchos::RCP<Thyra::VectorBase<double> > x_vec = Thyra::createMember(xSpace);
  {
    Thyra::DetachedVectorView<double> x_view(*x_vec);
    for (int i = 0; i < N; ++i)
      x_view[i] = x_n[i];
  }
 
  return tutorialRegressionTest(x_vec, out, relTol);
}