Implement gsatprod

[totto82]

Depends on
OPM/opm-common#4188

Sufficient to run OPM/opm-tests#1207 where GSATPROD only interact with output and new test case OPM/opm-tests#1286

[totto82]

Now also with interaction with group controls.

[totto82]

Simple test case added. OPM/opm-tests#1286

[totto82]

The only difference between GSATPROD1 and GSATPROD2 is that GSATPROD2 includes GCONPROD with 2500 ORAT. The well PROD's ORAT is correctly limited to meet 2500 ORAT target for group FIELD in GSATPROD2.

[bska]

This looks okay to me, but I really think we should try to limit the amount of nested logic we add when making new features, and, generally try to simplify the functions if at all possible. The WellGroupHelpers are already quite complicated and the fact that we can't understand any single function in isolation because everything gets accumulated into updateAndCommunicateGroupData().

[bska]

I think I'd prefer if this logic were separated out to a distinct helper function, or at least a separate loop. Something along the lines of

template <typename Scalar>
Scalar satelliteProduction(const ScheduleState& sched,
                           const std::vector<std::string>& groups,
                           const GSatProd::GSatProdGroup::Rate rateComp)
{
    auto satProdRate = Scalar{};

    const auto& gsatProd = sched.gsatprod();
    for (const auto& group : groups) {
        if (! gsatProd.has(group)) {
            continue;
        }

        gsatProdRate += gsatProd.get(group).rate[rateComp];
    }

    return gsatProdRate;
}

std::optional<GSatProd::GSatProdGroup::Rate>
selectRateComponent(const PhaseUsage& pu, const int phasePos)
{
    using Rate = GSatProd::GSatProdGroup::Rate;

    for (const auto& [phase, rateComp] : std::array {
        std::pair { BlackoilPhases::Aqua, Rate::Water },
        std::pair { BlackoilPhases::Liquid, Rate::Oil },
        std::pair { BlackoilPhases::Vapour, Rate::Gas } })
    {
        if (pu.phase_used[phase] && (pu.phase_pos[phase] == phasePos)) {
            return rateComp;
        }
    }

    return std::nullopt;
}

which you'd call, either as part of sumWellPhaseRates() or separately, as

if (wellState.isRank0() && !injector) {
    const auto rateComp = selecteRateComponent(wellState.phaseUsage(), phasePos);
    if (rateComp.has_value()) {
        rate += satelliteProduction(schedule[reportStepIdx], group.groups(), *rateComp);
    }
}

This would reduce the amount of nested logic.

[totto82]

Thanks for the suggestions.

[bska]

Thank you for the updates. I think this is starting to look good. Just one small issue remaining, I think.

[bska]

This section needs to be outside of the groupName loop lest we include the contributions multiple times in the case that more than one of group.groups() is a satellite.

[bska]

Thanks a lot for the updates. This looks good to me now and I'll merge into master.