diff --git a/projection_utils.py b/projection_utils.py index 9df58307473561a3bb0e899bc2f877b34409b6d2..d159bd8671f985692ec0fd92862fdebdb8ba58d3 100644 --- a/projection_utils.py +++ b/projection_utils.py @@ -40,6 +40,13 @@ class Mesh: cells : ndarray Array of cell centers in mesh. + Methods + ------- + create_data_dict() + Return dictionary with data necessary to construct mesh. + random_stencil(stencil_len) + Return random stencil. + """ def __init__(self, num_cells: int, num_ghost_cells: int, @@ -62,6 +69,11 @@ class Mesh: Flag indicating whether the mesh is used for training data generation. Default: False. + Raises + ------ + ValueError + If number of cells is not exponential of 2. + """ self._num_cells = num_cells self._mode = 'training' if training_data_mode else 'evaluation'