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_UNKNOWNFUNCTIONSTUB_H 00032 #define SUNDANCE_UNKNOWNFUNCTIONSTUB_H 00033 00034 #include "SundanceDefs.hpp" 00035 #include "SundanceSymbolicFunc.hpp" 00036 #include "SundanceUnknownFuncDataStub.hpp" 00037 #include "SundanceSpectralBasis.hpp" 00038 #include "SundanceSpectralExpr.hpp" 00039 00040 namespace Sundance 00041 { 00042 using namespace Teuchos; 00043 00044 /** 00045 * UnknownFunctionStub is the base class for unknown functions. 00046 * Each framework will need to implement its own subclass of 00047 * UnknownFunctionStub. 00048 * 00049 * The interface is left very minimal so as to not place 00050 * any constraints on how a framework might specify the basis. 00051 * When a framework needs any information about the 00052 * unknown function, it will have to get it by downcasting 00053 * to the appropriate framework-specific subclass. 00054 * 00055 * <h4> Writing a UnknownFunctionStub subclass </h4> 00056 * 00057 * For purposes of interaction with the Sundance core, no 00058 * additional methods are required. 00059 * However, most frameworks will require extensions to 00060 * UnknownFunctionStub that can supply the framework with information 00061 * on the basis used by the unknown func. See the 00062 * demo and standard frameworks for information on how to do this. 00063 */ 00064 class UnknownFunctionStub : public SymbolicFunc 00065 { 00066 public: 00067 /** */ 00068 UnknownFunctionStub(const std::string& name, 00069 int tensorOrder=0, int dim=1, 00070 const RCP<const UnknownFuncDataStub>& data=RCP<const UnknownFuncDataStub>()); 00071 00072 /** */ 00073 UnknownFunctionStub(const std::string& name, const SpectralBasis& sbasis, 00074 int tensorOrder=0, int dim=1, 00075 const RCP<const UnknownFuncDataStub>& data=RCP<const UnknownFuncDataStub>()); 00076 00077 /** virtual destructor */ 00078 virtual ~UnknownFunctionStub() {;} 00079 00080 /** */ 00081 bool isUnknownFunction() const {return true;} 00082 00083 /** */ 00084 virtual RCP<ExprBase> getRcp() {return rcp(this);} 00085 00086 protected: 00087 00088 /** */ 00089 const RCP<const UnknownFuncDataStub>& dataStub() const {return data_;} 00090 00091 private: 00092 RCP<const UnknownFuncDataStub> data_; 00093 00094 00095 }; 00096 } 00097 00098 00099 #endif