Reinforcement profile¶
KoswatProfileBase
dataclass
¶
Bases: KoswatProfileProtocol
Basic definition and implementation of a KoswatProfileProtocol. It represents the initial koswat profile being provided by the user from which further calculations will be made.
points: list[Point]
property
¶
The combination of points from both water and polder sides.
Returns:
| Type | Description |
|---|---|
list[Point]
|
list[Point]: A total of eight points comforming the |
profile_height: float
property
¶
The profile highest point (largest y-coordinate).
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Greatest y-coordinate. |
profile_width: float
property
¶
The profile extent from the lowest (left-most) x-coordinate to the largest (right-most) x-coordinate from a dike geometry polygon.
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Total distance. |
ReinforcementInputProfileCalculationProtocol
¶
Bases: BuilderProtocol, Protocol
build() -> ReinforcementInputProfileProtocol
¶
Builds a ReinforcementInputProfileProtocol instance based on the base_profile and scenario specified in this class.
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementInputProfileProtocol |
ReinforcementInputProfileProtocol
|
Calculated reinforcement input profile. |
ReinforcementInputProfileProtocol
¶
Bases: KoswatInputProfileProtocol, Protocol
Just an alias to distinguish from a regular KoswatInputProfileProtocol.
reinforcement_domain_name: str
property
¶
Returns the representative name in the "real" world of this reinforcement.
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
ReinforcementProfileBuilderProtocol
¶
Bases: BuilderProtocol, Protocol
build() -> ReinforcementProfileProtocol
¶
Builds a concrete instance of a ReinforcementProfileProtocol based on the required data.
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementProfileProtocol |
ReinforcementProfileProtocol
|
Valid instance of a |
KoswatProfileBase
dataclass
¶
Bases: KoswatProfileProtocol
Basic definition and implementation of a KoswatProfileProtocol. It represents the initial koswat profile being provided by the user from which further calculations will be made.
points: list[Point]
property
¶
The combination of points from both water and polder sides.
Returns:
| Type | Description |
|---|---|
list[Point]
|
list[Point]: A total of eight points comforming the |
profile_height: float
property
¶
The profile highest point (largest y-coordinate).
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Greatest y-coordinate. |
profile_width: float
property
¶
The profile extent from the lowest (left-most) x-coordinate to the largest (right-most) x-coordinate from a dike geometry polygon.
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Total distance. |
ReinforcementProfileBuilderFactory
¶
get_available_reinforcements() -> list[ReinforcementProfileProtocol]
staticmethod
¶
Gets all available reinforcements defined in Koswat.
Returns:
| Type | Description |
|---|---|
list[ReinforcementProfileProtocol]
|
List[ReinforcementProfileProtocol]: List of reinforcement profile protocols types. |
get_reinforcement_builder(reinforcement_profile_type: type[ReinforcementProfileProtocol]) -> ReinforcementProfileBuilderProtocol
staticmethod
¶
Gets a valid reinforcement profile builder instance (ReinforcementProfileBuilderProtocol).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reinforcement_profile_type |
Type[ReinforcementProfileProtocol]
|
Type that requires a builder. |
required |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
When there is no builder associated to the given |
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementProfileBuilderProtocol |
ReinforcementProfileBuilderProtocol
|
Valid instance of a |
ReinforcementProfileBuilderProtocol
¶
Bases: BuilderProtocol, Protocol
build() -> ReinforcementProfileProtocol
¶
Builds a concrete instance of a ReinforcementProfileProtocol based on the required data.
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementProfileProtocol |
ReinforcementProfileProtocol
|
Valid instance of a |
ReinforcementProfileProtocol
¶
Bases: KoswatProfileProtocol, Protocol
Extension of the KoswatProfileProtocol to define the properties of a calculated reinforcement.
StandardReinforcementProfileBuilder
¶
Bases: ReinforcementProfileBuilderBase
get_input_profile_calculator(reinforcement_type: type[StandardReinforcementProfile]) -> ReinforcementInputProfileCalculationProtocol
staticmethod
¶
Get the input profile calculator for the given reinforcement type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reinforcement_type |
type[StandardReinforcementProfile]
|
The reinforcement type. |
required |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
The given reinforcement type is not supported. |
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementInputProfileCalculationProtocol |
ReinforcementInputProfileCalculationProtocol
|
The input profile calculator. |
BuilderProtocol
¶
Bases: Protocol
build() -> Any
¶
Instantiates a concrete object to separate its initalization from the data structure.
Returns:
| Name | Type | Description |
|---|---|---|
Any |
Any
|
Intance of a created object within Koswat domain. |
KoswatProfileBase
dataclass
¶
Bases: KoswatProfileProtocol
Basic definition and implementation of a KoswatProfileProtocol. It represents the initial koswat profile being provided by the user from which further calculations will be made.
points: list[Point]
property
¶
The combination of points from both water and polder sides.
Returns:
| Type | Description |
|---|---|
list[Point]
|
list[Point]: A total of eight points comforming the |
profile_height: float
property
¶
The profile highest point (largest y-coordinate).
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Greatest y-coordinate. |
profile_width: float
property
¶
The profile extent from the lowest (left-most) x-coordinate to the largest (right-most) x-coordinate from a dike geometry polygon.
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Total distance. |
ReinforcementProfileBuilderProtocol
¶
Bases: BuilderProtocol, Protocol
build() -> ReinforcementProfileProtocol
¶
Builds a concrete instance of a ReinforcementProfileProtocol based on the required data.
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementProfileProtocol |
ReinforcementProfileProtocol
|
Valid instance of a |
ReinforcementProfileProtocol
¶
Bases: KoswatProfileProtocol, Protocol
Extension of the KoswatProfileProtocol to define the properties of a calculated reinforcement.
ReinforcementInputProfileProtocol
¶
Bases: KoswatInputProfileProtocol, Protocol
Just an alias to distinguish from a regular KoswatInputProfileProtocol.
reinforcement_domain_name: str
property
¶
Returns the representative name in the "real" world of this reinforcement.
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
ReinforcementProfileProtocol
¶
Bases: KoswatProfileProtocol, Protocol
Extension of the KoswatProfileProtocol to define the properties of a calculated reinforcement.
KoswatProfileBase
dataclass
¶
Bases: KoswatProfileProtocol
Basic definition and implementation of a KoswatProfileProtocol. It represents the initial koswat profile being provided by the user from which further calculations will be made.
points: list[Point]
property
¶
The combination of points from both water and polder sides.
Returns:
| Type | Description |
|---|---|
list[Point]
|
list[Point]: A total of eight points comforming the |
profile_height: float
property
¶
The profile highest point (largest y-coordinate).
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Greatest y-coordinate. |
profile_width: float
property
¶
The profile extent from the lowest (left-most) x-coordinate to the largest (right-most) x-coordinate from a dike geometry polygon.
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Total distance. |
ReinforcementInputProfileProtocol
¶
Bases: KoswatInputProfileProtocol, Protocol
Just an alias to distinguish from a regular KoswatInputProfileProtocol.
reinforcement_domain_name: str
property
¶
Returns the representative name in the "real" world of this reinforcement.
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
ReinforcementProfileProtocol
¶
Bases: KoswatProfileProtocol, Protocol
Extension of the KoswatProfileProtocol to define the properties of a calculated reinforcement.
Outside slope¶
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
CofferdamInputProfileCalculation
¶
Bases: ReinforcementInputProfileCalculationBase, ReinforcementInputProfileCalculationProtocol
KoswatProfileBase
dataclass
¶
Bases: KoswatProfileProtocol
Basic definition and implementation of a KoswatProfileProtocol. It represents the initial koswat profile being provided by the user from which further calculations will be made.
points: list[Point]
property
¶
The combination of points from both water and polder sides.
Returns:
| Type | Description |
|---|---|
list[Point]
|
list[Point]: A total of eight points comforming the |
profile_height: float
property
¶
The profile highest point (largest y-coordinate).
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Greatest y-coordinate. |
profile_width: float
property
¶
The profile extent from the lowest (left-most) x-coordinate to the largest (right-most) x-coordinate from a dike geometry polygon.
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Total distance. |
OutsideSlopeReinforcementLayersWrapperBuilder
¶
ReinforcementInputProfileCalculationProtocol
¶
Bases: BuilderProtocol, Protocol
build() -> ReinforcementInputProfileProtocol
¶
Builds a ReinforcementInputProfileProtocol instance based on the base_profile and scenario specified in this class.
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementInputProfileProtocol |
ReinforcementInputProfileProtocol
|
Calculated reinforcement input profile. |
ReinforcementInputProfileProtocol
¶
Bases: KoswatInputProfileProtocol, Protocol
Just an alias to distinguish from a regular KoswatInputProfileProtocol.
reinforcement_domain_name: str
property
¶
Returns the representative name in the "real" world of this reinforcement.
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
Standard¶
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
KoswatProfileBase
dataclass
¶
Bases: KoswatProfileProtocol
Basic definition and implementation of a KoswatProfileProtocol. It represents the initial koswat profile being provided by the user from which further calculations will be made.
points: list[Point]
property
¶
The combination of points from both water and polder sides.
Returns:
| Type | Description |
|---|---|
list[Point]
|
list[Point]: A total of eight points comforming the |
profile_height: float
property
¶
The profile highest point (largest y-coordinate).
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Greatest y-coordinate. |
profile_width: float
property
¶
The profile extent from the lowest (left-most) x-coordinate to the largest (right-most) x-coordinate from a dike geometry polygon.
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Total distance. |
OutsideSlopeReinforcementLayersWrapperBuilder
¶
PipingWallInputProfileCalculation
¶
Bases: ReinforcementInputProfileCalculationBase, ReinforcementInputProfileCalculationProtocol
ReinforcementInputProfileCalculationProtocol
¶
Bases: BuilderProtocol, Protocol
build() -> ReinforcementInputProfileProtocol
¶
Builds a ReinforcementInputProfileProtocol instance based on the base_profile and scenario specified in this class.
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementInputProfileProtocol |
ReinforcementInputProfileProtocol
|
Calculated reinforcement input profile. |
ReinforcementInputProfileProtocol
¶
Bases: KoswatInputProfileProtocol, Protocol
Just an alias to distinguish from a regular KoswatInputProfileProtocol.
reinforcement_domain_name: str
property
¶
Returns the representative name in the "real" world of this reinforcement.
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |
SoilInputProfileCalculation
¶
Bases: ReinforcementInputProfileCalculationBase, ReinforcementInputProfileCalculationProtocol
StabilityWallInputProfileCalculation
¶
Bases: ReinforcementInputProfileCalculationBase, ReinforcementInputProfileCalculationProtocol
StandardReinforcementLayersWrapperBuilder
¶
StandardReinforcementProfileBuilder
¶
Bases: ReinforcementProfileBuilderBase
get_input_profile_calculator(reinforcement_type: type[StandardReinforcementProfile]) -> ReinforcementInputProfileCalculationProtocol
staticmethod
¶
Get the input profile calculator for the given reinforcement type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reinforcement_type |
type[StandardReinforcementProfile]
|
The reinforcement type. |
required |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
The given reinforcement type is not supported. |
Returns:
| Name | Type | Description |
|---|---|---|
ReinforcementInputProfileCalculationProtocol |
ReinforcementInputProfileCalculationProtocol
|
The input profile calculator. |
ReinforcementLayersWrapper
¶
Bases: KoswatLayersWrapperProtocol
layers: list[ReinforcementLayerProtocol]
property
¶
All the stored layers being the KoswatBaseLayer the latest one in the collection.
Returns:
| Type | Description |
|---|---|
list[ReinforcementLayerProtocol]
|
List[KoswatLayerProtocol]: Ordered list of |