ug::d3f::ISubmodule< TGridFunction, dim > Class Template Reference

Abstract base class for independent sub-solvers (e.g., 1D St. Venant). More...

#include <i_coupling_bridge.h>

Inheritance diagram for ug::d3f::ISubmodule< TGridFunction, dim >:

Public Member Functions
	ISubmodule ()=default
virtual void	run (number tStart, number tEnd, number dt)=0
	Executes the submodule's internal solver for the given time interval.
virtual	~ISubmodule ()=default

Protected Attributes
SmartPtr< TGridFunction >	m_u
	The internal state of the submodule.

Detailed Description

template<typename TGridFunction, int dim = TGridFunction::dim>
class ug::d3f::ISubmodule< TGridFunction, dim >

Abstract base class for independent sub-solvers (e.g., 1D St. Venant).

Template Parameters

TGridFunction	The grid function type used by the submodule.
dim	The spatial dimension.

Constructor & Destructor Documentation

ISubmodule()

template<typename TGridFunction , int dim = TGridFunction::dim>

ug::d3f::ISubmodule< TGridFunction, dim >::ISubmodule ( )

default

~ISubmodule()

template<typename TGridFunction , int dim = TGridFunction::dim>

virtual ug::d3f::ISubmodule< TGridFunction, dim >::~ISubmodule ( )

virtualdefault

Member Function Documentation

run()

template<typename TGridFunction , int dim = TGridFunction::dim>

virtual void ug::d3f::ISubmodule< TGridFunction, dim >::run ( number  tStart, number  tEnd, number  dt  )

pure virtual

Executes the submodule's internal solver for the given time interval.

Parameters

tStart	Start time.
tEnd	End time.
dt	Time step size.

Implemented in ug::d3f::StVenantSubmodule< TGridFunction, dim >.

Member Data Documentation

m_u

template<typename TGridFunction , int dim = TGridFunction::dim>

SmartPtr<TGridFunction> ug::d3f::ISubmodule< TGridFunction, dim >::m_u

protected

The internal state of the submodule.

Referenced by ug::d3f::StVenantSubmodule< TGridFunction, dim >::get_grid_function(), ug::d3f::StVenantSubmodule< TGridFunction, dim >::interpolate_A(), and ug::d3f::StVenantSubmodule< TGridFunction, dim >::interpolate_v().

---

The documentation for this class was generated from the following file:

• /home/runner/work/docs/docs/ug4/plugins/d3f/river_networks/i_coupling_bridge.h