Commit 67a2effe authored by Henry's avatar Henry
Browse files

Doxygen: Updated lists in member documentation to conform to Doxygen limitations

parent 3c56a952
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -90,7 +90,8 @@ fileName cwd();
// else return false
bool chDir(const fileName& dir);
//- Search for @em name in the following hierarchy:
//- Search for @em name
// in the following hierarchy:
// -# personal settings:
// - ~/.OpenFOAM/\<VERSION\>/
// <em>for version-specific files</em>
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -122,6 +122,7 @@ public:
inline linePointRef line(const pointField&) const;
//- compare edges
// Returns:
// - 0: different
// - +1: identical
// - -1: same edge, but different orientation
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -307,6 +307,7 @@ public:
inline edge faceEdge(const label n) const;
//- Return the edge direction on the face
// Returns:
// - 0: edge not found on the face
// - +1: forward (counter-clockwise) on the face
// - -1: reverse (clockwise) on the face
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -201,12 +201,14 @@ public:
inline edge faceEdge(const label n) const;
//- Return the edge direction on the face
// Returns:
// - +1: forward (counter-clockwise) on the face
// - -1: reverse (clockwise) on the face
// - 0: edge not found on the face
inline int edgeDirection(const edge&) const;
//- compare triFaces
// Returns:
// - 0: different
// - +1: identical
// - -1: same face, but different orientation
......
......@@ -509,7 +509,8 @@ public:
// Other
//- Helper for merging mesh point data. Determines
//- Helper for merging mesh point data.
// Determines:
// - my unique indices
// - global numbering over all unique indices
// - the global number for all local points (so this will
......@@ -520,7 +521,8 @@ public:
labelList& uniquePoints
) const;
//- Helper for merging patch point data. Takes maps from
//- Helper for merging patch point data.
// Takes maps from:
// local points to/from mesh. Determines
// - my unique points. These are mesh points, not patch points
// since the master might not be on the patch.
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -415,6 +415,7 @@ public:
// Check
//- Calculate surface type formed by patch.
// Types:
// - all edges have two neighbours (manifold)
// - some edges have more than two neighbours (illegal)
// - other (open)
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -134,7 +134,8 @@ public:
}
//- compare Pairs
//- Compare Pairs
// Returning:
// - 0: different
// - +1: identical
// - -1: same pair, but reversed order
......
......@@ -65,9 +65,10 @@ public:
// Public classes
//- Less function class used in sorting encoded transforms and indices
// - minimum processor
// - minimum local index
// - minimum transform
// Minimum of:
// - processor
// - local index
// - transform
class less
{
public:
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -281,7 +281,8 @@ public:
// Point merging
//- Find topologically&geometrically shared points.
//- Find topologically and geometrically shared points.
//
// - should only be called for parallel correct mesh
// (since uses mesh.globalData)
// - returns Map from point to master point (all in mesh point
......@@ -293,6 +294,7 @@ public:
);
//- Helper: Merge points.
//
// - Gets map from point to destination point
// - Removes all points that don't map to themselves
// - Modifies all faces that use the points to be removed.
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -382,6 +382,7 @@ public:
) const;
//- Like consistentRefinement but slower:
//
// - specify number of cells between consecutive refinement levels
// (consistentRefinement equivalent to 1)
// - specify max level difference between point-connected cells.
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -36,14 +36,11 @@ License
namespace Foam
{
defineTypeNameAndDebug(removeCells, 0);
defineTypeNameAndDebug(removeCells, 0);
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Remove count of elements of f.
void Foam::removeCells::uncount
(
const labelList& f,
......@@ -59,7 +56,6 @@ void Foam::removeCells::uncount
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct from mesh
Foam::removeCells::removeCells
(
const polyMesh& mesh,
......@@ -73,10 +69,6 @@ Foam::removeCells::removeCells
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
//- Get labels of exposed faces. These are
// - internal faces that become boundary faces
// - coupled faces that become uncoupled (since on of the sides
// gets deleted)
Foam::labelList Foam::removeCells::getExposedFaces
(
const labelList& cellLabels
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -94,7 +94,8 @@ public:
// Topology changes
//- Get labels of exposed faces. These are
//- Get labels of exposed faces.
// These are
// - internal faces that become boundary faces
// - coupled faces that become uncoupled (since one of the sides
// gets deleted)
......@@ -114,7 +115,6 @@ public:
//- Force recalculation of locally stored data on topological change
void updateMesh(const mapPolyMesh&)
{}
};
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -178,7 +178,8 @@ public:
// Member Functions
//- Given set of faces to pierce calculates:
//- Find faces including those with cells which have the same mastercell
// Given set of faces to pierce calculates:
// - region for connected cells
// - mastercell for each region. This is the lowest numbered cell
// of all cells that get merged.
......
......@@ -26,7 +26,6 @@ Class
Description
Cone injection
- User specifies
- time of start of injection
- injector position
......
......@@ -26,7 +26,6 @@ Class
Description
Cone injection multi-point
- User specifies
- time of start of injection
- injector positions
......
......@@ -26,7 +26,6 @@ Class
Description
Manual injection
- User specifies
- Total mass to inject
- Parcel positions in file @c positionsFile
......
......@@ -26,7 +26,6 @@ Class
Description
Patch injection
- User specifies
- Total mass to inject
- Name of patch
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -130,18 +130,21 @@ public:
inline label end() const;
//- Compare the given start and end points with this curve
// Return:
// - 0: different
// - +1: identical
// - -1: same edge, but different orientation
inline int compare(const curvedEdge&) const;
//- Compare the given start and end points with this curve
// Return:
// - 0: different
// - +1: identical
// - -1: same edge, but different orientation
inline int compare(const edge&) const;
//- Compare the given start and end points with this curve
// Return:
// - 0: different
// - +1: identical
// - -1: same edge, but different orientation
......@@ -159,6 +162,7 @@ public:
void operator=(const curvedEdge&);
// Ostream operator
friend Ostream& operator<<(Ostream&, const curvedEdge&);
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -107,6 +107,7 @@ public:
//- Helper class for finding nearest
// Nearest:
// - point+local index
// - sqr(distance)
// - processor
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -511,7 +511,8 @@ public:
// Queries
//- Calculate nearest point on nearest shape. Returns
//- Calculate nearest point on nearest shape.
// Returns
// - bool : any point found nearer than nearestDistSqr
// - label: index in shapes
// - point: actual nearest point found
......@@ -532,7 +533,8 @@ public:
point& nearestPoint
) const;
//- Find nearest to line. Returns
//- Find nearest to line.
// Returns
// - bool : any point found?
// - label: index in shapes
// - point: actual nearest point found
......@@ -621,10 +623,10 @@ public:
bool write(Ostream& os) const;
// IOstream Operators
friend Ostream& operator<< <Type>(Ostream&, const indexedOctree<Type>&);
};
......
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