src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.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::activeBaffleVelocityFvPatchVectorField
  26
  27 Description
  28     Boundary condition that modifies mesh areas based on velocity.
  29
  30 SourceFiles
  31     activeBaffleVelocityFvPatchVectorField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef activeBaffleVelocityFvPatchVectorField_H
  36 #define activeBaffleVelocityFvPatchVectorField_H
  37
  38 #include "fvPatchFields.H"
  39 #include "fixedValueFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                  Class activeBaffleVelocityFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class activeBaffleVelocityFvPatchVectorField
  51 :
  52     public fixedValueFvPatchVectorField
  53 {
  54     // Private data
  55
  56         //- Name of the pressure field used to calculate the force
  57         //  on the active baffle
  58         word pName_;
  59
  60         //- Name of the cyclic patch used when the active baffle is open
  61         word cyclicPatchName_;
  62
  63         //- Index of the cyclic patch used when the active baffle is open
  64         label cyclicPatchLabel_;
  65
  66         //- Orientation (1 or -1) of the active baffle patch.
  67         //  Used to change the direction of opening without the need for
  68         //  reordering the patch faces
  69         label orientation_;
  70
  71         //- Initial wall patch areas
  72         vectorField initWallSf_;
  73
  74         //- Initial this-side cyclic patch areas
  75         vectorField initCyclicSf_;
  76
  77         //- Initial neighbour-side cyclic patch areas
  78         vectorField nbrCyclicSf_;
  79
  80         //- Current fraction of the active baffle which is open
  81         scalar openFraction_;
  82
  83         //- Time taken for the active baffle to open
  84         scalar openingTime_;
  85
  86         //- Maximum fractional change to the active baffle openness
  87         //  per time-step
  88         scalar maxOpenFractionDelta_;
  89
  90         label curTimeIndex_;
  91
  92
  93 public:
  94
  95     //- Runtime type information
  96     TypeName("activeBaffleVelocity");
  97
  98
  99     // Constructors
 100
 101         //- Construct from patch and internal field
 102         activeBaffleVelocityFvPatchVectorField
 103         (
 104             const fvPatch&,
 105             const DimensionedField<vector, volMesh>&
 106         );
 107
 108         //- Construct from patch, internal field and dictionary
 109         activeBaffleVelocityFvPatchVectorField
 110         (
 111             const fvPatch&,
 112             const DimensionedField<vector, volMesh>&,
 113             const dictionary&
 114         );
 115
 116         //- Construct by mapping given activeBaffleVelocityFvPatchVectorField
 117         //  onto a new patch
 118         activeBaffleVelocityFvPatchVectorField
 119         (
 120             const activeBaffleVelocityFvPatchVectorField&,
 121             const fvPatch&,
 122             const DimensionedField<vector, volMesh>&,
 123             const fvPatchFieldMapper&
 124         );
 125
 126         //- Construct as copy
 127         activeBaffleVelocityFvPatchVectorField
 128         (
 129             const activeBaffleVelocityFvPatchVectorField&
 130         );
 131
 132         //- Construct and return a clone
 133         virtual tmp<fvPatchVectorField> clone() const
 134         {
 135             return tmp<fvPatchVectorField>
 136             (
 137                 new activeBaffleVelocityFvPatchVectorField(*this)
 138             );
 139         }
 140
 141         //- Construct as copy setting internal field reference
 142         activeBaffleVelocityFvPatchVectorField
 143         (
 144             const activeBaffleVelocityFvPatchVectorField&,
 145             const DimensionedField<vector, volMesh>&
 146         );
 147
 148         //- Construct and return a clone setting internal field reference
 149         virtual tmp<fvPatchVectorField> clone
 150         (
 151             const DimensionedField<vector, volMesh>& iF
 152         ) const
 153         {
 154             return tmp<fvPatchVectorField>
 155             (
 156                 new activeBaffleVelocityFvPatchVectorField(*this, iF)
 157             );
 158         }
 159
 160
 161     // Member functions
 162
 163         // Mapping functions
 164
 165             //- Map (and resize as needed) from self given a mapping object
 166             virtual void autoMap
 167             (
 168                 const fvPatchFieldMapper&
 169             );
 170
 171             //- Reverse map the given fvPatchField onto this fvPatchField
 172             virtual void rmap
 173             (
 174                 const fvPatchVectorField&,
 175                 const labelList&
 176             );
 177
 178
 179         //- Update the coefficients associated with the patch field
 180         virtual void updateCoeffs();
 181
 182         //- Write
 183         virtual void write(Ostream&) const;
 184 };
 185
 186
 187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 188
 189 } // End namespace Foam
 190
 191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 192
 193 #endif
 194
 195 // ************************************************************************* //