Nektar++
InputSemtex.h
Go to the documentation of this file.
1////////////////////////////////////////////////////////////////////////////////
2//
3// File: InputSemtex.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: Reads a Semtex checkpoint file.
32//
33////////////////////////////////////////////////////////////////////////////////
34
35#ifndef FIELDUTILS_INPUTSEMTEX
36#define FIELDUTILS_INPUTSEMTEX
37
38#include "../Module.h"
39
40namespace Nektar
41{
42namespace FieldUtils
43{
44
45/**
46 * Converter for Fld files.
47 */
49{
50public:
52 virtual ~InputSemtex();
53
54 /// Creates an instance of this class
56 {
58 }
59 /// %ModuleKey for class.
61
62protected:
63 virtual void v_Process(po::variables_map &vm) override;
64
65 virtual std::string v_GetModuleName() override
66 {
67 return "InputSemtex";
68 }
69
70 virtual std::string v_GetModuleDescription() override
71 {
72 return "Processing Semtex field file";
73 }
74
76 {
77 return eCreateFieldData;
78 }
79
80private:
81};
82} // namespace FieldUtils
83} // namespace Nektar
84
85#endif
Abstract base class for input modules.
Definition: Module.h:278
virtual std::string v_GetModuleName() override
Definition: InputSemtex.h:65
InputSemtex(FieldSharedPtr f)
Set up InputSemtex object.
Definition: InputSemtex.cpp:62
virtual ModulePriority v_GetModulePriority() override
Definition: InputSemtex.h:75
static ModuleSharedPtr create(FieldSharedPtr f)
Creates an instance of this class.
Definition: InputSemtex.h:55
virtual void v_Process(po::variables_map &vm) override
Process Semtex input file.
Definition: InputSemtex.cpp:82
virtual std::string v_GetModuleDescription() override
Definition: InputSemtex.h:70
static ModuleKey m_className[]
ModuleKey for class.
Definition: InputSemtex.h: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: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