Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / applications / utilities / postProcessing / foamCalc / foamCalc.C
blob66ded07b88b5cda475d849dc4fea76f2f4627e7f
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Application
25     foamCalc
27 Description
28     Generic wrapper for calculating a quantity at each time. Split into four
29     phases:
30         1. Intialise
31         2. Pre-time calculation loop
32         3. Calculation loop
33         4. Post-calculation loop
35 \*---------------------------------------------------------------------------*/
37 #include "timeSelector.H"
38 #include "calcType.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 int main(int argc, char *argv[])
44     Foam::timeSelector::addOptions();
45     Foam::argList::validOptions.insert("noWrite", "");
46     Foam::argList::validOptions.insert("dict", "dictionary name");
48     if (argc < 2)
49     {
50         FatalError
51             << "No utility has been supplied" << nl
52             << exit(FatalError);
53     }
55     word utilityName = argv[1];
57     Foam::autoPtr<Foam::calcType> utility
58     (
59         calcType::New(utilityName)
60     );
62     utility().tryInit();
64 #   include "setRootCase.H"
65 #   include "createTime.H"
66     Foam::instantList timeDirs = Foam::timeSelector::select0(runTime, args);
67 #   include "createMesh.H"
69     utility().tryPreCalc(args, runTime, mesh);
71     forAll(timeDirs, timeI)
72     {
73         runTime.setTime(timeDirs[timeI], timeI);
75         Foam::Info<< "Time = " << runTime.timeName() << Foam::endl;
77         mesh.readUpdate();
79         utility().tryCalc(args, runTime, mesh);
81         Foam::Info<< Foam::endl;
82     }
84     utility().tryPostCalc(args, runTime, mesh);
86     Info<< "End\n" << endl;
88     return 0;
92 // ************************************************************************* //