Nektar++
CsvIO.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File CsvIO.h
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2017 Kilian Lackhove
10 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
11 // Department of Aeronautics, Imperial College London (UK), and Scientific
12 // Computing and Imaging Institute, University of Utah (USA).
13 //
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Csv IO
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_LIB_UTILITIES_BASIC_UTILS_CSVIO_H
37 #define NEKTAR_LIB_UTILITIES_BASIC_UTILS_CSVIO_H
38 
39 #include <string>
40 #include <vector>
41 #include <memory>
42 
48 
49 namespace Nektar
50 {
51 namespace LibUtilities
52 {
53 
54 class CsvIO : public PtsIO
55 {
56 public:
58  bool sharedFilesystem = false);
59 
61  {
62  }
63 
64  LIB_UTILITIES_EXPORT void Write(const std::string &outFile,
65  const PtsFieldSharedPtr &ptsField,
66  const bool backup = false);
67 
68 
69 
70 protected:
72  const std::string inFile,
73  PtsFieldSharedPtr &ptsField,
74  DomainRangeShPtr &Range);
75 
76  // LIB_UTILITIES_EXPORT virtual void v_ImportFieldData(
77  // const std::string inFile,
78  // PtsFieldSharedPtr &ptsField);
79 
80 
81  LIB_UTILITIES_EXPORT virtual std::string GetFileEnding() const
82  {
83  return "csv";
84  };
85 };
86 
87 typedef std::shared_ptr<CsvIO> CsvIOSharedPtr;
88 }
89 }
90 #endif
#define LIB_UTILITIES_EXPORT
void Write(const std::string &outFile, const PtsFieldSharedPtr &ptsField, const bool backup=false)
Save a pts field to a file.
Definition: CsvIO.cpp:71
virtual void v_ImportFieldData(const std::string inFile, PtsFieldSharedPtr &ptsField, DomainRangeShPtr &Range)
Definition: CsvIO.cpp:112
virtual std::string GetFileEnding() const
Helper function that determines default file extension.
Definition: CsvIO.h:81
CsvIO(LibUtilities::CommSharedPtr pComm, bool sharedFilesystem=false)
Definition: CsvIO.cpp:60
std::shared_ptr< PtsField > PtsFieldSharedPtr
Definition: PtsField.h:182
std::shared_ptr< DomainRange > DomainRangeShPtr
Definition: DomainRange.h:61
std::shared_ptr< CsvIO > CsvIOSharedPtr
Definition: CsvIO.h:87
std::shared_ptr< Comm > CommSharedPtr
Pointer to a Communicator object.
Definition: Comm.h:54
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:1