ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData > Class Template Reference

Manager class for point and line sources and sinks. More...

#include <fv1_sss.h>

Classes
class	line_iterator
	class of line source and sink iterator for a given scv More...
class	point_iterator
	class of point source and sink iterator for a given scv More...

Public Types
typedef FVLineSourceOrSink< dim, TLineData >	line_sss_type
typedef FVPointSourceOrSink< dim, TPointData >	point_sss_type

Public Member Functions
void	add_line (SmartPtr< line_sss_type > line_sss)
	add a line source or sink
void	add_point (SmartPtr< point_sss_type > point_sss)
	add a point source or sink
	FVSingularSourcesAndSinks ()
	class constructor
void	init_all_line_sss ()
	calls the init-functions of all line sinks (if there are any in TLineData)
void	init_all_point_sss ()
	calls the init-functions of all point sinks (if there are any in TPointData)
line_sss_type *	line (size_t i)
	return a line sink with a given index
size_t	num_lines ()
	returns the number of the line sources and sinks
size_t	num_points ()
	returns the number of the point sources and sinks
point_sss_type *	point (size_t i)
	return a point sink with a given index

Private Attributes
std::vector< SmartPtr< line_sss_type > >	ListL
std::vector< SmartPtr< point_sss_type > >	ListP

Detailed Description

template<int dim, typename TPointData, typename TLineData = TPointData>
class ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >

Manager class for point and line sources and sinks.

Member Typedef Documentation

line_sss_type

template<int dim, typename TPointData , typename TLineData = TPointData>

typedef FVLineSourceOrSink<dim, TLineData> ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::line_sss_type

point_sss_type

template<int dim, typename TPointData , typename TLineData = TPointData>

typedef FVPointSourceOrSink<dim, TPointData> ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::point_sss_type

Constructor & Destructor Documentation

FVSingularSourcesAndSinks()

template<int dim, typename TPointData , typename TLineData = TPointData>

ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::FVSingularSourcesAndSinks ( )

inline

class constructor

Member Function Documentation

add_line()

template<int dim, typename TPointData , typename TLineData = TPointData>

void ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::add_line ( SmartPtr< line_sss_type >  line_sss )

inline

add a line source or sink

Parameters

line_sss

the object to add

References ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListL.

add_point()

template<int dim, typename TPointData , typename TLineData = TPointData>

void ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::add_point ( SmartPtr< point_sss_type >  point_sss )

inline

add a point source or sink

Parameters

point_sss

the object to add

References ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListP.

init_all_line_sss()

template<int dim, typename TPointData , typename TLineData = TPointData>

void ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::init_all_line_sss ( )

inline

calls the init-functions of all line sinks (if there are any in TLineData)

References ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListL.

init_all_point_sss()

template<int dim, typename TPointData , typename TLineData = TPointData>

void ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::init_all_point_sss ( )

inline

calls the init-functions of all point sinks (if there are any in TPointData)

References ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListP.

line()

template<int dim, typename TPointData , typename TLineData = TPointData>

line_sss_type * ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::line ( size_t  i )

inline

return a line sink with a given index

References ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListL.

num_lines()

template<int dim, typename TPointData , typename TLineData = TPointData>

size_t ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::num_lines ( )

inline

returns the number of the line sources and sinks

References ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListL.

num_points()

template<int dim, typename TPointData , typename TLineData = TPointData>

size_t ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::num_points ( )

inline

returns the number of the point sources and sinks

References ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListP.

point()

template<int dim, typename TPointData , typename TLineData = TPointData>

point_sss_type * ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::point ( size_t  i )

inline

return a point sink with a given index

References ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListP.

Member Data Documentation

ListL

template<int dim, typename TPointData , typename TLineData = TPointData>

std::vector<SmartPtr<line_sss_type> > ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListL

private

Referenced by ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::add_line(), ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::init_all_line_sss(), ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::line(), ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::line_iterator< TElem, TAAPos, TFVGeom >::next_sss(), and ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::num_lines().

ListP

template<int dim, typename TPointData , typename TLineData = TPointData>

std::vector<SmartPtr<point_sss_type> > ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::ListP

private

Referenced by ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::add_point(), ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::init_all_point_sss(), ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::point_iterator< TElem, TAAPos, TFVGeom >::next_sss(), ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::num_points(), and ug::FVSingularSourcesAndSinks< dim, TPointData, TLineData >::point().

---

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

• ugbase/lib_disc/spatial_disc/disc_util/fv1_sss.h