FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

oneField.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::oneField
00026 
00027 Description
00028     A class representing the concept of a field of 1 used to avoid unnecessary
00029     manipulations for objects which are known to be one at compile-time.
00030 
00031     Used for example as the density argument to a function written for
00032     compressible to be used for incompressible flow.
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef oneField_H
00037 #define oneField_H
00038 
00039 #include <OpenFOAM/one.H>
00040 #include <OpenFOAM/scalar.H>
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class oneField Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class oneField
00052 :
00053     public one
00054 {
00055 
00056 public:
00057 
00058     // Constructors
00059 
00060         //- Construct null
00061         oneField()
00062         {}
00063 
00064 
00065     // Member Operators
00066 
00067         inline scalar operator[](const label) const;
00068 };
00069 
00070 
00071 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00072 
00073 } // End namespace Foam
00074 
00075 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00076 
00077 #   include <OpenFOAM/oneFieldI.H>
00078 
00079 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00080 
00081 #endif
00082 
00083 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines