src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 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::uniformFixedValueFvPatchField
  27
  28 Description
  29     Foam::uniformFixedValueFvPatchField
  30
  31 SourceFiles
  32     uniformFixedValueFvPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef uniformFixedValueFvPatchField_H
  37 #define uniformFixedValueFvPatchField_H
  38
  39 #include "Random.H"
  40 #include "fixedValueFvPatchFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                      Class uniformFixedValueFvPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class uniformFixedValueFvPatchField
  53 :
  54     public fixedValueFvPatchField<Type>
  55 {
  56     // Private data
  57
  58         Type uniformValue_;
  59
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName("uniformFixedValue");
  65
  66
  67     // Constructors
  68
  69         //- Construct from patch and internal field
  70         uniformFixedValueFvPatchField
  71         (
  72             const fvPatch&,
  73             const DimensionedField<Type, volMesh>&
  74         );
  75
  76         //- Construct from patch, internal field and dictionary
  77         uniformFixedValueFvPatchField
  78         (
  79             const fvPatch&,
  80             const DimensionedField<Type, volMesh>&,
  81             const dictionary&
  82         );
  83
  84         //- Construct by mapping given uniformFixedValueFvPatchField
  85         //  onto a new patch
  86         uniformFixedValueFvPatchField
  87         (
  88             const uniformFixedValueFvPatchField<Type>&,
  89             const fvPatch&,
  90             const DimensionedField<Type, volMesh>&,
  91             const fvPatchFieldMapper&
  92         );
  93
  94         //- Construct as copy
  95         uniformFixedValueFvPatchField
  96         (
  97             const uniformFixedValueFvPatchField<Type>&
  98         );
  99
 100         //- Construct and return a clone
 101         virtual tmp<fvPatchField<Type> > clone() const
 102         {
 103             return tmp<fvPatchField<Type> >
 104             (
 105                 new uniformFixedValueFvPatchField<Type>(*this)
 106             );
 107         }
 108
 109         //- Construct as copy setting internal field reference
 110         uniformFixedValueFvPatchField
 111         (
 112             const uniformFixedValueFvPatchField<Type>&,
 113             const DimensionedField<Type, volMesh>&
 114         );
 115
 116         //- Construct and return a clone setting internal field reference
 117         virtual tmp<fvPatchField<Type> > clone
 118         (
 119             const DimensionedField<Type, volMesh>& iF
 120         ) const
 121         {
 122             return tmp<fvPatchField<Type> >
 123             (
 124                 new uniformFixedValueFvPatchField<Type>(*this, iF)
 125             );
 126         }
 127
 128
 129     // Member functions
 130
 131         // Access
 132
 133             //- Return the fluctuation scale
 134             const Type& uniformValue() const
 135             {
 136                 return uniformValue_;
 137             }
 138
 139             //- Return reference to the fluctuation scale to allow adjustment
 140             Type& uniformValue()
 141             {
 142                 return uniformValue_;
 143             }
 144
 145
 146         // Mapping functions
 147
 148             //- Map (and resize as needed) from self given a mapping object
 149             virtual void autoMap
 150             (
 151                 const fvPatchFieldMapper&
 152             );
 153
 154
 155         //- Write
 156         virtual void write(Ostream&) const;
 157 };
 158
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 } // End namespace Foam
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #ifdef NoRepository
 167 #   include "uniformFixedValueFvPatchField.C"
 168 #endif
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 #endif
 173
 174 // ************************************************************************* //