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-2019 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 {
33  defineTypeNameAndDebug(singleRegionSolutionControl, 0);
34 }
35 
36 
37 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
38 
40 (
41  fvMesh& mesh,
42  const word& algorithmName
43 )
44 :
45  solutionControl(mesh, mesh.time(), algorithmName),
46  mesh_(mesh)
47 {}
48 
49 
50 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
51 
53 {}
54 
55 
56 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
57 
59 {
60  return mesh_.solutionDict().subDict(algorithmName());
61 }
62 
63 
65 {
66  return false;
67 }
68 
69 
71 {
72  mesh_.data::remove("finalIteration");
73 
74  if (isFinal())
75  {
76  mesh_.data::add("finalIteration", true);
77  }
78 }
79 
80 
82 {
83  storePrevIterTypeFields<scalar>();
84  storePrevIterTypeFields<vector>();
85  storePrevIterTypeFields<sphericalTensor>();
86  storePrevIterTypeFields<symmTensor>();
87  storePrevIterTypeFields<tensor>();
88 }
89 
90 
91 // ************************************************************************* //
singleRegionSolutionControl(fvMesh &mesh, const word &algorithmName)
Construct from a mesh and the name of the algorithm.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Solution control class.
virtual bool isFinal() const
Flag to indicate whether in final state.
const Time & time() const
Return the top-level database.
Definition: fvMesh.H:239
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:982
A class for handling words, derived from string.
Definition: word.H:59
virtual const dictionary & dict() const
Return the solution dictionary.
void storePrevIterFields()
Store previous iteration for fields.
defineTypeNameAndDebug(combustionModel, 0)
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
void updateFinal() const
Update the mesh data for the final state.
Namespace for OpenFOAM.