ensightPartTemplates.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Description
25  Template to write generalised field components
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "ensightPart.H"
30 
31 // * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
32 
33 template<class Type>
35 (
36  ensightFile& os,
37  const Field<Type>& field,
38  const bool perNode
39 ) const
40 {
41  if (this->size() && field.size())
42  {
43  writeHeader(os);
44 
45  if (perNode)
46  {
47  os.writeKeyword("coordinates");
48  for
49  (
50  direction cmpt=0;
51  cmpt < pTraits<Type>::nComponents;
52  ++cmpt
53  )
54  {
55  writeFieldList(os, field.component(cmpt), labelUList::null());
56  }
57  }
58  else
59  {
60  forAll(elementTypes(), elemI)
61  {
62  const labelUList& idList = elemLists_[elemI];
63 
64  if (idList.size())
65  {
66  os.writeKeyword(elementTypes()[elemI]);
67 
68  for
69  (
70  direction cmpt=0;
71  cmpt < pTraits<Type>::nComponents;
72  ++cmpt
73  )
74  {
75  writeFieldList(os, field.component(cmpt), idList);
76  }
77  }
78  }
79  }
80  }
81 }
82 
83 
84 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
Pre-declare SubField and related Field type.
Definition: Field.H:83
tmp< Field< cmptType > > component(const direction) const
Return a component field of the field.
Definition: Field.C:479
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
static const UList< label > & null()
Return a null UList.
Definition: UListI.H:51
label size() const
Return the number of elements in the UList.
Definition: UListI.H:311
Ensight output with specialised write() for strings, integers and floats. Correctly handles binary wr...
Definition: ensightFile.H:50
virtual Ostream & writeKeyword(const string &key)
Write element keyword with trailing newline, optionally with undef.
Definition: ensightFile.C:275
labelListList elemLists_
Simple labelList with a name.
Definition: ensightPart.H:84
label size() const
Number of elements in this part.
Definition: ensightPart.H:235
void writeHeader(ensightFile &, bool withDescription=false) const
Write the part header.
Definition: ensightPartIO.C:36
void writeField(ensightFile &, const Field< Type > &, const bool perNode=false) const
Write generalised field components.
virtual const List< word > & elementTypes() const
Definition: ensightPart.H:226
void writeFieldList(ensightFile &os, const List< scalar > &field, const labelUList &idList) const
Write a scalar field for idList.
Definition: ensightPartIO.C:56
uint8_t direction
Definition: direction.H:45