src/fvMotionSolver/fvPatchFields/derived/cellMotion/cellMotionFvPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::cellMotionFvPatchField
  26
  27 Description
  28     Foam::cellMotionFvPatchField
  29
  30 SourceFiles
  31     cellMotionFvPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef cellMotionFvPatchField_H
  36 #define cellMotionFvPatchField_H
  37
  38 #include "Random.H"
  39 #include "fixedValueFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                      Class cellMotionFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class cellMotionFvPatchField
  52 :
  53     public fixedValueFvPatchField<Type>
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("cellMotion");
  60
  61
  62     // Constructors
  63
  64         //- Construct from patch and internal field
  65         cellMotionFvPatchField
  66         (
  67             const fvPatch&,
  68             const DimensionedField<Type, volMesh>&
  69         );
  70
  71         //- Construct from patch, internal field and dictionary
  72         cellMotionFvPatchField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<Type, volMesh>&,
  76             const dictionary&
  77         );
  78
  79         //- Construct by mapping given cellMotionFvPatchField
  80         //  onto a new patch
  81         cellMotionFvPatchField
  82         (
  83             const cellMotionFvPatchField<Type>&,
  84             const fvPatch&,
  85             const DimensionedField<Type, volMesh>&,
  86             const fvPatchFieldMapper&
  87         );
  88
  89         //- Construct as copy
  90         cellMotionFvPatchField
  91         (
  92             const cellMotionFvPatchField<Type>&
  93         );
  94
  95         //- Construct and return a clone
  96         virtual tmp<fvPatchField<Type> > clone() const
  97         {
  98             return tmp<fvPatchField<Type> >
  99             (
 100                 new cellMotionFvPatchField<Type>(*this)
 101             );
 102         }
 103
 104         //- Construct as copy setting internal field reference
 105         cellMotionFvPatchField
 106         (
 107             const cellMotionFvPatchField<Type>&,
 108             const DimensionedField<Type, volMesh>&
 109         );
 110
 111         //- Construct and return a clone setting internal field reference
 112         virtual tmp<fvPatchField<Type> > clone
 113         (
 114             const DimensionedField<Type, volMesh>& iF
 115         ) const
 116         {
 117             return tmp<fvPatchField<Type> >
 118             (
 119                 new cellMotionFvPatchField<Type>(*this, iF)
 120             );
 121         }
 122
 123
 124     // Member functions
 125
 126         //- Update the coefficients associated with the patch field
 127         virtual void updateCoeffs();
 128
 129         //- Write
 130         virtual void write(Ostream&) const;
 131 };
 132
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 } // End namespace Foam
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 #ifdef NoRepository
 141 #   include "cellMotionFvPatchField.C"
 142 #endif
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 #endif
 147
 148 // ************************************************************************* //