From 8b428bc73c19f60ca5ca13a90c07c83f35c4b0d1 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@Germany>
Date: Tue, 18 May 2010 14:41:53 +0200
Subject: [PATCH] STYLE: add some usage comments to some conversion utilities
STYLE: move polyDualMesh from conversion -> manipulation
---
.../Optional/ccm26ToFoam/ccm26ToFoam.C | 16 ++++++++++------
.../conversion/foamToStarMesh/foamToStarMesh.C | 6 +++++-
.../mesh/conversion/star3ToFoam/star3ToFoam.C | 9 +++++++--
.../mesh/conversion/star4ToFoam/star4ToFoam.C | 5 +++++
.../polyDualMesh/Make/files | 0
.../polyDualMesh/Make/options | 0
.../polyDualMesh/meshDualiser.C | 13 -------------
.../polyDualMesh/meshDualiser.H | 0
.../polyDualMesh/polyDualMeshApp.C | 0
9 files changed, 27 insertions(+), 22 deletions(-)
rename applications/utilities/mesh/{conversion => manipulation}/polyDualMesh/Make/files (100%)
rename applications/utilities/mesh/{conversion => manipulation}/polyDualMesh/Make/options (100%)
rename applications/utilities/mesh/{conversion => manipulation}/polyDualMesh/meshDualiser.C (99%)
rename applications/utilities/mesh/{conversion => manipulation}/polyDualMesh/meshDualiser.H (100%)
rename applications/utilities/mesh/{conversion => manipulation}/polyDualMesh/polyDualMeshApp.C (100%)
diff --git a/applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C b/applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C
index 58070fc473c..decabfeae01 100644
--- a/applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C
+++ b/applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C
@@ -579,12 +579,17 @@ void ReadCells
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "read CCM files as written by proSTAR/ccm\n"
+ " - does not handle 'interfaces' (couples), cyclics or data\n"
+ " - does not handle mesh regions (porosity, solids, ...)\n"
+ );
argList::noParallel();
- argList::validArgs.append("ccm26 file");
-
-# include "setRootCase.H"
-# include "createTime.H"
+ argList::validArgs.append("ccmFile");
+ #include "setRootCase.H"
+ #include "createTime.H"
// Foam mesh data
// ~~~~~~~~~~~~~~
@@ -615,6 +620,7 @@ int main(int argc, char *argv[])
{
const fileName ccmFile = args[1];
+ const word ccmExt = ccmFile.ext();
if (!isFile(ccmFile))
{
@@ -623,8 +629,6 @@ int main(int argc, char *argv[])
<< exit(FatalError);
}
- word ccmExt = ccmFile.ext();
-
if (ccmExt != "ccm" && ccmExt != "ccmg")
{
FatalErrorIn(args.executable())
diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
index 09e34235e5f..2587a5d4571 100644
--- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
+++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
@@ -62,6 +62,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "read OpenFOAM mesh and write a pro-STAR (v4) bnd/cel/vrt format"
+ );
argList::noParallel();
timeSelector::addOptions();
@@ -74,7 +78,7 @@ int main(int argc, char *argv[])
argList::addBoolOption
(
"noBnd",
- "suppress writing the .bnd file"
+ "suppress writing a boundary (.bnd) file"
);
# include "setRootCase.H"
diff --git a/applications/utilities/mesh/conversion/star3ToFoam/star3ToFoam.C b/applications/utilities/mesh/conversion/star3ToFoam/star3ToFoam.C
index de32c0f5b3d..8d8c565387d 100644
--- a/applications/utilities/mesh/conversion/star3ToFoam/star3ToFoam.C
+++ b/applications/utilities/mesh/conversion/star3ToFoam/star3ToFoam.C
@@ -38,8 +38,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "convert pro-STAR (v3) mesh to OpenFOAM"
+ );
+
argList::noParallel();
- argList::validArgs.append("STAR mesh file prefix");
+ argList::validArgs.append("pro-STAR prefix");
argList::addOption
(
"scale",
@@ -56,7 +61,7 @@ int main(int argc, char *argv[])
const scalar scaleFactor = args.optionLookupOrDefault("scale", 1.0);
-# include "createTime.H"
+ #include "createTime.H"
starMesh makeMesh(args[1], runTime, scaleFactor);
diff --git a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
index fc956582b3e..53dd66c234a 100644
--- a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
+++ b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
@@ -59,6 +59,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "convert pro-STAR (v4) mesh to OpenFOAM"
+ );
+
argList::noParallel();
argList::validArgs.append("pro-STAR prefix");
argList::addBoolOption
diff --git a/applications/utilities/mesh/conversion/polyDualMesh/Make/files b/applications/utilities/mesh/manipulation/polyDualMesh/Make/files
similarity index 100%
rename from applications/utilities/mesh/conversion/polyDualMesh/Make/files
rename to applications/utilities/mesh/manipulation/polyDualMesh/Make/files
diff --git a/applications/utilities/mesh/conversion/polyDualMesh/Make/options b/applications/utilities/mesh/manipulation/polyDualMesh/Make/options
similarity index 100%
rename from applications/utilities/mesh/conversion/polyDualMesh/Make/options
rename to applications/utilities/mesh/manipulation/polyDualMesh/Make/options
diff --git a/applications/utilities/mesh/conversion/polyDualMesh/meshDualiser.C b/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C
similarity index 99%
rename from applications/utilities/mesh/conversion/polyDualMesh/meshDualiser.C
rename to applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C
index 74a89fdc5e3..bdfb35bd504 100644
--- a/applications/utilities/mesh/conversion/polyDualMesh/meshDualiser.C
+++ b/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C
@@ -881,9 +881,6 @@ Foam::meshDualiser::meshDualiser(const polyMesh& mesh)
{}
-// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
-
-
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
void Foam::meshDualiser::setRefinement
@@ -1469,14 +1466,4 @@ void Foam::meshDualiser::setRefinement
}
-
-// * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
-
-
-// * * * * * * * * * * * * * * * Friend Functions * * * * * * * * * * * * * //
-
-
-// * * * * * * * * * * * * * * * Friend Operators * * * * * * * * * * * * * //
-
-
// ************************************************************************* //
diff --git a/applications/utilities/mesh/conversion/polyDualMesh/meshDualiser.H b/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.H
similarity index 100%
rename from applications/utilities/mesh/conversion/polyDualMesh/meshDualiser.H
rename to applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.H
diff --git a/applications/utilities/mesh/conversion/polyDualMesh/polyDualMeshApp.C b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
similarity index 100%
rename from applications/utilities/mesh/conversion/polyDualMesh/polyDualMeshApp.C
rename to applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
--
GitLab