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 (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::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         );
  87
  88         //- Construct by mapping the given coupledFvsPatchField onto a new patch
  89         coupledFvsPatchField
  90         (
  91             const coupledFvsPatchField<Type>&,
  92             const fvPatch&,
  93             const DimensionedField<Type, surfaceMesh>&,
  94             const fvPatchFieldMapper&
  95         );
  96
  97         //- Construct as copy
  98         coupledFvsPatchField
  99         (
 100             const coupledFvsPatchField<Type>&
 101         );
 102
 103         //- Construct and return a clone
 104         virtual tmp<fvsPatchField<Type> > clone() const = 0;
 105
 106         //- Construct as copy setting internal field reference
 107         coupledFvsPatchField
 108         (
 109             const coupledFvsPatchField<Type>&,
 110             const DimensionedField<Type, surfaceMesh>&
 111         );
 112
 113         //- Construct and return a clone
 114         virtual tmp<fvsPatchField<Type> > clone
 115         (
 116             const DimensionedField<Type, surfaceMesh>&
 117         ) const = 0;
 118
 119
 120     // Member functions
 121
 122         // Access
 123
 124             //- Return true if this patch field is derived from
 125             //  coupledFvsPatchField<Type>.
 126             virtual bool coupled() const
 127             {
 128                 return true;
 129             }
 130
 131
 132         //- Write
 133         virtual void write(Ostream&) const;
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #ifdef NoRepository
 144 #   include "coupledFvsPatchField.C"
 145 #endif
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 #endif
 150
 151 // ************************************************************************* //