Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alihakimtaskiran committed Mar 22, 2023
1 parent 79778d3 commit 543de5f
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,13 +165,14 @@ pip install glimy
PEC (Perfect Electric Conductor): Reflects all waves perfectly
ABC (Absorbing Boundary Conditions): Absorbs all waves

-L(self, boundary_type="ABC"): Sets the left boundary condition.
-R(self, boundary_type="ABC"): Sets the right boundary condition.
-B(self, boundary_type="ABC"): Sets the backward boundary condition.
-F(self, boundary_type="ABC"): Sets the forward boundary condition.
-D(self, boundary_type="ABC"): Sets the down boundary condition (for 3D grids only).
-U(self, boundary_type="ABC"): Sets the up boundary condition (for 3D grids only).
A short example: <code>
- L(self, boundary_type="ABC"): Sets the left boundary condition.
- R(self, boundary_type="ABC"): Sets the right boundary condition.
- B(self, boundary_type="ABC"): Sets the backward boundary condition.
- F(self, boundary_type="ABC"): Sets the forward boundary condition.
- D(self, boundary_type="ABC"): Sets the down boundary condition (for 3D grids only).
- U(self, boundary_type="ABC"): Sets the up boundary condition (for 3D grids only).
A short example:
<code>
boundaries = Boundaries(3) # Creates a 3D grid with default ABC boundaries
boundaries.L("PEC") # Sets the left boundary to PEC
boundaries.R("PEC") # Sets the right boundary to PEC
Expand Down

0 comments on commit 543de5f

Please sign in to comment.