surfaceReader.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) 2015-2022 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "surfaceReader.H"
29 #include "fileFormats.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  defineTypeNameAndDebug(surfaceReader, 0);
37 }
38 
39 
40 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
41 
43 (
44  const dictionary& dict,
45  const word& formatName,
46  const word& entryName
47 )
48 {
49  return fileFormats::getFormatOptions(dict, formatName, entryName);
50 }
51 
52 
53 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
54 
56 (
57  const fileName& fName
58 )
59 :
60  fileName_(fName)
61 {}
62 
63 
65 (
66  const fileName& fName,
67  const dictionary& options
68 )
69 :
70  surfaceReader(fName)
71 {}
72 
73 
74 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
75 
78 (
79  const word& readerType,
80  const fileName& fName,
81  const dictionary& options
82 )
83 {
84  auto* ctorPtr = fileNameConstructorTable(readerType);
85 
86  if (!ctorPtr)
87  {
89  (
90  "reader",
91  readerType,
92  *fileNameConstructorTablePtr_
93  ) << exit(FatalError);
94  }
95 
96  return autoPtr<surfaceReader>(ctorPtr(fName, options));
97 }
98 
99 
100 // ************************************************************************* //
dictionary dict
A class for handling file names.
Definition: fileName.H:72
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
surfaceReader(const fileName &fName)
Construct from fileName.
Definition: surfaceReader.C:49
dictionary getFormatOptions(const dictionary &dict, const word &formatName, const word &entryName="formatOptions")
Find "formatOptions" in a top-level dictionary. Extract and merge &#39;default&#39; + formatName values...
Definition: fileFormats.C:80
#define FatalErrorInLookup(lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalError.
Definition: error.H:605
A class for handling words, derived from Foam::string.
Definition: word.H:63
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
static dictionary formatOptions(const dictionary &dict, const word &formatName, const word &entryName="formatOptions")
Same as fileFormats::getFormatOptions.
Definition: surfaceReader.C:36
static autoPtr< surfaceReader > New(const word &readType, const fileName &fName, const dictionary &options=dictionary())
Return a reference to the selected surfaceReader.
Definition: surfaceReader.C:71
Abstract base class for surface readers with fields.
Definition: surfaceReader.H:67
Namespace for OpenFOAM.