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