applications/solvers/multiphase/twoPhaseEulerFoam/kineticTheoryModels/radialModel/radialModel/radialModel.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::radialModel
  27
  28 SourceFiles
  29     radialModel.C
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef radialModel_H
  34 #define radialModel_H
  35
  36 #include "dictionary.H"
  37 #include "volFields.H"
  38 #include "dimensionedTypes.H"
  39 #include "runTimeSelectionTables.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class radialModel Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class radialModel
  51 {
  52     // Private member functions
  53
  54         //- Disallow default bitwise copy construct
  55         radialModel(const radialModel&);
  56
  57         //- Disallow default bitwise assignment
  58         void operator=(const radialModel&);
  59
  60
  61 protected:
  62
  63     // Protected data
  64
  65         const dictionary& dict_;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("radialModel");
  72
  73     // Declare runtime constructor selection table
  74     declareRunTimeSelectionTable
  75     (
  76         autoPtr,
  77         radialModel,
  78         dictionary,
  79         (
  80             const dictionary& dict
  81         ),
  82         (dict)
  83     );
  84
  85
  86     // Constructors
  87
  88         //- Construct from components
  89         radialModel(const dictionary& dict);
  90
  91
  92     // Selectors
  93
  94         static autoPtr<radialModel> New
  95         (
  96             const dictionary& dict
  97         );
  98
  99
 100     //- Destructor
 101     virtual ~radialModel();
 102
 103
 104     // Member Functions
 105
 106         //- Radial distribution function
 107         virtual tmp<volScalarField> g0
 108         (
 109             const volScalarField& alpha,
 110             const dimensionedScalar& alphaMax
 111         ) const = 0;
 112
 113         //- Derivative of the radial distribution function
 114         virtual tmp<volScalarField> g0prime
 115         (
 116             const volScalarField& alpha,
 117             const dimensionedScalar& alphaMax
 118         ) const = 0;
 119 };
 120
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 } // End namespace Foam
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //