src/OpenFOAM/fields/pointPatchFields/basic/mixed/mixedPointPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::mixedPointPatchField
  27
  28 Description
  29     A mixed FixedValue / ZeroGradient boundary condition for pointField.
  30
  31     I am still not sure how to do the FixedValue-fixedGradient combination.
  32
  33 SourceFiles
  34     mixedPointPatchField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef mixedPointPatchField_H
  39 #define mixedPointPatchField_H
  40
  41 #include "valuePointPatchField.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                       Class mixedPointPatchField Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template<class Type>
  53 class mixedPointPatchField
  54 :
  55     public valuePointPatchField<Type>
  56 {
  57     // Private data
  58
  59         //- Value field
  60         Field<Type> refValue_;
  61
  62         //- Fraction (0-1) of value used for boundary condition
  63         scalarField valueFraction_;
  64
  65
  66     // Private member functions
  67
  68         void checkFieldSize() const;
  69
  70
  71 public:
  72
  73     //- Runtime type information
  74     TypeName("mixed");
  75
  76
  77     // Constructors
  78
  79         //- Construct from patch and internal field
  80         mixedPointPatchField
  81         (
  82             const pointPatch&,
  83             const DimensionedField<Type, pointMesh>&
  84         );
  85
  86         //- Construct from patch, internal field and dictionary
  87         mixedPointPatchField
  88         (
  89             const pointPatch&,
  90             const DimensionedField<Type, pointMesh>&,
  91             const dictionary&
  92         );
  93
  94         //- Construct by mapping given patchField<Type> onto a new patch
  95         mixedPointPatchField
  96         (
  97             const mixedPointPatchField<Type>&,
  98             const pointPatch&,
  99             const DimensionedField<Type, pointMesh>&,
 100             const pointPatchFieldMapper&
 101         );
 102
 103         //- Construct and return a clone
 104         virtual autoPtr<pointPatchField<Type> > clone() const
 105         {
 106             return autoPtr<pointPatchField<Type> >
 107             (
 108                 new mixedPointPatchField<Type>
 109                 (
 110                     *this
 111                 )
 112             );
 113         }
 114
 115         //- Construct as copy setting internal field reference
 116         mixedPointPatchField
 117         (
 118             const mixedPointPatchField<Type>&,
 119             const DimensionedField<Type, pointMesh>&
 120         );
 121
 122         //- Construct and return a clone setting internal field reference
 123         virtual autoPtr<pointPatchField<Type> > clone
 124         (
 125             const DimensionedField<Type, pointMesh>& iF
 126         ) const
 127         {
 128             return autoPtr<pointPatchField<Type> >
 129             (
 130                 new mixedPointPatchField<Type>
 131                 (
 132                     *this,
 133                     iF
 134                 )
 135             );
 136         }
 137
 138
 139     // Member functions
 140
 141         // Return defining fields
 142
 143             virtual Field<Type>& refValue()
 144             {
 145                 return refValue_;
 146             }
 147
 148             virtual const Field<Type>& refValue() const
 149             {
 150                 return refValue_;
 151             }
 152
 153             virtual scalarField& valueFraction()
 154             {
 155                 return valueFraction_;
 156             }
 157
 158             virtual const scalarField& valueFraction() const
 159             {
 160                 return valueFraction_;
 161             }
 162
 163
 164         // Mapping functions
 165
 166             //- Map (and resize as needed) from self given a mapping object
 167             virtual void autoMap
 168             (
 169                 const pointPatchFieldMapper&
 170             );
 171
 172             //- Reverse map the given PointPatchField onto
 173             //  this PointPatchField
 174             virtual void rmap
 175             (
 176                 const pointPatchField<Type>&,
 177                 const labelList&
 178             );
 179
 180
 181         // Evaluation functions
 182
 183             //- Update the patch field
 184             virtual void evaluate
 185             (
 186                 const Pstream::commsTypes commsType=Pstream::blocking
 187             );
 188
 189
 190         //- Write
 191         virtual void write(Ostream&) const;
 192 };
 193
 194
 195 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 196
 197 } // End namespace Foam
 198
 199 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 200
 201 #ifdef NoRepository
 202 #    include "mixedPointPatchField.C"
 203 #endif
 204
 205 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 206
 207 #endif
 208
 209 // ************************************************************************* //