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-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 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
33 }
34 
35 
36 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
37 
39 {
41  {
42  return false;
43  }
44 
45  const dictionary& solutionDict = dict();
46 
48  solutionDict.lookupOrDefault<label>("nNonOrthogonalCorrectors", 0);
49 
50  return true;
51 }
52 
53 
54 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
55 
57 (
58  fvMesh& mesh,
59  const word& algorithmName
60 )
61 :
62  singleRegionSolutionControl(mesh, algorithmName),
63  nCorrNonOrth_(-1),
64  corrNonOrth_(0)
65 {
66  read();
67 }
68 
69 
70 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
71 
73 {}
74 
75 
76 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
77 
78 bool Foam::nonOrthogonalSolutionControl::isFinal(const bool finalIter) const
79 {
80  return finalIter && (finalNonOrthogonalIter() || !anyNonOrthogonalIter());
81 }
82 
83 
85 (
86  const bool finalIter
87 )
88 {
89  if (finalNonOrthogonalIter())
90  {
91  corrNonOrth_ = 0;
92 
93  updateFinal(isFinal(finalIter));
94 
95  return false;
96  }
97 
98  corrNonOrth_++;
99 
100  updateFinal(isFinal(finalIter));
101 
102  return true;
103 }
104 
105 
106 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T, if not found return the given default.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Non-orthogonal solution control class. Provides non-orthogonal-loop control methods.
bool correctNonOrthogonal(const bool finalIter=false)
Non-orthogonal corrector loop.
bool isFinal(const bool finalIter) const
Flag to indicate whether in final state.
nonOrthogonalSolutionControl(fvMesh &mesh, const word &algorithmName)
Construct from a mesh and the name of the algorithm.
label nCorrNonOrth_
Maximum number of non-orthogonal correctors.
Single-region-specific derivation of the solution control class.
virtual const dictionary & dict() const
Return the solution dictionary.
virtual bool read()=0
Read controls.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
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
defineTypeNameAndDebug(combustionModel, 0)