Compsegs.hpp

/*
  Copyright 2015 SINTEF ICT, Applied Mathematics.

  This file is part of the Open Porous Media project (OPM).

  OPM 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.

  OPM 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 OPM.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef COMPSEGS_HPP_
#define COMPSEGS_HPP_

#include <array>
#include <string_view>
#include <unordered_map>
#include <utility>
#include <vector>

namespace Opm {

    class Connection;
    class DeckKeyword;
    class ErrorGuard;
    class KeywordLocation;
    class ParseContext;
    class ScheduleGrid;
    class Segment;
    class WellConnections;
    class WellSegments;

} // namespace Opm

namespace Opm::RestartIO {

    struct RstWell;

} // namespace Opm::RestartIO

namespace Opm::Compsegs {

    WellConnections
    processCOMPSEGS(const DeckKeyword&     compsegs,
                    const WellConnections& input_connections,
                    const WellSegments&    input_segments,
                    const ScheduleGrid&    grid,
                    const ParseContext&    parseContext,
                    ErrorGuard&            errors);

    struct TrajectorySegment
    {
        double startMD{};

        double endMD{};

        std::array<int, 3> ijk{};
    };

    WellConnections
    getConnectionsAndSegmentsFromTrajectory(std::string_view                      well_name,
                                            const std::vector<TrajectorySegment>& trajectory_segments,
                                            const WellSegments&                   segments,
                                            const WellConnections&                input_connections,
                                            const ScheduleGrid&                   grid,
                                            const KeywordLocation&                location,
                                            const ParseContext&                   parseContext,
                                            ErrorGuard&                           errors);

    std::pair<WellConnections, WellSegments>
    rstUpdate(const RestartIO::RstWell&               rst_well,
              std::vector<Connection>                 input_connections,
              const std::unordered_map<int, Segment>& input_segments);

} // namespace Opm::Compsegs

#endif // COMPSEGS_HPP_