Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ProcessScalGrad.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ProcessScalGrad.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 // 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: Computes scalar gradient field.
33 //
34 ////////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef UTILITIES_PREPROCESSING_FIELDCONVERT_PROCESSSCALGRAD
37 #define UTILITIES_PREPROCESSING_FIELDCONVERT_PROCESSSCALGRAD
38 
39 #include "../Module.h"
40 
41 namespace Nektar
42 {
43 namespace Utilities
44 {
45 
46 /**
47  * @brief This processing module calculates the scalar gradient field and
48  * writes it to a surface output file.
49  */
51 {
52  public:
53  /// Creates an instance of this class
54  static boost::shared_ptr<Module> create(FieldSharedPtr f) {
56  }
58 
60  virtual ~ProcessScalGrad();
61 
62  /// Write mesh to output file.
63  virtual void Process(po::variables_map &vm);
64 
65  virtual std::string GetModuleName()
66  {
67  return "ProcessScalGrad";
68  }
69 
70 };
71 }
72 }
73 
74 #endif
pair< ModuleType, string > ModuleKey
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
virtual void Process()=0
This processing module calculates the scalar gradient field and writes it to a surface output file...
virtual std::string GetModuleName()
boost::shared_ptr< Field > FieldSharedPtr
Definition: Field.hpp:695
static boost::shared_ptr< Module > create(FieldSharedPtr f)
Creates an instance of this class.
Abstract base class for processing modules.