Skip to content

Commit

Permalink
doc string
Browse files Browse the repository at this point in the history
  • Loading branch information
0x23 authored Apr 2, 2024
1 parent 28d5dc2 commit 1f16fcf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion source/scene_objects/static_dampening.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class StaticDampening(wave_simulation.SceneObject):
def __init__(self, dampening_field, border_thickness):
"""
Creates a static dampening field object
@param dampening_field: The dampening field. If None, a default dampening field is applied.
@param dampening_field: A NxM array with dampening factors (1.0 equals no dampening) of the same size as the simulation domain.
@param pml_thickness: Thickness of the Perfectly Matched Layer (PML) at the boundaries to prevent reflections.
"""
w = dampening_field.shape[1]
Expand Down

0 comments on commit 1f16fcf

Please sign in to comment.