initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / sampling / graphField / makeGraph.C
blob4961bb58b9d74e5c723d775e4dc3c60fa34fda82
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 Global
26     makeGraph
28 Description
29     Write a graph file for a field given the data point locations field,
30     the field of interest and the name of the field to be used for the
31     graph file name.
33 \*---------------------------------------------------------------------------*/
35 #include "makeGraph.H"
36 #include "volFields.H"
37 #include "fvMesh.H"
38 #include "graph.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 void makeGraph
49     const scalarField& x,
50     const volScalarField& vsf,
51     const word& graphFormat
54     makeGraph(x, vsf, vsf.name(), graphFormat);
58 void makeGraph
60     const scalarField& x,
61     const volScalarField& vsf,
62     const word& name,
63     const word& graphFormat
66     makeGraph(x, vsf.internalField(), name, vsf.path(), graphFormat);
70 void makeGraph
72     const scalarField& x,
73     const scalarField& sf,
74     const word& name,
75     const fileName& path,
76     const word& graphFormat
79     graph
80     (
81         name,
82         "x",
83         name,
84         x,
85         sf
86     ).write(path/name, graphFormat);
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 } // End namespace Foam
94 // ************************************************************************* //