fvbaseprimaryvariables.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-2014 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_PRIMARY_VARIABLES_HH
#define EWOMS_FV_BASE_PRIMARY_VARIABLES_HH

#include <dune/common/fvector.hh>

#include "fvbaseproperties.hh"

namespace Ewoms {

template <class TypeTag>
class FvBasePrimaryVariables
    : public Dune::FieldVector<typename GET_PROP_TYPE(TypeTag, Scalar),
                               GET_PROP_VALUE(TypeTag, NumEq)>
{
    typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
    typedef typename GET_PROP_TYPE(TypeTag, Evaluation) Evaluation;

    enum { numEq = GET_PROP_VALUE(TypeTag, NumEq) };

    typedef Opm::MathToolbox<Evaluation> Toolbox;
    typedef Dune::FieldVector<Scalar, numEq> ParentType;

public:
    FvBasePrimaryVariables()
        : ParentType()
    { Valgrind::SetUndefined(*this); }

    FvBasePrimaryVariables(Scalar value)
        : ParentType(value)
    { }

    FvBasePrimaryVariables(const FvBasePrimaryVariables &value)
        : ParentType(value)
    { }

    Evaluation makeEvaluation(int varIdx, int timeIdx) const
    {
        if (timeIdx == 0)
            return Toolbox::createVariable((*this)[varIdx], varIdx);
        else
            return Toolbox::createConstant((*this)[varIdx]);
    }

    template <class FluidState>
    void assignNaive(const FluidState &fluidState)
    {
        OPM_THROW(std::runtime_error,
                  "The PrimaryVariables class does not define a assignNaive() method");
    }
    void checkDefined() const
    {
        Valgrind::CheckDefined(*static_cast<const ParentType*>(this));
    }
};

} // namespace Ewoms

#endif