Mercurial > repos > public > sbplib_julia
view src/SbpOperators/readoperator.jl @ 852:510f744d0876 operator_storage_array_of_table
Add some documentation for the file format
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Fri, 14 Jan 2022 15:39:56 +0100 |
parents | 91a63b04b1c9 |
children | fe8fe3f01162 |
line wrap: on
line source
using TOML export read_stencil_set export get_stencil_set export parse_stencil export parse_scalar export parse_tuple export sbp_operators_path """ read_stencil_set(fn; filters) Picks out a stencil set from the given toml file based on some key-value filters. If more than one set matches the filters an error is raised. The stencil set contains parsed toml intended for functions like `parse_scalar` and `parse_stencil`. The stencil set is not parsed beyond the inital toml parse. To get usable stencils use the `parse_stencil` functions on the fields of the stencil set. The reason for this is that since stencil sets are intended to be very general, and currently do not include any way to specify how to parse a given section, the exact parsing is left to the user. For more information see [Operator file format](@ref) in the documentation. See also [`sbp_operators_path`](@ref), [`get_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref),. """ read_stencil_set(fn; filters...) = get_stencil_set(TOML.parsefile(fn); filters...) """ get_stencil_set(parsed_toml; filters...) Same as `read_stencil_set` but works on already parsed TOML. See also [`read_stencil_set`](@ref). """ function get_stencil_set(parsed_toml; filters...) matches = findall(parsed_toml["stencil_set"]) do set for (key, val) ∈ filters if set[string(key)] != val return false end end return true end if length(matches) != 1 throw(ArgumentError("filters must pick out a single stencil set")) end i = matches[1] return parsed_toml["stencil_set"][i] end """ parse_stencil(parsed_toml) Accepts parsed parsed_toml and reads it as a stencil. See also [`read_stencil_set`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref). """ function parse_stencil(parsed_toml) check_stencil_toml(parsed_toml) if parsed_toml isa Array weights = parse_rational.(parsed_toml) return CenteredStencil(weights...) end weights = parse_rational.(parsed_toml["s"]) return Stencil(weights..., center = parsed_toml["c"]) end """ parse_stencil(T, parsed_toml) Parses the stencil with element type `T` """ parse_stencil(T, parsed_toml) = Stencil{T}(parse_stencil(parsed_toml)) function check_stencil_toml(parsed_toml) if !(parsed_toml isa Dict || parsed_toml isa Vector{String}) throw(ArgumentError("the TOML for a stencil must be a vector of strings or a table.")) end if parsed_toml isa Vector{String} return end if !(haskey(parsed_toml, "s") && haskey(parsed_toml, "c")) throw(ArgumentError("the table form of a stencil must have fields `s` and `c`.")) end if !(parsed_toml["s"] isa Vector{String}) throw(ArgumentError("a stencil must be specified as a vector of strings.")) end if !(parsed_toml["c"] isa Int) throw(ArgumentError("the center of a stencil must be specified as an integer.")) end end """ parse_scalar(parsed_toml) Parse a scalar, represented as a string or a number in the TOML, and return it as a `Rational` See also [`read_stencil_set`](@ref), [`parse_stencil`](@ref) [`parse_tuple`](@ref). """ function parse_scalar(parsed_toml) try return parse_rational(parsed_toml) catch e throw(ArgumentError("must be a number or a string representing a number.")) end end """ parse_tuple(parsed_toml) Parse `parsed_toml` as a tuple of scalars. See also [`read_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref). """ function parse_tuple(parsed_toml) if !(parsed_toml isa Array) throw(ArgumentError("argument must be an array")) end return Tuple(parse_scalar.(parsed_toml)) end """ parse_rational(parsed_toml) Parse a string or a number as a rational. """ function parse_rational(parsed_toml) if parsed_toml isa String expr = Meta.parse(replace(parsed_toml, "/"=>"//")) return eval(:(Rational($expr))) else return Rational(parsed_toml) end end """ sbp_operators_path() Calculate the path for the operators folder with included stencil sets. See also [`read_stencil_set`](@ref) """ sbp_operators_path() = (@__DIR__) * "/operators/"