ENH: Function objects - first pass at updating read functionality

Note: should be using the result of the parent::read(dict) when
deciding whether to read local entries...

src/functionObjects/field/DESModelRegions/DESModelRegions.C

@@ -110,6 +110,7 @@ Foam::functionObjects::DESModelRegions::~DESModelRegions()
 
 bool Foam::functionObjects::DESModelRegions::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
     writeFile::read(dict);
 
     dict.readIfPresent("resultName", resultName_);

src/functionObjects/field/PecletNo/PecletNo.C

@@ -144,6 +144,7 @@ Foam::functionObjects::PecletNo::PecletNo
     rhoName_("rho")
 {
     setResultName("Pe", "phi");
+    read(dict);
 }
 
 

src/functionObjects/field/XiReactionRate/XiReactionRate.C

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
-     \\/     M anipulation  |
+     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -63,6 +63,12 @@ Foam::functionObjects::XiReactionRate::~XiReactionRate()
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
+bool Foam::functionObjects::XiReactionRate::read(const dictionary& dict)
+{
+    return fvMeshFunctionObject::read(dict);
+}
+
+
 bool Foam::functionObjects::XiReactionRate::execute()
 {
     return true;

src/functionObjects/field/XiReactionRate/XiReactionRate.H

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
-     \\/     M anipulation  |
+     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -107,10 +107,13 @@ public:
 
     // Member Functions
 
+        //- Read the reaction rate data
+        virtual bool read(const dictionary&);
+
         //- Do nothing
         virtual bool execute();
 
-        //- Write the cell-centre fields
+        //- Write the reaction rate fields
         virtual bool write();
 };
 

src/functionObjects/field/components/components.C

@@ -63,9 +63,7 @@ Foam::functionObjects::components::components
 )
 :
     fieldExpression(name, runTime, dict)
-{
+{}
-    read(dict);
-}
 
 
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

src/functionObjects/field/ddt2/ddt2.C

@@ -196,6 +196,8 @@ Foam::functionObjects::ddt2::~ddt2()
 
 bool Foam::functionObjects::ddt2::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
+
     if (word(mesh_.ddtScheme("default")) == "steadyState")
     {
         WarningInFunction

src/functionObjects/field/externalCoupled/externalCoupled.C

@@ -854,6 +854,8 @@ bool Foam::functionObjects::externalCoupled::end()
 
 bool Foam::functionObjects::externalCoupled::read(const dictionary& dict)
 {
+    functionObject::read(dict);
+
     dict.readIfPresent("enabled", enabled_);
 
     if (!enabled_)

src/functionObjects/field/fluxSummary/fluxSummary.C

@@ -619,6 +619,7 @@ Foam::functionObjects::fluxSummary::~fluxSummary()
 
 bool Foam::functionObjects::fluxSummary::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
     writeFile::read(dict);
 
     mode_ = modeTypeNames_.read(dict.lookup("mode"));

src/functionObjects/field/grad/grad.C

@@ -61,9 +61,7 @@ Foam::functionObjects::grad::grad
 )
 :
     fieldExpression(name, runTime, dict)
-{
+{}
-    read(dict);
-}
 
 
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

src/functionObjects/field/histogram/histogram.C

@@ -92,6 +92,8 @@ Foam::functionObjects::histogram::~histogram()
 
 bool Foam::functionObjects::histogram::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
+
     dict.lookup("field") >> fieldName_;
     dict.lookup("max") >> max_;
     min_ = dict.lookupOrDefault<scalar>("min", 0);

src/functionObjects/field/mag/mag.C

@@ -64,9 +64,7 @@ Foam::functionObjects::mag::mag
 )
 :
     fieldExpression(name, runTime, dict)
-{
+{}
-    read(dict);
-}
 
 
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

src/functionObjects/field/magSqr/magSqr.C

@@ -64,9 +64,7 @@ Foam::functionObjects::magSqr::magSqr
 )
 :
     fieldExpression(name, runTime, dict)
-{
+{}
-    read(dict);
-}
 
 
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

src/functionObjects/field/mapFields/mapFields.C

@@ -166,6 +166,8 @@ Foam::functionObjects::mapFields::~mapFields()
 
 bool Foam::functionObjects::mapFields::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
+
     dict.lookup("fields") >> fieldNames_;
     createInterpolation(dict);
     return true;

src/functionObjects/field/pressure/pressure.C

@@ -230,6 +230,8 @@ Foam::functionObjects::pressure::~pressure()
 
 bool Foam::functionObjects::pressure::read(const dictionary& dict)
 {
+    fieldExpression::read(dict);
+
     dict.readIfPresent("U", UName_);
     dict.readIfPresent("rho", rhoName_);
 

src/functionObjects/field/reactionSensitivityAnalysis/reactionsSensitivityAnalysis.C

@@ -267,6 +267,7 @@ bool Foam::functionObjects::reactionsSensitivityAnalysis<chemistryType>::read
     const dictionary& dict
 )
 {
+    fvMeshFunctionObject::read(dict);
     writeFile::read(dict);
     return true;
 }

src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.C

@@ -353,6 +353,8 @@ Foam::functionObjects::regionSizeDistribution::~regionSizeDistribution()
 
 bool Foam::functionObjects::regionSizeDistribution::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
+
     dict.lookup("field") >> alphaName_;
     dict.lookup("patches") >> patchNames_;
     dict.lookup("threshold") >> threshold_;

src/functionObjects/field/streamLine/streamLineBase.C

@@ -507,6 +507,8 @@ Foam::functionObjects::streamLineBase::~streamLineBase()
 
 bool Foam::functionObjects::streamLineBase::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
+
     Info<< type() << " " << name() << ":" << nl;
 
     dict.lookup("fields") >> fields_;

src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.C

@@ -74,6 +74,8 @@ bool Foam::functionObjects::surfaceInterpolate::read
     const dictionary& dict
 )
 {
+    fvMeshFunctionObject::read(dict);
+
     dict.lookup("fields") >> fieldSet_;
 
     return true;

src/functionObjects/field/turbulenceFields/turbulenceFields.C

@@ -146,6 +146,8 @@ Foam::functionObjects::turbulenceFields::~turbulenceFields()
 
 bool Foam::functionObjects::turbulenceFields::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
+
     if (dict.found("field"))
     {
         fieldSet_.insert(word(dict.lookup("field")));

src/functionObjects/field/valueAverage/valueAverage.C

@@ -106,6 +106,7 @@ Foam::functionObjects::valueAverage::~valueAverage()
 
 bool Foam::functionObjects::valueAverage::read(const dictionary& dict)
 {
+    regionFunctionObject::read(dict);
     writeFile::read(dict);
 
     dict.lookup("functionObjectName") >> functionObjectName_;

src/functionObjects/field/writeCellCentres/writeCellCentres.C

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
-     \\/     M anipulation  |
+     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -62,6 +62,12 @@ Foam::functionObjects::writeCellCentres::~writeCellCentres()
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
+bool Foam::functionObjects::writeCellCentres::read(const dictionary& dict)
+{
+    return fvMeshFunctionObject::read(dict);
+}
+
+
 bool Foam::functionObjects::writeCellCentres::execute()
 {
     return true;

src/functionObjects/field/writeCellCentres/writeCellCentres.H

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
-     \\/     M anipulation  |
+     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -107,6 +107,9 @@ public:
 
     // Member Functions
 
+        //- Read the cell-centre rate data
+        virtual bool read(const dictionary&);
+
         //- Do nothing
         virtual bool execute();
 

src/functionObjects/field/writeCellVolumes/writeCellVolumes.C

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
-     \\/     M anipulation  |
+     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -62,6 +62,12 @@ Foam::functionObjects::writeCellVolumes::~writeCellVolumes()
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
+bool Foam::functionObjects::writeCellVolumes::read(const dictionary& dict)
+{
+    return fvMeshFunctionObject::read(dict);
+}
+
+
 bool Foam::functionObjects::writeCellVolumes::execute()
 {
     return true;

src/functionObjects/field/writeCellVolumes/writeCellVolumes.H

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
-     \\/     M anipulation  |
+     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -106,10 +106,13 @@ public:
 
     // Member Functions
 
+        //- Read the cell-volume data
+        virtual bool read(const dictionary&);
+
         //- Do nothing
         virtual bool execute();
 
-        //- Write the cell-centre fields
+        //- Write the cell-volume fields
         virtual bool write();
 };
 

src/functionObjects/field/zeroGradient/zeroGradient.C

@@ -181,6 +181,8 @@ Foam::functionObjects::zeroGradient::~zeroGradient()
 
 bool Foam::functionObjects::zeroGradient::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
+
     dict.lookup("fields") >> selectFields_;
     uniqWords(selectFields_);
 

src/functionObjects/graphics/runTimePostProcessing/runTimePostProcessing.C

@@ -90,6 +90,8 @@ Foam::functionObjects::runTimePostProcessing::~runTimePostProcessing()
 
 bool Foam::functionObjects::runTimePostProcessing::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
+
     Info<< type() << " " << name() << ": reading post-processing data" << endl;
 
     scene_.read(dict);

src/functionObjects/lagrangian/dsmcFields/dsmcFields.C

@@ -75,6 +75,7 @@ Foam::functionObjects::dsmcFields::~dsmcFields()
 
 bool Foam::functionObjects::dsmcFields::read(const dictionary& dict)
 {
+    fvMeshFunctionObject::read(dict);
     return true;
 }
 

src/functionObjects/utilities/abort/abort.C

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
-     \\/     M anipulation  |
+     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -114,6 +114,8 @@ Foam::functionObjects::abort::~abort()
 
 bool Foam::functionObjects::abort::read(const dictionary& dict)
 {
+    functionObject::read(dict);
+
     if (dict.found("action"))
     {
         action_ = actionTypeNames_.read(dict.lookup("action"));

src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C

@@ -184,6 +184,8 @@ bool Foam::codedFunctionObject::end()
 
 bool Foam::codedFunctionObject::read(const dictionary& dict)
 {
+    functionObject::read(dict);
+
     // Backward compatibility
     if (dict.found("redirectType"))
     {

src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.C

@@ -72,6 +72,8 @@ Foam::functionObjects::removeRegisteredObject::~removeRegisteredObject()
 
 bool Foam::functionObjects::removeRegisteredObject::read(const dictionary& dict)
 {
+    regionFunctionObject::read(dict);
+
     dict.lookup("objects") >> objectNames_;
 
     return true;

src/functionObjects/utilities/runTimeControl/runTimeControl.C

@@ -77,6 +77,8 @@ bool Foam::functionObjects::runTimeControls::runTimeControl::read
     const dictionary& dict
 )
 {
+    fvMeshFunctionObject::read(dict);
+
     const dictionary& conditionsDict = dict.subDict("conditions");
     const wordList conditionNames(conditionsDict.toc());
     conditions_.setSize(conditionNames.size());

src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.C

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2013-2016 OpenFOAM Foundation
-     \\/     M anipulation  |
+     \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -92,6 +92,8 @@ bool Foam::functionObjects::setTimeStepFunctionObject::read
     const dictionary& dict
 )
 {
+    functionObject::read(dict);
+
     timeStepPtr_ = Function1<scalar>::New("deltaT", dict);
 
     // Check that adjustTimeStep is active

src/functionObjects/utilities/systemCall/systemCall.C

@@ -74,6 +74,8 @@ Foam::functionObjects::systemCall::~systemCall()
 
 bool Foam::functionObjects::systemCall::read(const dictionary& dict)
 {
+    functionObject::read(dict);
+
     dict.readIfPresent("executeCalls", executeCalls_);
     dict.readIfPresent("endCalls", endCalls_);
     dict.readIfPresent("writeCalls", writeCalls_);

src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.C

@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2015 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2015-2016 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -103,6 +103,8 @@ bool Foam::functionObjects::timeActivatedFileUpdate::read
     const dictionary& dict
 )
 {
+    functionObject::read(dict);
+
     dict.lookup("fileToUpdate") >> fileToUpdate_;
     dict.lookup("timeVsFile") >> timeVsFile_;
 

src/functionObjects/utilities/writeDictionary/writeDictionary.C

@@ -122,6 +122,8 @@ Foam::functionObjects::writeDictionary::~writeDictionary()
 
 bool Foam::functionObjects::writeDictionary::read(const dictionary& dict)
 {
+    regionFunctionObject::read(dict);
+
     wordList dictNames(dict.lookup("dictNames"));
     HashSet<word> uniqueNames(dictNames);
     dictNames_ = uniqueNames.toc();

src/functionObjects/utilities/writeObjects/writeObjects.C

@@ -98,6 +98,8 @@ Foam::functionObjects::writeObjects::~writeObjects()
 
 bool Foam::functionObjects::writeObjects::read(const dictionary& dict)
 {
+    functionObject::read(dict);
+
     if (dict.found("field"))
     {
         objectNames_.setSize(1);