Mercurial > repos > public > sbplib_julia

comparison src/SbpOperators/stencil_set.jl @ 1594:d68d02dd882f feature/boundary_conditions

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge with default
author Vidar Stiernström <vidar.stiernstrom@gmail.com>
date Sat, 25 May 2024 16:07:10 -0700
parents d7bc11053951
children 84dc3b9b449b
comparison
equal deleted inserted replaced
1591:615eeb6e662e 1594:d68d02dd882f
3 3
4 """ 4 """
5 StencilSet 5 StencilSet
6 6
7 A `StencilSet` contains a set of associated stencils. The stencils 7 A `StencilSet` contains a set of associated stencils. The stencils
8 are are stored in a table, and can be accesed by indexing into the `StencilSet`. 8 are are stored in a table, and can be accessed by indexing into the `StencilSet`.
9 """ 9 """
10 struct StencilSet 10 struct StencilSet
11 table 11 table
12 end 12 end
13 Base.getindex(set::StencilSet,I...) = set.table[I...] 13 Base.getindex(set::StencilSet,I...) = set.table[I...]
19 Creates a `StencilSet` from a TOML file based on some key-value 19 Creates a `StencilSet` from a TOML file based on some key-value
20 filters. If more than one set matches the filters an error is raised. The 20 filters. If more than one set matches the filters an error is raised. The
21 table of the `StencilSet` is a parsed TOML intended for functions like 21 table of the `StencilSet` is a parsed TOML intended for functions like
22 `parse_scalar` and `parse_stencil`. 22 `parse_scalar` and `parse_stencil`.
23 23
24 The `StencilSet` table is not parsed beyond the inital TOML parse. To get usable 24 The `StencilSet` table is not parsed beyond the initial TOML parse. To get usable
25 stencils use the `parse_stencil` functions on the fields of the stencil set. 25 stencils use the `parse_stencil` functions on the fields of the stencil set.
26 26
27 The reason for this is that since stencil sets are intended to be very 27 The reason for this is that since stencil sets are intended to be very
28 general, and currently do not include any way to specify how to parse a given 28 general, and currently do not include any way to specify how to parse a given
29 section, the exact parsing is left to the user. 29 section, the exact parsing is left to the user.