From f6f45959842334cbf72a13355a64b27a4044ee44 Mon Sep 17 00:00:00 2001
From: Henry <Henry>
Date: Tue, 26 Oct 2010 14:31:17 +0100
Subject: [PATCH] fvcSmooth: updated documentation
---
.../finiteVolume/fvc/fvcSmooth/fvcSmooth.C | 3 +--
.../finiteVolume/fvc/fvcSmooth/fvcSmooth.H | 18 ++++++++++++++----
.../finiteVolume/fvc/fvcSmooth/smoothData.H | 4 ++--
.../finiteVolume/fvc/fvcSmooth/sweepData.H | 4 ++--
4 files changed, 19 insertions(+), 10 deletions(-)
diff --git a/src/finiteVolume/finiteVolume/fvc/fvcSmooth/fvcSmooth.C b/src/finiteVolume/finiteVolume/fvc/fvcSmooth/fvcSmooth.C
index c04d16dcc9e..47cfb5582ac 100644
--- a/src/finiteVolume/finiteVolume/fvc/fvcSmooth/fvcSmooth.C
+++ b/src/finiteVolume/finiteVolume/fvc/fvcSmooth/fvcSmooth.C
@@ -255,8 +255,7 @@ void Foam::fvc::sweep
changedFaces.append(facei);
changedFacesInfo.append
(
- sweepData(max(field[own], field[nbr]),
- Cf[facei])
+ sweepData(max(field[own], field[nbr]), Cf[facei])
);
}
}
diff --git a/src/finiteVolume/finiteVolume/fvc/fvcSmooth/fvcSmooth.H b/src/finiteVolume/finiteVolume/fvc/fvcSmooth/fvcSmooth.H
index ced147e3dc5..2ce5b1b5d32 100644
--- a/src/finiteVolume/finiteVolume/fvc/fvcSmooth/fvcSmooth.H
+++ b/src/finiteVolume/finiteVolume/fvc/fvcSmooth/fvcSmooth.H
@@ -21,12 +21,22 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-function
- Foam::fvc::smooth
+InNamespace
+ Foam::fvc
Description
- Function that uses smoothData to apply spatial smoothing of a
- volume field using the FaceCellWave algorithm
+ Provides functions smooth spread and sweep which use the FaceCellWave
+ algorithm to smooth and redistribute the first field argument.
+
+ smooth: smooths the field by ensuring the values in neighbouring
+ cells are at least coeff* the cell value.
+
+ spread: redistributes the field by spreading the maximum value within
+ the region defined by the value and gradient of alpha.
+
+ sweep: redistributes the field by sweeping the maximum value where the
+ gradient of alpha is large away from that starting point of the
+ sweep.
SourceFiles
fvcSmooth.C
diff --git a/src/finiteVolume/finiteVolume/fvc/fvcSmooth/smoothData.H b/src/finiteVolume/finiteVolume/fvc/fvcSmooth/smoothData.H
index b55c93a52a4..d027f9f2a24 100644
--- a/src/finiteVolume/finiteVolume/fvc/fvcSmooth/smoothData.H
+++ b/src/finiteVolume/finiteVolume/fvc/fvcSmooth/smoothData.H
@@ -25,9 +25,9 @@ Class
Foam::smoothData
Description
- Helper class used by the smoothVolField class
+ Helper class used by the fvc::smooth and fvc::spread functions.
-Files
+SourceFiles
smoothData.H
smoothDataI.H
diff --git a/src/finiteVolume/finiteVolume/fvc/fvcSmooth/sweepData.H b/src/finiteVolume/finiteVolume/fvc/fvcSmooth/sweepData.H
index ebee81c0f75..1bfec88fdfc 100644
--- a/src/finiteVolume/finiteVolume/fvc/fvcSmooth/sweepData.H
+++ b/src/finiteVolume/finiteVolume/fvc/fvcSmooth/sweepData.H
@@ -25,9 +25,9 @@ Class
Foam::sweepData
Description
- Helper class used by fvcSmooth
+ Helper class used by fvc::sweep function.
-Files
+SourceFiles
sweepData.H
sweepDataI.H
--
GitLab