src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::buoyantPressureFvPatchScalarField
  27
  28 Description
  29     Set the pressure gradient boundary condition appropriately for buoyant flow.
  30
  31     If the variable name is "pd" assume it is p - rho*g.h and set the gradient
  32     appropriately.  Otherwise assume the variable is the static pressure.
  33
  34 SourceFiles
  35     buoyantPressureFvPatchScalarField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef buoyantPressureFvPatchScalarFields_H
  40 #define buoyantPressureFvPatchScalarFields_H
  41
  42 #include "fvPatchFields.H"
  43 #include "fixedGradientFvPatchFields.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                   Class buoyantPressureFvPatch Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class buoyantPressureFvPatchScalarField
  55 :
  56     public fixedGradientFvPatchScalarField
  57 {
  58     // Private data
  59
  60         //- Name of the density field used to calculate the buoyancy force
  61         word rhoName_;
  62
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("buoyantPressure");
  68
  69
  70     // Constructors
  71
  72         //- Construct from patch and internal field
  73         buoyantPressureFvPatchScalarField
  74         (
  75             const fvPatch&,
  76             const DimensionedField<scalar, volMesh>&
  77         );
  78
  79         //- Construct from patch, internal field and dictionary
  80         buoyantPressureFvPatchScalarField
  81         (
  82             const fvPatch&,
  83             const DimensionedField<scalar, volMesh>&,
  84             const dictionary&
  85         );
  86
  87         //- Construct by mapping given
  88         //  buoyantPressureFvPatchScalarField onto a new patch
  89         buoyantPressureFvPatchScalarField
  90         (
  91             const buoyantPressureFvPatchScalarField&,
  92             const fvPatch&,
  93             const DimensionedField<scalar, volMesh>&,
  94             const fvPatchFieldMapper&
  95         );
  96
  97         //- Construct as copy
  98         buoyantPressureFvPatchScalarField
  99         (
 100             const buoyantPressureFvPatchScalarField&
 101         );
 102
 103         //- Construct and return a clone
 104         virtual tmp<fvPatchScalarField> clone() const
 105         {
 106             return tmp<fvPatchScalarField>
 107             (
 108                 new buoyantPressureFvPatchScalarField(*this)
 109             );
 110         }
 111
 112         //- Construct as copy setting internal field reference
 113         buoyantPressureFvPatchScalarField
 114         (
 115             const buoyantPressureFvPatchScalarField&,
 116             const DimensionedField<scalar, volMesh>&
 117         );
 118
 119         //- Construct and return a clone setting internal field reference
 120         virtual tmp<fvPatchScalarField> clone
 121         (
 122             const DimensionedField<scalar, volMesh>& iF
 123         ) const
 124         {
 125             return tmp<fvPatchScalarField>
 126             (
 127                 new buoyantPressureFvPatchScalarField(*this, iF)
 128             );
 129         }
 130
 131
 132     // Member functions
 133
 134         //- Update the coefficients associated with the patch field
 135         virtual void updateCoeffs();
 136
 137         //- Write
 138         virtual void write(Ostream&) const;
 139 };
 140
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 } // End namespace Foam
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 #endif
 149
 150 // ************************************************************************* //