Nektar++
ProcessMean.cpp
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ProcessMean.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 // 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: Compute the mean of each field.
32 //
33 ////////////////////////////////////////////////////////////////////////////////
34 
35 #include <iostream>
36 #include <string>
37 using namespace std;
38 
39 #include <boost/core/ignore_unused.hpp>
40 
42 
43 #include "ProcessMean.h"
44 
45 namespace Nektar
46 {
47 namespace FieldUtils
48 {
49 
50 ModuleKey ProcessMean::className = GetModuleFactory().RegisterCreatorFunction(
51  ModuleKey(eProcessModule, "mean"), ProcessMean::create,
52  "compute the mean of each field over the domain.");
53 
54 ProcessMean::ProcessMean(FieldSharedPtr f) : ProcessModule(f)
55 {
56 }
57 
59 {
60 }
61 
62 void ProcessMean::v_Process(po::variables_map &vm)
63 {
64  m_f->SetUpExp(vm);
65 
66  int nfields = m_f->m_variables.size();
67  int spacedim = m_f->m_graph->GetMeshDimension() + m_f->m_numHomogeneousDir;
68  int npoints = m_f->m_exp[0]->GetNpoints();
69 
70  // Calculate volume (or area)
71  Array<OneD, NekDouble> ones(npoints, 1.0);
72  NekDouble scale = m_f->m_exp[0]->Integral(ones);
73 
74  // Output volume
75  string name[3] = {"length", "area", "volume"};
76  cout << "Domain " << name[spacedim - 1] << " : " << scale << endl;
77 
78  // Calculate integral and mean of each field
79  for (int i = 0; i < nfields; ++i)
80  {
81  NekDouble integral = m_f->m_exp[0]->Integral(m_f->m_exp[i]->GetPhys());
82 
83  if (m_f->m_comm->GetSpaceComm()->GetRank() == 0)
84  {
85  cout << "Integral (variable " << m_f->m_variables[i]
86  << ") : " << integral << endl;
87  cout << "Mean (variable " << m_f->m_variables[i]
88  << ") : " << integral / scale << endl;
89  }
90  }
91 }
92 } // namespace FieldUtils
93 } // namespace Nektar
FieldSharedPtr m_f
Field object.
Definition: Module.h:234
virtual void v_Process(po::variables_map &vm) override
Write mesh to output file.
Definition: ProcessMean.cpp:62
Abstract base class for processing modules.
Definition: Module.h:292
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:198
std::shared_ptr< Field > FieldSharedPtr
Definition: Field.hpp:991
std::pair< ModuleType, std::string > ModuleKey
Definition: Module.h:317
ModuleFactory & GetModuleFactory()
Definition: Module.cpp:49
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:2
double NekDouble