fileOperationInitialise.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-2018 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::fileOperationInitialise
28
29Description
30 General fileOperation initialiser.
31 Handles \c -ioRanks option, using it to set the FOAM_IORANKS environment
32 variable.
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef fileOperationInitialise_H
37#define fileOperationInitialise_H
38
40
41// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43namespace Foam
44{
45namespace fileOperations
46{
47
48/*---------------------------------------------------------------------------*\
49 Class fileOperationInitialise Declaration
50\*---------------------------------------------------------------------------*/
53{
54public:
55
56 //- Runtime type information
57 TypeName("fileOperationInitialise");
58
59
60 // Constructors
61
62 //- Construct from components
63 fileOperationInitialise(int& argc, char**& argv);
64
65
66 // Declare run-time constructor selection table
69 (
70 autoPtr,
72 word,
73 (
74 int& argc, char**& argv
75 ),
76 (argc, argv)
77 );
78
79
80 // Selectors
81
82 //- Select type
84 (
85 const word& type, int& argc, char**& argv
86 );
87
88
89 //- Destructor
90 virtual ~fileOperationInitialise() = default;
91
92
93 // Member Functions
94
95 //- Threading required?
96 virtual bool needsThreading() const = 0;
97};
98
99
100// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102} // End namespace fileOperations
103} // End namespace Foam
104
105// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106
107#endif
108
109// ************************************************************************* //
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
virtual ~fileOperationInitialise()=default
Destructor.
declareRunTimeSelectionTable(autoPtr, fileOperationInitialise, word,(int &argc, char **&argv),(argc, argv))
static autoPtr< fileOperationInitialise > New(const word &type, int &argc, char **&argv)
Select type.
TypeName("fileOperationInitialise")
Runtime type information.
virtual bool needsThreading() const =0
Threading required?
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:598
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73