Transferred copyright to the OpenFOAM Foundation
[OpenFOAM-2.0.x.git] / src / thermophysicalModels / thermalPorousZone / thermalModel / noThermalModel / noThermalModel.H
blob5fec230046126456592f03b9fa3a0e1ae4c58a40
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.
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.
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.
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/>.
24 Class
25     Foam::porousMedia::noThermalModel
27 Description
28     A dummy thermal model porous media, corresponding to the 'none' option
30 \*---------------------------------------------------------------------------*/
32 #ifndef noThermalModel_H
33 #define noThermalModel_H
35 #include "thermalModel.H"
36 #include "runTimeSelectionTables.H"
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 namespace Foam
42 namespace porousMedia
45 /*---------------------------------------------------------------------------*\
46                        Class noThermalModel Declaration
47 \*---------------------------------------------------------------------------*/
49 class noThermalModel
51     public thermalModel
54 public:
56     //- Runtime type information
57     TypeName("none");
60     // Constructors
62         //- Construct from porous zone
63         noThermalModel(const porousZone&);
66     //- Destructor
67     virtual ~noThermalModel();
70     // Member Functions
72         //- Add the thermal source to the enthalpy equation
73         virtual void addEnthalpySource
74         (
75             const basicThermo&,
76             const volScalarField& rho,
77             fvScalarMatrix& hEqn
78         ) const;
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 } // End namespace porousMedia
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 } // End namespace Foam
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 #endif
94 // ************************************************************************* //