Nektar++
ProcessAddFld.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ProcessAddFld.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: Add a field to the input field.
32 //
33 ////////////////////////////////////////////////////////////////////////////////
34 
35 #ifndef FIELDUTILS_PROCESSSCALEINFLD
36 #define FIELDUTILS_PROCESSSCALEINFLD
37 
38 #include "../Module.h"
39 
40 namespace Nektar
41 {
42 namespace FieldUtils
43 {
44 
45 /**
46  * @brief This processing module scales the input fld file
47  *
48  */
50 {
51 public:
52  /// Creates an instance of this class
53  static std::shared_ptr<Module> create(FieldSharedPtr f)
54  {
56  }
58 
60  virtual ~ProcessAddFld();
61 
62  /// Write mesh to output file.
63  virtual void Process(po::variables_map &vm);
64 
65  virtual std::string GetModuleName()
66  {
67  return "ProcessAddFld";
68  }
69 
70  virtual std::string GetModuleDescription()
71  {
72  return "Adding new fld to input fld";
73  }
74 
76  {
77  return m_priority;
78  }
79 
80 private:
82 
83 };
84 }
85 }
86 
87 #endif
This processing module scales the input fld file.
Definition: ProcessAddFld.h:50
virtual ModulePriority GetModulePriority()
Definition: ProcessAddFld.h:75
virtual std::string GetModuleName()
Definition: ProcessAddFld.h:65
virtual void Process(po::variables_map &vm)
Write mesh to output file.
static std::shared_ptr< Module > create(FieldSharedPtr f)
Creates an instance of this class.
Definition: ProcessAddFld.h:53
virtual std::string GetModuleDescription()
Definition: ProcessAddFld.h:70
Abstract base class for processing modules.
Definition: Module.h:265
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
std::shared_ptr< Field > FieldSharedPtr
Definition: Field.hpp:989
std::pair< ModuleType, std::string > ModuleKey
Definition: Module.h:290
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:1