src/regionModels/regionModel/singleLayerRegion/singleLayerRegion.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::singleLayerRegion
  26
  27 Description
  28     Base class for single layer region models
  29
  30 SourceFiles
  31     singleLayerRegion.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef singleLayerRegion_H
  36 #define singleLayerRegion_H
  37
  38 #include "regionModel.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44 namespace regionModels
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                       Class singleLayerRegion Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class singleLayerRegion
  52 :
  53     public regionModel
  54 {
  55
  56 private:
  57
  58     // Private Member Functions
  59
  60         //- Disallow default bitwise copy construct
  61         singleLayerRegion(const singleLayerRegion&);
  62
  63         //- Disallow default bitwise assignment
  64         void operator=(const singleLayerRegion&);
  65
  66         //- Construct region mesh and fields
  67         void constructMeshObjects();
  68
  69         //- Initialise the region
  70         void initialise();
  71
  72
  73 protected:
  74
  75     // Protected data
  76
  77         // Region addressing
  78
  79             //- Patch normal vectors
  80             autoPtr<volVectorField> nHatPtr_;
  81
  82             //- Face area magnitudes / [m2]
  83             autoPtr<volScalarField> magSfPtr_;
  84
  85
  86         // Addressing
  87
  88             //- List of patch IDs opposite to internally coupled patches
  89             labelList passivePatchIDs_;
  90
  91
  92     // Protected member functions
  93
  94         //- Read control parameters from dictionary
  95         virtual bool read();
  96
  97
  98 public:
  99
 100     //- Runtime type information
 101     TypeName("regionModel");
 102
 103
 104     // Constructors
 105
 106         //- Construct null
 107         singleLayerRegion(const fvMesh& mesh);
 108
 109         //- Construct from mesh, region type and name
 110         singleLayerRegion
 111         (
 112             const fvMesh& mesh,
 113             const word& regionType,
 114             const word& modelName,
 115             bool readFields = true
 116         );
 117
 118
 119     //- Destructor
 120     virtual ~singleLayerRegion();
 121
 122
 123     // Member Functions
 124
 125         // Access
 126
 127             // Region geometry
 128
 129                 //- Return the patch normal vectors
 130                 virtual const volVectorField& nHat() const;
 131
 132                 //- Return the face area magnitudes / [m2]
 133                 virtual const volScalarField& magSf() const;
 134
 135
 136             // Addressing
 137
 138                 //- Return the list of patch IDs opposite to internally
 139                 //  coupled patches
 140                 virtual const labelList& passivePatchIDs() const;
 141
 142
 143         // Patch type information
 144
 145             //- Return boundary types for mapped field patches
 146             //  Also maps internal field value
 147             //  Mapping region prescribed by underlying mapped poly patch
 148             template<class Type>
 149             wordList mappedFieldAndInternalPatchTypes() const;
 150
 151             //- Return boundary types for pushed mapped field patches
 152             //  Mapping region prescribed by underlying mapped poly patch
 153             template<class Type>
 154             wordList mappedPushedFieldPatchTypes() const;
 155 };
 156
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 } // End namespace regionModels
 161 } // End namespace Foam
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 #ifdef NoRepository
 166     #include "singleLayerRegionTemplates.C"
 167 #endif
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 #endif
 172
 173 // ************************************************************************* //