Nektar++
OutputVtkBase.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: OutputVtkBase.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: Vtk output module base class
32 //
33 ////////////////////////////////////////////////////////////////////////////////
34 
35 #ifndef FIELDUTILS_OUTPUTVTKBASE
36 #define FIELDUTILS_OUTPUTVTKBASE
37 
38 #include "OutputFileBase.h"
39 #include <tinyxml.h>
40 
41 namespace Nektar
42 {
43 namespace FieldUtils
44 {
45 
46 /// Converter from fld to vtk.
48 {
49 public:
50  /// Creates an instance of this class
51  static std::shared_ptr<Module> create(FieldSharedPtr f)
52  {
54  }
56 
58  virtual ~OutputVtkBase();
59 
60 protected:
61  virtual std::string v_GetModuleName() override
62  {
63  return "OutputVtk";
64  }
65 
66  /// Write from pts to output file.
67  virtual void v_OutputFromPts(po::variables_map &vm) override;
68 
69  /// Write from m_exp to output file.
70  virtual void v_OutputFromExp(po::variables_map &vm) override;
71 
72  /// Write from data to output file.
73  virtual void v_OutputFromData(po::variables_map &vm) override;
74 
75  virtual fs::path v_GetPath(std::string &filename,
76  po::variables_map &vm) override;
77 
78  virtual fs::path v_GetFullOutName(std::string &filename,
79  po::variables_map &vm) override;
80 
81  std::string PrepareOutput(po::variables_map &vm);
82 
83 private:
84  void WriteVtkHeader(std::ostream &outfile);
85 
86  void WriteVtkFooter(std::ostream &outfile);
87 
88  void WriteEmptyVtkPiece(std::ofstream &outfile);
89 
90  void WritePVtu(po::variables_map &vm);
91 };
92 } // namespace FieldUtils
93 } // namespace Nektar
94 
95 #endif
Converter from fld to vtk.
Converter from fld to vtk.
Definition: OutputVtkBase.h:48
std::string PrepareOutput(po::variables_map &vm)
void WriteEmptyVtkPiece(std::ofstream &outfile)
virtual fs::path v_GetFullOutName(std::string &filename, po::variables_map &vm) override
void WriteVtkHeader(std::ostream &outfile)
virtual std::string v_GetModuleName() override
Definition: OutputVtkBase.h:61
virtual void v_OutputFromData(po::variables_map &vm) override
Write from data to output file.
virtual fs::path v_GetPath(std::string &filename, po::variables_map &vm) override
void WritePVtu(po::variables_map &vm)
static std::shared_ptr< Module > create(FieldSharedPtr f)
Creates an instance of this class.
Definition: OutputVtkBase.h:51
void WriteVtkFooter(std::ostream &outfile)
virtual void v_OutputFromExp(po::variables_map &vm) override
Write from m_exp to output file.
virtual void v_OutputFromPts(po::variables_map &vm) override
Write from pts to output file.
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