Mercurial > repos > public > sbplib_julia
diff src/SbpOperators/readoperator.jl @ 1018:5ec49dd2c7c4 feature/stencil_set_type
Reintroduce read_stencil_set
author | Vidar Stiernström <vidar.stiernstrom@it.uu.se> |
---|---|
date | Tue, 22 Mar 2022 09:57:28 +0100 |
parents | 37fd8c1cadb2 |
children |
line wrap: on
line diff
--- a/src/SbpOperators/readoperator.jl Fri Mar 18 13:29:35 2022 +0100 +++ b/src/SbpOperators/readoperator.jl Tue Mar 22 09:57:28 2022 +0100 @@ -1,13 +1,5 @@ using TOML -export StencilSet -export get_stencil_set - -export parse_stencil -export parse_scalar -export parse_tuple - -export sbp_operators_path """ StencilSet @@ -22,7 +14,7 @@ """ - StencilSet(filename; filters) +read_stencil_set(filename; filters) Creates a `StencilSet` from a TOML file based on some key-value filters. If more than one set matches the filters an error is raised. The @@ -38,9 +30,9 @@ 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),. +See also [`StencilSet`](@ref), [`sbp_operators_path`](@ref), [`get_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref). """ -StencilSet(filename; filters...) = StencilSet(get_stencil_set(TOML.parsefile(filename); filters...)) +read_stencil_set(filename; filters...) = StencilSet(get_stencil_set(TOML.parsefile(filename); filters...)) """ @@ -49,7 +41,7 @@ Picks out a stencil set from an already parsed TOML based on some key-value filters. -See also [`StencilSet`](@ref). +See also [`read_stencil_set`](@ref). """ function get_stencil_set(parsed_toml; filters...) matches = findall(parsed_toml["stencil_set"]) do set @@ -75,7 +67,7 @@ Accepts parsed TOML and reads it as a stencil. -See also [`StencilSet`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref). +See also [`read_stencil_set`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref). """ function parse_stencil(parsed_toml) check_stencil_toml(parsed_toml) @@ -123,7 +115,7 @@ Parse a scalar, represented as a string or a number in the TOML, and return it as a `Rational` -See also [`StencilSet`](@ref), [`parse_stencil`](@ref) [`parse_tuple`](@ref). +See also [`read_stencil_set`](@ref), [`parse_stencil`](@ref) [`parse_tuple`](@ref). """ function parse_scalar(parsed_toml) try @@ -138,7 +130,7 @@ Parse an array as a tuple of scalars. -See also [`StencilSet`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref). +See also [`read_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref). """ function parse_tuple(parsed_toml) if !(parsed_toml isa Array) @@ -167,6 +159,6 @@ Calculate the path for the operators folder with included stencil sets. -See also [`StencilSet`](@ref) +See also [`StencilSet`](@ref), [`read_stencil_set`](@ref). """ sbp_operators_path() = (@__DIR__) * "/operators/"