From 91f8176a750c0c4594c26a1558e05d800de84cb6 Mon Sep 17 00:00:00 2001
From: Andrew Heather <a.heather@opencfd.co.uk>
Date: Fri, 16 Dec 2016 16:56:55 +0000
Subject: [PATCH] STYLE: using messaging macros when referring to function name
---
.../mesh/conversion/ccm/ccmToFoam/ccmToFoam.C | 2 +-
.../primitives/Tensor/tensor/tensor.C | 2 +-
src/conversion/ccm/reader/ccmReader.C | 34 ++++++++-----------
src/conversion/ccm/reader/ccmReaderMesh.C | 15 ++++----
src/conversion/ccm/writer/ccmWriterMesh.C | 2 +-
src/conversion/ccm/writer/ccmWriterSolution.C | 2 +-
6 files changed, 25 insertions(+), 32 deletions(-)
diff --git a/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C b/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C
index 5b0a4cf6605..de3fd4ed308 100644
--- a/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C
+++ b/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C
@@ -301,7 +301,7 @@ int main(int argc, char *argv[])
}
else
{
- FatalErrorIn("ccmToFoam")
+ FatalErrorInFunction
<< "could not read geometry"
<< exit(FatalError);
}
diff --git a/src/OpenFOAM/primitives/Tensor/tensor/tensor.C b/src/OpenFOAM/primitives/Tensor/tensor/tensor.C
index f84d2e53160..ec5920c6b7c 100644
--- a/src/OpenFOAM/primitives/Tensor/tensor/tensor.C
+++ b/src/OpenFOAM/primitives/Tensor/tensor/tensor.C
@@ -154,7 +154,7 @@ Foam::vector Foam::eigenValues(const tensor& T)
// based on the above logic, PPP must be less than QQ
else
{
- WarningIn("eigenValues(const tensor&)")
+ WarningInFunction
<< "complex eigenvalues detected for tensor: " << T
<< endl;
diff --git a/src/conversion/ccm/reader/ccmReader.C b/src/conversion/ccm/reader/ccmReader.C
index 5d0c6f11579..217a1e8347f 100644
--- a/src/conversion/ccm/reader/ccmReader.C
+++ b/src/conversion/ccm/reader/ccmReader.C
@@ -109,7 +109,7 @@ std::string Foam::ccm::reader::ccmReadNodestr
str = strval;
}
- // allocated by CCMIOReadNodestr
+ // Allocated by CCMIOReadNodestr
if (strval)
{
free(strval);
@@ -189,7 +189,7 @@ Foam::word Foam::ccm::reader::validateWord
{
first = false;
- // start with a digit? need to prefix with '_'
+ // Start with a digit? need to prefix with '_'
if (isdigit(*iter))
{
prefix = true;
@@ -237,7 +237,7 @@ Foam::word Foam::ccm::reader::validateWord
}
-// read map data and check error
+// Read map data and check error
void Foam::ccm::reader::readMap
(
const ccmID& mapId,
@@ -305,7 +305,7 @@ void Foam::ccm::reader::readInterfaceDefinitions()
)
== kCCMIONoErr
- // get "/InterfaceDefinitions"
+ // Get "/InterfaceDefinitions"
&&
CCMIOGetNode
(
@@ -319,7 +319,7 @@ void Foam::ccm::reader::readInterfaceDefinitions()
{
CCMIONode interfaceNode;
- // simulate CCMIONextEntity
+ // Simulate CCMIONextEntity
for
(
int index = 0;
@@ -405,7 +405,7 @@ void Foam::ccm::reader::readProblemDescription_boundaryRegion
/* nop */
)
{
- // read boundaryRegionId
+ // Read boundaryRegionId
int Id = 0;
CCMIOGetEntityIndex
(
@@ -430,7 +430,7 @@ void Foam::ccm::reader::readProblemDescription_boundaryRegion
}
else if (str == "internal")
{
- // old PROSTAR bug: "monitoring" mislabeled as "internal"
+ // Old PROSTAR bug: "monitoring" mislabeled as "internal"
dict.add(opt, "monitoring");
}
else
@@ -461,7 +461,7 @@ void Foam::ccm::reader::readProblemDescription_boundaryRegion
#ifdef DEBUG_CCMIOREAD
Info<< "boundary is on an interface: remap name for " << Id << endl;
#endif
- // substitute immediately with interface name
+ // Substitute immediately with interface name
str = interfaceDefinitions_.interfaceName(Id);
}
else if
@@ -470,7 +470,7 @@ void Foam::ccm::reader::readProblemDescription_boundaryRegion
&& (str = ccmReadOptstr("BoundaryName", node)).empty()
)
{
- // fallback
+ // Fallback
str = word(dict["BoundaryType"]) + "_" + ::Foam::name(Id);
}
@@ -687,7 +687,7 @@ bool Foam::ccm::reader::remapMeshInfo
}
else
{
- // specified (absolute) name: treat like MUST_READ
+ // Specified (absolute) name: treat like MUST_READ
remapDict = dictionary(IFstream(remappingDictName)());
}
@@ -699,14 +699,14 @@ bool Foam::ccm::reader::remapMeshInfo
}
- // merge specified cellTable entries together
+ // Merge specified cellTable entries together
if (remapDict.isDict("cellTable"))
{
cellTable_.combine(remapDict.subDict("cellTable"), cellTableId_);
ok = true;
}
- // rename boundaries
+ // Rename boundaries
if (remapDict.isDict("boundaryRegion"))
{
boundaryRegion_.rename(remapDict.subDict("boundaryRegion"));
@@ -720,11 +720,7 @@ bool Foam::ccm::reader::remapMeshInfo
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct from reading a file
-Foam::ccm::reader::reader
-(
- const fileName& file,
- const reader::options& opts
-)
+Foam::ccm::reader::reader(const fileName& file, const reader::options& opts)
:
base(),
options_(new options(opts)),
@@ -754,14 +750,14 @@ Foam::ccm::reader::reader
{
if (!option().keptSomeRegion())
{
- FatalErrorIn("ccm::reader(const fileName&)")
+ FatalErrorInFunction
<< "must retain at least one region type: fluid | porous | solid"
<< exit(FatalError);
}
if (!isFile(file, false))
{
- FatalErrorIn("ccm::reader(const fileName&)")
+ FatalErrorInFunction
<< "Cannot read file " << file
<< exit(FatalError);
}
diff --git a/src/conversion/ccm/reader/ccmReaderMesh.C b/src/conversion/ccm/reader/ccmReaderMesh.C
index aa5058c3cef..bee858c18e4 100644
--- a/src/conversion/ccm/reader/ccmReaderMesh.C
+++ b/src/conversion/ccm/reader/ccmReaderMesh.C
@@ -45,10 +45,7 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
-Foam::labelList Foam::ccm::reader::patchStartList
-(
- label initial
-) const
+Foam::labelList Foam::ccm::reader::patchStartList(label initial) const
{
labelList startLst(patchSizes_.size(), Zero);
@@ -289,7 +286,7 @@ Foam::labelList Foam::ccm::reader::readVertices
if (dims != 3)
{
- FatalErrorIn("ccm::reader::readVertices")
+ FatalErrorInFunction
<< "can only handle 3-dimensional vertices"
<< exit(FatalError);
}
@@ -2272,7 +2269,7 @@ void Foam::ccm::reader::mergeInplaceInterfaces()
if (nFaceUsed != extFaceI)
{
- FatalErrorIn("ccm::reader::mergeInplaceInterfaces")
+ FatalErrorInFunction
<< "coding error: used " << nFaceUsed
<< " faces, but expected to use " << extFaceI << " faces"
<< exit(FatalError);
@@ -2335,7 +2332,7 @@ void Foam::ccm::reader::reorderMesh()
if (nbr >= cellTableId_.size() || own >= cellTableId_.size())
{
- FatalErrorIn("ccm::reader::reorderMesh")
+ FatalErrorInFunction
<< "face:" << faceI
<< " nbr:" << nbr
<< " own:" << own
@@ -2357,7 +2354,7 @@ void Foam::ccm::reader::reorderMesh()
{
if (f[fp] < 0 || f[fp] >= points_.size())
{
- FatalErrorIn("ccm::reader::reorderMesh")
+ FatalErrorInFunction
<< "face:" << faceI << " f:" << f
<< abort(FatalError);
}
@@ -2569,7 +2566,7 @@ void Foam::ccm::reader::addPatches
if (meshFaceI != mesh.nFaces())
{
- FatalErrorIn("ccm::reader::addPatches(polyMesh& mesh)")
+ FatalErrorInFunction
<< "meshFaceI:" << meshFaceI << " nFaces:" << mesh.nFaces()
<< abort(FatalError);
}
diff --git a/src/conversion/ccm/writer/ccmWriterMesh.C b/src/conversion/ccm/writer/ccmWriterMesh.C
index 506e9fc1c9c..f17a56a5304 100644
--- a/src/conversion/ccm/writer/ccmWriterMesh.C
+++ b/src/conversion/ccm/writer/ccmWriterMesh.C
@@ -519,7 +519,7 @@ void Foam::ccm::writer::writeCells
}
else
{
- WarningIn("ccm::writer::writeCells(polyMesh&)")
+ WarningInFunction
<< ioList.objectPath() << endl
<< " Has incorrect number of cells: "
<< ioList.size() << " instead of " << mesh_.nCells()
diff --git a/src/conversion/ccm/writer/ccmWriterSolution.C b/src/conversion/ccm/writer/ccmWriterSolution.C
index c351ef76c86..354e9cdf932 100644
--- a/src/conversion/ccm/writer/ccmWriterSolution.C
+++ b/src/conversion/ccm/writer/ccmWriterSolution.C
@@ -130,7 +130,7 @@ void Foam::ccm::writer::writeSolution
if (!isA<fvMesh>(mesh_))
{
- WarningIn("ccm::writer::writeSolution(const IOobjectList&, const fileName&)")
+ WarningInFunction
<< "cannot write solutions with a polyMesh instead of a fvMesh"
<< endl;
return;
--
GitLab