OpenFOAM: API Guide
v2112
The open source CFD toolbox
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
-------------------------------------------------------------------------------
10
License
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
26
Application
27
potentialFreeSurfaceFoam
28
29
Group
30
grpMultiphaseSolvers
31
32
Description
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
"
43
#include "
singlePhaseTransportModel.H
"
44
#include "
turbulentTransportModel.H
"
45
#include "
pimpleControl.H
"
46
#include "
fvOptions.H
"
47
48
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49
50
int
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
// ************************************************************************* //
addCheckCaseOptions.H
Required Classes.
pimple
pimpleControl & pimple
Definition:
setRegionFluidFields.H:56
runTime
engineTime & runTime
Definition:
createEngineTime.H:13
createMesh.H
Required Variables.
createTimeControls.H
Read the control parameters used by setDeltaT.
createTime.H
turbulence
compressible::turbulenceModel & turbulence
Definition:
setRegionFluidFields.H:30
fvCFD.H
fvOptions.H
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition:
Ostream.H:372
Foam::nl
constexpr char nl
The newline '\n' character (0x0a)
Definition:
Ostream.H:53
pimpleControl.H
postProcess.H
Execute application functionObjects to post-process existing results.
readTimeControls.H
Read the control parameters used by setDeltaT.
setRootCaseLists.H
singlePhaseTransportModel.H
laminarTransport
singlePhaseTransportModel laminarTransport(U, phi)
turbulentTransportModel.H
applications
solvers
multiphase
potentialFreeSurfaceFoam
potentialFreeSurfaceFoam.C
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.