updated magGrad utility, and separated out template functions

applications/utilities/postProcessing/field/components/components.C

@@ -35,44 +35,7 @@ Description
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-template <class Type>
+#include "writeComponentFields.C"
-void writeComponents
-(
-    const IOobject& header,
-    const fvMesh& mesh,
-    bool& processed
-)
-{
-    typedef GeometricField<Type, fvPatchField, volMesh> fieldType;
-
-    if (header.headerClassName() == fieldType::typeName)
-    {
-        Info<< "    Reading " << header.name() << endl;
-        fieldType field(header, mesh);
-
-        for (direction i=0; i<Type::nComponents; i++)
-        {
-            Info<< "    Calculating " << header.name()
-                << Type::componentNames[i] << endl;
-
-            volScalarField componentField
-            (
-                IOobject
-                (
-                    header.name() + word(Type::componentNames[i]),
-                    mesh.time().timeName(),
-                    mesh,
-                    IOobject::NO_READ
-                ),
-                field.component(i)
-            );
-            componentField.write();
-        }
-
-        processed = true;
-    }
-}
-
 
 int main(int argc, char *argv[])
 {
@@ -115,10 +78,15 @@ int main(int argc, char *argv[])
             mesh.readUpdate();
 
             bool processed = false;
-            writeComponents<vector>(fieldHeader, mesh, processed);
+            writeComponentFields<vector>(fieldHeader, mesh, processed);
-            writeComponents<sphericalTensor>(fieldHeader, mesh, processed);
+            writeComponentFields<sphericalTensor>
-            writeComponents<symmTensor>(fieldHeader, mesh, processed);
+            (
-            writeComponents<tensor>(fieldHeader, mesh, processed);
+                fieldHeader,
+                mesh,
+                processed
+            );
+            writeComponentFields<symmTensor>(fieldHeader, mesh, processed);
+            writeComponentFields<tensor>(fieldHeader, mesh, processed);
             if (!processed)
             {
                 FatalError

applications/utilities/postProcessing/field/components/writeComponentFields.C

@@ -0,0 +1,77 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 1991-2007 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by the
+    Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM; if not, write to the Free Software Foundation,
+    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Application
+    components
+
+Description
+    Writes scalar fields corresponding to each component of the supplied
+    field (name) for each time.
+
+\*---------------------------------------------------------------------------*/
+
+#include "fvCFD.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+template <class Type>
+void writeComponentFields
+(
+    const IOobject& header,
+    const fvMesh& mesh,
+    bool& processed
+)
+{
+    typedef GeometricField<Type, fvPatchField, volMesh> fieldType;
+
+    if (header.headerClassName() == fieldType::typeName)
+    {
+        Info<< "    Reading " << header.name() << endl;
+        fieldType field(header, mesh);
+
+        for (direction i=0; i<Type::nComponents; i++)
+        {
+            Info<< "    Calculating " << header.name()
+                << Type::componentNames[i] << endl;
+
+            volScalarField componentField
+            (
+                IOobject
+                (
+                    header.name() + word(Type::componentNames[i]),
+                    mesh.time().timeName(),
+                    mesh,
+                    IOobject::NO_READ
+                ),
+                field.component(i)
+            );
+            componentField.write();
+        }
+
+        processed = true;
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

applications/utilities/postProcessing/field/mag/mag.C

@@ -34,39 +34,7 @@ Description
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-template<class Type>
+#include "writeMagField.C"
-void writeMagField
-(
-    const IOobject& header,
-    const fvMesh& mesh,
-    bool& processed
-)
-{
-    typedef GeometricField<Type, fvPatchField, volMesh> fieldType;
-
-    if (header.headerClassName() == fieldType::typeName)
-    {
-        Info<< "    Reading " << header.name() << endl;
-        fieldType field(header, mesh);
-
-        Info<< "    Calculating mag" << header.name() << endl;
-        volScalarField magField
-        (
-            IOobject
-            (
-                "mag" + header.name(),
-                mesh.time().timeName(),
-                mesh,
-                IOobject::NO_READ
-            ),
-            mag(field)
-        );
-        magField.write();
-
-        processed = true;
-    }
-}
-
 
 int main(int argc, char *argv[])
 {

applications/utilities/postProcessing/field/mag/writeMagField.C

@@ -0,0 +1,71 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 1991-2007 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by the
+    Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM; if not, write to the Free Software Foundation,
+    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Application
+    mag
+
+Description
+    Calculates and writes the magnitude of a field for each time
+
+\*---------------------------------------------------------------------------*/
+
+#include "fvCFD.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+template<class Type>
+void writeMagField
+(
+    const IOobject& header,
+    const fvMesh& mesh,
+    bool& processed
+)
+{
+    typedef GeometricField<Type, fvPatchField, volMesh> fieldType;
+
+    if (header.headerClassName() == fieldType::typeName)
+    {
+        Info<< "    Reading " << header.name() << endl;
+        fieldType field(header, mesh);
+
+        Info<< "    Calculating mag" << header.name() << endl;
+        volScalarField magField
+        (
+            IOobject
+            (
+                "mag" + header.name(),
+                mesh.time().timeName(),
+                mesh,
+                IOobject::NO_READ
+            ),
+            mag(field)
+        );
+        magField.write();
+
+        processed = true;
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

applications/utilities/postProcessing/field/magGrad/FoamX/magGradU.cfg

@@ -1,27 +0,0 @@
-/*---------------------------------------------------------------------------*\
-| =========                 |                                                 |
-| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
-|  \\    /   O peration     | Version:  1.0                                   |
-|   \\  /    A nd           | Web:      http://www.openfoam.org               |
-|    \\/     M anipulation  |                                                 |
-\*---------------------------------------------------------------------------*/
-// magGradU tool definition
-
-description     "Magnitude of grad(U) calculation";
-
-magGradUDict
-{
-    type            dictionary;
-    description     "magGradU control dictionary";
-    dictionaryPath  "system";
-
-    entries
-    {
-        arguments
-        {
-            type        rootCaseTimeArguments;
-        }
-    }
-}
-
-// ************************************************************************* //

applications/utilities/postProcessing/field/magGrad/magGrad.C

@@ -26,23 +26,26 @@ Application
     magGrad
 
 Description
-    Calculates and writes the scalar magnitude of a scalar or vector field
+    Calculates and writes the magnitude of the gradient of a field for each
-    at each time
+    time
 
 \*---------------------------------------------------------------------------*/
 
 #include "fvCFD.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-//  Main program:
+
+#include "writeMagGradField.C"
 
 int main(int argc, char *argv[])
 {
-    argList::validArgs.append("field");
+    argList::validArgs.append("fieldName");
 
 #   include "addTimeOptions.H"
 #   include "setRootCase.H"
 
+    word fieldName(args.additionalArgs()[0]);
+
 #   include "createTime.H"
 
     // Get times list
@@ -51,8 +54,6 @@ int main(int argc, char *argv[])
     // set startTime and endTime depending on -time and -latestTime options
 #   include "checkTimeOptions.H"
 
-    const word fieldName(args.additionalArgs()[0]);
-
     runTime.setTime(Times[startTime], startTime);
 
 #   include "createMesh.H"
@@ -63,7 +64,7 @@ int main(int argc, char *argv[])
 
         Info<< "Time = " << runTime.timeName() << endl;
 
-        IOobject header
+        IOobject fieldHeader
         (
             fieldName,
             runTime.timeName(),
@@ -71,56 +72,33 @@ int main(int argc, char *argv[])
             IOobject::MUST_READ
         );
 
-        // Check U exists
+        // Check field "fieldName" exists
-        if (header.headerOk())
+        if (fieldHeader.headerOk())
         {
             mesh.readUpdate();
 
-            if (header.headerClassName() == volVectorField::typeName)
+            bool processed = false;
+            writeMagGradField<scalar>(fieldHeader, mesh, processed);
+            writeMagGradField<vector>(fieldHeader, mesh, processed);
+            if (!processed)
             {
-                Info<< "    Reading " << fieldName << endl;
+                FatalError
-                volVectorField U(header, mesh);
+                    << "Unable to process " << fieldName << nl
-
+                    << "No call to magGrad for fields of type "
-                volScalarField magGrad
+                    << fieldHeader.headerClassName() << nl << nl
-                (
+                    << exit(FatalError);
-                    IOobject
-                    (
-                        "magGrad" + fieldName,
-                        runTime.timeName(),
-                        mesh,
-                        IOobject::NO_READ
-                    ),
-                    mag(fvc::grad(U))
-                );
-                Info<< "    Calculating " << magGrad.name() << endl;
-                magGrad.write();
-            }
-            else if (header.headerClassName() == volScalarField::typeName)
-            {
-                Info<< "    Reading " << fieldName << endl;
-                volScalarField U(header, mesh);
-
-                volScalarField magGrad
-                (
-                    IOobject
-                    (
-                        "magGrad" + fieldName,
-                        runTime.timeName(),
-                        mesh,
-                        IOobject::NO_READ
-                    ),
-                    mag(fvc::grad(U))
-                );
-                Info<< "    Calculating " << magGrad.name() << endl;
-                magGrad.write();
             }
         }
         else
         {
             Info<< "    No " << fieldName << endl;
         }
+
+        Info<< endl;
     }
 
+    Info<< "End\n" << endl;
+
     return(0);
 }
 

applications/utilities/postProcessing/field/magGrad/writeMagGradField.C

@@ -0,0 +1,72 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 1991-2007 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by the
+    Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM; if not, write to the Free Software Foundation,
+    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Application
+    magGrad
+
+Description
+    Calculates and writes the magnitude of the gradient of a field for each
+    time
+
+\*---------------------------------------------------------------------------*/
+
+#include "fvCFD.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+template<class Type>
+void writeMagGradField
+(
+    const IOobject& header,
+    const fvMesh& mesh,
+    bool& processed
+)
+{
+    typedef GeometricField<Type, fvPatchField, volMesh> fieldType;
+
+    if (header.headerClassName() == fieldType::typeName)
+    {
+        Info<< "    Reading " << header.name() << endl;
+        fieldType field(header, mesh);
+
+        Info<< "    Calculating magGrad" << header.name() << endl;
+        volScalarField magField
+        (
+            IOobject
+            (
+                "magGrad" + header.name(),
+                mesh.time().timeName(),
+                mesh,
+                IOobject::NO_READ
+            ),
+            mag(fvc::grad(field))
+        );
+        magField.write();
+
+        processed = true;
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

applications/utilities/postProcessing/field/magSqr/magSqr.C

@@ -34,39 +34,7 @@ Description
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-template<class Type>
+#include "writeMagSqrField.C"
-void writeMagSqrField
-(
-    const IOobject& header,
-    const fvMesh& mesh,
-    bool& processed
-)
-{
-    typedef GeometricField<Type, fvPatchField, volMesh> fieldType;
-
-    if (header.headerClassName() == fieldType::typeName)
-    {
-        Info<< "    Reading " << header.name() << endl;
-        fieldType field(header, mesh);
-
-        Info<< "    Calculating magSqr" << header.name() << endl;
-        volScalarField magSqrField
-        (
-            IOobject
-            (
-                "magSqr" + header.name(),
-                mesh.time().timeName(),
-                mesh,
-                IOobject::NO_READ
-            ),
-            magSqr(field)
-        );
-        magSqrField.write();
-
-        processed = true;
-    }
-}
-
 
 int main(int argc, char *argv[])
 {

applications/utilities/postProcessing/field/magSqr/writeMagSqrField.C

@@ -0,0 +1,72 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 1991-2007 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by the
+    Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM; if not, write to the Free Software Foundation,
+    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Application
+    mag
+
+Description
+    Calculates and writes the magnitude-squared of a field for each time
+
+\*---------------------------------------------------------------------------*/
+
+#include "fvCFD.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+template<class Type>
+void writeMagSqrField
+(
+    const IOobject& header,
+    const fvMesh& mesh,
+    bool& processed
+)
+{
+    typedef GeometricField<Type, fvPatchField, volMesh> fieldType;
+
+    if (header.headerClassName() == fieldType::typeName)
+    {
+        Info<< "    Reading " << header.name() << endl;
+        fieldType field(header, mesh);
+
+        Info<< "    Calculating magSqr" << header.name() << endl;
+        volScalarField magSqrField
+        (
+            IOobject
+            (
+                "magSqr" + header.name(),
+                mesh.time().timeName(),
+                mesh,
+                IOobject::NO_READ
+            ),
+            magSqr(field)
+        );
+        magSqrField.write();
+
+        processed = true;
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+