Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Rythmos_ErrorEstimatorBase.hpp
1//@HEADER
2// ***********************************************************************
3//
4// Rythmos Package
5// Copyright (2006) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// This library is free software; you can redistribute it and/or modify
11// it under the terms of the GNU Lesser General Public License as
12// published by the Free Software Foundation; either version 2.1 of the
13// License, or (at your option) any later version.
14//
15// This library is distributed in the hope that it will be useful, but
16// WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18// Lesser General Public License for more details.
19//
20// You should have received a copy of the GNU Lesser General Public
21// License along with this library; if not, write to the Free Software
22// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
23// USA
24// Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
25//
26// ***********************************************************************
27//@HEADER
28
29#ifndef Rythmos_ERROR_ESTIMATOR_BASE_H
30#define Rythmos_ERROR_ESTIMATOR_BASE_H
31
32#include "Teuchos_Describable.hpp"
33#include "Teuchos_ParameterListAcceptor.hpp"
34#include "Teuchos_VerboseObject.hpp"
35#include "Thyra_ModelEvaluator.hpp"
36
37#include "Rythmos_ErrorEstimateBase.hpp"
38
39namespace Rythmos {
40
41enum ERROR_QUANTITY_OF_INTEREST { INVALID_ERROR_QTY, AVERAGE_ERROR_QTY, ENDPOINT_ERROR_QTY };
42
43template<class Scalar>
44class ErrorEstimatorBase
45 : virtual public Teuchos::Describable
46 , virtual public Teuchos::ParameterListAcceptor
47 , virtual public Teuchos::VerboseObject<ErrorEstimatorBase<Scalar> >
48{
49public:
50
51 // setModel
52 virtual void setModel( const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> > model ) = 0;
53
54 // setQuantityOfInterest
55 virtual void setQuantityOfInterest( ERROR_QUANTITY_OF_INTEREST qtyOfInterest ) = 0;
56
57 // getErrorEstimate
58 virtual Teuchos::RCP<const ErrorEstimateBase<Scalar> > getErrorEstimate() = 0;
59
60};
61
62
63} // namespace Rythmos
64
65
66#endif // Rythmos_ERROR_ESTIMATOR_BASE_H