Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / regionModels / surfaceFilmModels / submodels / thermo / filmRadiationModel / noRadiation / noRadiation.H
blob3ce5479f4d698327f5f2bf2c3068fb54c2b4b552
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2010-2011 OpenCFD Ltd.
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::noRadiation
27 Description
28     Dummy radiation model for 'none' option
30 SourceFiles
31     noRadiation.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef noRadiation_H
36 #define noRadiation_H
38 #include "filmRadiationModel.H"
39 #include "volFieldsFwd.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
45 namespace regionModels
47 namespace surfaceFilmModels
50 /*---------------------------------------------------------------------------*\
51                          Class noRadiation Declaration
52 \*---------------------------------------------------------------------------*/
54 class noRadiation
56     public filmRadiationModel
58 private:
60     // Private member functions
62         //- Disallow default bitwise copy construct
63         noRadiation(const noRadiation&);
65         //- Disallow default bitwise assignment
66         void operator=(const noRadiation&);
69 public:
71     //- Runtime type information
72     TypeName("none");
75     // Constructors
77         //- Construct from surface film model and dictionary
78         noRadiation
79         (
80             const surfaceFilmModel& owner,
81             const dictionary& dict
82         );
85     //- Destructor
86     virtual ~noRadiation();
89     // Member Functions
91         // Evolution
93             //- Correct
94             virtual void correct();
96             //- Return the radiation sensible enthalpy source
97             virtual tmp<volScalarField> Shs();
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 } // End namespace surfaceFilmModels
104 } // End namespace regionModels
105 } // End namespace Foam
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 #endif
111 // ************************************************************************* //