Teuchos Package Browser (Single Doxygen Collection) Version of the Day
AlgorithmA.hpp
Go to the documentation of this file.
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 //
00005 //                    Teuchos: Common Tools Package
00006 //                 Copyright (2004) Sandia Corporation
00007 //
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00039 //
00040 // ***********************************************************************
00041 // @HEADER
00042 */
00043 
00044 #include "Teuchos_ParameterListAcceptor.hpp"
00045 #include "Teuchos_VerboseObject.hpp"
00046 
00047 #ifndef TEUCHOS_ALGORITHM_A_HPP
00048 #define TEUCHOS_ALGORITHM_A_HPP
00049 
00050 
00051 void someDumbFunction( std::ostream &out, const std::string &indentSpacer );
00052 
00053 
00054 void someLessDumbFunction( std::ostream &out_arg );
00055 
00056 
00057 // This is a typical numerical class that derives from VerboseObject and does
00058 // outputting.  Note that the use of the OSTab class requires initialization
00059 // using VerboseObject::getOSTab(...) which takes care of the hassles and is
00060 // easy to use.
00061 //
00062 // This class also derives from ParameterListAcceptor and uses helper
00063 // functio  ns to read options for VerboseObject from a parameter sublist.
00064 class AlgorithmA
00065   : public Teuchos::VerboseObject<AlgorithmA>,
00066     public Teuchos::ParameterListAcceptor
00067 {
00068 public:
00069 
00070   // Constructor(s)
00071 
00072   AlgorithmA();
00073 
00074   // Overridden from ParameterListAccpetor
00075 
00076   void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const& paramList);
00077 
00078   Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
00079 
00080   Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
00081 
00082   Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
00083 
00084   Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
00085 
00086   // Other functions
00087 
00088   void doAlgorithm();
00089 
00090 private:
00091 
00092   enum EAlgoType { ALGO_BOB, ALGO_JOHN, ALGO_HARRY };
00093 
00094   static const std::string toString( AlgorithmA::EAlgoType algoType );
00095 
00096   Teuchos::RCP<Teuchos::ParameterList> paramList_;
00097   EAlgoType algoType_;
00098   double algoTol_;
00099   
00100 };
00101 
00102 
00103 #endif // TEUCHOS_ALGORITHM_A_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines