i_coupling_bridge.h

Go to the documentation of this file.

//
// Created by julian on 5/15/25.
//
 
#ifndef D3F_ISUBMODULEBRIDGE_H
#define D3F_ISUBMODULEBRIDGE_H
#include <common/util/smart_pointer.h>
 
#include "common/common.h"
 
 
#include <vector>
#include <common/util/smart_pointer.h>
#include "common/common.h"
 
namespace ug {
    class Vertex;
}
 
namespace ug {
namespace d3f {
 
    template<typename TDomain, int dim = TDomain::dim>
    class ISurjectiveInterface {
    public:
        ISurjectiveInterface() = default;
        virtual ~ISurjectiveInterface() = default;
 
        virtual Vertex* subdom_to_dom(Vertex* subdom_vertex) const = 0;
 
        virtual std::vector<Vertex*> dom_to_subdom(Vertex* dom_vertex) const = 0;
    };
 
 
    template<typename TGridFunction, int dim = TGridFunction::dim>
    class ISubmodule {
    public:
        ISubmodule() = default;
        virtual ~ISubmodule() = default;
 
        virtual void run(number tStart, number tEnd, number dt) = 0;
 
    protected:
        SmartPtr<TGridFunction> m_u; 
    };
 
 
    template<typename TGridFunction, int dim = TGridFunction::dim>
    class ISubmoduleBridge {
        friend class ISubmodule<TGridFunction, dim>;
 
    public:
        typedef typename TGridFunction::domain_type domain_type;
        typedef typename domain_type::position_type position_type;
 
        ISubmoduleBridge() = default;
        virtual ~ISubmoduleBridge() = default;
 
        bool apply(SmartPtr<TGridFunction> u, int step, number time, number dt) {
            communicate(time);
            // Submodule execution is typically triggered here or in finalize() 
            // depending on the coupling scheme (explicit/implicit).
            finalize(time);
            return true;
        }
 
        virtual bool finalize_timestep(SmartPtr<TGridFunction> u, int step, number time, number dt) = 0;
        virtual bool init_timestep(SmartPtr<TGridFunction> u, int step, number time, number dt) = 0;
 
        void set_submodule(SmartPtr<ISubmodule<TGridFunction>> submodule) {
            m_submodule = submodule;
        }
 
        void set_interface(SmartPtr<ISurjectiveInterface<domain_type>> interface) {
            m_interface = interface;
        }
 
        virtual void communicate(number time) = 0;
 
        virtual void finalize(number time) = 0;
 
    protected:
        SmartPtr<ISubmodule<TGridFunction>> m_submodule;
        SmartPtr<ISurjectiveInterface<domain_type>> m_interface;
    };
 
} // namespace d3f
} // namespace ug
 
#endif // D3F_ISUBMODULEBRIDGE_H