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 {
40  defineTypeName(proxyWriter);
41 }
42 }
43 
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
48 :
49  surfaceWriter(),
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  IOstream::formatEnum("format", options, IOstream::ASCII),
66  IOstream::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 
130  if (Pstream::master() || !parallel_)
131  {
132  if (!isDir(outputFile.path()))
133  {
134  mkDir(outputFile.path());
135  }
136 
138  (
139  outputFile,
140  fileExtension_,
141  streamOpt_,
142  options_
143  );
144  }
145 
146  wroteGeom_ = true;
147  return outputFile;
148 }
149 
150 
151 // Field writing methods
153 
154 
155 // ************************************************************************* //
OSspecific.H
Functions used by OpenFOAM that are specific to POSIX compliant operating systems and need to be repl...
MeshedSurfaceProxy.H
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::surfaceWriter
Base class for surface writers.
Definition: surfaceWriter.H:114
Foam::fileName
A class for handling file names.
Definition: fileName.H:73
Foam::surfaceWriters::defineTypeName
defineTypeName(abaqusWriter)
proxySurfaceWriter.H
Foam::fileName::path
static std::string path(const std::string &str)
Return directory path name (part before last /)
Definition: fileNameI.H:176
Foam::meshedSurf::faces
virtual const faceList & faces() const =0
The faces used for the surface.
Foam::meshedSurf
Abstract definition of a meshed surface defined by faces and points.
Definition: meshedSurf.H:49
Foam::surfaceWriters::proxyWriter::write
virtual fileName write()
Write surface geometry to file.
Definition: proxySurfaceWriter.C:103
Foam::UPstream::master
static bool master(const label communicator=worldComm)
Am I the master process.
Definition: UPstream.H:457
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
surfaceWriterMethods.H
Convenience macros for instantiating surfaceWriter methods.
Foam::MeshedSurfaceProxy
A proxy for writing MeshedSurface, UnsortedMeshedSurface and surfMesh to various file formats.
Definition: MeshedSurface.H:82
defineSurfaceWriterWriteFields
defineSurfaceWriterWriteFields(Foam::surfaceWriters::proxyWriter)
Foam::surfaceWriters::proxyWriter
A surfaceWriter that writes the geometry via the MeshedSurfaceProxy, but which does not support any f...
Definition: proxySurfaceWriter.H:92
Foam::Field< vector >
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::meshedSurf::points
virtual const pointField & points() const =0
The points used for the surface.
timeName
word timeName
Definition: getTimeIndex.H:3
Foam::IOstreamOption::compressionEnum
static compressionType compressionEnum(const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
The compression enum corresponding to the string.
Definition: IOstreamOption.C:92
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::fileName::ext
word ext() const
Return file name extension (part after last .)
Definition: fileNameI.H:218
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::fileName::null
static const fileName null
An empty fileName.
Definition: fileName.H:101
Foam::surfaceWriters::proxyWriter::proxyWriter
proxyWriter(const word &fileExt)
Construct for a given extension.
Definition: proxySurfaceWriter.C:47
Foam::IOstreamOption::ASCII
"ascii" (normal default)
Definition: IOstreamOption.H:72
Foam::IOstreamOption::formatEnum
static streamFormat formatEnum(const word &formatName, const streamFormat deflt=streamFormat::ASCII)
Definition: IOstreamOption.C:53
Foam::List< face >
points
const pointField & points
Definition: gmvOutputHeader.H:1
Foam::vtk::write
void write(vtk::formatter &fmt, const Type &val, const label n=1)
Component-wise write of a value (N times)
Definition: foamVtkOutputTemplates.C:36
Foam::mkDir
bool mkDir(const fileName &pathName, mode_t mode=0777)
Make a directory and return an error if it could not be created.
Definition: MSwindows.C:507
Foam::surfaceWriter::open
virtual void open(const fileName &outputPath)
Open for output on specified path, using existing surface.
Definition: surfaceWriter.C:250
Foam::isDir
bool isDir(const fileName &name, const bool followLink=true)
Does the name exist as a DIRECTORY in the file system?
Definition: MSwindows.C:643