nonOrthogonalSolutionControl.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 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(nonOrthogonalSolutionControl, 0);
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 (
40  fvMesh& mesh,
41  const word& algorithmName
42 )
43 :
44  singleRegionSolutionControl(mesh, algorithmName),
45  nCorrNonOrth_(-1),
46  corrNonOrth_(0)
47 {
48  read();
49 }
50 
51 
52 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
53 
55 {}
56 
57 
58 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
59 
61 {
63  {
64  return false;
65  }
66 
67  const dictionary& solutionDict = dict();
68 
69  nCorrNonOrth_ =
70  solutionDict.lookupOrDefault<label>("nNonOrthogonalCorrectors", 0);
71 
72  return true;
73 }
74 
75 
77 {
78  read();
79 
80  if (finalNonOrthogonalIter())
81  {
82  corrNonOrth_ = 0;
83 
84  updateFinal();
85 
86  return false;
87  }
88 
89  ++ corrNonOrth_;
90 
91  updateFinal();
92 
93  return true;
94 }
95 
96 
97 // ************************************************************************* //
dictionary dict
Single-region-specific derivation of the solution control class.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
bool correctNonOrthogonal()
Non-orthogonal corrector loop.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
bool read(const char *, int32_t &)
Definition: int32IO.C:85
A class for handling words, derived from string.
Definition: word.H:59
virtual bool read()
Dummy read.
defineTypeNameAndDebug(combustionModel, 0)
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T,.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
nonOrthogonalSolutionControl(fvMesh &mesh, const word &algorithmName)
Construct from a mesh and the name of the algorithm.
Namespace for OpenFOAM.