surfaceMeshExport.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 | Copyright (C) 2011-2015 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 Application
25  surfaceMeshExport
26 
27 Description
28  Export from surfMesh to various third-party surface formats with
29  optional scaling or transformations (rotate/translate) on a
30  coordinateSystem.
31 
32 Usage
33  - surfaceMeshExport outputFile [OPTION]
34 
35  \param -clean \n
36  Perform some surface checking/cleanup on the input surface.
37 
38  \param -name <name> \n
39  Specify an alternative surface name when writing.
40 
41  \param -scaleIn <scale> \n
42  Specify a scaling factor when reading files.
43 
44  \param -scaleOut <scale> \n
45  Specify a scaling factor when writing files.
46 
47  \param -dict <dictionary> \n
48  Specify an alternative dictionary for constant/coordinateSystems.
49 
50  \param -from <coordinateSystem> \n
51  Specify a coordinate system when reading files.
52 
53  \param -to <coordinateSystem> \n
54  Specify a coordinate system when writing files.
55 
56 Note
57  The filename extensions are used to determine the file format type.
58 
59 \*---------------------------------------------------------------------------*/
60 
61 #include "argList.H"
62 #include "Time.H"
63 
64 #include "MeshedSurfaces.H"
65 #include "coordinateSystems.H"
66 
67 using namespace Foam;
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 int main(int argc, char *argv[])
72 {
74  (
75  "export from surfMesh to various third-party surface formats"
76  );
77 
79  argList::validArgs.append("outputFile");
80 
82  (
83  "clean",
84  "perform some surface checking/cleanup on the input surface"
85  );
87  (
88  "name",
89  "name",
90  "specify an alternative surface name when reading - "
91  "default is 'default'"
92  );
94  (
95  "scaleIn",
96  "factor",
97  "geometry scaling factor on input - default is 1"
98  );
100  (
101  "scaleOut",
102  "factor",
103  "geometry scaling factor on output - default is 1"
104  );
105  #include "addDictOption.H"
107  (
108  "from",
109  "coordinateSystem",
110  "specify the source coordinate system, applied after '-scaleIn'"
111  );
113  (
114  "to",
115  "coordinateSystem",
116  "specify the target coordinate system, applied before '-scaleOut'"
117  );
118 
119  argList args(argc, argv);
120  Time runTime(args.rootPath(), args.caseName());
121 
122  const fileName exportName = args[1];
123  const word importName = args.optionLookupOrDefault<word>("name", "default");
124 
125  // check that writing is supported
126  if (!MeshedSurface<face>::canWriteType(exportName.ext(), true))
127  {
128  return 1;
129  }
130 
131 
132  // get the coordinate transformations
133  autoPtr<coordinateSystem> fromCsys;
135 
136  if (args.optionFound("from") || args.optionFound("to"))
137  {
138  autoPtr<IOobject> ioPtr;
139 
140  if (args.optionFound("dict"))
141  {
142  const fileName dictPath = args["dict"];
143 
144  ioPtr.set
145  (
146  new IOobject
147  (
148  (
149  isDir(dictPath)
150  ? dictPath/coordinateSystems::typeName
151  : dictPath
152  ),
153  runTime,
156  false
157  )
158  );
159  }
160  else
161  {
162  ioPtr.set
163  (
164  new IOobject
165  (
166  coordinateSystems::typeName,
167  runTime.constant(),
168  runTime,
171  false
172  )
173  );
174  }
175 
176 
177  if (!ioPtr->headerOk())
178  {
180  << ioPtr->objectPath() << nl
181  << exit(FatalError);
182  }
183 
184  coordinateSystems csLst(ioPtr());
185 
186  if (args.optionFound("from"))
187  {
188  const word csName = args["from"];
189 
190  const label csIndex = csLst.findIndex(csName);
191  if (csIndex < 0)
192  {
194  << "Cannot find -from " << csName << nl
195  << "available coordinateSystems: " << csLst.toc() << nl
196  << exit(FatalError);
197  }
198 
199  fromCsys.reset(new coordinateSystem(csLst[csIndex]));
200  }
201 
202  if (args.optionFound("to"))
203  {
204  const word csName = args["to"];
205 
206  const label csIndex = csLst.findIndex(csName);
207  if (csIndex < 0)
208  {
210  << "Cannot find -to " << csName << nl
211  << "available coordinateSystems: " << csLst.toc() << nl
212  << exit(FatalError);
213  }
214 
215  toCsys.reset(new coordinateSystem(csLst[csIndex]));
216  }
217 
218 
219  // maybe fix this later
220  if (fromCsys.valid() && toCsys.valid())
221  {
223  << exit(FatalError);
224  }
225  }
226 
227 
228  surfMesh smesh
229  (
230  IOobject
231  (
232  importName,
233  runTime.constant(),
234  runTime,
237  )
238  );
239 
240  Info<< "read surfMesh:\n " << smesh.objectPath() << endl;
241 
242 
243  // Simply copy for now, but really should have a separate write method
244 
245  MeshedSurface<face> surf(smesh);
246 
247  if (args.optionFound("clean"))
248  {
249  surf.cleanup(true);
250  }
251 
252  scalar scaleIn = 0;
253  if (args.optionReadIfPresent("scaleIn", scaleIn) && scaleIn > 0)
254  {
255  Info<< " -scaleIn " << scaleIn << endl;
256  surf.scalePoints(scaleIn);
257  }
258 
259  if (fromCsys.valid())
260  {
261  Info<< " -from " << fromCsys().name() << endl;
262  tmp<pointField> tpf = fromCsys().localPosition(surf.points());
263  surf.movePoints(tpf());
264  }
265 
266  if (toCsys.valid())
267  {
268  Info<< " -to " << toCsys().name() << endl;
269  tmp<pointField> tpf = toCsys().globalPosition(surf.points());
270  surf.movePoints(tpf());
271  }
272 
273  scalar scaleOut = 0;
274  if (args.optionReadIfPresent("scaleOut", scaleOut) && scaleOut > 0)
275  {
276  Info<< " -scaleOut " << scaleOut << endl;
277  surf.scalePoints(scaleOut);
278  }
279 
280 
281  surf.writeStats(Info);
282  Info<< endl;
283 
284  Info<< "writing " << exportName << endl;
285  surf.write(exportName);
286 
287  Info<< "\nEnd\n" << endl;
288 
289  return 0;
290 }
291 
292 // ************************************************************************* //
Foam::argList::validArgs
static SLList< string > validArgs
A list of valid (mandatory) arguments.
Definition: argList.H:143
Foam::IOobject
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::fileName
A class for handling file names.
Definition: fileName.H:69
Foam::argList::addOption
static void addOption(const word &opt, const string &param="", const string &usage="")
Add to an option to validOptions with usage information.
Definition: argList.C:108
Foam::argList::addNote
static void addNote(const string &)
Add extra notes for the usage information.
Definition: argList.C:139
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
Foam::argList::addBoolOption
static void addBoolOption(const word &opt, const string &usage="")
Add to a bool option to validOptions with usage information.
Definition: argList.C:98
Foam::argList
Extract command arguments and options from the supplied argc and argv parameters.
Definition: argList.H:97
Foam::surfMesh
A surface mesh consisting of general polygon faces.
Definition: surfMesh.H:55
Foam::IOobject::MUST_READ
@ MUST_READ
Definition: IOobject.H:108
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
Foam::argList::rootPath
const fileName & rootPath() const
Return root path.
Definition: argListI.H:36
Foam::IOobject::NO_WRITE
@ NO_WRITE
Definition: IOobject.H:118
addDictOption.H
Foam::IOobject::MUST_READ_IF_MODIFIED
@ MUST_READ_IF_MODIFIED
Definition: IOobject.H:109
Foam::label
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
Foam::Ostream::write
virtual Ostream & write(const token &)=0
Write next token to stream.
Foam::nl
static const char nl
Definition: Ostream.H:260
Foam::Info
messageStream Info
argList.H
Foam::autoPtr::set
void set(T *)
Set pointer to that given.
Definition: autoPtrI.H:99
main
int main(int argc, char *argv[])
Definition: postCalc.C:54
Foam::argList::optionLookupOrDefault
T optionLookupOrDefault(const word &opt, const T &deflt) const
Read a value from the named option if present.
Definition: argListI.H:237
Foam::FatalError
error FatalError
Foam::coordinateSystems
Provides a centralized coordinateSystem collection.
Definition: coordinateSystems.H:71
Foam::fileName::ext
word ext() const
Return file name extension (part after last .)
Definition: fileName.C:329
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::isDir
bool isDir(const fileName &)
Does the name exist as a DIRECTORY in the file system?
Definition: POSIX.C:615
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
Foam::autoPtr
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:318
Foam::autoPtr::valid
bool valid() const
Return true if the autoPtr valid (ie, the pointer is set).
Definition: autoPtrI.H:83
MeshedSurfaces.H
Foam::argList::optionFound
bool optionFound(const word &opt) const
Return true if the named option is found.
Definition: argListI.H:108
Foam::autoPtr::reset
void reset(T *=0)
If object pointer already set, delete object and set to given.
Definition: autoPtrI.H:114
Foam::argList::caseName
const fileName & caseName() const
Return case name (parallel run) or global case (serial run)
Definition: argListI.H:42
Foam::argList::noParallel
static void noParallel()
Remove the parallel options.
Definition: argList.C:161
Foam::MeshedSurface
A surface geometry mesh with zone information, not to be confused with the similarly named surfaceMes...
Definition: MeshedSurface.H:72
args
Foam::argList args(argc, argv)
dictPath
fileName dictPath
Definition: setConstantMeshDictionaryIO.H:5
Foam::argList::optionReadIfPresent
bool optionReadIfPresent(const word &opt, T &) const
Read a value from the named option if present.
Definition: argListI.H:198
coordinateSystems.H
Foam::coordinateSystem
Base class for other coordinate system specifications.
Definition: coordinateSystem.H:85