From 1a03d43b57f3ec5788d16e79269e1227abe0d039 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@Germany>
Date: Tue, 1 Feb 2011 18:50:19 +0100
Subject: [PATCH] STYLE: remove comments referring to '<root>' or '<root>
<case>'
---
.../manipulation/insideCells/insideCells.C | 30 +++++++++++--------
.../writers/dx/dxSurfaceWriter.H | 10 +++----
.../writers/ensight/ensightSurfaceWriter.H | 10 +++----
.../writers/foamFile/foamFileSurfaceWriter.H | 10 +++----
.../writers/raw/rawSurfaceWriter.H | 10 +++----
.../writers/starcd/starcdSurfaceWriter.H | 6 ++--
.../sampledSurface/writers/surfaceWriter.H | 12 ++++----
.../writers/vtk/vtkSurfaceWriter.H | 10 +++----
8 files changed, 52 insertions(+), 46 deletions(-)
diff --git a/applications/utilities/mesh/manipulation/insideCells/insideCells.C b/applications/utilities/mesh/manipulation/insideCells/insideCells.C
index 967240701ec..16a37594d8f 100644
--- a/applications/utilities/mesh/manipulation/insideCells/insideCells.C
+++ b/applications/utilities/mesh/manipulation/insideCells/insideCells.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) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,8 +22,8 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Description
- Picks up cells with cell centre 'inside' of surface. Requires surface
- to be closed and singly connected.
+ Picks up cells with cell centre 'inside' of surface.
+ Requires surface to be closed and singly connected.
\*---------------------------------------------------------------------------*/
@@ -42,9 +42,16 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Create a cellSet for cells with their centres inside the defined "
+ "surface.\n"
+ "Surface must be closed and singly connected."
+ );
+
argList::noParallel();
- argList::validArgs.append("surface file");
- argList::validArgs.append("destination cellSet");
+ argList::validArgs.append("surfaceFile");
+ argList::validArgs.append("cellSet");
# include "setRootCase.H"
# include "createTime.H"
@@ -75,14 +82,13 @@ int main(int argc, char *argv[])
}
- Info<< "Selected " << insideCells.size()
- << " cells out of " << mesh.nCells() << endl
- << endl
+ Info<< "Selected " << insideCells.size() << " of " << mesh.nCells()
+ << " cells" << nl << nl
<< "Writing selected cells to cellSet " << insideCells.name()
- << endl << endl
- << "Use this cellSet e.g. with subsetMesh : " << endl << endl
- << " subsetMesh <root> <case> " << insideCells.name()
- << endl << endl;
+ << nl << nl
+ << "Use this cellSet e.g. with subsetMesh : " << nl << nl
+ << " subsetMesh " << insideCells.name()
+ << nl << endl;
insideCells.write();
diff --git a/src/sampling/sampledSurface/writers/dx/dxSurfaceWriter.H b/src/sampling/sampledSurface/writers/dx/dxSurfaceWriter.H
index e4e3af67e6b..6ff54c775f9 100644
--- a/src/sampling/sampledSurface/writers/dx/dxSurfaceWriter.H
+++ b/src/sampling/sampledSurface/writers/dx/dxSurfaceWriter.H
@@ -96,7 +96,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -110,7 +110,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -124,7 +124,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -138,7 +138,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -152,7 +152,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
diff --git a/src/sampling/sampledSurface/writers/ensight/ensightSurfaceWriter.H b/src/sampling/sampledSurface/writers/ensight/ensightSurfaceWriter.H
index 628c178d4e6..ca42fa8f08a 100644
--- a/src/sampling/sampledSurface/writers/ensight/ensightSurfaceWriter.H
+++ b/src/sampling/sampledSurface/writers/ensight/ensightSurfaceWriter.H
@@ -117,7 +117,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -131,7 +131,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -145,7 +145,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -159,7 +159,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -173,7 +173,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
diff --git a/src/sampling/sampledSurface/writers/foamFile/foamFileSurfaceWriter.H b/src/sampling/sampledSurface/writers/foamFile/foamFileSurfaceWriter.H
index ce19c21455a..7912a65acfc 100644
--- a/src/sampling/sampledSurface/writers/foamFile/foamFileSurfaceWriter.H
+++ b/src/sampling/sampledSurface/writers/foamFile/foamFileSurfaceWriter.H
@@ -107,7 +107,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -121,7 +121,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -135,7 +135,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -149,7 +149,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -163,7 +163,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
diff --git a/src/sampling/sampledSurface/writers/raw/rawSurfaceWriter.H b/src/sampling/sampledSurface/writers/raw/rawSurfaceWriter.H
index 5ec4d1ac305..c08b0eee5e9 100644
--- a/src/sampling/sampledSurface/writers/raw/rawSurfaceWriter.H
+++ b/src/sampling/sampledSurface/writers/raw/rawSurfaceWriter.H
@@ -128,7 +128,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -142,7 +142,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -156,7 +156,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -170,7 +170,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -184,7 +184,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
diff --git a/src/sampling/sampledSurface/writers/starcd/starcdSurfaceWriter.H b/src/sampling/sampledSurface/writers/starcd/starcdSurfaceWriter.H
index bf0a0eb8245..be537abed0a 100644
--- a/src/sampling/sampledSurface/writers/starcd/starcdSurfaceWriter.H
+++ b/src/sampling/sampledSurface/writers/starcd/starcdSurfaceWriter.H
@@ -129,7 +129,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -143,7 +143,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -157,7 +157,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
diff --git a/src/sampling/sampledSurface/writers/surfaceWriter.H b/src/sampling/sampledSurface/writers/surfaceWriter.H
index be265178499..f9d05871649 100644
--- a/src/sampling/sampledSurface/writers/surfaceWriter.H
+++ b/src/sampling/sampledSurface/writers/surfaceWriter.H
@@ -119,7 +119,7 @@ public:
//- Write single surface geometry to file.
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -132,7 +132,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -147,7 +147,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -162,7 +162,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -177,7 +177,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -192,7 +192,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
diff --git a/src/sampling/sampledSurface/writers/vtk/vtkSurfaceWriter.H b/src/sampling/sampledSurface/writers/vtk/vtkSurfaceWriter.H
index 322159094b7..75af4a347e9 100644
--- a/src/sampling/sampledSurface/writers/vtk/vtkSurfaceWriter.H
+++ b/src/sampling/sampledSurface/writers/vtk/vtkSurfaceWriter.H
@@ -105,7 +105,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -119,7 +119,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -133,7 +133,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -147,7 +147,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
@@ -161,7 +161,7 @@ public:
// One value per face or vertex (isNodeValues = true)
virtual void write
(
- const fileName& outputDir, // <root>/<case>/surface/TIME
+ const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
--
GitLab