switchableprimaryvariables.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-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_SWITCHABLE_PRIMARY_VARIABLES_HH
#define DUMUX_SWITCHABLE_PRIMARY_VARIABLES_HH
 
#include <dune/common/ftraits.hh>
#include <dune/common/exceptions.hh>
#include <dumux/common/numeqvector.hh>
 
namespace Dumux {
 
template<class PrimaryVariables, class StateType>
class SwitchablePrimaryVariables : public PrimaryVariables
{
    using ParentType = PrimaryVariables;
public:
    using ParentType::ParentType;
    using ParentType::operator=;
 
    StateType state() const
    {
        if (!stateIsSet_)
            DUNE_THROW(Dune::InvalidStateException, "Model demands setting a primary variable state (like a phase presence)"
                                                 << " but none was set! Use its setState method to set the state.");
 
        return state_;
    }
 
    void setState(StateType state)
    {
        // NOTE: we use a copy instead of a reference in the signature to
        // avoid linker errors related to passing a static variable to this function
        state_ = std::move(state);
        stateIsSet_ = true;
    }
 
    bool stateIsSet() const
    {
        return stateIsSet_;
    }
 
    void invalidateState()
    {
        stateIsSet_ = false;
    }
 
private:
    StateType state_;
    bool stateIsSet_{false};
};
 
template<class PrimaryVariables, class StateType>
struct NumEqVectorTraits<SwitchablePrimaryVariables<PrimaryVariables, StateType>>
{
    static constexpr std::size_t numEq = PrimaryVariables::size();
    using type = PrimaryVariables;
};
 
} // end namespace Dumux
 
// specialize field traits for this type
namespace Dune {
 
template <class PrimaryVariables, class StateType>
struct FieldTraits<Dumux::SwitchablePrimaryVariables<PrimaryVariables, StateType>>
: public FieldTraits<PrimaryVariables>
{};
 
} // end namespace Dune
 
#endif