SundanceUnknownParameterElement.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                              Sundance
//                 Copyright (2005) Sandia Corporation
// 
// Copyright (year first published) 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 Kevin Long (krlong@sandia.gov), 
// Sandia National Laboratories, Livermore, California, USA
// 
// ************************************************************************
/* @HEADER@ */

#ifndef SUNDANCE_UNKNOWNPARAMETERELEMENT_H
#define SUNDANCE_UNKNOWNPARAMETERELEMENT_H


#include "SundanceDefs.hpp"
#include "SundanceUnknownFuncElement.hpp"
#include "SundanceParameter.hpp"
#include "SundanceUnknownFuncDataStub.hpp"
#include "SundanceSpatiallyConstantExpr.hpp"

namespace Sundance
{
using namespace Sundance;

using namespace Teuchos;




/** 
 * UnknownParameterElement represents an element of an unknown 
 * spatially-constant parameter
 */
class UnknownParameterElement : public UnknownFuncElement,
                                public SpatiallyConstantExpr
{
public:
  /** */
  UnknownParameterElement(const std::string& name,
    const std::string& suffix,
    const FunctionIdentifier& fid);


  /** virtual destructor */
  virtual ~UnknownParameterElement() {;}

      
  /** */
  Evaluator* createEvaluator(const EvaluatableExpr* expr,
    const EvalContext& context) const ;

      

  /** */
  void setValue(const double& value) {parameterValue()->setValue(value);}

  /** */
  const double& value() const {return parameterValue()->value();}

          
  /** */
  Set<MultipleDeriv> 
  internalFindW(int order, const EvalContext& context) const ;
  /** */
  Set<MultipleDeriv> 
  internalFindC(int order, const EvalContext& context) const ;
  /** */
  Set<MultipleDeriv> 
  internalFindV(int order, const EvalContext& context) const ;

  /** */
  bool lessThan(const ScalarExpr* other) const ;

  /** */
  XMLObject toXML() const ;

  /** */
  bool isParameter() const {return true;}

  /** */
  RCP<ExprBase> getRcp() {return rcp(this);}
      
private:

  /** */
  const Parameter* parameterValue() const ;
  /** */
  Parameter* parameterValue() ;
      
};
}

#endif