fvSolution.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) 2011 OpenFOAM Foundation
9  Copyright (C) 2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::fvSolution
29 
30 Description
31  Selector class for finite volume solution solution.
32  fvMesh is derived from fvSolution so that all fields have access to the
33  fvSolution from the mesh reference they hold.
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef fvSolution_H
38 #define fvSolution_H
39 
40 #include "solution.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class fvSolution Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class fvSolution
52 :
53  public solution
54 {
55  // Private Member Functions
56 
57  //- No copy construct
58  fvSolution(const fvSolution&) = delete;
59 
60  //- No copy assignment
61  void operator=(const fvSolution&) = delete;
62 
63 
64 public:
65 
66  // Constructors
67 
68  //- Construct for objectRegistry
69  fvSolution(const objectRegistry& obr)
70  :
71  solution(obr, "fvSolution")
72  {}
73 
74  //- Construct for objectRegistry and optional contents
75  fvSolution(const objectRegistry& obr, const dictionary& dict)
76  :
77  solution(obr, "fvSolution", dict)
78  {}
79 };
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace Foam
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #endif
89 
90 // ************************************************************************* //
Foam::solution
Selector class for relaxation factors, solver type and solution.
Definition: solution.H:51
Foam::fvSolution::fvSolution
fvSolution(const objectRegistry &obr, const dictionary &dict)
Construct for objectRegistry and optional contents.
Definition: fvSolution.H:74
Foam::objectRegistry
Registry of regIOobjects.
Definition: objectRegistry.H:60
Foam::fvSolution::fvSolution
fvSolution(const objectRegistry &obr)
Construct for objectRegistry.
Definition: fvSolution.H:68
Foam::fvSolution
Selector class for finite volume solution solution. fvMesh is derived from fvSolution so that all fie...
Definition: fvSolution.H:50
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
solution.H