initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / applications / utilities / postProcessing / foamCalc / foamCalc.C
blob9eb313fd364f0f834bcaceed6f9d26b2ebad722b
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     foamCalc
28 Description
29     Generic wrapper for calculating a quantity at each time. Split into four
30     phases:
31         1. Intialise
32         2. Pre-time calculation loop
33         3. Calculation loop
34         4. Post-calculation loop
36 \*---------------------------------------------------------------------------*/
38 #include "timeSelector.H"
39 #include "calcType.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 int main(int argc, char *argv[])
45     Foam::timeSelector::addOptions();
46     Foam::argList::validOptions.insert("noWrite", "");
47     Foam::argList::validOptions.insert("dict", "dictionary name");
49     if (argc < 2)
50     {
51         FatalError
52             << "No utility has been supplied" << nl
53             << exit(FatalError);
54     }
56     word utilityName = argv[1];
58     Foam::autoPtr<Foam::calcType> utility
59     (
60         calcType::New(utilityName)
61     );
63     utility().tryInit();
65 #   include "setRootCase.H"
66 #   include "createTime.H"
67     Foam::instantList timeDirs = Foam::timeSelector::select0(runTime, args);
68 #   include "createMesh.H"
70     utility().tryPreCalc(args, runTime, mesh);
72     forAll(timeDirs, timeI)
73     {
74         runTime.setTime(timeDirs[timeI], timeI);
76         Foam::Info<< "Time = " << runTime.timeName() << Foam::endl;
78         mesh.readUpdate();
80         utility().tryCalc(args, runTime, mesh);
82         Foam::Info<< Foam::endl;
83     }
85     utility().tryPostCalc(args, runTime, mesh);
87     return 0;
91 // ************************************************************************* //