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