FEApp_CubicSourceFunction.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_CUBICSOURCEFUNCTION_HPP
00033 #define FEAPP_CUBICSOURCEFUNCTION_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 CubicNonlinearFactorParameter;
00045 
00049   template <typename EvalT>
00050   class CubicSourceFunction : 
00051     public FEApp::AbstractSourceFunction<EvalT> {
00052   public:
00053 
00055     typedef typename FEApp::AbstractSourceFunction<EvalT>::ScalarT ScalarT;
00056   
00058     CubicSourceFunction(
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 = "Cubic 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< CubicNonlinearFactorParameter<EvalT> > tmp = 
00069           Teuchos::rcp(new CubicNonlinearFactorParameter<EvalT>(Teuchos::rcp(this,false)));
00070         paramLib->template addEntry<EvalT>(name, tmp);
00071       }
00072     };
00073 
00075     virtual ~CubicSourceFunction() {};
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]*solution[i];
00083       }
00084       
00085     }
00086 
00088     void setFactor(const ScalarT& val, bool mark_constant) { 
00089       alpha = val;
00090       if (mark_constant) Sacado::MarkConstant<ScalarT>::eval(alpha); 
00091     }
00092 
00094     const ScalarT& getFactor() const { return alpha; }
00095 
00096   private:
00097 
00099     CubicSourceFunction(const CubicSourceFunction&);
00100 
00102     CubicSourceFunction& operator=(const CubicSourceFunction&);
00103 
00104   protected:
00105   
00107     ScalarT alpha;
00108 
00109   };
00110 
00115   template <typename EvalT>
00116   class CubicNonlinearFactorParameter : 
00117     public Sacado::ScalarParameterEntry<EvalT,EvaluationTraits> {
00118 
00119   public:
00120 
00122     typedef typename Sacado::ScalarParameterEntry<EvalT,EvaluationTraits>::ScalarT ScalarT;
00123 
00125     CubicNonlinearFactorParameter(
00126       const Teuchos::RCP< CubicSourceFunction<EvalT> >& s) 
00127       : srcFunc(s) {}
00128 
00130     virtual ~CubicNonlinearFactorParameter() {}
00131 
00133     virtual void setRealValue(double value) { 
00134       srcFunc->setFactor(value, true); }
00135     
00137     virtual void setValue(const ScalarT& value) { 
00138       srcFunc->setFactor(value, false); }
00139 
00141     virtual double getRealValue() const {
00142       return Sacado::ScalarValue<ScalarT>::eval(srcFunc->getFactor()); }
00143     
00145     virtual const ScalarT& getValue() const { return srcFunc->getFactor(); }
00146     
00147   protected:  
00148     
00150     Teuchos::RCP< CubicSourceFunction<EvalT> > srcFunc;
00151 
00152   };
00153 
00154 }
00155 
00156 #endif // FEAPP_CUBICSOURCEFUNCTION_HPP

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