1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
include "spud_base.rnc"
include "adaptivity_options.rnc"
include "diagnostic_algorithms.rnc"
include "input_output.rnc"
include "solvers.rnc"
include "stabilisation.rnc"
include "reduced_model.rnc"
include "mesh_options.rnc"
include "physical_parameters.rnc"
include "prognostic_field_options.rnc"
include "prescribed_field_options.rnc"
include "spatial_discretisation.rnc"
include "temporal_discretisation.rnc"
start =
(
## The root node of the options dictionary.
element test_coupler {
comment,
## Model output files are named according to the simulation
## name, e.g. [simulation_name]_0.vtu. Non-standard
## characters in the simulation name should be avoided.
element simulation_name {
anystring
},
geometry,
io,
material_phase,
coupling_options?
}
)
coupling_options =
(
## These options activate coupling of Fluidity with OASIS.
## NB: Currently only works in 2D
element coupling {
## Number of elements in longitude and latitude dimension respectively
element element_count { integer_dim_vector },
## The minimum and maximum longitude of the coupled domain
element longitude_extent { real_dim_vector },
## The minimum and maximum latitude of the coupled domain
element latitude_extent { real_dim_vector}
}?
)
geometry =
(
## Options dealing with the specification of geometry
element geometry {
## Dimension of the problem.
## <b>This can only be set once</b>
element dimension {
element integer_value {
attribute rank {"0"},
("3"|"2")
}
},
## The position mesh
element mesh {
attribute name { "CoordinateMesh" },
mesh_info_fromfile
},
## The tracer mesh
element mesh {
attribute name { "TracerMesh" },
mesh_info_frommesh
},
## Quadrature
element quadrature {
## Quadrature degree
##
## note: this specifies the degree of quadrature,
## not the number of gauss points
element degree {
integer
},
## Surface quadrature degree
##
## note: this specifies the degree of surface
## quadrature not the number of surface gauss points
element surface_degree {
integer
}?
}
}
)
mesh_choice_coordinate =
(
element mesh {
attribute name { "CoordinateMesh" }
}
)
mesh_choice =
(
(
element mesh {
attribute name { "TracerMesh" }
}|
element mesh {
attribute name { "CoordinateMesh" }
}
)
)
mesh_info_fromfile =
(
## Read mesh from file.
element from_file {
(
## Triangle mesh format.
##
## Enter the base name without the .edge .ele, .face or
## .node extensions, and without process numbers.
element format {
attribute name { "triangle" },
comment
}|
## Read the mesh from a vtu. Note that the mesh will have no
## surface or region IDs.
element format {
attribute name { "vtu" },
comment
}|
## GMSH mesh format
element format {
attribute name { "gmsh" },
comment
}
),
attribute file_name { xsd:string },
from_file_mesh_stat_options,
comment
}
)
mesh_info_frommesh =
(
## Make mesh from existing mesh.
element from_mesh {
mesh_choice_coordinate,
element mesh_shape {
element polynomial_degree {
integer
}?,
element element_type {
element string_value{
"lagrangian"
}
}?
}?,
derived_mesh_stat_options,
comment
}
)
material_phase =
(
## The material phase options
element material_phase {
attribute name { "Fluid" },
element scalar_field {
attribute rank { "0" },
attribute name { "Tracer" },
element prognostic {
element mesh {
attribute name { "TracerMesh" }
},
initial_condition_scalar,
element stat { comment },
element scalar_field {
attribute name { "Source" },
attribute rank { "0" },
element prescribed {
prescribed_scalar_field_no_adapt,
recalculation_options?
}
}?,
# If enabled, save the right hand side of the discrete equations.
element scalar_field {
attribute name { "Rhs" },
attribute rank { "0" },
element diagnostic {
empty
}
}?
}
},
## Prescribed or diagnostic scalar fields.
element scalar_field {
attribute rank { "0" },
attribute name { string },
(
element prescribed {
mesh_choice,
prescribed_scalar_field_no_adapt,
recalculation_options?
}|
element diagnostic {
mesh_choice,
diagnostic_scalar_field
}
)
}*
}
)
boundary_conditions =
(
## Boundary conditions
element boundary_conditions {
attribute name { string },
## Surface id
element surface_ids {
integer_vector
},
element type {
attribute name { "dirichlet" },
input_choice_real
}
}
)
prescribed_output_options = empty
prescribed_detector_options = empty
prescribed_scalar_stat_options = empty
discrete_properties_algorithm_scalar = empty
recalculation_options =
(
## Prevent this field from being recalculated at every timestep.
## This is cheaper especially if you are enforcing discrete properties on the field.
element do_not_recalculate {
empty
}
)
diagnostic_scalar_field =
(
scalar_python_diagnostic_algorithm,
element stat { comment },
recalculation_options?
)
io =
## Options to do with I/O
element io {
## Dump format
element dump_format { "vtk" },
## Dump period, in timesteps. Defaults to 1
element dump_period_in_timesteps {
element constant { integer }
}?,
(
## The mesh on to which all the fields will be
## interpolated for VTK output.
element output_mesh {
attribute name { "VelocityMesh" }
}|
## The mesh on to which all the fields will be
## interpolated for VTK output.
element output_mesh {
attribute name { xsd:string }
}
)
}
|