From baf0cc2a78b0bf3ddc5ec78b9aebc4f0193d0b23 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Mon, 27 May 2019 10:33:08 +0200
Subject: [PATCH] STYLE: relocate deprecation scripts and coding guide to wiki
content
- reduces installation clutter, allows easier cross-referencing
- remove older deprecated scripts (foamDebugSwitches, foamGraph*)
---
bin/Co | 1 -
bin/Lambda2 | 1 -
bin/Mach | 1 -
bin/Pe | 1 -
bin/Q | 1 -
bin/R | 1 -
bin/createTurbulenceFields | 1 -
bin/deprecated/Co | 41 --
bin/deprecated/Lambda2 | 1 -
bin/deprecated/Mach | 41 --
bin/deprecated/Pe | 41 --
bin/deprecated/Q | 1 -
bin/deprecated/R | 1 -
bin/deprecated/createTurbulenceFields | 42 --
bin/deprecated/enstrophy | 1 -
bin/deprecated/execFlowFunctionObjects | 42 --
bin/deprecated/flowType | 1 -
bin/deprecated/foamCalc | 39 --
bin/deprecated/foamDebugSwitches | 39 --
bin/deprecated/foamGraphExecTime | 54 --
bin/deprecated/foamGraphResKE | 66 ---
bin/deprecated/foamGraphResUVWP | 66 ---
bin/deprecated/patchAverage | 39 --
bin/deprecated/patchIntegrate | 39 --
bin/deprecated/probeLocations | 41 --
bin/deprecated/ptot | 41 --
bin/deprecated/sample | 45 --
bin/deprecated/streamFunction | 1 -
bin/deprecated/stressComponents | 41 --
bin/deprecated/supercededByPostProcess | 39 --
bin/deprecated/supercededByPostProcessOption | 42 --
bin/deprecated/vorticity | 1 -
bin/deprecated/wallGradU | 39 --
bin/deprecated/wallHeatFlux | 1 -
bin/deprecated/wallShearStress | 1 -
bin/deprecated/wdot | 39 --
bin/deprecated/writeCellCentres | 1 -
bin/deprecated/yPlus | 1 -
bin/enstrophy | 1 -
bin/execFlowFunctionObjects | 1 -
bin/flowType | 1 -
bin/foamCalc | 1 -
bin/foamGraphExecTime | 1 -
bin/foamGraphResKE | 1 -
bin/foamGraphResUVWP | 1 -
bin/patchAverage | 1 -
bin/patchIntegrate | 1 -
bin/probeLocations | 1 -
bin/ptot | 1 -
bin/sample | 1 -
bin/streamFunction | 1 -
bin/stressComponents | 1 -
bin/vorticity | 1 -
bin/wallGradU | 1 -
bin/wallHeatFlux | 1 -
bin/wallShearStress | 1 -
bin/wdot | 1 -
bin/writeCellCentres | 1 -
bin/yPlus | 1 -
doc/codingStyleGuide.org | 539 -------------------
60 files changed, 1454 deletions(-)
delete mode 120000 bin/Co
delete mode 120000 bin/Lambda2
delete mode 120000 bin/Mach
delete mode 120000 bin/Pe
delete mode 120000 bin/Q
delete mode 120000 bin/R
delete mode 120000 bin/createTurbulenceFields
delete mode 100755 bin/deprecated/Co
delete mode 120000 bin/deprecated/Lambda2
delete mode 100755 bin/deprecated/Mach
delete mode 100755 bin/deprecated/Pe
delete mode 120000 bin/deprecated/Q
delete mode 120000 bin/deprecated/R
delete mode 100755 bin/deprecated/createTurbulenceFields
delete mode 120000 bin/deprecated/enstrophy
delete mode 100755 bin/deprecated/execFlowFunctionObjects
delete mode 120000 bin/deprecated/flowType
delete mode 100755 bin/deprecated/foamCalc
delete mode 100755 bin/deprecated/foamDebugSwitches
delete mode 100755 bin/deprecated/foamGraphExecTime
delete mode 100755 bin/deprecated/foamGraphResKE
delete mode 100755 bin/deprecated/foamGraphResUVWP
delete mode 100755 bin/deprecated/patchAverage
delete mode 100755 bin/deprecated/patchIntegrate
delete mode 100755 bin/deprecated/probeLocations
delete mode 100755 bin/deprecated/ptot
delete mode 100755 bin/deprecated/sample
delete mode 120000 bin/deprecated/streamFunction
delete mode 100755 bin/deprecated/stressComponents
delete mode 100755 bin/deprecated/supercededByPostProcess
delete mode 100755 bin/deprecated/supercededByPostProcessOption
delete mode 120000 bin/deprecated/vorticity
delete mode 100755 bin/deprecated/wallGradU
delete mode 120000 bin/deprecated/wallHeatFlux
delete mode 120000 bin/deprecated/wallShearStress
delete mode 100755 bin/deprecated/wdot
delete mode 120000 bin/deprecated/writeCellCentres
delete mode 120000 bin/deprecated/yPlus
delete mode 120000 bin/enstrophy
delete mode 120000 bin/execFlowFunctionObjects
delete mode 120000 bin/flowType
delete mode 120000 bin/foamCalc
delete mode 120000 bin/foamGraphExecTime
delete mode 120000 bin/foamGraphResKE
delete mode 120000 bin/foamGraphResUVWP
delete mode 120000 bin/patchAverage
delete mode 120000 bin/patchIntegrate
delete mode 120000 bin/probeLocations
delete mode 120000 bin/ptot
delete mode 120000 bin/sample
delete mode 120000 bin/streamFunction
delete mode 120000 bin/stressComponents
delete mode 120000 bin/vorticity
delete mode 120000 bin/wallGradU
delete mode 120000 bin/wallHeatFlux
delete mode 120000 bin/wallShearStress
delete mode 120000 bin/wdot
delete mode 120000 bin/writeCellCentres
delete mode 120000 bin/yPlus
delete mode 100644 doc/codingStyleGuide.org
diff --git a/bin/Co b/bin/Co
deleted file mode 120000
index e575b13fb58..00000000000
--- a/bin/Co
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/Co
\ No newline at end of file
diff --git a/bin/Lambda2 b/bin/Lambda2
deleted file mode 120000
index 14361924c1d..00000000000
--- a/bin/Lambda2
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/Lambda2
\ No newline at end of file
diff --git a/bin/Mach b/bin/Mach
deleted file mode 120000
index a780ea0a91c..00000000000
--- a/bin/Mach
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/Mach
\ No newline at end of file
diff --git a/bin/Pe b/bin/Pe
deleted file mode 120000
index 78e3ff2dc66..00000000000
--- a/bin/Pe
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/Pe
\ No newline at end of file
diff --git a/bin/Q b/bin/Q
deleted file mode 120000
index a0ae7b33e18..00000000000
--- a/bin/Q
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/Q
\ No newline at end of file
diff --git a/bin/R b/bin/R
deleted file mode 120000
index cde1a96978c..00000000000
--- a/bin/R
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/R
\ No newline at end of file
diff --git a/bin/createTurbulenceFields b/bin/createTurbulenceFields
deleted file mode 120000
index 008ddca6e97..00000000000
--- a/bin/createTurbulenceFields
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/createTurbulenceFields
\ No newline at end of file
diff --git a/bin/deprecated/Co b/bin/deprecated/Co
deleted file mode 100755
index c29f870fb68..00000000000
--- a/bin/deprecated/Co
+++ /dev/null
@@ -1,41 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# Co
-#
-# Description
-# Script to suggest using the new "-postProcess" solver option.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the -postProcess solver option:"
-echo "<solverName> -func CourantNo"
-echo "e.g."
-echo "pimpleFoam -postProcess -func CourantNo"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/Lambda2 b/bin/deprecated/Lambda2
deleted file mode 120000
index 7b00da8e40e..00000000000
--- a/bin/deprecated/Lambda2
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcess
\ No newline at end of file
diff --git a/bin/deprecated/Mach b/bin/deprecated/Mach
deleted file mode 100755
index 9854d354f79..00000000000
--- a/bin/deprecated/Mach
+++ /dev/null
@@ -1,41 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# Mach
-#
-# Description
-# Script to suggest using the new "-postProcess" solver option.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the -postProcess solver option:"
-echo "<solverName> -func MachNo"
-echo "e.g."
-echo "sonicFoam -postProcess -func MachNo"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/Pe b/bin/deprecated/Pe
deleted file mode 100755
index ca7d1c155fe..00000000000
--- a/bin/deprecated/Pe
+++ /dev/null
@@ -1,41 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# Pe
-#
-# Description
-# Script to suggest using the new "-postProcess" solver option.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the -postProcess solver option:"
-echo "<solverName> -func PecletNo"
-echo "e.g."
-echo "pimpleFoam -postProcess -func PecletNo"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/Q b/bin/deprecated/Q
deleted file mode 120000
index 7b00da8e40e..00000000000
--- a/bin/deprecated/Q
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcess
\ No newline at end of file
diff --git a/bin/deprecated/R b/bin/deprecated/R
deleted file mode 120000
index ff6b4704c67..00000000000
--- a/bin/deprecated/R
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcessOption
\ No newline at end of file
diff --git a/bin/deprecated/createTurbulenceFields b/bin/deprecated/createTurbulenceFields
deleted file mode 100755
index 90f492d6d84..00000000000
--- a/bin/deprecated/createTurbulenceFields
+++ /dev/null
@@ -1,42 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# createTurbulenceFields
-#
-# Description
-# Replacement script to suggest using the new "-postProcess"
-# solver command-line option.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the \
-'-postProcess' solver command-line option, e.g."
-
-echo "simpleFoam -postProcess -func 'turbulenceFields(R, omega)'"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/enstrophy b/bin/deprecated/enstrophy
deleted file mode 120000
index 7b00da8e40e..00000000000
--- a/bin/deprecated/enstrophy
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcess
\ No newline at end of file
diff --git a/bin/deprecated/execFlowFunctionObjects b/bin/deprecated/execFlowFunctionObjects
deleted file mode 100755
index c31517e00b1..00000000000
--- a/bin/deprecated/execFlowFunctionObjects
+++ /dev/null
@@ -1,42 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# execFlowFunctionObjects
-#
-# Description
-# Replacement execFlowFunctionObjects to suggest using the "-postProcess"
-# solver command-line option.
-#
-#------------------------------------------------------------------------------
-
-echo "execFlowFunctionObjects has been superceded by the \
-'-postProcess' solver command-line option, e.g."
-
-echo "simpleFoam -help -postProcess"
-simpleFoam -help -postProcess
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/flowType b/bin/deprecated/flowType
deleted file mode 120000
index 7b00da8e40e..00000000000
--- a/bin/deprecated/flowType
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcess
\ No newline at end of file
diff --git a/bin/deprecated/foamCalc b/bin/deprecated/foamCalc
deleted file mode 100755
index 5749b653a4d..00000000000
--- a/bin/deprecated/foamCalc
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# foamCalc
-#
-# Description
-# Replacement foamCalc to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-
-echo "foamCalc has been superceded by the postProcess utility:"
-echo " postProcess -help"
-postProcess -help
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/foamDebugSwitches b/bin/deprecated/foamDebugSwitches
deleted file mode 100755
index c04e31bccc9..00000000000
--- a/bin/deprecated/foamDebugSwitches
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# foamDebugSwitches
-#
-# Description
-# Script to suggest using the new "foamList" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the foamList utility:"
-echo "foamList -debug"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/foamGraphExecTime b/bin/deprecated/foamGraphExecTime
deleted file mode 100755
index 7a4ebc0b8f2..00000000000
--- a/bin/deprecated/foamGraphExecTime
+++ /dev/null
@@ -1,54 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2011-2017 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# foamGraphExecTime
-#
-# Description
-# Deprecated script extract the 'ExecutionTime' for each time-step from a
-# log file for graphing.
-#
-# Superseded by the more general foamLog script.
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-if [ ! -f "$1" ]; then
- echo "$Script: $1 is not a valid filename"
- exit 1
-fi
-
-tmpTime=newTime$$.dat
-cat $1 | \
- grep "ExecutionTime = " | \
- awk 'BEGIN { NENTRIES = 0 ; TPREV = 0.0 }{NENTRIES++; printf("%f %e\n", NENTRIES, $3 - TPREV); TPREV = $3}' - > $tmpTime
-
-if [ "$(cat $tmpTime | wc -l)" -gt 1 ]; then
- mv $tmpTime executionTime.dat
-fi
-
-rm -f $tmpTime
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/foamGraphResKE b/bin/deprecated/foamGraphResKE
deleted file mode 100755
index 2f9e7aab1bb..00000000000
--- a/bin/deprecated/foamGraphResKE
+++ /dev/null
@@ -1,66 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2011-2017 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# foamGraphResKE
-#
-# Description
-# Deprecated script extract initial turbulence residuals for each time-step
-# from a log file for graphing.
-#
-# Superseded by the more general foamLog script.
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-if [ ! -f "$1" ]; then
- echo "$Script: $1 is not a valid filename"
- exit 1
-fi
-
-scan()
-{
- tmpFile=new$1$$.dat
- cat $2 | \
- grep "Solving for $1" | \
- grep -v "solution singularity" | \
- sed s/,//g | \
- awk 'BEGIN { NENTRIES = 0 }{NENTRIES++; printf("%d %e\n", NENTRIES, $8)}' - > $tmpFile
-
- if [ "$(cat $tmpFile | wc -l)" -gt 1 ]; then
- echo >> residualKE.dat
- cat $tmpFile >> residualKE.dat
- fi
-
- rm $tmpFile
-}
-
-rm -f residualKE.dat
-scan "k" $1
-scan "epsilon" $1
-scan "omega" $1
-scan "nuTilda" $1
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/foamGraphResUVWP b/bin/deprecated/foamGraphResUVWP
deleted file mode 100755
index ec0d14513ce..00000000000
--- a/bin/deprecated/foamGraphResUVWP
+++ /dev/null
@@ -1,66 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2011-2017 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# foamGraphResUVWP
-#
-# Description
-# Deprecated script extract initial velocity and pressure residuals for each
-# time-step from a log file for graphing.
-#
-# Superseded by the more general foamLog script.
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-if [ ! -f "$1" ]; then
- echo "$Script: $1 is not a valid filename"
- exit 1
-fi
-
-scan()
-{
- tmpFile=new$1$$.dat
- cat $2 | \
- grep "Solving for $1" | \
- grep -v "solution singularity" | \
- sed s/,//g | \
- awk 'BEGIN { NENTRIES = 0 }{NENTRIES++; printf("%d %e\n", NENTRIES, $8)}' - > $tmpFile
-
- if [ "$(cat $tmpFile | wc -l)" -gt 1 ]; then
- echo >> residualUVWP.dat
- cat $tmpFile >> residualUVWP.dat
- fi
-
- rm $tmpFile
-}
-
-rm -f residualUVWP.dat
-scan "Ux" $1
-scan "Uy" $1
-scan "Uz" $1
-scan "p" $1
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/patchAverage b/bin/deprecated/patchAverage
deleted file mode 100755
index 26b14907bc7..00000000000
--- a/bin/deprecated/patchAverage
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# patchAverage
-#
-# Description
-# Script to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the postProcess utility:"
-echo " postProcess -func '"$Script"(name=inlet,p)'"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/patchIntegrate b/bin/deprecated/patchIntegrate
deleted file mode 100755
index 11d90679304..00000000000
--- a/bin/deprecated/patchIntegrate
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# patchIntegrate
-#
-# Description
-# Script to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the postProcess utility:"
-echo " postProcess -func '"$Script"(name=inlet,p)'"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/probeLocations b/bin/deprecated/probeLocations
deleted file mode 100755
index cec259f6add..00000000000
--- a/bin/deprecated/probeLocations
+++ /dev/null
@@ -1,41 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# probeLocations
-#
-# Description
-# Script to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the postProcess utility:"
-echo " postProcess -func probes"
-echo "or"
-echo " postProcess -func 'probes(p, U)'"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/ptot b/bin/deprecated/ptot
deleted file mode 100755
index 0ae6ed9dae7..00000000000
--- a/bin/deprecated/ptot
+++ /dev/null
@@ -1,41 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# ptot
-#
-# Description
-# Script to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the postProcess utility:"
-echo " postProcess -func 'totalPressureIncompressible(U,p)'"
-echo "or"
-echo " postProcess -func 'totalPressureCompressible(rho,U,p)'"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/sample b/bin/deprecated/sample
deleted file mode 100755
index f3d82e472a9..00000000000
--- a/bin/deprecated/sample
+++ /dev/null
@@ -1,45 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# probeLocations
-#
-# Description
-# Script to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the postProcess utility:"
-echo " postProcess -func $Script"
-echo
-echo "To re-use existing 'sampleDict' files simply add the following entries:"
-echo " type sets;"
-echo " libs (\"libsampling.so\");"
-echo "and run"
-echo " postProcess -func sampleDict"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/streamFunction b/bin/deprecated/streamFunction
deleted file mode 120000
index 7b00da8e40e..00000000000
--- a/bin/deprecated/streamFunction
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcess
\ No newline at end of file
diff --git a/bin/deprecated/stressComponents b/bin/deprecated/stressComponents
deleted file mode 100755
index 208463c41b3..00000000000
--- a/bin/deprecated/stressComponents
+++ /dev/null
@@ -1,41 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016-2017 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# stressComponents
-#
-# Description
-# Script to suggest using the new "-postProcess" solver option.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superseded by the -postProcess solver option:"
-echo "<solverName> -funcs '(R components(turbulenceProperties:R))'"
-echo "e.g."
-echo "simpleFoam -postProcess -funcs '(R components(turbulenceProperties:R))'"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/supercededByPostProcess b/bin/deprecated/supercededByPostProcess
deleted file mode 100755
index 2dfcb7c2344..00000000000
--- a/bin/deprecated/supercededByPostProcess
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# supercededByPostProcess
-#
-# Description
-# Script to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the postProcess utility:"
-echo " postProcess -func" $Script
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/supercededByPostProcessOption b/bin/deprecated/supercededByPostProcessOption
deleted file mode 100755
index 273d325f174..00000000000
--- a/bin/deprecated/supercededByPostProcessOption
+++ /dev/null
@@ -1,42 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2016 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# supercededByPostProcessOption
-#
-# Description
-# Replacement script to suggest using the new "-postProcess"
-# solver command-line option.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superceded by the \
-'-postProcess' solver command-line option, e.g."
-
-echo "simpleFoam -postProcess -func" $Script
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/vorticity b/bin/deprecated/vorticity
deleted file mode 120000
index 7b00da8e40e..00000000000
--- a/bin/deprecated/vorticity
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcess
\ No newline at end of file
diff --git a/bin/deprecated/wallGradU b/bin/deprecated/wallGradU
deleted file mode 100755
index 92ae5b809c3..00000000000
--- a/bin/deprecated/wallGradU
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2017 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# wallGradU
-#
-# Description
-# Script to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superseded by the postProcess utility:"
-echo " postProcess -func 'grad(U)'"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/wallHeatFlux b/bin/deprecated/wallHeatFlux
deleted file mode 120000
index ff6b4704c67..00000000000
--- a/bin/deprecated/wallHeatFlux
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcessOption
\ No newline at end of file
diff --git a/bin/deprecated/wallShearStress b/bin/deprecated/wallShearStress
deleted file mode 120000
index ff6b4704c67..00000000000
--- a/bin/deprecated/wallShearStress
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcessOption
\ No newline at end of file
diff --git a/bin/deprecated/wdot b/bin/deprecated/wdot
deleted file mode 100755
index 9f4d43d71bc..00000000000
--- a/bin/deprecated/wdot
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# ========= |
-# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
-# \\ / O peration |
-# \\ / A nd |
-# \\/ M anipulation |
-#-------------------------------------------------------------------------------
-# | Copyright (C) 2017 OpenFOAM Foundation
-#------------------------------------------------------------------------------
-# 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/>.
-#
-# Script
-# wdot
-#
-# Description
-# Script to suggest using the new "postProcess" utility.
-#
-#------------------------------------------------------------------------------
-Script=${0##*/}
-
-echo $Script "has been superseded by the postProcess utility:"
-echo "postProcess -func XiReactionRate"
-
-#------------------------------------------------------------------------------
diff --git a/bin/deprecated/writeCellCentres b/bin/deprecated/writeCellCentres
deleted file mode 120000
index 7b00da8e40e..00000000000
--- a/bin/deprecated/writeCellCentres
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcess
\ No newline at end of file
diff --git a/bin/deprecated/yPlus b/bin/deprecated/yPlus
deleted file mode 120000
index ff6b4704c67..00000000000
--- a/bin/deprecated/yPlus
+++ /dev/null
@@ -1 +0,0 @@
-supercededByPostProcessOption
\ No newline at end of file
diff --git a/bin/enstrophy b/bin/enstrophy
deleted file mode 120000
index 3c4b1df251b..00000000000
--- a/bin/enstrophy
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/enstrophy
\ No newline at end of file
diff --git a/bin/execFlowFunctionObjects b/bin/execFlowFunctionObjects
deleted file mode 120000
index ff820179432..00000000000
--- a/bin/execFlowFunctionObjects
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/execFlowFunctionObjects
\ No newline at end of file
diff --git a/bin/flowType b/bin/flowType
deleted file mode 120000
index cf8bfb7d33c..00000000000
--- a/bin/flowType
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/flowType
\ No newline at end of file
diff --git a/bin/foamCalc b/bin/foamCalc
deleted file mode 120000
index 40110e155c0..00000000000
--- a/bin/foamCalc
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/foamCalc
\ No newline at end of file
diff --git a/bin/foamGraphExecTime b/bin/foamGraphExecTime
deleted file mode 120000
index f6fb34291e3..00000000000
--- a/bin/foamGraphExecTime
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/foamGraphExecTime
\ No newline at end of file
diff --git a/bin/foamGraphResKE b/bin/foamGraphResKE
deleted file mode 120000
index 6f00aa885bd..00000000000
--- a/bin/foamGraphResKE
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/foamGraphResKE
\ No newline at end of file
diff --git a/bin/foamGraphResUVWP b/bin/foamGraphResUVWP
deleted file mode 120000
index 0414911d86e..00000000000
--- a/bin/foamGraphResUVWP
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/foamGraphResUVWP
\ No newline at end of file
diff --git a/bin/patchAverage b/bin/patchAverage
deleted file mode 120000
index 56f120034e1..00000000000
--- a/bin/patchAverage
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/patchAverage
\ No newline at end of file
diff --git a/bin/patchIntegrate b/bin/patchIntegrate
deleted file mode 120000
index 86bf0e1807d..00000000000
--- a/bin/patchIntegrate
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/patchIntegrate
\ No newline at end of file
diff --git a/bin/probeLocations b/bin/probeLocations
deleted file mode 120000
index b0ae936d8c9..00000000000
--- a/bin/probeLocations
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/probeLocations
\ No newline at end of file
diff --git a/bin/ptot b/bin/ptot
deleted file mode 120000
index 8d3449ff63d..00000000000
--- a/bin/ptot
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/ptot
\ No newline at end of file
diff --git a/bin/sample b/bin/sample
deleted file mode 120000
index 3cf64426e38..00000000000
--- a/bin/sample
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/sample
\ No newline at end of file
diff --git a/bin/streamFunction b/bin/streamFunction
deleted file mode 120000
index 1670122cfd0..00000000000
--- a/bin/streamFunction
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/streamFunction
\ No newline at end of file
diff --git a/bin/stressComponents b/bin/stressComponents
deleted file mode 120000
index 2f3bb9ee362..00000000000
--- a/bin/stressComponents
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/stressComponents
\ No newline at end of file
diff --git a/bin/vorticity b/bin/vorticity
deleted file mode 120000
index 2a65ebaac66..00000000000
--- a/bin/vorticity
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/vorticity
\ No newline at end of file
diff --git a/bin/wallGradU b/bin/wallGradU
deleted file mode 120000
index 70dbc7d577a..00000000000
--- a/bin/wallGradU
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/wallGradU
\ No newline at end of file
diff --git a/bin/wallHeatFlux b/bin/wallHeatFlux
deleted file mode 120000
index f5445f1117a..00000000000
--- a/bin/wallHeatFlux
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/wallHeatFlux
\ No newline at end of file
diff --git a/bin/wallShearStress b/bin/wallShearStress
deleted file mode 120000
index 31456be8313..00000000000
--- a/bin/wallShearStress
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/wallShearStress
\ No newline at end of file
diff --git a/bin/wdot b/bin/wdot
deleted file mode 120000
index 433eb780387..00000000000
--- a/bin/wdot
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/wdot
\ No newline at end of file
diff --git a/bin/writeCellCentres b/bin/writeCellCentres
deleted file mode 120000
index 807b2c74fd2..00000000000
--- a/bin/writeCellCentres
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/writeCellCentres
\ No newline at end of file
diff --git a/bin/yPlus b/bin/yPlus
deleted file mode 120000
index e002dec748c..00000000000
--- a/bin/yPlus
+++ /dev/null
@@ -1 +0,0 @@
-deprecated/yPlus
\ No newline at end of file
diff --git a/doc/codingStyleGuide.org b/doc/codingStyleGuide.org
deleted file mode 100644
index 4df1aa03b4a..00000000000
--- a/doc/codingStyleGuide.org
+++ /dev/null
@@ -1,539 +0,0 @@
-# -*- mode: org; -*-
-#
-#+TITLE: OpenFOAM C++ Style Guide
-#+AUTHOR: OpenFOAM Foundation
-#+DATE: 2011-2016
-#+LINK: http://OpenFOAM.com
-#+OPTIONS: author:nil ^:{}
-#+STARTUP: hidestars
-#+STARTUP: odd
-
-* Code
-*** General
- + 80 character lines max
- + The normal indentation is 4 spaces per logical level.
- + Use spaces for indentation, not tab characters.
- + Avoid trailing whitespace.
- + The body of control statements (eg, =if=, =else=, =while=, /etc./). is
- always delineated with braces. A possible exception can be
- made in conjunction with =break= or =continue= as part of a control
- structure.
- + The body of =case= statements is usually delineated with braces.
- + Stream output
- + =<<= is always four characters after the start of the stream,
- so that the =<<= symbols align, i.e.
- #+begin_src C++
- Info<< ...
- os << ...
- #+end_src
- so
- #+begin_src C++
- WarningInFunction
- << "Warning message"
- #+end_src
- *not*
- #+begin_src C++
- WarningInFunction
- << "Warning message"
- #+end_src
-
- + Remove unnecessary class section headers, i.e. remove
-#+begin_src C++
-// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
-
- // Check
-
- // Edit
-
- // Write
-#+end_src
- if they contain nothing, even if planned for 'future use'
-
- + Class titles should be centred
-#+begin_src C++
-/*---------------------------------------------------------------------------*\
- Class exampleClass Declaration
-\*---------------------------------------------------------------------------*/
-#+end_src
- *not*
-#+begin_src C++
-/*---------------------------------------------------------------------------*\
- Class exampleClass Declaration
-\*---------------------------------------------------------------------------*/
-#+end_src
-
-*** The /.H/ Header Files
- + Header file spacing
- + Leave two empty lines between sections
- (as per functions in the /.C/ file /etc./)
- + Use =//- Comment= comments in header file to add descriptions to class
- data and functions do be included in the Doxygen documentation:
- + Text on the line starting with =//-= becomes the Doxygen brief
- description;
- + Text on subsequent lines becomes the Doxygen detailed description /e.g./
- #+begin_src C++
- //- A function which returns a thing
- // This is a detailed description of the function
- // which processes stuff and returns other stuff
- // depending on things.
- thing function(stuff1, stuff2);
- #+end_src
- + List entries start with =-= or =-#= for numbered lists but cannot start
- on the line immediately below the brief description so
- #+begin_src C++
- //- Compare triFaces
- // Returns:
- // - 0: different
- // - +1: identical
- // - -1: same face, but different orientation
- static int compare(const triFace&, const triFace&);
- #+end_src
- or
- #+begin_src C++
- //- Compare triFaces returning 0, +1 or -1
- //
- // - 0: different
- // - +1: identical
- // - -1: same face, but different orientation
- static int compare(const triFace&, const triFace&);
- #+end_src
- *not*
- #+begin_src C++
- //- Compare triFaces returning 0, +1 or -1
- // - 0: different
- // - +1: identical
- // - -1: same face, but different orientation
- static int compare(const triFace&, const triFace&);
- #+end_src
- + List can be nested for example
- #+begin_src C++
- //- Search for \em name
- // in the following hierarchy:
- // -# user settings
- // - ~/.OpenFOAM/\<VERSION\>/
- // <em>for version-specific files</em>
- // - ~/.OpenFOAM/
- // <em>for version-independent files</em>
- // -# group settings
- // - $WM_PROJECT_DIR/site/\<VERSION\>
- // <em>for version-specific files</em>
- // - $WM_PROJECT_DIR/site/
- // <em>for version-independent files</em>
- // -# other (shipped) settings
- // - $WM_PROJECT_DIR/etc/
- //
- // \return the full path name or fileName() if the name cannot be found
- // Optionally abort if the file cannot be found
- fileName findEtcFile(const fileName&, bool mandatory=false);
- #+end_src
- + For more details see the Doxygen documentation.
- + Destructor
- + When adding a comment to the destructor use =//-= and code as a normal
- function:
- #+begin_src C++
- //- Destructor
- ~className();
- #+end_src
- + Inline functions
- + Use inline functions where appropriate in a separate /classNameI.H/
- file. Avoid cluttering the header file with function bodies.
-
-*** The /.C/ Source Files
- + Do not open/close namespaces in a /.C/ file
- + Fully scope the function name, i.e.
- #+begin_src C++
- Foam::returnType Foam::className::functionName()
- #+end_src
- *not*
- #+begin_src C++
- namespace Foam
- {
- ...
- returnType className::functionName()
- ...
- }
- #+end_src
- *Exception*
- When there are multiple levels of namespace, they may be used in the
- /.C/ file to avoid excessive clutter, i.e.
- #+begin_src C++
- namespace Foam
- {
- namespace compressible
- {
- namespace RASModels
- {
- ...
- } // End namespace RASModels
- } // End namespace compressible
- } // End namespace Foam
- #+end_src
-
- + Use two empty lines between functions
-
-*** Coding Practice
- + Passing data as arguments or return values:
- + Pass bool, label, scalar and other primitive types as copy,
- anything larger by reference.
- + =const=
- + Use everywhere it is applicable.
- + Variable initialisation using
- #+begin_src C++
- const className& variableName = otherClass.data();
- #+end_src
- *not*
- #+begin_src C++
- const className& variableName(otherClass.data());
- #+end_src
- + Virtual functions
- + If a class is virtual, make all derived classes virtual.
-
-*** Conditional Statements
- #+begin_src C++
- if (condition)
- {
- code;
- }
- #+end_src
- OR
- #+begin_src C++
- if
- (
- long condition
- )
- {
- code;
- }
- #+end_src
- *not* (no space between =if= and =(= used)
- #+begin_src C++
- if(condition)
- {
- code;
- }
- #+end_src
-
-*** =for= and =while= Loops
- #+begin_src C++
- for (i = 0; i < maxI; ++i)
- {
- code;
- }
- #+end_src
- OR
- #+begin_src C++
- for
- (
- i = 0;
- i < maxI;
- ++i
- )
- {
- code;
- }
- #+end_src
- *not* this (no space between =for= and =(= used)
- #+begin_src C++
- for(i = 0; i < maxI; ++i)
- {
- code;
- }
- #+end_src
- Range-base for should have a space surrounding the ':'
- #+begin_src C++
- for (auto i : range)
- {
- code;
- }
- #+end_src
- Note that when indexing through iterators, it is often more efficient
- to use the pre-increment form. Eg, =++iter= instead of =iter++=
-
-*** =forAll=, =forAllIters=, =forAllConstIters=, /etc./ loops
- Like =for= loops, but
- #+begin_src C++
- forAll(
- #+end_src
- *not*
- #+begin_src C++
- forAll (
- #+end_src
- In many cases, the new =forAllIters= and =forAllConstIters= macros
- provide a good means of cycling through iterators (when a range-base
- for doesn't apply). These use the C++11 decltype and work without
- explicitly specifying the container class:
- #+begin_src C++
- forAllIters(myEdgeHash, iter)
- #+end_src
- Using the older =forAllIter= and =forAllConstIter= macros will
- still be seen. However, since they are macros, they will fail if
- the iterated object contains any commas /e.g./ following will FAIL!:
- #+begin_src C++
- forAllIter(HashTable<labelPair, edge, Hash<edge>>, myEdgeHash, iter)
- #+end_src
- These convenience macros are also generally avoided in other
- container classes and OpenFOAM primitive classes.
- In certain cases, the range-based for can also be used.
-
-*** Splitting Over Multiple Lines
-***** Splitting return type and function name
- + Split initially after the function return type and left align
- + Do not put =const= onto its own line - use a split to keep it with
- the function name and arguments.
- #+begin_src C++
- const Foam::longReturnTypeName&
- Foam::longClassName::longFunctionName const
- #+end_src
- *not*
- #+begin_src C++
- const Foam::longReturnTypeName&
- Foam::longClassName::longFunctionName const
- #+end_src
- *nor*
- #+begin_src C++
- const Foam::longReturnTypeName& Foam::longClassName::longFunctionName
- const
- #+end_src
- *nor*
- #+begin_src C++
- const Foam::longReturnTypeName& Foam::longClassName::
- longFunctionName const
- #+end_src
- + If it needs to be split again, split at the function name (leaving
- behind the preceding scoping =::=s), and again, left align, i.e.
- #+begin_src C++
- const Foam::longReturnTypeName&
- Foam::veryveryveryverylongClassName::
- veryveryveryverylongFunctionName const
- #+end_src
-
-***** Splitting long lines at an "="
- Indent after split
- #+begin_src C++
- variableName =
- longClassName.longFunctionName(longArgument);
- #+end_src
- OR (where necessary)
- #+begin_src C++
- variableName =
- longClassName.longFunctionName
- (
- longArgument1,
- longArgument2
- );
- #+end_src
- *not*
- #+begin_src C++
- variableName =
- longClassName.longFunctionName(longArgument);
- #+end_src
- *nor*
- #+begin_src C++
- variableName = longClassName.longFunctionName
- (
- longArgument1,
- longArgument2
- );
- #+end_src
-
-*** Maths and Logic
- + Operator spacing
- #+begin_src C++
- a + b, a - b
- a*b, a/b
- a & b, a ^ b
- a = b, a != b
- a < b, a > b, a >= b, a <= b
- a || b, a && b
- #+end_src
-
- + Splitting formulae over several lines:
- Split and indent as per "splitting long lines at an ="
- with the operator on the lower line. Align operator so that first
- variable, function or bracket on the next line is 4 spaces indented i.e.
- #+begin_src C++
- variableName =
- a*(a + b)
- *exp(c/d)
- *(k + t);
- #+end_src
- This is sometimes more legible when surrounded by extra parentheses:
- #+begin_src C++
- variableName =
- (
- a*(a + b)
- *exp(c/d)
- *(k + t)
- );
- #+end_src
-
- + Splitting logical tests over several lines:
- outdent the operator so that the next variable to test is aligned with
- the four space indentation, i.e.
- #+begin_src C++
- if
- (
- a == true
- && b == c
- )
- #+end_src
-
-* Documentation
-*** General
- + For readability in the comment blocks, certain tags are used that are
- translated by pre-filtering the file before sending it to Doxygen.
- + The tags start in column 1, the contents follow on the next lines and
- indented by 4 spaces. The filter removes the leading 4 spaces from the
- following lines until the next tag that starts in column 1.
- + The 'Class' and 'Description' tags are the most important ones.
- + The first paragraph following the 'Description' will be used for the
- brief description, the remaining paragraphs become the detailed
- description. For example,
- #+begin_example C++
- Class
- Foam::myClass
-
- Description
- A class for specifying the documentation style.
-
- The class is implemented as a set of recommendations that may
- sometimes be useful.
- #+end_example
-
- + The class name must be qualified by its namespace, otherwise Doxygen
- will think you are documenting some other class.
- + If you don't have anything to say about the class (at the moment), use
- the namespace-qualified class name for the description. This aids with
- finding these under-documented classes later.
- #+begin_example C++
- Class
- Foam::myUnderDocumentedClass
-
- Description
- Foam::myUnderDocumentedClass
- #+end_example
- + Use 'Class' and 'Namespace' tags in the header files.
- The Description block then applies to documenting the class.
- + Use 'InClass' and 'InNamespace' in the source files.
- The Description block then applies to documenting the file itself.
- #+begin_example C++
- InClass
- Foam::myClass
-
- Description
- Implements the read and writing of files.
- #+end_example
-
-*** Doxygen Special Commands
- Doxygen has a large number of special commands with a =\= prefix.
-
- Since the filtering removes the leading spaces within the blocks, the
- Doxygen commands can be inserted within the block without problems.
- #+begin_example C++
- InClass
- Foam::myClass
-
- Description
- Implements the read and writing of files.
-
- An example input file:
- \verbatim
- patchName
- {
- type patchType;
- refValue 100;
- value uniform 1;
- }
- \endverbatim
-
- Within the implementation, a loop over all patches is done:
- \code
- forAll(patches, patchi)
- {
- ... // some operation
- }
- \endcode
- #+end_example
-
-*** HTML Special Commands
- Since Doxygen also handles HTML tags to a certain extent, the angle
- brackets need quoting in the documentation blocks. Non-HTML tags cause
- Doxygen to complain, but seem to work anyhow. /e.g./,
- + The template with type =<HR>= is a bad example.
- + The template with type =\<HR\>= is a better example.
- + The template with type =<Type>= causes Doxygen to complain about an
- unknown html type, but it seems to work okay anyhow.
-
-*** Documenting Namespaces
- + If namespaces are explicitly declared with the =Namespace()= macro,
- they should be documented there.
- + If the namespaces is used to hold sub-models, the namespace can be
- documented in the same file as the class with the model selector.
- /e.g./,
- #+begin_example C++
- documented namespace 'Foam::functionEntries' within the
- class 'Foam::functionEntry'
- #+end_example
- + If nothing else helps, find some sensible header.
- /e.g./,
- #+begin_example C++
- namespace 'Foam' is documented in the foamVersion.H file
- #+end_example
-
-*** Documenting Applications
- Any number of classes might be defined by a particular application, but
- these classes will not, however, be available to other parts of
- OpenFOAM. At the moment, the sole purpose for running Doxygen on the
- applications is to extract program usage information for the '-doc'
- option.
-
- The documentation for a particular application is normally contained
- within the first comment block in a /.C/ source file. The solution is this
- to invoke a special filter for the "/applications/{solver,utilities}/"
- directories that only allows the initial comment block for the /.C/ files
- through.
-
- The layout of the application documentation has not yet been finalized,
- but foamToVTK shows an initial attempt.
-
-*** Orthography
- Given the origins of OpenFOAM, the British spellings (/e.g./, neighbour and
- not neighbor) are generally favoured.
-
- Both '-ize' and the '-ise' variant are found in the code comments. If
- used as a variable or class method name, it is probably better to use
- '-ize', which is considered the main form by the Oxford University
- Press. /e.g./,
- #+begin_src C++
- myClass.initialize()
- #+end_src
-*** References
- References provided in the =Description= section of the class header files
- should be formatted in the [[http://www.apastyle.org][APA (American
- Psychological Association)]] style /e.g./ from =kEpsilon.H=
- #+begin_example
-Description
- Standard k-epsilon turbulence model for incompressible and compressible
- flows including rapid distortion theory (RDT) based compression term.
-
- Reference:
- \verbatim
- Standard model:
- Launder, B. E., & Spalding, D. B. (1972).
- Lectures in mathematical models of turbulence.
-
- Launder, B. E., & Spalding, D. B. (1974).
- The numerical computation of turbulent flows.
- Computer methods in applied mechanics and engineering,
- 3(2), 269-289.
-
- For the RDT-based compression term:
- El Tahry, S. H. (1983).
- k-epsilon equation for compressible reciprocating engine flows.
- Journal of Energy, 7(4), 345-353.
- \endverbatim
- #+end_example
- The APA style is a commonly used standard and references are available in
- this format from many sources including
- [[http://www.citationmachine.net/apa/cite-a-book][Citation Machine]] and
- [[http://scholar.google.com][Google Scholar]].
--
GitLab