src/finiteVolume/finiteVolume/fvSchemes/fvSchemes.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::fvSchemes
  27
  28 Description
  29     Selector class for finite volume differencing schemes.
  30     fvMesh is derived from fvShemes so that all fields have access to the
  31     fvSchemes from the mesh reference they hold.
  32
  33 SourceFiles
  34     fvSchemes.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef fvSchemes_H
  39 #define fvSchemes_H
  40
  41 #include "IOdictionary.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class fvSchemes Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class fvSchemes
  53 :
  54     public IOdictionary
  55 {
  56     // Private data
  57
  58         dictionary ddtSchemes_;
  59         ITstream defaultDdtScheme_;
  60
  61         dictionary d2dt2Schemes_;
  62         ITstream defaultD2dt2Scheme_;
  63
  64         dictionary interpolationSchemes_;
  65         ITstream defaultInterpolationScheme_;
  66
  67         dictionary divSchemes_;
  68         ITstream defaultDivScheme_;
  69
  70         dictionary gradSchemes_;
  71         ITstream defaultGradScheme_;
  72
  73         dictionary snGradSchemes_;
  74         ITstream defaultSnGradScheme_;
  75
  76         dictionary laplacianSchemes_;
  77         ITstream defaultLaplacianScheme_;
  78
  79         dictionary fluxRequired_;
  80         bool defaultFluxRequired_;
  81
  82         dictionary cacheFields_;
  83
  84
  85     // Private Member Functions
  86
  87         //- Clear the dictionaries and streams before reading
  88         void clear();
  89
  90         //- Disallow default bitwise copy construct
  91         fvSchemes(const fvSchemes&);
  92
  93         //- Disallow default bitwise assignment
  94         void operator=(const fvSchemes&);
  95
  96
  97 public:
  98
  99     //- Debug switch
 100     static int debug;
 101
 102
 103     // Constructors
 104
 105         //- Construct for objectRegistry
 106         fvSchemes(const objectRegistry& obr);
 107
 108
 109     // Member Functions
 110
 111         // Access
 112
 113             const dictionary& schemesDict() const;
 114
 115             ITstream& ddtScheme(const word& name) const;
 116
 117             ITstream& d2dt2Scheme(const word& name) const;
 118
 119             ITstream& interpolationScheme(const word& name) const;
 120
 121             ITstream& divScheme(const word& name) const;
 122
 123             ITstream& gradScheme(const word& name) const;
 124
 125             ITstream& snGradScheme(const word& name) const;
 126
 127             ITstream& laplacianScheme(const word& name) const;
 128
 129             bool fluxRequired(const word& name) const;
 130
 131             bool cache(const word& name) const;
 132
 133
 134         // Read
 135
 136             //- Read the fvSchemes
 137             bool read();
 138 };
 139
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 } // End namespace Foam
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 #endif
 148
 149 // ************************************************************************* //