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:
//
// SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_COMMON_VARIABLES_HH
#define DUMUX_COMMON_VARIABLES_HH
 
#include <type_traits>
 
#include <dune/common/typetraits.hh>
#include <dumux/experimental/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