annotate src/SbpOperators/readoperator.jl @ 877:dd2ab001a7b6 feature/equidistant_grid/refine

Implement refine function, move exports to the top of the file, change location of constuctors. The constructors were changed have only one inner constructor and simpler outer constructors.
author Jonatan Werpers <jonatan@werpers.com>
date Mon, 14 Feb 2022 09:39:58 +0100
parents 568058183791
children 06c510d40ebb 7bf3121c6864
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
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
3 export read_stencil_set
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
249
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
12
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
13 """
860
568058183791 Rename argument for `read_stencil_set`: `fn` -> `filename`
Jonatan Werpers <jonatan@werpers.com>
parents: 856
diff changeset
14 read_stencil_set(filename; filters)
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
15
860
568058183791 Rename argument for `read_stencil_set`: `fn` -> `filename`
Jonatan Werpers <jonatan@werpers.com>
parents: 856
diff changeset
16 Picks out a stencil set 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
17 filters. If more than one set matches the filters an error is raised. The
855
439a5e6c7175 Align docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 853
diff changeset
18 returned stencil set contains parsed TOML intended for functions like
853
fe8fe3f01162 Docs touch up
Jonatan Werpers <jonatan@werpers.com>
parents: 852
diff changeset
19 `parse_scalar` and `parse_stencil`.
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
20
855
439a5e6c7175 Align docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 853
diff changeset
21 The stencil set 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
22 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
23
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
24 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
25 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
26 section, the exact parsing is left to the user.
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
27
852
510f744d0876 Add some documentation for the file format
Jonatan Werpers <jonatan@werpers.com>
parents: 836
diff changeset
28 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
29
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
30 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
31 """
860
568058183791 Rename argument for `read_stencil_set`: `fn` -> `filename`
Jonatan Werpers <jonatan@werpers.com>
parents: 856
diff changeset
32 read_stencil_set(filename; filters...) = get_stencil_set(TOML.parsefile(filename); filters...)
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
33
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
34 """
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
35 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
36
855
439a5e6c7175 Align docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 853
diff changeset
37 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
38 filters.
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
39
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
40 See also [`read_stencil_set`](@ref).
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
41 """
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
42 function get_stencil_set(parsed_toml; filters...)
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
43 matches = findall(parsed_toml["stencil_set"]) do set
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
44 for (key, val) ∈ filters
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
45 if set[string(key)] != val
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
46 return false
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
47 end
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
48 end
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
49
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
50 return true
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
51 end
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
52
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
53 if length(matches) != 1
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
54 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
55 end
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
56
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
57 i = matches[1]
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
58 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
59 end
597
98cd99237176 Add a function for reading a stencil directly from the a file
Jonatan Werpers <jonatan@werpers.com>
parents: 596
diff changeset
60
768
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
61 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
62 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
63
855
439a5e6c7175 Align docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 853
diff changeset
64 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
65
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
66 See also [`read_stencil_set`](@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
67 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
68 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
69 check_stencil_toml(parsed_toml)
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
70
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
71 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
72 weights = parse_rational.(parsed_toml)
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
73 return CenteredStencil(weights...)
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
74 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
75
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
76 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
77 return Stencil(weights..., center = parsed_toml["c"])
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
78 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
79
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
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 parse_stencil(T, parsed_toml)
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
82
853
fe8fe3f01162 Docs touch up
Jonatan Werpers <jonatan@werpers.com>
parents: 852
diff changeset
83 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
84 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
85 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
86
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
87 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
88 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
89 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
90 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
91
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
92 if parsed_toml isa Vector{String}
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
93 return
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
94 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
95
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
96 if !(haskey(parsed_toml, "s") && haskey(parsed_toml, "c"))
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
97 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
98 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
99
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
100 if !(parsed_toml["s"] isa Vector{String})
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
101 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
102 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
103
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
104 if !(parsed_toml["c"] isa Int)
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
105 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
106 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
107 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
108
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
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 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
111
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
112 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
113
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
114 See also [`read_stencil_set`](@ref), [`parse_stencil`](@ref) [`parse_tuple`](@ref).
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
115 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
116 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
117 try
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
118 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
119 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
120 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
121 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
122 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
123
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
124 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
125 parse_tuple(parsed_toml)
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
126
853
fe8fe3f01162 Docs touch up
Jonatan Werpers <jonatan@werpers.com>
parents: 852
diff changeset
127 Parse an array as a tuple of scalars.
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
128
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
129 See also [`read_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref).
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
130 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
131 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
132 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
133 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
134 end
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
135 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
136 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
137
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
138
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
139 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
140 parse_rational(parsed_toml)
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
141
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
142 Parse a string or a number as a rational.
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
143 """
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
144 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
145 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
146 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
147 return eval(:(Rational($expr)))
21ab60cc0a5c Let parse_rational handle numbers and not just strings
Jonatan Werpers <jonatan@werpers.com>
parents: 828
diff changeset
148 else
836
91a63b04b1c9 Attempt to make variable names for parse functions more descriptive
Jonatan Werpers <jonatan@werpers.com>
parents: 835
diff changeset
149 return Rational(parsed_toml)
830
21ab60cc0a5c Let parse_rational handle numbers and not just strings
Jonatan Werpers <jonatan@werpers.com>
parents: 828
diff changeset
150 end
249
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
151 end
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
152
835
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
153 """
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
154 sbp_operators_path()
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
155
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
156 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
157
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
158 See also [`read_stencil_set`](@ref)
fc2ac236dd73 Add a bunch of documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 831
diff changeset
159 """
340
29df39a7b568 readoperator.jl: Fix path to operators
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
160 sbp_operators_path() = (@__DIR__) * "/operators/"