OpenFOAM-dev / data /src /finiteVolume /fvMesh /wallDist /patchDistMethods /meshWave /meshWavePatchDistMethod.H
| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation | |
| \\/ M anipulation | | |
| ------------------------------------------------------------------------------- | |
| License | |
| This file is part of OpenFOAM. | |
| OpenFOAM is free software: you can redistribute it and/or modify it | |
| under the terms of the GNU General Public License as published by | |
| the Free Software Foundation, either version 3 of the License, or | |
| (at your option) any later version. | |
| OpenFOAM is distributed in the hope that it will be useful, but WITHOUT | |
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| for more details. | |
| You should have received a copy of the GNU General Public License | |
| along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. | |
| Class | |
| Foam::patchDistMethods::meshWave | |
| Description | |
| Fast topological mesh-wave method for calculating the distance to nearest | |
| patch for all cells and boundary. | |
| For regular/un-distorted meshes this method is accurate but for skewed, | |
| non-orthogonal meshes it is approximate with the error increasing with the | |
| degree of mesh distortion. The distance from the near-wall cells to the | |
| boundary may optionally be corrected for mesh distortion by setting a | |
| number of correction iterations. | |
| Example of the wallDist specification in fvSchemes: | |
| \verbatim | |
| wallDist | |
| { | |
| method meshWave; | |
| // Number of corrections | |
| nCorrectors 3; | |
| // Optional entry enabling the calculation | |
| // of the normal-to-wall field | |
| nRequired false; | |
| } | |
| \endverbatim | |
| See also | |
| Foam::patchDistMethod::Poisson | |
| Foam::wallDist | |
| SourceFiles | |
| meshWavePatchDistMethod.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| namespace patchDistMethods | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class meshWave Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class meshWave | |
| : | |
| public patchDistMethod | |
| { | |
| // Private Data | |
| //- Do accurate distance calculation for near-wall cells. | |
| const label nCorrectors_; | |
| //- Minimum fraction of a poly face considered to be a valid location | |
| // from which to measure distance | |
| const scalar minFaceFraction_; | |
| public: | |
| //- Runtime type information | |
| TypeName("meshWave"); | |
| // Constructors | |
| //- Construct from coefficients dictionary, mesh | |
| // and fixed-value patch set | |
| meshWave | |
| ( | |
| const dictionary& dict, | |
| const fvMesh& mesh, | |
| const labelHashSet& patchIDs | |
| ); | |
| //- Construct from mesh, fixed-value patch set, and number of wall | |
| // correction iterations | |
| meshWave | |
| ( | |
| const fvMesh& mesh, | |
| const labelHashSet& patchIDs, | |
| const label nCorrectors = 2, | |
| const scalar minFaceFraction = 1e-1 | |
| ); | |
| //- Disallow default bitwise copy construction | |
| meshWave(const meshWave&) = delete; | |
| // Member Functions | |
| //- Correct the given distance-to-patch field | |
| virtual bool correct(volScalarField& y); | |
| //- Correct the given distance-to-patch and normal-to-patch fields | |
| virtual bool correct(volScalarField& y, volVectorField& n); | |
| // Member Operators | |
| //- Disallow default bitwise assignment | |
| void operator=(const meshWave&) = delete; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace patchDistMethods | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |