Nektar++
InputXml.h
Go to the documentation of this file.
1////////////////////////////////////////////////////////////////////////////////
2//
3// File: InputXml.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: Xml reader and expansion setup
32//
33////////////////////////////////////////////////////////////////////////////////
34
35#ifndef FIELDUTILS_INPUTXML
36#define FIELDUTILS_INPUTXML
37
38#include "../Module.h"
39
40namespace Nektar::FieldUtils
41{
42
43/**
44 * Input module for Xml files.
45 */
46class InputXml : public InputModule
47{
48public:
50 ~InputXml() override;
51 /// Creates an instance of this class
53 {
55 }
56 /// %ModuleKey for class.
58
59protected:
60 void v_Process(po::variables_map &vm) override;
61
62 std::string v_GetModuleName() override
63 {
64 return "InputXml";
65 }
66
67 std::string v_GetModuleDescription() override
68 {
69 return "Processing input xml file";
70 }
71
73 {
74 return eCreateGraph;
75 }
76
77private:
78};
79} // namespace Nektar::FieldUtils
80
81#endif
Abstract base class for input modules.
Definition: Module.h:287
std::string v_GetModuleName() override
Definition: InputXml.h:62
std::string v_GetModuleDescription() override
Definition: InputXml.h:67
void v_Process(po::variables_map &vm) override
Definition: InputXml.cpp:76
ModulePriority v_GetModulePriority() override
Definition: InputXml.h:72
static ModuleKey m_className[]
ModuleKey for class.
Definition: InputXml.h:57
static ModuleSharedPtr create(FieldSharedPtr f)
Creates an instance of this class.
Definition: InputXml.h:52
InputXml(FieldSharedPtr f)
Set up InputXml object.
Definition: InputXml.cpp:60
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:990
std::pair< ModuleType, std::string > ModuleKey
Definition: Module.h:180
std::shared_ptr< Module > ModuleSharedPtr
Definition: Module.h:329