Abstract coupling point between a 1D SWMM object and a 2D mesh cell. More...

#include <SpatialFrame.hpp>

Collaboration diagram for openswmm::ICouplingPoint:

Public Member Functions
virtual	~ICouplingPoint ()=default

virtual int	object_index () const noexcept=0
	Index of the 1D SWMM object (node, link, or subcatch index).

virtual const char *	object_type () const noexcept=0
	Type: "NODE", "LINK", or "SUBCATCH".

virtual void	exchange_to_2d (double value)=0
	Exchange 1D state to the 2D component at this point.

virtual double	receive_from_2d () const =0
	Receive 2D state from the 2D component at this point.

Detailed Description

Abstract coupling point between a 1D SWMM object and a 2D mesh cell.

This will be implemented by the 2D SWMM component to register exchange points. The 1D engine does not depend on the 2D implementation — coupling is always optional.

Constructor & Destructor Documentation

◆ ~ICouplingPoint()

virtual openswmm::ICouplingPoint::~ICouplingPoint ( )

virtualdefault

Member Function Documentation

◆ exchange_to_2d()

virtual void openswmm::ICouplingPoint::exchange_to_2d ( double value )

pure virtual

Exchange 1D state to the 2D component at this point.

◆ object_index()

virtual int openswmm::ICouplingPoint::object_index ( ) const

pure virtualnoexcept

Index of the 1D SWMM object (node, link, or subcatch index).

◆ object_type()

virtual const char * openswmm::ICouplingPoint::object_type ( ) const

pure virtualnoexcept

Type: "NODE", "LINK", or "SUBCATCH".

◆ receive_from_2d()

virtual double openswmm::ICouplingPoint::receive_from_2d ( ) const