src/regionModels/surfaceFilmModels/submodels/subModelBase.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::subModelBase
  26
  27 Description
  28     Base class for surface film sub-models
  29
  30 SourceFiles
  31     subModelBaseI.H
  32     subModelBase.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef subModelBase_H
  37 #define subModelBase_H
  38
  39 #include "surfaceFilmModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace regionModels
  46 {
  47 namespace surfaceFilmModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                       Class subModelBase Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class subModelBase
  55 {
  56 private:
  57
  58     // Private Member Functions
  59
  60         //- Disallow default bitwise copy construct
  61         subModelBase(const subModelBase&);
  62
  63         //- Disallow default bitwise assignment
  64         void operator=(const subModelBase&);
  65
  66
  67 protected:
  68
  69     // Protected data
  70
  71         //- Reference to the owner surface film model
  72         const surfaceFilmModel& owner_;
  73
  74         //- Model coefficients dictionary
  75         dictionary coeffs_;
  76
  77
  78 public:
  79
  80     // Constructors
  81
  82         //- Construct null
  83         subModelBase(const surfaceFilmModel& owner);
  84
  85         //- Construct from type name, dictionary and surface film model
  86         subModelBase
  87         (
  88             const word& type,
  89             const surfaceFilmModel& owner,
  90             const dictionary& dict
  91         );
  92
  93
  94     //- Destructor
  95     virtual ~subModelBase();
  96
  97
  98     // Member Functions
  99
 100         // Access
 101
 102             //- Return the reference to the owner surface film model
 103             inline const surfaceFilmModel& owner() const;
 104
 105             //- Return the model coefficients dictionary
 106             inline const dictionary& coeffs() const;
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace surfaceFilmModels
 113 } // End namespace regionModels
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #include "subModelBaseI.H"
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //