View Issue Details

IDProjectCategoryView StatusLast Update
0004108OpenFOAMBugpublic2024-07-02 14:19
Reportercgoessni Assigned Tohenry  
PrioritynoneSeveritytrivialReproducibilityN/A
Status resolvedResolutionfixed 
Product Versiondev 
Fixed in Versiondev 
Summary0004108: turbulenceFields: Header documentation issues
DescriptionThe turbulenceFields functionObject documentation says that the names of the added fields are prefixed with "momentumTransportModel:", e.g., "momentumTransportModel:k" for k. However, when using this functionObject, this prefix is only added when the undocumented "prefix" switch is true. This switch defaults to "false", making the documentation wrong there.
Steps To ReproduceRun in fluid/aerofoilNACA0012:

#!/bin/sh
cd ${0%/*} || exit 1 # Run from this directory

# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions

# Copy aerofoil surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/NACA0012.obj.gz constant/geometry/

application="$(getApplication)"

runApplication blockMesh
runApplication transformPoints "scale=(1 0 1)"
runApplication extrudeMesh

echo '#includeFunc turbulenceFields(fields=(R))' >> system/functions
echo '#includeFunc volAverage(fields=(momentumTransportModel:R R))' >> system/functions

runApplication $application

#------------------------------------------------------------------------------

In the log file, it says

--> FOAM Warning : functionObjects::volFieldValue volAverage(fields=(momentumTransportModel:RR)) cannot find required object momentumTransportModel:R
TagsNo tags attached.

Activities

henry

2024-07-02 14:13

manager   ~0013297

Last edited: 2024-07-02 14:14

The prefix switch is documented:

        prefix | If true prefix fields | no | no

which is correct, it is optional and the default is "no".

henry

2024-07-02 14:19

manager   ~0013298

Improved documentation in commit aaa2c25b81215cfa91f6c05b2fa334f18ffec47e

Issue History

Date Modified Username Field Change
2024-07-02 08:03 cgoessni New Issue
2024-07-02 14:13 henry Note Added: 0013297
2024-07-02 14:14 henry Note Edited: 0013297
2024-07-02 14:19 henry Assigned To => henry
2024-07-02 14:19 henry Status new => resolved
2024-07-02 14:19 henry Resolution open => fixed
2024-07-02 14:19 henry Fixed in Version => dev
2024-07-02 14:19 henry Note Added: 0013298