src/finiteVolume/fields/fvsPatchFields/basic/calculated/calculatedFvsPatchField.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::calculatedFvsPatchField
  27
  28 Description
  29     Foam::calculatedFvsPatchField
  30
  31 SourceFiles
  32     calculatedFvsPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef calculatedFvsPatchField_H
  37 #define calculatedFvsPatchField_H
  38
  39 #include "fvsPatchField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                       Class calculatedFvsPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class calculatedFvsPatchField
  52 :
  53     public fvsPatchField<Type>
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("calculated");
  60
  61
  62     // Constructors
  63
  64         //- Construct from patch and internal field
  65         calculatedFvsPatchField
  66         (
  67             const fvPatch&,
  68             const DimensionedField<Type, surfaceMesh>&
  69         );
  70
  71         //- Construct from patch, internal field and dictionary
  72         calculatedFvsPatchField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<Type, surfaceMesh>&,
  76             const dictionary&
  77         );
  78
  79         //- Construct by mapping given patchField<Type> onto a new patch
  80         calculatedFvsPatchField
  81         (
  82             const calculatedFvsPatchField<Type>&,
  83             const fvPatch&,
  84             const DimensionedField<Type, surfaceMesh>&,
  85             const fvPatchFieldMapper&
  86         );
  87
  88         //- Construct as copy
  89         calculatedFvsPatchField
  90         (
  91             const calculatedFvsPatchField<Type>&
  92         );
  93
  94         //- Construct and return a clone
  95         virtual tmp<fvsPatchField<Type> > clone() const
  96         {
  97             return tmp<fvsPatchField<Type> >
  98             (
  99                 new calculatedFvsPatchField<Type>(*this)
 100             );
 101         }
 102
 103         //- Construct as copy setting internal field reference
 104         calculatedFvsPatchField
 105         (
 106             const calculatedFvsPatchField<Type>&,
 107             const DimensionedField<Type, surfaceMesh>&
 108         );
 109
 110         //- Construct and return a clone setting internal field reference
 111         virtual tmp<fvsPatchField<Type> > clone
 112         (
 113             const DimensionedField<Type, surfaceMesh>& iF
 114         ) const
 115         {
 116             return tmp<fvsPatchField<Type> >
 117             (
 118                 new calculatedFvsPatchField<Type>(*this, iF)
 119             );
 120         }
 121
 122
 123     // Member functions
 124
 125         // Access
 126
 127             //- Return true if this patch field fixes a value.
 128             //  Needed to check if a level has to be specified while solving
 129             //  Poissons equations.
 130             virtual bool fixesValue() const
 131             {
 132                 return true;
 133             }
 134
 135
 136         //- Write
 137         virtual void write(Ostream&) const;
 138 };
 139
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 } // End namespace Foam
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 #ifdef NoRepository
 148 #   include "calculatedFvsPatchField.C"
 149 #endif
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 #endif
 154
 155 // ************************************************************************* //