Rythmos - Transient Integration for Differential Equations Version of the Day
Rythmos_ErrorEstimatorBase.hpp
00001 //@HEADER
00002 // ***********************************************************************
00003 //
00004 //                     Rythmos Package
00005 //                 Copyright (2006) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
00023 // USA
00024 // Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 //@HEADER
00028 
00029 #ifndef Rythmos_ERROR_ESTIMATOR_BASE_H
00030 #define Rythmos_ERROR_ESTIMATOR_BASE_H
00031 
00032 #include "Teuchos_Describable.hpp"
00033 #include "Teuchos_ParameterListAcceptor.hpp"
00034 #include "Teuchos_VerboseObject.hpp"
00035 #include "Thyra_ModelEvaluator.hpp"
00036 
00037 #include "Rythmos_ErrorEstimateBase.hpp"
00038 
00039 namespace Rythmos {
00040 
00041 enum ERROR_QUANTITY_OF_INTEREST { INVALID_ERROR_QTY, AVERAGE_ERROR_QTY, ENDPOINT_ERROR_QTY };
00042 
00043 template<class Scalar> 
00044 class ErrorEstimatorBase
00045   : virtual public Teuchos::Describable
00046   , virtual public Teuchos::ParameterListAcceptor
00047   , virtual public Teuchos::VerboseObject<ErrorEstimatorBase<Scalar> >
00048 {
00049 public:
00050 
00051   // setModel
00052   virtual void setModel( const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> > model ) = 0;
00053   
00054   // setQuantityOfInterest
00055   virtual void setQuantityOfInterest( ERROR_QUANTITY_OF_INTEREST qtyOfInterest ) = 0;
00056 
00057   // getErrorEstimate
00058   virtual Teuchos::RCP<const ErrorEstimateBase<Scalar> > getErrorEstimate() = 0;
00059 
00060 };
00061 
00062 
00063 } // namespace Rythmos
00064 
00065 
00066 #endif // Rythmos_ERROR_ESTIMATOR_BASE_H
 All Classes Functions Variables Typedefs Friends