fvIOoptionListAdjoint.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) 2007-2019 PCOpt/NTUA
9  Copyright (C) 2013-2019 FOSS GP
10  Copyright (C) 2019 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 3 of the License, or
18  (at your option) any later version.
19 
20  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23  for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27 
28 
29 Class
30  Foam::fv::IOoptionListAdjoint
31 
32 Description
33  IOoptionListAdjoint
34 
35 SourceFiles
36  IOoptionListAdjoint.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef IOoptionListAdjoint_H
41 #define IOoptionListAdjoint_H
42 
43 #include "fvOptionList.H"
44 #include "IOdictionary.H"
45 #include "autoPtr.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 namespace fv
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class IOoptionListAdjoint Declaration
57 \*---------------------------------------------------------------------------*/
58 
60 :
61  public IOdictionary,
62  public optionList
63 {
64 private:
65 
66  // Private Member Functions
67 
68  //- Create IO object if dictionary is present
69  IOobject createIOobject(const fvMesh& mesh) const;
70 
71  //- No copy construct
73 
74  //- No copy assignment
75  void operator=(const IOoptionListAdjoint&) = delete;
76 
77 
78 public:
79 
80  // Constructors
81 
82  //- Construct from components with list of field names
84 
85 
86  //- Destructor
87  virtual ~IOoptionListAdjoint() = default;
88 
89 
90  // Member Functions
91 
92  //- Read dictionary
93  virtual bool read();
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace fv
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:54
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:104
Foam::fv::IOoptionListAdjoint::read
virtual bool read()
Read dictionary.
Definition: fvIOoptionListAdjoint.C:80
fvOptionList.H
Foam::fv::IOoptionListAdjoint::~IOoptionListAdjoint
virtual ~IOoptionListAdjoint()=default
Destructor.
Foam::fv::IOoptionListAdjoint
IOoptionListAdjoint.
Definition: fvIOoptionListAdjoint.H:58
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:84
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
fv
labelList fv(nPoints)
IOdictionary.H
Foam::fv::optionList
List of finite volume options.
Definition: fvOptionList.H:67
autoPtr.H