All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
hydrostaticInitialisation.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2021 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 Class
25  Foam::hydrostaticInitialisation
26 
27 Description
28  Optional hydrostatic initialisation of p_rgh and p by solving for and
29  caching the hydrostatic ph_rgh and updating the density such that
30 
31  p = ph_rgh + rho*gh + pRef
32 
33  This initialisation process is applied at the beginning of the run (not on
34  restart) if the \c hydrostaticInitialisation switch is set true in
35  fvSolution/PIMPLE or fvSolution/SIMPLE. The calculation is iterative if the
36  density is a function of pressure and an optional number of iterations \c
37  nHydrostaticCorrectors may be specified which defaults to 5.
38 
39 SourceFiles
40  hydrostaticInitialisation.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef hydrostaticInitialisation_H
45 #define hydrostaticInitialisation_H
46 
47 #include "volFieldsFwd.H"
48 #include "surfaceFieldsFwd.H"
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 namespace Foam
54 {
55  class fluidThermo;
56 
58  (
59  volScalarField& p_rgh,
62  const volVectorField& U,
63  const volScalarField& gh,
64  const surfaceScalarField& ghf,
66  fluidThermo& thermo,
67  const dictionary& dict
68  );
69 }
70 
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 #endif
75 
76 // ************************************************************************* //
U
Definition: pEqn.H:72
Namespace for OpenFOAM.
VolField< vector > volVectorField
Definition: volFieldsFwd.H:65
UniformDimensionedField< scalar > uniformDimensionedScalarField
SurfaceField< scalar > surfaceScalarField
void hydrostaticInitialisation(volScalarField &p_rgh, volScalarField &p, volScalarField &rho, const volVectorField &U, const volScalarField &gh, const surfaceScalarField &ghf, const uniformDimensionedScalarField &pRef, fluidThermo &thermo, const dictionary &dict)
VolField< scalar > volScalarField
Definition: volFieldsFwd.H:64
dictionary dict
volScalarField & p
fluidMulticomponentThermo & thermo
Definition: createFields.H:31