Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ProcessMeanMode.cpp
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ProcessMeanMode.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: Extract mean mode of 3DH1D field.
33 //
34 ////////////////////////////////////////////////////////////////////////////////
35 
36 #include <string>
37 #include <iostream>
38 using namespace std;
39 
40 #include "ProcessMeanMode.h"
41 
44 
45 namespace Nektar
46 {
47 namespace Utilities
48 {
49 
50 ModuleKey ProcessMeanMode::className =
52  ModuleKey(eProcessModule, "meanmode"),
53  ProcessMeanMode::create,
54  "Extract mean mode from 3DH1D.");
55 
56 ProcessMeanMode::ProcessMeanMode(FieldSharedPtr f) : ProcessHomogeneousPlane(f)
57 {
58 }
59 
61 {
62 }
63 
64 void ProcessMeanMode::Process(po::variables_map &vm)
65 {
66  if (m_f->m_verbose)
67  {
68  if(m_f->m_comm->TreatAsRankZero())
69  {
70  cout << "ProcessMeanMode: Extracting mean mode..." << endl;
71  }
72  }
73 
74  if (m_f->m_fielddef[0]->m_homogeneousZIDs[0] != 0)
75  {
76  ASSERTL0(false, "ProcessMeanMode: mean mode not found.");
77  }
78 
79  // Set parameters for mean mode
80  RegisterConfig("planeid", "0");
81  RegisterConfig("wavespace", "1");
82 
84 }
85 }
86 }
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:188
This processing module replaces all expansions by a single plane from 3DH1D fields, defined by the parameter planeid.
pair< ModuleType, string > ModuleKey
virtual void Process()=0
STL namespace.
void RegisterConfig(string key, string value)
Register a configuration option with a module.
FieldSharedPtr m_f
Field object.
boost::shared_ptr< Field > FieldSharedPtr
Definition: Field.hpp:698
ModuleFactory & GetModuleFactory()
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215