STYLE: trailing whitespace, doxygen, error messages from fileOperation

This commit is contained in:
Mark Olesen 2017-12-13 17:56:34 +01:00
parent 0af97856f1
commit bc8420e14f
33 changed files with 65 additions and 102 deletions

View File

@ -36,7 +36,7 @@ namespace Foam
namespace dragModels
{
defineTypeNameAndDebug(GidaspowErgunWenYu, 0);
addToRunTimeSelectionTable(dragModel, GidaspowErgunWenYu, dictionary);
addToRunTimeSelectionTable(dragModel, GidaspowErgunWenYu, dictionary);
}
}

View File

@ -1,5 +1,5 @@
EXE_INC = \
-I$(LIB_SRC)/finiteVolume/lnInclude
-I$(LIB_SRC)/finiteVolume/lnInclude
EXE_LIBS = \
-lfiniteVolume \

View File

@ -1,16 +1,13 @@
#!/bin/bash
#!/bin/sh
#------------------------------------------------------------------------------
# Script
# find-trailingspace
# git-find-trailingspace
#
# Description
# Search for files with trailing whitesapce
# Use git grep to search for files with trailing whitespace
#
#------------------------------------------------------------------------------
cd $WM_PROJECT_DIR || exit 1
tab=$'\t'
git grep -c -E "[ $tab]+"'$' -- $@
git grep -c -P '\s+$' -- $@
#------------------------------------------------------------------------------

View File

@ -1,15 +0,0 @@
Misc. tools for finding and/or repairing common documentation problems
See the comments in the scripts.
1. find-suspiciousTags
2. fix-Class
3. find-tinyDescription
4. find-placeholderDescription
5. find-retagged
Misc Tools
1. find-templateInComments
2. find-its
3. find-junkFiles
4. find-longlines

View File

@ -227,12 +227,6 @@ Foam::fileOperations::collatedFileOperation::collatedFileOperation
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::fileOperations::collatedFileOperation::~collatedFileOperation()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
Foam::fileName Foam::fileOperations::collatedFileOperation::objectPath

View File

@ -99,7 +99,7 @@ public:
//- Destructor
virtual ~collatedFileOperation();
virtual ~collatedFileOperation() = default;
// Member Functions

View File

@ -54,10 +54,10 @@ namespace Foam
false
)
);
word fileOperation::processorsDir = "processors";
}
Foam::word Foam::fileOperation::processorsDir = "processors";
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
@ -143,30 +143,25 @@ bool Foam::fileOperation::isFileOrDir(const bool isFile, const fileName& f)
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::fileOperation::fileOperation()
{}
Foam::autoPtr<Foam::fileOperation> Foam::fileOperation::New
(
const word& type,
const word& handlerType,
const bool verbose
)
{
if (debug)
{
InfoInFunction << "Constructing fileOperation" << endl;
InfoInFunction << "Constructing fileHandler" << endl;
}
wordConstructorTable::iterator cstrIter =
wordConstructorTablePtr_->find(type);
auto cstrIter = wordConstructorTablePtr_->cfind(handlerType);
if (cstrIter == wordConstructorTablePtr_->end())
if (!cstrIter.found())
{
FatalErrorInFunction
<< "Unknown fileOperation type "
<< type << nl << nl
<< "Valid fileOperation types are" << endl
<< "Unknown fileHandler type "
<< handlerType << nl << nl
<< "Valid fileHandler types :" << endl
<< wordConstructorTablePtr_->sortedToc()
<< abort(FatalError);
}
@ -175,12 +170,6 @@ Foam::autoPtr<Foam::fileOperation> Foam::fileOperation::New
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::fileOperation::~fileOperation()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
Foam::fileName Foam::fileOperation::objectPath
@ -278,10 +267,8 @@ Foam::fileName Foam::fileOperation::filePath(const fileName& fName) const
{
return fName;
}
else
{
return fileName::null;
}
return fileName::null;
}

View File

@ -24,6 +24,15 @@ License
Class
Foam::fileOperation
Description
An encapsulation of filesystem-related operations.
Namespace
Foam::fileOperations
Description
Namespace for implementations of a fileOperation
\*---------------------------------------------------------------------------*/
#ifndef fileOperation_H
@ -75,7 +84,7 @@ public:
// Static data
//- Return the processors directory name (usually "processors")
//- The processors directory name (usually "processors")
static word processorsDir;
//- Default fileHandler
@ -108,7 +117,7 @@ public:
// Constructors
//- Construct null
fileOperation();
fileOperation() = default;
// Declare run-time constructor selection table
@ -127,12 +136,16 @@ public:
// Selectors
//- Select type
static autoPtr<fileOperation> New(const word& type, const bool verbose);
//- Select fileHandler-type
static autoPtr<fileOperation> New
(
const word& handlerType,
const bool verbose
);
//- Destructor
virtual ~fileOperation();
virtual ~fileOperation() = default;
// Member Functions

View File

@ -489,13 +489,6 @@ masterUncollatedFileOperation
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::fileOperations::masterUncollatedFileOperation::
~masterUncollatedFileOperation()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::fileOperations::masterUncollatedFileOperation::mkDir

View File

@ -427,7 +427,7 @@ public:
//- Destructor
virtual ~masterUncollatedFileOperation();
virtual ~masterUncollatedFileOperation() = default;
// Member Functions

View File

@ -161,12 +161,6 @@ Foam::fileOperations::uncollatedFileOperation::uncollatedFileOperation
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::fileOperations::uncollatedFileOperation::~uncollatedFileOperation()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::fileOperations::uncollatedFileOperation::mkDir

View File

@ -77,7 +77,7 @@ public:
//- Destructor
virtual ~uncollatedFileOperation();
virtual ~uncollatedFileOperation() = default;
// Member Functions

View File

@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation | Copyright (C) 2016 OpenCFD Ltd.
\\/ M anipulation | Copyright (C) 2016 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.

View File

@ -89,7 +89,7 @@ tmp<volScalarField> kOmegaSSTDDES<BasicTurbulenceModel>::dTilda
return max
(
lRAS
lRAS
- fd(magGradU)
*max
(

View File

@ -153,7 +153,7 @@ void Foam::porosityModelList::addResistance
(
const fvVectorMatrix& UEqn,
volTensorField& AU,
bool correctAUprocBC
bool correctAUprocBC
)
{
forAll(*this, i)

View File

@ -44,7 +44,7 @@ Description
entered in the same form as the timeVaryingMappedFixedValue condition,
except that no interpolation in time is supported. These should be
located in the directory:
\$FOAM_CASE/constant/boundaryData/<patchName>/points
\$FOAM_CASE/constant/boundaryData/<patchName>/0/\{R|U|L\}

View File

@ -25,7 +25,7 @@ Class
Foam::displacementComponentLaplacianFvMotionSolver
Group
grpMeshMotionSolvers
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre

View File

@ -25,7 +25,7 @@ Class
Foam::velocityComponentLaplacianFvMotionSolver
Group
grpMeshMotionSolvers
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre

View File

@ -25,7 +25,7 @@ Class
Foam::displacementSBRStressFvMotionSolver
Group
grpMeshMotionSolvers
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre

View File

@ -25,7 +25,7 @@ Class
Foam::displacementLaplacianFvMotionSolver
Group
grpMeshMotionSolvers
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre

View File

@ -25,7 +25,7 @@ Class
Foam::surfaceAlignedSBRStressFvMotionSolver
Group
grpMeshMotionSolvers
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre

View File

@ -25,7 +25,7 @@ Class
Foam::velocityLaplacianFvMotionSolver
Group
grpMeshMotionSolvers
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre

View File

@ -57,7 +57,7 @@ void Foam::fv::acousticDampingSource::setBlendingFactor()
const vectorField& Cf = mesh_.C();
const scalar pi = constant::mathematical::pi;
forAll(cells_, i)
{
label celli = cells_[i];

View File

@ -40,24 +40,24 @@ Description
To provide a Joule heating contribution according to:
Differential form of Joule heating - power per unit volume:
\f[
\frac{d(P)}{d(V)} = J \cdot E
\f]
where \f$ J \f$ is the current density and \f$ E \f$ the electric field.
If no magnetic field is present:
\f[
J = \sigma E
\f]
The electric field given by
\f[
E = \grad V
\f]
Therefore:
\f[
@ -79,7 +79,7 @@ Usage
sigma table
(
(273 1e5)
(1000 1e5)
(1000 1e5)
);
}
\endverbatim

View File

@ -84,7 +84,7 @@ Foam::TimeScaleModels::isotropic::oneByTau
static const scalar a =
8.0*sqrt(2.0)/(5.0*constant::mathematical::pi)
*0.25*(3.0 - e_)*(1.0 + e_);
return a*f*alphaPacked_/max(alphaPacked_ - alpha, SMALL);
}

View File

@ -4608,7 +4608,7 @@ void Foam::snappyLayerDriver::doLayers
if (!preBalance)
{
// Check if there are faceZones on processor boundaries. This
// requires balancing to move them off the processor boundaries.
// requires balancing to move them off the processor boundaries.
// Is face on a faceZone
PackedBoolList isExtrudedZoneFace(mesh.nFaces());

View File

@ -52,7 +52,7 @@ Hanning::Hanning(const dictionary& dict, const label nSamples)
// Extend range if required
label offset = extended_ ? 1 : 0;
scalar m = nSamples - 1 + 2*offset;
scalarField t(nSamples);
forAll(t, i)
{

View File

@ -333,7 +333,7 @@ void reactingOneDim::solveEnergy()
NOTE: The moving mesh option is only correct for reaction such as
Solid -> Gas, thus the ddt term is compesated exaclty by chemistrySh and
the mesh flux is not necessary.
if (regionMesh().moving())
{
surfaceScalarField phihMesh

View File

@ -26,7 +26,7 @@ Class
Group
grpRigidBodyDynamicsJoints
Description
Revolute joint for rotation about the z-axis

View File

@ -25,7 +25,7 @@ Class
Foam::rigidBodyMeshMotion
Group
grpMeshMotionSolvers
grpMeshMotionSolvers
Description
Rigid-body mesh motion solver for fvMesh.

View File

@ -25,7 +25,7 @@ Class
Foam::sixDoFRigidBodyMotionSolver
Group
grpMeshMotionSolvers
grpMeshMotionSolvers
Description
6-DoF solid-body mesh motion solver for an fvMesh.

View File

@ -153,7 +153,7 @@ bool Foam::functionObjects::specieReactionRates<ChemistryModelType>::write()
}
file() << nl << endl;
return true;
}

View File

@ -81,7 +81,7 @@ Description
- A scalar transport equation for the carrier specie is required, e.g.
supplied via a function object or in the main solver. This specie
transports the vapour phase in the main ragion.
- The boundary condition of this specie on the coupled wall must be
- The boundary condition of this specie on the coupled wall must be
fixedGradient in order to allow condensation or evaporation of the
vapour in or out of this wall