residuals.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
     \\/     M anipulation  | Copyright (C) 2015 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 "residuals.H"
#include "volFields.H"
#include "dictionary.H"
#include "Time.H"
 
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
namespace Foam
{
    defineTypeNameAndDebug(residuals, 0);
}
 
 
// * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
 
void Foam::residuals::writeFileHeader(Ostream& os) const
{
    writeHeader(os, "Residuals");
    writeCommented(os, "Time");
 
    forAll(fieldSet_, fieldI)
    {
        writeTabbed(os, fieldSet_[fieldI]);
    }
 
    os << endl;
}
 
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::residuals::residuals
(
    const word& name,
    const objectRegistry& obr,
    const dictionary& dict,
    const bool loadFromFiles
)
:
    functionObjectFile(obr, name, typeName, dict),
    name_(name),
    obr_(obr),
    active_(true),
    fieldSet_()
{
    // Check if the available mesh is an fvMesh otherwise deactivate
    if (!isA<fvMesh>(obr_))
    {
        active_ = false;
        WarningInFunction
            << "No fvMesh available, deactivating " << name_
            << endl;
    }
 
    if (active_)
    {
        read(dict);
        writeFileHeader(file());
    }
}
 
 
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
Foam::residuals::~residuals()
{}
 
 
// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
void Foam::residuals::read(const dictionary& dict)
{
    if (active_)
    {
        functionObjectFile::read(dict);
 
        wordList allFields(dict.lookup("fields"));
        wordHashSet uniqueFields(allFields);
        fieldSet_ = uniqueFields.toc();
    }
}
 
 
void Foam::residuals::execute()
{}
 
 
void Foam::residuals::end()
{}
 
 
void Foam::residuals::timeSet()
{}
 
 
void Foam::residuals::write()
{
    if (active_)
    {
        if (Pstream::master())
        {
            writeTime(file());
 
            forAll(fieldSet_, fieldI)
            {
                const word& fieldName = fieldSet_[fieldI];
 
                writeResidual<scalar>(fieldName);
                writeResidual<vector>(fieldName);
                writeResidual<sphericalTensor>(fieldName);
                writeResidual<symmTensor>(fieldName);
                writeResidual<tensor>(fieldName);
            }
 
            file() << endl;
        }
    }
}
 
 
// ************************************************************************* //