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