This class implements the hypercubic basis shape. More...
#include <shape_hypercubic.hpp>
Public Member Functions | |
| HyperCubicShape (const std::array< int, D > &limits) | |
| HyperCubicShape (int limit) | |
| Set limits to \( K_d := K \; \forall d \). More... | |
| HyperCubicShape (std::initializer_list< int > list) | |
| HyperCubicShape (const HyperCubicShape &that) | |
| HyperCubicShape & | operator= (const HyperCubicShape &that) |
| virtual int | limit (int const *base_node, dim_t axis) const override |
| Evaluates one surface function on a base node. More... | |
| virtual int | bbox (dim_t axis) const override |
| Retrieves the length of the minimum bounding box in one direction. More... | |
| virtual void | print (std::ostream &out) const override |
| Prints a pretty description of the shape. More... | |
 Public Member Functions inherited from waveblocks::wavepackets::shapes::AbstractShape< D > | |
| virtual | ~AbstractShape () |
Private Attributes | |
| std::array< int, D > | limits_ |
Detailed Description
template<dim_t D>
class waveblocks::wavepackets::shapes::HyperCubicShape< D >
This class implements the hypercubic basis shape.
A \( D \)-dimensional hypercubic shape with limits \( \mathbf{K}=\{K_1,\dots,K_D\} \) is defined as the set
\[ \mathfrak{K}(D,\mathbf{K}) := \left\{ (k_1, \dots, k_D) \in \mathbb{N}_0^D | k_d < K_d \forall d \right\} \]
- Template Parameters
-
D basis shape dimensionality
Constructor & Destructor Documentation
|
inline |
- Parameters
-
[in] limits Array of all limits \( \{K_d\} \).
|
inline |
Set limits to \( K_d := K \; \forall d \).
- Parameters
-
limit Limit \( K \).
|
inline |
- Parameters
-
list List of all limits \( \{K_d\} \).
|
inline |
Member Function Documentation
|
inlineoverridevirtual |
Retrieves the length of the minimum bounding box in one direction.
The minimum bounding box is given by
\[ L_{\alpha}=\max_{k_{\alpha}}\left\{\underline{k} \in \mathfrak{K}\right\} \]
- Parameters
-
axis The direction \( \alpha \).
- Returns
- Length of the bbox.
Implements waveblocks::wavepackets::shapes::AbstractShape< D >.
|
inlineoverridevirtual |
Evaluates one surface function on a base node.
The surface function to direction \( \alpha \) is given by
\[ s_{\alpha}(\underline{n})=\max_{k_{\alpha}} \left\{\underline{k} \in \mathfrak{K} \;|\; k_d = n_d \; \forall d \neq \alpha \right\} \]
Notice that the \( \alpha \)-th entry of \( \underline{n} \) does not influence return value. It can be of any value since it is simply ignored.
- Parameters
-
base_node The basis node \( \underline{n} \). It contains D indices. axis The direction \( \alpha \).
- Returns
- Value of the surface function.
Implements waveblocks::wavepackets::shapes::AbstractShape< D >.
|
inline |
|
inlineoverridevirtual |
Prints a pretty description of the shape.
- Parameters
-
out The output stream.
Implements waveblocks::wavepackets::shapes::AbstractShape< D >.
Member Data Documentation
|
private |
The documentation for this class was generated from the following file:
- /userdata/raoulb/LWB/libwaveblocks/waveblocks/wavepackets/shapes/shape_hypercubic.hpp
