All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
solidNoLoopControl.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 
26 #include "solidNoLoopControl.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(solidNoLoopControl, 0);
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 (
40  fvMesh& mesh,
41  const word& algorithmName,
42  const pimpleLoop& loop
43 )
44 :
45  nonOrthogonalSolutionControl(mesh, algorithmName),
47  (
48  static_cast<singleRegionSolutionControl&>(*this)
49  ),
51  (
52  static_cast<singleRegionSolutionControl&>(*this),
53  "outerCorrector"
54  ),
55  loop_(loop)
56 {
57  read();
58 }
59 
60 
61 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
62 
64 {}
65 
66 
67 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
68 
70 {
71  return
73  && readResidualControls()
74  && readCorrResidualControls();
75 }
76 
77 
79 {
80  return loop_.finalPimpleIter() && finalNonOrthogonalIter();
81 }
82 
83 
84 // ************************************************************************* //
Pimple loop class. Implements the logic which controls the pimple loop generically for a given correc...
Definition: pimpleLoop.H:51
bool read(const char *, int32_t &)
Definition: int32IO.C:85
A class for handling words, derived from string.
Definition: word.H:59
defineTypeNameAndDebug(combustionModel, 0)
virtual bool read()
Read controls.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Single-region-specific derivation of the convergence control class.
virtual bool isFinal() const
Flag to indicate whether in final state.
solidNoLoopControl(fvMesh &mesh, const word &algorithmName, const pimpleLoop &loop)
Construct from a mesh, the name of the algorithm, and a reference.
virtual ~solidNoLoopControl()
Destructor.
Single-region-specific derivation of the corrector convergence control class.
Non-orthogonal solution control class. Provides non-orthogonal-loop control methods.
Namespace for OpenFOAM.