4.2.1.4. pde.grids.boundaries.axis module
This module handles the boundaries of a single axis of a grid. There are
generally only two options, depending on whether the axis of the underlying
grid is defined as periodic or not. If it is periodic, the class
BoundaryPeriodic
should be used, while
non-periodic axes have more option, which are represented by
BoundaryPair
.
- class BoundaryAxisBase(low, high)[source]
Bases:
object
base class for defining boundaries of a single axis in a grid
- Parameters:
- classmethod get_help()[source]
Return information on how boundary conditions can be set
- Return type:
- get_mathematical_representation(field_name='C')[source]
return mathematical representation of the boundary condition
- class BoundaryPair(low, high)[source]
Bases:
BoundaryAxisBase
represents the two boundaries of an axis along a single dimension
- Parameters:
- check_value_rank(rank)[source]
check whether the values at the boundaries have the correct rank
- Parameters:
rank (int) – The tensorial rank of the field for this boundary condition
- Return type:
None
- Throws:
RuntimeError: if the value does not have rank rank
- class BoundaryPeriodic(grid, axis, flip_sign=False)[source]
Bases:
BoundaryPair
represent a periodic axis
- Parameters:
- check_value_rank(rank)[source]
check whether the values at the boundaries have the correct rank
- Parameters:
rank (int) – The tensorial rank of the field for this boundary condition
- Return type:
None