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: add compile-time deprecated message for face/triangle normal()

Browse Source 
- in 1812 propagated through the distinction between areaNormal and
  unitNormal (issue #885).

  In older versions, the normal() always meant the area-normal for
  certain of these primitive.

  However, the .org version changed this to now return the unit-normal
  instead, but with the same method name. Thus add the deprecated
  message to avoid future inadvertent uses of normal() without being
  certain which one is being meant.
This commit is contained in:
Mark Olesen
2019-01-09 10:32:25 +01:00
parent 2067014079
commit c350a127cd
3 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/OpenFOAM/meshes/meshShapes/face/face.H
View File

@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | Copyright (C) 2017-2018 OpenCFD Ltd. \\/ M anipulation | Copyright (C) 2017-2019 OpenCFD Ltd.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
@ -201,6 +201,7 @@ public:
//- Legacy name for areaNormal() //- Legacy name for areaNormal()
// \deprecated(2018-06) Deprecated for new use // \deprecated(2018-06) Deprecated for new use
inline vector normal(const UList<point>& p) const inline vector normal(const UList<point>& p) const
FOAM_DEPRECATED_FOR(2018-12, "areaNormal() or unitNormal()")
{ {
return areaNormal(p); // Legacy definition return areaNormal(p); // Legacy definition
} }

3
src/OpenFOAM/meshes/meshShapes/triFace/triFace.H
View File

@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | Copyright (C) 2017-2018 OpenCFD Ltd. \\/ M anipulation | Copyright (C) 2017-2019 OpenCFD Ltd.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
@ -132,6 +132,7 @@ public:
//- Legacy name for areaNormal() //- Legacy name for areaNormal()
// \deprecated(2018-06) Deprecated for new use // \deprecated(2018-06) Deprecated for new use
inline vector normal(const UList<point>& points) const inline vector normal(const UList<point>& points) const
FOAM_DEPRECATED_FOR(2018-12, "areaNormal() or unitNormal()")
{ {
return areaNormal(points); // Legacy definition return areaNormal(points); // Legacy definition
} }

3
src/OpenFOAM/meshes/primitiveShapes/triangle/triangle.H
View File

@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\/ M anipulation | Copyright (C) 2018 OpenCFD Ltd. \\/ M anipulation | Copyright (C) 2018-2019 OpenCFD Ltd.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
@ -215,6 +215,7 @@ public:
//- Legacy name for areaNormal(). //- Legacy name for areaNormal().
// \deprecated(2018-06) Deprecated for new use // \deprecated(2018-06) Deprecated for new use
inline vector normal() const inline vector normal() const
FOAM_DEPRECATED_FOR(2018-12, "areaNormal() or unitNormal()")
{ {
return areaNormal(); return areaNormal();
} }