src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
   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::emptyFvPatchField
  26
  27 Description
  28     Foam::emptyFvPatchField
  29
  30 SourceFiles
  31     emptyFvPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef emptyFvPatchField_H
  36 #define emptyFvPatchField_H
  37
  38 #include "fvPatchField.H"
  39 #include "emptyFvPatch.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                          Class emptyFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class emptyFvPatchField
  52 :
  53     public fvPatchField<Type>
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName(emptyFvPatch::typeName_());
  60
  61
  62     // Constructors
  63
  64         //- Construct from patch and internal field
  65         emptyFvPatchField
  66         (
  67             const fvPatch&,
  68             const DimensionedField<Type, volMesh>&
  69         );
  70
  71         //- Construct from patch, internal field and dictionary
  72         emptyFvPatchField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<Type, volMesh>&,
  76             const dictionary&
  77         );
  78
  79         //- Construct by mapping given emptyFvPatchField onto a new patch
  80         emptyFvPatchField
  81         (
  82             const emptyFvPatchField<Type>&,
  83             const fvPatch&,
  84             const DimensionedField<Type, volMesh>&,
  85             const fvPatchFieldMapper&
  86         );
  87
  88         //- Construct as copy
  89         emptyFvPatchField
  90         (
  91             const emptyFvPatchField<Type>&
  92         );
  93
  94         //- Construct and return a clone
  95         virtual tmp<fvPatchField<Type> > clone() const
  96         {
  97             return tmp<fvPatchField<Type> >
  98             (
  99                 new emptyFvPatchField<Type>(*this)
 100             );
 101         }
 102
 103         //- Construct as copy setting internal field reference
 104         emptyFvPatchField
 105         (
 106             const emptyFvPatchField<Type>&,
 107             const DimensionedField<Type, volMesh>&
 108         );
 109
 110         //- Construct and return a clone setting internal field reference
 111         virtual tmp<fvPatchField<Type> > clone
 112         (
 113             const DimensionedField<Type, volMesh>& iF
 114         ) const
 115         {
 116             return tmp<fvPatchField<Type> >
 117             (
 118                 new emptyFvPatchField<Type>(*this, iF)
 119             );
 120         }
 121
 122
 123     // Member functions
 124
 125         // Mapping functions
 126
 127             //- Map (and resize as needed) from self given a mapping object
 128             virtual void autoMap
 129             (
 130                 const fvPatchFieldMapper&
 131             )
 132             {}
 133
 134             //- Reverse map the given fvPatchField onto this fvPatchField
 135             virtual void rmap
 136             (
 137                 const fvPatchField<Type>&,
 138                 const labelList&
 139             )
 140             {}
 141
 142
 143         // Evaluation functions
 144
 145             //- Update the coefficients associated with the patch field
 146             //  This only checks to see the case is actually 1D or 2D
 147             //  for which this boundary condition is valid
 148             void updateCoeffs();
 149
 150
 151             //- Return the matrix diagonal coefficients corresponding to the
 152             //  evaluation of the value of this patchField with given weights
 153             virtual tmp<Field<Type> > valueInternalCoeffs
 154             (
 155                 const tmp<scalarField>&
 156             ) const
 157             {
 158                 return tmp<Field<Type> >(new Field<Type>(0));
 159             }
 160
 161             //- Return the matrix source coefficients corresponding to the
 162             //  evaluation of the value of this patchField with given weights
 163             virtual tmp<Field<Type> > valueBoundaryCoeffs
 164             (
 165                 const tmp<scalarField>&
 166             ) const
 167             {
 168                 return tmp<Field<Type> >(new Field<Type>(0));
 169             }
 170
 171             //- Return the matrix diagonal coefficients corresponding to the
 172             //  evaluation of the gradient of this patchField
 173             tmp<Field<Type> > gradientInternalCoeffs() const
 174             {
 175                 return tmp<Field<Type> >(new Field<Type>(0));
 176             }
 177
 178             //- Return the matrix source coefficients corresponding to the
 179             //  evaluation of the gradient of this patchField
 180             tmp<Field<Type> > gradientBoundaryCoeffs() const
 181             {
 182                 return tmp<Field<Type> >(new Field<Type>(0));
 183             }
 184 };
 185
 186
 187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 188
 189 } // End namespace Foam
 190
 191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 192
 193 #ifdef NoRepository
 194 #   include "emptyFvPatchField.C"
 195 #endif
 196
 197 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 198
 199 #endif
 200
 201 // ************************************************************************* //