Nektar++
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties 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// Permission is hereby granted, free of charge, to any person obtaining a
14// copy of this software and associated documentation files (the "Software"),
15// to deal in the Software without restriction, including without limitation
16// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17// and/or sell copies of the Software, and to permit persons to whom the
18// Software is furnished to do so, subject to the following conditions:
19//
20// The above copyright notice and this permission notice shall be included
21// in all copies or substantial portions of the Software.
22//
23// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29// DEALINGS IN THE SOFTWARE.
30//
31// Description: Outputs values at the modal energy.
32
33///////////////////////////////////////////////////////////////////////////////
34
35#ifndef NEKTAR_SOLVERUTILS_FILTERS_FILTERMODALENERGY_H
36#define NEKTAR_SOLVERUTILS_FILTERS_FILTERMODALENERGY_H
37
42
46
47namespace Nektar
48{
49namespace SolverUtils
50{
52{
53public:
54 friend class MemoryManager<FilterModalEnergy>;
55
56 // Creates an instance of this class
59 const std::weak_ptr<EquationSystem> &pEquation, const ParamMap &pParams)
60 {
62 pSession, pEquation, pParams);
63 return p;
64 }
65
66 // Name of the class
67 static std::string className;
68
71 const std::weak_ptr<EquationSystem> &pEquation,
72 const ParamMap &pParams);
74
75protected:
76 virtual void v_Initialise(
78 const NekDouble &time) override;
79 virtual void v_Update(
81 const NekDouble &time) override;
82 virtual void v_Finalise(
84 const NekDouble &time) override;
85 virtual bool v_IsTimeDependent() override;
88 unsigned int field, const NekDouble &time);
90 void ImportFldBase(std::string pInfile);
91
92private:
96
97 // ID's of boundary regions where we want the forces
98 std::vector<unsigned int> m_boundaryRegionsIdList;
99 // Determines if a given Boundary Region is in
100 // m_boundaryRegionsIdList
101 std::vector<bool> m_boundaryRegionIsInList;
102 unsigned int m_index;
103 unsigned int m_outputFrequency;
104 // plane to take history point from if using a homogeneous1D
105 // expansion
106 unsigned int m_outputPlane;
112 std::string m_outputFile;
113 std::string m_EqTypeStr;
114 std::ofstream m_outputStream;
116 std::string m_BoundaryString;
125};
126
127} // namespace SolverUtils
128} // namespace Nektar
129
130#endif
#define SOLVER_UTILS_EXPORT
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
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) override
virtual void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
LibUtilities::BasisSharedPtr m_homogeneousBasis
enum MultiRegions::ProjectionType m_projectionType
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const ParamMap &pParams)
LibUtilities::FieldIOSharedPtr m_fld
SOLVER_UTILS_EXPORT FilterModalEnergy(const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const ParamMap &pParams)
std::vector< unsigned int > m_boundaryRegionsIdList
NekDouble L2Error(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, unsigned int field, const NekDouble &time)
Array< OneD, MultiRegions::ExpListSharedPtr > m_base
virtual SOLVER_UTILS_EXPORT ~FilterModalEnergy()
void SetUpBaseFields(SpatialDomains::MeshGraphSharedPtr &mesh)
std::shared_ptr< Basis > BasisSharedPtr
std::shared_ptr< FieldIO > FieldIOSharedPtr
Definition: FieldIO.h:327
std::shared_ptr< SessionReader > SessionReaderSharedPtr
ProjectionType
Type of Galerkin projection.
std::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:53
std::shared_ptr< MeshGraph > MeshGraphSharedPtr
Definition: MeshGraph.h:176
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:2
double NekDouble