STYLE: Renamed residuals FO -> solverInfo to reflect capabilities

src/functionObjects/utilities/solverInfo/solverInfo.C

@@ -0,0 +1,233 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2015-2016 OpenFOAM Foundation
+     \\/     M anipulation  | Copyright (C) 2015-2019 OpenCFD Ltd.
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "solverInfo.H"
+#include "addToRunTimeSelectionTable.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+    defineTypeNameAndDebug(solverInfo, 0);
+
+    addToRunTimeSelectionTable
+    (
+        functionObject,
+        solverInfo,
+        dictionary
+    );
+}
+}
+
+
+// * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
+
+void Foam::functionObjects::solverInfo::writeFileHeader(Ostream& os)
+{
+    if (!fieldSet_.updateSelection())
+    {
+        return;
+    }
+
+    if (writtenHeader_)
+    {
+        writeBreak(file());
+    }
+    else
+    {
+        writeHeader(os, "Solver information");
+    }
+
+    writeCommented(os, "Time");
+
+    for (const word& fieldName : fieldSet_.selectionNames())
+    {
+        writeFileHeader<scalar>(os, fieldName);
+        writeFileHeader<vector>(os, fieldName);
+        writeFileHeader<sphericalTensor>(os, fieldName);
+        writeFileHeader<symmTensor>(os, fieldName);
+        writeFileHeader<tensor>(os, fieldName);
+    }
+
+    os << endl;
+
+    writtenHeader_ = true;
+}
+
+
+void Foam::functionObjects::solverInfo::createResidualField
+(
+    const word& fieldName
+)
+{
+    if (!writeResidualFields_)
+    {
+        return;
+    }
+
+    const word residualName("initialResidual:" + fieldName);
+
+    if (!mesh_.foundObject<IOField<scalar>>(residualName))
+    {
+        IOField<scalar>* fieldPtr =
+            new IOField<scalar>
+            (
+                IOobject
+                (
+                    residualName,
+                    mesh_.time().timeName(),
+                    mesh_,
+                    IOobject::NO_READ,
+                    IOobject::NO_WRITE
+                ),
+                Field<scalar>(mesh_.nCells(), Zero)
+            );
+
+        fieldPtr->store();
+    }
+}
+
+
+void Foam::functionObjects::solverInfo::writeResidualField
+(
+    const word& fieldName
+) const
+{
+    const word residualName("initialResidual:" + fieldName);
+
+    const auto* residualPtr = mesh_.findObject<IOField<scalar>>(residualName);
+
+    if (residualPtr)
+    {
+        volScalarField residual
+        (
+            IOobject
+            (
+                residualName,
+                mesh_.time().timeName(),
+                mesh_,
+                IOobject::NO_READ,
+                IOobject::NO_WRITE,
+                false
+            ),
+            mesh_,
+            dimensionedScalar(dimless, Zero),
+            zeroGradientFvPatchField<scalar>::typeName
+        );
+
+        residual.primitiveFieldRef() = *residualPtr;
+        residual.correctBoundaryConditions();
+
+        residual.write();
+    }
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::solverInfo::solverInfo
+(
+    const word& name,
+    const Time& runTime,
+    const dictionary& dict
+)
+:
+    fvMeshFunctionObject(name, runTime, dict),
+    writeFile(obr_, name, typeName, dict),
+    fieldSet_(mesh_),
+    writeResidualFields_(false),
+    initialised_(false)
+{
+    read(dict);
+}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+bool Foam::functionObjects::solverInfo::read(const dictionary& dict)
+{
+    if (fvMeshFunctionObject::read(dict))
+    {
+        fieldSet_.read(dict);
+
+        writeResidualFields_ =
+            dict.lookupOrDefault("writeResidualFields", false);
+
+        return true;
+    }
+
+    return false;
+}
+
+
+bool Foam::functionObjects::solverInfo::execute()
+{
+    // Note: delaying initialisation until after first iteration so that
+    // we can find wildcard fields
+    if (!initialised_)
+    {
+        writeFileHeader(file());
+
+        if (writeResidualFields_)
+        {
+            for (const word& fieldName : fieldSet_.selectionNames())
+            {
+                initialiseResidualField<scalar>(fieldName);
+                initialiseResidualField<vector>(fieldName);
+                initialiseResidualField<sphericalTensor>(fieldName);
+                initialiseResidualField<symmTensor>(fieldName);
+                initialiseResidualField<tensor>(fieldName);
+            }
+        }
+
+        initialised_ = true;
+    }
+
+    return true;
+}
+
+
+bool Foam::functionObjects::solverInfo::write()
+{
+    writeTime(file());
+
+    for (const word& fieldName : fieldSet_.selectionNames())
+    {
+        writeSolverInfo<scalar>(fieldName);
+        writeSolverInfo<vector>(fieldName);
+        writeSolverInfo<sphericalTensor>(fieldName);
+        writeSolverInfo<symmTensor>(fieldName);
+        writeSolverInfo<tensor>(fieldName);
+    }
+
+    file() << endl;
+
+    return true;
+}
+
+
+// ************************************************************************* //