ENH: Added Usage section to all solvers
[freefoam.git] / applications / solvers / multiphase / settlingFoam / settlingFoam.C
blob5f695da9e728f4a6331b5adfb73df9106bce6e4a
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Application
26     settlingFoam
28 Description
29     Solver for 2 incompressible fluids for simulating the settling of the
30     dispersed phase.
32 Usage
33     - settlingFoam [OPTION]
35     @param -case \<dir\> \n
36     Specify the case directory
38     @param -parallel \n
39     Run the case in parallel
41     @param -help \n
42     Display short usage message
44     @param -doc \n
45     Display Doxygen documentation page
47     @param -srcDoc \n
48     Display source code
50 \*---------------------------------------------------------------------------*/
52 #include <finiteVolume/fvCFD.H>
53 #include <finiteVolume/nearWallDist.H>
54 #include <finiteVolume/wallFvPatch.H>
55 #include <finiteVolume/bound.H>
56 #include <OpenFOAM/Switch.H>
57 #include "plasticViscosity.H"
58 #include "yieldStress.H"
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62 int main(int argc, char *argv[])
65 #   include <OpenFOAM/setRootCase.H>
67 #   include <OpenFOAM/createTime.H>
68 #   include <OpenFOAM/createMesh.H>
69 #   include <finiteVolume/readEnvironmentalProperties.H>
70 #   include "createFields.H"
71 #   include <finiteVolume/initContinuityErrs.H>
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76     Info<< "\nStarting time loop\n" << endl;
78     for (runTime++; !runTime.end(); runTime++)
79     {
80         Info<< "Time = " << runTime.timeName() << nl << endl;
82 #       include <finiteVolume/readPISOControls.H>
83 #       include <finiteVolume/compressibleCourantNo.H>
85 #       include <finiteVolume/rhoEqn.H>
87 #       include "calcVdj.H"
89 #       include "UEqn.H"
91 #       include "alphaEqn.H"
93 #       include "correctViscosity.H"
96         // --- PISO loop
97         for (int corr=0; corr<nCorr; corr++)
98         {
99 #           include "pEqn.H"
100         }
102 #       include "kEpsilon.H"
104         runTime.write();
106         Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
107             << "  ClockTime = " << runTime.elapsedClockTime() << " s"
108             << nl << endl;
109     }
111     Info<< "End\n" << endl;
113     return(0);
117 // ************************ vim: set sw=4 sts=4 et: ************************ //