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
41namespace Nektar::FieldUtils
42{
43
45{
46public:
47 /// Creates an instance of this class
48 static std::shared_ptr<Module> create(FieldSharedPtr f)
49 {
51 }
53
55 ~OutputStdOut() override;
56
57protected:
58 /// Write fld to output file.
59 void v_Process(po::variables_map &vm) override;
60
61 std::string v_GetModuleName() override
62 {
63 return "OutputStdOut";
64 }
65
66 std::string v_GetModuleDescription() override
67 {
68 return "Output written to StdOut";
69 }
70
72 {
73 return eOutput;
74 }
75};
76} // namespace Nektar::FieldUtils
77
78#endif
Abstract base class for output modules.
Definition: Module.h:316
void v_Process(po::variables_map &vm) override
Write fld to output file.
static std::shared_ptr< Module > create(FieldSharedPtr f)
Creates an instance of this class.
Definition: OutputStdOut.h:48
ModulePriority v_GetModulePriority() override
Definition: OutputStdOut.h:71
std::string v_GetModuleName() override
Definition: OutputStdOut.h:61
std::string v_GetModuleDescription() override
Definition: OutputStdOut.h:66
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:1026
std::pair< ModuleType, std::string > ModuleKey
Definition: Module.h:180