applications/utilities/mesh/generation/extrudeMesh/extrudeModel/extrudeModel/extrudeModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 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::extrudeModel
  27
  28 Description
  29     Top level extrusion model class
  30
  31 SourceFiles
  32     extrudeModel.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef extrudeModel_H
  37 #define extrudeModel_H
  38
  39 #include "dictionary.H"
  40 #include "point.H"
  41 #include "autoPtr.H"
  42 #include "runTimeSelectionTables.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                         Class extrudeModel Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class extrudeModel
  54 {
  55 protected:
  56
  57     // Protected data
  58
  59         const label nLayers_;
  60
  61         const dictionary& dict_;
  62
  63         const dictionary& coeffDict_;
  64
  65
  66     // Private Member Functions
  67
  68         //- Disallow default bitwise copy construct
  69         extrudeModel(const extrudeModel&);
  70
  71         //- Disallow default bitwise assignment
  72         void operator=(const extrudeModel&);
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("extrudeModel");
  79
  80     //- Declare runtime constructor selection table
  81
  82         declareRunTimeSelectionTable
  83         (
  84             autoPtr,
  85             extrudeModel,
  86             dictionary,
  87             (
  88                 const dictionary& dict
  89             ),
  90             (dict)
  91         );
  92
  93
  94     // Constructors
  95
  96         //- Construct from dictionary
  97         extrudeModel(const word& modelType, const dictionary&);
  98
  99
 100     // Selectors
 101
 102         //- Select null constructed
 103         static autoPtr<extrudeModel> New(const dictionary&);
 104
 105
 106     //- Destructor
 107     virtual ~extrudeModel();
 108
 109
 110     // Member Functions
 111
 112         // Access
 113
 114             label nLayers() const;
 115
 116
 117     // Member Operators
 118
 119         virtual point operator()
 120         (
 121             const point& surfacePoint,
 122             const vector& surfaceNormal,
 123             const label layer
 124         ) const = 0;
 125 };
 126
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 } // End namespace Foam
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #endif
 135
 136 // ************************************************************************* //