loadsolution.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_IO_LOADSOLUTION_HH
#define DUMUX_IO_LOADSOLUTION_HH
 
#include <string>
#include <iostream>
#include <vector>
#include <unordered_set>
#include <unordered_map>
#include <type_traits>
#include <functional>
 
#include <dune/common/exceptions.hh>
#include <dune/common/indices.hh>
#include <dune/grid/common/partitionset.hh>
 
#include <dumux/common/parameters.hh>
#include <dumux/common/typetraits/isvalid.hh>
#include <dumux/common/typetraits/vector.hh>
#include <dumux/common/typetraits/state.hh>
#include <dumux/io/vtk/vtkreader.hh>
#include <dumux/discretization/method.hh>
#include <dumux/common/gridcapabilities.hh>
 
namespace Dumux {
 
template <class Container, class EntityMapper, int codim>
class LoadSolutionDataHandle
: public Dune::CommDataHandleIF< LoadSolutionDataHandle<Container, EntityMapper, codim>,
                                 std::decay_t<decltype(std::declval<Container>()[0])> >
{
    using FieldType = std::decay_t<decltype(std::declval<Container>()[0])>;
public:
    LoadSolutionDataHandle(Container& container,
                           const EntityMapper& mapper)
    : mapper_(mapper)
    , container_(container)
    {}
 
    bool contains(int dim, int cd) const
    { return cd == codim; }
 
    bool fixedSize(int dim, int cd) const
    { return true; }
 
    template<class EntityType>
    std::size_t size (const EntityType &e) const
    { return 1; }
 
    template<class MessageBufferImp, class EntityType>
    void gather(MessageBufferImp& buff, const EntityType& e) const
    {
        const auto vIdx = mapper_.index(e);
        buff.write(container_[vIdx]);
    }
 
    template<class MessageBufferImp, class EntityType>
    void scatter(MessageBufferImp& buff, const EntityType& e, std::size_t n)
    {
        const auto vIdx = mapper_.index(e);
        FieldType tmp;
        buff.read(tmp);
        container_[vIdx] = tmp;
    }
 
private:
    EntityMapper mapper_;
    Container& container_;
};
 
template <class SolutionVector, class PvNameFunc, class GridGeometry>
auto loadSolutionFromVtkFile(SolutionVector& sol,
                             const std::string fileName,
                             PvNameFunc&& targetPvNameFunc,
                             const GridGeometry& gridGeometry,
                             const VTKReader::DataType& dataType)
-> typename std::enable_if_t<!decltype(isValid(Detail::hasState())(sol[0]))::value, void>
{
    VTKReader vtu(fileName);
 
    using PrimaryVariables = typename SolutionVector::block_type;
    using Scalar = typename PrimaryVariables::field_type;
    constexpr auto dim = GridGeometry::GridView::dimension;
    const std::size_t targetSolutionSize = PrimaryVariables::dimension;
 
    std::size_t matchingLoadedArrays = 0;
    for (std::size_t i = 0; i < targetSolutionSize; i++)
        if (vtu.hasData(targetPvNameFunc(i,0), dataType))
            matchingLoadedArrays++;
 
    if (matchingLoadedArrays < targetSolutionSize)
        std::cout << "The loaded solution does not provide a data array for each of the primary variables. \n"
                  << "The target solution has "<< targetSolutionSize << " entries, "
                  << "whereas the loaded solution provides only " << matchingLoadedArrays << " data array(s). \n"
                  << "Make sure that the model concepts are compatible, "
                  << "and be sure to provide initial conditions for the missing primary variables. \n";
 
    for (std::size_t targetPvIdx = 0; targetPvIdx < targetSolutionSize; ++targetPvIdx)
    {
        std::vector<Scalar> vec;
        const auto targetPvName = targetPvNameFunc(targetPvIdx, 0);
 
        if (vtu.hasData(targetPvName, dataType))
            vec = vtu.readData<std::vector<Scalar>>(targetPvName, dataType);
        else
        {
            std::cout << "The loaded solution does not have a field named \"" << targetPvName << "\". "
                      << "Make sure this field is filled using the initial method in the problem definition. \n";
            continue;
        }
 
        if (dataType == VTKReader::DataType::cellData)
        {
            std::size_t i = 0;
            for (const auto& element : elements(gridGeometry.gridView(), Dune::Partitions::interior))
            {
                const auto eIdx = gridGeometry.elementMapper().index(element);
                sol[eIdx][targetPvIdx] = vec[i++];
            }
        }
 
        // for staggered face data (which is written out as VTK point data) we just read in the vector
        else if (dataType == VTKReader::DataType::pointData && GridGeometry::discMethod == DiscretizationMethods::staggered)
        {
            if (sol.size() != vec.size())
                DUNE_THROW(Dune::InvalidStateException, "Solution size (" << sol.size() << ") does not match input size (" << vec.size() << ")!");
 
            for (std::size_t i = 0; i < sol.size(); ++i)
                sol[i][targetPvIdx] = vec[i];
        }
 
        // structured grid vertex data
        else if (const auto extension = fileName.substr(fileName.find_last_of(".") + 1); extension == "vti" || extension == "pvti")
        {
            std::size_t i = 0;
            for (const auto& vertex : vertices(gridGeometry.gridView(), Dune::Partitions::interior + Dune::Partitions::border))
            {
                const auto vIdx = gridGeometry.vertexMapper().index(vertex);
                sol[vIdx][targetPvIdx] = vec[i++];
            }
        }
 
        // unstructured grid vertex data
        else
        {
            std::size_t i = 0;
            std::vector<bool> visited(gridGeometry.gridView().size(dim), false);
            for (const auto& element : elements(gridGeometry.gridView(), Dune::Partitions::interior))
            {
                for (int vIdxLocal = 0; vIdxLocal < element.subEntities(dim); ++vIdxLocal)
                {
                    const auto vIdxGlobal = gridGeometry.vertexMapper().subIndex(element, vIdxLocal, dim);
                    if (!visited[vIdxGlobal])
                    {
                        sol[vIdxGlobal][targetPvIdx] = vec[i++];
                        visited[vIdxGlobal] = true;
                    }
                }
            }
        }
    }
}
 
template <class SolutionVector, class PvNameFunc, class GridGeometry>
auto loadSolutionFromVtkFile(SolutionVector& sol,
                             const std::string fileName,
                             PvNameFunc&& targetPvNameFunc,
                             const GridGeometry& gridGeometry,
                             const VTKReader::DataType& dataType)
-> typename std::enable_if_t<decltype(isValid(Detail::hasState())(sol[0]))::value, void>
{
    VTKReader vtu(fileName);
    // get states at each dof location
    const auto stateAtDof = vtu.readData<std::vector<int>>("phase presence", dataType);
 
    // determine all states that are present
    std::unordered_set<int> states;
    for (std::size_t i = 0; i < stateAtDof.size(); ++i)
        states.insert(stateAtDof[i]);
 
    using PrimaryVariables = typename SolutionVector::block_type;
    using Scalar = typename PrimaryVariables::field_type;
    const std::size_t targetSolutionSize = PrimaryVariables::dimension;
 
    std::unordered_set<std::string> matchingNames;
    for (std::size_t i = 0; i < targetSolutionSize; i++)
        for (const auto& state : states)
            if ( vtu.hasData(targetPvNameFunc(i,state), dataType))
                matchingNames.insert(targetPvNameFunc(i,state));
 
    const std::size_t matchingLoadedArrays = matchingNames.size() - (states.size()-1);
 
    if (matchingLoadedArrays < targetSolutionSize)
        std::cout << "The loaded solution does not provide a data array for each of the primary variables. \n"
                  << "The target solution has "<< targetSolutionSize << " entries, "
                  << "whereas the loaded solution provides only " << matchingLoadedArrays << " data array(s). \n"
                  << "Make sure that the model concepts are compatible, "
                  << "and be sure to provide initial conditions for the missing primary variables. \n";
 
    for (std::size_t targetPvIdx = 0; targetPvIdx < targetSolutionSize; ++targetPvIdx)
    {
        std::unordered_map<int, std::vector<Scalar>> data;
        for (const auto& state : states)
        {
            const auto targetPvName = targetPvNameFunc(targetPvIdx, state);
 
            if (vtu.hasData(targetPvName, dataType))
                data[state] = vtu.readData<std::vector<Scalar>>(targetPvName, dataType);
            else
            {
                std::cout << "Loaded Solution does not have a field named \"" << targetPvName << "\". "
                          << "Make sure this field is filled using the initial method in the problem definition. \n";
                continue;
            }
        }
 
        if (dataType == VTKReader::DataType::cellData)
        {
            std::size_t i = 0;
            for (const auto& element : elements(gridGeometry.gridView(), Dune::Partitions::interior))
            {
                const auto eIdx = gridGeometry.elementMapper().index(element);
                const auto state = stateAtDof[i];
                sol[eIdx][targetPvIdx] = data[state][i++];
                sol[eIdx].setState(state);
            }
        }
        else
        {
            std::size_t i = 0;
            constexpr int dim = GridGeometry::GridView::dimension;
            std::vector<bool> visited(gridGeometry.gridView().size(dim), false);
            for (const auto& element : elements(gridGeometry.gridView(), Dune::Partitions::interior))
            {
                for (int vIdxLocal = 0; vIdxLocal < element.subEntities(dim); ++vIdxLocal)
                {
                    const auto vIdxGlobal = gridGeometry.vertexMapper().subIndex(element, vIdxLocal, dim);
                    if (!visited[vIdxGlobal])
                    {
                        const auto state = stateAtDof[i];
                        sol[vIdxGlobal][targetPvIdx] = data[state][i++];
                        sol[vIdxGlobal].setState(state);
                        visited[vIdxGlobal] = true;
                    }
                }
            }
        }
    }
}
 
template<class IOFields, class PrimaryVariables, class ModelTraits = void, class FluidSystem = void, class SolidSystem = void>
auto createPVNameFunction(const std::string& paramGroup = "")
-> typename std::enable_if_t<decltype(isValid(Detail::hasState())(PrimaryVariables(0)))::value, std::function<std::string(int,int)>>
{
    return  [paramGroup](int pvIdx, int state = 0)
            {
                static auto numStates = (1 << ModelTraits::numFluidPhases()) - 1;
                const auto paramNameWithState = "LoadSolution.PriVarNamesState" + std::to_string(state);
 
                if (hasParamInGroup(paramGroup, "LoadSolution.PriVarNames") && !hasParamInGroup(paramGroup, paramNameWithState))
                    DUNE_THROW(Dune::NotImplemented, "please provide LoadSolution.PriVarNamesState1..." << numStates
                              << " or remove LoadSolution.PriVarNames to use the model's default primary variable names");
 
                else if (hasParamInGroup(paramGroup, paramNameWithState))
                {
                    const auto pvName = getParamFromGroup<std::vector<std::string>>(paramGroup, paramNameWithState);
                    return pvName[pvIdx];
                }
                else
                    return IOFields::template primaryVariableName<ModelTraits, FluidSystem, SolidSystem>(pvIdx, state);
            };
}
 
template<class IOFields, class PrimaryVariables, class ModelTraits = void, class FluidSystem = void, class SolidSystem = void>
auto createPVNameFunction(const std::string& paramGroup = "")
-> typename std::enable_if_t<!decltype(isValid(Detail::hasState())(PrimaryVariables(0)))::value, std::function<std::string(int,int)>>
{
    if (hasParamInGroup(paramGroup, "LoadSolution.PriVarNames"))
    {
        const auto pvName = getParamFromGroup<std::vector<std::string>>(paramGroup, "LoadSolution.PriVarNames");
        return [n = std::move(pvName)](int pvIdx, int state = 0){ return n[pvIdx]; };
    }
    else
        return [](int pvIdx, int state = 0){ return IOFields::template primaryVariableName<ModelTraits, FluidSystem, SolidSystem>(pvIdx, state); };
}
 
template <class SolutionVector, class PvNameFunc, class GridGeometry>
void loadSolution(SolutionVector& sol,
                  const std::string& fileName,
                  PvNameFunc&& targetPvNameFunc,
                  const GridGeometry& gridGeometry)
{
    const auto extension = fileName.substr(fileName.find_last_of(".") + 1);
    auto dataType = GridGeometry::discMethod == DiscretizationMethods::box ?
                    VTKReader::DataType::pointData : VTKReader::DataType::cellData;
 
    if (extension == "vtu" || extension == "vtp" || extension == "vti")
    {
        if (GridGeometry::discMethod == DiscretizationMethods::staggered && extension == "vtp")
            dataType = VTKReader::DataType::pointData;
 
        loadSolutionFromVtkFile(sol, fileName, targetPvNameFunc, gridGeometry, dataType);
    }
    else if (extension == "pvtu" || extension == "pvtp" || extension == "pvti")
    {
        if (GridGeometry::discMethod == DiscretizationMethods::staggered)
            DUNE_THROW(Dune::NotImplemented, "reading staggered solution from a parallel vtk file");
 
        loadSolutionFromVtkFile(sol, fileName, targetPvNameFunc, gridGeometry, dataType);
    }
    else
        DUNE_THROW(Dune::NotImplemented, "loadSolution for file with extension " << extension);
 
    // communicate solution on ghost and overlap dofs
    if (gridGeometry.gridView().comm().size() > 1)
    {
        using GridView = typename GridGeometry::GridView;
        if (dataType == VTKReader::DataType::cellData)
        {
            LoadSolutionDataHandle<SolutionVector, typename GridGeometry::ElementMapper, 0>
                dataHandle(sol, gridGeometry.elementMapper());
 
            if constexpr (Dune::Capabilities::canCommunicate<typename GridView::Traits::Grid, 0>::v)
                gridGeometry.gridView().communicate(dataHandle,
                                                    Dune::InteriorBorder_All_Interface,
                                                    Dune::ForwardCommunication);
            else
                DUNE_THROW(Dune::InvalidStateException, "Cannot call loadSolution on multiple processes for a grid that cannot communicate codim-" << 0 << "-entities.");
        }
        else
        {
            LoadSolutionDataHandle<SolutionVector, typename GridGeometry::VertexMapper, GridView::dimension>
                dataHandle(sol, gridGeometry.vertexMapper());
 
            if constexpr (Dune::Capabilities::canCommunicate<typename GridView::Traits::Grid, GridView::dimension>::v)
                gridGeometry.gridView().communicate(dataHandle,
                                                    Dune::InteriorBorder_All_Interface,
                                                    Dune::ForwardCommunication);
            else
                DUNE_THROW(Dune::InvalidStateException, "Cannot call loadSolution on multiple processes for a grid that cannot communicate codim-" <<  GridView::dimension << "-entities.");
        }
    }
}
} // end namespace Dumux
 
#endif