singleRun.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2007-2019 PCOpt/NTUA
9  Copyright (C) 2013-2019 FOSS GP
10  Copyright (C) 2019 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 3 of the License, or
18  (at your option) any later version.
19 
20  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23  for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27 
28 \*---------------------------------------------------------------------------*/
29 
30 #include "singleRun.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(singleRun, 0);
38  addToRunTimeSelectionTable(optimisationManager, singleRun, dictionary);
39 }
40 
41 
42 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43 
44 Foam::singleRun::singleRun(fvMesh& mesh)
45 :
47  cycles_(Zero)
48 {}
49 
50 
51 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
52 
54 {
55  cycles_++;
56  return *this;
57 }
58 
59 
61 {
62  return operator++();
63 }
64 
65 
67 {
68  return end();
69 }
70 
71 
73 {
74  // Force execution of a single loop
75  return cycles_ > 1;
76 }
77 
78 
80 {
81  // No update in singleRun cases
82  return false;
83 }
84 
85 
87 {
88  // No update in singleRun cases
89 }
90 
91 
92 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::singleRun::end
virtual bool end()
Return true if end of optimisation run.
Definition: singleRun.C:72
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
singleRun.H
Foam::singleRun::updateDesignVariables
virtual void updateDesignVariables()
Update design variables.
Definition: singleRun.C:86
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
stdFoam::end
constexpr auto end(C &c) -> decltype(c.end())
Return iterator to the end of the container c.
Definition: stdFoam.H:121
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::singleRun::checkEndOfLoopAndUpdate
virtual bool checkEndOfLoopAndUpdate()
Return true if end of optimisation run.
Definition: singleRun.C:66
Foam::singleRun::update
virtual bool update()
Whether to update the design variables.
Definition: singleRun.C:79
Foam::optimisationManager
Abstract base class for optimisation methods.
Definition: optimisationManager.H:57
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::singleRun::operator++
virtual optimisationManager & operator++()
Prefix increment.
Definition: singleRun.C:53