zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: fix namespace documentation for CGAL-related content

Browse Source
This commit is contained in:
Mark Olesen
2019-07-30 18:15:48 +02:00
committed by Andrew Heather
parent 1b4b127af5
commit 5382c2f590
5 changed files with 46 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMeshTools/DelaunayMeshTools.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd |
\\ / A nd | Copyright (C) 2019 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
| Copyright (C) 2013-2016 OpenFOAM Foundation
@ -23,12 +23,13 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Namespace
Foam::DelaunayMeshTools
Description
Collection of functions for operating on a Delaunay mesh. Includes:
Collection of functions for operating on a Delaunay mesh.
Includes:
- Functions for writing to an OBJ file
- Functions for extracting fields from the Delaunay triangulation

8
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/indexedCell/indexedCellChecks.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd |
\\ / A nd | Copyright (C) 2019 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
| Copyright (C) 2012-2016 OpenFOAM Foundation
@ -23,6 +23,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Namespace
Foam::foamyHexMeshChecks
Description
Collection of checks for foamyHexMesh
\*---------------------------------------------------------------------------*/
#ifndef indexedCellChecks_H

1
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/indexedCell/indexedCellOps.H
View File

@ -27,6 +27,7 @@ Namespace
CGAL::indexedCellOps
Description
Operations for indexed cell types
SourceFiles
indexedCellOpsTemplates.C

1
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/indexedVertex/indexedVertexOps.H
View File

@ -27,6 +27,7 @@ Namespace
CGAL::indexedVertexOps
Description
Operations for indexed vertex types
SourceFiles
indexedVertexOpsTemplates.C

33
applications/utilities/mesh/generation/foamyMesh/foamyMesh.dox Normal file
View File

@ -0,0 +1,33 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2019 OpenCFD Ltd.
\\/ 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/>.
Namespace
CGAL
Description
Specializations for CGAL-related routines.
\*---------------------------------------------------------------------------*/
// ************************************************************************* //