src/finiteVolume/fields/fvsPatchFields/basic/coupled/coupledFvsPatchField.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::coupledFvsPatchField
  27
  28 Description
  29     Foam::coupledFvsPatchField
  30
  31 SourceFiles
  32     coupledFvsPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef coupledFvsPatchField_H
  37 #define coupledFvsPatchField_H
  38
  39 #include "fvsPatchField.H"
  40 #include "coupledFvPatch.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class coupledFvsPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class coupledFvsPatchField
  53 :
  54     public fvsPatchField<Type>
  55 {
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName(coupledFvPatch::typeName_());
  61
  62
  63     // Constructors
  64
  65         //- Construct from patch and internal field
  66         coupledFvsPatchField
  67         (
  68             const fvPatch&,
  69             const DimensionedField<Type, surfaceMesh>&
  70         );
  71
  72         //- Construct from patch and internal field and patch field
  73         coupledFvsPatchField
  74         (
  75             const fvPatch&,
  76             const DimensionedField<Type, surfaceMesh>&,
  77             const Field<Type>&
  78         );
  79
  80         //- Construct from patch, internal field and dictionary
  81         coupledFvsPatchField
  82         (
  83             const fvPatch&,
  84             const DimensionedField<Type, surfaceMesh>&,
  85             const dictionary&,
  86             const bool valueRequired = false
  87         );
  88
  89         //- Construct by mapping the given coupledFvsPatchField onto a new patch
  90         coupledFvsPatchField
  91         (
  92             const coupledFvsPatchField<Type>&,
  93             const fvPatch&,
  94             const DimensionedField<Type, surfaceMesh>&,
  95             const fvPatchFieldMapper&
  96         );
  97
  98         //- Construct as copy
  99         coupledFvsPatchField
 100         (
 101             const coupledFvsPatchField<Type>&
 102         );
 103
 104         //- Construct and return a clone
 105         virtual tmp<fvsPatchField<Type> > clone() const = 0;
 106
 107         //- Construct as copy setting internal field reference
 108         coupledFvsPatchField
 109         (
 110             const coupledFvsPatchField<Type>&,
 111             const DimensionedField<Type, surfaceMesh>&
 112         );
 113
 114         //- Construct and return a clone
 115         virtual tmp<fvsPatchField<Type> > clone
 116         (
 117             const DimensionedField<Type, surfaceMesh>&
 118         ) const = 0;
 119
 120
 121     // Member functions
 122
 123         // Access
 124
 125             //- Return true if this patch field is derived from
 126             //  coupledFvsPatchField<Type>.
 127             virtual bool coupled() const
 128             {
 129                 return true;
 130             }
 131
 132
 133         //- Write
 134         virtual void write(Ostream&) const;
 135 };
 136
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 } // End namespace Foam
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 #ifdef NoRepository
 145 #   include "coupledFvsPatchField.C"
 146 #endif
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 #endif
 151
 152 // ************************************************************************* //