discretization/fvgridvariables.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_FV_GRID_VARIABLES_HH
#define DUMUX_FV_GRID_VARIABLES_HH
 
#include <type_traits>
#include <memory>
#include <cassert>
 
namespace Dumux {
 
template<class GG, class GVV, class GFVC>
class FVGridVariables
{
public:
    using GridGeometry = GG;
 
    using GridVolumeVariables = GVV;
 
    using VolumeVariables = typename GridVolumeVariables::VolumeVariables;
 
    using PrimaryVariables = typename VolumeVariables::PrimaryVariables;
 
    using Scalar = std::decay_t<decltype(std::declval<PrimaryVariables>()[0])>;
 
    using GridFluxVariablesCache = GFVC;
 
    template<class Problem>
    FVGridVariables(std::shared_ptr<Problem> problem,
                    std::shared_ptr<const GridGeometry> gridGeometry)
    : gridGeometry_(gridGeometry)
    , curGridVolVars_(*problem)
    , prevGridVolVars_(*problem)
    , gridFluxVarsCache_(*problem)
    {}
 
    template<class SolutionVector>
    void init(const SolutionVector& curSol)
    {
        // resize and update the volVars with the initial solution
        curGridVolVars_.update(*gridGeometry_, curSol);
 
        // update the flux variables caches (always force flux cache update on initialization)
        gridFluxVarsCache_.update(*gridGeometry_, curGridVolVars_, curSol, true);
 
        // set the volvars of the previous time step in case we have an instationary problem
        // note that this means some memory overhead in the case of enabled caching, however
        // this it outweighted by the advantage of having a single grid variables object for
        // stationary and instationary problems
        prevGridVolVars_ = curGridVolVars_;
    }
 
    template<class SolutionVector>
    [[deprecated("Use init(sol) instead. The class now works without modification for stationary and instationary cases.")]]
    void init(const SolutionVector& curSol, const SolutionVector& initSol)
    {
        // initialize current volvars and the flux var cache
        init(initSol);
    }
 
    template<class SolutionVector>
    void update(const SolutionVector& curSol, bool forceFluxCacheUpdate = false)
    {
        // resize and update the volVars with the initial solution
        curGridVolVars_.update(*gridGeometry_, curSol);
 
        // update the flux variables caches
        gridFluxVarsCache_.update(*gridGeometry_, curGridVolVars_, curSol, forceFluxCacheUpdate);
    }
 
    template<class SolutionVector>
    void updateAfterGridAdaption(const SolutionVector& curSol)
    {
        // update (always force flux cache update as the grid changed)
        update(curSol, true);
 
        // for instationary problems also update the variables
        // for the previous time step to the new grid
        prevGridVolVars_ = curGridVolVars_;
    }
 
    void advanceTimeStep()
    {
        prevGridVolVars_ = curGridVolVars_;
    }
 
    template<class SolutionVector>
    void resetTimeStep(const SolutionVector& solution)
    {
        // set the new time step vol vars to old vol vars
        curGridVolVars_ = prevGridVolVars_;
 
        // update the flux variables caches
        gridFluxVarsCache_.update(*gridGeometry_, curGridVolVars_, solution);
    }
 
    const GridFluxVariablesCache& gridFluxVarsCache() const
    { return gridFluxVarsCache_; }
 
    GridFluxVariablesCache& gridFluxVarsCache()
    { return gridFluxVarsCache_; }
 
    const GridVolumeVariables& curGridVolVars() const
    { return curGridVolVars_; }
 
    GridVolumeVariables& curGridVolVars()
    { return curGridVolVars_; }
 
    const GridVolumeVariables& prevGridVolVars() const
    { return prevGridVolVars_; }
 
    GridVolumeVariables& prevGridVolVars()
    { return prevGridVolVars_; }
 
    [[deprecated("Use gridGeometry() instead. fvGridGeometry() will be removed after 3.1!")]]
    const GridGeometry& fvGridGeometry() const
    { return gridGeometry(); }
 
    const GridGeometry& gridGeometry() const
    { return *gridGeometry_; }
 
protected:
 
    std::shared_ptr<const GridGeometry> gridGeometry_; 
 
private:
    GridVolumeVariables curGridVolVars_; 
    GridVolumeVariables prevGridVolVars_; 
 
    GridFluxVariablesCache gridFluxVarsCache_; 
};
 
} // end namespace Dumux
 
#endif