FEApp_ConstantFunction.hpp

Go to the documentation of this file.
00001 // $Id$ 
00002 // $Source$ 
00003 // @HEADER
00004 // ***********************************************************************
00005 // 
00006 //                           Sacado Package
00007 //                 Copyright (2006) Sandia Corporation
00008 // 
00009 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00010 // the U.S. Government retains certain rights in this software.
00011 // 
00012 // This library is free software; you can redistribute it and/or modify
00013 // it under the terms of the GNU Lesser General Public License as
00014 // published by the Free Software Foundation; either version 2.1 of the
00015 // License, or (at your option) any later version.
00016 //  
00017 // This library is distributed in the hope that it will be useful, but
00018 // WITHOUT ANY WARRANTY; without even the implied warranty of
00019 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00020 // Lesser General Public License for more details.
00021 //  
00022 // You should have received a copy of the GNU Lesser General Public
00023 // License along with this library; if not, write to the Free Software
00024 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00025 // USA
00026 // Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
00027 // (etphipp@sandia.gov).
00028 // 
00029 // ***********************************************************************
00030 // @HEADER
00031 
00032 #ifndef FEAPP_CONSTANTFUNCTION_HPP
00033 #define FEAPP_CONSTANTFUNCTION_HPP
00034 
00035 #include "FEApp_AbstractFunction.hpp"
00036 
00037 #include "Teuchos_RCP.hpp"
00038 #include "Sacado_ScalarParameterLibrary.hpp"
00039 #include "Sacado_ParameterRegistration.hpp"
00040 #include "Sacado_Traits.hpp"
00041 
00042 namespace FEApp {
00043 
00047   template <typename EvalT>
00048   class ConstantFunction : 
00049     public FEApp::AbstractFunction<EvalT>,
00050     public Sacado::ParameterAccessor<EvalT, FEApp::EvaluationTraits> {
00051   public:
00052 
00054     typedef typename FEApp::AbstractFunction<EvalT>::ScalarT ScalarT;
00055   
00057     ConstantFunction(
00058          const ScalarT& value,
00059          const Teuchos::RCP<ParamLib>& paramLib) : 
00060       val(value) 
00061     {
00062       // Add val to parameter library
00063       std::string name = "Constant Function Value";
00064       // Register this name and *this* class with the Parameter Library
00065       new Sacado::ParameterRegistration<EvalT, FEApp::EvaluationTraits>(name, this, paramLib);
00066     };
00067 
00069     virtual ~ConstantFunction() {};
00070 
00072     virtual void
00073     evaluate(const std::vector<double>& quad_points,
00074        std::vector<ScalarT>& value) const {
00075       for (unsigned int i=0; i<quad_points.size(); i++) {
00076         value[i] = val;
00077       }
00078     };
00079 
00081     ScalarT& getValue(const std::string &n) {
00082       if (n == "Constant Function Value") return val;
00083       else {
00084         TEST_FOR_EXCEPTION(true, Teuchos::Exceptions::InvalidParameter,
00085                        std::endl <<
00086                        "Error! Logic error in setting paramter " << n
00087                        << " in FEApp_ConstantFunction.hpp" << std::endl)
00088         return val;
00089       }
00090     };
00091 
00092   private:
00093 
00095     ConstantFunction(const ConstantFunction&);
00096 
00098     ConstantFunction& operator=(const ConstantFunction&);
00099 
00100   protected:
00101   
00103     ScalarT val;
00104 
00105   };
00106 }
00107 
00108 #endif // FEAPP_CONSTANTFUNCTION_HPP

Generated on Wed May 12 21:39:32 2010 for Sacado Package Browser (Single Doxygen Collection) by  doxygen 1.4.7