Merge branch 'master' into cvm

applications/utilities/miscellaneous/expandDictionary/expandDictionary.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2008-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -28,12 +28,33 @@ Description
     Read the dictionary provided as an argument, expand the macros etc. and
     write the resulting dictionary to standard output.
 
+Usage
+    - expandDictionary inputDict [OPTION]
+
+    \param -list \n
+    Report the #include/#includeIfPresent to stdout only.
+
+Note
+    The \c -list option can be useful when determining which files
+    are actually included by a directory. It can also be used to
+    determine which files may need to be copied when transferring
+    simulation to another environment. The following code snippet
+    could be a useful basis for such cases:
+
+    \verbatim
+        for i in . 0 constant system
+        do
+            find $i -maxdepth 1 -type f -exec expandDictionary -list '{}' \;
+        done | sed -ne '/^"\//!{ s/^"//; s/"$//; p }' | sort | uniq
+    \endverbatim
+
 \*---------------------------------------------------------------------------*/
 
 #include "argList.H"
 #include "IFstream.H"
 #include "IOobject.H"
 #include "dictionary.H"
+#include "includeEntry.H"
 
 using namespace Foam;
 
@@ -48,6 +69,12 @@ int main(int argc, char *argv[])
         "the resulting dictionary to standard output."
     );
 
+    argList::addBoolOption
+    (
+        "list",
+        "Report the #include/#includeIfPresent to stdout only"
+    );
+
     argList::noBanner();
     argList::noParallel();
     argList::validArgs.append("inputDict");
@@ -55,12 +82,22 @@ int main(int argc, char *argv[])
 
     const string dictName = args[1];
 
-    IOobject::writeBanner(Info)
-        <<"//\n// " << dictName << "\n//\n";
+    const bool listOpt = args.optionFound("list");
 
-    dictionary(IFstream(dictName)(), true).write(Info, false);
+    if (listOpt)
+    {
+        Foam::functionEntries::includeEntry::report = true;
+    }
 
-    IOobject::writeDivider(Info);
+    dictionary dict(IFstream(dictName)(), true);
+
+    if (!listOpt)
+    {
+        IOobject::writeBanner(Info)
+            <<"//\n// " << dictName << "\n//\n";
+        dict.write(Info, false);
+        IOobject::writeDivider(Info);
+    }
 
     return 0;
 }

applications/utilities/surface/surfaceMeshInfo/Make/files

@@ -0,0 +1,3 @@
+surfaceMeshInfo.C
+
+EXE = $(FOAM_APPBIN)/surfaceMeshInfo

applications/utilities/surface/surfaceMeshInfo/Make/options

@@ -0,0 +1,5 @@
+EXE_INC = \
+    -I$(LIB_SRC)/meshTools/lnInclude \
+    -I$(LIB_SRC)/surfMesh/lnInclude
+
+EXE_LIBS = -lmeshTools -lsurfMesh

applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C

@@ -0,0 +1,177 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2011-2011 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 3 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, see <http://www.gnu.org/licenses/>.
+
+Application
+    surfaceMeshInfo
+
+Description
+    Miscellaneous information about surface meshes
+
+Usage
+    - surfaceMeshInfo surfaceFile [OPTION]
+
+    \param -areas \n
+    Report area for each face.
+
+    \param -scale \<scale\> \n
+    Specify a scaling factor when reading files.
+
+    \param -xml \n
+    Write output in XML format.
+
+Note
+    The filename extensions are used to determine the file format type.
+
+    The XML-like output can be useful for extraction with other tools,
+    but either output format can be easily extracted with a simple sed
+    command:
+    \verbatim
+        surfaceMeshInfo surfaceFile -areas | \
+            sed -ne '/areas/,/:/{ /:/!p }'
+
+        surfaceMeshInfo surfaceFile -areas -xml | \
+            sed -ne '/<areas/,/</{ /</!p }'
+    \endverbatim
+
+\*---------------------------------------------------------------------------*/
+
+#include "argList.H"
+#include "timeSelector.H"
+#include "Time.H"
+
+#include "UnsortedMeshedSurfaces.H"
+
+using namespace Foam;
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+//  Main program:
+
+int main(int argc, char *argv[])
+{
+    argList::addNote
+    (
+        "information about surface meshes"
+    );
+
+    argList::noBanner();
+    argList::noParallel();
+    argList::validArgs.append("surfaceFile");
+
+    argList::addOption
+    (
+        "scale",
+        "factor",
+        "geometry scaling factor - default is 1"
+    );
+    argList::addBoolOption
+    (
+        "areas",
+        "display area of each face"
+    );
+    argList::addBoolOption
+    (
+        "xml",
+        "write output in XML format"
+    );
+
+    argList args(argc, argv);
+    Time runTime(args.rootPath(), args.caseName());
+
+    const fileName importName = args[1];
+
+    // check that reading is supported
+    if (!UnsortedMeshedSurface<face>::canRead(importName, true))
+    {
+        return 1;
+    }
+
+    const bool writeXML = args.optionFound("xml");
+    const bool writeAreas = args.optionFound("areas");
+
+
+    // use UnsortedMeshedSurface, not MeshedSurface to maintain ordering
+    UnsortedMeshedSurface<face> surf(importName);
+
+    scalar scaling = 0;
+    if (args.optionReadIfPresent("scale", scaling) && scaling > 0)
+    {
+        Info<< " -scale " << scaling << endl;
+        surf.scalePoints(scaling);
+    }
+
+    scalar areaTotal = 0;
+
+    if (writeXML)
+    {
+        Info<<"<?xml version='1.0' encoding='utf-8'?>" << nl
+            <<"<surfaceMeshInfo>" << nl
+            << "<npoints>" << surf.nPoints() << "</npoints>" << nl
+            << "<nfaces>"  << surf.size() << "</nfaces>" << nl;
+
+        if (writeAreas)
+        {
+            Info<<"<areas size='" << surf.size() << "'>" << nl;
+        }
+    }
+    else
+    {
+        Info<< "nPoints   : " << surf.nPoints() << nl
+            << "nFaces    : " << surf.size() << nl;
+
+        if (writeAreas)
+        {
+            Info<< "areas     : " << nl;
+        }
+    }
+
+    forAll(surf, faceI)
+    {
+        const scalar fArea(surf[faceI].mag(surf.points()));
+        areaTotal += fArea;
+
+        if (writeAreas)
+        {
+            Info<< fArea << nl;
+        }
+    }
+
+    if (writeXML)
+    {
+        if (writeAreas)
+        {
+            Info<<"</areas>" << nl;
+        }
+
+        Info<< "<area>" << areaTotal << "</area>" << nl
+            << "</surfaceMeshInfo>" << nl;
+    }
+    else
+    {
+        Info<< "area      : " << areaTotal << nl;
+    }
+
+    return 0;
+}
+
+// ************************************************************************* //