Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / applications / utilities / postProcessing / velocityField / uprime / uprime.C
blob69679cee3f90ca117afb76ad693b7e396318a189
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     uprime
27 Description
28     Calculates and writes the scalar field of uprime (sqrt(2/3 k)).
30     The -noWrite option just outputs the max/min values without writing
31     the field.
33 \*---------------------------------------------------------------------------*/
35 #include "calc.H"
36 #include "fvc.H"
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 void Foam::calc(const argList& args, const Time& runTime, const fvMesh& mesh)
42     bool writeResults = !args.optionFound("noWrite");
44     IOobject kheader
45     (
46         "k",
47         runTime.timeName(),
48         mesh,
49         IOobject::MUST_READ
50     );
52     if (kheader.headerOk())
53     {
54         Info<< "    Reading k" << endl;
55         volScalarField k(kheader, mesh);
57         Info<< "    Calculating uprime" << endl;
58         volScalarField uprime
59         (
60             IOobject
61             (
62                 "uprime",
63                 runTime.timeName(),
64                 mesh,
65                 IOobject::NO_READ
66             ),
67             sqrt((2.0/3.0)*k)
68         );
70         Info<< "uprime max/min : "
71             << max(uprime).value() << " "
72             << min(uprime).value() << endl;
74         if (writeResults)
75         {
76             uprime.write();
77         }
78     }
79     else
80     {
81         Info<< "    No k" << endl;
82     }
84     Info<< "\nEnd\n" << endl;
88 // ************************************************************************* //