src/finiteVolume/fields/fvsPatchFields/basic/calculated/calculatedFvsPatchField.H

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