Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / postProcessing / foamCalcFunctions / field / mag / mag.C
blob44cfbb2ef2c759715a3816be879bd5a93bb0fd19
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 \*---------------------------------------------------------------------------*/
26 #include "mag.H"
27 #include "addToRunTimeSelectionTable.H"
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 namespace Foam
33     namespace calcTypes
34     {
35         defineTypeNameAndDebug(mag, 0);
36         addToRunTimeSelectionTable(calcType, mag, dictionary);
37     }
41 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
43 Foam::calcTypes::mag::mag()
45     calcType()
49 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
51 Foam::calcTypes::mag::~mag()
55 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
57 void Foam::calcTypes::mag::init()
59     argList::validArgs.append("mag");
60     argList::validArgs.append("fieldName");
64 void Foam::calcTypes::mag::preCalc
66     const argList& args,
67     const Time& runTime,
68     const fvMesh& mesh
73 void Foam::calcTypes::mag::calc
75     const argList& args,
76     const Time& runTime,
77     const fvMesh& mesh
80     const word& fieldName = args.additionalArgs()[1];
82     IOobject fieldHeader
83     (
84         fieldName,
85         runTime.timeName(),
86         mesh,
87         IOobject::MUST_READ
88     );
90     // Check field exists
91     if (fieldHeader.headerOk())
92     {
93         bool processed = false;
95         writeMagField<scalar>(fieldHeader, mesh, processed);
96         writeMagField<vector>(fieldHeader, mesh, processed);
97         writeMagField<sphericalTensor>(fieldHeader, mesh, processed);
98         writeMagField<symmTensor>(fieldHeader, mesh, processed);
99         writeMagField<tensor>(fieldHeader, mesh, processed);
101         if (!processed)
102         {
103             FatalError
104                 << "Unable to process " << fieldName << nl
105                 << "No call to mag for fields of type "
106                 << fieldHeader.headerClassName() << nl << nl
107                 << exit(FatalError);
108         }
109     }
110     else
111     {
112         Info<< "    No " << fieldName << endl;
113     }
117 // ************************************************************************* //