Nektar++
OutputStdOut.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: OutputStdOut.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: Dummy output module
32 //
33 ////////////////////////////////////////////////////////////////////////////////
34 
35 #ifndef FIELDUTILS_OUTPUTSTDOUT
36 #define FIELDUTILS_OUTPUTSTDOUT
37 
38 #include "../Module.h"
39 #include <tinyxml.h>
40 
41 namespace Nektar
42 {
43 namespace FieldUtils
44 {
45 
46 class OutputStdOut : public OutputModule
47 {
48 public:
49  /// Creates an instance of this class
50  static std::shared_ptr<Module> create(FieldSharedPtr f)
51  {
53  }
55 
57  virtual ~OutputStdOut();
58 
59 protected:
60  /// Write fld to output file.
61  virtual void v_Process(po::variables_map &vm) override;
62 
63  virtual std::string v_GetModuleName() override
64  {
65  return "OutputStdOut";
66  }
67 
68  virtual std::string v_GetModuleDescription() override
69  {
70  return "Output written to StdOut";
71  }
72 
74  {
75  return eOutput;
76  }
77 };
78 } // namespace FieldUtils
79 } // namespace Nektar
80 
81 #endif
Abstract base class for output modules.
Definition: Module.h:307
virtual void v_Process(po::variables_map &vm) override
Write fld to output file.
virtual std::string v_GetModuleName() override
Definition: OutputStdOut.h:63
virtual ModulePriority v_GetModulePriority() override
Definition: OutputStdOut.h:73
static std::shared_ptr< Module > create(FieldSharedPtr f)
Creates an instance of this class.
Definition: OutputStdOut.h:50
virtual std::string v_GetModuleDescription() override
Definition: OutputStdOut.h:68
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:991
std::pair< ModuleType, std::string > ModuleKey
Definition: Module.h:317
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:2