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 | Copyright (C) 2011-2015 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 Application
25  potentialFreeSurfaceFoam
26 
27 Description
28  Incompressible Navier-Stokes solver with inclusion of a wave height field
29  to enable single-phase free-surface approximations
30 
31  Wave height field, zeta, used by pressure boundary conditions
32 
33  Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #include "fvCFD.H"
40 #include "pimpleControl.H"
41 #include "fvIOoptionList.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 int main(int argc, char *argv[])
47 {
48  #include "setRootCase.H"
49 
50  #include "createTime.H"
51  #include "createMesh.H"
52 
53  pimpleControl pimple(mesh);
54 
55  #include "createTimeControls.H"
56  #include "createFields.H"
57  #include "createMRF.H"
58  #include "createFvOptions.H"
59  #include "initContinuityErrs.H"
60 
61  // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62 
63  Info<< "\nStarting time loop\n" << endl;
64 
65  while (runTime.run())
66  {
67  #include "readTimeControls.H"
68  #include "CourantNo.H"
69  #include "setDeltaT.H"
70 
71  runTime++;
72 
73  Info<< "Time = " << runTime.timeName() << nl << endl;
74 
75  // --- Pressure-velocity PIMPLE corrector loop
76  while (pimple.loop())
77  {
78  #include "UEqn.H"
79 
80  // --- Pressure corrector loop
81  while (pimple.correct())
82  {
83  #include "pEqn.H"
84  }
85 
86  if (pimple.turbCorr())
87  {
88  laminarTransport.correct();
89  turbulence->correct();
90  }
91  }
92 
93  runTime.write();
94 
95  Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
96  << " ClockTime = " << runTime.elapsedClockTime() << " s"
97  << nl << endl;
98  }
99 
100  Info<< "End\n" << endl;
101 
102  return 0;
103 }
104 
105 
106 // ************************************************************************* //
singlePhaseTransportModel laminarTransport(U, phi)
messageStream Info
autoPtr< compressible::turbulenceModel > turbulence
Definition: createFields.H:23
dynamicFvMesh & mesh
const dictionary & pimple
static const char nl
Definition: Ostream.H:260
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
Read the control parameters used by setDeltaT.
int main(int argc, char *argv[])
Definition: postCalc.C:54
Read the control parameters used by setDeltaT.