fvbasenewtonconvergencewriter.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  Copyright (C) 2011-2013 by Andreas Lauser

  This file is part of the Open Porous Media project (OPM).

  OPM 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 2 of the License, or
  (at your option) any later version.

  OPM 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 OPM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef EWOMS_FV_BASE_NEWTON_CONVERGENCE_WRITER_HH
#define EWOMS_FV_BASE_NEWTON_CONVERGENCE_WRITER_HH

#include <ewoms/io/vtkmultiwriter.hh>
#include <ewoms/common/propertysystem.hh>

#include <iostream>

namespace Ewoms {
namespace Properties {
// forward declaration of the required property tags
NEW_PROP_TAG(GridView);
NEW_PROP_TAG(NewtonMethod);
NEW_PROP_TAG(SolutionVector);
NEW_PROP_TAG(GlobalEqVector);
NEW_PROP_TAG(VtkOutputFormat);
} // namespace Properties

template <class TypeTag>
class FvBaseNewtonConvergenceWriter
{
    typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;

    typedef typename GET_PROP_TYPE(TypeTag, SolutionVector) SolutionVector;
    typedef typename GET_PROP_TYPE(TypeTag, GlobalEqVector) GlobalEqVector;
    typedef typename GET_PROP_TYPE(TypeTag, NewtonMethod) NewtonMethod;

    static const int vtkFormat = GET_PROP_VALUE(TypeTag, VtkOutputFormat);
    typedef Ewoms::VtkMultiWriter<GridView, vtkFormat> VtkMultiWriter;

public:
    FvBaseNewtonConvergenceWriter(NewtonMethod &nm)
        : newtonMethod_(nm)
    {
        timeStepIdx_ = 0;
        iteration_ = 0;
        vtkMultiWriter_ = 0;
    }

    ~FvBaseNewtonConvergenceWriter()
    { delete vtkMultiWriter_; }

    void beginTimeStep()
    {
        ++timeStepIdx_;
        iteration_ = 0;
    }

    void beginIteration()
    {
        ++ iteration_;
        if (!vtkMultiWriter_)
            vtkMultiWriter_ =
                new VtkMultiWriter(newtonMethod_.problem().gridView(), "convergence");
        vtkMultiWriter_->beginWrite(timeStepIdx_ + iteration_ / 100.0);
    }

    void writeFields(const SolutionVector &uLastIter,
                     const GlobalEqVector &deltaU)
    {
        try {
            newtonMethod_.problem().model().addConvergenceVtkFields(*vtkMultiWriter_,
                                                                    uLastIter,
                                                                    deltaU);
        }
        catch (...) {
            std::cout << "Oops: exception thrown on rank "
                      << newtonMethod_.problem().gridView().comm().rank()
                      << " while writing the convergence\n"  << std::flush;
        }
    }

    void endIteration()
    { vtkMultiWriter_->endWrite(); }

    void endTimeStep()
    { iteration_ = 0; }

private:
    int timeStepIdx_;
    int iteration_;
    VtkMultiWriter *vtkMultiWriter_;
    NewtonMethod &newtonMethod_;
};

} // namespace Ewoms

#endif