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

This commit is contained in:
Henry Weller
2019-06-19 15:01:35 +01:00
parent 4d297126d9
commit 213319ae30
165 changed files with 933 additions and 772 deletions

View File

@ -56,15 +56,6 @@ class ensightAsciiStream
OFstream str_;
// Private Member Functions
//- Disallow default bitwise copy construction
ensightAsciiStream(const ensightAsciiStream&) = delete;
//- Disallow default bitwise assignment
void operator=(const ensightAsciiStream&) = delete;
public:
// Constructors
@ -86,6 +77,9 @@ public:
str_.precision(5);
}
//- Disallow default bitwise copy construction
ensightAsciiStream(const ensightAsciiStream&) = delete;
//- Destructor
virtual ~ensightAsciiStream()
@ -139,14 +133,11 @@ public:
<< setw(10) << partI << nl;
}
// Member Operators
// Friend Functions
// Friend Operators
// IOstream Operators
//- Disallow default bitwise assignment
void operator=(const ensightAsciiStream&) = delete;
};

View File

@ -55,15 +55,6 @@ class ensightBinaryStream
autoPtr<std::ofstream> str_;
// Private Member Functions
//- Disallow default bitwise copy construction
ensightBinaryStream(const ensightBinaryStream&) = delete;
//- Disallow default bitwise assignment
void operator=(const ensightBinaryStream&) = delete;
public:
// Constructors
@ -82,6 +73,9 @@ public:
)
{}
//- Disallow default bitwise copy construction
ensightBinaryStream(const ensightBinaryStream&) = delete;
//- Destructor
virtual ~ensightBinaryStream()
@ -141,14 +135,11 @@ public:
write(partI);
}
// Member Operators
// Friend Functions
// Friend Operators
// IOstream Operators
//- Disallow default bitwise assignment
void operator=(const ensightBinaryStream&) = delete;
};

View File

@ -139,12 +139,6 @@ private:
// Private Member Functions
//- Disallow default bitwise copy construction
ensightMesh(const ensightMesh&) = delete;
//- Disallow default bitwise assignment
void operator=(const ensightMesh&) = delete;
void writePoints
(
const scalarField& pointsComponent,
@ -270,6 +264,9 @@ public:
const bool binary
);
//- Disallow default bitwise copy construction
ensightMesh(const ensightMesh&) = delete;
//- Destructor
~ensightMesh();
@ -378,6 +375,11 @@ public:
Ostream& ensightCaseFile
) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const ensightMesh&) = delete;
};

View File

@ -54,14 +54,6 @@ class ensightStream
const fileName name_;
// Private Member Functions
//- Disallow default bitwise copy construction
ensightStream(const ensightStream&) = delete;
//- Disallow default bitwise assignment
void operator=(const ensightStream&) = delete;
public:
@ -73,6 +65,9 @@ public:
name_(f)
{}
//- Disallow default bitwise copy construction
ensightStream(const ensightStream&) = delete;
//- Destructor
virtual ~ensightStream()
@ -99,7 +94,10 @@ public:
virtual void writePartHeader(const label) = 0;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const ensightStream&) = delete;
};

View File

@ -63,18 +63,6 @@ class vtkMesh
//- Current cellSet (or empty)
const word setName_;
// //- Current decomposition of topology
// mutable autoPtr<vtkTopo> topoPtr_;
// Private Member Functions
//- Disallow default bitwise copy construction
vtkMesh(const vtkMesh&) = delete;
//- Disallow default bitwise assignment
void operator=(const vtkMesh&) = delete;
public:
@ -84,6 +72,9 @@ public:
//- Construct from components
vtkMesh(fvMesh& baseMesh, const word& setName = "");
//- Disallow default bitwise copy construction
vtkMesh(const vtkMesh&) = delete;
// Member Functions
@ -106,16 +97,6 @@ public:
return setName_.size();
}
// //- topology
// const vtkTopo& topo() const
// {
// if (topoPtr_.empty())
// {
// topoPtr_.reset(new vtkTopo(mesh()));
// }
// return topoPtr_();
// }
//- Access either mesh or submesh
const fvMesh& mesh() const
{
@ -129,18 +110,6 @@ public:
}
}
// //- Number of field cells
// label nFieldCells() const
// {
// return topo().vertLabels().size();
// }
//
// //- Number of field points
// label nFieldPoints() const
// {
// return mesh().nPoints() + topo().addPointCellLabels().size();
// }
// Edit
@ -164,6 +133,12 @@ public:
return fld;
}
}
// Member Operators
//- Disallow default bitwise assignment
void operator=(const vtkMesh&) = delete;
};

View File

@ -68,16 +68,6 @@ class vtkMesh
mutable autoPtr<vtkTopo> topoPtr_;
// Private Member Functions
//- Disallow default bitwise copy construction
vtkMesh(const vtkMesh&) = delete;
//- Disallow default bitwise assignment
void operator=(const vtkMesh&) = delete;
public:
// Constructors
@ -85,6 +75,9 @@ public:
//- Construct from components
vtkMesh(fvMesh& baseMesh, const word& setName = "");
//- Disallow default bitwise copy construction
vtkMesh(const vtkMesh&) = delete;
// Member Functions
@ -165,6 +158,12 @@ public:
return fld;
}
}
// Member Operators
//- Disallow default bitwise assignment
void operator=(const vtkMesh&) = delete;
};

View File

@ -66,15 +66,6 @@ class vtkTopo
labelList superCells_;
// Private Member Functions
//- Disallow default bitwise copy construction
vtkTopo(const vtkTopo&) = delete;
//- Disallow default bitwise assignment
void operator=(const vtkTopo&) = delete;
public:
// Public static data
@ -102,6 +93,10 @@ public:
//- Construct from components
vtkTopo(const polyMesh&);
//- Disallow default bitwise copy construction
vtkTopo(const vtkTopo&) = delete;
// Member Functions
// Access
@ -125,6 +120,12 @@ public:
{
return superCells_;
}
// Member Operators
//- Disallow default bitwise assignment
void operator=(const vtkTopo&) = delete;
};

View File

@ -92,12 +92,6 @@ class writeVTK
template<class GeoField>
UPtrList<const GeoField> lookupFields() const;
//- Disallow default bitwise copy construction
writeVTK(const writeVTK&) = delete;
//- Disallow default bitwise assignment
void operator=(const writeVTK&) = delete;
public:
@ -115,6 +109,9 @@ public:
const dictionary&
);
//- Disallow default bitwise copy construction
writeVTK(const writeVTK&) = delete;
//- Destructor
virtual ~writeVTK();
@ -130,6 +127,12 @@ public:
//- Write the writeVTK
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const writeVTK&) = delete;
};

View File

@ -63,6 +63,7 @@ class vtkPVFoamReader
public vtkMultiBlockDataSetAlgorithm
{
public:
vtkTypeMacro(vtkPVFoamReader, vtkMultiBlockDataSetAlgorithm);
void PrintSelf(ostream&, vtkIndent);
@ -181,6 +182,9 @@ protected:
//- Construct null
vtkPVFoamReader();
//- Disallow default bitwise copy construction
vtkPVFoamReader(const vtkPVFoamReader&) = delete;
//- Destructor
~vtkPVFoamReader();
@ -209,15 +213,12 @@ protected:
//- The file name for this case
char* FileName;
private:
//- Disallow default bitwise copy construction
vtkPVFoamReader(const vtkPVFoamReader&) = delete;
//- Disallow default bitwise assignment
void operator=(const vtkPVFoamReader&) = delete;
private:
//- Add/remove patch names to/from the view
void updatePatchNamesView(const bool show);

View File

@ -113,6 +113,9 @@ protected:
//- Construct null
vtkPVblockMeshReader();
//- Disallow default bitwise copy construction
vtkPVblockMeshReader(const vtkPVblockMeshReader&) = delete;
//- Destructor
~vtkPVblockMeshReader();
@ -140,15 +143,12 @@ protected:
char* FileName;
private:
//- Disallow default bitwise copy construction
vtkPVblockMeshReader(const vtkPVblockMeshReader&) = delete;
//- Disallow default bitwise assignment
void operator=(const vtkPVblockMeshReader&) = delete;
private:
//- Add/remove point numbers to/from the view
void updatePointNumbersView(const bool show);

View File

@ -666,13 +666,6 @@ class vtkPVFoam
word getPartName(const int);
//- Disallow default bitwise copy construction
vtkPVFoam(const vtkPVFoam&) = delete;
//- Disallow default bitwise assignment
void operator=(const vtkPVFoam&) = delete;
public:
//- Static data members
@ -689,6 +682,9 @@ public:
vtkPVFoamReader* reader
);
//- Disallow default bitwise copy construction
vtkPVFoam(const vtkPVFoam&) = delete;
//- Destructor
~vtkPVFoam();
@ -736,6 +732,12 @@ public:
//- Simple memory used debugging information
static void printMemory();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const vtkPVFoam&) = delete;
};

View File

@ -293,13 +293,6 @@ class vtkPVblockMesh
);
//- Disallow default bitwise copy construction
vtkPVblockMesh(const vtkPVblockMesh&) = delete;
//- Disallow default bitwise assignment
void operator=(const vtkPVblockMesh&) = delete;
public:
//- Static data members
@ -316,6 +309,9 @@ public:
vtkPVblockMeshReader* reader
);
//- Disallow default bitwise copy construction
vtkPVblockMesh(const vtkPVblockMesh&) = delete;
//- Destructor
~vtkPVblockMesh();
@ -339,6 +335,11 @@ public:
//- Debug information
void PrintSelf(ostream&, vtkIndent) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const vtkPVblockMesh&) = delete;
};

View File

@ -45,7 +45,6 @@ SourceFiles
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class channelIndex Declaration
\*---------------------------------------------------------------------------*/
@ -93,10 +92,6 @@ class channelIndex
const labelList& startFaces
);
//- Disallow default bitwise copy construct and assignment
channelIndex(const channelIndex&) = delete;
void operator=(const channelIndex&);
public:
@ -114,6 +109,9 @@ public:
const direction dir
);
//- Disallow default bitwise copy construction
channelIndex(const channelIndex&) = delete;
// Member Functions
@ -137,6 +135,11 @@ public:
return y_;
}
// Member Operators
//- Disallow default bitwise assignment
void operator=(const channelIndex&);
};