annotate src/SbpOperators/readoperator.jl @ 989:7bf3121c6864 feature/stencil_set_type

Add type StencilSet
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Thu, 17 Mar 2022 21:31:20 +0100
parents 568058183791
children b6238afd3bb0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
594
cc86b920531a Change the readoperator function to use the .toml format
Jonatan Werpers <jonatan@werpers.com>
parents: 340
diff changeset
1 using TOML
601
b05f542b2e8f Export relevant functions and move export of read_D2_operator to readoperator.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 600
diff changeset
2
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
3 export StencilSet
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
4 export get_stencil_set
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
5
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
6 export parse_stencil
831
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
7 export parse_scalar
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
8 export parse_tuple
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
9
804
98e0e0f3c5a8 Move exports to top of file in readoperator.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 803
diff changeset
10 export sbp_operators_path
98e0e0f3c5a8 Move exports to top of file in readoperator.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 803
diff changeset
11
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
12 """
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
13 StencilSet
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
14
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
15 A `StencilSet` contains a set of associated stencils. The stencils
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
16 are are stored in a table, and can be accesed by indexing into the `StencilSet`.
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
17 """
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
18 struct StencilSet
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
19 table
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
20 end
249
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
21
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
22 """
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
23 StencilSet(filename; filters)
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
24
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
25 Creates a `StencilSet` from a TOML file based on some key-value
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
26 filters. If more than one set matches the filters an error is raised. The
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
27 table of the `StencilSet` is a parsed TOML intended for functions like
853
fe8fe3f01162 Docs touch up
Jonatan Werpers <jonatan@werpers.com>
parents: 852
diff changeset
28 `parse_scalar` and `parse_stencil`.
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
29
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
30 The `StencilSet` table is not parsed beyond the inital TOML parse. To get usable
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
31 stencils use the `parse_stencil` functions on the fields of the stencil set.
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
32
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
33 The reason for this is that since stencil sets are intended to be very
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
34 general, and currently do not include any way to specify how to parse a given
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
35 section, the exact parsing is left to the user.
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
36
852
510f744d0876 Add some documentation for the file format
Jonatan Werpers <jonatan@werpers.com>
parents: 836
diff changeset
37 For more information see [Operator file format](@ref) in the documentation.
510f744d0876 Add some documentation for the file format
Jonatan Werpers <jonatan@werpers.com>
parents: 836
diff changeset
38
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
39 See also [`sbp_operators_path`](@ref), [`get_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref),.
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
40 """
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
41 StencilSet(filename; filters...) = StencilSet(get_stencil_set(TOML.parsefile(filename); filters...))
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
42 Base.getindex(set::StencilSet,I...) = set.table[I...]
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
43
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
44 """
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
45 get_stencil_set(parsed_toml; filters...)
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
46
855
439a5e6c7175 Align docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 853
diff changeset
47 Picks out a stencil set from an already parsed TOML based on some key-value
439a5e6c7175 Align docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 853
diff changeset
48 filters.
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
49
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
50 See also [`StencilSet`](@ref).
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
51 """
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
52 function get_stencil_set(parsed_toml; filters...)
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
53 matches = findall(parsed_toml["stencil_set"]) do set
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
54 for (key, val) ∈ filters
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
55 if set[string(key)] != val
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
56 return false
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
57 end
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
58 end
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
59
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
60 return true
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
61 end
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
62
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
63 if length(matches) != 1
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
64 throw(ArgumentError("filters must pick out a single stencil set"))
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
65 end
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
66
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
67 i = matches[1]
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
68 return parsed_toml["stencil_set"][i]
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
69 end
597
98cd99237176 Add a function for reading a stencil directly from the a file
Jonatan Werpers <jonatan@werpers.com>
parents: 596
diff changeset
70
768
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
71 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
72 parse_stencil(parsed_toml)
768
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
73
855
439a5e6c7175 Align docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 853
diff changeset
74 Accepts parsed TOML and reads it as a stencil.
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
75
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
76 See also [`StencilSet`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref).
768
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
77 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
78 function parse_stencil(parsed_toml)
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
79 check_stencil_toml(parsed_toml)
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
80
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
81 if parsed_toml isa Array
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
82 weights = parse_rational.(parsed_toml)
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
83 return CenteredStencil(weights...)
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
84 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
85
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
86 weights = parse_rational.(parsed_toml["s"])
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
87 return Stencil(weights..., center = parsed_toml["c"])
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
88 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
89
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
90 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
91 parse_stencil(T, parsed_toml)
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
92
853
fe8fe3f01162 Docs touch up
Jonatan Werpers <jonatan@werpers.com>
parents: 852
diff changeset
93 Parses the input as a stencil with element type `T`.
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
94 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
95 parse_stencil(T, parsed_toml) = Stencil{T}(parse_stencil(parsed_toml))
828
ca182cbb8f49 Add a method to parse_stencil which allows controlling the element type
Jonatan Werpers <jonatan@werpers.com>
parents: 809
diff changeset
96
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
97 function check_stencil_toml(parsed_toml)
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
98 if !(parsed_toml isa Dict || parsed_toml isa Vector{String})
791
7669c1e3a9a4 Fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 782
diff changeset
99 throw(ArgumentError("the TOML for a stencil must be a vector of strings or a table."))
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
100 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
101
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
102 if parsed_toml isa Vector{String}
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
103 return
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
104 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
105
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
106 if !(haskey(parsed_toml, "s") && haskey(parsed_toml, "c"))
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
107 throw(ArgumentError("the table form of a stencil must have fields `s` and `c`."))
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
108 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
109
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
110 if !(parsed_toml["s"] isa Vector{String})
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
111 throw(ArgumentError("a stencil must be specified as a vector of strings."))
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
112 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
113
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
114 if !(parsed_toml["c"] isa Int)
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
115 throw(ArgumentError("the center of a stencil must be specified as an integer."))
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
116 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
117 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
118
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
119 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
120 parse_scalar(parsed_toml)
831
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
121
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
122 Parse a scalar, represented as a string or a number in the TOML, and return it as a `Rational`
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
123
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
124 See also [`StencilSet`](@ref), [`parse_stencil`](@ref) [`parse_tuple`](@ref).
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
125 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
126 function parse_scalar(parsed_toml)
831
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
127 try
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
128 return parse_rational(parsed_toml)
831
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
129 catch e
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
130 throw(ArgumentError("must be a number or a string representing a number."))
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
131 end
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
132 end
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
133
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
134 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
135 parse_tuple(parsed_toml)
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
136
853
fe8fe3f01162 Docs touch up
Jonatan Werpers <jonatan@werpers.com>
parents: 852
diff changeset
137 Parse an array as a tuple of scalars.
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
138
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
139 See also [`StencilSet`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref).
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
140 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
141 function parse_tuple(parsed_toml)
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
142 if !(parsed_toml isa Array)
831
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
143 throw(ArgumentError("argument must be an array"))
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
144 end
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
145 return Tuple(parse_scalar.(parsed_toml))
831
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
146 end
760c11e81fd4 Introduce parse_tuple and parse_scalar and replace all external calls to parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 830
diff changeset
147
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
148
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
149 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
150 parse_rational(parsed_toml)
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
151
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
152 Parse a string or a number as a rational.
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
153 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
154 function parse_rational(parsed_toml)
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
155 if parsed_toml isa String
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
156 expr = Meta.parse(replace(parsed_toml, "/"=>"//"))
830
21ab60cc0a5c Let parse_rational handle numbers and not just strings
Jonatan Werpers <jonatan@werpers.com>
parents: 828
diff changeset
157 return eval(:(Rational($expr)))
21ab60cc0a5c Let parse_rational handle numbers and not just strings
Jonatan Werpers <jonatan@werpers.com>
parents: 828
diff changeset
158 else
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
159 return Rational(parsed_toml)
830
21ab60cc0a5c Let parse_rational handle numbers and not just strings
Jonatan Werpers <jonatan@werpers.com>
parents: 828
diff changeset
160 end
249
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
161 end
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
162
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
163 """
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
164 sbp_operators_path()
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
165
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
166 Calculate the path for the operators folder with included stencil sets.
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
167
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 860
diff changeset
168 See also [`StencilSet`](@ref)
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
169 """
340
29df39a7b568 readoperator.jl: Fix path to operators
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
170 sbp_operators_path() = (@__DIR__) * "/operators/"