Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / postProcessing / functionObjects / field / streamLine / streamLineFunctionObject.H
blobc434f5fc6327fcad7bfb7083865fce8268ff9846
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2009-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 Typedef
25     Foam::streamLineFunctionObject
27 Description
28     FunctionObject wrapper around streamLines to allow them to be created via
29     the functions entry within controlDict.
31 SourceFiles
32     streamLineFunctionObject.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef streamLineFunctionObject_H
37 #define streamLineFunctionObject_H
39 #include "streamLine.H"
40 #include "OutputFilterFunctionObject.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
46     typedef OutputFilterFunctionObject<streamLine>
47         streamLineFunctionObject;
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 #endif
54 // ************************************************************************* //