foamVtkPolyWriterTemplates.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2018-2021 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
29
30template<class Type>
32(
33 const label nCellValues,
34 const word& fieldName,
35 const Type& val
36)
37{
38 label nValues(0);
39
41 {
42 ++nCellData_;
43 nValues = nCellValues;
44 }
46 {
48 nValues = nLocalPoints_;
49 }
50 else
51 {
53 (
57 )
58 << " for uniform field " << fieldName << nl << endl
59 << exit(FatalError);
60
61 return;
62 }
63
64 vtk::fileWriter::writeUniform<Type>(fieldName, val, nValues);
65}
66
67
68// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
69
70template<class Type>
72(
73 const word& fieldName,
74 const UList<Type>& field
75)
76{
77 // Could check sizes:
78 // const label nValues = field.size();
79 // CELL_DATA: nValues == (nLocalPolys | nLocalLines)
80 // POINT_DATA: nValues == nLocalPoints
81
82 if (isState(outputState::CELL_DATA))
83 {
84 ++nCellData_;
85 }
86 else if (isState(outputState::POINT_DATA))
87 {
88 ++nPointData_;
89 }
90 else
91 {
92 reportBadState
93 (
95 outputState::CELL_DATA,
96 outputState::POINT_DATA
97 )
98 << " for field " << fieldName << nl << endl
99 << exit(FatalError);
100 return;
101 }
102
103 vtk::fileWriter::writeBasicField<Type>(fieldName, field);
104}
105
106
107template<class Type>
109(
110 const word& fieldName,
111 const UList<Type>& field
112)
113{
114 // Could check sizes:
115 // const label nValues = field.size();
116 // CELL_DATA: nValues == (nLocalPolys | nLocalLines)
117
118 if (isState(outputState::CELL_DATA))
119 {
120 ++nCellData_;
121 }
122 else
123 {
124 reportBadState(FatalErrorInFunction, outputState::CELL_DATA)
125 << " for field " << fieldName << nl << endl
126 << exit(FatalError);
127 return;
128 }
129
130 vtk::fileWriter::writeBasicField<Type>(fieldName, field);
131}
132
133
134template<class Type>
136(
137 const word& fieldName,
138 const UList<Type>& field
139)
140{
141 // Could check sizes:
142 // const label nValues = field.size();
143 // POINT_DATA: nValues == nLocalPoints
144
145 if (isState(outputState::POINT_DATA))
146 {
147 ++nPointData_;
148 }
149 else
150 {
151 reportBadState(FatalErrorInFunction, outputState::POINT_DATA)
152 << " for field " << fieldName << nl << endl
153 << exit(FatalError);
154 return;
155 }
156
157 vtk::fileWriter::writeBasicField<Type>(fieldName, field);
158}
159
160
161// ************************************************************************* //
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: UList.H:94
virtual bool write()
Write the output fields.
bool isState(outputState test) const noexcept
True if output state corresponds to the test state.
label nCellData_
The number of CellData written for the Piece thus far.
label nPointData_
The number of PointData written for the Piece thus far.
@ POINT_DATA
Inside PointData.
@ CELL_DATA
Inside CellData.
Ostream & reportBadState(Ostream &, outputState expected) const
Generate message reporting bad writer state.
void writePointData(const word &fieldName, const UList< Type > &field)
Write primitive field of PointData.
label nLocalPoints_
Local number of points.
void writeCellData(const word &fieldName, const UList< Type > &field)
Write primitive field of CellData.
void writeUniformValue(const label nCellValues, const word &fieldName, const Type &val)
Write a uniform field of Cell (Poly or Line) or Point values.
A class for handling words, derived from Foam::string.
Definition: word.H:68
rDeltaTY field()
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
error FatalError
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53