BHEInflowPythonBoundaryConditionPythonSideInterface.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
namespace ProcessLib
{
class BHEInflowPythonBoundaryConditionPythonSideInterface
{
public:
    virtual std::tuple<double /*time*/,
                       std::vector<double> /*Tin_val*/,
                       std::vector<double> /*Tout_val*/,
                       std::vector<int> /*bc_out_ids*/,
                       std::vector<double> /*BHE_flowrate*/>
    initializeDataContainer() const
    {
        _overridden_essential = false;
        return std::tuple<double,
                          std::vector<double>,
                          std::vector<double>,
                          std::vector<int>,
                          std::vector<double>>{
            std::numeric_limits<double>::quiet_NaN(), {}, {}, {}, {}};
    }

    virtual std::tuple<bool, bool, std::vector<double>, std::vector<double>>
    tespySolver(double /*t*/,
                std::vector<double> const& /*Tin_val*/,
                std::vector<double> const& /*Tout_val*/) const
    {
        _overridden_tespy = false;
        return std::tuple<bool, bool, std::vector<double>, std::vector<double>>{
            false, false, {}, {}};
    }

    virtual std::tuple<std::vector<double>, std::vector<double>>
    serverCommunicationPreTimestep(double /*t*/,
                        double /*dt*/,
                        std::vector<double> const& /*Tin_val*/,
                        std::vector<double> const& /*Tout_val*/,
                        std::vector<double> const& /*BHE_flowrate*/) const
    {
        _overridden_server_communication_pre = false;
        return {};
    }
 
    virtual void serverCommunicationPostTimestep(double /*t*/,
                             double /*dt*/,
                             std::vector<double> const& /*Tin_val*/,
                             std::vector<double> const& /*Tout_val*/,
                             std::vector<double> const& /*BHE_flowrate*/) const
    {
        _overridden_server_communication_post = false;
    }

    bool isOverriddenEssential() const { return _overridden_essential; }

    bool isOverriddenTespy() const { return _overridden_tespy; }

    bool isOverriddenServerCommunicationPreTimestep() const
    {
        return _overridden_server_communication_pre;
    }
 
    bool isOverriddenServerCommunicationPostTimestep() const
    {
        return _overridden_server_communication_post;
    }
 
    // BHE network dataframe container
    std::tuple<double,
               std::vector<double>,
               std::vector<double>,
               std::vector<int>,
               std::vector<double>>
        dataframe_network;
 
    virtual ~BHEInflowPythonBoundaryConditionPythonSideInterface() = default;
 
private:
    mutable bool _overridden_essential = true;
    mutable bool _overridden_tespy = true;
    mutable bool _overridden_server_communication_pre = true;
 
    mutable bool _overridden_server_communication_post = true;
};
}  // namespace ProcessLib