proxySurfaceWriter.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) 2011 OpenFOAM Foundation
9  Copyright (C) 2015-2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "proxySurfaceWriter.H"
30 #include "MeshedSurfaceProxy.H"
31 #include "OSspecific.H"
32 #include "surfaceWriterMethods.H"
33 
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38 namespace surfaceWriters
39 {
41 }
42 }
43 
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
48 :
50  fileExtension_(fileExt),
51  streamOpt_()
52 {}
53 
54 
56 (
57  const word& fileExt,
58  const dictionary& options
59 )
60 :
61  surfaceWriter(options),
62  fileExtension_(fileExt),
63  streamOpt_
64  (
65  IOstreamOption::formatEnum("format", options, IOstreamOption::ASCII),
66  IOstreamOption::compressionEnum("compression", options)
67  ),
68  options_(options)
69 {}
70 
71 
73 (
74  const meshedSurf& surf,
75  const fileName& outputPath,
76  bool parallel,
77  const dictionary& options
78 )
79 :
80  proxyWriter(outputPath.ext(), options)
81 {
82  surfaceWriter::open(surf, outputPath, parallel);
83 }
84 
85 
87 (
88  const pointField& points,
89  const faceList& faces,
90  const fileName& outputPath,
91  bool parallel,
92  const dictionary& options
93 )
94 :
95  proxyWriter(outputPath.ext(), options)
96 {
97  surfaceWriter::open(points, faces, outputPath, parallel);
98 }
99 
100 
101 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
102 
104 {
105  checkOpen();
106 
107  // Avoid bad values
108  if (fileExtension_.empty())
109  {
110  return fileName::null;
111  }
112 
113  // Geometry: rootdir/<TIME>/surfaceName.{extension}
114 
115  fileName outputFile = outputPath_;
116  if (useTimeDir() && !timeName().empty())
117  {
118  // Splice in time-directory
119  outputFile = outputPath_.path() / timeName() / outputPath_.name();
120  }
121  outputFile.ext(fileExtension_);
122 
123  if (verbose_)
124  {
125  Info<< "Writing geometry to " << outputFile << endl;
126  }
127 
128  // const meshedSurf& surf = surface();
129  const meshedSurfRef& surf = adjustSurface();
130 
131  if (UPstream::master() || !parallel_)
132  {
133  if (!isDir(outputFile.path()))
134  {
135  mkDir(outputFile.path());
136  }
137 
138  MeshedSurfaceProxy<face>(surf.points(), surf.faces()).write
139  (
140  outputFile,
141  fileExtension_,
142  streamOpt_,
143  options_
144  );
145  }
146 
147  wroteGeom_ = true;
148  return outputFile;
149 }
150 
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 // Field writing methods
156 
157 
158 // ************************************************************************* //
A class for handling file names.
Definition: fileName.H:72
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
virtual void open(const fileName &outputPath)
Open for output on specified path, using existing surface.
static const fileName null
An empty fileName.
Definition: fileName.H:111
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
virtual fileName write()
Write surface geometry to file.
A simple container for options an IOstream can normally have.
static std::string path(const std::string &str)
Return directory path name (part before last /)
Definition: fileNameI.H:169
word ext() const
Return file name extension (part after last .)
Definition: fileNameI.H:211
Abstract definition of a meshed surface defined by faces and points.
Definition: meshedSurf.H:43
A surfaceWriter that writes the geometry via the MeshedSurfaceProxy, but which does not support any f...
bool isDir(const fileName &name, const bool followLink=true)
Does the name exist as a DIRECTORY in the file system?
Definition: POSIX.C:860
Functions used by OpenFOAM that are specific to POSIX compliant operating systems and need to be repl...
word timeName
Definition: getTimeIndex.H:3
void write(vtk::formatter &fmt, const Type &val, const label n=1)
Component-wise write of a value (N times)
bool mkDir(const fileName &pathName, mode_t mode=0777)
Make a directory and return an error if it could not be created.
Definition: POSIX.C:614
const pointField & points
proxyWriter(const word &fileExt)
Construct for a given extension.
A class for handling words, derived from Foam::string.
Definition: word.H:63
Convenience macros for instantiating surfaceWriter methods.
defineTypeName(abaqusWriter)
static bool master(const label communicator=worldComm)
True if process corresponds to the master rank in the communicator.
Definition: UPstream.H:1082
messageStream Info
Information stream (stdout output on master, null elsewhere)
defineSurfaceWriterWriteFields(Foam::surfaceWriters::proxyWriter)
Base class for surface writers.
Namespace for OpenFOAM.