Commit 66cb99e6 authored by Henry's avatar Henry
Browse files

Updated headers to ensure the class name declared to Doxygen is in the appropriate namespace

Also moved global classes which should be in the Foam namespace into it.
parent 4a1fb55c
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
adjointOutletPressureFvPatchScalarField
Foam::adjointOutletPressureFvPatchScalarField
Description
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
adjointOutletVelocityFvPatchVectorField
Foam::adjointOutletVelocityFvPatchVectorField
Description
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
incompressibleThreePhaseMixture
Foam::incompressibleThreePhaseMixture
Description
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
threePhaseInterfaceProperties
Foam::threePhaseInterfaceProperties
Description
Properties to aid interFoam :
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void sammMesh::calcPointCells() const
void Foam::sammMesh::calcPointCells() const
{
static const label UNIT_POINT_CELLS = 12;
......@@ -125,7 +125,7 @@ void sammMesh::calcPointCells() const
}
const labelListList& sammMesh::pointCells() const
const Foam::labelListList& Foam::sammMesh::pointCells() const
{
if (!pointCellsPtr_)
{
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,9 +30,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Specialist version of face comparison to deal with
// PROSTAR boundary format idiosyncracies
bool sammMesh::sammEqualFace
bool Foam::sammMesh::sammEqualFace
(
const face& boundaryFace,
const face& cellFace
......@@ -70,7 +68,7 @@ bool sammMesh::sammEqualFace
}
void sammMesh::createBoundaryFaces()
void Foam::sammMesh::createBoundaryFaces()
{
forAll(boundary_, patchI)
{
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -31,7 +31,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void sammMesh::createPolyBoundary()
void Foam::sammMesh::createPolyBoundary()
{
label nBoundaryFacesFound = 0;
......@@ -115,7 +115,10 @@ void sammMesh::createPolyBoundary()
}
List<polyPatch* > sammMesh::polyBoundaryPatches(const polyMesh& pMesh)
Foam::List<Foam::polyPatch* > Foam::sammMesh::polyBoundaryPatches
(
const polyMesh& pMesh
)
{
List<polyPatch* > p(boundary_.size());
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void sammMesh::createPolyCells()
void Foam::sammMesh::createPolyCells()
{
// loop through all cell faces and create connectivity. This will produce
// a global face list and will describe all cells as lists of face labels
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -23,15 +23,11 @@ License
\*---------------------------------------------------------------------------*/
#include "error.H"
#include "sammMesh.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
void sammMesh::fillSammAddressingTable()
void Foam::sammMesh::fillSammAddressingTable()
{
// SAMM trim type 1: 8 models
static label SammTrim1Rot0[10] = {1, 5, 6, 2, 8, 10, 4, 7, 3, 9};
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -26,16 +26,11 @@ Description
\*---------------------------------------------------------------------------*/
#include "error.H"
#include "sammMesh.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
void sammMesh::fillSammCellShapeTable()
void Foam::sammMesh::fillSammCellShapeTable()
{
// Fill the list by hand
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void sammMesh::fixCollapsedEdges()
void Foam::sammMesh::fixCollapsedEdges()
{
cellFaces_.setSize(cellShapes_.size());
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
void sammMesh::purgeCellShapes()
void Foam::sammMesh::purgeCellShapes()
{
forAll(cellFaces_, cellI)
{
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -36,7 +36,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void sammMesh::readBoundary()
void Foam::sammMesh::readBoundary()
{
label nPatches=0, nFaces=0;
labelList nPatchFaces(1000);
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -31,7 +31,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void sammMesh::addRegularCell
void Foam::sammMesh::addRegularCell
(
const labelList& labels,
const label nCreatedCells
......@@ -135,7 +135,7 @@ void sammMesh::addRegularCell
}
void sammMesh::addSAMMcell
void Foam::sammMesh::addSAMMcell
(
const label typeFlag,
const labelList& globalLabels,
......@@ -171,7 +171,7 @@ void sammMesh::addSAMMcell
}
void sammMesh::readCells()
void Foam::sammMesh::readCells()
{
label nCells = 0;
label maxLabel = -1;
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -31,7 +31,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void sammMesh::readCouples()
void Foam::sammMesh::readCouples()
{
fileName couplesFileName(casePrefix_ + ".cpl");
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -31,21 +31,33 @@ License
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
// Cell shape models
const cellModel* sammMesh::unknownPtr_ = cellModeller::lookup("unknown");
const cellModel* sammMesh::hexPtr_ = cellModeller::lookup("hex");
const cellModel* sammMesh::wedgePtr_ = cellModeller::lookup("wedge");
const cellModel* sammMesh::prismPtr_ = cellModeller::lookup("prism");
const cellModel* sammMesh::pyrPtr_ = cellModeller::lookup("pyr");
const cellModel* sammMesh::tetPtr_ = cellModeller::lookup("tet");
const cellModel* sammMesh::tetWedgePtr_ = cellModeller::lookup("tetWedge");
const cellModel* sammMesh::sammTrim1Ptr_ = cellModeller::lookup("sammTrim1");
const cellModel* sammMesh::sammTrim2Ptr_ = cellModeller::lookup("sammTrim2");
const cellModel* sammMesh::sammTrim3Ptr_ = cellModeller::lookup("sammTrim3");
const cellModel* sammMesh::sammTrim4Ptr_ = cellModeller::lookup("sammTrim4");
const cellModel* sammMesh::sammTrim5Ptr_ = cellModeller::lookup("sammTrim5");
const cellModel* sammMesh::sammTrim8Ptr_ =
cellModeller::lookup("hexagonalPrism");
const Foam::cellModel* Foam::sammMesh::unknownPtr_ =
Foam::cellModeller::lookup("unknown");
const Foam::cellModel* Foam::sammMesh::hexPtr_ =
Foam::cellModeller::lookup("hex");
const Foam::cellModel* Foam::sammMesh::wedgePtr_ =
Foam::cellModeller::lookup("wedge");
const Foam::cellModel* Foam::sammMesh::prismPtr_ =
Foam::cellModeller::lookup("prism");
const Foam::cellModel* Foam::sammMesh::pyrPtr_ =
Foam::cellModeller::lookup("pyr");
const Foam::cellModel* Foam::sammMesh::tetPtr_ =
Foam::cellModeller::lookup("tet");
const Foam::cellModel* Foam::sammMesh::tetWedgePtr_ =
Foam::cellModeller::lookup("tetWedge");
const Foam::cellModel* Foam::sammMesh::sammTrim1Ptr_ =
Foam::cellModeller::lookup("sammTrim1");
const Foam::cellModel* Foam::sammMesh::sammTrim2Ptr_ =
Foam::cellModeller::lookup("sammTrim2");
const Foam::cellModel* Foam::sammMesh::sammTrim3Ptr_ =
Foam::cellModeller::lookup("sammTrim3");
const Foam::cellModel* Foam::sammMesh::sammTrim4Ptr_ =
Foam::cellModeller::lookup("sammTrim4");
const Foam::cellModel* Foam::sammMesh::sammTrim5Ptr_ =
Foam::cellModeller::lookup("sammTrim5");
const Foam::cellModel* Foam::sammMesh::sammTrim8Ptr_ =
Foam::cellModeller::lookup("hexagonalPrism");
// lookup table giving OpenFOAM face number when looked up with shape index
// (first index) and STAR face number
......@@ -59,7 +71,7 @@ const cellModel* sammMesh::sammTrim8Ptr_ =
// However, at the moment I haven't got enough info to complete the toble and
// there are no cases that break it. Please reconsider in the light of mode
// information.
const label sammMesh::shapeFaceLookup[19][9] =
const Foam::label Foam::sammMesh::shapeFaceLookup[19][9] =
{
{-1, -1, -1, -1, -1, -1, -1, -1, -1}, // shape 0 - empty+
{-1, -1, -1, -1, -1, -1, -1, -1, -1}, // shape 1 - empty+
......@@ -87,22 +99,22 @@ const label sammMesh::shapeFaceLookup[19][9] =
// List of pointers used instead of pointer list o avoid
// de-allocation problems
List<const cellModel*> sammMesh::sammShapeLookup
Foam::List<const Foam::cellModel*> Foam::sammMesh::sammShapeLookup
(
256,
reinterpret_cast<cellModel*>(0)
);
List<const label*> sammMesh::sammAddressingTable
Foam::List<const Foam::label*> Foam::sammMesh::sammAddressingTable
(
256,
reinterpret_cast<label*>(0)
);
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Make polyhedral mesh data (packing)
void sammMesh::createPolyMeshData()
void Foam::sammMesh::createPolyMeshData()
{
Info<< "Creating a polyMesh" << endl;
......@@ -146,10 +158,10 @@ void sammMesh::createPolyMeshData()
}
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct from components
sammMesh::sammMesh
Foam::sammMesh::sammMesh
(
const fileName& prefix,
const Time& rt,
......@@ -199,13 +211,10 @@ sammMesh::sammMesh
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
sammMesh::~sammMesh()
Foam::sammMesh::~sammMesh()
{
deleteDemandDrivenData(pointCellsPtr_);
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// ************************************************************************* //
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -42,14 +42,10 @@ SourceFiles
#include "cellList.H"
#include "polyPatchList.H"
#ifndef namespaceFoam
#define namespaceFoam
using namespace Foam;
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Forward declaration of classes
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class sammMesh Declaration
......@@ -224,9 +220,6 @@ class sammMesh
public:
// Static data members
// Constructors
//- Construct from case name
......@@ -246,17 +239,12 @@ public:
//- Write mesh
void writeMesh();
};
// Member Operators
// Friend Functions
// Friend Operators
// IOstream Operators
// Ostream Operator
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -33,6 +33,8 @@ Description
#include "Time.H"
#include "sammMesh.H"
using namespace Foam;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
int main(int argc, char *argv[])
......@@ -55,7 +57,7 @@ int main(int argc, char *argv[])
const scalar scaleFactor = args.optionLookupOrDefault("scale", 1.0);
# include "createTime.H"
#include "createTime.H"
sammMesh makeMesh(args[1], runTime, scaleFactor);
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -32,7 +32,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void sammMesh::writeMesh()
void Foam::sammMesh::writeMesh()
{
if (isShapeMesh_)
{
......
......@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -30,7 +30,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void starMesh::calcPointCells() const
void Foam::starMesh::calcPointCells() const
{
static const label UNIT_POINT_CELLS = 12;
......@@ -125,7 +125,7 @@ void starMesh::calcPointCells() const
}
const labelListList& starMesh::pointCells() const
const Foam::labelListList& Foam::starMesh::pointCells() const
{
if (!pointCellsPtr_)
{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment