Nektar++
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 ParamMap &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 ParamMap &pParams);
80 
81 protected:
82  virtual void v_Initialise(
84  const NekDouble &time);
85  virtual void v_Update(
87  const NekDouble &time);
88  virtual void v_Finalise(
90  const NekDouble &time);
91  virtual bool v_IsTimeDependent();
94  unsigned int field,
95  const NekDouble &time);
96  void SetUpBaseFields(
98  void ImportFldBase(
99  std::string pInfile,
101 
102 private:
106 
107  // ID's of boundary regions where we want the forces
108  vector<unsigned int> m_boundaryRegionsIdList;
109  // Determines if a given Boundary Region is in
110  // m_boundaryRegionsIdList
112  unsigned int m_index;
113  unsigned int m_outputFrequency;
114  // plane to take history point from if using a homogeneous1D
115  // expansion
116  unsigned int m_outputPlane;
121  int m_nproc;
122  std::string m_outputFile;
123  std::string m_EqTypeStr;
124  std::ofstream m_outputStream;
126  std::string m_BoundaryString;
132  bool m_useFFT;
135 };
136 }
137 }
138 
139 #endif
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
enum MultiRegions::ProjectionType m_projectionType
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...
virtual void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
ProjectionType
Type of Galerkin projection.
Array< OneD, MultiRegions::ExpListSharedPtr > m_base
vector< unsigned int > m_boundaryRegionsIdList
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
LibUtilities::FieldIOSharedPtr m_fld
void SetUpBaseFields(SpatialDomains::MeshGraphSharedPtr &mesh)
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
boost::shared_ptr< FieldIO > FieldIOSharedPtr
Definition: FieldIO.h:236
double NekDouble
void ImportFldBase(std::string pInfile, SpatialDomains::MeshGraphSharedPtr pGraph)
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
NekDouble L2Error(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, unsigned int field, const NekDouble &time)
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
#define SOLVER_UTILS_EXPORT
LibUtilities::BasisSharedPtr m_homogeneousBasis
SOLVER_UTILS_EXPORT FilterModalEnergy(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
virtual SOLVER_UTILS_EXPORT ~FilterModalEnergy()
boost::shared_ptr< Basis > BasisSharedPtr
boost::shared_ptr< MeshGraph > MeshGraphSharedPtr
Definition: MeshGraph.h:432