Commit 7ba41e00 authored by Henry Weller's avatar Henry Weller
Browse files

Removed duplicate, inconsistent and spurious comments in .C files

parent 95d146ec
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,6 @@ License
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
//- Calculate and return the laminar viscosity
void Foam::incompressibleThreePhaseMixture::calcNu()
{
nuModel1_->correct();
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -36,13 +36,10 @@ License
namespace Foam
{
defineTypeNameAndDebug(cellShapeControl, 0);
defineTypeNameAndDebug(cellShapeControl, 0);
}
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::cellShapeControl::cellShapeControl
......@@ -173,7 +170,6 @@ Foam::scalar Foam::cellShapeControl::cellSize(const point& pt) const
}
//- Return the cell alignment at the given location
Foam::tensor Foam::cellShapeControl::cellAlignment(const point& pt) const
{
scalarList bary;
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -36,7 +36,7 @@ License
namespace Foam
{
defineTypeNameAndDebug(meshDualiser, 0);
defineTypeNameAndDebug(meshDualiser, 0);
}
......@@ -123,8 +123,6 @@ void Foam::meshDualiser::dumpPolyTopoChange
}
//- Given cell and point on mesh finds the corresponding dualCell. Most
// points become only one cell but the feature points might be split.
Foam::label Foam::meshDualiser::findDualCell
(
const label cellI,
......@@ -146,8 +144,6 @@ Foam::label Foam::meshDualiser::findDualCell
}
// Helper function to generate dualpoints on all boundary edges emanating
// from (boundary & feature) point
void Foam::meshDualiser::generateDualBoundaryEdges
(
const PackedBoolList& isBoundaryEdge,
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -206,7 +206,6 @@ void Foam::ensightLagrangianField
}
//- Write generalized field components
template<class Type>
void Foam::ensightVolField
(
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -25,7 +25,6 @@ License
#include "collapseEdge.H"
//- Sets point neighbours of face to val
static void markPointNbrs
(
const triSurface& surf,
......
......@@ -188,7 +188,6 @@ bool Foam::isAdministrator()
}
// use $HOME environment variable or passwd info
Foam::fileName Foam::home()
{
char* env = ::getenv("HOME");
......@@ -588,14 +587,12 @@ bool Foam::mkDir(const fileName& pathName, mode_t mode)
}
// Set the file mode
bool Foam::chMod(const fileName& name, const mode_t m)
{
return ::chmod(name.c_str(), m) == 0;
}
// Return the file mode
mode_t Foam::mode(const fileName& name)
{
fileStat fileStatus(name);
......@@ -610,7 +607,6 @@ mode_t Foam::mode(const fileName& name)
}
// Return the file type: FILE or DIRECTORY
Foam::fileName::Type Foam::type(const fileName& name)
{
mode_t m = mode(name);
......@@ -630,28 +626,24 @@ Foam::fileName::Type Foam::type(const fileName& name)
}
// Does the name exist in the filing system?
bool Foam::exists(const fileName& name, const bool checkGzip)
{
return mode(name) || isFile(name, checkGzip);
}
// Does the directory exist?
bool Foam::isDir(const fileName& name)
{
return S_ISDIR(mode(name));
}
// Does the file exist?
bool Foam::isFile(const fileName& name, const bool checkGzip)
{
return S_ISREG(mode(name)) || (checkGzip && S_ISREG(mode(name + ".gz")));
}
// Return size of file
off_t Foam::fileSize(const fileName& name)
{
fileStat fileStatus(name);
......@@ -666,7 +658,6 @@ off_t Foam::fileSize(const fileName& name)
}
// Return time of last file modification
time_t Foam::lastModified(const fileName& name)
{
fileStat fileStatus(name);
......@@ -681,7 +672,6 @@ time_t Foam::lastModified(const fileName& name)
}
// Read a directory and return the entries as a string list
Foam::fileNameList Foam::readDir
(
const fileName& directory,
......@@ -776,7 +766,6 @@ Foam::fileNameList Foam::readDir
}
// Copy, recursively if necessary, the source to the destination
bool Foam::cp(const fileName& src, const fileName& dest)
{
// Make sure source exists.
......@@ -877,7 +866,6 @@ bool Foam::cp(const fileName& src, const fileName& dest)
}
// Create a softlink. dst should not exist. Returns true if successful.
bool Foam::ln(const fileName& src, const fileName& dst)
{
if (POSIX::debug)
......@@ -915,7 +903,6 @@ bool Foam::ln(const fileName& src, const fileName& dst)
}
// Rename srcFile dstFile
bool Foam::mv(const fileName& src, const fileName& dst)
{
if (POSIX::debug)
......@@ -941,8 +928,6 @@ bool Foam::mv(const fileName& src, const fileName& dst)
}
//- Rename to a corresponding backup file
// If the backup file already exists, attempt with "01" .. "99" index
bool Foam::mvBak(const fileName& src, const std::string& ext)
{
if (POSIX::debug)
......@@ -980,7 +965,6 @@ bool Foam::mvBak(const fileName& src, const std::string& ext)
}
// Remove a file, returning true if successful otherwise false
bool Foam::rm(const fileName& file)
{
if (POSIX::debug)
......@@ -1001,7 +985,6 @@ bool Foam::rm(const fileName& file)
}
// Remove a dirctory and its contents
bool Foam::rmDir(const fileName& directory)
{
if (POSIX::debug)
......@@ -1314,31 +1297,31 @@ Foam::fileNameList Foam::dlLoaded()
void Foam::osRandomSeed(const label seed)
{
#ifdef USE_RANDOM
#ifdef USE_RANDOM
srandom((unsigned int)seed);
#else
#else
srand48(seed);
#endif
#endif
}
Foam::label Foam::osRandomInteger()
{
#ifdef USE_RANDOM
#ifdef USE_RANDOM
return random();
#else
#else
return lrand48();
#endif
#endif
}
Foam::scalar Foam::osRandomDouble()
{
#ifdef USE_RANDOM
#ifdef USE_RANDOM
return (scalar)random()/INT_MAX;
#else
#else
return drand48();
#endif
#endif
}
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -55,8 +55,6 @@ Foam::dynamicTreeDataPoint::shapePoints() const
}
//- Get type (inside,outside,mixed,unknown) of point w.r.t. surface.
// Only makes sense for closed surfaces.
Foam::volumeType Foam::dynamicTreeDataPoint::getVolumeType
(
const dynamicIndexedOctree<dynamicTreeDataPoint>& oc,
......@@ -129,8 +127,6 @@ void Foam::dynamicTreeDataPoint::findNearest
}
//- Calculates nearest (to line) point in shape.
// Returns point and distance (squared)
void Foam::dynamicTreeDataPoint::findNearest
(
const labelUList& indices,
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -405,14 +405,12 @@ bool Foam::regIOobject::upToDate
}
//- Flag me as up to date
void Foam::regIOobject::setUpToDate()
{
eventNo_ = db().getEvent();
}
// Rename object and re-register with objectRegistry under new name
void Foam::regIOobject::rename(const word& newName)
{
// Check out of objectRegistry
......@@ -428,7 +426,6 @@ void Foam::regIOobject::rename(const word& newName)
}
// Assign to IOobject
void Foam::regIOobject::operator=(const IOobject& io)
{
if (isPtr_)
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -35,16 +35,16 @@ namespace Foam
/* * * * * * * * * * * * * * * Static Member Data * * * * * * * * * * * * * */
//- Since dimensionSystems() can be reread we actually store a copy of
// the controlDict subDict (v.s. a reference to the subDict for e.g.
// dimensionedConstants)
// Since dimensionSystems() can be reread we actually store a copy of
// the controlDict subDict (v.s. a reference to the subDict for e.g.
// dimensionedConstants)
dictionary* dimensionSystemsPtr_(NULL);
HashTable<dimensionedScalar>* unitSetPtr_(NULL);
dimensionSets* writeUnitSetPtr_(NULL);
//- Helper class to
// - register re-reader
// - deallocate demand-driven data
// Helper class to
// register re-reader
// deallocate demand-driven data
class addDimensionSetsToDebug
:
public ::Foam::simpleRegIOobject
......
......@@ -33,7 +33,6 @@ namespace Foam
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
//- Interpolate point field
template<class FromPatch, class ToPatch>
template<class Type>
tmp<Field<Type>>
......@@ -102,7 +101,6 @@ PatchToPatchInterpolation<FromPatch, ToPatch>::pointInterpolate
}
//- Interpolate face field
template<class FromPatch, class ToPatch>
template<class Type>
tmp<Field<Type>>
......
......@@ -636,7 +636,6 @@ void Foam::mapDistribute::exchangeAddressing
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
//- Construct null
Foam::mapDistribute::mapDistribute()
:
constructSize_(0),
......@@ -644,7 +643,6 @@ Foam::mapDistribute::mapDistribute()
{}
//- Construct from components
Foam::mapDistribute::mapDistribute
(
const label constructSize,
......@@ -659,7 +657,6 @@ Foam::mapDistribute::mapDistribute
{}
//- Construct from components
Foam::mapDistribute::mapDistribute
(
const label constructSize,
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -56,7 +56,6 @@ void Foam::mapDistributePolyMesh::calcPatchSizes()
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
//- Construct from components
Foam::mapDistributePolyMesh::mapDistributePolyMesh
(
const polyMesh& mesh,
......
......@@ -31,7 +31,6 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Distribute list.
template<class T>
void Foam::mapDistribute::distribute
(
......@@ -381,7 +380,6 @@ void Foam::mapDistribute::distribute
}
// Distribute list.
template<class T, class CombineOp>
void Foam::mapDistribute::distribute
(
......@@ -783,7 +781,6 @@ void Foam::mapDistribute::receive(PstreamBuffers& pBufs, List<T>& field) const
}
// In case of no transform: copy elements
template<class T>
void Foam::mapDistribute::applyDummyTransforms(List<T>& field) const
{
......@@ -801,7 +798,6 @@ void Foam::mapDistribute::applyDummyTransforms(List<T>& field) const
}
// In case of no transform: copy elements
template<class T>
void Foam::mapDistribute::applyDummyInverseTransforms(List<T>& field) const
{
......@@ -818,7 +814,6 @@ void Foam::mapDistribute::applyDummyInverseTransforms(List<T>& field) const
}
// Calculate transformed elements.
template<class T, class TransformOp> //, class CombineOp>
void Foam::mapDistribute::applyTransforms
(
......@@ -849,7 +844,6 @@ void Foam::mapDistribute::applyTransforms
}
// Calculate transformed elements.
template<class T, class TransformOp> //, class CombineOp>
void Foam::mapDistribute::applyInverseTransforms
(
......@@ -880,7 +874,6 @@ void Foam::mapDistribute::applyInverseTransforms
}
//- Distribute data using default commsType.
template<class T>
void Foam::mapDistribute::distribute
(
......@@ -899,7 +892,6 @@ void Foam::mapDistribute::distribute
}
//- Distribute data using default commsType.
template<class T>
void Foam::mapDistribute::distribute
(
......@@ -948,7 +940,7 @@ void Foam::mapDistribute::distribute
);
}
//- Fill in transformed slots with copies
// Fill in transformed slots with copies
if (dummyTransform)
{
applyDummyTransforms(fld);
......@@ -956,7 +948,6 @@ void Foam::mapDistribute::distribute
}
//- Reverse distribute data using default commsType.
template<class T>
void Foam::mapDistribute::reverseDistribute
(
......@@ -1013,9 +1004,6 @@ void Foam::mapDistribute::reverseDistribute
}
//- Reverse distribute data using default commsType.
// Since constructSize might be larger than supplied size supply
// a nullValue
template<class T>
void Foam::mapDistribute::reverseDistribute
(
......@@ -1079,7 +1067,6 @@ void Foam::mapDistribute::reverseDistribute
}
//- Distribute data using default commsType.
template<class T, class TransformOp>
void Foam::mapDistribute::distribute
(
......
......@@ -1130,7 +1130,6 @@ Foam::tmp<Foam::scalarField> Foam::polyMesh::movePoints
}
// Reset motion by deleting old points
void Foam::polyMesh::resetMotion() const
{
curMotionTimeIndex_ = 0;
......@@ -1138,7 +1137,6 @@ void Foam::polyMesh::resetMotion() const
}
// Return parallel info
const Foam::globalMeshData& Foam::polyMesh::globalData() const
{
if (globalMeshDataPtr_.empty())
......
......@@ -269,12 +269,6 @@ bool Foam::polyMesh::checkFaceSkewness
}
// Check 1D/2Dness of edges. Gets passed the non-empty directions and
// checks all edges in the mesh whether they:
// - have no component in a non-empty direction or
// - are only in a singe non-empty direction.
// Empty direction info is passed in as a vector of labels (synchronised)
// which are 1 if the direction is non-empty, 0 if it is.
bool Foam::polyMesh::checkEdgeAlignment
(
const pointField& p,
......@@ -283,6 +277,13 @@ bool Foam::polyMesh::checkEdgeAlignment
labelHashSet* setPtr
) const
{
// Check 1D/2Dness of edges. Gets passed the non-empty directions and
// checks all edges in the mesh whether they:
// - have no component in a non-empty direction or
// - are only in a singe non-empty direction.
// Empty direction info is passed in as a vector of labels (synchronised)
// which are 1 if the direction is non-empty, 0 if it is.
if (debug)
{
InfoInFunction << "Checking edge alignment" << endl;
......
......@@ -127,7 +127,6 @@ Foam::labelList Foam::polyMesh::facePatchFaceCells
}
//- Set faces_, calculate cells and patchStarts.
void Foam::polyMesh::setTopology
(
const cellShapeList& cellsAsShapes,
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -104,11 +104,6 @@ Foam::label Foam::oldCyclicPolyPatch::findMaxArea
}
// Get geometric zones of patch by looking at normals.
// Method 1: any edge with sharpish angle is edge between two halves.
// (this will handle e.g. wedge geometries).
// Also two fully disconnected regions will be handled this way.
// Method 2: sort faces into two halves based on face normal.
bool Foam::oldCyclicPolyPatch::getGeometricHalves
(
const primitivePatch& pp,
......@@ -116,6 +111,12 @@ bool Foam::oldCyclicPolyPatch::getGeometricHalves
labelList& half1ToPatch
) const
{