All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
multiRegionSolutionControl.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2018-2023 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::multiRegionSolutionControl
26 
27 Description
28  Multi-region-specific derivation of the solution control class
29 
30 SourceFiles
31  multiRegionSolutionControl.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef multiRegionSolutionControl_H
36 #define multiRegionSolutionControl_H
37 
38 #include "solutionControl.H"
39 #include "fvSolution.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class multiRegionSolutionControl Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public solutionControl
53 {
54  // Private Data
55 
56  //- Solution instance
57  const fvSolution solution_;
58 
59 
60  // Protected Member Functions
61 
62  //- Return true if the dependencies have been modified
63  virtual bool dependenciesModified() const;
64 
65 
66 public:
67 
68  // Static Data Members
69 
70  //- Run-time type information
71  TypeName("multiRegionSolutionControl");
72 
73 
74  // Constructors
75 
76  //- Construct from a time and the name of the algorithm
78 
79 
80  //- Destructor
82 
83 
84  // Member Functions
85 
86  // Access
87 
88  //- Return the solution dictionary
89  virtual const dictionary& dict() const;
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
const Time & time() const
Return time.
Definition: IOobject.C:318
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Selector class for finite volume solution solution. fvMesh is derived from fvSolution so that all fie...
Definition: fvSolution.H:50
Multi-region-specific derivation of the solution control class.
virtual const dictionary & dict() const
Return the solution dictionary.
TypeName("multiRegionSolutionControl")
Run-time type information.
multiRegionSolutionControl(const Time &time, const word &algorithmName)
Construct from a time and the name of the algorithm.
Solution control class.
const word & algorithmName() const
Return the name of the algorithm.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.