00001 /* @HEADER@ */ 00002 // ************************************************************************ 00003 // 00004 // Sundance 00005 // Copyright (2005) Sandia Corporation 00006 // 00007 // Copyright (year first published) Sandia Corporation. Under the terms 00008 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 00009 // retains certain rights in this software. 00010 // 00011 // This library is free software; you can redistribute it and/or modify 00012 // it under the terms of the GNU Lesser General Public License as 00013 // published by the Free Software Foundation; either version 2.1 of the 00014 // License, or (at your option) any later version. 00015 // 00016 // This library is distributed in the hope that it will be useful, but 00017 // WITHOUT ANY WARRANTY; without even the implied warranty of 00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00019 // Lesser General Public License for more details. 00020 // 00021 // You should have received a copy of the GNU Lesser General Public 00022 // License along with this library; if not, write to the Free Software 00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 00024 // USA 00025 // Questions? Contact Kevin Long (krlong@sandia.gov), 00026 // Sandia National Laboratories, Livermore, California, USA 00027 // 00028 // ************************************************************************ 00029 /* @HEADER@ */ 00030 00031 #ifndef SUNDANCE_DERIVATIVE_H 00032 #define SUNDANCE_DERIVATIVE_H 00033 00034 #include "SundanceDefs.hpp" 00035 #include "SundanceScalarExpr.hpp" 00036 #include "SundanceMultiIndex.hpp" 00037 #include "Teuchos_XMLObject.hpp" 00038 00039 namespace Sundance 00040 { 00041 using namespace Sundance; 00042 using namespace Teuchos; 00043 00044 00045 00046 00047 /** 00048 * Derivative is an expression subtype representing 00049 * a first-order spatial partial derivative operator. 00050 */ 00051 class Derivative : public ScalarExpr 00052 { 00053 public: 00054 /** Construct an operator for spatial differentiation with respect to 00055 * the given direction (0=x, 1=y, or 2=z). */ 00056 Derivative(int direction); 00057 00058 /** virtual destructor */ 00059 virtual ~Derivative() {;} 00060 00061 /** */ 00062 virtual XMLObject toXML() const ; 00063 00064 /** Indicate whether this expression is a "hungry" 00065 * differential operator that is awaiting an argument. */ 00066 virtual bool isHungryDiffOp() const {return true;} 00067 00068 /** */ 00069 virtual std::ostream& toText(std::ostream& os, bool paren) const ; 00070 00071 /** */ 00072 const MultiIndex& multiIndex() const {return m_;} 00073 00074 /** */ 00075 virtual RCP<ExprBase> getRcp() {return rcp(this);} 00076 00077 /** Ordering operator for use in transforming exprs to standard form */ 00078 virtual bool lessThan(const ScalarExpr* other) const ; 00079 00080 00081 private: 00082 MultiIndex m_; 00083 00084 }; 00085 } 00086 00087 #endif