FEApp_CubicSourceFunction.hpp

Go to the documentation of this file.

// $Id: FEApp_CubicSourceFunction.hpp,v 1.2 2008/05/16 19:56:56 etphipp Exp $ 
// $Source: /space/CVS/Trilinos/packages/sacado/example/FEApp/FEApp_CubicSourceFunction.hpp,v $ 
// @HEADER
// ***********************************************************************
// 
//                           Sacado Package
//                 Copyright (2006) Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#ifndef FEAPP_CUBICSOURCEFUNCTION_HPP
#define FEAPP_CUBICSOURCEFUNCTION_HPP

#include "FEApp_AbstractSourceFunction.hpp"

#include "Teuchos_RCP.hpp"
#include "Sacado_ScalarParameterLibrary.hpp"
#include "Sacado_ScalarParameterEntry.hpp"
#include "Sacado_Traits.hpp"

namespace FEApp {

  template <typename ScalarT> class CubicNonlinearFactorParameter;

  template <typename ScalarT>
  class CubicSourceFunction : 
    public FEApp::AbstractSourceFunction<ScalarT> {
  public:
  
    CubicSourceFunction(
         const ScalarT& factor,
         const Teuchos::RCP<Sacado::ScalarParameterLibrary>& paramLib) : 
      alpha(factor) 
    {
      // Add nonlinear factor to parameter library
      std::string name = "Cubic Source Function Nonlinear Factor";
      if (!paramLib->isParameter(name))
  paramLib->addParameterFamily(name, true, false);
      if (!paramLib->template isParameterForType<ScalarT>(name)) {
  Teuchos::RCP< CubicNonlinearFactorParameter<ScalarT> > tmp = 
    Teuchos::rcp(new CubicNonlinearFactorParameter<ScalarT>(Teuchos::rcp(this,false)));
  paramLib->template addEntry<ScalarT>(name, tmp);
      }
    };

    virtual ~CubicSourceFunction() {};

    virtual void
    evaluate(const std::vector<ScalarT>& solution,
       std::vector<ScalarT>& value) const {
      for (unsigned int i=0; i<solution.size(); i++) {
  value[i] = alpha*solution[i]*solution[i]*solution[i];
      }
      
    }

    void setFactor(const ScalarT& val, bool mark_constant) { 
      alpha = val;
      if (mark_constant) Sacado::MarkConstant<ScalarT>::eval(alpha); 
    }

    const ScalarT& getFactor() const { return alpha; }

  private:

    CubicSourceFunction(const CubicSourceFunction&);

    CubicSourceFunction& operator=(const CubicSourceFunction&);

  protected:
  
    ScalarT alpha;

  };

  template <typename ScalarT>
  class CubicNonlinearFactorParameter : 
    public Sacado::ScalarParameterEntry<ScalarT> {

  public:

    CubicNonlinearFactorParameter(
      const Teuchos::RCP< CubicSourceFunction<ScalarT> >& s) 
      : srcFunc(s) {}

    virtual ~CubicNonlinearFactorParameter() {}

    virtual void setRealValue(double value) { 
      setValueAsConstant(ScalarT(value)); }

    virtual void setValueAsConstant(const ScalarT& value) { 
      srcFunc->setFactor(value, true); }
    
    virtual void setValueAsIndependent(const ScalarT& value) { 
      srcFunc->setFactor(value, false); }
    
    virtual const ScalarT& getValue() const { return srcFunc->getFactor(); }
    
  protected:  
    
    Teuchos::RCP< CubicSourceFunction<ScalarT> > srcFunc;

  };

}

#endif // FEAPP_CUBICSOURCEFUNCTION_HPP

---