cakegridmanager.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_CAKE_GRID_MANAGER_HH
#define DUMUX_CAKE_GRID_MANAGER_HH
 
#include <vector>
#include <iostream>
#include <cmath>
#include <algorithm>
 
#include <dune/common/dynvector.hh>
#include <dune/common/float_cmp.hh>
#include <dune/common/math.hh>
#include <dune/grid/common/gridfactory.hh>
#include <dumux/common/parameters.hh>
 
namespace Dumux {
 
template <class Grid>
class CakeGridManager
{
    using Scalar = typename Grid::ctype;
 
    using GridFactory = Dune::GridFactory<Grid>;
    using GridPointer = std::shared_ptr<Grid>;
 
    enum { dim = Grid::dimension,
           dimWorld = Grid::dimensionworld };
 
public:
    void init(const std::string& modelParamGroup = "")
    {
        static_assert(dim == 2 || dim == 3, "The CakeGridManager is only implemented for 2D and 3D.");
 
        const bool verbose = getParamFromGroup<bool>(modelParamGroup, "Grid.Verbosity", false);
 
        std::array<std::vector<Scalar>, dim> polarCoordinates;
        // Indices specifying in which direction the piece of cake is oriented
        Dune::FieldVector<int, dim> indices(-1);
        createVectors(polarCoordinates, indices, modelParamGroup, verbose);
 
        gridPtr() = createCakeGrid(polarCoordinates, indices, modelParamGroup, verbose);
        loadBalance();
    }
 
    static void createVectors(std::array<std::vector<Scalar>, dim> &polarCoordinates,
                              Dune::FieldVector<int, dim> &indices,
                              const std::string& modelParamGroup,
                              bool verbose = false)
    {
        // The positions
        std::array<std::vector<Scalar>, dim> positions;
 
        for (int i = 0; i < dim; ++i)
        {
            const bool hasRadial = hasParamInGroup(modelParamGroup, "Grid.Radial" + std::to_string(i));
            const bool hasAngular = hasParamInGroup(modelParamGroup, "Grid.Angular" + std::to_string(i));
            const bool hasAxial = (dim == 3) && hasParamInGroup(modelParamGroup, "Grid.Axial" + std::to_string(i));
            if (static_cast<int>(hasRadial) + static_cast<int>(hasAngular) + static_cast<int>(hasAxial) != 1)
                DUNE_THROW(Dune::RangeError, "Multiple or no position vectors (radial, angular, axial) specified in coord direction: " << i << std::endl);
 
            if (hasRadial)
            {
                positions[i] = getParamFromGroup<std::vector<Scalar>>(modelParamGroup, "Grid.Radial" + std::to_string(i));
                indices[0] = i; // Index specifying radial direction
            }
            else if (hasAngular)
            {
                positions[i] = getParamFromGroup<std::vector<Scalar>>(modelParamGroup, "Grid.Angular" + std::to_string(i));
                indices[1] = i; // Index specifying angular direction
            }
            else // hasAxial
            {
                positions[i] = getParamFromGroup<std::vector<Scalar>>(modelParamGroup, "Grid.Axial" + std::to_string(i));
                indices[2] = i; // Index specifying axial direction
            }
 
            if (!std::is_sorted(positions[i].begin(), positions[i].end()))
                DUNE_THROW(Dune::GridError, "Make sure to specify a monotone increasing \"Positions\" array");
 
            if(positions[i].size() < 2)
                DUNE_THROW(Dune::GridError, "Make sure to specify position arrays with at least two entries (min and max value).");
        }
 
        // check that all indices are specified i.e. > 0
        for (int i = 0; i < dim; ++i)
            if (indices[i] < 0)
                DUNE_THROW(Dune::RangeError, "Please specify Positions Angular and Radial and Axial correctly and unambiguously!" << std::endl);
 
        // the number of cells (has a default)
        std::array<std::vector<int>, dim> cells;
        for (int i = 0; i < dim; ++i)
        {
            cells[i].resize(positions[i].size()-1, 1.0);
            cells[i] = getParamFromGroup<std::vector<int>>(modelParamGroup, "Grid.Cells" +  std::to_string(i), cells[i]);
            if (cells[i].size() + 1 != positions[i].size())
                DUNE_THROW(Dune::RangeError, "Make sure to specify the correct length of \"Cells\" and \"Positions\" arrays");
        }
 
        // grading factor (has a default)
        std::array<std::vector<Scalar>, dim> grading;
        for (int i = 0; i < dim; ++i)
        {
            grading[i].resize(positions[i].size()-1, 1.0);
            grading[i] = getParamFromGroup<std::vector<Scalar>>(modelParamGroup, "Grid.Grading" +  std::to_string(i), grading[i]);
            if (grading[i].size() + 1 != positions[i].size())
                DUNE_THROW(Dune::RangeError, "Make sure to specify the correct length of \"Grading\" and \"Positions\" arrays");
        }
 
        // make the grid
        std::array<std::vector<Scalar>, dim> globalPositions;
        using std::pow;
        using Dune::power;
        for (int dimIdx = 0; dimIdx < dim; dimIdx++)
        {
            // Each grid direction is subdivided into (numCells + 1) points
            std::size_t numGlobalPositions = 1;
            for (int zoneIdx = 0; zoneIdx < cells[dimIdx].size(); ++zoneIdx)
                numGlobalPositions += cells[dimIdx][zoneIdx];
 
            globalPositions[dimIdx].resize(numGlobalPositions);
            std::size_t posIdx = 0;
            for (int zoneIdx = 0; zoneIdx < cells[dimIdx].size(); ++zoneIdx)
            {
                const Scalar lower = positions[dimIdx][zoneIdx];
                const Scalar upper = positions[dimIdx][zoneIdx+1];
                const int numCells = cells[dimIdx][zoneIdx];
                Scalar gradingFactor = grading[dimIdx][zoneIdx];
                const Scalar length = upper - lower;
                Scalar height = 1.0;
                bool increasingCellSize = false;
 
                if (verbose)
                {
                    std::cout << "dim " << dimIdx
                              << " lower "  << lower
                              << " upper "  << upper
                              << " numCells "  << numCells
                              << " grading "  << gradingFactor;
                }
 
                if (gradingFactor > 1.0)
                    increasingCellSize = true;
 
                // take absolute values and reverse cell size increment to achieve
                // reverse behavior for negative values
                if (gradingFactor < 0.0)
                {
                    using std::abs;
                    gradingFactor = abs(gradingFactor);
 
                    if (gradingFactor < 1.0)
                        increasingCellSize = true;
                }
 
                const bool useGrading = Dune::FloatCmp::eq(gradingFactor, 1.0) ? false : true;
 
                // if the grading factor is exactly 1.0 do equal spacing
                if (!useGrading)
                {
                    height = 1.0 / numCells;
                    if (verbose)
                        std::cout << " -> h "  << height * length << std::endl;
                }
                // if grading factor is not 1.0, do power law spacing
                else
                {
                    height = (1.0 - gradingFactor) / (1.0 - power(gradingFactor, numCells));
 
                    if (verbose)
                    {
                        std::cout << " -> grading_eff "  << gradingFactor
                                  << " h_min "  << height * power(gradingFactor, 0) * length
                                  << " h_max "  << height * power(gradingFactor, numCells-1) * length
                                  << std::endl;
                    }
                }
 
                // the positions inside a global segment
                Dune::DynamicVector<Scalar> localPositions(numCells, 0.0);
                for (int i = 1; i < numCells; i++)
                {
                    Scalar hI = height;
                    if (useGrading)
                    {
                        if (increasingCellSize)
                            hI *= power(gradingFactor, i-1);
 
                        else
                            hI *= power(gradingFactor, numCells-i);
                    }
                    localPositions[i] = localPositions[i-1] + hI;
                }
 
                localPositions *= length;
                localPositions += lower;
 
                for (int i = 0; i < numCells; ++i)
                    globalPositions[dimIdx][posIdx++] = localPositions[i];
            }
 
            globalPositions[dimIdx][posIdx] = positions[dimIdx].back();
        }
 
        polarCoordinates[0] = globalPositions[indices[0]];
        polarCoordinates[1] = globalPositions[indices[1]];
        if (dim == 3)
            polarCoordinates[2] = globalPositions[dim - indices[0] - indices[1]];
 
        // convert angular coordinates into radians
        std::transform(polarCoordinates[1].begin(), polarCoordinates[1].end(),
                       polarCoordinates[1].begin(),
                       [](Scalar s){ return s*M_PI/180; });
    }
 
    std::unique_ptr<Grid> createCakeGrid(std::array<std::vector<Scalar>, dim> &polarCoordinates,
                                         Dune::FieldVector<int, dim> &indices,
                                         const std::string& modelParamGroup,
                                         bool verbose = false)
    {
        GridFactory gridFactory;
 
        // create grid on rank 0, return empty grid on all other ranks
        if (gridFactory.comm().rank() != 0)
            return std::unique_ptr<Grid>(gridFactory.createGrid());
 
        const auto& dR = polarCoordinates[0];
        const auto& dA = polarCoordinates[1];
 
        // For the special case of 360°, the last element is connected with the first one.
        // Thus, one needs to distinguish here between all other cases, were the normal procedure
        // is applied for all elements until the last one  (= dA.size() - 1) and the 360° case,
        // where it is only applied until the second to last element (dA.size() - 2).
        const int dAMax = Dune::FloatCmp::eq(dA[dA.size()-1], 2*M_PI) ? dA.size() - 2 : dA.size() - 1;
        constexpr auto type = Dune::GeometryTypes::cube(dim);
        const bool hasHole = dR[0] >= 1.0e-8*dR.back();
 
        // create nodes
        if constexpr (dim == 3)
        {
            constexpr auto prismType = Dune::GeometryTypes::prism;
            std::vector<Scalar> dZ = polarCoordinates[2];
            for (int j = 0; j <= dAMax; ++j)
            {
                for (int l = 0; l <= dZ.size() - 1; ++l)
                {
                    for (int i = hasHole ? 0 : 1; i <= dR.size()- 1; ++i)
                    {
                        // transform into Cartesian coordinates
                        using std::cos;
                        using std::sin;
                        Dune::FieldVector <double, dim> v(0.0);
                        v[indices[2]] = dZ[l];
                        v[indices[0]] = cos(dA[j])*dR[i];
                        v[indices[1]] = sin(dA[j])*dR[i];
                        if (verbose)
                            printCoordinate(v);
                        gridFactory.insertVertex(v);
                    }
                }
            }
 
            // if the well is not considered, we have to add the points lying on the center-line
            // this has to be done separately, otherwise these points would occur multiple times
            if(!hasHole)
            {
                for (int l = 0; l <= dZ.size() - 1; ++l)
                {
                    Dune::FieldVector <double, dim> v(0.0);
                    v[indices[2]] = dZ[l];
                    v[indices[0]] = 0.0;
                    v[indices[1]] = 0.0;
 
                    if (verbose)
                        printCoordinate(v);
                    gridFactory.insertVertex(v);
                }
            }
 
            if (verbose)
                std::cout << "Filled node vector" << std::endl;
 
            // assign nodes
            unsigned int z = 0;
            unsigned int t = 0;
            unsigned int rSize = hasHole ? dR.size() : dR.size()-1;
            unsigned int zSize = dZ.size();
            for (int j = 0; j < dA.size() - 1; ++j)
            {
                for (int l = 0; l < dZ.size() - 1; ++l)
                {
                    if (j < dAMax)
                    {
                        for (int i = 0; i < dR.size() - 1; ++i)
                        {
                            if(!hasHole && i==0)
                            {
                                std::vector<unsigned int> vid({rSize*zSize*(dAMax+1) + l, z, z+rSize*zSize,
                                                               rSize*zSize*(dAMax+1) + l+1, z+rSize, z+rSize*zSize+rSize});
 
                                if (verbose)
                                    printIndices(vid);
 
                                gridFactory.insertElement(prismType, vid);
                            }
                            else
                            {
                                std::vector<unsigned int> vid({z, z+1,
                                                               z+rSize*zSize, z+rSize*zSize+1,
                                                               z+rSize, z+rSize+1,
                                                               z+rSize*zSize+rSize, z+rSize*zSize+rSize+1});
 
                                if (verbose)
                                    printIndices(vid);
 
                                gridFactory.insertElement(type, vid);
 
                                z++;
                            }
                        }
                        z++;
                    }
                    else
                    {
                        // assign nodes for 360°-cake
                        for (int i = 0; i < dR.size() - 1; ++i)
                        {
                            if(!hasHole && i==0)
                            {
                                std::vector<unsigned int> vid({rSize*zSize*(dAMax+1) + l, z, t,
                                                               rSize*zSize*(dAMax+1) + l+1, z+rSize, t+rSize});
 
                                if (verbose)
                                    printIndices(vid);
 
                                gridFactory.insertElement(prismType, vid);
                            }
                            else
                            {
                                std::vector<unsigned int> vid({z, z+1,
                                                               t, t+1,
                                                               z+rSize, z+rSize+1,
                                                               t+rSize, t+rSize+1});
 
                                if (verbose)
                                    printIndices(vid);
 
                                gridFactory.insertElement(type, vid);
                                t++;
                                z++;
                            }
                        }
                        t++;
                        z++;
 
                        if (verbose)
                            std::cout << "assign nodes 360° ends..." << std::endl;
                    }
                }
                z += rSize;
            }
        }
 
        // for dim = 2
        else
        {
            constexpr auto triangleType = Dune::GeometryTypes::simplex(dim);
            for (int j = 0; j <= dAMax; ++j)
            {
                for (int i = hasHole ? 0 : 1; i <= dR.size()- 1; ++i)
                {
                    // transform into Cartesian coordinates
                    Dune::FieldVector <double, dim> v(0.0);
 
                    v[indices[0]] = cos(dA[j])*dR[i];
                    v[indices[1]] = sin(dA[j])*dR[i];
                    if(verbose)
                        printCoordinate(v);
                    gridFactory.insertVertex(v);
                }
            }
 
            // if the well is not considered, we have to add the point located at the center
            // this has to be done separately, otherwise this point would occur multiple times
            if(!hasHole)
            {
                Dune::FieldVector <double, dim> v(0.0);
                v[indices[0]] = 0.0;
                v[indices[1]] = 0.0;
 
                if(verbose)
                    printCoordinate(v);
                gridFactory.insertVertex(v);
            }
 
            std::cout << "Filled node vector" << std::endl;
 
            // assign nodes
            unsigned int z = 0;
            unsigned int t = 0;
            unsigned int rSize = hasHole ? dR.size() : dR.size()-1;
            for (int j = 0; j < dA.size() - 1; ++j)
            {
                if (j < dAMax)
                {
                    for (int i = 0; i < dR.size() - 1; ++i)
                    {
                        if(!hasHole && i==0)
                        {
                            std::vector<unsigned int> vid({rSize*(dAMax+1), z, z+rSize});
 
                            if (verbose)
                                printIndices(vid);
 
                            gridFactory.insertElement(triangleType, vid);
                        }
                        else
                        {
                            std::vector<unsigned int> vid({z, z+1, z+rSize, z+rSize+1});
 
                            if (verbose)
                                printIndices(vid);
 
                            gridFactory.insertElement(type, vid);
                            z++;
                        }
                    }
                    z++;
                }
                else
                {
                    // assign nodes for 360°-cake
                    for (int i = 0; i < dR.size() - 1; ++i)
                    {
                        if(!hasHole && i==0)
                        {
                            std::vector<unsigned int> vid({rSize*(dAMax+1), z, t});
 
                            if (verbose)
                                printIndices(vid);
 
                            gridFactory.insertElement(triangleType, vid);
                        }
                        else
                        {
                            std::vector<unsigned int> vid({z, z+1, t, t+1});
 
                            if (verbose)
                                printIndices(vid);
 
                            gridFactory.insertElement(type, vid);
                            t++;
                            z++;
                        }
                    }
                    t++;
                    z++;
 
                    if (verbose)
                        std::cout << "assign nodes 360 ends..." << std::endl;
                }
            }
        }
 
        // create the grid
        return std::unique_ptr<Grid>(gridFactory.createGrid());
    }
 
    Grid& grid()
    {
        return *gridPtr();
    }
 
    void loadBalance()
    {
        gridPtr()->loadBalance();
    }
 
protected:
    static void printCoordinate(const Dune::FieldVector <double, dim>& v)
    { std::cout << "Coordinates of: " << v << std::endl; }
 
    static void printIndices(const std::vector<unsigned int>& vid)
    {
        std::cout << "element vertex indices: ";
        for (int k = 0; k < vid.size(); ++k)
            std::cout << vid[k] << " ";
        std::cout << std::endl;
    }
 
    GridPointer& gridPtr()
    {
        return cakeGrid_;
    }
 
private:
    GridPointer cakeGrid_;
};
 
} // end namespace Dumux
 
#endif