snappyHexMesh: Corrected code documentation

Patch contributed by Bruno Santos
Resolves contribution request https://bugs.openfoam.org/view.php?id=3794
This commit is contained in:
Henry Weller
2022-01-27 11:14:15 +00:00
parent 4b914573eb
commit bc32409e6b
3 changed files with 19 additions and 19 deletions

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -707,7 +707,7 @@ Foam::label Foam::meshRefinement::markInternalDistanceToFeatureRefinement
const labelList& cellLevel = meshCutter_.cellLevel();
const pointField& cellCentres = mesh_.cellCentres();
// Detect if there are any distance shells
// Detect if there are any distance features
if (features_.maxDistance() <= 0.0)
{
return 0;
@ -730,7 +730,7 @@ Foam::label Foam::meshRefinement::markInternalDistanceToFeatureRefinement
}
}
// Do test to see whether cells is inside/outside shell with higher level
// Do test to see whether cells are in/near features with higher level
labelList maxLevel;
features_.findHigherLevel(testCc, testLevels, maxLevel);
@ -2086,7 +2086,7 @@ Foam::labelList Foam::meshRefinement::refineCandidates
// Cells pierced by feature lines
// Cells pierced by feature edges
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
if (featureRefinement)
@ -2104,12 +2104,12 @@ Foam::labelList Foam::meshRefinement::refineCandidates
<< ": " << nFeatures << " cells." << endl;
}
// Inside distance-to-feature shells
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Inside distance-to-feature
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
if (featureDistanceRefinement)
{
const label nShell = markInternalDistanceToFeatureRefinement
const label nCellsFeat = markInternalDistanceToFeatureRefinement
(
nAllowRefine,
@ -2117,7 +2117,7 @@ Foam::labelList Foam::meshRefinement::refineCandidates
nRefine
);
Info<< "Marked for refinement due to distance to explicit features "
": " << nShell << " cells." << endl;
": " << nCellsFeat << " cells." << endl;
}
// Inside refinement shells

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -295,7 +295,7 @@ void Foam::refinementFeatures::buildTrees(const label feati)
}
// Find maximum level of a shell.
// Find maximum level of a feature edge.
void Foam::refinementFeatures::findHigherLevel
(
const pointField& pt,
@ -308,8 +308,8 @@ void Foam::refinementFeatures::findHigherLevel
const scalarField& distances = distances_[feati];
// Collect all those points that have a current maxLevel less than
// (any of) the shell. Also collect the furthest distance allowable
// to any shell with a higher level.
// (any of) the feature edge. Also collect the furthest distance allowable
// to any feature edge with a higher level.
pointField candidates(pt.size());
labelList candidateMap(pt.size());
@ -361,7 +361,7 @@ void Foam::refinementFeatures::findHigherLevel
label pointi = candidateMap[candidatei];
// pt is in between shell[minDistI] and shell[minDistI+1]
// pt is in between feature[minDistI] and feature[minDistI+1]
maxLevel[pointi] = levels[minDistI+1];
}
}
@ -747,7 +747,7 @@ void Foam::refinementFeatures::findHigherLevel
labelList& maxLevel
) const
{
// Maximum level of any shell. Start off with level of point.
// Maximum level of any feature edge. Start off with level of point.
maxLevel = ptLevel;
forAll(*this, feati)

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,10 +55,10 @@ class refinementFeatures
{
// Private Data
//- Per shell the list of ranges
//- Per feature the list of ranges
List<scalarField> distances_;
//- Per shell per distance the refinement level
//- Per feature per distance the refinement level
labelListList levels_;
//- Edge
@ -80,7 +80,7 @@ class refinementFeatures
//- Build edge tree and feature point tree
void buildTrees(const label);
//- Find shell level higher than ptLevel
//- Find feature level higher than ptLevel
void findHigherLevel
(
const pointField& pt,
@ -184,7 +184,7 @@ public:
List<pointIndexHit>& nearInfo
) const;
//- Find shell level higher than ptLevel
//- Find feature level higher than ptLevel
void findHigherLevel
(
const pointField& pt,