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