baseoutputmodule.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_BASE_OUTPUT_MODULE_HH
#define EWOMS_BASE_OUTPUT_MODULE_HH

#include "baseoutputwriter.hh"

#include <ewoms/common/parametersystem.hh>

#include <ewoms/common/propertysystem.hh>
#include <opm/common/ErrorMacros.hpp>

#include <dune/istl/bvector.hh>
#include <dune/common/fvector.hh>

#include <vector>
#include <sstream>
#include <string>
#include <array>

#include <cstdio>


namespace Ewoms {
namespace Properties {
// forward definition of property tags
NEW_PROP_TAG(NumPhases);
NEW_PROP_TAG(NumComponents);
NEW_PROP_TAG(NumEq);

NEW_PROP_TAG(Model);
NEW_PROP_TAG(Simulator);
NEW_PROP_TAG(Scalar);
NEW_PROP_TAG(Evaluation);
NEW_PROP_TAG(GridView);
NEW_PROP_TAG(ElementContext);
NEW_PROP_TAG(FluidSystem);
NEW_PROP_TAG(DiscBaseOutputModule);
} // namespace Properties

template<class TypeTag>
class BaseOutputModule
{
    typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
    typedef typename GET_PROP_TYPE(TypeTag, Model) Model;
    typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
    typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
    typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
    typedef typename GET_PROP_TYPE(TypeTag, FluidSystem) FluidSystem;
    typedef typename GET_PROP_TYPE(TypeTag, DiscBaseOutputModule) DiscBaseOutputModule;

    enum { numPhases = GET_PROP_VALUE(TypeTag, NumPhases) };
    enum { numComponents = GET_PROP_VALUE(TypeTag, NumComponents) };
    enum { numEq = GET_PROP_VALUE(TypeTag, NumEq) };
    enum { dim = GridView::dimension };
    enum { dimWorld = GridView::dimensionworld };

    typedef BaseOutputWriter::Tensor Tensor;

public:
    typedef BaseOutputWriter::ScalarBuffer ScalarBuffer;
    typedef BaseOutputWriter::VectorBuffer VectorBuffer;
    typedef BaseOutputWriter::TensorBuffer TensorBuffer;

    typedef std::array<ScalarBuffer, numEq> EqBuffer;
    typedef std::array<ScalarBuffer, numPhases> PhaseBuffer;
    typedef std::array<ScalarBuffer, numComponents> ComponentBuffer;
    typedef std::array<std::array<ScalarBuffer, numComponents>, numPhases> PhaseComponentBuffer;

    typedef std::array<VectorBuffer, numPhases> PhaseVectorBuffer;

    BaseOutputModule(const Simulator &simulator)
        : simulator_(simulator)
    {}

    virtual ~BaseOutputModule()
    {}

    virtual void allocBuffers() = 0;

    virtual void processElement(const ElementContext &elemCtx) = 0;

    virtual void commitBuffers(BaseOutputWriter &writer) = 0;

protected:
    enum BufferType {
        DofBuffer,

        VertexBuffer,

        ElementBuffer
    };

    void resizeScalarBuffer_(ScalarBuffer &buffer,
                             BufferType bufferType = DofBuffer)
    {
        Scalar n;
        if (bufferType == VertexBuffer)
            n = simulator_.gridView().size(dim);
        else if (bufferType == ElementBuffer)
            n = simulator_.gridView().size(0);
        else if (bufferType == DofBuffer)
            n = simulator_.model().numGridDof();
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");

        buffer.resize(n);
        std::fill(buffer.begin(), buffer.end(), 0.0);
    }

    void resizeTensorBuffer_(TensorBuffer &buffer,
                             BufferType bufferType = DofBuffer)
    {
        Scalar n;
        if (bufferType == VertexBuffer)
            n = simulator_.gridView().size(dim);
        else if (bufferType == ElementBuffer)
            n = simulator_.gridView().size(0);
        else if (bufferType == DofBuffer)
            n = simulator_.model().numGridDof();
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");

        buffer.resize(n);
        Tensor nullMatrix(dimWorld, dimWorld, 0.0);
        std::fill(buffer.begin(), buffer.end(), nullMatrix);
    }

    void resizeEqBuffer_(EqBuffer &buffer,
                         BufferType bufferType = DofBuffer)
    {
        Scalar n;
        if (bufferType == VertexBuffer)
            n = simulator_.gridView().size(dim);
        else if (bufferType == ElementBuffer)
            n = simulator_.gridView().size(0);
        else if (bufferType == DofBuffer)
            n = simulator_.model().numGridDof();
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");

        for (int i = 0; i < numEq; ++i) {
            buffer[i].resize(n);
            std::fill(buffer[i].begin(), buffer[i].end(), 0.0);
        }
    }

    void resizePhaseBuffer_(PhaseBuffer &buffer,
                            BufferType bufferType = DofBuffer)
    {
        Scalar n;
        if (bufferType == VertexBuffer)
            n = simulator_.gridView().size(dim);
        else if (bufferType == ElementBuffer)
            n = simulator_.gridView().size(0);
        else if (bufferType == DofBuffer)
            n = simulator_.model().numGridDof();
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");

        for (int i = 0; i < numPhases; ++i) {
            buffer[i].resize(n);
            std::fill(buffer[i].begin(), buffer[i].end(), 0.0);
        }
    }

    void resizeComponentBuffer_(ComponentBuffer &buffer,
                                BufferType bufferType = DofBuffer)
    {
        Scalar n;
        if (bufferType == VertexBuffer)
            n = simulator_.gridView().size(dim);
        else if (bufferType == ElementBuffer)
            n = simulator_.gridView().size(0);
        else if (bufferType == DofBuffer)
            n = simulator_.model().numGridDof();
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");

        for (int i = 0; i < numComponents; ++i) {
            buffer[i].resize(n);
            std::fill(buffer[i].begin(), buffer[i].end(), 0.0);
        }
    }

    void resizePhaseComponentBuffer_(PhaseComponentBuffer &buffer,
                                     BufferType bufferType = DofBuffer)
    {
        Scalar n;
        if (bufferType == VertexBuffer)
            n = simulator_.gridView().size(dim);
        else if (bufferType == ElementBuffer)
            n = simulator_.gridView().size(0);
        else if (bufferType == DofBuffer)
            n = simulator_.model().numGridDof();
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");

        for (int i = 0; i < numPhases; ++i) {
            for (int j = 0; j < numComponents; ++j) {
                buffer[i][j].resize(n);
                std::fill(buffer[i][j].begin(), buffer[i][j].end(), 0.0);
            }
        }
    }

    void commitScalarBuffer_(BaseOutputWriter &baseWriter,
                             const char *name,
                             ScalarBuffer &buffer,
                             BufferType bufferType = DofBuffer)
    {
        if (bufferType == DofBuffer)
            DiscBaseOutputModule::attachScalarDofData_(baseWriter, buffer, name);
        else if (bufferType == VertexBuffer)
            attachScalarVertexData_(baseWriter, buffer, name);
        else if (bufferType == ElementBuffer)
            attachScalarElementData_(baseWriter, buffer, name);
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");
    }

    void commitVectorBuffer_(BaseOutputWriter &baseWriter,
                             const char *name,
                             VectorBuffer &buffer,
                             BufferType bufferType = DofBuffer)
    {
        if (bufferType == DofBuffer)
            DiscBaseOutputModule::attachVectorDofData_(baseWriter, buffer, name);
        else if (bufferType == VertexBuffer)
            attachVectorVertexData_(baseWriter, buffer, name);
        else if (bufferType == ElementBuffer)
            attachVectorElementData_(baseWriter, buffer, name);
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");
    }

    void commitTensorBuffer_(BaseOutputWriter &baseWriter,
                             const char *name,
                             TensorBuffer &buffer,
                             BufferType bufferType = DofBuffer)
    {
        if (bufferType == DofBuffer)
            DiscBaseOutputModule::attachTensorDofData_(baseWriter, buffer, name);
        else if (bufferType == VertexBuffer)
            attachTensorVertexData_(baseWriter, buffer, name);
        else if (bufferType == ElementBuffer)
            attachTensorElementData_(baseWriter, buffer, name);
        else
            OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");
    }

    void commitPriVarsBuffer_(BaseOutputWriter &baseWriter,
                              const char *pattern,
                              EqBuffer &buffer,
                              BufferType bufferType = DofBuffer)
    {
        char name[512];
        for (int i = 0; i < numEq; ++i) {
            std::string eqName = simulator_.model().primaryVarName(i);
            snprintf(name, 512, pattern, eqName.c_str());

            if (bufferType == DofBuffer)
                DiscBaseOutputModule::attachScalarDofData_(baseWriter, buffer[i], name);
            else if (bufferType == VertexBuffer)
                attachScalarVertexData_(baseWriter, buffer[i], name);
            else if (bufferType == ElementBuffer)
                attachScalarElementData_(baseWriter, buffer[i], name);
            else
                OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");
        }
    }

    void commitEqBuffer_(BaseOutputWriter &baseWriter,
                         const char *pattern,
                         EqBuffer &buffer,
                         BufferType bufferType = DofBuffer)
    {
        char name[512];
        for (int i = 0; i < numEq; ++i) {
            std::ostringstream oss;
            oss << i;
            snprintf(name, 512, pattern, oss.str().c_str());

            if (bufferType == DofBuffer)
                DiscBaseOutputModule::attachScalarDofData_(baseWriter, buffer[i], name);
            else if (bufferType == VertexBuffer)
                attachScalarVertexData_(baseWriter, buffer[i], name);
            else if (bufferType == ElementBuffer)
                attachScalarElementData_(baseWriter, buffer[i], name);
            else
                OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");
        }
    }

    void commitPhaseBuffer_(BaseOutputWriter &baseWriter,
                            const char *pattern,
                            PhaseBuffer &buffer,
                            BufferType bufferType = DofBuffer)
    {
        char name[512];
        for (int i = 0; i < numPhases; ++i) {
            snprintf(name, 512, pattern, FluidSystem::phaseName(i));

            if (bufferType == DofBuffer)
                DiscBaseOutputModule::attachScalarDofData_(baseWriter, buffer[i], name);
            else if (bufferType == VertexBuffer)
                attachScalarVertexData_(baseWriter, buffer[i], name);
            else if (bufferType == ElementBuffer)
                attachScalarElementData_(baseWriter, buffer[i], name);
            else
                OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");
        }
    }

    void commitComponentBuffer_(BaseOutputWriter &baseWriter,
                                const char *pattern,
                                ComponentBuffer &buffer,
                                BufferType bufferType = DofBuffer)
    {
        char name[512];
        for (int i = 0; i < numComponents; ++i) {
            snprintf(name, 512, pattern, FluidSystem::componentName(i));

            if (bufferType == DofBuffer)
                DiscBaseOutputModule::attachScalarDofData_(baseWriter, buffer[i], name);
            else if (bufferType == VertexBuffer)
                attachScalarVertexData_(baseWriter, buffer[i], name);
            else if (bufferType == ElementBuffer)
                attachScalarElementData_(baseWriter, buffer[i], name);
            else
                OPM_THROW(std::logic_error, "bufferType must be one of Dof, Vertex or Element");
        }
    }

    void commitPhaseComponentBuffer_(BaseOutputWriter &baseWriter,
                                     const char *pattern,
                                     PhaseComponentBuffer &buffer,
                                     BufferType bufferType = DofBuffer)
    {
        char name[512];
        for (int i= 0; i < numPhases; ++i) {
            for (int j = 0; j < numComponents; ++j) {
                snprintf(name, 512, pattern,
                         FluidSystem::phaseName(i),
                         FluidSystem::componentName(j));

                if (bufferType == DofBuffer)
                    DiscBaseOutputModule::attachScalarDofData_(baseWriter, buffer[i][j], name);
                else if (bufferType == VertexBuffer)
                    attachScalarVertexData_(baseWriter, buffer[i][j], name);
                else if (bufferType == ElementBuffer)
                    attachScalarElementData_(baseWriter, buffer[i][j], name);
                else
                    OPM_THROW(std::logic_error,
                              "bufferType must be one of Dof, Vertex or Element");
            }
        }
    }

    void attachScalarElementData_(BaseOutputWriter &baseWriter,
                                  ScalarBuffer &buffer,
                                  const char *name)
    { baseWriter.attachScalarElementData(buffer, name); }

    void attachScalarVertexData_(BaseOutputWriter &baseWriter,
                                 ScalarBuffer &buffer,
                                 const char *name)
    { baseWriter.attachScalarVertexData(buffer, name); }

    void attachVectorElementData_(BaseOutputWriter &baseWriter,
                                  VectorBuffer &buffer,
                                  const char *name)
    { baseWriter.attachVectorElementData(buffer, name); }

    void attachVectorVertexData_(BaseOutputWriter &baseWriter,
                                 VectorBuffer &buffer,
                                 const char *name)
    { baseWriter.attachVectorVertexData(buffer, name); }

    void attachTensorElementData_(BaseOutputWriter &baseWriter,
                                  TensorBuffer &buffer,
                                  const char *name)
    { baseWriter.attachTensorElementData(buffer, name); }

    void attachTensorVertexData_(BaseOutputWriter &baseWriter,
                                 TensorBuffer &buffer,
                                 const char *name)
    { baseWriter.attachTensorVertexData(buffer, name); }

    const Simulator &simulator_;
};

} // namespace Ewoms

#endif