src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H

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