Nektar++
FilterEnergy1D.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FilterEnergy1D.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: Outputs orthogonal expansion of 1D elements.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FILTERS_FILTERENERGY1D_H
37 #define NEKTAR_SOLVERUTILS_FILTERS_FILTERENERGY1D_H
38 
40 
41 namespace Nektar
42 {
43 namespace SolverUtils
44 {
45 /**
46  * @brief Filter for one-dimensional energy spectrum.
47  *
48  * This filter transforms the coefficients of each element into an
49  * orthogonal basis and outputs these coefficients at each timestep. It
50  * can be used to, for example, detect high-order oscillations in the
51  * solution field.
52  */
53 class FilterEnergy1D : public Filter
54 {
55 public:
57 
58  /// Creates an instance of this class
61  const std::map<std::string, std::string> &pParams) {
63  ::AllocateSharedPtr(pSession, pParams);
64  return p;
65  }
66 
67  ///Name of the class
68  static std::string className;
69 
72  const ParamMap &pParams);
74 
75 protected:
76  virtual void v_Initialise(
78  const NekDouble &time);
79  virtual void v_Update(
81  const NekDouble &time);
82  virtual void v_Finalise(
84  const NekDouble &time);
85  virtual bool v_IsTimeDependent();
86 
87 private:
88  /// Output file.
89  ofstream m_out;
90  /// Output frequency.
91  unsigned int m_outputFrequency;
92  /// Current index counter.
93  unsigned int m_index;
94 };
95 }
96 }
97 
98 #endif
virtual void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time)
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
SOLVER_UTILS_EXPORT FilterEnergy1D(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
Set up filter with output file and frequency parameters.
Filter for one-dimensional energy spectrum.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
static std::string className
Name of the class.
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time)
Update filter output with the current timestep's orthogonal coefficients.
SOLVER_UTILS_EXPORT ~FilterEnergy1D()
Destructor.
unsigned int m_index
Current index counter.
virtual void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pField, const NekDouble &time)
Initialize filter.
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
double NekDouble
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
Creates an instance of this class.
#define SOLVER_UTILS_EXPORT
unsigned int m_outputFrequency
Output frequency.