Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FilterAverageFields.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FilterAverageField.cpp
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: Average solution fields during time-stepping.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
37 
38 namespace Nektar
39 {
40 namespace SolverUtils
41 {
44  "AverageFields", FilterAverageFields::create);
45 
48  const ParamMap &pParams)
49  : FilterSampler(pSession, pParams)
50 {
51 }
52 
54 {
55 }
56 
59  const NekDouble &time)
60 {
61  int nfield = pFields.num_elements();
62  m_variables.resize(pFields.num_elements());
63  // Fill name of variables
64  for (int n = 0; n < nfield; ++n)
65  {
66  m_variables[n] = pFields[n]->GetSession()->GetVariable(n);
67  }
68  // Now let FilterSampler initialise the output
69  FilterSampler::v_Initialise(pFields, time);
70 }
71 
74  const NekDouble &time)
75 {
76  for(int n = 0; n < pFields.num_elements(); ++n)
77  {
78  Vmath::Vadd(m_outFields[n].num_elements(),
79  pFields[n]->GetCoeffs(),
80  1,
81  m_outFields[n],
82  1,
83  m_outFields[n],
84  1);
85  }
86 }
87 
90  const NekDouble &time)
91 {
92  m_scale = 1.0 / m_numSamples;
93 }
94 
96 {
97  return true;
98 }
99 }
100 }
std::vector< Array< OneD, NekDouble > > m_outFields
Definition: FilterSampler.h:90
virtual void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
static std::string className
Name of the class.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
std::vector< std::string > m_variables
Definition: FilterSampler.h:91
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
Creates an instance of this class.
virtual SOLVER_UTILS_EXPORT void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
double NekDouble
virtual void v_ProcessSample(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
SOLVER_UTILS_EXPORT FilterAverageFields(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
virtual void v_PrepareOutput(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
FilterFactory & GetFilterFactory()
Definition: Filter.cpp:42
void Vadd(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Add vector z = x+y.
Definition: Vmath.cpp:285
virtual SOLVER_UTILS_EXPORT ~FilterAverageFields()
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215