/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2014-2016 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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 "partialWrite.H"
#include "dictionary.H"
#include "Time.H"
#include "IOobjectList.H"
#include "polyMesh.H"
#include "cloud.H"

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

namespace Foam
{
namespace functionObjects
{
    defineTypeNameAndDebug(partialWrite, 0);
}
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::functionObjects::partialWrite::partialWrite
(
    const word& name,
    const objectRegistry& obr,
    const dictionary& dict,
    const bool loadFromFiles
)
:
    name_(name),
    obr_(obr)
{
    read(dict);
}


bool Foam::functionObjects::partialWrite::viable
(
    const word& name,
    const objectRegistry& obr,
    const dictionary& dict,
    const bool loadFromFiles
)
{
    // Construction is viable if the available mesh is an fvMesh
    return isA<fvMesh>(obr);
}


// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

Foam::functionObjects::partialWrite::~partialWrite()
{}


// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

void Foam::functionObjects::partialWrite::read(const dictionary& dict)
{
    dict.lookup("objectNames") >> objectNames_;
    dict.lookup("writeInterval") >> writeInterval_;
    writeInstance_ = 0;

    Info<< type() << " " << name() << ":" << nl
        << "    dumping every " << writeInterval_
        << " th outputTime : " << nl << endl ;

    forAllConstIter(HashSet<word>, objectNames_, iter)
    {
        Info<< ' ' << iter.key();
    }

    if (writeInterval_ < 1)
    {
        FatalIOErrorInFunction(dict)
            << "Illegal value for writeInterval " << writeInterval_
            << ". It should be >= 1."
            << exit(FatalIOError);
    }

    // Clear out any previously loaded fields
    vsf_.clear();
    vvf_.clear();
    vSpheretf_.clear();
    vSymmtf_.clear();
    vtf_.clear();

    ssf_.clear();
    svf_.clear();
    sSpheretf_.clear();
    sSymmtf_.clear();
    stf_.clear();

    forAllConstIter(HashSet<word>, objectNames_, iter)
    {
        loadField<scalar>(iter.key(), vsf_, ssf_);
        loadField<vector>(iter.key(), vvf_, svf_);
        loadField<sphericalTensor>(iter.key(), vSpheretf_, sSpheretf_);
        loadField<symmTensor>(iter.key(), vSymmtf_, sSymmtf_);
        loadField<tensor>(iter.key(), vtf_, stf_);
    }
}


void Foam::functionObjects::partialWrite::execute()
{}


void Foam::functionObjects::partialWrite::end()
{}


void Foam::functionObjects::partialWrite::timeSet()
{
    if (obr_.time().outputTime())
    {
        writeInstance_++;

        if (writeInstance_ == writeInterval_)
        {
            // Next overall dump corresponds to partial write. Change
            // write options to AUTO_WRITE
            writeInstance_ = 0;

            changeWriteOptions<scalar>(vsf_, ssf_, IOobject::AUTO_WRITE);
            changeWriteOptions<vector>(vvf_, svf_, IOobject::AUTO_WRITE);
            changeWriteOptions<sphericalTensor>
            (
                vSpheretf_,
                sSpheretf_,
                IOobject::AUTO_WRITE
            );
            changeWriteOptions<symmTensor>
            (
                vSymmtf_,
                sSymmtf_,
                IOobject::AUTO_WRITE
            );
            changeWriteOptions<tensor>(vtf_, stf_, IOobject::AUTO_WRITE);
        }
        else
        {
            changeWriteOptions<scalar>(vsf_, ssf_, IOobject::NO_WRITE);
            changeWriteOptions<vector>(vvf_, svf_, IOobject::NO_WRITE);
            changeWriteOptions<sphericalTensor>
            (
                vSpheretf_,
                sSpheretf_,
                IOobject::NO_WRITE
            );
            changeWriteOptions<symmTensor>
            (
                vSymmtf_,
                sSymmtf_,
                IOobject::NO_WRITE
            );
            changeWriteOptions<tensor>(vtf_, stf_, IOobject::NO_WRITE);
        }
    }
}


void Foam::functionObjects::partialWrite::write()
{
    // Fields are written in the standard manner
}


// ************************************************************************* //