opm-simulators/flowexperimental/comp/wells/CompWellState_impl.hpp

/*
  Copyright 2024, SINTEF Digital

  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/>.
*/

namespace Opm {

template <typename FluidSystem>
CompWellState<FluidSystem>::
CompWellState(const CompositionalConfig& comp_config)
    : comp_config_(comp_config)
{
}


template <typename FluidSystem>
void CompWellState<FluidSystem>::
init(const std::vector<Well>& wells_ecl,
     const std::vector<Scalar>& cell_pressures,
     const Scalar temperature,
     const std::vector<std::vector<Scalar>>& cell_mole_fractions,
     const std::vector<std::vector<CompConnectionData> >& well_connection_data,
     const SummaryState& summary_state,
     const CompWellState* /*prev_well_state*/)
{
    this->base_init(wells_ecl, cell_pressures, temperature, cell_mole_fractions, well_connection_data, summary_state);

    // TODO: for the simple case we have, I think we can just copy from the prev_well_state
    // let us see how we gonna use it though
}

template <typename FluidSystem>
void CompWellState<FluidSystem>::
base_init(const std::vector<Well>& wells_ecl,
          const std::vector<Scalar>& cell_pressures,
          const Scalar temperature,
          const std::vector<std::vector<Scalar>>& cell_mole_fractions,
          const std::vector<std::vector<CompConnectionData>>& well_connection_data,
          const SummaryState& summary_state)
{
    this->wells_.clear();

    const auto num_wells = wells_ecl.size();

    for (auto w = 0*num_wells; w < num_wells; ++w) {
        const Well& well = wells_ecl[w];
        const auto& conn_data = well_connection_data[w];
        initSingleWell(well, cell_pressures, temperature, cell_mole_fractions, conn_data, summary_state);
    }

}

template <typename FluidSystem>
void CompWellState<FluidSystem>::
initSingleWell(const Well& well,
               const std::vector<Scalar>& cell_pressures,
               const Scalar tempearture,
               const std::vector<std::vector<Scalar>>& cell_mole_fractions,
               const std::vector<CompConnectionData>& conn_data,
               const SummaryState& summary_state)
{
    if (well.isInjector()) {
        initSingleInjector(well, cell_pressures, tempearture, conn_data, summary_state);
    } else {
        initSingleProducer(well, cell_pressures, tempearture, cell_mole_fractions, conn_data, summary_state);
    }

}

template <typename FluidSystem>
void CompWellState<FluidSystem>::
initSingleInjector(const Well& well,
                   const std::vector<Scalar>& /* cell_pressures */,
                   const Scalar temperature,
                   const std::vector<CompConnectionData>& conn_data,
                   const SummaryState& summary_state)
{
    auto& ws = this->wells_.add(well.name(),
                                SingleWellState(well.name(),
                                    this->comp_config_,
                                    temperature,
                                    conn_data,
                                    false) );
    ws.update_injector_targets(well, summary_state);
}

template <typename FluidSystem>
void CompWellState<FluidSystem>::
initSingleProducer(const Well& well,
                   const std::vector<Scalar>& /* cell_pressures */,
                   const Scalar temperature,
                   const std::vector<std::vector<Scalar>>& cell_mole_fractions,
                   const std::vector<CompConnectionData>& conn_data,
                   const SummaryState& summary_state)
{
    auto& ws = this->wells_.add(well.name(),
                                SingleWellState(well.name(),
                                    this->comp_config_,
                                    temperature,
                                    conn_data,
                                    true) );
    ws.update_producer_targets(well, cell_mole_fractions, summary_state);
}

template <typename FluidSystem>
const typename CompWellState<FluidSystem>::SingleWellState&
CompWellState<FluidSystem>::
operator[](const std::string& well_name) const
{
    return this->wells_[well_name];
}

template <typename FluidSystem>
typename CompWellState<FluidSystem>::SingleWellState&
CompWellState<FluidSystem>::
operator[](const std::string& well_name)
{
    return this->wells_[well_name];
}

template <typename FluidSystem>
data::Wells
CompWellState<FluidSystem>::
report() const
{
    if (this->wells_.empty()) {
        return {};
    }
    using rt = data::Rates::opt;

    data::Wells res;
    for (std::size_t w = 0; w < this->wells_.size(); ++w) {
        const auto& ws = this->wells_[w];
        if (ws.status == Well::Status::SHUT) {
            continue;
        }
        auto& well = res[ws.name];
        well.bhp = ws.bhp;
        well.temperature = ws.temperature;
        const auto& surface_rates = ws.surface_phase_rates;
        if (FluidSystem::phaseIsActive(FluidSystem::waterPhaseIdx)) {
            well.rates.set(rt::wat, surface_rates[FluidSystem::waterPhaseIdx]);
        }
        if (FluidSystem::phaseIsActive(FluidSystem::oilPhaseIdx)) {
            well.rates.set(rt::oil, surface_rates[FluidSystem::oilPhaseIdx]);
        }
        if (FluidSystem::phaseIsActive(FluidSystem::gasPhaseIdx)) {
            well.rates.set(rt::gas, surface_rates[FluidSystem::gasPhaseIdx]);
        }
    }
    return res;
}

} // end of namespace Opm