From 1b377dd4395261a568576a4524924f475c848fa2 Mon Sep 17 00:00:00 2001 From: Will Bainbridge Date: Fri, 30 Jun 2017 12:07:11 +0100 Subject: [PATCH] interfaceHeight: Improved the description --- etc/caseDicts/postProcessing/probes/interfaceHeight | 8 +++++--- .../field/interfaceHeight/interfaceHeight.H | 9 +++++---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/etc/caseDicts/postProcessing/probes/interfaceHeight b/etc/caseDicts/postProcessing/probes/interfaceHeight index e003baf3e..b240af4dd 100644 --- a/etc/caseDicts/postProcessing/probes/interfaceHeight +++ b/etc/caseDicts/postProcessing/probes/interfaceHeight @@ -7,9 +7,11 @@ ------------------------------------------------------------------------------- Description Reports the height of the interface above a set of locations. For each - location, it writes the distance from the boundary to the interface, - intersecting the location. It uses an integral approach, which computes an - average where for multiple interfaces above or below a location. + location, it writes the vertical distance of the interface above both the + location and the lowest boundary. It also writes the point on the interface + from which these heights are computed. It uses an integral approach, so if + there are multiple interfaces above or below a location then this method + will generate average values. \*---------------------------------------------------------------------------*/ diff --git a/src/functionObjects/field/interfaceHeight/interfaceHeight.H b/src/functionObjects/field/interfaceHeight/interfaceHeight.H index 33e82ffb1..d443e1f03 100644 --- a/src/functionObjects/field/interfaceHeight/interfaceHeight.H +++ b/src/functionObjects/field/interfaceHeight/interfaceHeight.H @@ -26,10 +26,11 @@ Class Description This function object reports the height of the interface above a set of - locations. It writes the height above the location, above the boundary, - and the point on the interface. It uses an integral approach, so if there - are multiple interfaces above or below a location, this method will return - an average height. + locations. For each location, it writes the vertical distance of the + interface above both the location and the lowest boundary. It also writes + the point on the interface from which these heights are computed. It uses + an integral approach, so if there are multiple interfaces above or below a + location then this method will generate average values. Example of function object specification: \verbatim