singleRegionSolutionControl.C
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-2026 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 \*---------------------------------------------------------------------------*/
25 
27 #include "volFields.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
34 }
35 
36 
37 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
38 
40 {
41  return mesh_.solution().modified();
42 }
43 
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
48 (
49  const fvMesh& mesh,
50  const word& algorithmName
51 )
52 :
54  (
55  mesh,
56  (
57  !mesh.solution().found(algorithmName)
58  && mesh.schemes().steady()
59  && mesh.solution().found("SIMPLE")
60  )
61  ? "SIMPLE"
62  : algorithmName
63  ),
64  mesh_(mesh)
65 {}
66 
67 
68 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
69 
71 {}
72 
73 
74 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
75 
77 (
78  const fvMesh& mesh,
79  const word& algorithmName
80 )
81 {
82  return mesh.solution().subDict
83  (
84  (
85  !mesh.solution().found(algorithmName)
86  && mesh.schemes().steady()
87  && mesh.solution().found("SIMPLE")
88  )
89  ? "SIMPLE"
90  : algorithmName
91  );
92 }
93 
94 
96 {
97  return dict(mesh_, algorithmName());
98 }
99 
100 
102 (
103  const bool finalIter
104 ) const
105 {
106  finalIter_ = finalIter;
107 }
108 
109 
111 {
112  storePrevIterTypeFields<scalar>();
113  storePrevIterTypeFields<vector>();
114  storePrevIterTypeFields<sphericalTensor>();
115  storePrevIterTypeFields<symmTensor>();
116  storePrevIterTypeFields<tensor>();
117 }
118 
119 
120 // ************************************************************************* //
bool found
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:778
bool found(const word &, bool recursive=false, bool patternMatch=true) const
Search dictionary for given keyword.
Definition: dictionary.C:468
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:98
const fvSchemes & schemes() const
Return the fvSchemes.
Definition: fvMesh.C:1792
const fvSolution & solution() const
Return the fvSolution.
Definition: fvMesh.C:1803
bool steady() const
Return true if the default ddtScheme is steadyState.
Definition: fvSchemes.H:145
virtual bool modified() const
Return true if the object's file (or files for objectRegistry)
Single-region-specific derivation of the solution control class.
const fvMesh & mesh_
Reference to the mesh.
virtual bool dependenciesModified() const
Return true if the dependencies have been modified.
void storePrevIterFields()
Store previous iteration for fields.
singleRegionSolutionControl(const fvMesh &mesh, const word &algorithmName)
Construct from a mesh and the name of the algorithm.
virtual const dictionary & dict() const
Return the solution dictionary.
void updateFinal(const bool finalIter) const
Update the mesh data for the final state.
Solution control class.
Selector class for relaxation factors, solver type and solution.
Definition: solution.H:51
A class for handling words, derived from string.
Definition: word.H:63
Foam::fvMesh mesh(Foam::IOobject(regionName, runTime.name(), runTime, Foam::IOobject::MUST_READ), false)
Namespace for OpenFOAM.
defineTypeNameAndDebug(atmosphericBoundaryLayer, 0)
dictionary dict