src/finiteVolume/fields/fvsPatchFields/constraint/processorCyclic/processorCyclicFvsPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2010-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::processorCyclicFvsPatchField
  26
  27 Description
  28     Foam::processorCyclicFvsPatchField
  29
  30 SourceFiles
  31     processorCyclicFvsPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef processorCyclicFvsPatchField_H
  36 #define processorCyclicFvsPatchField_H
  37
  38 #include "coupledFvsPatchField.H"
  39 #include "processorCyclicFvPatch.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                       Class processorCyclicFvsPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class processorCyclicFvsPatchField
  52 :
  53     public coupledFvsPatchField<Type>
  54 {
  55     // Private data
  56
  57         //- Local reference cast into the processor patch
  58         const processorCyclicFvPatch& procPatch_;
  59
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName(processorCyclicFvPatch::typeName_());
  65
  66
  67     // Constructors
  68
  69         //- Construct from patch and internal field
  70         processorCyclicFvsPatchField
  71         (
  72             const fvPatch&,
  73             const DimensionedField<Type, surfaceMesh>&
  74         );
  75
  76         //- Construct from patch and internal field and patch field
  77         processorCyclicFvsPatchField
  78         (
  79             const fvPatch&,
  80             const DimensionedField<Type, surfaceMesh>&,
  81             const Field<Type>&
  82         );
  83
  84         //- Construct from patch, internal field and dictionary
  85         processorCyclicFvsPatchField
  86         (
  87             const fvPatch&,
  88             const DimensionedField<Type, surfaceMesh>&,
  89             const dictionary&
  90         );
  91
  92         //- Construct by mapping given processorCyclicFvsPatchField onto a
  93         //  new patch
  94         processorCyclicFvsPatchField
  95         (
  96             const processorCyclicFvsPatchField<Type>&,
  97             const fvPatch&,
  98             const DimensionedField<Type, surfaceMesh>&,
  99             const fvPatchFieldMapper&
 100         );
 101
 102         //- Construct as copy
 103         processorCyclicFvsPatchField(const processorCyclicFvsPatchField<Type>&);
 104
 105         //- Construct and return a clone
 106         virtual tmp<fvsPatchField<Type> > clone() const
 107         {
 108             return tmp<fvsPatchField<Type> >
 109             (
 110                 new processorCyclicFvsPatchField<Type>(*this)
 111             );
 112         }
 113
 114         //- Construct as copy setting internal field reference
 115         processorCyclicFvsPatchField
 116         (
 117             const processorCyclicFvsPatchField<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 processorCyclicFvsPatchField<Type>(*this, iF)
 130             );
 131         }
 132
 133
 134     // Destructor
 135
 136         ~processorCyclicFvsPatchField();
 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 "processorCyclicFvsPatchField.C"
 166 #endif
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 #endif
 171
 172 // ************************************************************************* //