initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / postProcessing / foamCalcFunctions / field / components / components.C
blob35254bbca26c5d8befc4eb48a15a7163eb1dacd5
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 \*---------------------------------------------------------------------------*/
27 #include "components.H"
28 #include "addToRunTimeSelectionTable.H"
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 namespace Foam
34     namespace calcTypes
35     {
36         defineTypeNameAndDebug(components, 0);
37         addToRunTimeSelectionTable(calcType, components, dictionary);
38     }
42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
44 Foam::calcTypes::components::components()
46     calcType()
50 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
52 Foam::calcTypes::components::~components()
56 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
58 void Foam::calcTypes::components::init()
60     argList::validArgs.append("components");
61     argList::validArgs.append("fieldName");
65 void Foam::calcTypes::components::preCalc
67     const argList& args,
68     const Time& runTime,
69     const fvMesh& mesh
74 void Foam::calcTypes::components::calc
76     const argList& args,
77     const Time& runTime,
78     const fvMesh& mesh
81     const word& fieldName = args.additionalArgs()[1];
83     IOobject fieldHeader
84     (
85         fieldName,
86         runTime.timeName(),
87         mesh,
88         IOobject::MUST_READ
89     );
91     // Check field exists
92     if (fieldHeader.headerOk())
93     {
94         bool processed = false;
96         writeComponentFields<vector>(fieldHeader, mesh, processed);
97         writeComponentFields<sphericalTensor>(fieldHeader, mesh, processed);
98         writeComponentFields<symmTensor>(fieldHeader, mesh, processed);
99         writeComponentFields<tensor>(fieldHeader, mesh, processed);
101         if (!processed)
102         {
103             FatalError
104                 << "Unable to process " << fieldName << nl
105                 << "No call to components for fields of type "
106                 << fieldHeader.headerClassName() << nl << nl
107                 << exit(FatalError);
108         }
109     }
110     else
111     {
112         Info<< "    No " << fieldName << endl;
113     }
117 // ************************************************************************* //