Completed standardisation of the class declaration section comments to correspond to the foamNewSource template

This commit is contained in:
Henry Weller
2019-06-21 22:45:47 +01:00
parent 5dbbac7c86
commit 5c188ddce7
325 changed files with 3038 additions and 2873 deletions

View File

@ -72,15 +72,6 @@ class XiReactionRate
:
public fvMeshFunctionObject
{
// Private Member Functions
//- Disallow default bitwise copy construction
XiReactionRate(const XiReactionRate&) = delete;
//- Disallow default bitwise assignment
void operator=(const XiReactionRate&) = delete;
public:
//- Runtime type information
@ -97,6 +88,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
XiReactionRate(const XiReactionRate&) = delete;
//- Destructor
virtual ~XiReactionRate();
@ -109,6 +103,12 @@ public:
//- Write the cell-centre fields
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const XiReactionRate&) = delete;
};

View File

@ -257,13 +257,6 @@ protected:
void readAveragingProperties();
//- Disallow default bitwise copy construction
fieldAverage(const fieldAverage&) = delete;
//- Disallow default bitwise assignment
void operator=(const fieldAverage&) = delete;
public:
//- Runtime type information
@ -280,6 +273,9 @@ public:
const dictionary&
);
//- Disallow default bitwise copy construction
fieldAverage(const fieldAverage&) = delete;
//- Destructor
virtual ~fieldAverage();
@ -295,6 +291,12 @@ public:
//- Write the field averages
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const fieldAverage&) = delete;
};

View File

@ -76,17 +76,6 @@ protected:
bool foundObject(const word& name);
private:
// Private Member Functions
//- Disallow default bitwise copy construction
fieldExpression(const fieldExpression&) = delete;
//- Disallow default bitwise assignment
void operator=(const fieldExpression&) = delete;
public:
//- Runtime type information
@ -105,6 +94,9 @@ public:
const word& resultName = word::null
);
//- Disallow default bitwise copy construction
fieldExpression(const fieldExpression&) = delete;
//- Destructor
virtual ~fieldExpression();
@ -123,6 +115,12 @@ public:
//- Clear the result field from the objectRegistry
virtual bool clear();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const fieldExpression&) = delete;
};

View File

@ -138,12 +138,6 @@ protected:
const Type& maxValue
);
//- Disallow default bitwise copy construction
fieldMinMax(const fieldMinMax&) = delete;
//- Disallow default bitwise assignment
void operator=(const fieldMinMax&) = delete;
//- Calculate the field min/max
template<class Type>
void calcMinMaxFields
@ -172,6 +166,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
fieldMinMax(const fieldMinMax&) = delete;
//- Destructor
virtual ~fieldMinMax();
@ -187,6 +184,12 @@ public:
//- Write the fieldMinMax
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const fieldMinMax&) = delete;
};

View File

@ -91,17 +91,6 @@ protected:
virtual bool calc() = 0;
private:
// Private Member Functions
//- Disallow default bitwise copy construction
fieldsExpression(const fieldsExpression&) = delete;
//- Disallow default bitwise assignment
void operator=(const fieldsExpression&) = delete;
public:
//- Runtime type information
@ -120,6 +109,9 @@ public:
const word& resultName = word::null
);
//- Disallow default bitwise copy construction
fieldsExpression(const fieldsExpression&) = delete;
//- Destructor
virtual ~fieldsExpression();
@ -138,6 +130,12 @@ public:
//- Clear the result fields from the objectRegistry
virtual bool clear();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const fieldsExpression&) = delete;
};

View File

@ -115,12 +115,6 @@ class histogram
const scalarField& values
) const;
//- Disallow default bitwise copy construction
histogram(const histogram&) = delete;
//- Disallow default bitwise assignment
void operator=(const histogram&) = delete;
public:
@ -138,6 +132,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
histogram(const histogram&) = delete;
// Destructor
virtual ~histogram();
@ -155,6 +152,12 @@ public:
// postProcess overrides the usual writeControl behaviour and
// forces writing always (used in post-processing mode)
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const histogram&) = delete;
};

View File

@ -165,14 +165,6 @@ protected:
) const;
private:
//- Disallow default bitwise copy construction
nearWallFields(const nearWallFields&) = delete;
//- Disallow default bitwise assignment
void operator=(const nearWallFields&) = delete;
public:
//- Runtime type information
@ -190,6 +182,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
nearWallFields(const nearWallFields&) = delete;
//- Destructor
virtual ~nearWallFields();
@ -205,6 +200,12 @@ public:
//- Write the near-wall fields
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const nearWallFields&) = delete;
};

View File

@ -72,15 +72,6 @@ class processorField
:
public fvMeshFunctionObject
{
// Private Member Functions
//- Disallow default bitwise copy construction
processorField(const processorField&) = delete;
//- Disallow default bitwise assignment
void operator=(const processorField&) = delete;
public:
//- Runtime type information
@ -97,6 +88,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
processorField(const processorField&) = delete;
//- Destructor
virtual ~processorField();
@ -112,6 +106,12 @@ public:
//- Write the processorID field
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const processorField&) = delete;
};

View File

@ -112,17 +112,6 @@ protected:
) const;
private:
// Private Member Functions
//- Disallow default bitwise copy construction
readFields(const readFields&) = delete;
//- Disallow default bitwise assignment
void operator=(const readFields&) = delete;
public:
//- Runtime type information
@ -140,6 +129,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
readFields(const readFields&) = delete;
//- Destructor
virtual ~readFields();
@ -155,6 +147,12 @@ public:
//- Do nothing
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const readFields&) = delete;
};

View File

@ -221,12 +221,6 @@ class regionSizeDistribution
const coordSet& coords // graph data for bins
) const;
//- Disallow default bitwise copy construction
regionSizeDistribution(const regionSizeDistribution&) = delete;
//- Disallow default bitwise assignment
void operator=(const regionSizeDistribution&) = delete;
public:
@ -245,6 +239,9 @@ public:
const dictionary&
);
//- Disallow default bitwise copy construction
regionSizeDistribution(const regionSizeDistribution&) = delete;
// Destructor
@ -261,6 +258,12 @@ public:
//- Calculate the regionSizeDistribution and write
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const regionSizeDistribution&) = delete;
};

View File

@ -224,12 +224,6 @@ private:
//- Do all seeding and tracking
void track();
//- Disallow default bitwise copy construction
streamLine(const streamLine&) = delete;
//- Disallow default bitwise assignment
void operator=(const streamLine&) = delete;
public:
@ -247,6 +241,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
streamLine(const streamLine&) = delete;
//- Destructor
virtual ~streamLine();
@ -268,6 +265,12 @@ public:
//- Update for mesh point-motion
virtual void movePoints(const polyMesh&);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const streamLine&) = delete;
};

View File

@ -51,15 +51,6 @@ class streamLineParticleCloud
:
public Cloud<streamLineParticle>
{
// Private Member Functions
//- Disallow default bitwise copy construction
streamLineParticleCloud(const streamLineParticleCloud&) = delete;
//- Disallow default bitwise assignment
void operator=(const streamLineParticleCloud&) = delete;
public:
//- Type of parcel the cloud was instantiated for
@ -82,6 +73,15 @@ public:
const word& cloudName,
const IDLList<streamLineParticle>& particles
);
//- Disallow default bitwise copy construction
streamLineParticleCloud(const streamLineParticleCloud&) = delete;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const streamLineParticleCloud&) = delete;
};

View File

@ -115,17 +115,6 @@ protected:
) const;
private:
// Private Member Functions
//- Disallow default bitwise copy construction
surfaceInterpolate(const surfaceInterpolate&) = delete;
//- Disallow default bitwise assignment
void operator=(const surfaceInterpolate&) = delete;
public:
//- Runtime type information
@ -143,6 +132,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
surfaceInterpolate(const surfaceInterpolate&) = delete;
//- Destructor
virtual ~surfaceInterpolate();
@ -158,6 +150,12 @@ public:
//- Write the interpolated fields
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const surfaceInterpolate&) = delete;
};

View File

@ -163,17 +163,6 @@ protected:
tmp<volScalarField> omega(const Model& model) const;
private:
// Private Member Functions
//- Disallow default bitwise copy construction
turbulenceFields(const turbulenceFields&) = delete;
//- Disallow default bitwise assignment
void operator=(const turbulenceFields&) = delete;
public:
//- Runtime type information
@ -190,6 +179,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
turbulenceFields(const turbulenceFields&) = delete;
//- Destructor
virtual ~turbulenceFields();
@ -206,6 +198,12 @@ public:
//- Do nothing.
// The turbulence fields are registered and written automatically
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const turbulenceFields&) = delete;
};

View File

@ -108,12 +108,6 @@ class turbulenceIntensity
//- File header information
virtual void writeFileHeader(const label i);
//- Disallow default bitwise copy construction
turbulenceIntensity(const turbulenceIntensity&) = delete;
//- Disallow default bitwise assignment
void operator=(const turbulenceIntensity&) = delete;
public:
@ -131,6 +125,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
turbulenceIntensity(const turbulenceIntensity&) = delete;
//- Destructor
virtual ~turbulenceIntensity();
@ -146,6 +143,12 @@ public:
//- Write the turbulenceIntensity field
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const turbulenceIntensity&) = delete;
};

View File

@ -115,17 +115,6 @@ protected:
);
private:
// Private Member Functions
//- Disallow default bitwise copy construction
wallHeatFlux(const wallHeatFlux&) = delete;
//- Disallow default bitwise assignment
void operator=(const wallHeatFlux&) = delete;
public:
//- Runtime type information
@ -142,6 +131,9 @@ public:
const dictionary&
);
//- Disallow default bitwise copy construction
wallHeatFlux(const wallHeatFlux&) = delete;
//- Destructor
virtual ~wallHeatFlux();
@ -157,6 +149,12 @@ public:
//- Write the wall heat-flux
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const wallHeatFlux&) = delete;
};

View File

@ -137,17 +137,6 @@ protected:
);
private:
// Private Member Functions
//- Disallow default bitwise copy construction
wallHeatTransferCoeff(const wallHeatTransferCoeff&) = delete;
//- Disallow default bitwise assignment
void operator=(const wallHeatTransferCoeff&) = delete;
public:
//- Runtime type information
@ -164,6 +153,9 @@ public:
const dictionary&
);
//- Disallow default bitwise copy construction
wallHeatTransferCoeff(const wallHeatTransferCoeff&) = delete;
//- Destructor
virtual ~wallHeatTransferCoeff();
@ -179,6 +171,12 @@ public:
//- Write the wall heat transfer coefficient
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const wallHeatTransferCoeff&) = delete;
};

View File

@ -123,17 +123,6 @@ protected:
);
private:
// Private Member Functions
//- Disallow default bitwise copy construction
wallShearStress(const wallShearStress&) = delete;
//- Disallow default bitwise assignment
void operator=(const wallShearStress&) = delete;
public:
//- Runtime type information
@ -150,6 +139,9 @@ public:
const dictionary&
);
//- Disallow default bitwise copy construction
wallShearStress(const wallShearStress&) = delete;
//- Destructor
virtual ~wallShearStress();
@ -165,6 +157,12 @@ public:
//- Write the wall shear-stress
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const wallShearStress&) = delete;
};

View File

@ -72,15 +72,6 @@ class writeCellCentres
:
public fvMeshFunctionObject
{
// Private Member Functions
//- Disallow default bitwise copy construction
writeCellCentres(const writeCellCentres&) = delete;
//- Disallow default bitwise assignment
void operator=(const writeCellCentres&) = delete;
public:
//- Runtime type information
@ -97,6 +88,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
writeCellCentres(const writeCellCentres&) = delete;
//- Destructor
virtual ~writeCellCentres();
@ -109,6 +103,12 @@ public:
//- Write the cell-centre fields
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const writeCellCentres&) = delete;
};

View File

@ -71,15 +71,6 @@ class writeCellVolumes
:
public fvMeshFunctionObject
{
// Private Member Functions
//- Disallow default bitwise copy construction
writeCellVolumes(const writeCellVolumes&) = delete;
//- Disallow default bitwise assignment
void operator=(const writeCellVolumes&) = delete;
public:
//- Runtime type information
@ -96,6 +87,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
writeCellVolumes(const writeCellVolumes&) = delete;
//- Destructor
virtual ~writeCellVolumes();
@ -108,6 +102,12 @@ public:
//- Write the cell-centre fields
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const writeCellVolumes&) = delete;
};

View File

@ -100,12 +100,6 @@ class yPlus
const turbulenceModel& turbModel
);
//- Disallow default bitwise copy construction
yPlus(const yPlus&) = delete;
//- Disallow default bitwise assignment
void operator=(const yPlus&) = delete;
public:
@ -123,6 +117,9 @@ public:
const dictionary& dict
);
//- Disallow default bitwise copy construction
yPlus(const yPlus&) = delete;
//- Destructor
virtual ~yPlus();
@ -138,6 +135,12 @@ public:
//- Write the yPlus field
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const yPlus&) = delete;
};