functionObjects: Changed options 'outputControl' -> 'writeControl' and 'outputInterval' -> 'writeInterval'

for consistency with the time controls in controlDict and to avoid unnecessary confusion. All code and tutorials have been updated. The old names 'outputControl' and 'outputInterval' are but supported for backward compatibility but deprecated.
2025-11-28 03:28:01 +00:00 · 2016-05-12 11:38:11 +01:00
parent cacbc688d8
commit c983670c91
113 changed files with 399 additions and 295 deletions
--- a/src/postProcessing/functionObjects/field/fieldAverage/controlDict
+++ b/src/postProcessing/functionObjects/field/fieldAverage/controlDict
@ -58,7 +58,7 @@ functions
        enabled         true;

        // When to output the average fields
-        outputControl   outputTime;
+        writeControl   outputTime;

        // Fields to be averaged - runTime modifiable
        fields
--- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/postProcessingDict
+++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/postProcessingDict
@ -28,7 +28,7 @@ functions
        enabled         true;

        // When to output the average fields
-        outputControl   outputTime;
+        writeControl   outputTime;

        // Fields to be transformed - runTime modifiable
        fields
--- a/src/postProcessing/functionObjects/field/fieldValues/controlDict
+++ b/src/postProcessing/functionObjects/field/fieldValues/controlDict
@ -52,7 +52,7 @@ functions
        functionObjectLibs ("libfieldFunctionObjects.so");

        enabled         true;
-        outputControl   outputTime;
+        writeControl   outputTime;

        // Output to log&file (true) or to file only
        log             true;
@ -93,7 +93,7 @@ functions
        type            faceSource;
        functionObjectLibs ("libfieldFunctionObjects.so");
        enabled         true;
-        outputControl   outputTime;
+        writeControl   outputTime;
        log             true;
        valueOutput     true;
        source          faceZone;
@ -111,7 +111,7 @@ functions
        type            cellSource;
        functionObjectLibs ("libfieldFunctionObjects.so");
        enabled         true;
-        outputControl   outputTime;
+        writeControl   outputTime;
        log             true;
        valueOutput     true;
        source          cellZone;
--- a/src/postProcessing/functionObjects/field/nearWallFields/controlDict
+++ b/src/postProcessing/functionObjects/field/nearWallFields/controlDict
@ -54,8 +54,8 @@ functions
        type nearWallFields;

        // Output every
-        outputControl outputTime; //timeStep;
-        //outputInterval 5;
+        writeControl outputTime; //timeStep;
+        //writeInterval 5;

        // Fields to be sampled. Per field original name and mapped field to
        // create.
--- a/src/postProcessing/functionObjects/field/processorField/postProcessingDict
+++ b/src/postProcessing/functionObjects/field/processorField/postProcessingDict
@ -28,7 +28,7 @@ functions
        enabled         true;

        // When to output the average fields
-        outputControl   outputTime;
+        writeControl   outputTime;
    }
 }

--- a/src/postProcessing/functionObjects/field/readFields/postProcessingDict
+++ b/src/postProcessing/functionObjects/field/readFields/postProcessingDict
@ -21,8 +21,8 @@ functions
        type            readFields;
        functionObjectLibs ("libfieldFunctionObjects.so");
        enabled         true;
-        outputControl   timeStep;
-        outputInterval  1;
+        writeControl   timeStep;
+        writeInterval  1;

        fields
        (
@ -35,8 +35,8 @@ functions
        type            faceSource;
        functionObjectLibs ("libfieldFunctionObjects.so");
        enabled         true;
-        outputControl   timeStep;
-        outputInterval  1;
+        writeControl   timeStep;
+        writeInterval  1;
        log             true;
        valueOutput     true;
        source          faceZone;
--- a/src/postProcessing/functionObjects/field/streamLine/controlDict
+++ b/src/postProcessing/functionObjects/field/streamLine/controlDict
@ -54,8 +54,8 @@ functions
        functionObjectLibs ("libfieldFunctionObjects.so");

        // Output every
-        outputControl   outputTime;
-        // outputInterval 10;
+        writeControl   outputTime;
+        // writeInterval 10;

        setFormat       vtk; //gnuplot, raw etc. See sampleDict.

--- a/src/postProcessing/functionObjects/field/streamLine/streamLine.C
+++ b/src/postProcessing/functionObjects/field/streamLine/streamLine.C
@ -35,6 +35,7 @@ License
 #include "mapDistribute.H"
 #include "interpolationCellPoint.H"
 #include "PatchTools.H"
+#include "mapPolyMesh.H"

 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

@ -697,16 +698,26 @@ void Foam::functionObjects::streamLine::write()
 }


-void Foam::functionObjects::streamLine::updateMesh(const mapPolyMesh&)
+void Foam::functionObjects::streamLine::updateMesh(const mapPolyMesh& mpm)
 {
-    read(dict_);
+    const fvMesh& mesh_ = dynamic_cast<const fvMesh&>(obr_);
+
+    if (&mpm.mesh() == &mesh_)
+    {
+        read(dict_);
+    }
 }


-void Foam::functionObjects::streamLine::movePoints(const polyMesh&)
+void Foam::functionObjects::streamLine::movePoints(const polyMesh& mesh)
 {
-    // Moving mesh affects the search tree
-    read(dict_);
+    const fvMesh& mesh_ = dynamic_cast<const fvMesh&>(obr_);
+
+    if (&mesh == &mesh_)
+    {
+        // Moving mesh affects the search tree
+        read(dict_);
+    }
 }


--- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/controlDict
+++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/controlDict
@ -63,8 +63,8 @@ functions
        type nearWallFields;

        // Output every
-        outputControl   outputTime;
-        //outputInterval  1;
+        writeControl   outputTime;
+        //writeInterval  1;

        // Fields to be sampled. Per field original name and mapped field to
        // create.
@ -86,8 +86,8 @@ functions
        type            wallBoundedStreamLine;

        // Output every
-        outputControl   timeStep;   //outputTime;
-        // outputInterval 10;
+        writeControl   timeStep;   //outputTime;
+        // writeInterval 10;

        setFormat       vtk; //gnuplot; //xmgr; //raw; //jplot;

--- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.C
+++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.C
@ -37,6 +37,7 @@ License
 #include "PatchTools.H"
 #include "meshSearchMeshObject.H"
 #include "faceSet.H"
+#include "mapPolyMesh.H"

 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

@ -854,17 +855,30 @@ void Foam::functionObjects::wallBoundedStreamLine::write()

 void Foam::functionObjects::wallBoundedStreamLine::updateMesh
 (
-    const mapPolyMesh&
+    const mapPolyMesh& mpm
 )
 {
-    read(dict_);
+    const fvMesh& mesh_ = dynamic_cast<const fvMesh&>(obr_);
+
+    if (&mpm.mesh() == &mesh_)
+    {
+        read(dict_);
+    }
 }


-void Foam::functionObjects::wallBoundedStreamLine::movePoints(const polyMesh&)
+void Foam::functionObjects::wallBoundedStreamLine::movePoints
+(
+    const polyMesh& mesh
+)
 {
-    // Moving mesh affects the search tree
-    read(dict_);
+    const fvMesh& mesh_ = dynamic_cast<const fvMesh&>(obr_);
+
+    if (&mesh == &mesh_)
+    {
+        // Moving mesh affects the search tree
+        read(dict_);
+    }
 }


--- a/src/postProcessing/functionObjects/lagrangian/cloudInfo/postProcessingDict
+++ b/src/postProcessing/functionObjects/lagrangian/cloudInfo/postProcessingDict
@ -21,8 +21,8 @@ functions
        type            cloudInfo;
        functionObjectLibs ("libcloudFunctionObjects.so");
        enabled         true;
-        outputControl   timeStep;
-        outputInterval  1;
+        writeControl   timeStep;
+        writeInterval  1;

        clouds          (myCloud1);
    }
--- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
+++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
@ -172,7 +172,7 @@ public:
        functionObject& redirectFunctionObject() const;

        //- Called at each ++ or += of the time-loop. forceWrite overrides the
-        //  outputControl behaviour.
+        //  writeControl behaviour.
        virtual bool execute(const bool forceWrite);

        //- Called when Time::run() determines that the time-loop exits.
--- a/src/postProcessing/functionObjects/utilities/partialWrite/controlDict
+++ b/src/postProcessing/functionObjects/utilities/partialWrite/controlDict
@ -71,14 +71,14 @@ functions
        //  runTime
        //  clockTime
        //  cpuTime
-        outputControl   outputTime;
+        writeControl   outputTime;

        // Objects (fields or lagrangian fields in any of the clouds)
        // to write every outputTime
        objectNames    (p positions nParticle);

        // Write as normal every writeInterval'th outputTime.
-        outputInterval  1; // (timeStep, outputTime)
+        writeInterval  1; // (timeStep, outputTime)

        // Interval of time (sec) to write down(
        writeInterval   10.5 //(adjustableRunTime, runTime, clockTime, cpuTime)
@ -94,16 +94,16 @@ functions
        functionObjectLibs ("libIOFunctionObjects.so");

        // When to write:
-        //  timeStep            (with optional outputInterval)
-        //  outputTime          (with optional outputInterval)
+        //  timeStep            (with optional writeInterval)
+        //  outputTime          (with optional writeInterval)
        //  adjustableRunTime
        //  runTime
        //  clockTime
        //  cpuTime
-        outputControl   outputTime;
+        writeControl   outputTime;

         // Write every writeInterval (only valid for timeStemp, outputTime)
-        outputInterval  1;
+        writeInterval  1;

         // Interval of time (valid for adjustableRunTime, runTime, clockTime,
        //  cpuTime)
--- a/src/postProcessing/functionObjects/utilities/residuals/residuals.H
+++ b/src/postProcessing/functionObjects/utilities/residuals/residuals.H
@ -35,8 +35,8 @@ Description
    residuals
    {
        type            residuals;
-        outputControl   timeStep;
-        outputInterval  1;
+        writeControl   timeStep;
+        writeInterval  1;
        fields
        (
            U
--- a/src/postProcessing/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.C
+++ b/src/postProcessing/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.C
@ -136,14 +136,14 @@ bool Foam::functionObjects::setTimeStepFunctionObject::read

 void Foam::functionObjects::setTimeStepFunctionObject::updateMesh
 (
-    const mapPolyMesh& mpm
+    const mapPolyMesh&
 )
 {}


 void Foam::functionObjects::setTimeStepFunctionObject::movePoints
 (
-    const polyMesh& mesh
+    const polyMesh&
 )
 {}

--- a/src/postProcessing/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H
+++ b/src/postProcessing/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H
@ -32,7 +32,7 @@ Description
    solvers with adjustTimeStep control (e.g. pimpleFoam). Makes no attempt
    to cooperate with other timeStep 'controllers' (maxCo, other
    functionObjects). Supports 'enabled' flag but none of othe other ones
-    'timeStart', 'timeEnd', 'outputControl' etc.
+    'timeStart', 'timeEnd', 'writeControl' etc.

 SourceFiles
    setTimeStepFunctionObject.C
@ -125,10 +125,10 @@ public:
            virtual bool read(const dictionary&);

            //- Update for changes of mesh
-            virtual void updateMesh(const mapPolyMesh& mpm);
+            virtual void updateMesh(const mapPolyMesh&);

            //- Update for changes of mesh
-            virtual void movePoints(const polyMesh& mesh);
+            virtual void movePoints(const polyMesh&);
 };


--- a/src/postProcessing/functionObjects/utilities/systemCall/controlDict
+++ b/src/postProcessing/functionObjects/utilities/systemCall/controlDict
@ -51,7 +51,7 @@ functions
        type            systemCall;
        functionObjectLibs ("libsystemCall.so");
        enabled         true;
-        outputControl   outputTime;
+        writeControl   outputTime;

        // called every time step
        executeCalls
--- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/controlDict
+++ b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/controlDict
@ -50,8 +50,8 @@ functions
    {
        type            timeActivatedFileUpdate;
        functionObjectLibs ("libutilityFunctionObjects.so");
-        outputControl   timeStep;
-        outputInterval  1;
+        writeControl   timeStep;
+        writeInterval  1;
        fileToUpdate    "$FOAM_CASE/system/fvSolution";

        timeVsFile
--- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H
+++ b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H
@ -38,8 +38,8 @@ Description
    {
        type              timeActivatedFileUpdate;
        functionObjectLibs ("libutilityFunctionObjects.so");
-        outputControl     timeStep;
-        outputInterval    1;
+        writeControl     timeStep;
+        writeInterval    1;
        fileToUpdate      "$FOAM_CASE/system/fvSolution";
        timeVsFile
        (
--- a/src/postProcessing/functionObjects/utilities/turbulenceFields/postProcessingDict
+++ b/src/postProcessing/functionObjects/utilities/turbulenceFields/postProcessingDict
@ -21,8 +21,8 @@ functions
        type            turbulenceFields;
        functionObjectLibs ("libutilityFunctionObjects.so");
        enabled         true;
-        outputControl   timeStep;
-        outputInterval  1;
+        writeControl   timeStep;
+        writeInterval  1;

        fields
        (
--- a/src/postProcessing/functionObjects/utilities/writeRegisteredObject/controlDict
+++ b/src/postProcessing/functionObjects/utilities/writeRegisteredObject/controlDict
@ -71,14 +71,14 @@ functions
        //  runTime
        //  clockTime
        //  cpuTime
-        outputControl   outputTime;
+        writeControl   outputTime;

        // Objects (fields or lagrangian fields in any of the clouds)
        // to write every outputTime
        objectNames    (p positions nParticle);

        // Write as normal every writeInterval'th outputTime.
-        outputInterval  1; // (timeStep, outputTime)
+        writeInterval  1; // (timeStep, outputTime)

        // Interval of time (sec) to write down(
        writeInterval   10.5 //(adjustableRunTime, runTime, clockTime, cpuTime)
@ -94,16 +94,16 @@ functions
        functionObjectLibs ("libIOFunctionObjects.so");

        // When to write:
-        //  timeStep            (with optional outputInterval)
-        //  outputTime          (with optional outputInterval)
+        //  timeStep            (with optional writeInterval)
+        //  outputTime          (with optional writeInterval)
        //  adjustableRunTime
        //  runTime
        //  clockTime
        //  cpuTime
-        outputControl   outputTime;
+        writeControl   outputTime;

         // Write every writeInterval (only valid for timeStemp, outputTime)
-        outputInterval  1;
+        writeInterval  1;

         // Interval of time (valid for adjustableRunTime, runTime, clockTime,
        //  cpuTime)
--- a/src/postProcessing/functionObjects/utilities/writeRegisteredObject/writeRegisteredObject.H
+++ b/src/postProcessing/functionObjects/utilities/writeRegisteredObject/writeRegisteredObject.H
@ -30,7 +30,7 @@ Group
 Description
    This function object allows specification of different writing frequency
    of objects registered to the database. It has similar functionality
-    as the main time database through the outputControl setting:
+    as the main time database through the writeControl setting:

    \li \c timeStep
    \li \c outputTime