src/finiteVolume/fields/fvPatchFields/derived/directMappedVelocityFluxFixedValue/directMappedVelocityFluxFixedValueFvPatchField.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::directMappedVelocityFluxFixedValueFvPatchField
  27
  28 Description
  29     Recycles the velocity and flux at a patch to this patch
  30
  31 SourceFiles
  32     directMappedVelocityFluxFixedValueFvPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef directMappedVelocityFluxFixedValueFvPatchField_H
  37 #define directMappedVelocityFluxFixedValueFvPatchField_H
  38
  39 #include "fixedValueFvPatchFields.H"
  40 #include "directMappedFvPatch.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48           Class directMappedVelocityFluxFixedValueFvPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class directMappedVelocityFluxFixedValueFvPatchField
  52 :
  53     public fixedValueFvPatchVectorField
  54 {
  55     // Private data
  56
  57         //- Name of flux field
  58         word phiName_;
  59
  60 public:
  61
  62     //- Runtime type information
  63     TypeName("directMappedVelocityFlux");
  64
  65
  66     // Constructors
  67
  68         //- Construct from patch and internal field
  69         directMappedVelocityFluxFixedValueFvPatchField
  70         (
  71             const fvPatch&,
  72             const DimensionedField<vector, volMesh>&
  73         );
  74
  75         //- Construct from patch, internal field and dictionary
  76         directMappedVelocityFluxFixedValueFvPatchField
  77         (
  78             const fvPatch&,
  79             const DimensionedField<vector, volMesh>&,
  80             const dictionary&
  81         );
  82
  83         //- Construct by mapping given
  84         //  directMappedVelocityFluxFixedValueFvPatchField
  85         //  onto a new patch
  86         directMappedVelocityFluxFixedValueFvPatchField
  87         (
  88             const directMappedVelocityFluxFixedValueFvPatchField&,
  89             const fvPatch&,
  90             const DimensionedField<vector, volMesh>&,
  91             const fvPatchFieldMapper&
  92         );
  93
  94         //- Construct as copy
  95         directMappedVelocityFluxFixedValueFvPatchField
  96         (
  97             const directMappedVelocityFluxFixedValueFvPatchField&
  98         );
  99
 100         //- Construct and return a clone
 101         virtual tmp<fvPatchVectorField> clone() const
 102         {
 103             return tmp<fvPatchVectorField>
 104             (
 105                 new directMappedVelocityFluxFixedValueFvPatchField(*this)
 106             );
 107         }
 108
 109         //- Construct as copy setting internal field reference
 110         directMappedVelocityFluxFixedValueFvPatchField
 111         (
 112             const directMappedVelocityFluxFixedValueFvPatchField&,
 113             const DimensionedField<vector, volMesh>&
 114         );
 115
 116         //- Construct and return a clone setting internal field reference
 117         virtual tmp<fvPatchVectorField> clone
 118         (
 119             const DimensionedField<vector, volMesh>& iF
 120         ) const
 121         {
 122             return tmp<fvPatchVectorField>
 123             (
 124                 new directMappedVelocityFluxFixedValueFvPatchField(*this, iF)
 125             );
 126         }
 127
 128
 129     // Member functions
 130
 131         // Evaluation functions
 132
 133             //- Update the coefficients associated with the patch field
 134             virtual void updateCoeffs();
 135
 136         //- Write
 137         virtual void write(Ostream&) const;
 138 };
 139
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 } // End namespace Foam
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 #endif
 148
 149 // ************************************************************************* //