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

Updated and simplified the Doxygen documentation

Browse Source
This commit is contained in:
Henry Weller
2016-06-20 21:20:28 +01:00
parent 9321273c26
commit cf89a3094a
40 changed files with 1858 additions and 2113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C
View File

@ -957,7 +957,7 @@ Foam::DistributedDelaunayMesh<Triangulation>::rangeInsertReferredWithInfo
}
else if (lt == Triangulation::OUTSIDE_CONVEX_HULL)
{
// @todo Can this be optimised?
// TODO: Can this be optimised?
//
// Only want to insert if a connection is formed between
// pointToInsert and an internal or internal boundary point.

4
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C
View File

@ -1434,7 +1434,7 @@ Foam::labelList Foam::backgroundMeshDecomposition::overlapProcessors
//// map().distribute(testCentres);
//// map().distribute(testRadiusSqrs);
//
// // @todo This is faster, but results in more vertices being referred
// // TODO: This is faster, but results in more vertices being referred
// boolList sphereOverlapsCandidate(testCentres.size(), true);
//// boolList sphereOverlapsCandidate(testCentres.size(), false);
////
@ -1551,7 +1551,7 @@ Foam::labelList Foam::backgroundMeshDecomposition::overlapProcessors
// map().distribute(testCentres);
// map().distribute(testRadiusSqrs);
//
// // @todo This is faster, but results in more vertices being referred
// // TODO: This is faster, but results in more vertices being referred
//// boolList sphereOverlapsCandidate(testCentres.size(), true);
// boolList sphereOverlapsCandidate(testCentres.size(), false);
//

2
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C
View File

@ -746,7 +746,7 @@ Foam::label Foam::cellShapeControlMesh::estimateCellCount
{
if (!cit->hasFarPoint() && !is_infinite(cit))
{
// @todo Check if tet centre is on the processor..
// TODO: Check if tet centre is on the processor..
CGAL::Tetrahedron_3<baseK> tet
(
cit->vertex(0)->point(),

6
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C
View File

@ -31,7 +31,7 @@ License
namespace Foam
{
defineTypeNameAndDebug(controlMeshRefinement, 0);
defineTypeNameAndDebug(controlMeshRefinement, 0);
}
// * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
@ -396,7 +396,7 @@ void Foam::controlMeshRefinement::initialMeshPopulation
<< ", alignment difference = " << alignmentDiff << endl;
}
// @todo Also need to base it on the alignments
// TODO: Also need to base it on the alignments
if
(
sizeDiff/interpolatedCellSize > 0.1
@ -561,7 +561,7 @@ void Foam::controlMeshRefinement::initialMeshPopulation
Info<< " size difference = " << sizeDiff << endl;
}
// @todo Also need to base it on the alignments
// TODO: Also need to base it on the alignments
if (sizeDiff/interpolatedCellSize > 0.1)
{
insertPoint = true;

4
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C
View File

@ -104,7 +104,7 @@ bool Foam::conformalVoronoiMesh::reconformToSurface() const
}
// @todo Investigate topological tests
// TODO: Investigate topological tests
Foam::label Foam::conformalVoronoiMesh::findVerticesNearBoundaries()
{
label countNearBoundaryVertices = 0;
@ -1732,7 +1732,7 @@ bool Foam::conformalVoronoiMesh::nearSurfacePoint
const scalar cosAngle =
angleBetweenSurfacePoints(pt, closePoint.hitPoint());
// @todo make this tolerance run-time selectable?
// TODO: make this tolerance run-time selectable?
if (cosAngle < searchAngleOppositeSurface)
{
pointIndexHit pCloseHit;

2
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C
View File

@ -91,7 +91,7 @@ Foam::triSurfaceMeshFeatures::features() const
surfaceFeatures sFeat(surfMesh, includedAngle_);
// @todo Need to read on a per region basis
// TODO: Need to read on a per region basis
boolList surfBaffleRegions
(
surfMesh.patches().size(),

2
applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C
View File

@ -97,7 +97,7 @@ void Foam::CV2D::insertFeaturePoints()
}
// Args: (base point, normal)
// @todo allow user to input this
// TODO: allow user to input this
plane zPlane(vector(0, 0, z_), vector(0, 0, 1));
if (debug)