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-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 \*---------------------------------------------------------------------------*/
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  fvMesh& mesh,
50  const word& algorithmName
51 )
52 :
54  (
55  mesh,
56  (
57  !mesh.solution().dict().found(algorithmName)
58  && mesh.schemes().steady()
59  && mesh.solution().dict().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  return mesh_.solution().dict().subDict(algorithmName());
79 }
80 
81 
83 (
84  const bool finalIter
85 ) const
86 {
87  finalIter_ = finalIter;
88 }
89 
90 
92 {
93  storePrevIterTypeFields<scalar>();
94  storePrevIterTypeFields<vector>();
95  storePrevIterTypeFields<sphericalTensor>();
96  storePrevIterTypeFields<symmTensor>();
97  storePrevIterTypeFields<tensor>();
98 }
99 
100 
101 // ************************************************************************* //
bool found
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:843
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
const fvSolution & solution() const
Return the fvSolution.
Definition: fvMesh.C:1762
virtual bool modified() const
Return true if the object's file (or files for objectRegistry)
Single-region-specific derivation of the solution control class.
singleRegionSolutionControl(fvMesh &mesh, const word &algorithmName)
Construct from a mesh and the name of the algorithm.
virtual bool dependenciesModified() const
Return true if the dependencies have been modified.
void storePrevIterFields()
Store previous iteration for fields.
virtual const dictionary & dict() const
Return the solution dictionary.
fvMesh & mesh_
Reference to the mesh.
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:62
Namespace for OpenFOAM.
defineTypeNameAndDebug(combustionModel, 0)
dictionary dict