Flow123d  master-f44eb46
output_msh.hh
Go to the documentation of this file.
1 /*!
2  *
3  * Copyright (C) 2015 Technical University of Liberec. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it under
6  * the terms of the GNU General Public License version 3 as published by the
7  * Free Software Foundation. (http://www.gnu.org/licenses/gpl-3.0.en.html)
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
12  *
13  *
14  * @file output_msh.h
15  * @brief Header: The functions for MSH (GMSH) outputs.
16  */
17 
18 #ifndef OUTPUT_MSH_HH_
19 #define OUTPUT_MSH_HH_
20 
21 #include <vector> // for vector
22 #include "output_time.hh" // for OutputTime::OutputDataPtr, OutputTime, Out...
23 namespace Input { namespace Type { class Record; } }
24 namespace flow { template <class T> class VectorId; }
25 
26 
27 /**
28  * \brief This class is used for output data to VTK file format
29  */
30 class OutputMSH : public OutputTime {
31 public:
33 
34  /**
35  * \brief The constructor of this class.
36  * We open the output file in first call of write_data
37  */
38  OutputMSH();
39 
40  /**
41  * \brief The destructor of this class
42  */
43  ~OutputMSH();
44 
45  /**
46  * \brief The definition of input record for gmsh file format
47  */
48  static const Input::Type::Record & get_input_type();
49 
50  /**
51  * \brief This method writes head of GMSH (.msh) file format
52  *
53  * \return This function returns 1
54  */
55  int write_head(void);
56 
57  /**
58  * \brief This method writes data to GMSH (.msh) file format for current time
59  *
60  * \return This function returns 1
61  */
62  int write_data(void);
63 
64  /**
65  * \brief This method should write tail of GMSH (.msh) file format
66  *
67  * It is stupid file format. It doesn't write anything special at the end of
68  * the file
69  *
70  * \return This function returns 1
71  */
72  int write_tail(void);
73 
74  /**
75  * Set shared pointers of output data caches.
76  */
77  void set_output_data_caches(std::shared_ptr<OutputMeshBase> mesh_ptr) override;
78 
79 private:
80 
81  /// Registrar of class to factory
82  static const int registrar;
83 
85 
86  /**
87  * EquationOutput force output of all output fields at the time zero.
88  * We keep this list to perform single elemnent/node output in order to have correct behavior in GMSH.
89  */
91 
92  /**
93  * \brief This function write header of GMSH (.msh) file format
94  */
95  void write_msh_header(void);
96 
97  /**
98  * \brief This function writes geometry (position of nodes) to GMSH (.msh) file
99  * format
100  */
101  void write_msh_geometry(void);
102 
103  /**
104  * \brief This function writes topology (connection of nodes) to the GMSH (.msh)
105  * file format
106  */
107  void write_msh_topology(void);
108 
109  /**
110  * \brief This function writes nodes / elements ascii data to GMSH (.msh) output file.
111  *
112  * \param[in] id_cache Data cache of node or element ids.
113  * \param[in] output_data The pointer at structure storing pointer at own data.
114  * \param[in] permutations Permutation vector of optimized order of nodes / elements.
115  */
116  void write_msh_ascii_data(std::shared_ptr<ElementDataCache<unsigned int>> id_cache, OutputDataPtr output_data, const std::vector<unsigned int> &permutations);
117 
118  /**
119  * \brief This function write all data on nodes to output file. This function
120  * is used for static and dynamic data
121  *
122  * \param[in] time The time from start
123  * \param[in] step The number of steps from start
124  */
125  void write_node_data(OutputDataPtr output_data);
126  /**
127  * \brief writes ElementNode data ascii GMSH (.msh) output file.
128  *
129  */
130  void write_corner_data(OutputDataPtr output_data);
131 
132 
133  /**
134  * \brief This function write all data on elements to output file. This
135  * function is used for static and dynamic data
136  *
137  * \param[in] time The time from start
138  * \param[in] step The number of steps from start
139  */
140  void write_elem_data(OutputDataPtr output_data);
141 
142  /**
143  * \brief This method add right suffix to .msh GMSH file
144  */
145  void fix_base_file_name(void);
146 
147  /// Vector gets ids of nodes.
148  std::shared_ptr<ElementDataCache<unsigned int>> node_ids_;
149  /// Vector gets ids of elements.
150  std::shared_ptr<ElementDataCache<unsigned int>> elem_ids_;
151  /// Vector gets ids of regions.
152  std::shared_ptr<ElementDataCache<unsigned int>> region_ids_;
153  /// Vector gets partitions of elements.
154  std::shared_ptr<ElementDataCache<int>> partitions_;
155 };
156 
157 #endif /* OUTPUT_MSH_HH_ */
Record type proxy class.
Definition: type_record.hh:182
This class is used for output data to VTK file format.
Definition: output_msh.hh:30
static const Input::Type::Record & get_input_type()
The definition of input record for gmsh file format.
Definition: output_msh.cc:33
std::vector< std::vector< OutputDataPtr > > dummy_data_list_
Definition: output_msh.hh:90
std::shared_ptr< ElementDataCache< unsigned int > > elem_ids_
Vector gets ids of elements.
Definition: output_msh.hh:150
int write_data(void)
This method writes data to GMSH (.msh) file format for current time.
Definition: output_msh.cc:266
OutputMSH()
The constructor of this class. We open the output file in first call of write_data.
Definition: output_msh.cc:44
void write_msh_ascii_data(std::shared_ptr< ElementDataCache< unsigned int >> id_cache, OutputDataPtr output_data, const std::vector< unsigned int > &permutations)
This function writes nodes / elements ascii data to GMSH (.msh) output file.
Definition: output_msh.cc:140
void write_node_data(OutputDataPtr output_data)
This function write all data on nodes to output file. This function is used for static and dynamic da...
Definition: output_msh.cc:165
void set_output_data_caches(std::shared_ptr< OutputMeshBase > mesh_ptr) override
Definition: output_msh.cc:317
void write_msh_geometry(void)
This function writes geometry (position of nodes) to GMSH (.msh) file format.
Definition: output_msh.cc:75
bool header_written
Definition: output_msh.hh:84
std::shared_ptr< ElementDataCache< int > > partitions_
Vector gets partitions of elements.
Definition: output_msh.hh:154
OutputTime FactoryBaseType
Definition: output_msh.hh:32
void write_corner_data(OutputDataPtr output_data)
writes ElementNode data ascii GMSH (.msh) output file.
Definition: output_msh.cc:191
void fix_base_file_name(void)
This method add right suffix to .msh GMSH file.
int write_head(void)
This method writes head of GMSH (.msh) file format.
Definition: output_msh.cc:251
~OutputMSH()
The destructor of this class.
Definition: output_msh.cc:54
static const int registrar
Registrar of class to factory.
Definition: output_msh.hh:82
std::shared_ptr< ElementDataCache< unsigned int > > node_ids_
Vector gets ids of nodes.
Definition: output_msh.hh:148
void write_msh_header(void)
This function write header of GMSH (.msh) file format.
Definition: output_msh.cc:65
int write_tail(void)
This method should write tail of GMSH (.msh) file format.
Definition: output_msh.cc:311
void write_elem_data(OutputDataPtr output_data)
This function write all data on elements to output file. This function is used for static and dynamic...
Definition: output_msh.cc:227
void write_msh_topology(void)
This function writes topology (connection of nodes) to the GMSH (.msh) file format.
Definition: output_msh.cc:87
std::shared_ptr< ElementDataCache< unsigned int > > region_ids_
Vector gets ids of regions.
Definition: output_msh.hh:152
The class for outputting data during time.
Definition: output_time.hh:51
std::shared_ptr< ElementDataCacheBase > OutputDataPtr
Definition: output_time.hh:144
Abstract linear system class.
Definition: balance.hh:40