comparison src/SbpOperators/readoperator.jl @ 860:568058183791 operator_storage_array_of_table

Rename argument for `read_stencil_set`: `fn` -> `filename`
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 19 Jan 2022 07:17:53 +0100
parents 0ed9ac097200
children 06c510d40ebb 7bf3121c6864
comparison
equal deleted inserted replaced
856:0ed9ac097200 860:568058183791
8 export parse_tuple 8 export parse_tuple
9 9
10 export sbp_operators_path 10 export sbp_operators_path
11 11
12 12
13 #REVIEW: Reference fn in doc for read_stencil_set.
14 # Is it the filename of the TOML?
15 """ 13 """
16 read_stencil_set(fn; filters) 14 read_stencil_set(filename; filters)
17 15
18 Picks out a stencil set from the given TOML file based on some key-value 16 Picks out a stencil set from a TOML file based on some key-value
19 filters. If more than one set matches the filters an error is raised. The 17 filters. If more than one set matches the filters an error is raised. The
20 returned stencil set contains parsed TOML intended for functions like 18 returned stencil set contains parsed TOML intended for functions like
21 `parse_scalar` and `parse_stencil`. 19 `parse_scalar` and `parse_stencil`.
22 20
23 The stencil set is not parsed beyond the inital TOML parse. To get usable 21 The stencil set is not parsed beyond the inital TOML parse. To get usable
29 27
30 For more information see [Operator file format](@ref) in the documentation. 28 For more information see [Operator file format](@ref) in the documentation.
31 29
32 See also [`sbp_operators_path`](@ref), [`get_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref),. 30 See also [`sbp_operators_path`](@ref), [`get_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref),.
33 """ 31 """
34 read_stencil_set(fn; filters...) = get_stencil_set(TOML.parsefile(fn); filters...) 32 read_stencil_set(filename; filters...) = get_stencil_set(TOML.parsefile(filename); filters...)
35 33
36 """ 34 """
37 get_stencil_set(parsed_toml; filters...) 35 get_stencil_set(parsed_toml; filters...)
38 36
39 Picks out a stencil set from an already parsed TOML based on some key-value 37 Picks out a stencil set from an already parsed TOML based on some key-value