Commit f6f45959 authored by Henry's avatar Henry
Browse files

fvcSmooth: updated documentation

parent 2864fdfd
......@@ -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])
);
}
}
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment