src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.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::jumpCyclicFvPatchField
  26
  27 Description
  28     Foam::jumpCyclicFvPatchField
  29
  30 SourceFiles
  31     jumpCyclicFvPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef jumpCyclicFvPatchField_H
  36 #define jumpCyclicFvPatchField_H
  37
  38 #include "cyclicFvPatchField.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class cyclicFvPatch Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class Type>
  50 class jumpCyclicFvPatchField
  51 :
  52     public cyclicFvPatchField<Type>
  53 {
  54
  55 public:
  56
  57     //- Runtime type information
  58     TypeName("jumpCyclic");
  59
  60
  61     // Constructors
  62
  63         //- Construct from patch and internal field
  64         jumpCyclicFvPatchField
  65         (
  66             const fvPatch&,
  67             const DimensionedField<Type, volMesh>&
  68         );
  69
  70         //- Construct from patch, internal field and dictionary
  71         jumpCyclicFvPatchField
  72         (
  73             const fvPatch&,
  74             const DimensionedField<Type, volMesh>&,
  75             const dictionary&
  76         );
  77
  78         //- Construct by mapping given jumpCyclicFvPatchField onto a new patch
  79         jumpCyclicFvPatchField
  80         (
  81             const jumpCyclicFvPatchField<Type>&,
  82             const fvPatch&,
  83             const DimensionedField<Type, volMesh>&,
  84             const fvPatchFieldMapper&
  85         );
  86
  87         //- Construct as copy
  88         jumpCyclicFvPatchField
  89         (
  90             const jumpCyclicFvPatchField<Type>&
  91         );
  92
  93         //- Construct as copy setting internal field reference
  94         jumpCyclicFvPatchField
  95         (
  96             const jumpCyclicFvPatchField<Type>&,
  97             const DimensionedField<Type, volMesh>&
  98         );
  99
 100
 101     // Member functions
 102
 103         // Access
 104
 105             //- Return the interface type
 106             virtual const word& interfaceFieldType() const
 107             {
 108                 return cyclicFvPatchField<Type>::type();
 109             }
 110
 111             //- Return the "jump" across the patch as a "half" field
 112             virtual tmp<Field<scalar> > jump() const = 0;
 113
 114
 115         // Evaluation functions
 116
 117             //- Return neighbour coupled given internal cell data
 118             tmp<Field<Type> > patchNeighbourField() const;
 119
 120             //- Update result field based on interface functionality
 121             virtual void updateInterfaceMatrix
 122             (
 123                 const scalarField& psiInternal,
 124                 scalarField& result,
 125                 const lduMatrix&,
 126                 const scalarField& coeffs,
 127                 const direction cmpt,
 128                 const Pstream::commsTypes commsType
 129             ) const;
 130 };
 131
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 } // End namespace Foam
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 #ifdef NoRepository
 140 #   include "jumpCyclicFvPatchField.C"
 141 #endif
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #endif
 146
 147 // ************************************************************************* //