00001 /* @HEADER@ */ 00002 // ************************************************************************ 00003 // 00004 // Sundance 00005 // Copyright 2011 Sandia Corporation 00006 // 00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, 00008 // the U.S. Government retains certain rights in this software. 00009 // 00010 // Redistribution and use in source and binary forms, with or without 00011 // modification, are permitted provided that the following conditions are 00012 // met: 00013 // 00014 // 1. Redistributions of source code must retain the above copyright 00015 // notice, this list of conditions and the following disclaimer. 00016 // 00017 // 2. Redistributions in binary form must reproduce the above copyright 00018 // notice, this list of conditions and the following disclaimer in the 00019 // documentation and/or other materials provided with the distribution. 00020 // 00021 // 3. Neither the name of the Corporation nor the names of the 00022 // contributors may be used to endorse or promote products derived from 00023 // this software without specific prior written permission. 00024 // 00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY 00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE 00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00036 // 00037 // Questions? Contact Kevin Long (kevin.long@ttu.edu) 00038 // 00039 00040 /* @HEADER@ */ 00041 00042 #ifndef SUNDANCE_SCALAREXPR_H 00043 #define SUNDANCE_SCALAREXPR_H 00044 00045 00046 #include "SundanceDefs.hpp" 00047 #include "PlayaExceptions.hpp" 00048 #include "Teuchos_XMLObject.hpp" 00049 #include "Teuchos_RefCountPtrDecl.hpp" 00050 #include "SundanceExprBase.hpp" 00051 #include "SundanceExpr.hpp" 00052 00053 namespace Sundance 00054 { 00055 00056 using namespace Sundance; 00057 using namespace Teuchos; 00058 00059 00060 00061 00062 00063 /** */ 00064 class ScalarExpr : virtual public ExprBase 00065 { 00066 public: 00067 /** empty ctor */ 00068 ScalarExpr(); 00069 00070 /** virtual destructor */ 00071 virtual ~ScalarExpr() {;} 00072 00073 00074 /** Indicate whether this expression is constant in space */ 00075 virtual bool isConstant() const {return false;} 00076 00077 00078 /** Indicate whether this expression is an immutable constant */ 00079 virtual bool isImmutable() const {return false;} 00080 00081 /** Indicate whether this expression is a "hungry" 00082 * differential operator that is awaiting an argument. */ 00083 virtual bool isHungryDiffOp() const {return false;} 00084 00085 /** Indicate whether the expression is independent of the given 00086 * functions */ 00087 virtual bool isIndependentOf(const Expr& u) const {return true;} 00088 00089 /** 00090 * Indicate whether the expression is nonlinear 00091 * with respect to test functions */ 00092 virtual bool isLinearInTests() const {return false;} 00093 00094 /** 00095 * Indicate whether every term in the expression contains test functions */ 00096 virtual bool everyTermHasTestFunctions() const {return hasTestFunctions();} 00097 00098 /** 00099 * Indicate whether the expression contains test functions */ 00100 virtual bool hasTestFunctions() const {return false;} 00101 /** 00102 * Indicate whether the expression contains unknown functions */ 00103 virtual bool hasUnkFunctions() const {return false;} 00104 00105 /** Indicate whether the expression is linear in the given 00106 * functions */ 00107 virtual bool isLinearForm(const Expr& u) const {return false;} 00108 00109 /** Indicate whether the expression is quadratic in the given 00110 * functions */ 00111 virtual bool isQuadraticForm(const Expr& u) const {return false;} 00112 00113 /** Find all the unknown functions in this expression. */ 00114 virtual void getUnknowns(Set<int>& unkID, Array<Expr>& unks) const {;} 00115 00116 /** Find all the test functions in this expression. */ 00117 virtual void getTests(Set<int>& varID, Array<Expr>& vars) const {;} 00118 00119 /** Ordering operator for use in transforming exprs 00120 * to standard form */ 00121 virtual bool lessThan(const ScalarExpr* other) const = 0 ; 00122 00123 00124 protected: 00125 private: 00126 }; 00127 } 00128 00129 #endif