zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Standardised the class declaration section comments to correspond to the foamNewSource template

Browse Source
This commit is contained in:
Henry Weller
2019-06-13 21:26:33 +01:00
parent 47d19548c1
commit 8e9f692aa4
1863 changed files with 3798 additions and 3970 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/functionObjects/field/CourantNo/CourantNo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -59,7 +59,7 @@ class CourantNo
:
public fieldExpression
{
// Private data
// Private Data
//- Name of flux field, default is "phi"
word phiName_;

2
src/functionObjects/field/XiReactionRate/XiReactionRate.H
View File

@ -72,7 +72,7 @@ class XiReactionRate
:
public fvMeshFunctionObject
{
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
XiReactionRate(const XiReactionRate&) = delete;

4
src/functionObjects/field/age/age.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -90,7 +90,7 @@ class age
:
public fvMeshFunctionObject
{
// Private data
// Private Data
//- The name of the flux field
word phiName_;

2
src/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItem.H
View File

@ -98,7 +98,7 @@ public:
private:
// Private data
// Private Data
//- Field name
word fieldName_;

4
src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -115,7 +115,7 @@ public:
private:
// Private data
// Private Data
//- Operation to apply to values
operationType operation_;

2
src/functionObjects/field/histogram/histogram.H
View File

@ -86,7 +86,7 @@ class histogram
:
public fvMeshFunctionObject
{
// Private data
// Private Data
writeFile file_;

4
src/functionObjects/field/interfaceHeight/interfaceHeight.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -80,7 +80,7 @@ class interfaceHeight
public fvMeshFunctionObject,
public logFiles
{
// Private data
// Private Data
//- Name of the alpha field
word alphaName_;

4
src/functionObjects/field/log/log.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -59,7 +59,7 @@ class log
:
public fieldExpression
{
// Private data
// Private Data
//- Optional clip (default is 0)
scalar clip_;

6
src/functionObjects/field/nearWallFields/findCellParticle.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -61,7 +61,7 @@ class findCellParticle
:
public particle
{
// Private data
// Private Data
//- Displacement over which to track
vector displacement_;
@ -99,7 +99,7 @@ public:
{}
// Member functions
// Member Functions
labelListList& cellToData()
{

4
src/functionObjects/field/pressure/pressure.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -132,7 +132,7 @@ class pressure
:
public fieldExpression
{
// Private data
// Private Data
//- Name of velocity field, default is "U"
word UName_;

2
src/functionObjects/field/processorField/processorField.H
View File

@ -72,7 +72,7 @@ class processorField
:
public fvMeshFunctionObject
{
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
processorField(const processorField&) = delete;

2
src/functionObjects/field/readFields/readFields.H
View File

@ -114,7 +114,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
readFields(const readFields&) = delete;

2
src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
View File

@ -131,7 +131,7 @@ class regionSizeDistribution
:
public fvMeshFunctionObject
{
// Private data
// Private Data
writeFile file_;

4
src/functionObjects/field/scale/scale.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -58,7 +58,7 @@ class scale
:
public fieldExpression
{
// Private data
// Private Data
//- Scale factor
scalar scale_;

2
src/functionObjects/field/streamLine/streamLine.H
View File

@ -149,7 +149,7 @@ public:
private:
// Private data
// Private Data
//- Input dictionary
dictionary dict_;

4
src/functionObjects/field/streamLine/streamLineParticle.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -123,7 +123,7 @@ public:
private:
// Private data
// Private Data
//- Lifetime of particle. Particle dies when reaches 0.
label lifeTime_;

2
src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H
View File

@ -117,7 +117,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
surfaceInterpolate(const surfaceInterpolate&) = delete;

2
src/functionObjects/field/turbulenceFields/turbulenceFields.H
View File

@ -165,7 +165,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
turbulenceFields(const turbulenceFields&) = delete;

2
src/functionObjects/field/wallHeatFlux/wallHeatFlux.H
View File

@ -117,7 +117,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
wallHeatFlux(const wallHeatFlux&) = delete;

2
src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeff.H
View File

@ -139,7 +139,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
wallHeatTransferCoeff(const wallHeatTransferCoeff&) = delete;

2
src/functionObjects/field/wallShearStress/wallShearStress.H
View File

@ -125,7 +125,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
wallShearStress(const wallShearStress&) = delete;

2
src/functionObjects/field/writeCellCentres/writeCellCentres.H
View File

@ -72,7 +72,7 @@ class writeCellCentres
:
public fvMeshFunctionObject
{
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
writeCellCentres(const writeCellCentres&) = delete;

2
src/functionObjects/field/writeCellVolumes/writeCellVolumes.H
View File

@ -71,7 +71,7 @@ class writeCellVolumes
:
public fvMeshFunctionObject
{
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
writeCellVolumes(const writeCellVolumes&) = delete;

2
src/functionObjects/forces/forceCoeffs/forceCoeffs.H
View File

@ -106,7 +106,7 @@ class forceCoeffs
:
public forces
{
// Private data
// Private Data
// Force coefficient geometry

2
src/functionObjects/lagrangian/cloudInfo/cloudInfo.H
View File

@ -98,7 +98,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
cloudInfo(const cloudInfo&) = delete;

2
src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H
View File

@ -118,7 +118,7 @@ class icoUncoupledKinematicCloud
basicKinematicCollidingCloud kinematicCloud_;
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
icoUncoupledKinematicCloud(const icoUncoupledKinematicCloud&) = delete;

2
src/functionObjects/solvers/phaseScalarTransport/phaseScalarTransport.H
View File

@ -116,7 +116,7 @@ class phaseScalarTransport
:
public fvMeshFunctionObject
{
// Private data
// Private Data
//- Name of field to process
const word fieldName_;

2
src/functionObjects/solvers/scalarTransport/scalarTransport.H
View File

@ -70,7 +70,7 @@ class scalarTransport
:
public fvMeshFunctionObject
{
// Private data
// Private Data
//- Name of field to process
word fieldName_;

2
src/functionObjects/utilities/abort/abort.H
View File

@ -73,7 +73,7 @@ public:
private:
// Private data
// Private Data
//- Reference to the Time
const Time& time_;

4
src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
View File

@ -78,7 +78,7 @@ class removeRegisteredObject
:
public functionObject
{
// Private data
// Private Data
//- Reference to the objectRegistry
const objectRegistry& obr_;
@ -87,7 +87,7 @@ class removeRegisteredObject
wordList objectNames_;
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
removeRegisteredObject(const removeRegisteredObject&) = delete;

2
src/functionObjects/utilities/residuals/residuals.H
View File

@ -103,7 +103,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
residuals(const residuals&) = delete;

4
src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H
View File

@ -57,7 +57,7 @@ class setTimeStepFunctionObject
:
public functionObject
{
// Private data
// Private Data
//- Reference to the time database
const Time& time_;
@ -66,7 +66,7 @@ class setTimeStepFunctionObject
autoPtr<Function1<scalar>> timeStepPtr_;
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
setTimeStepFunctionObject(const setTimeStepFunctionObject&) = delete;

4
src/functionObjects/utilities/systemCall/systemCall.H
View File

@ -103,7 +103,7 @@ class systemCall
{
protected:
// Private data
// Private Data
//- List of calls to execute - every step
stringList executeCalls_;
@ -117,7 +117,7 @@ protected:
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
systemCall(const systemCall&) = delete;

2
src/functionObjects/utilities/time/timeFunctionObject.H
View File

@ -87,7 +87,7 @@ class time
scalar clockTime0_;
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
time(const time&) = delete;

2
src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H
View File

@ -78,7 +78,7 @@ class timeActivatedFileUpdate
:
public functionObject
{
// Private data
// Private Data
//- Reference to Time
const Time& time_;

4
src/functionObjects/utilities/writeDictionary/writeDictionary.H
View File

@ -58,7 +58,7 @@ class writeDictionary
:
public functionObject
{
// Private data
// Private Data
//- Reference to the database
const objectRegistry& obr_;
@ -83,7 +83,7 @@ class writeDictionary
private:
// Private member functions
// Private Member Functions
//- Disallow default bitwise copy construction
writeDictionary(const writeDictionary&) = delete;

2
src/functionObjects/utilities/writeObjects/writeObjects.H
View File

@ -118,7 +118,7 @@ public:
private:
// Private data
// Private Data
//- To only write objects of defined writeOption
writeOption writeOption_;