Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Filter.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File Filter.h
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Base class for filters.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FILTER_FILTER_H
37 #define NEKTAR_SOLVERUTILS_FILTER_FILTER_H
38 
41 #include <MultiRegions/ExpList.h>
43 
45 
46 namespace Nektar
47 {
48 namespace SolverUtils
49 {
50 class Filter;
51 
52 /// A shared pointer to a Driver object
53 typedef boost::shared_ptr<Filter> FilterSharedPtr;
54 
55 /// Datatype of the NekFactory used to instantiate classes derived from
56 /// the Driver class.
58  std::string, Filter,
60  const std::map<std::string, std::string>&
63 
64 class Filter
65 {
66 public:
67  typedef std::map<std::string, std::string> ParamMap;
69  const LibUtilities::SessionReaderSharedPtr& pSession);
70  SOLVER_UTILS_EXPORT virtual ~Filter();
71 
72  SOLVER_UTILS_EXPORT inline void Initialise(
74  const NekDouble &time);
75  SOLVER_UTILS_EXPORT inline void Update(
77  const NekDouble &time);
78  SOLVER_UTILS_EXPORT inline void Finalise(
80  const NekDouble &time);
82 
83 protected:
84  LibUtilities::SessionReaderSharedPtr m_session;
85 
86  virtual void v_Initialise(
88  const NekDouble &time) = 0;
89  virtual void v_Update(
91  const NekDouble &time) = 0;
92  virtual void v_Finalise(
94  const NekDouble &time) = 0;
95  virtual bool v_IsTimeDependent() = 0;
96 };
97 
98 inline void Filter::Initialise(
100  const NekDouble &time)
101 {
102  v_Initialise(pFields, time);
103 }
104 
105 inline void Filter::Update(
107  const NekDouble &time)
108 {
109  v_Update(pFields, time);
110 }
111 
112 inline void Filter::Finalise(
114  const NekDouble &time)
115 {
116  v_Finalise(pFields, time);
117 }
118 
120 {
121  return v_IsTimeDependent();
122 }
123 }
124 }
125 #endif /* NEKTAR_SOLVERUTILS_FILTER_FILTER_H */
virtual SOLVER_UTILS_EXPORT ~Filter()
Definition: Filter.cpp:57
SOLVER_UTILS_EXPORT void Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Definition: Filter.h:112
LibUtilities::NekFactory< std::string, Filter, const LibUtilities::SessionReaderSharedPtr &, const std::map< std::string, std::string > & > FilterFactory
Datatype of the NekFactory used to instantiate classes derived from the Driver class.
Definition: Filter.h:61
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
SOLVER_UTILS_EXPORT void Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Definition: Filter.h:98
SOLVER_UTILS_EXPORT Filter(const LibUtilities::SessionReaderSharedPtr &pSession)
Definition: Filter.cpp:52
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
SOLVER_UTILS_EXPORT bool IsTimeDependent()
Definition: Filter.h:119
double NekDouble
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
virtual void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:84
virtual bool v_IsTimeDependent()=0
SOLVER_UTILS_EXPORT void Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Definition: Filter.h:105
#define SOLVER_UTILS_EXPORT
FilterFactory & GetFilterFactory()
Definition: Filter.cpp:42
virtual void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)=0
Provides a generic Factory class.
Definition: NekFactory.hpp:116