src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.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::fixedValueFvPatchField
  27
  28 Description
  29     Foam::fixedValueFvPatchField
  30
  31 SourceFiles
  32     fixedValueFvPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef fixedValueFvPatchField_H
  37 #define fixedValueFvPatchField_H
  38
  39 #include "fvPatchField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class fixedValueFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class fixedValueFvPatchField
  52 :
  53     public fvPatchField<Type>
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("fixedValue");
  60
  61
  62     // Constructors
  63
  64         //- Construct from patch and internal field
  65         fixedValueFvPatchField
  66         (
  67             const fvPatch&,
  68             const DimensionedField<Type, volMesh>&
  69         );
  70
  71         //- Construct from patch, internal field and dictionary
  72         fixedValueFvPatchField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<Type, volMesh>&,
  76             const dictionary&
  77         );
  78
  79         //- Construct by mapping the given fixedValueFvPatchField<Type>
  80         //  onto a new patch
  81         fixedValueFvPatchField
  82         (
  83             const fixedValueFvPatchField<Type>&,
  84             const fvPatch&,
  85             const DimensionedField<Type, volMesh>&,
  86             const fvPatchFieldMapper&
  87         );
  88
  89         //- Construct as copy
  90         fixedValueFvPatchField
  91         (
  92             const fixedValueFvPatchField<Type>&
  93         );
  94
  95         //- Construct and return a clone
  96         virtual tmp<fvPatchField<Type> > clone() const
  97         {
  98             return tmp<fvPatchField<Type> >
  99             (
 100                 new fixedValueFvPatchField<Type>(*this)
 101             );
 102         }
 103
 104         //- Construct as copy setting internal field reference
 105         fixedValueFvPatchField
 106         (
 107             const fixedValueFvPatchField<Type>&,
 108             const DimensionedField<Type, volMesh>&
 109         );
 110
 111         //- Construct and return a clone setting internal field reference
 112         virtual tmp<fvPatchField<Type> > clone
 113         (
 114             const DimensionedField<Type, volMesh>& iF
 115         ) const
 116         {
 117             return tmp<fvPatchField<Type> >
 118             (
 119                 new fixedValueFvPatchField<Type>(*this, iF)
 120             );
 121         }
 122
 123
 124     // Member functions
 125
 126         // Access
 127
 128             //- Return true if this patch field fixes a value.
 129             //  Needed to check if a level has to be specified while solving
 130             //  Poissons equations.
 131             virtual bool fixesValue() const
 132             {
 133                 return true;
 134             }
 135
 136
 137         // Evaluation functions
 138
 139             //- Return the matrix diagonal coefficients corresponding to the
 140             //  evaluation of the value of this patchField with given weights
 141             virtual tmp<Field<Type> > valueInternalCoeffs
 142             (
 143                 const tmp<scalarField>&
 144             ) const;
 145
 146             //- Return the matrix source coefficients corresponding to the
 147             //  evaluation of the value of this patchField with given weights
 148             virtual tmp<Field<Type> > valueBoundaryCoeffs
 149             (
 150                 const tmp<scalarField>&
 151             ) const;
 152
 153             //- Return the matrix diagonal coefficients corresponding to the
 154             //  evaluation of the gradient of this patchField
 155             virtual tmp<Field<Type> > gradientInternalCoeffs() const;
 156
 157             //- Return the matrix source coefficients corresponding to the
 158             //  evaluation of the gradient of this patchField
 159             virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
 160
 161
 162         //- Write
 163         virtual void write(Ostream&) const;
 164
 165
 166     // Member operators
 167
 168         virtual void operator=(const UList<Type>&) {}
 169
 170         virtual void operator=(const fvPatchField<Type>&) {}
 171         virtual void operator+=(const fvPatchField<Type>&) {}
 172         virtual void operator-=(const fvPatchField<Type>&) {}
 173         virtual void operator*=(const fvPatchField<scalar>&) {}
 174         virtual void operator/=(const fvPatchField<scalar>&) {}
 175
 176         virtual void operator+=(const Field<Type>&) {}
 177         virtual void operator-=(const Field<Type>&) {}
 178
 179         virtual void operator*=(const Field<scalar>&) {}
 180         virtual void operator/=(const Field<scalar>&) {}
 181
 182         virtual void operator=(const Type&) {}
 183         virtual void operator+=(const Type&) {}
 184         virtual void operator-=(const Type&) {}
 185         virtual void operator*=(const scalar) {}
 186         virtual void operator/=(const scalar) {}
 187 };
 188
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 } // End namespace Foam
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 #ifdef NoRepository
 197 #   include "fixedValueFvPatchField.C"
 198 #endif
 199
 200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 201
 202 #endif
 203
 204 // ************************************************************************* //