FEApp_QuadraticSourceFunction.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_QUADRATICSOURCEFUNCTION_HPP
00033 #define FEAPP_QUADRATICSOURCEFUNCTION_HPP
00034 
00035 #include "FEApp_AbstractSourceFunction.hpp"
00036 
00037 #include "Teuchos_RCP.hpp"
00038 #include "Sacado_ScalarParameterLibrary.hpp"
00039 #include "Sacado_ScalarParameterEntry.hpp"
00040 #include "Sacado_Traits.hpp"
00041 
00042 namespace FEApp {
00043 
00044   template <typename EvalT> class QuadraticNonlinearFactorParameter;
00045 
00049   template <typename EvalT>
00050   class QuadraticSourceFunction : 
00051     public FEApp::AbstractSourceFunction<EvalT> {
00052   public:
00053 
00055     typedef typename FEApp::AbstractSourceFunction<EvalT>::ScalarT ScalarT;
00056   
00058     QuadraticSourceFunction(
00059          const ScalarT& factor,
00060          const Teuchos::RCP<ParamLib>& paramLib) : 
00061       alpha(factor) 
00062     {
00063       // Add nonlinear factor to parameter library
00064       std::string name = "Quadratic Source Function Nonlinear Factor";
00065       if (!paramLib->isParameter(name))
00066         paramLib->addParameterFamily(name, true, false);
00067       if (!paramLib->template isParameterForType<EvalT>(name)) {
00068         Teuchos::RCP< QuadraticNonlinearFactorParameter<EvalT> > tmp = 
00069           Teuchos::rcp(new QuadraticNonlinearFactorParameter<EvalT>(Teuchos::rcp(this,false)));
00070         paramLib->template addEntry<EvalT>(name, tmp);
00071       }
00072     };
00073 
00075     virtual ~QuadraticSourceFunction() {};
00076 
00078     virtual void
00079     evaluate(const std::vector<ScalarT>& solution,
00080              std::vector<ScalarT>& value) const {
00081       for (unsigned int i=0; i<solution.size(); i++)
00082         value[i] = alpha*solution[i]*solution[i];
00083     }
00084 
00086     void setFactor(const ScalarT& val, bool mark_constant) { 
00087       alpha = val; 
00088       if (mark_constant) Sacado::MarkConstant<ScalarT>::eval(alpha); 
00089     }
00090 
00092     const ScalarT& getFactor() const { return alpha; }
00093 
00094   private:
00095 
00097     QuadraticSourceFunction(const QuadraticSourceFunction&);
00098 
00100     QuadraticSourceFunction& operator=(const QuadraticSourceFunction&);
00101 
00102   protected:
00103   
00105     ScalarT alpha;
00106 
00107   };
00108 
00113   template <typename EvalT>
00114   class QuadraticNonlinearFactorParameter : 
00115     public Sacado::ScalarParameterEntry<EvalT,EvaluationTraits> {
00116 
00117   public:
00118 
00120     typedef typename Sacado::ScalarParameterEntry<EvalT,EvaluationTraits>::ScalarT ScalarT;
00121 
00123     QuadraticNonlinearFactorParameter(
00124       const Teuchos::RCP< QuadraticSourceFunction<EvalT> >& s) : 
00125       srcFunc(s) {}
00126 
00128     virtual ~QuadraticNonlinearFactorParameter() {}
00129 
00131     virtual void setRealValue(double value) { 
00132       srcFunc->setFactor(value, true); }
00133     
00135     virtual void setValue(const ScalarT& value) { 
00136       srcFunc->setFactor(value, false); }
00137 
00139     virtual double getRealValue() const { 
00140       return Sacado::ScalarValue<ScalarT>::eval(srcFunc->getFactor()); }
00141     
00143     virtual const ScalarT& getValue() const { return srcFunc->getFactor(); }
00144     
00145   protected:  
00146     
00148     Teuchos::RCP< QuadraticSourceFunction<EvalT> > srcFunc;
00149 
00150   };
00151 
00152 }
00153 
00154 #endif // FEAPP_QUADRATICSOURCEFUNCTION_HPP

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