Scalar: Documented 'posPart' and 'negPart'

2016-05-19 09:39:45 +01:00
parent f2331a8587
commit ae9889697e
1 changed files with 4 additions and 0 deletions
--- a/src/OpenFOAM/primitives/Scalar/Scalar.H
+++ b/src/OpenFOAM/primitives/Scalar/Scalar.H
@ -139,12 +139,16 @@ inline Scalar neg(const Scalar s)
 }


+//- Return the positive part of s
 inline Scalar posPart(const Scalar s)
 {
    return (s > 0)? s: 0;
 }


+//- Return the negative part of s.
+//  Note: this function returns the actual negative part of s as a
+//  negative number and does not change the sign
 inline Scalar negPart(const Scalar s)
 {
    return (s < 0)? s: 0;