src/transportModels/interfaceProperties/alphaFixedPressure/alphaFixedPressureFvPatchScalarField.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::alphaFixedPressureFvPatchScalarField
  27
  28 Description
  29     A fixed-pressure alphaContactAngle boundary
  30
  31 SourceFiles
  32     alphaFixedPressureFvPatchScalarField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef alphaFixedPressureFvPatchScalarField_H
  37 #define alphaFixedPressureFvPatchScalarField_H
  38
  39 #include "fixedValueFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                  Class alphaFixedPressureFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class alphaFixedPressureFvPatchScalarField
  51 :
  52     public fixedValueFvPatchScalarField
  53 {
  54     // Private data
  55
  56         //- Fixed pressure
  57         scalarField p_;
  58
  59
  60 public:
  61
  62     //- Runtime type information
  63     TypeName("alphaFixedPressure");
  64
  65
  66     // Constructors
  67
  68         //- Construct from patch and internal field
  69         alphaFixedPressureFvPatchScalarField
  70         (
  71             const fvPatch&,
  72             const DimensionedField<scalar, volMesh>&
  73         );
  74
  75         //- Construct from patch, internal field and dictionary
  76         alphaFixedPressureFvPatchScalarField
  77         (
  78             const fvPatch&,
  79             const DimensionedField<scalar, volMesh>&,
  80             const dictionary&
  81         );
  82
  83         //- Construct by mapping given alphaFixedPressureFvPatchScalarField
  84         //  onto a new patch
  85         alphaFixedPressureFvPatchScalarField
  86         (
  87             const alphaFixedPressureFvPatchScalarField&,
  88             const fvPatch&,
  89             const DimensionedField<scalar, volMesh>&,
  90             const fvPatchFieldMapper&
  91         );
  92
  93         //- Construct as copy
  94         alphaFixedPressureFvPatchScalarField
  95         (
  96             const alphaFixedPressureFvPatchScalarField&
  97         );
  98
  99         //- Construct and return a clone
 100         virtual tmp<fvPatchScalarField> clone() const
 101         {
 102             return tmp<fvPatchScalarField>
 103             (
 104                 new alphaFixedPressureFvPatchScalarField(*this)
 105             );
 106         }
 107
 108         //- Construct as copy setting internal field reference
 109         alphaFixedPressureFvPatchScalarField
 110         (
 111             const alphaFixedPressureFvPatchScalarField&,
 112             const DimensionedField<scalar, volMesh>&
 113         );
 114
 115         //- Construct and return a clone setting internal field reference
 116         virtual tmp<fvPatchScalarField> clone
 117         (
 118             const DimensionedField<scalar, volMesh>& iF
 119         ) const
 120         {
 121             return tmp<fvPatchScalarField>
 122             (
 123                 new alphaFixedPressureFvPatchScalarField(*this, iF)
 124             );
 125         }
 126
 127
 128     // Member functions
 129
 130         // Access
 131
 132             //- Return the alphaFixed pressure
 133             const scalarField& p() const
 134             {
 135                 return p_;
 136             }
 137
 138             //- Return reference to the alphaFixed pressure to allow adjustment
 139             scalarField& p()
 140             {
 141                 return p_;
 142             }
 143
 144
 145         // Mapping functions
 146
 147             //- Map (and resize as needed) from self given a mapping object
 148             virtual void autoMap
 149             (
 150                 const fvPatchFieldMapper&
 151             );
 152
 153             //- Reverse map the given fvPatchField onto this fvPatchField
 154             virtual void rmap
 155             (
 156                 const fvPatchScalarField&,
 157                 const labelList&
 158             );
 159
 160
 161         // Evaluation functions
 162
 163             //- Update the coefficients associated with the patch field
 164             virtual void updateCoeffs();
 165
 166
 167         //- Write
 168         virtual void write(Ostream&) const;
 169 };
 170
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 } // End namespace Foam
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 #endif
 179
 180 // ************************************************************************* //