readFields.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) 2018-2023 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 "readFields.H"
29 #include "volFields.H"
30 
31 // * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
32 
33 Foam::label Foam::checkData
34 (
35  const objectRegistry& obr,
36  const instantList& timeDirs,
37  wordList& objectNames,
38  const fileName& local
39 )
40 {
41  // Assume prune_0() was used prior to calling this
42 
43  wordHashSet goodFields;
44 
45  for (const word& fieldName : objectNames)
46  {
47  // // If prune_0() not previously used...
48  // if (objectNames.ends_with("_0")) continue;
49 
50  bool good = false;
51 
52  for (const instant& inst : timeDirs)
53  {
54  good =
55  IOobject
56  (
57  fieldName,
58  inst.name(),
59  local,
60  obr,
61  IOobject::NO_READ,
62  IOobject::NO_WRITE,
63  IOobject::NO_REGISTER
64  ).typeHeaderOk<volScalarField>(false, false);
65 
66  if (!good)
67  {
68  break;
69  }
70  }
71 
72  if (returnReduceAnd(good))
73  {
74  goodFields.insert(fieldName);
75  }
76  }
77 
78  objectNames = goodFields.sortedToc();
79 
80  return objectNames.size();
81 }
82 
83 
84 // ************************************************************************* //
bool returnReduceAnd(const bool value, const int communicator=UPstream::worldComm)
Perform logical (and) MPI Allreduce on a copy. Uses UPstream::reduceAnd.
bool local
Definition: EEqn.H:20
HashSet< word, Hash< word > > wordHashSet
A HashSet of words, uses string hasher.
Definition: HashSet.H:73
List< word > wordList
List of word.
Definition: fileName.H:59
List< instant > instantList
List of instants.
Definition: instantList.H:41
label checkData(const objectRegistry &obr, const instantList &timeDirs, wordList &objectNames, const fileName &local=fileName::null)
Check if fields are good to use (available at all times)