ensightField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2016 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 InApplication
25  foamToEnsight
26 
27 Description
28 
29 SourceFiles
30  ensightField.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef ensightField_H
35 #define ensightField_H
36 
37 #include "ensightMesh.H"
38 #include "fvMeshSubset.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 //- Wrapper to get hold of the field or the subsetted field
43 template<class Type>
46 (
47  const Foam::fvMeshSubset&,
49 );
50 
51 
52 template<class Type>
53 void ensightField
54 (
56  const Foam::ensightMesh& eMesh,
57  const Foam::fileName& postProcPath,
58  const Foam::word& prepend,
59  const Foam::label timeIndex,
60  const bool binary,
61  const bool nodeValues,
62  Foam::Ostream& ensightCaseFile
63 );
64 
65 
66 template<class Type>
67 void writePatchField
68 (
69  const Foam::word& fieldName,
70  const Foam::Field<Type>& pf,
71  const Foam::word& patchName,
72  const Foam::ensightMesh& eMesh,
73  const Foam::fileName& postProcPath,
74  const Foam::word& prepend,
75  const Foam::label timeIndex,
76  Foam::Ostream& ensightCaseFile
77 );
78 
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 #ifdef NoRepository
83  #include "ensightField.C"
84 #endif
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #endif
89 
90 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A class for handling file names.
Definition: fileName.H:69
void ensightField(const Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > &vf, const Foam::ensightMesh &eMesh, const Foam::fileName &postProcPath, const Foam::word &prepend, const Foam::label timeIndex, const bool binary, const bool nodeValues, Foam::Ostream &ensightCaseFile)
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > volField(const Foam::fvMeshSubset &, const Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > &vf)
Wrapper to get hold of the field or the subsetted field.
Pre-declare SubField and related Field type.
Definition: Field.H:57
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Post-processing mesh subset tool. Given the original mesh and the list of selected cells...
Definition: fvMeshSubset.H:73
void writePatchField(const Foam::word &fieldName, const Foam::Field< Type > &pf, const Foam::word &patchName, const Foam::ensightMesh &eMesh, const Foam::fileName &postProcPath, const Foam::word &prepend, const Foam::label timeIndex, Foam::Ostream &ensightCaseFile)
label timeIndex
Definition: getTimeIndex.H:4
A class for managing temporary objects.
Definition: PtrList.H:54