Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
fields
Fields
oneField
oneField.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | Copyright (C) 1991-2010 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
13
the Free Software Foundation, either version 3 of the License, or
14
(at your 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, see <http://www.gnu.org/licenses/>.
23
24
Class
25
Foam::oneField
26
27
Description
28
A class representing the concept of a field of 1 used to avoid unnecessary
29
manipulations for objects which are known to be one at compile-time.
30
31
Used for example as the density argument to a function written for
32
compressible to be used for incompressible flow.
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef oneField_H
37
#define oneField_H
38
39
#include <
OpenFOAM/one.H
>
40
#include <
OpenFOAM/scalar.H
>
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
47
/*---------------------------------------------------------------------------*\
48
Class oneField Declaration
49
\*---------------------------------------------------------------------------*/
50
51
class
oneField
52
:
53
public
one
54
{
55
56
public
:
57
58
// Constructors
59
60
//- Construct null
61
oneField
()
62
{}
63
64
65
// Member Operators
66
67
inline
scalar
operator[]
(
const
label)
const
;
68
};
69
70
71
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72
73
}
// End namespace Foam
74
75
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76
77
# include <
OpenFOAM/oneFieldI.H
>
78
79
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80
81
#endif
82
83
// ************************ vim: set sw=4 sts=4 et: ************************ //