Merge branch 'upstream/OpenFOAM' into master
[freefoam.git] / src / thermophysicalModels / radiation / radiationModel / noRadiation / noRadiation.H
blob682c359f27302f6fb299f24e228084033d83a6d9
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.
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.
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, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::radiation::noRadiation
28 Description
29     No radiation - does nothing to energy equation source terms
30     (returns zeros)
32 SourceFiles
33     noRadiation.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef noRadiation_H
38 #define noRadiation_H
40 #include <radiation/radiationModel.H>
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
46 namespace radiation
49 /*---------------------------------------------------------------------------*\
50                              Class noRadiation Declaration
51 \*---------------------------------------------------------------------------*/
53 class noRadiation
55     public radiationModel
57     // Private member functions
59         //- Disallow default bitwise copy construct
60         noRadiation(const noRadiation&);
62         //- Disallow default bitwise assignment
63         void operator=(const noRadiation&);
66 public:
68     //- Runtime type information
69     TypeName("none");
72     // Constructors
74         //- Construct from components
75         noRadiation(const volScalarField& T);
78     //- Destructor
79     virtual ~noRadiation();
82     // Member functions
84         // Edit
86             //- Solve radiation equation(s)
87             void calculate();
89             //- Read radiationProperties dictionary
90             bool read();
92             //- Source term component (for power of T^4)
93             tmp<volScalarField> Rp() const;
95             //- Source term component (constant)
96             tmp<DimensionedField<scalar, volMesh> > Ru() const;
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 } // End namespace radiation
103 } // End namespace Foam
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 #endif
109 // ************************ vim: set sw=4 sts=4 et: ************************ //