TUT: update some old keywords found in tutorials

- functionObjectLibs -> libs - redirectType -> name - change deprecated writeCompression flags types to Switch. - cleanup some trailing ';;' from some dictionaries
2025-11-28 03:28:01 +00:00 · 2018-06-26 14:18:52 +02:00
parent 1c9f93e173
commit 30b4eda7a4
18 changed files with 32 additions and 37 deletions
--- a/applications/test/mapDistributePolyMesh/cavity/system/processorField
+++ b/applications/test/mapDistributePolyMesh/cavity/system/processorField
@ -18,25 +18,22 @@ functions
 {
    processorField
    {
-        // Type of functionObject
        type            processorField;

-        // Where to load it from (if not already in solver)
        libs            ("libfieldFunctionObjects.so");

-        // Function object enabled flag
        enabled         true;

-        // When to output the average fields
        writeControl    writeTime;
    }
    cellID
    {
-        // Load the library containing the 'coded' functionObject
-        functionObjectLibs ("libutilityFunctionObjects.so");
        type coded;
-        // Name of on-the-fly generated functionObject
-        redirectType cellID;
+
+        libs ("libutilityFunctionObjects.so");
+
+        name cellID;
+
        codeExecute
        #{
            volScalarField cellID
--- a/src/functionObjects/doc/functionObjects.dox
+++ b/src/functionObjects/doc/functionObjects.dox
@ -91,7 +91,7 @@ typically used as the name of the output directory for any derived data.  The
 \c type entry defines the type of function object properties that follow.
 Since the function objects are packaged into separate libraries, the user must
 tell the code where to find the function object implementation, identified
-using the \c functionObjectLibs entry.
+using the \c libs entry.


 \*---------------------------------------------------------------------------*/
--- a/tutorials/IO/fileHandler/system/controlDict
+++ b/tutorials/IO/fileHandler/system/controlDict
@ -37,7 +37,7 @@ writeFormat     binary;

 writePrecision  6;

-writeCompression false;
+writeCompression off;

 timeFormat      general;

--- a/tutorials/combustion/XiDyMFoam/oscillatingCylinder/0/pointDisplacementy
+++ b/tutorials/combustion/XiDyMFoam/oscillatingCylinder/0/pointDisplacementy
@ -1,4 +1,4 @@
-/*---------------------------------------------------------------------------*\
+/*--------------------------------*- C++ -*----------------------------------*\
 | =========                 |                                                 |
 | \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
 |  \\    /   O peration     | Version:  plus                                  |
@ -29,7 +29,7 @@ boundaryField
    cylinder
    {
        type            codedFixedValue;
-        redirectType    pointDisplacementy_cylinder;
+        name            pointDisplacementy_cylinder;
        code
        #{
            const scalar t = this->db().time().value();
--- a/tutorials/compressible/rhoPimpleAdiabaticFoam/rutlandVortex2D/system/controlDict
+++ b/tutorials/compressible/rhoPimpleAdiabaticFoam/rutlandVortex2D/system/controlDict
@ -37,7 +37,7 @@ writeFormat       binary;

 writePrecision    10;

-writeCompression  uncompressed;
+writeCompression  off;

 timeFormat        general;

@ -51,7 +51,7 @@ functions
    {
        type probes;

-        functionObjectLibs ("libsampling.so");
+        libs ("libsampling.so");

        probeLocations
        (
--- a/tutorials/compressible/rhoPimpleAdiabaticFoam/rutlandVortex2D/system/preProcess
+++ b/tutorials/compressible/rhoPimpleAdiabaticFoam/rutlandVortex2D/system/preProcess
@ -20,8 +20,8 @@ functions
    createVortex
    {
        type            coded;
-        functionObjectLibs ("libutilityFunctionObjects.so");
-        redirectType    createVortices;
+        libs            ("libutilityFunctionObjects.so");
+        name            createVortices;
        enabled         yes;

        codeInclude
--- a/tutorials/compressible/rhoSimpleFoam/squareBend/0/T
+++ b/tutorials/compressible/rhoSimpleFoam/squareBend/0/T
@ -30,7 +30,7 @@ boundaryField
    {
        type            inletOutlet;
        value           $internalField;
-        inletValue      $internalField;;
+        inletValue      $internalField;
    }

    ".*"
--- a/tutorials/incompressible/overPimpleDyMFoam/cylinder/cylinderAndBackground/system/fvSchemes
+++ b/tutorials/incompressible/overPimpleDyMFoam/cylinder/cylinderAndBackground/system/fvSchemes
@ -29,10 +29,10 @@ divSchemes
 {
    default         none;
    div(phi,U)      Gauss limitedLinearV 1;
-    div(phi,k)      Gauss limitedLinear 1;;
-    div(phi,epsilon) Gauss limitedLinear 1;;
-    div(phi,R)      Gauss limitedLinear 1;;
-    div(R)          Gauss limitedLinear 1;;
+    div(phi,k)      Gauss limitedLinear 1;
+    div(phi,epsilon) Gauss limitedLinear 1;
+    div(phi,R)      Gauss limitedLinear 1;
+    div(R)          Gauss limitedLinear 1;
    div(phi,omega)  Gauss limitedLinear 1;
    div(phid,p)     Gauss limitedLinear 1;
    div(phi,K)      Gauss limitedLinear 1;
--- a/tutorials/incompressible/overSimpleFoam/aeroFoil/aeroFoil_overset/system/controlDict
+++ b/tutorials/incompressible/overSimpleFoam/aeroFoil/aeroFoil_overset/system/controlDict
@ -49,7 +49,7 @@ functions
    forces
    {
        type                forces;
-        functionObjectLibs  ( "libforces.so" );
+        libs                ( "libforces.so" );
        outputControl       timeStep;
        outputInterval      10;
        patches             (wing);
--- a/tutorials/incompressible/simpleFoam/pipeCyclic/0.orig/U
+++ b/tutorials/incompressible/simpleFoam/pipeCyclic/0.orig/U
@ -24,7 +24,7 @@ boundaryField

    inlet
    {
-        type            codedFixedValue;
+        type    codedFixedValue;
        name    swirl;

        code
--- a/tutorials/incompressible/simpleFoam/squareBend/system/fvSchemes
+++ b/tutorials/incompressible/simpleFoam/squareBend/system/fvSchemes
@ -29,10 +29,10 @@ divSchemes
 {
    default         none;
    div(phi,U)      Gauss limitedLinearV 1;
-    div(phi,k)      Gauss limitedLinear 1;;
-    div(phi,epsilon) Gauss limitedLinear 1;;
-    div(phi,R)      Gauss limitedLinear 1;;
-    div(R)          Gauss limitedLinear 1;;
+    div(phi,k)      Gauss limitedLinear 1;
+    div(phi,epsilon) Gauss limitedLinear 1;
+    div(phi,R)      Gauss limitedLinear 1;
+    div(R)          Gauss limitedLinear 1;
    div(phi,omega)  Gauss limitedLinear 1;
    div(phid,p)     Gauss limitedLinear 1;
    div(phi,K)      Gauss limitedLinear 1;
--- a/tutorials/lagrangian/icoUncoupledKinematicParcelDyMFoam/mixerVesselAMI2D/system/controlDict
+++ b/tutorials/lagrangian/icoUncoupledKinematicParcelDyMFoam/mixerVesselAMI2D/system/controlDict
@ -37,7 +37,7 @@ writeFormat     binary;

 writePrecision  6;

-writeCompression uncompressed;
+writeCompression off;

 timeFormat      general;

--- a/tutorials/mesh/moveDynamicMesh/twistingColumn/constant/dynamicMeshDict
+++ b/tutorials/mesh/moveDynamicMesh/twistingColumn/constant/dynamicMeshDict
@ -68,9 +68,7 @@ code
    const scalar maxRotAngle =
        constant::mathematical::pi*Foam::sin(degToRad(90.0/10.0*tm.value()));

-    tmp<pointField> tnewPoints(twistColumn(maxRotAngle, p0));
-
-    return tnewPoints;
+    return twistColumn(maxRotAngle, p0);
 #};


--- a/tutorials/multiphase/compressibleInterFoam/laminar/climbingRod/system/controlDict
+++ b/tutorials/multiphase/compressibleInterFoam/laminar/climbingRod/system/controlDict
@ -37,7 +37,7 @@ writeFormat     ascii;

 writePrecision  10;

-writeCompression uncompressed;
+writeCompression off;

 timeFormat      general;

--- a/tutorials/multiphase/interFoam/laminar/waveMangroveInteraction/system/controlDict
+++ b/tutorials/multiphase/interFoam/laminar/waveMangroveInteraction/system/controlDict
@ -59,7 +59,7 @@ functions
    line
    {
        type            sets;
-        functionObjectLibs ("libsampling.so");
+        libs            ("libsampling.so");
        enabled         true;
        writeControl    writeTime;

--- a/tutorials/multiphase/interIsoFoam/damBreakWithObstacle/system/controlDict
+++ b/tutorials/multiphase/interIsoFoam/damBreakWithObstacle/system/controlDict
@ -37,7 +37,7 @@ writeFormat     ascii;

 writePrecision  6;

-writeCompression uncompressed;
+writeCompression off;

 timeFormat      general;

--- a/tutorials/multiphase/reactingTwoPhaseEulerFoam/laminar/steamInjection/system/controlDict
+++ b/tutorials/multiphase/reactingTwoPhaseEulerFoam/laminar/steamInjection/system/controlDict
@ -56,7 +56,7 @@ functions
    timeStepping
    {
        type            setTimeStep;
-        functionObjectLibs ("libutilityFunctionObjects.so");
+        libs            ("libutilityFunctionObjects.so");
        enabled         yes;
        deltaT          tableFile;
        file            "system/deltaTvalues";
@ -65,7 +65,7 @@ functions
    minMaxp
    {
        type        fieldMinMax;
-        functionObjectLibs ("libfieldFunctionObjects.so");
+        libs        ("libfieldFunctionObjects.so");
        fields
        (
             p
--- a/tutorials/verificationAndValidation/schemes/divergenceExample/system/controlDict
+++ b/tutorials/verificationAndValidation/schemes/divergenceExample/system/controlDict
@ -50,7 +50,7 @@ functions
    sample1
    {
        type        sets;
-        functionObjectLibs ("libsampling.so");
+        libs        ("libsampling.so");
        writeControl onEnd;
        setFormat   raw;
        sets