solutionControlI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 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 
26 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
29 {
31 }
32 
33 
35 {
36  return corr_;
37 }
38 
39 
41 {
42  return corrNonOrtho_;
43 }
44 
45 
47 {
48  return nNonOrthCorr_;
49 }
50 
51 
53 {
54  return corrNonOrtho_ == nNonOrthCorr_ + 1;
55 }
56 
57 
59 {
60  return momentumPredictor_;
61 }
62 
63 
65 {
66  return transonic_;
67 }
68 
69 
71 {
72  return consistent_;
73 }
74 
75 
77 {
78  corrNonOrtho_++;
79 
80  if (debug)
81  {
82  Info<< algorithmName_ << " correctNonOrthogonal: corrNonOrtho = "
83  << corrNonOrtho_ << endl;
84  }
85 
86  if (corrNonOrtho_ <= nNonOrthCorr_ + 1)
87  {
88  return true;
89  }
90  else
91  {
92  corrNonOrtho_ = 0;
93  return false;
94  }
95 }
96 
97 
98 // ************************************************************************* //
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 consistent() const
Flag to indicate to relax pressure using the.
fvMesh & mesh_
Reference to the mesh database.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
label nNonOrthCorr_
Maximum number of non-orthogonal correctors.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:253
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:692
const dictionary & dict() const
Return the solution dictionary.
bool correctNonOrthogonal()
Non-orthogonal corrector loop.
const dictionary & solutionDict() const
Return the selected sub-dictionary of solvers if the "select".
Definition: solution.C:329
bool transonic_
Flag to indicate to solve using transonic algorithm.
const word algorithmName_
The dictionary name, e.g. SIMPLE, PIMPLE.
bool momentumPredictor() const
Flag to indicate to solve for momentum.
bool finalNonOrthogonalIter() const
Helper function to identify final non-orthogonal iteration.
label nNonOrthCorr() const
Maximum number of non-orthogonal correctors.
label corr_
Current corrector loop index.
label corr() const
Current corrector loop index.
label corrNonOrtho_
Current non-orthogonal corrector loop index.
bool momentumPredictor_
Flag to indicate to solve for momentum.
messageStream Info
bool transonic() const
Flag to indicate to solve using transonic algorithm.
label corrNonOrtho() const
Current non-orthogonal corrector index.
bool consistent_
Flag to indicate to relax pressure using the.