Standardized the naming of functions which control the writing of fields etc.

to have the prefix 'write' rather than 'output'

So outputTime() -> writeTime()

but 'outputTime()' is still supported for backward-compatibility.

Also removed the redundant secondary-writing functionality from Time
which has been superseded by the 'writeRegisteredObject' functionObject.

src/OpenFOAM/db/functionObjects/OutputFilterFunctionObject/OutputFilterFunctionObject.C

@@ -93,12 +93,12 @@ bool Foam::OutputFilterFunctionObject<OutputFilter>::execute
 {
     if (active())
     {
-        if (evaluateControl_.output())
+        if (evaluateControl_.execute())
         {
             filter_.execute();
         }
 
-        if (forceWrite || writeControl_.output())
+        if (forceWrite || writeControl_.execute())
         {
             filter_.write();
         }
@@ -113,7 +113,7 @@ bool Foam::OutputFilterFunctionObject<OutputFilter>::end()
 {
     filter_.end();
 
-    if (writeControl_.output())
+    if (writeControl_.execute())
     {
         filter_.write();
     }
@@ -140,17 +140,17 @@ bool Foam::OutputFilterFunctionObject<OutputFilter>::adjustTimeStep()
     if
     (
         active()
-     && writeControl_.writeControl()
+     && writeControl_.control()
      == outputFilterControl::ocAdjustableRunTime
     )
     {
-        const label  outputTimeIndex = writeControl_.outputTimeLastDump();
-        const scalar writeInterval = writeControl_.writeInterval();
+        const label  writeTimeIndex = writeControl_.executionIndex();
+        const scalar writeInterval = writeControl_.interval();
 
         scalar timeToNextWrite = max
         (
             0.0,
-            (outputTimeIndex + 1)*writeInterval
+            (writeTimeIndex + 1)*writeInterval
           - (time_.value() - time_.startTime().value())
         );
 

src/OpenFOAM/db/functionObjects/functionObject/functionObject.H

@@ -51,7 +51,7 @@ Description
                 enabled             yes;
                 timeStart           0;
                 timeEnd             10;
-                writeControl        outputTime;
+                writeControl        writeTime;
                 writeInterval       1;
                 ...
             }
@@ -77,7 +77,7 @@ Description
     \table
         Option            | Description
         timeStep          | Execute/write every 'writeInterval' time-steps
-        outputTime        | Execute/write every 'writeInterval' output times
+        writeTime        | Execute/write every 'writeInterval' output times
         adjustableRunTime | Execute/write every 'writeInterval' run time period
         runTime           | Execute/write every 'writeInterval' run time period
         clockTime       | Execute/write every 'writeInterval' clock time period

src/OpenFOAM/db/functionObjects/outputFilterControl/outputFilterControl.C

@@ -31,7 +31,7 @@ License
 namespace Foam
 {
     template<>
-    const char* NamedEnum<outputFilterControl::writeControls, 8>::
+    const char* NamedEnum<outputFilterControl::timeControls, 8>::
     names[] =
     {
         "timeStep",
@@ -45,8 +45,8 @@ namespace Foam
     };
 }
 
-const Foam::NamedEnum<Foam::outputFilterControl::writeControls, 8>
-    Foam::outputFilterControl::writeControlNames_;
+const Foam::NamedEnum<Foam::outputFilterControl::timeControls, 8>
+    Foam::outputFilterControl::timeControlNames_;
 
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
@@ -60,10 +60,10 @@ Foam::outputFilterControl::outputFilterControl
 :
     time_(t),
     prefix_(prefix),
-    writeControl_(ocTimeStep),
-    outputInterval_(0),
-    writeInterval_(-1),
-    outputTimeLastDump_(0)
+    timeControl_(ocTimeStep),
+    intervalSteps_(0),
+    interval_(-1),
+    executionIndex_(0)
 {
     read(dict);
 }
@@ -98,25 +98,25 @@ void Foam::outputFilterControl::read(const dictionary& dict)
 
     if (dict.found(controlName))
     {
-        writeControl_ = writeControlNames_.read(dict.lookup(controlName));
+        timeControl_ = timeControlNames_.read(dict.lookup(controlName));
     }
     else
     {
-        writeControl_ = ocTimeStep;
+        timeControl_ = ocTimeStep;
     }
 
-    switch (writeControl_)
+    switch (timeControl_)
     {
         case ocTimeStep:
         {
-            outputInterval_ = dict.lookupOrDefault<label>(intervalName, 0);
+            intervalSteps_ = dict.lookupOrDefault<label>(intervalName, 0);
             break;
         }
 
         case ocWriteTime:
         case ocOutputTime:
         {
-            outputInterval_ = dict.lookupOrDefault<label>(intervalName, 1);
+            intervalSteps_ = dict.lookupOrDefault<label>(intervalName, 1);
             break;
         }
 
@@ -125,7 +125,7 @@ void Foam::outputFilterControl::read(const dictionary& dict)
         case ocCpuTime:
         case ocAdjustableRunTime:
         {
-            writeInterval_ = readScalar(dict.lookup(intervalName));
+            interval_ = readScalar(dict.lookup(intervalName));
             break;
         }
 
@@ -137,16 +137,16 @@ void Foam::outputFilterControl::read(const dictionary& dict)
 }
 
 
-bool Foam::outputFilterControl::output()
+bool Foam::outputFilterControl::execute()
 {
-    switch (writeControl_)
+    switch (timeControl_)
     {
         case ocTimeStep:
         {
             return
             (
-                (outputInterval_ <= 1)
-             || !(time_.timeIndex() % outputInterval_)
+                (intervalSteps_ <= 1)
+             || !(time_.timeIndex() % intervalSteps_)
             );
             break;
         }
@@ -154,10 +154,10 @@ bool Foam::outputFilterControl::output()
         case ocWriteTime:
         case ocOutputTime:
         {
-            if (time_.outputTime())
+            if (time_.writeTime())
             {
-                outputTimeLastDump_++;
-                return !(outputTimeLastDump_ % outputInterval_);
+                executionIndex_++;
+                return !(executionIndex_ % intervalSteps_);
             }
             break;
         }
@@ -165,18 +165,18 @@ bool Foam::outputFilterControl::output()
         case ocRunTime:
         case ocAdjustableRunTime:
         {
-            label outputIndex = label
+            label executionIndex = label
             (
                 (
                     (time_.value() - time_.startTime().value())
                   + 0.5*time_.deltaTValue()
                 )
-               /writeInterval_
+               /interval_
             );
 
-            if (outputIndex > outputTimeLastDump_)
+            if (executionIndex > executionIndex_)
             {
-                outputTimeLastDump_ = outputIndex;
+                executionIndex_ = executionIndex;
                 return true;
             }
             break;
@@ -184,14 +184,14 @@ bool Foam::outputFilterControl::output()
 
         case ocCpuTime:
         {
-            label outputIndex = label
+            label executionIndex = label
             (
                 returnReduce(time_.elapsedCpuTime(), maxOp<double>())
-               /writeInterval_
+               /interval_
             );
-            if (outputIndex > outputTimeLastDump_)
+            if (executionIndex > executionIndex_)
             {
-                outputTimeLastDump_ = outputIndex;
+                executionIndex_ = executionIndex;
                 return true;
             }
             break;
@@ -199,14 +199,14 @@ bool Foam::outputFilterControl::output()
 
         case ocClockTime:
         {
-            label outputIndex = label
+            label executionIndex = label
             (
                 returnReduce(label(time_.elapsedClockTime()), maxOp<label>())
-               /writeInterval_
+               /interval_
             );
-            if (outputIndex > outputTimeLastDump_)
+            if (executionIndex > executionIndex_)
             {
-                outputTimeLastDump_ = outputIndex;
+                executionIndex_ = executionIndex;
                 return true;
             }
             break;
@@ -221,7 +221,7 @@ bool Foam::outputFilterControl::output()
         {
             FatalErrorInFunction
                 << "Undefined output control: "
-                << writeControlNames_[writeControl_] << nl
+                << timeControlNames_[timeControl_] << nl
                 << abort(FatalError);
             break;
         }

src/OpenFOAM/db/functionObjects/outputFilterControl/outputFilterControl.H

@@ -54,15 +54,15 @@ class outputFilterControl
 public:
 
     //- The output control options
-    enum writeControls
+    enum timeControls
     {
         ocTimeStep,           //!< execution is coupled to the time-step
         ocWriteTime,          //!< execution is coupled to the write-time
         ocOutputTime,         //!< execution is coupled to the output-time
-        ocAdjustableRunTime,  //!< Adjust time step for dumping
-        ocRunTime,            //!< run time for dumping
-        ocClockTime,          //!< clock time for dumping
-        ocCpuTime,            //!< cpu time for dumping
+        ocAdjustableRunTime,  //!< Adjust time step for execution
+        ocRunTime,            //!< run time for execution
+        ocClockTime,          //!< clock time for execution
+        ocCpuTime,            //!< cpu time for execution
         ocNone                //!< no output
     };
 
@@ -77,28 +77,29 @@ private:
         //- Prefix
         const word prefix_;
 
-        //- String representation of writeControls enums
-        static const NamedEnum<writeControls, 8> writeControlNames_;
+        //- String representation of timeControls enums
+        static const NamedEnum<timeControls, 8> timeControlNames_;
 
         //- Type of output
-        writeControls writeControl_;
+        timeControls timeControl_;
 
-        //- The execution interval (in time steps) when using \c timeStep mode,
+        //- Execution interval steps for timeStep mode
         //  a value <= 1 means execute at every time step
-        label outputInterval_;
+        label intervalSteps_;
 
-        //- Dump each deltaT (adjust Ttime)
-        scalar writeInterval_;
+        //- Execution interval
+        scalar interval_;
 
-        //- Dumping counter for ocOutputTime or index dump
-        //  for ocAdjustableRunTime
-        label outputTimeLastDump_;
+        //- Index of previous execution
+        label executionIndex_;
 
 
     // Private Member Functions
 
         //- Disallow default bitwise copy construct and assignment
         outputFilterControl(const outputFilterControl&);
+
+        //- Disallow default bitwise assignment
         void operator=(const outputFilterControl&);
 
 
@@ -124,20 +125,20 @@ public:
         //- Read from dictionary
         void read(const dictionary&);
 
-        //- Return const access to the Time object
+        //- Return Time
         inline const Time& time() const;
 
-        //- Flag to indicate whether to output
-        bool output();
+        //- Flag to indicate whether to execute
+        bool execute();
 
-        //- Return writeControl
-        inline writeControls writeControl() const;
+        //- Return control
+        inline timeControls control() const;
 
-        //- Return writeInterval
-        inline scalar writeInterval() const;
+        //- Return interval
+        inline scalar interval() const;
 
-        //- Return outputTimeLastDump
-        inline label outputTimeLastDump() const;
+        //- Return the index of the previous execution
+        inline label executionIndex() const;
 };
 
 

src/OpenFOAM/db/functionObjects/outputFilterControl/outputFilterControlI.H

@@ -31,22 +31,22 @@ inline const Foam::Time& Foam::outputFilterControl::time() const
 }
 
 
-inline Foam::outputFilterControl::writeControls
-Foam::outputFilterControl::writeControl() const
+inline Foam::outputFilterControl::timeControls
+Foam::outputFilterControl::control() const
 {
-    return writeControl_;
+    return timeControl_;
 }
 
 
-inline Foam::scalar Foam::outputFilterControl::writeInterval() const
+inline Foam::scalar Foam::outputFilterControl::interval() const
 {
-    return writeInterval_;
+    return interval_;
 }
 
 
-inline Foam::label Foam::outputFilterControl::outputTimeLastDump() const
+inline Foam::label Foam::outputFilterControl::executionIndex() const
 {
-    return outputTimeLastDump_;
+    return executionIndex_;
 }