solidNoLoopControl.H
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-2020 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 Class
25  Foam::solidNoLoopControl
26 
27 Description
28  Solid no-loop control class. Implements non-orthogonal and convergence
29  controls, but leaves loop controls to the derivation or owner. Can be
30  derived into a "full" solid control or can be owned by a multi-region class.
31 
32 SourceFiles
33  solidNoLoopControl.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef solidNoLoopControl_H
38 #define solidNoLoopControl_H
39 
41 #include "pimpleLoop.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class solidNoLoopControl Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
59 {
60 protected:
61 
62  // Protected data
63 
64  //- The pimple loop
65  const pimpleLoop& loop_;
66 
67 
68 public:
69 
70  // Static Data Members
71 
72  //- Run-time type information
73  TypeName("solidNoLoopControl");
74 
75 
76  // Constructors
77 
78  //- Construct from a mesh, the name of the algorithm, and a reference
79  // to the pimple loop
81  (
82  fvMesh& mesh,
83  const word& algorithmName,
84  const pimpleLoop& loop
85  );
86 
87 
88  //- Destructor
89  virtual ~solidNoLoopControl();
90 
91 
92  // Member Functions
93 
94  // IO
95 
96  //- Read controls
97  virtual bool read();
98 
99  // Access
100 
101  //- Flag to indicate whether in final state
102  virtual bool isFinal() const;
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
Solid no-loop control class. Implements non-orthogonal and convergence controls, but leaves loop cont...
const pimpleLoop & loop_
The pimple loop.
Pimple loop class. Implements the logic which controls the pimple loop generically for a given correc...
Definition: pimpleLoop.H:51
A class for handling words, derived from string.
Definition: word.H:59
const fvMesh & mesh() const
Return the mesh.
TypeName("solidNoLoopControl")
Run-time type information.
virtual bool read()
Read controls.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
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.
const word & algorithmName() const
Return the name of the algorithm.
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.