Cross-sectional flow (2-dimensional).
More...
#include <dbpp_SectionFlow.h>
|
| | SectionFlow ()=default |
| | default ctor
|
| constexpr | SectionFlow (uint32 aId, float64 aX, eSectionType aType=eSectionType::unitwidth) |
| | set most of the section hydraulic parameters to default value such N=0,B=1,Z=0
|
| constexpr | SectionFlow (uint32 aId, float64 aX, float64 aH, float64 d=0., float64 aZ=0.) noexcept |
| | Check older version for description (coming) VS15 project.
|
| constexpr bool | isUnitWidth () const noexcept |
| | Check unit width.
|
| constexpr bool | isFrictionLess () const noexcept |
| | Check friction.
|
| constexpr bool | isFlatBottom () const noexcept |
| | Check section bottom type.
|
| constexpr float64 | X () const noexcept |
| | Getter.
|
| constexpr float64 | Z () const noexcept |
| | Getter.
|
| constexpr float64 | H () const noexcept |
| | Getter.
|
| constexpr float64 | N () const noexcept |
| | Gdetter.
|
| constexpr float64 | B () const noexcept |
| | Getter.
|
| constexpr float64 | getS0am () const noexcept |
| | Getter.
|
| constexpr float64 | getS0av () const noexcept |
| | Getter.
|
| constexpr unsigned | getId () const noexcept |
| | Getter.
|
| eSectionType | getType () const noexcept |
| | Getter.
|
| constexpr eSectionType | getSectionType () const noexcept |
| | Getter.
|
| constexpr void | setH (float64 aH) noexcept |
| | Setter.
|
| constexpr void | setN (float64 aN) noexcept |
| | Setter.
|
| constexpr void | setZ (float64 aZ) noexcept |
| | Setter.
|
| constexpr void | setB (float64 aB) noexcept |
| | Setter.
|
| constexpr void | setSectionUnitWidth () noexcept |
| | Setter.
|
| auto | operator== (const SectionFlow &aOther) const |
| | comparison operator ==, !=(generated)
|
| auto | operator<=> (const SectionFlow &aOther) const |
| | comparison operator (all other operators such: <,>,<=,>=)
|
| void | printSectionInfo () const |
| | / want to use it with mem_fn
|
Cross-sectional flow (2-dimensional).
◆ eSectionType
Section flow geometry.
| Enumerator |
|---|
| unitwidth | section unit width
|
| rectangular | |
◆ SectionFlow() [1/3]
| dbpp::SectionFlow::SectionFlow |
( |
| ) |
|
|
default |
◆ SectionFlow() [2/3]
set most of the section hydraulic parameters to default value such N=0,B=1,Z=0
- Parameters
-
| aId | section index |
| aX | x coordinate along flow (longitudinal) |
| aType | section geometry type |
◆ SectionFlow() [3/3]
Check older version for description (coming) VS15 project.
- Parameters
-
| aId | Section id |
| aX | section x-coordinate along flow (longitudinal) |
| d | Section transversal coordinate |
| aZ | bathymetry coordinate about bottom reference |
◆ B()
| float64 dbpp::SectionFlow::B |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Getter.
- Returns
- Section width (top)
◆ getId()
| unsigned dbpp::SectionFlow::getId |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Getter.
- Returns
- section id
◆ getS0am()
| float64 dbpp::SectionFlow::getS0am |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Getter.
- Returns
- Bed slope upstream
◆ getS0av()
| float64 dbpp::SectionFlow::getS0av |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Getter.
- Returns
- Bed slope downtream
◆ getSectionType()
Getter.
- Returns
- section type
◆ getType()
Getter.
- Returns
- section type
- Deprecated
- to be removed in the next re-factoring (not used)
◆ H()
| float64 dbpp::SectionFlow::H |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Getter.
- Returns
- Water depth
◆ isFlatBottom()
| bool dbpp::SectionFlow::isFlatBottom |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Check section bottom type.
- Returns
- true/false
◆ isFrictionLess()
| bool dbpp::SectionFlow::isFrictionLess |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Check friction.
- Returns
- true/false
◆ isUnitWidth()
| bool dbpp::SectionFlow::isUnitWidth |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Check unit width.
- Returns
- true/false
◆ N()
| float64 dbpp::SectionFlow::N |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Gdetter.
4 *
- Returns
- Manning coefficient
◆ operator<=>()
| auto dbpp::SectionFlow::operator<=> |
( |
const SectionFlow & | aOther | ) |
const |
|
inline |
comparison operator (all other operators such: <,>,<=,>=)
- Parameters
-
| aOther | object to compare with |
- Returns
- ordering category
◆ operator==()
| auto dbpp::SectionFlow::operator== |
( |
const SectionFlow & | aOther | ) |
const |
|
inline |
comparison operator ==, !=(generated)
- Parameters
-
| aOther | object to compare with |
- Returns
- ordering category
◆ printSectionInfo()
| void dbpp::SectionFlow::printSectionInfo |
( |
| ) |
const |
|
inline |
/ want to use it with mem_fn
◆ setB()
| void dbpp::SectionFlow::setB |
( |
float64 | aB | ) |
|
|
inlineconstexprnoexcept |
◆ setH()
| void dbpp::SectionFlow::setH |
( |
float64 | aH | ) |
|
|
inlineconstexprnoexcept |
◆ setN()
| void dbpp::SectionFlow::setN |
( |
float64 | aN | ) |
|
|
inlineconstexprnoexcept |
◆ setSectionUnitWidth()
| void dbpp::SectionFlow::setSectionUnitWidth |
( |
| ) |
|
|
inlineconstexprnoexcept |
◆ setZ()
| void dbpp::SectionFlow::setZ |
( |
float64 | aZ | ) |
|
|
inlineconstexprnoexcept |
◆ X()
| float64 dbpp::SectionFlow::X |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Getter.
- Returns
- x coordinate
◆ Z()
| float64 dbpp::SectionFlow::Z |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Getter.
- Returns
- bathy value
◆ m_B
◆ m_d
section transversal coordinate
◆ m_H
◆ m_id
| unsigned dbpp::SectionFlow::m_id |
|
private |
◆ m_N
section Manning coefficient
◆ m_S0am
section bottom slope upstream
◆ m_S0av
section bottom slope downstream
◆ m_type
◆ m_x
◆ m_Z
section bottom thalweg or topography?? an array
The documentation for this class was generated from the following file: