ug::FVLineSourceOrSink< 1, TData > Class Template Reference
#include <fv1_sss.h>
Inheritance diagram for ug::FVLineSourceOrSink< 1, TData >:
Public Member Functions | |
| template<typename TElem , typename TAAPos , typename TFVGeom > | |
| bool | corresponds_to (TElem *elem, Grid &grid, TAAPos &aaPos, const TFVGeom &geo, size_t co, MathVector< dim > &ls, MathVector< dim > &le) |
| test whether a source/sink point corresponds to a given corner of the element More... | |
| const MathVector< dim > & | from_position () |
| returns the beginning of the line segment More... | |
| FVLineSourceOrSink (const MathVector< dim > &_point1, const MathVector< dim > &_point2) | |
| class constructor (with the default constructor for data) More... | |
| FVLineSourceOrSink (const MathVector< dim > &_point1, const MathVector< dim > &_point2, const TData &_data) | |
| class constructor (with the copy constructor for data) More... | |
| FVLineSourceOrSink (const std::vector< number > &_point1, const std::vector< number > &_point2) | |
| class constructor (with the default constructor for data) More... | |
| const MathVector< dim > & | to_position () |
| returns the end of the line segment More... | |
Private Attributes | |
| MathVector< dim > | point1 |
| beginning of the line segment More... | |
| MathVector< dim > | point2 |
| end of the line segment More... | |
Static Private Attributes | |
| static const int | dim = 1 |
Detailed Description
template<typename TData>
class ug::FVLineSourceOrSink< 1, TData >
Partial specialization of for 1d: No line sources and sinks in 1d Base class for line sources and sinks
Constructor & Destructor Documentation
◆ FVLineSourceOrSink() [1/3]
template<typename TData >
|
inline |
class constructor (with the default constructor for data)
- Parameters
-
_point1 beginning of the line segment _point2 end of the line segment
◆ FVLineSourceOrSink() [2/3]
template<typename TData >
|
inline |
class constructor (with the copy constructor for data)
- Parameters
-
_point1 beginning of the line segment _point2 end of the line segment _data the data to copy
◆ FVLineSourceOrSink() [3/3]
template<typename TData >
|
inline |
class constructor (with the default constructor for data)
- Parameters
-
_point1 beginning of the line segment _point2 end of the line segment
References UG_THROW.
Member Function Documentation
◆ corresponds_to()
template<typename TData >
template<typename TElem , typename TAAPos , typename TFVGeom >
|
inline |
test whether a source/sink point corresponds to a given corner of the element
- Parameters
-
[in] elem the element [in] grid the grid [in] aaPos position of the vertices [in] geo FV geometry (initialized for 'elem') [in] co corner to get the contribution for [out] ls beginning of the subsegment [out] le end of the subsegment
References UG_THROW.
◆ from_position()
template<typename TData >
|
inline |
returns the beginning of the line segment
References ug::FVLineSourceOrSink< dim, TData >::point1.
◆ to_position()
template<typename TData >
|
inline |
returns the end of the line segment
References ug::FVLineSourceOrSink< dim, TData >::point2.
Member Data Documentation
◆ dim
template<typename TData >
|
staticprivate |
◆ point1
template<typename TData >
|
private |
beginning of the line segment
◆ point2
template<typename TData >
|
private |
end of the line segment
The documentation for this class was generated from the following file:
- ugbase/lib_disc/spatial_disc/disc_util/fv1_sss.h
