externalFileCouplerI.H
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) 2017 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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
31 {
32  return runState_ != NONE;
33 }
34 
35 
37 {
38  return slaveFirst_;
39 }
40 
41 
43 {
44  return commsDir_;
45 }
46 
47 
49 (
50  const word& file
51 ) const
52 {
53  return fileName(commDirectory()/file);
54 }
55 
56 
58 {
59  return resolveFile(lockName + ".lock");
60 }
61 
62 
63 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::fileName
A class for handling file names.
Definition: fileName.H:73
Foam::externalFileCoupler::slaveFirst
bool slaveFirst() const
External application provides initial values.
Definition: externalFileCouplerI.H:36
Foam::externalFileCoupler::commDirectory
const fileName & commDirectory() const
Return the file path to the base communications directory.
Definition: externalFileCouplerI.H:42
Foam::externalFileCoupler::initialized
bool initialized() const
True if state has been initialized.
Definition: externalFileCouplerI.H:30
Foam::externalFileCoupler::resolveFile
fileName resolveFile(const word &file) const
Return the file path in the communications directory.
Definition: externalFileCouplerI.H:49
Foam::externalFileCoupler::NONE
Not initialized.
Definition: externalFileCoupler.H:116
Foam::externalFileCoupler::lockFile
fileName lockFile() const
Return the file path to the lock file.
Definition: externalFileCouplerI.H:57