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
41{
42namespace FieldUtils
43{
44
45/**
46 * Input module for Xml files.
47 */
48class InputXml : public InputModule
49{
50public:
52 virtual ~InputXml();
53 /// Creates an instance of this class
55 {
57 }
58 /// %ModuleKey for class.
60
61protected:
62 virtual void v_Process(po::variables_map &vm) override;
63
64 virtual std::string v_GetModuleName() override
65 {
66 return "InputXml";
67 }
68
69 virtual std::string v_GetModuleDescription() override
70 {
71 return "Processing input xml file";
72 }
73
75 {
76 return eCreateGraph;
77 }
78
79private:
80};
81} // namespace FieldUtils
82} // namespace Nektar
83
84#endif
Abstract base class for input modules.
Definition: Module.h:278
virtual std::string v_GetModuleName() override
Definition: InputXml.h:64
virtual void v_Process(po::variables_map &vm) override
Definition: InputXml.cpp:78
static ModuleKey m_className[]
ModuleKey for class.
Definition: InputXml.h:59
virtual std::string v_GetModuleDescription() override
Definition: InputXml.h:69
virtual ModulePriority v_GetModulePriority() override
Definition: InputXml.h:74
static ModuleSharedPtr create(FieldSharedPtr f)
Creates an instance of this class.
Definition: InputXml.h:54
InputXml(FieldSharedPtr f)
Set up InputXml object.
Definition: InputXml.cpp:62
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
std::shared_ptr< Module > ModuleSharedPtr
Definition: Module.h:321
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:2