foamVtkInternalMeshWriterTemplates.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) 2017-2021 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
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 
29 #include "foamVtkOutput.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 template<class Type>
35 (
36  const word& fieldName,
37  const Type& val
38 )
39 {
40  label nValues(0);
41 
43  {
44  ++nCellData_;
45  nValues = vtuCells_.nFieldCells();
46  }
48  {
49  ++nPointData_;
50  nValues = vtuCells_.nFieldPoints();
51  }
52  else
53  {
55  (
59  )
60  << " for uniform field " << fieldName << nl << endl
61  << exit(FatalError);
62 
63  return;
64  }
65 
66  vtk::fileWriter::writeUniform<Type>(fieldName, val, nValues);
67 }
68 
69 
70 template<class Type>
72 (
73  const word& fieldName,
74  const UList<Type>& field
75 )
76 {
77  if (isState(outputState::CELL_DATA))
78  {
79  ++nCellData_;
80  }
81  else
82  {
84  << " for field " << fieldName << nl << endl
85  << exit(FatalError);
86  }
87 
88  const labelList& cellMap = vtuCells_.cellMap();
89 
90  this->beginDataArray<Type>(fieldName, numberOfCells_);
91 
92  if (parallel_)
93  {
94  vtk::writeListParallel(format_.ref(), field, cellMap);
95  }
96  else
97  {
98  vtk::writeList(format(), field, cellMap);
99  }
101  this->endDataArray();
102 }
103 
104 
105 template<class Type>
107 (
108  const word& fieldName,
109  const UList<Type>& field
110 )
111 {
112  if (isState(outputState::POINT_DATA))
113  {
114  ++nPointData_;
115  }
116  else
117  {
119  << " for field " << fieldName << nl << endl
120  << exit(FatalError);
121  }
122 
123  this->beginDataArray<Type>(fieldName, numberOfPoints_);
124 
125  if (parallel_)
126  {
127  vtk::writeListParallel(format_.ref(), field);
128  }
129  else
130  {
132  }
133 
134  this->endDataArray();
135 }
136 
137 
138 // ************************************************************************* //
rDeltaTY field()
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
label nCellData_
The number of CellData written for the Piece thus far.
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:598
constexpr char nl
The newline &#39;\n&#39; character (0x0a)
Definition: Ostream.H:50
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
label nFieldPoints() const noexcept
Number of field points = nPoints + nAddPoints.
label nPointData_
The number of PointData written for the Piece thus far.
bool isState(outputState test) const noexcept
True if output state corresponds to the test state.
const vtuCells & vtuCells_
The volume cells (internalMesh)
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.
A class for handling words, derived from Foam::string.
Definition: word.H:63
void writeList(vtk::formatter &fmt, const UList< uint8_t > &values)
Write a list of uint8_t values.
label nFieldCells() const noexcept
Number of field cells = nCells + nAddCells.
word format(conversionProperties.get< word >("format"))
void writeListParallel(vtk::formatter &fmt, const UList< Type > &values)
Write a list of values.
List< label > labelList
A List of labels.
Definition: List.H:62
void writeCellData(const word &fieldName, const UList< Type > &field)
Write primitive field of CellData.
void writeUniform(const word &fieldName, const Type &val)
Write a uniform field of Cell or Point values.