Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FilterModalEnergy.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FilterModalEnergy.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 values at the modal energy.
33 
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FILTERS_FILTERMODALENERGY_H
37 #define NEKTAR_SOLVERUTILS_FILTERS_FILTERMODALENERGY_H
38 
46 
47 #include <MultiRegions/ExpList2D.h> // for ExpList2D, etc
48 #include <MultiRegions/ExpList3D.h> // for ExpList3D
51 
52 
53 namespace Nektar
54 {
55  namespace SolverUtils
56  {
57  class FilterModalEnergy : public Filter
58  {
59  public:
61 
62  // Creates an instance of this class
65  const std::map<std::string, std::string> &pParams)
66  {
68  AllocateSharedPtr(pSession, pParams);
69  //p->InitObject();
70  return p;
71  }
72 
73  // Name of the class
74  static std::string className;
75 
78  const std::map<std::string, std::string> &pParams);
80 
81  protected:
82  virtual void v_Initialise(
83  const Array<OneD,
84  const MultiRegions::ExpListSharedPtr> &pFields,
85  const NekDouble &time);
86  virtual void v_Update(
87  const Array<OneD,
88  const MultiRegions::ExpListSharedPtr> &pFields,
89  const NekDouble &time);
90  virtual void v_Finalise(
91  const Array<OneD,
92  const MultiRegions::ExpListSharedPtr> &pFields,
93  const NekDouble &time);
94  virtual bool v_IsTimeDependent();
96  const Array<OneD,
97  const MultiRegions::ExpListSharedPtr> &pFields,
98  unsigned int field,
99  const NekDouble &time);
100  void SetUpBaseFields(
102  void ImportFldBase(
103  std::string pInfile,
105 
106  private:
108  Array<OneD, MultiRegions::ExpListSharedPtr> m_base;
110 
111  // ID's of boundary regions where we want the forces
112  vector<unsigned int> m_boundaryRegionsIdList;
113  // Determines if a given Boundary Region is in
114  // m_boundaryRegionsIdList
116  unsigned int m_index;
117  unsigned int m_outputFrequency;
118  // plane to take history point from if using a homogeneous1D
119  // expansion
120  unsigned int m_outputPlane;
125  int m_nproc;
126  std::string m_outputFile;
127  std::string m_EqTypeStr;
128  std::ofstream m_outputStream;
130  std::string m_BoundaryString;
136  bool m_useFFT;
139  };
140  }
141 }
142 
143 #endif