Mercurial > repos > public > sbplib_julia

annotate src/SbpOperators/readoperator.jl @ 828:ca182cbb8f49 operator_storage_array_of_table

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a method to parse_stencil which allows controlling the element type
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 12 Jan 2022 08:39:48 +0100
parents 219c9661e700
children 21ab60cc0a5c
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
782
f6e56d5dbc17 Export parse_rational
Jonatan Werpers <jonatan@werpers.com>
parents: 771
diff changeset
7 export parse_rational
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
8
804
98e0e0f3c5a8 Move exports to top of file in readoperator.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 803
diff changeset
9 export sbp_operators_path
98e0e0f3c5a8 Move exports to top of file in readoperator.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 803
diff changeset
10
768
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
11 # The read_stencil_set and get_stencil_set functions return the freshly parsed
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
12 # toml. The generic code in these functions can't be expected to know anyhting
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
13 # about how to read different stencil sets as they may contain many different
791
7669c1e3a9a4 Fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 782
diff changeset
14 # kinds of stencils. We should how ever add read_ and get_ functions for all
768
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
15 # the types of stencils we know about.
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
16 #
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
17 # After getting a stencil set the user can use parse functions to parse what
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
18 # they want from the TOML dict. I.e no more "paths".
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
19 # Functions needed:
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
20 # * parse stencil
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
21 # * parse rational
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
22 #
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
23 # maybe there is a better name than parse?
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
24 # Would be nice to be able to control the type in the stencil
249
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
25
768
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
26 # TODO: Control type for the stencil
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
27 # TODO: Think about naming and terminology around freshly parsed TOML.
792
26bf5b2b3e32 Comment on naming and add suggestion for restructure of check_stencil_toml
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 791
diff changeset
28 # Vidar: What about get_stencil instead of parse_stencil for an already parsed
26bf5b2b3e32 Comment on naming and add suggestion for restructure of check_stencil_toml
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 791
diff changeset
29 # toml. It matches get_stencil_set.
249
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
30
805
3881386f25e6 Add some todos
Jonatan Werpers <jonatan@werpers.com>
parents: 804
diff changeset
31 # TODO: Docs for readoperator.jl
3881386f25e6 Add some todos
Jonatan Werpers <jonatan@werpers.com>
parents: 804
diff changeset
32 # Parsing as rationals is intentional, allows preserving exactness, which can be lowered using converts or promotions later.
3881386f25e6 Add some todos
Jonatan Werpers <jonatan@werpers.com>
parents: 804
diff changeset
33 # TODO: readoperator.jl file name?
3881386f25e6 Add some todos
Jonatan Werpers <jonatan@werpers.com>
parents: 804
diff changeset
34 # TODO: Remove references to toml for dict-input arguments
3881386f25e6 Add some todos
Jonatan Werpers <jonatan@werpers.com>
parents: 804
diff changeset
35
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
36 """
767
210d3f58bd56 Make signature of read_stencil_set conform to signature of get_stencil_set
Jonatan Werpers <jonatan@werpers.com>
parents: 766
diff changeset
37 read_stencil_set(fn; filters)
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
38
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
39 Picks out a stencil set from the given toml file based on some filters.
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
40 If more than one set matches the filters an error is raised.
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
41
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
42 The stencil set is not parsed beyond the inital toml parse. To get usable
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
43 stencils use the `parse_stencil` functions on the fields of the stencil set.
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
44 """
771
d0c1d0b4da52 Fix type in call to get_stencil_set
Jonatan Werpers <jonatan@werpers.com>
parents: 768
diff changeset
45 read_stencil_set(fn; filters...) = get_stencil_set(TOML.parsefile(fn); filters...)
655
ec7490fb4404 Start sketching the toml format and needed functions
Jonatan Werpers <jonatan@werpers.com>
parents: 637
diff changeset
46
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
47 """
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
48 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
49
764
d34b515b0ae7 Add functions for reading stencil sets
Jonatan Werpers <jonatan@werpers.com>
parents: 655
diff changeset
50 Same as `read_stencil_set` but works on already parsed TOML.
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 """
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
72 parse_stencil(toml)
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
73
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
74 Accepts parsed toml and reads it as a stencil
7c87a33963c5 Add some notes, delete functions that won't be needed
Jonatan Werpers <jonatan@werpers.com>
parents: 767
diff changeset
75 """
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
76 function parse_stencil(toml)
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
77 check_stencil_toml(toml)
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
78
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
79 if toml isa Array
809
219c9661e700 Always parse as rationals
Jonatan Werpers <jonatan@werpers.com>
parents: 805
diff changeset
80 weights = parse_rational.(toml)
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
81 return CenteredStencil(weights...)
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
82 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
83
809
219c9661e700 Always parse as rationals
Jonatan Werpers <jonatan@werpers.com>
parents: 805
diff changeset
84 weights = parse_rational.(toml["s"])
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
85 return Stencil(weights..., center = toml["c"])
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
86 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
87
828
ca182cbb8f49 Add a method to parse_stencil which allows controlling the element type
Jonatan Werpers <jonatan@werpers.com>
parents: 809
diff changeset
88 parse_stencil(T, toml) = Stencil{T}(parse_stencil(toml))
ca182cbb8f49 Add a method to parse_stencil which allows controlling the element type
Jonatan Werpers <jonatan@werpers.com>
parents: 809
diff changeset
89
766
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
90 function check_stencil_toml(toml)
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
91 if !(toml isa Dict || toml isa Vector{String})
791
7669c1e3a9a4 Fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 782
diff changeset
92 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
93 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
94
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
95 if toml isa Vector{String}
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
96 return
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
97 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
98
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
99 if !(haskey(toml, "s") && haskey(toml, "c"))
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
100 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
101 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
102
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
103 if !(toml["s"] isa Vector{String})
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
104 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
105 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
106
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
107 if !(toml["c"] isa Int)
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
108 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
109 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
110 end
7624a1350ece Add parse_stencil
Jonatan Werpers <jonatan@werpers.com>
parents: 765
diff changeset
111
594
cc86b920531a Change the readoperator function to use the .toml format
Jonatan Werpers <jonatan@werpers.com>
parents: 340
diff changeset
112 function parse_rational(str)
cc86b920531a Change the readoperator function to use the .toml format
Jonatan Werpers <jonatan@werpers.com>
parents: 340
diff changeset
113 expr = Meta.parse(replace(str, "/"=>"//"))
603
fbff4009c08a Add tests for parse_rational()
Jonatan Werpers <jonatan@werpers.com>
parents: 602
diff changeset
114 return eval(:(Rational($expr)))
249
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
115 end
7cb4492ccd60 Refactor package SbpOperators
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
116
340
29df39a7b568 readoperator.jl: Fix path to operators
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
117 sbp_operators_path() = (@__DIR__) * "/operators/"