variables.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:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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.                                     *
 *                                                                           *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef DUMUX_COMMON_VARIABLES_HH
#define DUMUX_COMMON_VARIABLES_HH
 
#include <type_traits>
 
#include <dune/common/typetraits.hh>
#include <dumux/timestepping/timelevel.hh>
 
namespace Dumux::Experimental {
 
template<class X>
class Variables
{
    template<class T, bool indexable = Dune::IsIndexable<T>::value>
    struct ScalarT { using type = T; };
 
    template<class T>
    struct ScalarT<T, true>
    {
        using Element = std::decay_t<decltype(std::declval<T>()[0])>;
        using type = typename ScalarT<Element>::type;
    };
 
public:
    using SolutionVector = X;
 
    using Scalar = typename ScalarT<X>::type;
 
    using TimeLevel = Dumux::Experimental::TimeLevel<Scalar>;
 
    explicit Variables() : x_(), t_(0.0) {}
 
    explicit Variables(const SolutionVector& x,
                       const TimeLevel& t = TimeLevel{0.0})
    : x_(x), t_(t)
    {}
 
    explicit Variables(SolutionVector&& x,
                       const TimeLevel& t = TimeLevel{0.0})
    : x_(std::move(x)), t_(t)
    {}
 
    template<class Initializer,
              std::enable_if_t<(std::is_invocable_r_v<void, Initializer, X&>), int> = 0>
    explicit Variables(const Initializer& initializeSolution,
                       const TimeLevel& timeLevel = TimeLevel{0.0})
    : t_(timeLevel)
    {
        initializeSolution(x_);
    }
 
    const TimeLevel& timeLevel() const
    { return t_; }
 
    const SolutionVector& dofs() const { return x_; }
 
    SolutionVector& dofs() { return x_; }
 
    void update(const SolutionVector& x)
    { x_ = x; }
 
    void updateTime(const TimeLevel& t)
    { t_ = t; }
 
    void update(const SolutionVector& x,
                const TimeLevel& t)
    {
        x_ = x;
        t_ = t;
    }
 
private:
    SolutionVector x_;
    TimeLevel t_;
};
 
} // end namespace Dumux::Experimental
 
#endif