potentialFreeSurfaceFoam.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) 2011-2017 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Application
27 potentialFreeSurfaceFoam
28
29Group
30 grpMultiphaseSolvers
31
32Description
33 Incompressible Navier-Stokes solver with inclusion of a wave height field
34 to enable single-phase free-surface approximations
35
36 Wave height field, zeta, used by pressure boundary conditions
37
38 Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
39
40\*---------------------------------------------------------------------------*/
41
42#include "fvCFD.H"
45#include "pimpleControl.H"
46#include "fvOptions.H"
47
48// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49
50int main(int argc, char *argv[])
51{
52 argList::addNote
53 (
54 "Incompressible Navier-Stokes solver with inclusion of a wave height"
55 " field to enable single-phase free-surface approximations."
56 );
57
58 #include "postProcess.H"
59
60 #include "addCheckCaseOptions.H"
61 #include "setRootCaseLists.H"
62 #include "createTime.H"
63 #include "createMesh.H"
64 #include "createControl.H"
65 #include "createTimeControls.H"
66 #include "createFields.H"
67 #include "initContinuityErrs.H"
68
69 turbulence->validate();
70
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72
73 Info<< "\nStarting time loop\n" << endl;
74
75 while (runTime.run())
76 {
77 #include "readTimeControls.H"
78 #include "CourantNo.H"
79 #include "setDeltaT.H"
80
81 ++runTime;
82
83 Info<< "Time = " << runTime.timeName() << nl << endl;
84
85 // --- Pressure-velocity PIMPLE corrector loop
86 while (pimple.loop())
87 {
88 #include "UEqn.H"
89
90 // --- Pressure corrector loop
91 while (pimple.correct())
92 {
93 #include "pEqn.H"
94 }
95
96 if (pimple.turbCorr())
97 {
98 laminarTransport.correct();
99 turbulence->correct();
100 }
101 }
102
103 runTime.write();
104
105 runTime.printExecutionTime(Info);
106 }
107
108 Info<< "End\n" << endl;
109
110 return 0;
111}
112
113
114// ************************************************************************* //
Required Classes.
pimpleControl & pimple
engineTime & runTime
Required Variables.
Read the control parameters used by setDeltaT.
compressible::turbulenceModel & turbulence
messageStream Info
Information stream (stdout output on master, null elsewhere)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
Execute application functionObjects to post-process existing results.
Read the control parameters used by setDeltaT.
singlePhaseTransportModel laminarTransport(U, phi)