edgeMeshFormatsCore.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-2012 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 \*---------------------------------------------------------------------------*/
25 
26 #include "edgeMeshFormatsCore.H"
27 
28 #include "Time.H"
29 #include "IFstream.H"
30 #include "OFstream.H"
31 #include "edgeMesh.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
36 
37 
38 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
39 
41 (
42  IFstream& is
43 )
44 {
45  string line;
46  do
47  {
48  is.getLine(line);
49  }
50  while ((line.empty() || line[0] == '#') && is.good());
51 
52  return line;
53 }
54 
55 
56 #if 0
57 Foam::fileName Foam::fileFormats::edgeMeshFormatsCore::localMeshFileName
58 (
59  const word& meshName
60 )
61 {
62  const word name(meshName.size() ? meshName : surfaceRegistry::defaultName);
63 
64  return fileName
65  (
67  / name + "." + nativeExt
68  );
69 }
70 
71 
72 Foam::fileName Foam::fileFormats::edgeMeshFormatsCore::findMeshInstance
73 (
74  const Time& t,
75  const word& meshName
76 )
77 {
78  fileName localName = localMeshFileName(meshName);
79 
80  // Search back through the time directories list to find the time
81  // closest to and lower than current time
82 
83  instantList ts = t.times();
84  label instanceI;
85 
86  for (instanceI = ts.size()-1; instanceI >= 0; --instanceI)
87  {
88  if (ts[instanceI].value() <= t.timeOutputValue())
89  {
90  break;
91  }
92  }
93 
94  // Noting that the current directory has already been searched
95  // for mesh data, start searching from the previously stored time directory
96 
97  if (instanceI >= 0)
98  {
99  for (label i = instanceI; i >= 0; --i)
100  {
101  if (isFile(t.path()/ts[i].name()/localName))
102  {
103  return ts[i].name();
104  }
105  }
106  }
107 
108  return t.constant();
109 }
110 
111 
112 Foam::fileName Foam::fileFormats::edgeMeshFormatsCore::findMeshFile
113 (
114  const Time& t,
115  const word& meshName
116 )
117 {
118  fileName localName = localMeshFileName(meshName);
119 
120  // Search back through the time directories list to find the time
121  // closest to and lower than current time
122 
123  instantList ts = t.times();
124  label instanceI;
125 
126  for (instanceI = ts.size()-1; instanceI >= 0; --instanceI)
127  {
128  if (ts[instanceI].value() <= t.timeOutputValue())
129  {
130  break;
131  }
132  }
133 
134  // Noting that the current directory has already been searched
135  // for mesh data, start searching from the previously stored time directory
136 
137  if (instanceI >= 0)
138  {
139  for (label i = instanceI; i >= 0; --i)
140  {
141  fileName testName(t.path()/ts[i].name()/localName);
142 
143  if (isFile(testName))
144  {
145  return testName;
146  }
147  }
148  }
149 
150  // fallback to "constant"
151  return t.path()/t.constant()/localName;
152 }
153 #endif
154 
155 
157 (
158  const wordHashSet& available,
159  const word& ext,
160  const bool verbose,
161  const word& functionName
162 )
163 {
164  if (available.found(ext))
165  {
166  return true;
167  }
168  else if (verbose)
169  {
170  wordList known = available.sortedToc();
171 
172  Info<<"Unknown file extension for " << functionName
173  << " : " << ext << nl
174  <<"Valid types: (";
175  // compact output:
176  forAll(known, i)
177  {
178  Info<<" " << known[i];
179  }
180  Info<<" )" << endl;
181  }
182 
183  return false;
184 }
185 
186 
187 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
188 
190 {}
191 
192 
193 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
194 
196 {}
197 
198 
199 // ************************************************************************* //
static word defaultName
The default surface name: default.
fileName path() const
Return path.
Definition: Time.H:281
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
List< Key > sortedToc() const
Return the table of contents as a sorted list.
Definition: HashTable.C:216
A class for handling words, derived from string.
Definition: word.H:59
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 character strings derived from std::string.
Definition: string.H:74
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:76
static string getLineNoComment(IFstream &)
Read non-comment line.
messageStream Info
static bool checkSupport(const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
Input from file stream.
Definition: IFstream.H:81
scalar timeOutputValue() const
Return current time value.
Definition: TimeState.C:67
const word & constant() const
Return constant name.
Definition: TimePaths.H:124
A line primitive.
Definition: line.H:56
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
static const char nl
Definition: Ostream.H:260
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
#define forAll(list, i)
Definition: UList.H:421
bool good() const
Return true if next operation might succeed.
Definition: IOstream.H:333
ISstream & getLine(string &)
Raw, low-level getline into a string function.
Definition: ISstreamI.H:77
static const word prefix
The prefix to local: surfaces.
A class for handling file names.
Definition: fileName.H:69
static word nativeExt
The file extension corresponding to &#39;native&#39; edge format.
A HashTable with keys but without contents.
Definition: HashSet.H:59
instantList times() const
Search the case for valid time directories.
Definition: Time.C:758
bool isFile(const fileName &, const bool checkGzip=true)
Does the name exist as a FILE in the file system?
Definition: POSIX.C:623
bool found(const Key &) const
Return true if hashedEntry is found in table.
Definition: HashTable.C:109
static word meshSubDir
Return the mesh sub-directory name (normally "surfMesh")
Definition: surfMesh.H:152