Branch data Line data Source code
1 : : // *****************************************************************************
2 : : /*!
3 : : \file src/Control/Inciter/InputDeck/InputDeck.hpp
4 : : \copyright 2012-2015 J. Bakosi,
5 : : 2016-2018 Los Alamos National Security, LLC.,
6 : : 2019-2021 Triad National Security, LLC.
7 : : All rights reserved. See the LICENSE file for details.
8 : : \brief Inciter's new input deck definition
9 : : \details This file defines the heterogeneous struct that is used for storing
10 : : the data from user input during the control file parsing of the
11 : : computational shock hydrodynamics tool, Inciter.
12 : : */
13 : : // *****************************************************************************
14 : : #ifndef InputDeck_h
15 : : #define InputDeck_h
16 : :
17 : : #include <getopt.h>
18 : : #include "Types.hpp"
19 : : #include "TaggedTuple.hpp"
20 : : #include "Inciter/CmdLine/CmdLine.hpp"
21 : : #include "Transfer.hpp"
22 : : #include "Inciter/OutVar.hpp"
23 : : #include "Inciter/Options/PDE.hpp"
24 : : #include "Inciter/Options/Problem.hpp"
25 : : #include "Inciter/Options/Scheme.hpp"
26 : : #include "Inciter/Options/Limiter.hpp"
27 : : #include "Inciter/Options/Flux.hpp"
28 : : #include "Inciter/Options/Initiate.hpp"
29 : : #include "Inciter/Options/AMRInitial.hpp"
30 : : #include "Inciter/Options/AMRError.hpp"
31 : : #include "Inciter/Options/PrefIndicator.hpp"
32 : : #include "Inciter/Options/MeshVelocity.hpp"
33 : : #include "Inciter/Options/MeshVelocitySmoother.hpp"
34 : : #include "Inciter/Options/Material.hpp"
35 : : #include "Options/PartitioningAlgorithm.hpp"
36 : : #include "Options/TxtFloatFormat.hpp"
37 : : #include "Options/FieldFile.hpp"
38 : : #include "Options/Error.hpp"
39 : : #include "Options/UserTable.hpp"
40 : :
41 : : namespace inciter {
42 : :
43 : : namespace ctr {
44 : :
45 : : using ncomp_t = std::size_t;
46 : :
47 : : using bclist = tk::TaggedTuple< brigand::list<
48 : : tag::dirichlet, std::vector< std::size_t >,
49 : : tag::symmetry, std::vector< std::size_t >,
50 : : tag::inlet, std::vector< std::size_t >,
51 : : tag::outlet, std::vector< std::size_t >,
52 : : tag::farfield, std::vector< std::size_t >,
53 : : tag::extrapolate, std::vector< std::size_t >,
54 : : tag::noslipwall, std::vector< std::size_t >
55 : : > >;
56 : :
57 : : // Transport
58 : : using transportList = tk::TaggedTuple< brigand::list<
59 : : tag::physics, PhysicsType,
60 : : tag::ncomp, std::size_t,
61 : : tag::intsharp, int,
62 : : tag::intsharp_param, tk::real,
63 : : tag::problem, ProblemType,
64 : : tag::diffusivity, std::vector< tk::real >,
65 : : tag::lambda, std::vector< tk::real >,
66 : : tag::u0, std::vector< tk::real >
67 : : > >;
68 : :
69 : : // CompFlow
70 : : using compflowList = tk::TaggedTuple< brigand::list<
71 : : tag::physics, PhysicsType,
72 : : tag::problem, ProblemType,
73 : : tag::alpha, tk::real,
74 : : tag::beta, tk::real,
75 : : tag::betax, tk::real,
76 : : tag::betay, tk::real,
77 : : tag::betaz, tk::real,
78 : : tag::r0, tk::real,
79 : : tag::p0, tk::real,
80 : : tag::ce, tk::real,
81 : : tag::kappa, tk::real
82 : : > >;
83 : :
84 : : // MultiMat
85 : : using multimatList = tk::TaggedTuple< brigand::list<
86 : : tag::physics, PhysicsType,
87 : : tag::nmat, std::size_t,
88 : : tag::prelax, uint64_t,
89 : : tag::prelax_timescale, tk::real,
90 : : tag::intsharp, int,
91 : : tag::intsharp_param, tk::real,
92 : : tag::rho0constraint, uint64_t,
93 : : tag::dt_sos_massavg, int,
94 : : tag::problem, ProblemType,
95 : : tag::viscous, bool
96 : : > >;
97 : :
98 : : // MultiSpecies
99 : : using multispeciesList = tk::TaggedTuple< brigand::list<
100 : : tag::physics, PhysicsType,
101 : : tag::nspec, std::size_t,
102 : : tag::problem, ProblemType,
103 : : tag::viscous, bool
104 : : > >;
105 : :
106 : : // Material/EOS object
107 : : using materialList = tk::TaggedTuple< brigand::list<
108 : : tag::eos, MaterialType,
109 : : tag::id, std::vector< uint64_t >,
110 : : tag::gamma, std::vector< tk::real >,
111 : : tag::pstiff, std::vector< tk::real >,
112 : : tag::w_gru, std::vector< tk::real >,
113 : : tag::A_jwl, std::vector< tk::real >,
114 : : tag::B_jwl, std::vector< tk::real >,
115 : : tag::C_jwl, std::vector< tk::real >,
116 : : tag::R1_jwl, std::vector< tk::real >,
117 : : tag::R2_jwl, std::vector< tk::real >,
118 : : tag::rho0_jwl, std::vector< tk::real >,
119 : : tag::de_jwl, std::vector< tk::real >,
120 : : tag::rhor_jwl, std::vector< tk::real >,
121 : : tag::Tr_jwl, std::vector< tk::real >,
122 : : tag::Pr_jwl, std::vector< tk::real >,
123 : : tag::mu, std::vector< tk::real >,
124 : : tag::yield_stress, std::vector< tk::real >,
125 : : tag::cv, std::vector< tk::real >,
126 : : tag::k, std::vector< tk::real >
127 : : > >;
128 : :
129 : : // Species/EOS object
130 : : using speciesList = tk::TaggedTuple< brigand::list<
131 : : tag::id, std::vector< uint64_t >,
132 : : tag::gamma, std::vector< tk::real >,
133 : : tag::R, std::vector< tk::real >,
134 : : tag::cp_coeff, std::vector< std::vector< tk::real > >
135 : : > >;
136 : :
137 : : // Boundary conditions block
138 : : using bcList = tk::TaggedTuple< brigand::list<
139 : : tag::mesh, std::vector< std::size_t >,
140 : : tag::dirichlet, std::vector< std::size_t >,
141 : : tag::symmetry, std::vector< std::size_t >,
142 : : tag::inlet, std::vector< std::size_t >,
143 : : tag::outlet, std::vector< std::size_t >,
144 : : tag::farfield, std::vector< std::size_t >,
145 : : tag::extrapolate, std::vector< std::size_t >,
146 : : tag::noslipwall, std::vector< std::size_t >,
147 : : tag::stag_point, std::vector< tk::real >,
148 : : tag::radius, tk::real,
149 : : tag::velocity, std::vector< tk::real >,
150 : : tag::pressure, tk::real,
151 : : tag::density, tk::real,
152 : : tag::temperature, tk::real,
153 : : tag::mass_fractions, std::vector< tk::real >,
154 : : tag::materialid, std::size_t,
155 : : tag::timedep, std::vector<
156 : : tk::TaggedTuple< brigand::list<
157 : : tag::sideset, std::vector< uint64_t >,
158 : : tag::fn, std::vector< tk::real >
159 : : > >
160 : : >
161 : : > >;
162 : :
163 : : // IC box
164 : : using boxList = tk::TaggedTuple< brigand::list<
165 : : tag::materialid, std::size_t,
166 : : tag::volume, tk::real,
167 : : tag::mass, tk::real,
168 : : tag::density, tk::real,
169 : : tag::velocity, std::vector< tk::real >,
170 : : tag::pressure, tk::real,
171 : : tag::energy, tk::real,
172 : : tag::energy_content, tk::real,
173 : : tag::temperature, tk::real,
174 : : tag::mass_fractions, std::vector< tk::real >,
175 : : tag::xmin, tk::real,
176 : : tag::xmax, tk::real,
177 : : tag::ymin, tk::real,
178 : : tag::ymax, tk::real,
179 : : tag::zmin, tk::real,
180 : : tag::zmax, tk::real,
181 : : tag::orientation, std::vector< tk::real >,
182 : : tag::initiate, inciter::ctr::InitiateType,
183 : : tag::point, std::vector< tk::real >,
184 : : tag::init_time, tk::real,
185 : : tag::front_width, tk::real,
186 : : tag::front_speed, tk::real
187 : : > >;
188 : :
189 : : // IC meshblock
190 : : using meshblockList = tk::TaggedTuple< brigand::list<
191 : : tag::blockid, std::uint64_t,
192 : : tag::materialid, std::size_t,
193 : : tag::volume, tk::real,
194 : : tag::mass, tk::real,
195 : : tag::density, tk::real,
196 : : tag::velocity, std::vector< tk::real >,
197 : : tag::pressure, tk::real,
198 : : tag::energy, tk::real,
199 : : tag::energy_content, tk::real,
200 : : tag::temperature, tk::real,
201 : : tag::mass_fractions, std::vector< tk::real >,
202 : : tag::initiate, inciter::ctr::InitiateType,
203 : : tag::point, std::vector< tk::real >,
204 : : tag::init_time, tk::real,
205 : : tag::front_width, tk::real,
206 : : tag::front_speed, tk::real
207 : : > >;
208 : :
209 : : // Initial conditions (ic) block
210 : : using icList = tk::TaggedTuple< brigand::list<
211 : : tag::materialid, std::size_t,
212 : : tag::pressure, tk::real,
213 : : tag::temperature, tk::real,
214 : : tag::mass_fractions, std::vector< tk::real >,
215 : : tag::density, tk::real,
216 : : tag::energy, tk::real,
217 : : tag::velocity, std::vector< tk::real >,
218 : : tag::box, std::vector< boxList >,
219 : : tag::meshblock, std::vector< meshblockList >
220 : : > >;
221 : :
222 : : // Overset mesh block
223 : : using meshList = tk::TaggedTuple< brigand::list<
224 : : tag::filename, std::string,
225 : : tag::location, std::vector< tk::real >,
226 : : tag::orientation, std::vector< tk::real >,
227 : : tag::velocity, std::vector< tk::real >
228 : : > >;
229 : :
230 : : // Field output block
231 : : using fieldOutputList = tk::TaggedTuple< brigand::list<
232 : : tag::interval, uint32_t,
233 : : tag::time_interval, tk::real,
234 : : tag::time_range, std::vector< tk::real >,
235 : : tag::refined, bool,
236 : : tag::filetype, tk::ctr::FieldFileType,
237 : : tag::sideset, std::vector< uint64_t >,
238 : : tag::outvar, std::vector< OutVar >,
239 : : tag::elemalias, std::vector< std::string >, // only for error checking
240 : : tag::elemvar, std::vector< std::string >, // only for error checking
241 : : tag::nodealias, std::vector< std::string >, // only for error checking
242 : : tag::nodevar, std::vector< std::string > // only for error checking
243 : : > >;
244 : :
245 : : // Diagnostics block
246 : : using diagnosticsList = tk::TaggedTuple< brigand::list<
247 : : tag::interval, uint32_t,
248 : : tag::error, tk::ctr::ErrorType,
249 : : tag::format, tk::ctr::TxtFloatFormatType,
250 : : tag::precision, std::streamsize
251 : : > >;
252 : :
253 : : // History output block
254 : : using historyOutputList = tk::TaggedTuple< brigand::list<
255 : : tag::interval, uint32_t,
256 : : tag::time_interval, tk::real,
257 : : tag::time_range, std::vector< tk::real >,
258 : : tag::format, tk::ctr::TxtFloatFormatType,
259 : : tag::precision, std::streamsize,
260 : : tag::point, std::vector<
261 : : tk::TaggedTuple< brigand::list<
262 : : tag::id, std::string,
263 : : tag::coord, std::vector< tk::real >
264 : : > >
265 : : >
266 : : > >;
267 : :
268 : : using ConfigMembers = brigand::list<
269 : :
270 : : tag::title, std::string,
271 : :
272 : : // Command line parameters
273 : : tag::cmd, CmdLine,
274 : :
275 : : // time stepping options
276 : : tag::nstep, uint64_t,
277 : : tag::term, tk::real,
278 : : tag::t0, tk::real,
279 : : tag::dt, tk::real,
280 : : tag::cfl, tk::real,
281 : : tag::ttyi, uint32_t,
282 : : tag::imex_runge_kutta, uint32_t,
283 : : tag::imex_maxiter, uint32_t,
284 : : tag::imex_reltol, tk::real,
285 : : tag::imex_abstol, tk::real,
286 : :
287 : : // steady-state solver options
288 : : tag::steady_state, bool,
289 : : tag::residual, tk::real,
290 : : tag::rescomp, uint32_t,
291 : :
292 : : // mesh partitioning and reordering/sorting choices
293 : : tag::partitioning, tk::ctr::PartitioningAlgorithmType,
294 : : tag::pelocal_reorder, bool,
295 : : tag::operator_reorder, bool,
296 : :
297 : : // discretization scheme choices
298 : : tag::scheme, SchemeType,
299 : : tag::ndof, std::size_t,
300 : : tag::rdof, std::size_t,
301 : : tag::flux, FluxType,
302 : : tag::lowspeed_kp, tk::real,
303 : :
304 : : // limiter options
305 : : tag::limiter, LimiterType,
306 : : tag::cweight, tk::real,
307 : : tag::shock_detector_coeff, tk::real,
308 : : tag::accuracy_test, bool,
309 : : tag::limsol_projection, bool,
310 : :
311 : : // PDE options
312 : : tag::ncomp, std::size_t,
313 : : tag::pde, PDEType,
314 : : tag::transport, transportList,
315 : : tag::compflow, compflowList,
316 : : tag::multimat, multimatList,
317 : : tag::multispecies, multispeciesList,
318 : :
319 : : // Dependent variable name
320 : : tag::depvar, std::vector< char >,
321 : :
322 : : tag::sys, std::map< std::size_t, std::size_t >,
323 : :
324 : : tag::material, std::vector< materialList >,
325 : :
326 : : tag::species, std::vector< speciesList >,
327 : :
328 : : tag::matidxmap, tk::TaggedTuple< brigand::list<
329 : : tag::eosidx, std::vector< std::size_t >,
330 : : tag::matidx, std::vector< std::size_t >,
331 : : tag::solidx, std::vector< std::size_t >
332 : : > >,
333 : :
334 : : // Conditions
335 : : tag::bc, std::vector< bcList >,
336 : : tag::ic, icList,
337 : : tag::mesh, std::vector< meshList >,
338 : : tag::transfer, std::vector< Transfer >,
339 : :
340 : : // ALE block
341 : : // ---------------------------------------------------------------------------
342 : : tag::ale, tk::TaggedTuple< brigand::list<
343 : : tag::ale, bool,
344 : : tag::smoother, MeshVelocitySmootherType,
345 : : tag::mesh_velocity, MeshVelocityType,
346 : : tag::mesh_motion, std::vector< std::size_t >,
347 : : tag::meshforce, std::vector< tk::real >,
348 : : tag::dvcfl, tk::real,
349 : : tag::vortmult, tk::real,
350 : : tag::maxit, std::size_t,
351 : : tag::tolerance, tk::real,
352 : : tag::dirichlet, std::vector< std::size_t >,
353 : : tag::symmetry, std::vector< std::size_t >,
354 : : tag::move, std::vector<
355 : : tk::TaggedTuple< brigand::list<
356 : : tag::sideset, std::vector< uint64_t >,
357 : : tag::fntype, tk::ctr::UserTableType,
358 : : tag::fn, std::vector< tk::real >
359 : : > >
360 : : >
361 : : > >,
362 : :
363 : : // p-refinement block
364 : : // ---------------------------------------------------------------------------
365 : : tag::pref, tk::TaggedTuple< brigand::list<
366 : : tag::pref, bool,
367 : : tag::indicator, PrefIndicatorType,
368 : : tag::ndofmax, std::size_t,
369 : : tag::tolref, tk::real
370 : : > >,
371 : :
372 : : // AMR block
373 : : // ---------------------------------------------------------------------------
374 : : tag::amr, tk::TaggedTuple< brigand::list<
375 : : tag::amr, bool,
376 : : tag::t0ref, bool,
377 : : tag::dtref, bool,
378 : : tag::dtref_uniform, bool,
379 : : tag::dtfreq, std::size_t,
380 : : tag::maxlevels, std::size_t,
381 : : tag::initial, std::vector< AMRInitialType >,
382 : : tag::edgelist, std::vector< std::size_t >,
383 : : tag::coords, tk::TaggedTuple< brigand::list<
384 : : tag::xminus, tk::real,
385 : : tag::xplus, tk::real,
386 : : tag::yminus, tk::real,
387 : : tag::yplus, tk::real,
388 : : tag::zminus, tk::real,
389 : : tag::zplus, tk::real
390 : : > >,
391 : : tag::error, AMRErrorType,
392 : : tag::refvar, std::vector< char >,
393 : : tag::tol_refine, tk::real,
394 : : tag::tol_derefine, tk::real
395 : : > >,
396 : :
397 : : // Output options
398 : : tag::field_output, fieldOutputList,
399 : : tag::diagnostics, diagnosticsList,
400 : : tag::history_output, historyOutputList
401 : : >;
402 : :
403 : : // Class storing the Config params
404 : 191 : class InputDeck : public tk::TaggedTuple< ConfigMembers > {
405 : :
406 : : public:
407 : : //! Set of tags to ignore when printing this InputDeck
408 : : using ignore = CmdLine::ignore;
409 : :
410 : : //! \brief Constructor: set defaults
411 : : //! \param[in] cl Previously parsed and store command line
412 : : //! \details Anything not set here is initialized by the compiler using the
413 : : //! default constructor for the corresponding type.
414 : 1345 : explicit InputDeck( const CmdLine& cl = {} ) {
415 : : // Set previously parsed command line
416 : : get< tag::cmd >() = cl;
417 : : // Default time stepping params
418 : 1345 : get< tag::dt >() = 0.0;
419 : 1345 : get< tag::cfl >() = 0.0;
420 : : // Default AMR settings
421 : : auto rmax =
422 : : std::numeric_limits< tk::real >::max() / 100;
423 : 1345 : get< tag::amr, tag::coords, tag::xminus >() = rmax;
424 : 1345 : get< tag::amr, tag::coords, tag::xplus >() = -rmax;
425 : 1345 : get< tag::amr, tag::coords, tag::yminus >() = rmax;
426 : 1345 : get< tag::amr, tag::coords, tag::yplus >() = -rmax;
427 : 1345 : get< tag::amr, tag::coords, tag::zminus >() = rmax;
428 [ + - ]: 1345 : get< tag::amr, tag::coords, tag::zplus >() = -rmax;
429 : :
430 : : // -----------------------------------------------------------------------
431 : : /*
432 : : Keyword vector
433 : : The following code generates a vector of keywords, for the sole purpose
434 : : of documentation and user-help (accessible via the --helpctr and
435 : : --helpkw cmdline arguments. If entries for a keyword are not added to
436 : : this vector, help will not be output for it. The entries follow the
437 : : function signature of the tk::entry_t constructor (defined in
438 : : Base/Types.hpp).
439 : : */
440 : : // -----------------------------------------------------------------------
441 : : std::set< tk::entry_t > keywords;
442 : :
443 : : keywords.insert({"inciter",
444 : : "Start configuration block for inciter",
445 : : R"(This keyword is used to select inciter. Inciter, is a continuum-realm
446 : : shock hydrodynamics tool, solving a system of PDEs. The entire control
447 [ + - ][ + - ]: 5380 : file must be enclosed within the inciter block)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
448 : :
449 : : keywords.insert({"title", "Title", R"(The title may be specified in
450 [ + - ][ + - ]: 4035 : the input file. It is optional.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ - + ]
[ - + ][ - - ]
451 : :
452 : : // -----------------------------------------------------------------------
453 : : // time stepping options
454 : : // -----------------------------------------------------------------------
455 : :
456 : : keywords.insert({"nstep", "Set number of time steps to take",
457 : : R"(This keyword is used to specify the number of time steps to take in a
458 : : simulation. The number of time steps are used in conjunction with the
459 : : maximmum time specified by keyword 'term': the simulation stops whichever
460 : : is reached first. Both 'nstep' and 'term' can be left unspecified, in
461 [ + - ][ + - ]: 5380 : which case their default values are used. See also 'term'.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
462 : :
463 : : keywords.insert({"term", "Set maximum physical time to simulate",
464 : : R"(This keyword is used to specify the termination time in a simulation.
465 : : The termination time and number of time steps, specified by 'nstep', are
466 : : used in conjunction to determine when to stop a simulation: whichever is
467 : : reached first. Both 'nstep' and 'term' can be left unspecified, in which
468 [ + - ][ + - ]: 5380 : case their default values are used. See also 'nstep'.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
469 : :
470 : : keywords.insert({"t0", "Set starting non-dimensional time",
471 : : R"(This keyword is used to specify the starting time in a simulation.)",
472 [ + - ][ + - ]: 5380 : "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
473 : :
474 : : keywords.insert({"dt", "Select constant time step size",
475 : : R"(This keyword is used to specify the time step size that used as a
476 : : constant during simulation. Setting 'cfl' and 'dt' are mutually
477 [ + - ][ + - ]: 5380 : exclusive. If both 'cfl' and 'dt' are set, 'dt' wins.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
478 : :
479 : : keywords.insert({"cfl",
480 : : "Set the Courant-Friedrichs-Lewy (CFL) coefficient",
481 : : R"(This keyword is used to specify the CFL coefficient for
482 : : variable-time-step-size simulations. Setting 'cfl' and 'dt' are mutually
483 [ + - ][ + - ]: 5380 : exclusive. If both 'cfl' and 'dt' are set, 'dt' wins.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
484 : :
485 : : keywords.insert({"ttyi", "Set screen output interval",
486 : : R"(This keyword is used to specify the interval in time steps for screen
487 [ + - ][ + - ]: 5380 : output during a simulation.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
488 : :
489 : : keywords.insert({"imex_runge_kutta",
490 : : "Toggle use of IMplicit-EXplicit Runge-Kutta scheme",
491 : : R"(This keywords is used to turn IMEX integrator on/off for solid materials
492 : : in a multimat run. Plastic terms are integrated implicitly in time. This
493 : : flag will activate an Implicit-Explicit Runge-Kutta scheme to replace the
494 : : explicit one that is usually used. Scheme taken from Cavaglieri, D., &
495 : : Bewley, T. (2015). Low-storage implicit/explicit Runge–Kutta schemes for
496 : : the simulation of stiff high-dimensional ODE systems. Journal of
497 [ + - ][ + - ]: 5380 : Computational Physics, 286, 172-193.)", "uint 0/1"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
498 : :
499 : : keywords.insert({"imex_maxiter",
500 : : "Set maximum number of iterations for non-linear solver with IMEX-RK scheme",
501 : : R"(This keywords is used to specify the maximum number of iterations that
502 : : the non-linear solver uses to obtain the implicit unknowns within the
503 [ + - ][ + - ]: 5380 : Implicit-Explicit Runge-Kutta scheme.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
504 : :
505 : : keywords.insert({"imex_reltol",
506 : : "Set relative tolerance for non-linear solver with IMEX-RK scheme",
507 : : R"(This keywords is used to specify the relative tolerance that
508 : : the non-linear solver uses to obtain the implicit unknowns within the
509 [ + - ][ + - ]: 5380 : Implicit-Explicit Runge-Kutta scheme.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
510 : :
511 : : keywords.insert({"imex_abstol",
512 : : "Set absolute tolerance for non-linear solver with IMEX-RK scheme",
513 : : R"(This keywords is used to specify the absolute tolerance that
514 : : the non-linear solver uses to obtain the implicit unknowns within the
515 [ + - ][ + - ]: 5380 : Implicit-Explicit Runge-Kutta scheme.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
516 : :
517 : : // -----------------------------------------------------------------------
518 : : // steady-state solver options
519 : : // -----------------------------------------------------------------------
520 : :
521 : : keywords.insert({"steady_state", "March to steady state",
522 : : R"(This keyword is used indicate that local time stepping should be used
523 [ + - ][ + - ]: 5380 : to march towards a stationary solution.)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
524 : :
525 : : keywords.insert({"residual",
526 : : "Set the convergence criterion for the residual to reach",
527 : : R"(This keyword is used to specify a convergence criterion for the local
528 : : time stepping marching to steady state, below which the simulation is
529 [ + - ][ + - ]: 5380 : considered converged.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
530 : :
531 : : keywords.insert({"rescomp",
532 : : "Equation system component index for convergence",
533 : : R"(This keyword is used to specify a single integer that is used to denote
534 : : the equation component index in the complete system of equations
535 : : configured, to use for the convergence criterion for local
536 [ + - ][ + - ]: 5380 : time stepping marching towards steady state.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
537 : :
538 : : // -----------------------------------------------------------------------
539 : : // mesh partitioning and reordering/sorting choices
540 : : // -----------------------------------------------------------------------
541 : :
542 : : keywords.insert({"partitioning",
543 : : "Select mesh partitioning algorithm",
544 : : R"(This keyword is used to select a mesh partitioning algorithm. See
545 : : Control/Options/PartitioningAlgorithm.hpp for valid options.)",
546 [ + - ][ + - ]: 5380 : "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
547 : :
548 : : keywords.insert({"rcb",
549 : : "Select recursive coordinate bisection mesh partitioner",
550 : : R"(This keyword is used to select the recursive coordinate bisection (RCB)
551 : : mesh partitioner. RCB is a geometry-based partitioner used to distribute
552 : : an input mesh among processing elements. See
553 [ + - ][ + - ]: 5380 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
554 : :
555 : : keywords.insert({"rib",
556 : : "Select recursive inertial bisection mesh partitioner",
557 : : R"(This keyword is used to select the recursive inertial bisection (RIB)
558 : : mesh partitioner. RIB is a geometry-based partitioner used to distribute
559 : : an input mesh among processing elements. See
560 [ + - ][ + - ]: 5380 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
561 : :
562 : : keywords.insert({"hsfc",
563 : : "Select Hilbert Space Filling Curve (HSFC) mesh partitioner",
564 : : R"(This keyword is used to select the Hilbert Space Filling Curve (HSFC)
565 : : mesh partitioner. HSFC is a geometry-based partitioner used to distribute
566 : : an input mesh among processing elements. See
567 [ + - ][ + - ]: 5380 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
568 : :
569 : : keywords.insert({"phg",
570 : : "Select parallel hypergraph mesh partitioner",
571 : : R"(This keyword is used to select the parallel hypergraph (PHG)
572 : : mesh partitioner. PHG is a graph-based partitioner used to distribute an
573 : : input mesh among processing elements. See
574 [ + - ][ + - ]: 5380 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
575 : :
576 : : keywords.insert({"mj",
577 : : "Select multi-jagged (MJ) mesh partitioner",
578 : : R"(This keyword is used to select the multi-jagged (MJ) mesh partitioner.
579 : : MJ is a geometry-based partitioner used to distribute an input mesh among
580 : : processing elements. See
581 [ + - ][ + - ]: 5380 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
582 : :
583 : : keywords.insert({"pelocal_reorder",
584 : : "PE-local reorder",
585 : : R"(This keyword is used in inciter as a keyword in the inciter...end block
586 : : as "pelocal_reorder true" (or false) to do (or not do) a global
587 : : distributed mesh reordering across all PEs that yields an approximately
588 : : continuous mesh node ID order as mesh partitions are assigned to PEs after
589 [ + - ][ + - ]: 5380 : mesh partitioning. This reordering is optional.)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
590 : :
591 : : keywords.insert({"operator_reorder",
592 : : "Operator-access reorder",
593 : : R"(This keyword is used in inciter as a keyword in the inciter...end block
594 : : as "operator_reorder on" (or off) to do (or not do) a local mesh node
595 : : reordering based on the PDE operator access pattern. This reordering is
596 [ + - ][ + - ]: 5380 : optional.)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
597 : :
598 : : // -----------------------------------------------------------------------
599 : : // discretization scheme choices
600 : : // -----------------------------------------------------------------------
601 : :
602 : : keywords.insert({"scheme", "Select discretization scheme",
603 : : R"(This keyword is used to select a spatial discretization scheme,
604 : : necessarily connected to the temporal discretization scheme. See
605 [ + - ][ + - ]: 5380 : Control/Inciter/Options/Scheme.hpp for valid options.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
606 : :
607 : : keywords.insert({"alecg",
608 : : "Select continuous Galerkin with ALE + Runge-Kutta",
609 : : R"(This keyword is used to select the continuous Galerkin finite element
610 : : scheme in the arbitrary Lagrangian-Eulerian (ALE) reference frame combined
611 : : with Runge-Kutta (RK) time stepping.
612 [ + - ][ + - ]: 5380 : See Control/Inciter/Options/Scheme.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
613 : :
614 : : keywords.insert({"oversetfe",
615 : : "Select continuous Galerkin finite element with overset meshes + "
616 : : "Runge-Kutta",
617 : : R"(This keyword is used to select the continuous Galerkin finite element
618 : : scheme with Runge-Kutta (RK) time stepping, combined with overset grids.
619 [ + - ][ + - ]: 5380 : See Control/Inciter/Options/Scheme.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
620 : :
621 : : keywords.insert({"dg",
622 : : "Select 1st-order discontinuous Galerkin discretization + Runge-Kutta",
623 : : R"(This keyword is used to select the first-order accurate discontinuous
624 : : Galerkin, DG(P0), spatial discretiztaion used in Inciter. As this is first
625 : : order accurate, it is intended for testing and debugging purposes only.
626 : : Selecting this spatial discretization also selects the Runge-Kutta scheme
627 : : for time discretization. See Control/Inciter/Options/Scheme.hpp for other
628 [ + - ][ + - ]: 5380 : valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
629 : :
630 : : keywords.insert({"p0p1",
631 : : "Select 2nd-order finite volume discretization + Runge-Kutta",
632 : : R"(This keyword is used to select the second-order accurate finite volume,
633 : : P0P1, spatial discretiztaion used in Inciter. This method uses a
634 : : least-squares procedure to reconstruct the second-order solution from the
635 : : first-order one. Selecting this spatial discretization also selects the
636 : : Runge-Kutta scheme for time discretization.
637 [ + - ][ + - ]: 5380 : See Control/Inciter/Options/Scheme.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
638 : :
639 : : keywords.insert({"dgp1",
640 : : "Select 2nd-order discontinuous Galerkin discretization + Runge-Kutta",
641 : : R"(This keyword is used to select the second-order accurate discontinuous
642 : : Galerkin, DG(P1), spatial discretiztaion used in Inciter. Selecting this
643 : : spatial discretization also selects the Runge-Kutta scheme for time
644 : : discretization. See Control/Inciter/Options/Scheme.hpp for other
645 [ + - ][ + - ]: 5380 : valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
646 : :
647 : : keywords.insert({"dgp2",
648 : : "Select 3nd-order discontinuous Galerkin discretization + Runge-Kutta",
649 : : R"(This keyword is used to select the third-order accurate discontinuous
650 : : Galerkin, DG(P2), spatial discretiztaion used in Inciter. Selecting this
651 : : spatial discretization also selects the Runge-Kutta scheme for time
652 : : discretization. See Control/Inciter/Options/Scheme.hpp for other
653 [ + - ][ + - ]: 5380 : valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
654 : :
655 : : keywords.insert({"pdg",
656 : : "Select p-adaptive discontinuous Galerkin discretization + Runge-Kutta",
657 : : R"(This keyword is used to select the polynomial adaptive discontinuous
658 : : Galerkin spatial discretizaion used in Inciter. Selecting this spatial
659 : : discretization also selects the Runge-Kutta scheme for time
660 : : discretization. See Control/Inciter/Options/Scheme.hpp for other valid
661 [ + - ][ + - ]: 5380 : options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
662 : :
663 : : keywords.insert({"fv",
664 : : "Select 2nd-order finite volume discretization + Runge-Kutta",
665 : : R"(This keyword is used to select the second-order accurate finite volume,
666 : : P0P1, spatial discretiztaion used in Inciter. This method uses a
667 : : least-squares procedure to reconstruct the second-order solution from the
668 : : first-order one. See Control/Inciter/Options/Scheme.hpp for other valid
669 [ + - ][ + - ]: 5380 : options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
670 : :
671 : : keywords.insert({"ndof", "Number of evolved solution DOFs",
672 [ + - ][ + - ]: 5380 : R"(The number of solution DOFs that are evolved.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
673 : :
674 : : keywords.insert({"rdof", "Total number of solution DOFs",
675 : : R"(The total number of solution DOFs, including the reconstructed and the
676 [ + - ][ + - ]: 5380 : evolved ones.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
677 : :
678 : : // -----------------------------------------------------------------------
679 : : // limiter options
680 : : // -----------------------------------------------------------------------
681 : :
682 : : keywords.insert({"limiter", "Select limiter function",
683 : : R"(This keyword is used to select a limiter function, used for
684 : : discontinuous Galerkin (DG) spatial discretization used in inciter. See
685 [ + - ][ + - ]: 5380 : Control/Inciter/Options/Limiter.hpp for valid options.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
686 : :
687 : : keywords.insert({"nolimiter", "No limiter used",
688 : : R"(This keyword is used for discontinuous Galerkin (DG) spatial
689 : : discretization without any limiter in inciter. See
690 [ + - ][ + - ]: 4035 : Control/Inciter/Options/Limiter.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ - + ]
[ - + ][ - - ]
691 : :
692 : : keywords.insert({"wenop1",
693 : : "Select the Weighted Essentially Non-Oscillatory (WENO) limiter for DGP1",
694 : : R"(This keyword is used to select the Weighted Essentially Non-Oscillatory
695 : : limiter used for discontinuous Galerkin (DG) P1 spatial discretization
696 : : used in inciter. See Control/Inciter/Options/Limiter.hpp for other valid
697 [ + - ][ + - ]: 5380 : options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
698 : :
699 : : keywords.insert({"cweight",
700 : : "Set value for central linear weight used by WENO, cweight",
701 : : R"(This keyword is used to set the central linear weight used for the
702 : : central stencil in the Weighted Essentially Non-Oscillatory (WENO) limiter
703 [ + - ][ + - ]: 5380 : for discontinuous Galerkin (DG) methods.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
704 : :
705 : : keywords.insert({"superbeep1",
706 : : "Select the Superbee limiter for DGP1",
707 : : R"(This keyword is used to select the Superbee limiter used for
708 : : discontinuous Galerkin (DG) P1 spatial discretization used in inciter.
709 [ + - ][ + - ]: 5380 : See Control/Inciter/Options/Limiter.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
710 : :
711 : : keywords.insert({"shock_detector_coeff",
712 : : "Configure the coefficient used in shock indicator",
713 : : R"(This keyword can be used to configure the coefficient used in the
714 [ + - ][ + - ]: 5380 : threshold calculation for the shock indicator.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
715 : :
716 : : keywords.insert({"vertexbasedp1",
717 : : "Select the vertex-based limiter for DGP1",
718 : : R"(This keyword is used to select the vertex-based limiter used for
719 : : discontinuous Galerkin (DG) P1 spatial discretization used in inciter.
720 : : Ref. Kuzmin, D. (2010). A vertex-based hierarchical slope limiter for
721 : : p-adaptive discontinuous Galerkin methods. Journal of computational and
722 : : applied mathematics, 233(12), 3077-3085.
723 [ + - ][ + - ]: 5380 : See Control/Inciter/Options/Limiter.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
724 : :
725 : : keywords.insert({"accuracy_test", "Toggle accuracy test setup",
726 : : R"(This keyword is used to specify if the current setup is for an
727 : : order-of-accuracy testing, used for discontinuous Galerkin (DG) spatial
728 : : discretization in inciter. This deactivates certain robustness corrections
729 : : which might impact order-of-accuracy. Only intended for simple test
730 [ + - ][ + - ]: 5380 : problems and not for real problems.)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
731 : :
732 : : keywords.insert({"limsol_projection",
733 : : "Toggle limited solution projection",
734 : : R"(This keyword is used to specify limited solution projection.
735 : : This is used for discontinuous Galerkin (DG) spatial discretization in
736 : : inciter, for multi-material hydrodynamics. This uses a projection to
737 : : obtain bulk momentum and material energies from the limited primitive
738 : : quantities. This step is essential to obtain closure-law obeying limited
739 : : quantities. See Pandare et al. (2023). On the Design of Stable,
740 : : Consistent, and Conservative High-Order Methods for Multi-Material
741 [ + - ][ + - ]: 5380 : Hydrodynamics. J Comp Phys (490).)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
742 : :
743 : : // -----------------------------------------------------------------------
744 : : // flux options
745 : : // -----------------------------------------------------------------------
746 : :
747 : : keywords.insert({"flux", "Select flux function",
748 : : R"(This keyword is used to select a flux function, used for
749 : : discontinuous Galerkin (DG) spatial discretization used in inciter. See
750 [ + - ][ + - ]: 5380 : Control/Inciter/Options/Flux.hpp for valid options.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
751 : :
752 : : keywords.insert({"laxfriedrichs",
753 : : "Select Lax-Friedrichs flux function",
754 : : R"(This keyword is used to select the Lax-Friedrichs flux function used
755 : : for discontinuous Galerkin (DG) spatial discretization used in inciter.
756 [ + - ][ + - ]: 5380 : See Control/Inciter/Options/Flux.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
757 : :
758 : : keywords.insert({"hllc",
759 : : "Select the Harten-Lax-van Leer-Contact (HLLC) flux function",
760 : : R"(This keyword is used to select the Harten-Lax-van Leer-Contact flux
761 : : function used for discontinuous Galerkin (DG) spatial discretization
762 : : used in inciter. See Control/Inciter/Options/Flux.hpp for other valid
763 [ + - ][ + - ]: 5380 : options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
764 : :
765 : : keywords.insert({"upwind", "Select the upwind flux function",
766 : : R"(This keyword is used to select the upwind flux
767 : : function used for discontinuous Galerkin (DG) spatial discretization
768 : : used in inciter. It is only usable for scalar transport.
769 [ + - ][ + - ]: 5380 : See Control/Inciter/Options/Flux.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
770 : :
771 : : keywords.insert({"ausm",
772 : : "Select the Advection Upstream Splitting Method (AUSM) flux function",
773 : : R"(This keyword is used to select the AUSM flux
774 : : function used for discontinuous Galerkin (DG) spatial discretization
775 : : used in inciter. It is only set up for for multi-material hydro, and
776 [ + - ][ + - ]: 5380 : not selectable for anything else.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
777 : :
778 : : keywords.insert({"ldfss",
779 : : "Select the Low Diffusion Flux Splitting Scheme (LDFSS)",
780 : : R"(This keyword is used to select the LDFSS flux
781 : : function used for discontinuous Galerkin (DG) spatial discretization
782 : : used in inciter. It is only set up for for multi-material hydro, and
783 [ + - ][ + - ]: 5380 : not selectable for anything else.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
784 : :
785 : : keywords.insert({"lowspeed_kp",
786 : : "Select the low-speed coefficient K_p in the AUSM+up flux function",
787 : : R"(This keyword is used to select the low-speed coefficient K_p in the
788 : : AUSM+up flux function used for the DG or FV spatial discretization for
789 : : multi-material hydro, and not used for anything else. The default
790 : : value is 0, and recommended value for low speed flows (Mach < 0.1) is
791 [ + - ][ + - ]: 5380 : 1.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
792 : :
793 : : keywords.insert({"hll",
794 : : "Select the Harten-Lax-vanLeer (HLL) flux function",
795 : : R"(This keyword is used to select the HLL flux
796 : : function used for discontinuous Galerkin (DG) spatial discretization
797 : : used in inciter. It is only set up for for multi-material hydro, and
798 [ + - ][ + - ]: 5380 : not selectable for anything else.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
799 : :
800 : : // -----------------------------------------------------------------------
801 : : // PDE keywords
802 : : // -----------------------------------------------------------------------
803 : :
804 : : keywords.insert({"problem",
805 : : "Specify problem configuration for partial differential equation solver",
806 : : R"(This keyword is used to specify the problem configuration for the
807 [ + - ][ + - ]: 5380 : partial differential equation solver.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
808 : :
809 : : keywords.insert({"transport",
810 : : "Start configuration block for an transport equation",
811 : : R"(This keyword is used to introduce a transport block, used to
812 : : specify the configuration for a transport equation type.)",
813 [ + - ][ + - ]: 5380 : "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
814 : :
815 : : keywords.insert({"ncomp",
816 : : "Set number of scalar components for a system of transport equations",
817 : : R"(This keyword is used to specify the number of scalar
818 [ + - ][ + - ]: 5380 : components of transport (linear advection) equations.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
819 : :
820 : : keywords.insert({"compflow",
821 : : "Start configuration block for the compressible flow equations",
822 : : R"(This keyword is used to introduce the compflow block, used to
823 : : specify the configuration for a system of partial differential equations,
824 [ + - ][ + - ]: 5380 : governing single material compressible fluid flow.)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
825 : :
826 : : keywords.insert({"multimat",
827 : : "Start configuration block for the compressible multi-material equations",
828 : : R"(This keyword is used to introduce the multimat block,
829 : : used to specify the configuration for a system of partial differential
830 : : equations, governing compressible multi-material hydrodynamics assuming
831 [ + - ][ + - ]: 5380 : velocity equilibrium (single velocity).)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
832 : :
833 : : keywords.insert({"multispecies",
834 : : "Start configuration block for the compressible multi-species equations",
835 : : R"(This keyword is used to introduce the multispecies block,
836 : : used to specify the configuration for a system of partial differential
837 : : equations, governing compressible multi-species fluid dynamics.)",
838 [ + - ][ + - ]: 5380 : "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
839 : :
840 : : keywords.insert({"nmat",
841 : : "Set number of materials for the multi-material system",
842 : : R"(This keyword is used to specify the number of materials for
843 [ + - ][ + - ]: 5380 : multi-material flow, see also the keyword 'multimat'.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
844 : :
845 : : keywords.insert({"nspec",
846 : : "Set number of species for the multi-species system",
847 : : R"(This keyword is used to specify the number of species for
848 [ + - ][ + - ]: 5380 : multi-species flow, see also the keyword 'multispecies'.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
849 : :
850 : : keywords.insert({"prelax",
851 : : "Toggle multi-material finite pressure relaxation",
852 : : R"(This keyword is used to turn finite pressure relaxation between
853 : : multiple materials on/off. It is used only for the multi-material solver,
854 [ + - ][ + - ]: 5380 : and has no effect when used for the other PDE types.)", "uint 0/1"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
855 : :
856 : : keywords.insert({"prelax_timescale",
857 : : "Time-scale for multi-material finite pressure relaxation",
858 : : R"(This keyword is used to specify the time-scale at which finite pressure
859 : : relaxation between multiple materials occurs. The default value of 0.25
860 : : corresponds to a relaxation time that is 4 times the time required for a
861 : : sound wave to pass through a computational element. It is used only for
862 [ + - ][ + - ]: 5380 : multimat, and has no effect for the other PDE types.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
863 : :
864 : : keywords.insert({"intsharp",
865 : : "Toggle multi-material interface sharpening",
866 : : R"(This keyword is used to turn interface sharpening on/off. It uses the
867 : : multi-material THINC interface reconstruction.
868 : : Ref. Pandare A. K., Waltz J., & Bakosi J. (2021) Multi-Material
869 : : Hydrodynamics with Algebraic Sharp Interface Capturing. Computers &
870 : : Fluids, doi: https://doi.org/10.1016/j.compfluid.2020.104804. It is used
871 : : for the multi-material and the transport solver, and has no effect when
872 [ + - ][ + - ]: 5380 : used for the other PDE types.)", "uint 0/1"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
873 : :
874 : : keywords.insert({"intsharp_param",
875 : : "Parameter for multi-material interface sharpening",
876 : : R"(This keyword is used to specify the parameter for the interface
877 : : sharpening. This parameter affects how many cells the material interfaces
878 : : span, after the use of sharpening. It is used for multimat and transport,
879 [ + - ][ + - ]: 5380 : and has no effect for the other PDE types.)", "real" });
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
880 : :
881 : : keywords.insert({"rho0constraint",
882 : : "Toggle the density constraint correction",
883 : : R"(This keyword is used to toggle the density constraint in solid
884 : : dynamics on/off. It is used only for the multi-material solver in the
885 [ + - ][ + - ]: 5380 : presence of solids. The default is 1 (on).)", "uint 0/1"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
886 : :
887 : : keywords.insert({"dt_sos_massavg",
888 : : "Toggle method for calculating speed of sound used for time step in a cell",
889 : : R"(This keyword is used to specify the method to calculate the speed of
890 : : sound in a cell used for the time step. If set to 1, the speed of sound
891 : : will be calculated using the mass average, rather than the maximum value
892 : : across materials. It is used for multimat, and has no effect for the
893 [ + - ][ + - ]: 5380 : other PDE types.)", "uint 0/1" });
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
894 : :
895 : : // Dependent variable name
896 : : keywords.insert({"depvar",
897 : : "Select dependent variable name for PDE.",
898 [ + - ][ + - ]: 5380 : R"(Select dependent variable name for PDE.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
899 : :
900 : : // -----------------------------------------------------------------------
901 : : // physics choices
902 : : // -----------------------------------------------------------------------
903 : :
904 : : keywords.insert({"physics",
905 : : "Specify the physics configuration for a system of PDEs",
906 : : R"(This keyword is used to select the physics configuration for a
907 : : particular PDE system. Valid options depend on the system of PDEs in
908 [ + - ][ + - ]: 5380 : which the keyword is used.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
909 : :
910 : : keywords.insert({"advection",
911 : : "Specify the advection physics",
912 : : R"(This keyword is used to select the advection physics for the transport
913 [ + - ][ + - ]: 5380 : PDE system. Only usable for 'transport'.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
914 : :
915 : : keywords.insert({"advdiff",
916 : : "Specify the advection + diffusion physics",
917 : : R"(This keyword is used to select the advection + diffusion physics
918 [ + - ][ + - ]: 5380 : for transport PDEs. Only usable for 'transport'.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
919 : :
920 : : keywords.insert({"euler",
921 : : "Specify the Euler (inviscid) compressible flow physics",
922 : : R"(This keyword is used to select the Euler (inviscid) compressible
923 [ + - ][ + - ]: 5380 : flow physics configuration. Usable for 'compflow' and 'multimat')"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
924 : :
925 : : keywords.insert({"energy_pill",
926 : : "Specify the energy pill physics",
927 : : R"(This keyword is used to select an energy pill initialization as physics
928 : : configuration for multiple material compressible flow. Parameters for the
929 : : linearly traveling front are required to be specified when energy_pill is
930 : : selected. See 'linear' for more details. Currently setup only for
931 [ + - ][ + - ]: 5380 : 'multimat')"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
932 : :
933 : : // -----------------------------------------------------------------------
934 : : // material/eos object
935 : : // -----------------------------------------------------------------------
936 : :
937 : : keywords.insert({"material",
938 : : "Start configuration block for material (eos) properties",
939 : : R"(This keyword is used to introduce a material block, used to
940 [ + - ][ + - ]: 6725 : specify material properties.)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
941 : :
942 : : keywords.insert({"species",
943 : : "Start configuration block for species (eos) properties",
944 : : R"(This keyword is used to introduce a species block, used to
945 : : specify species properties in the multi species solver.)",
946 [ + - ][ + - ]: 6725 : "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
947 : :
948 : : keywords.insert({"id", "ID",
949 : : R"(This keyword is used to specify an ID, a positive integer. Usage is
950 : : context specific, i.e. what block it is specified in. E.g. Inside the
951 : : material block, it is used to specify a block consisting of IDs of
952 [ + - ][ + - ]: 4035 : materials of that EOS type)", "vector of uints"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ - + ]
[ - + ][ - - ]
953 : :
954 : : keywords.insert({"eos", "Select equation of state (type)",
955 : : R"(This keyword is used to select an equation of state for a material.)",
956 [ + - ][ + - ]: 5380 : "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
957 : :
958 : : keywords.insert({"gamma", "ratio of specific heats",
959 : : R"(This keyword is used to specify the material property, ratio of
960 [ + - ][ + - ]: 5380 : specific heats.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
961 : :
962 : : keywords.insert({"pstiff", "EoS stiffness parameter",
963 : : R"(This keyword is used to specify the material property, stiffness
964 [ + - ][ + - ]: 5380 : parameter in the stiffened gas equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
965 : :
966 : : keywords.insert({"w_gru", "Grueneisen coefficient",
967 : : R"(This keyword is used to specify the material property, Gruneisen
968 : : coefficient for the Jones-Wilkins-Lee equation of state.)",
969 [ + - ][ + - ]: 5380 : "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
970 : :
971 : : keywords.insert({"A_jwl", "JWL EoS A parameter",
972 : : R"(This keyword is used to specify the material property A (units: Pa)
973 [ + - ][ + - ]: 5380 : for the Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
974 : :
975 : : keywords.insert({"B_jwl", "JWL EoS B parameter",
976 : : R"(This keyword is used to specify the material property B (units: Pa)
977 [ + - ][ + - ]: 5380 : for the Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
978 : :
979 : : keywords.insert({"C_jwl", "JWL EoS C parameter",
980 : : R"(This keyword is used to specify the material property C (units: Pa)
981 [ + - ][ + - ]: 5380 : for the Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
982 : :
983 : : keywords.insert({"R1_jwl", "JWL EoS R1 parameter",
984 : : R"(This keyword is used to specify the material property R1 for the
985 [ + - ][ + - ]: 5380 : Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
986 : :
987 : : keywords.insert({"R2_jwl", "JWL EoS R2 parameter",
988 : : R"(This keyword is used to specify the material property R2 for the
989 [ + - ][ + - ]: 5380 : Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
990 : :
991 : : keywords.insert({"rho0_jwl", "JWL EoS rho0 parameter",
992 : : R"(This keyword is used to specify the material property rho0, which is
993 : : the density of initial state (units: kg/m3) for the Jones-Wilkins-Lee
994 [ + - ][ + - ]: 5380 : equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
995 : :
996 : : keywords.insert({"de_jwl", "JWL EoS de parameter",
997 : : R"(This keyword is used to specify the material property de, which is the
998 : : heat of detonation for products; and for reactants, it is chosen such that
999 : : the ambient internal energy (e0) is 0 (units: J/kg). Used for the
1000 [ + - ][ + - ]: 5380 : Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1001 : :
1002 : : keywords.insert({"rhor_jwl", "JWL EoS rhor parameter",
1003 : : R"(This keyword is used to specify the material property rhor, which is
1004 : : the density of reference state (units: kg/m3) for the Jones-Wilkins-Lee
1005 [ + - ][ + - ]: 5380 : equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1006 : :
1007 : : keywords.insert({"Tr_jwl", "JWL EoS Tr parameter",
1008 : : R"(This keyword is used to specify the material property Tr, which is the
1009 : : temperature of reference state (units: K) for the Jones-Wilkins-Lee
1010 [ + - ][ + - ]: 5380 : equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1011 : :
1012 : : keywords.insert({"Pr_jwl", "JWL EoS er parameter",
1013 : : R"(This keyword is used to specify the material property Pr, which is the
1014 : : pressure at the reference state (units: Pa) for the Jones-Wilkins-Lee
1015 : : equation of state. It is used to calculate the reference temperature for
1016 [ + - ][ + - ]: 5380 : the EoS.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1017 : :
1018 : : keywords.insert({"mu", "shear modulus/dynamic viscosity",
1019 : : R"(This keyword is used to specify the material property, shear modulus
1020 [ + - ][ + - ]: 5380 : for solids, or dynamic viscosity for fluids.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1021 : :
1022 : : keywords.insert({"yield_stress", "Yield stress of solid material",
1023 : : R"(This keyword is used to specify the material property yield stress,
1024 : : which indicates the stress (units: Pa) after which the material begins
1025 [ + - ][ + - ]: 5380 : plastic flow.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1026 : :
1027 : : keywords.insert({"cv", "specific heat at constant volume",
1028 : : R"(This keyword is used to specify the material property, specific heat at
1029 [ + - ][ + - ]: 5380 : constant volume.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1030 : :
1031 : : keywords.insert({"k", "heat conductivity",
1032 : : R"(This keyword is used to specify the material property, heat
1033 [ + - ][ + - ]: 5380 : conductivity.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1034 : :
1035 : : keywords.insert({"cp_coeff", "specific heat coefficients for TPG",
1036 : : R"(This keyword is used to specify species' coefficients in the
1037 : : thermally perfect gas polynomial fit for specific heat at constant
1038 [ + - ][ + - ]: 5380 : volume.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1039 : :
1040 : : keywords.insert({"R", "Specific gas constant",
1041 : : R"(This keyword is used to specify the species property, specific gas
1042 [ + - ][ + - ]: 5380 : constant, in units J/kg.K.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1043 : :
1044 : : keywords.insert({"stiffenedgas",
1045 : : "Select the stiffened gas equation of state",
1046 [ + - ][ + - ]: 5380 : R"(This keyword is used to select the stiffened gas equation of state.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1047 : :
1048 : : keywords.insert({"jwl", "Select the JWL equation of state",
1049 : : R"(This keyword is used to select the Jones, Wilkins, Lee equation of
1050 [ + - ][ + - ]: 5380 : state.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1051 : :
1052 : : keywords.insert({"smallshearsolid",
1053 : : "Select the SMALLSHEARSOLID equation of state",
1054 : : R"(This keyword is used to select the small shear strain equation of state
1055 : : for solids. This EOS uses a small-shear approximation for the elastic
1056 : : contribution, and a stiffened gas EOS for the hydrodynamic contribution of
1057 : : the internal energy See Plohr, J. N., & Plohr, B. J. (2005). Linearized
1058 : : analysis of Richtmyer–Meshkov flow for elastic materials. Journal of Fluid
1059 [ + - ][ + - ]: 5380 : Mechanics, 537, 55-89 for further details.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1060 : :
1061 : : keywords.insert({"godunovromenski_aluminum",
1062 : : "Select the GODUNOVROMENSKIALUMINUM equation of state",
1063 : : R"(This keyword is used to select the Godunov-Romenski equation of
1064 : : state for solids and a hydro EoS for aluminum. These function were
1065 : : taken from Barton, Philip T. "An interface-capturing Godunov method
1066 : : for the simulation of compressible solid-fluid problems." Journal
1067 [ + - ][ + - ]: 5380 : of Computational Physics 390 (2019): 25-50.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1068 : :
1069 : : keywords.insert({"matidxmap",
1070 : : "AUTO-GENERATED Material index map for EOS",
1071 : : R"(The following AUTO-GENERATED data structure is used to index into the
1072 : : correct material vector entry. This is done using the following three maps:
1073 : : 1. eosidx: This vector provides the eos-index (value) in the
1074 : : vector<tag::material> for the given user-spec material id (index).
1075 : : 2. matidx: This vector provides the material-index (value) inside the
1076 : : vector<tag::material>[eosidx] block for the given user-specified
1077 : : material id (index).
1078 : : 3. solidx: This vector provides the solid-index (value) assigned to
1079 [ + - ][ + - ]: 5380 : the given user-specified material id (index). It is 0 for fluids.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1080 : :
1081 : : // -----------------------------------------------------------------------
1082 : : // output object
1083 : : // -----------------------------------------------------------------------
1084 : :
1085 : : keywords.insert({"field_output",
1086 : : "Start of field_output input block",
1087 : : R"(This keyword is used to start a block in the input file containing the
1088 [ + - ][ + - ]: 5380 : list and settings of requested field output.)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1089 : :
1090 : : keywords.insert({"interval",
1091 : : "Set interval (in units of iteration count)",
1092 : : R"(This keyword is used to specify an interval in units of iteration count
1093 : : (i.e., number of time steps). This must be used within a relevant
1094 [ + - ][ + - ]: 5380 : block.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1095 : :
1096 : : keywords.insert({"time_interval",
1097 : : "Set interval (in units of physics time)",
1098 : : R"(This keyword is used to specify an interval in units of physics time.
1099 [ + - ][ + - ]: 5380 : This must be used within a relevant block.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1100 : :
1101 : : keywords.insert({"time_range",
1102 : : "Configure physics time range for output (in units of physics time)",
1103 : : R"(This keyword is used to configure field-, or history-output, specifying
1104 : : a start time, a stop time, and an output frequency in physics time units.
1105 : : Example: 'time_range = {0.2, 0.3, 0.001}', which specifies that from t=0.2 to
1106 : : t=0.3 output should happen at physics time units of dt=0.001. This must be
1107 [ + - ][ + - ]: 6725 : used within a relevant block.)", "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1108 : :
1109 : : keywords.insert({"refined", "Toggle refined field output on/off",
1110 : : R"(This keyword can be used to turn on/off refined field output, which
1111 : : refines the mesh and evaluates the solution on the refined mesh for saving
1112 [ + - ][ + - ]: 5380 : the solution.)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1113 : :
1114 : : keywords.insert({"filetype", "Select output file type",
1115 : : R"(This keyword is used to specify the output file type of
1116 [ + - ][ + - ]: 5380 : mesh-based field output in a field_output block.)", "string" });
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1117 : :
1118 : : keywords.insert({"elemvar",
1119 : : "Specify list of elem-centered variables for output",
1120 : : R"(This keyword is used to specify elem-centered variables for output to
1121 [ + - ][ + - ]: 6725 : file. It is used in field_output blocks.)", "vector of string"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1122 : :
1123 : : keywords.insert({"nodevar",
1124 : : "Specify list of node-centered variables for output",
1125 : : R"(This keyword is used to specify node-centered variables for output to
1126 [ + - ][ + - ]: 6725 : file. It is used in field_output blocks.)", "vector of string"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1127 : :
1128 : : keywords.insert({"sideset",
1129 : : "Specify list of side sets",
1130 : : R"(This keyword is used to specify side sets. Usage is context specific,
1131 : : i.e. depends on what block it is specified in. Eg. in the field_output
1132 : : block it specifies the sidesets on which field output is desired.)",
1133 [ + - ][ + - ]: 5380 : "vector of uints"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1134 : :
1135 : : keywords.insert({"diagnostics",
1136 : : "Specify the diagnostics block",
1137 : : R"(This keyword is used to introduce the dagnostics block, used to
1138 [ + - ][ + - ]: 5380 : configure diagnostics output.)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1139 : :
1140 : : keywords.insert({"interval",
1141 : : "Set interval (in units of iteration count)",
1142 : : R"(This keyword is used to specify an interval in units of iteration count
1143 : : (i.e., number of time steps). Usage is context specific, and this must
1144 [ + - ][ + - ]: 5380 : be used within a relevant block.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1145 : :
1146 : : keywords.insert({"error", "Select an error type",
1147 : : R"(This keyword is used to select the error type. Used either in the
1148 : : diagnostics block to specify error norm, or in the AMR block to specify
1149 [ + - ][ + - ]: 5380 : the error for solution-adaptive mesh refinement.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1150 : :
1151 : : keywords.insert({"format",
1152 : : "Specify the ASCII floating-point output format",
1153 : : R"(This keyword is used to select the
1154 : : floating-point output format for ASCII floating-point number output.
1155 : : Valid options are 'default', 'fixed', and 'scientific'. For more info on
1156 : : these various formats, see
1157 [ + - ][ + - ]: 5380 : http://en.cppreference.com/w/cpp/io/manip/fixed.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1158 : :
1159 : : keywords.insert({"precision",
1160 : : "Precision in digits for ASCII floating-point output",
1161 : : R"(This keyword is used to select
1162 : : the precision in digits for ASCII floating-point real number output.
1163 : : Example: "precision=10", which selects ten digits for floating-point
1164 : : output, e.g., 3.141592654. The number of digits must be larger than zero
1165 : : and lower than the maximum representable digits for the given
1166 : : floating-point type. For more info on setting the precision in C++, see
1167 : : http://en.cppreference.com/w/cpp/io/manip/setprecision, and
1168 [ + - ][ + - ]: 5380 : http://en.cppreference.com/w/cpp/types/numeric_limits/digits10)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1169 : :
1170 : : keywords.insert({"history_output",
1171 : : "Start of history_output input block",
1172 : : R"(This keyword is used to start a block in the input file containing the
1173 [ + - ][ + - ]: 5380 : descriptions and settings of requested history output.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1174 : :
1175 : : keywords.insert({"point",
1176 : : "Start configuration block for history point, or a single point in IC blocks",
1177 : : R"(This keyword is used to either introduce a vector block used to
1178 : : specify probes for history output, or in the IC/BC block to specify
1179 : : a single point. When used in history output, it takes sub-entries of
1180 : : 'id' and 'coord'. When used in IC/BC, directly takes three reals as
1181 [ + - ][ + - ]: 6725 : coordinates.)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1182 : :
1183 : : keywords.insert({"coord", "Specify point coordinates",
1184 : : R"(This keyword is used to specify coordinates of the history-point.)",
1185 [ + - ][ + - ]: 5380 : "3 reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1186 : :
1187 : : keywords.insert({"exodusii", "Select ExodusII output",
1188 : : R"(This keyword is used to select the
1189 : : ExodusII output file type readable by, e.g., ParaView of either a requested
1190 : : probability density function (PDF) within a pdfs ... end block or for
1191 : : mesh-based field output in a field_output ... end block. Example:
1192 : : "filetype exodusii", which selects ExodusII file output. For more info on
1193 [ + - ][ + - ]: 5380 : ExodusII, see http://sourceforge.net/projects/exodusii.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1194 : :
1195 : : keywords.insert({"density", "Request/specify density",
1196 : : R"(This keyword is used to request/specify the density. Usage is
1197 : : context specific. When specifed as 'elemvar' or 'nodevar' inside
1198 : : field_output, requests density as an output quantity. Otherwise,
1199 [ + - ][ + - ]: 5380 : specifies density at IC/BC.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1200 : :
1201 : : keywords.insert({"x-momentum",
1202 : : "Request x-momentum",
1203 : : R"(This keyword is used to request the fluid x-momentum as an output
1204 [ + - ][ + - ]: 5380 : variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1205 : :
1206 : : keywords.insert({"y-momentum",
1207 : : "Request y-momentum",
1208 : : R"(This keyword is used to request the fluid y-momentum as an output
1209 [ + - ][ + - ]: 5380 : variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1210 : :
1211 : : keywords.insert({"z-momentum",
1212 : : "Request z-momentum",
1213 : : R"(This keyword is used to request the fluid z-momentum as an output
1214 [ + - ][ + - ]: 5380 : variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1215 : :
1216 : : keywords.insert({
1217 : : "specific_total_energy", "Request specific total energy",
1218 : : R"(This keyword is used to request the specific total energy as an output
1219 [ + - ][ + - ]: 5380 : variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1220 : :
1221 : : keywords.insert({
1222 : : "volumetric_total_energy", "Request total volumetric energy",
1223 : : R"(This keyword is used to request the volumetric total energy as an output
1224 [ + - ][ + - ]: 5380 : variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1225 : :
1226 : : keywords.insert({"x-velocity",
1227 : : "Request x-velocity",
1228 : : R"(This keyword is used to request the fluid x-velocity as an output
1229 [ + - ][ + - ]: 5380 : variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1230 : :
1231 : : keywords.insert({"y-velocity",
1232 : : "Request y-velocity",
1233 : : R"(This keyword is used to request the fluid y-velocity as an output
1234 [ + - ][ + - ]: 5380 : variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1235 : :
1236 : : keywords.insert({"z-velocity",
1237 : : "Request z-velocity",
1238 : : R"(This keyword is used to request the fluid z-velocity as an output
1239 [ + - ][ + - ]: 5380 : variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1240 : :
1241 : : keywords.insert({"pressure", "Request/specify pressure",
1242 : : R"(This keyword is used to request/specify the pressure. Usage is
1243 : : context specific. When specifed as 'elemvar' or 'nodevar' inside
1244 : : field_output, requests pressure as an output quantity. Otherwise,
1245 [ + - ][ + - ]: 5380 : specifies pressure at IC/BC.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1246 : :
1247 : : keywords.insert({"material_indicator",
1248 : : "Request material_indicator",
1249 : : R"(This keyword is used to request the material indicator function as an
1250 [ + - ][ + - ]: 5380 : output variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1251 : :
1252 : : keywords.insert({"analytic",
1253 : : "Request analytic solution",
1254 : : R"(This keyword is used to request the analytic solution (if exist) as an
1255 [ + - ][ + - ]: 5380 : output variable.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1256 : :
1257 : : keywords.insert({"l2", "Select the L2 norm",
1258 [ + - ][ + - ]: 5380 : R"(This keyword is used to enable computing the L2 norm.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1259 : :
1260 : : keywords.insert({"linf", "Select the L_{infinity} norm",
1261 [ + - ][ + - ]: 5380 : R"(This keyword is used to enable computing the L-infinity norm.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1262 : :
1263 : : keywords.insert({"default",
1264 : : "Select the default ASCII floating-point output",
1265 : : R"(This keyword is used to select the
1266 : : 'default' floating-point output format for ASCII floating-point real
1267 : : number output. For more info on these various formats, see
1268 [ + - ][ + - ]: 5380 : http://en.cppreference.com/w/cpp/io/manip/fixed.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1269 : :
1270 : : keywords.insert({"fixed",
1271 : : "Select the fixed ASCII floating-point output",
1272 : : R"(This keyword is used to select the
1273 : : 'fixed' floating-point output format for ASCII floating-point real
1274 : : number output. For more info on these various formats, see
1275 [ + - ][ + - ]: 5380 : http://en.cppreference.com/w/cpp/io/manip/fixed.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1276 : :
1277 : : keywords.insert({"scientific",
1278 : : "Select the scientific ASCII floating-point output",
1279 : : R"(This keyword is used to select the
1280 : : 'scientific' floating-point output format for ASCII floating-point real
1281 : : number output. For more info on these various formats, see
1282 [ + - ][ + - ]: 5380 : http://en.cppreference.com/w/cpp/io/manip/fixed.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1283 : :
1284 : : // -----------------------------------------------------------------------
1285 : : // ALE options
1286 : : // -----------------------------------------------------------------------
1287 : :
1288 : : keywords.insert({"ale", "Start block configuring ALE",
1289 : : R"(This keyword is used to introduce the ale block, used to
1290 : : configure arbitrary Lagrangian-Eulerian (ALE) mesh movement.)",
1291 [ + - ][ + - ]: 5380 : "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1292 : :
1293 : : keywords.insert({"smoother", "Select mesh velocity smoother",
1294 : : R"(This keyword is used to select a mesh velocity smoother option, used
1295 : : for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion. Valid options are
1296 [ + - ][ + - ]: 5380 : 'laplace', 'helmholtz', and 'none')", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1297 : :
1298 : : keywords.insert({"mesh_velocity", "Select mesh velocity",
1299 : : R"(This keyword is used to select a mesh velocity option, used for
1300 : : Arbitrary-Lagrangian-Eulerian (ALE) mesh motion. Valid options are
1301 [ + - ][ + - ]: 5380 : 'sine', 'fluid', and 'user_defined".)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1302 : :
1303 : : keywords.insert({"mesh_motion",
1304 : : "List of dimension indices that are allowed to move in ALE calculations",
1305 : : R"(This keyword is used to specify a list of integers (0, 1, or 2) whose
1306 : : coordinate directions corresponding to x, y, or z are allowed to move with
1307 : : the mesh velocity in ALE calculations. Useful for 1D/2D problems.)",
1308 [ + - ][ + - ]: 5380 : "vector of uints"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1309 : :
1310 : : keywords.insert({"meshforce", "Set ALE mesh force model parameter(s)",
1311 : : R"(This keyword is used to specify a vector of real numbers used to
1312 : : parameterize a mesh force model for ALE. The length of the vector must
1313 [ + - ][ + - ]: 6725 : exactly be 4.)", "vector of 4 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1314 : :
1315 : : keywords.insert({"dvcfl",
1316 : : "Set the volume-change Courant-Friedrichs-Lewy (CFL) coefficient",
1317 : : R"(This keyword is used to specify the volume-change (dV/dt) CFL coefficient
1318 : : for variable-time-step-size simulations due to volume change in time in
1319 : : arbitrary-Lagrangian-Eulerian (ALE) calculations. Setting 'dvcfl' only has
1320 : : effect in ALE calculations and used together with 'cfl'. See also J. Waltz,
1321 : : N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A
1322 : : three-dimensional finite element arbitrary Lagrangian–Eulerian method for
1323 : : shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187,
1324 [ + - ][ + - ]: 5380 : 2014.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1325 : :
1326 : : keywords.insert({"vortmult",
1327 : : "Configure vorticity multiplier for ALE mesh velocity",
1328 : : R"(This keyword is used to configure the multiplier for the vorticity term
1329 : : in the mesh velocity smoother (mesh_velocity=fluid) or for the potential
1330 : : gradient for the Helmholtz mesh velocity (mesh_velocity=helmholtz) for ALE
1331 : : mesh motion. For 'fluid' this is coefficient c2 in Eq.(36) of Waltz,
1332 : : Morgan, Canfield, Charest, Risinger, Wohlbier, A three-dimensional finite
1333 : : element arbitrary Lagrangian–Eulerian method for shock hydrodynamics on
1334 : : unstructured grids, Computers & Fluids, 2014, and for 'helmholtz', this
1335 : : is coefficient a1 in Eq.(23) of Bakosi, Waltz, Morgan, Improved ALE mesh
1336 : : velocities for complex flows, International Journal for Numerical Methods
1337 [ + - ][ + - ]: 5380 : in Fluids, 2017. )", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1338 : :
1339 : : keywords.insert({"maxit",
1340 : : "Set the max number of iterations for the ALE mesh velocity linear solve",
1341 : : R"(This keyword is used to specify the maximum number of linear solver
1342 : : iterations taken to converge the mesh velocity linear solve in
1343 : : arbitrary-Lagrangian-Eulerian (ALE) calculations. See also J. Waltz,
1344 : : N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A
1345 : : three-dimensional finite element arbitrary Lagrangian–Eulerian method for
1346 : : shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187,
1347 [ + - ][ + - ]: 5380 : 2014.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1348 : :
1349 : : keywords.insert({"tolerance",
1350 : : "Set the tolerance for the ALE mesh velocity linear solve",
1351 : : R"(This keyword is used to specify the tolerance to converge the mesh
1352 : : velocity linear solve for in
1353 : : arbitrary-Lagrangian-Eulerian (ALE) calculations. See also J. Waltz,
1354 : : N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A
1355 : : three-dimensional finite element arbitrary Lagrangian–Eulerian method for
1356 : : shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187,
1357 [ + - ][ + - ]: 5380 : 2014.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1358 : :
1359 : : keywords.insert({"move",
1360 : : "Start configuration block configuring surface movement in ALE",
1361 : : R"(This keyword is used to introduce a move block, used to
1362 [ + - ][ + - ]: 6725 : configure surface movement for ALE simulations.)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1363 : :
1364 : : keywords.insert({"fntype",
1365 : : "Select how a user-defined function is interpreted",
1366 : : R"(This keyword is used to select how a user-defined function should be
1367 [ + - ][ + - ]: 5380 : interpreted.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1368 : :
1369 : : keywords.insert({"fn", "Specify a discrete user-defined function",
1370 : : R"(This keyword is used to specify a user-defined function block with
1371 : : discrete points, listed inside the fn block. Used in ale mesh motion and
1372 [ + - ][ + - ]: 5380 : time-dependent BC specification)", "reals" });
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1373 : :
1374 : : keywords.insert({"laplace",
1375 : : "Select the Laplace mesh velocity smoother for ALE",
1376 : : R"(This keyword is used to select the 'Laplace' mesh velocity smoother
1377 [ + - ][ + - ]: 5380 : for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1378 : :
1379 : : keywords.insert({"helmholtz",
1380 : : "Select the Helmholtz velocity for ALE",
1381 : : R"(This keyword is used to select the a velocity, computed from the
1382 : : Helmholtz-decomposition as the mesh velocity for
1383 : : Arbitrary-Lagrangian-Eulerian (ALE) mesh motion. See J. Bakosi, J. Waltz,
1384 : : N. Morgan, Improved ALE mesh velocities for complex flows, Int. J. Numer.
1385 [ + - ][ + - ]: 5380 : Meth. Fl., 1-10, 2017, https://doi.org/10.1002/fld.4403.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1386 : :
1387 : : keywords.insert({"none", "Select none option",
1388 : : R"(This keyword is used to select the 'none' option from a list of
1389 [ + - ][ + - ]: 5380 : configuration options.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1390 : :
1391 : : keywords.insert({"sine",
1392 : : "Prescribe sinusoidal mesh velocity for ALE",
1393 : : R"(This keyword is used to prescribe a sinusoidal mesh velocity
1394 [ + - ][ + - ]: 5380 : for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1395 : :
1396 : : keywords.insert({"fluid", "Select the fluid velocity for ALE",
1397 : : R"(This keyword is used to select the 'fluid' velocity as the mesh velocity
1398 [ + - ][ + - ]: 5380 : for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1399 : :
1400 : : // -----------------------------------------------------------------------
1401 : : // h/p adaptation objects
1402 : : // -----------------------------------------------------------------------
1403 : :
1404 : : keywords.insert({"amr",
1405 : : "Start configuration block configuring adaptive mesh refinement",
1406 : : R"(This keyword is used to introduce the amr block, used to
1407 [ + - ][ + - ]: 5380 : configure adaptive mesh refinement.)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1408 : :
1409 : : keywords.insert({"t0ref", "Enable mesh refinement at t<0",
1410 : : R"(This keyword is used to enable initial mesh refinement, which can be
1411 : : configured to perform multiple levels of mesh refinement based on various
1412 [ + - ][ + - ]: 5380 : refinement criteria and configuration settings.)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1413 : :
1414 : : keywords.insert({"dtref", "Enable mesh refinement at t>0",
1415 : : R"(This keyword is used to enable solution-adaptive mesh refinement during
1416 [ + - ][ + - ]: 5380 : time stepping.)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1417 : :
1418 : : keywords.insert({"dtref_uniform",
1419 : : "Enable mesh refinement at t>0 but only perform uniform refinement",
1420 : : R"(This keyword is used to force uniform-only solution-adaptive mesh
1421 [ + - ][ + - ]: 5380 : refinement during time stepping.)", "bool"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1422 : :
1423 : : keywords.insert({"dtfreq",
1424 : : "Set mesh refinement frequency during time stepping",
1425 : : R"(This keyword is used to configure the frequency of mesh refinement
1426 [ + - ][ + - ]: 5380 : during time stepping.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1427 : :
1428 : : keywords.insert({"maxlevels",
1429 : : "Set maximum allowed mesh refinement levels",
1430 : : R"(This keyword is used to configure the maximum allowed mesh refinement
1431 [ + - ][ + - ]: 5380 : levels.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1432 : :
1433 : : keywords.insert({"initial",
1434 : : "Configure initial mesh refinement (before time stepping)",
1435 : : R"(This keyword is used to add to a list of initial mesh refinement types
1436 : : that happens before t = 0. Allowed options are 'uniform',
1437 : : 'uniform_derefine', 'initial_conditions', 'coords', 'edgelist')",
1438 [ + - ][ + - ]: 6725 : "vector of strings"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1439 : :
1440 : : keywords.insert({"coords",
1441 : : "Configure initial refinement using coordinate planes",
1442 : : R"(This keyword can be used to configure entire volumes on a given side of
1443 : : a plane in 3D space. The keyword introduces an coords block within
1444 : : an amr block. All edges of the input mesh will be tagged for refinement
1445 : : whose end-points lie within the given ranges.
1446 : : Example: 'xminus 0.5' refines all edges whose end-point coordinates are
1447 : : less than 0.5. Multiple specifications are understood by combining with
1448 : : a logical AND. That is: 'xminus 0.5 yplus 0.3' refines all edges whose
1449 : : end-point x coordinates are less than 0.5 AND y coordinates are larger than
1450 [ + - ][ + - ]: 5380 : 0.3.)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1451 : :
1452 : : keywords.insert({"xminus",
1453 : : "Configure initial refinement for coordinates lower than an x-normal plane",
1454 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1455 : : whose end-points are less than the x coordinate of a plane perpendicular
1456 : : to coordinate x in 3D space. The keyword must be used in a coords-block
1457 : : within an amr-block with syntax 'xminus <real>'. All edges of the
1458 : : input mesh will be tagged for refinement whose end-points lie less than (-)
1459 : : the real number given. Example: 'xminus 0.5' refines all edges whose end-point
1460 [ + - ][ + - ]: 5380 : x-coordinates are less than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1461 : :
1462 : : keywords.insert({"xplus",
1463 : : "Configure initial refinement for coordinates larger than an x-normal plane",
1464 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1465 : : whose end-points are larger than the x coordinate of a plane perpendicular
1466 : : to coordinate x in 3D space. The keyword must be used in a coords-block
1467 : : within an amr-block with syntax 'xplus <real>'. All edges of the
1468 : : input mesh will be tagged for refinement whose end-points lie larger than
1469 : : (+) the real number given. Example: 'xplus 0.5' refines all edges whose
1470 [ + - ][ + - ]: 5380 : end-point coordinates are larger than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1471 : :
1472 : : keywords.insert({"yminus",
1473 : : "Configure initial refinement for coordinates lower than an y-normal plane",
1474 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1475 : : whose end-points are less than the y coordinate of a plane perpendicular
1476 : : to coordinate y in 3D space. The keyword must be used in a coords-block
1477 : : within an amr-block with syntax 'yminus <real>'. All edges of the
1478 : : input mesh will be tagged for refinement whose end-points lie less than (-)
1479 : : the real number given. Example: 'yminus 0.5' refines all edges whose end-point
1480 [ + - ][ + - ]: 5380 : coordinates are less than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1481 : :
1482 : : keywords.insert({"yplus",
1483 : : "Configure initial refinement for coordinates larger than an y-normal plane",
1484 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1485 : : whose end-points are larger than the y coordinate of a plane perpendicular
1486 : : to coordinate y in 3D space. The keyword must be used in a coords-block
1487 : : within an amr-block with syntax 'yplus <real>'. All edges of the
1488 : : input mesh will be tagged for refinement whose end-points lie larger than
1489 : : (+) the real number given. Example: 'yplus 0.5' refines all edges whose
1490 [ + - ][ + - ]: 5380 : end-point coordinates are larger than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1491 : :
1492 : : keywords.insert({"zminus",
1493 : : "Configure initial refinement for coordinates lower than an z-normal plane",
1494 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1495 : : whose end-points are less than the z coordinate of a plane perpendicular
1496 : : to coordinate z in 3D space. The keyword must be used in a coords-block
1497 : : within an amr-block with syntax 'zminus <real>'. All edges of the
1498 : : input mesh will be tagged for refinement whose end-points lie less than (-)
1499 : : the real number given. Example: 'zminus 0.5' refines all edges whose end-point
1500 [ + - ][ + - ]: 5380 : coordinates are less than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1501 : :
1502 : : keywords.insert({"zplus",
1503 : : "Configure initial refinement for coordinates larger than an z-normal plane",
1504 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1505 : : whose end-points are larger than the z coordinate of a plane perpendicular
1506 : : to coordinate z in 3D space. The keyword must be used in a coords-block
1507 : : within an amr-block with syntax 'zplus <real>'. All edges of the
1508 : : input mesh will be tagged for refinement whose end-points lie larger than
1509 : : (+) the real number given. Example: 'zplus 0.5' refines all edges whose
1510 [ + - ][ + - ]: 5380 : end-point coordinates are larger than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1511 : :
1512 : : keywords.insert({"edgelist",
1513 : : "Configure edge-node pairs for initial refinement",
1514 : : R"(This keyword can be used to configure a list of edges that are explicitly
1515 : : tagged for initial refinement during setup in inciter. The keyword
1516 : : introduces an edgelist block within an amr block and must
1517 : : contain a list of integer pairs, i.e., the number of ids must be even,
1518 : : denoting the end-points of the nodes (=edge) which should be tagged for
1519 [ + - ][ + - ]: 5380 : refinement.)", "vector of uints"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1520 : :
1521 : : keywords.insert({"error",
1522 : : "Configure the error type for solution-adaptive mesh refinement",
1523 : : R"(This keyword is used to select the algorithm used to estimate the error
1524 : : for solution-adaptive mesh refinement. Available options are 'jump' and
1525 [ + - ][ + - ]: 5380 : 'hessian')", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1526 : :
1527 : : keywords.insert({"refvar",
1528 : : "Configure dependent variables used for adaptive mesh refinement",
1529 : : R"(This keyword is used to configured a list of dependent variables that
1530 : : trigger adaptive mesh refinement based on estimating their numerical error.
1531 : : These refinement variables are used for both initial (i.e., before time
1532 : : stepping) mesh refinement as well as during time stepping. Only previously
1533 : : (i.e., earlier in the input file) selected dependent variables can be
1534 : : configured as refinement variables. Dependent variables are required to be
1535 : : defined in all equation system configuration blocks, e.g., transport ...
1536 : : end, by using the 'depvar' keyword. Example: transport depvar c end amr
1537 : : refvar c end end. Selecting a particular scalar component in a system is
1538 : : done by appending the equation number to the refvar: Example: transport
1539 : : depvar q ncomp 3 end amr refvar q1 q2 end end, which configures two
1540 : : refinement variables: the first and third scalar component of the previously
1541 [ + - ][ + - ]: 5380 : configured transport equation system.)", "vector of char"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1542 : :
1543 : : keywords.insert({"tol_refine", "Configure refine tolerance",
1544 : : R"(This keyword is used to set the tolerance used to tag an edge for
1545 [ + - ][ + - ]: 5380 : refinement if the relative error exceeds this value.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1546 : :
1547 : : keywords.insert({"tol_derefine",
1548 : : "Configure derefine tolerance",
1549 : : R"(This keyword is used to set the tolerance used to tag an edge for
1550 [ + - ][ + - ]: 5380 : derefinement if the relative error is below this value.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1551 : :
1552 : : keywords.insert({"uniform",
1553 : : "Select uniform initial mesh refinement",
1554 : : R"(This keyword is used to select uniform initial mesh refinement.)",
1555 [ + - ][ + - ]: 5380 : "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1556 : :
1557 : : keywords.insert({"uniform_derefine",
1558 : : "Select uniform initial mesh de-refinement",
1559 : : R"(This keyword is used to select uniform initial mesh de-refinement.)",
1560 [ + - ][ + - ]: 5380 : "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1561 : :
1562 : : keywords.insert({"initial_conditions",
1563 : : "Select initial-conditions-based initial mesh refinement",
1564 : : R"(This keyword is used to select initial-conditions-based initial mesh
1565 [ + - ][ + - ]: 5380 : refinement.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1566 : :
1567 : : keywords.insert({"jump",
1568 : : "Error estimation based on the solution jump normalized by solution value",
1569 : : R"(This keyword is used to select the jump-based error indicator for
1570 : : solution-adaptive mesh refinement. The error is estimated by computing the
1571 : : magnitude of the jump in the solution value normalized by the solution
1572 [ + - ][ + - ]: 5380 : value.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1573 : :
1574 : : keywords.insert({"hessian",
1575 : : "Error estimation based on the Hessian normalized by solution value",
1576 : : R"(This keyword is used to select the Hessian-based error indicator for
1577 : : solution-adaptive mesh refinement. The error is estimated by computing the
1578 : : Hessian (2nd derivative matrix) of the solution normalized by sum of the
1579 [ + - ][ + - ]: 5380 : absolute values of the gradients at edges-end points.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1580 : :
1581 : : keywords.insert({"pref",
1582 : : "Start configuration block configuring p-adaptive refinement",
1583 : : R"(This keyword is used to introduce the pref block, to
1584 [ + - ][ + - ]: 5380 : configure p-adaptive refinement)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1585 : :
1586 : : keywords.insert({"indicator",
1587 : : "Configure the specific adaptive indicator for p-adaptive DG scheme",
1588 : : R"(This keyword can be used to configure a specific type of adaptive
1589 : : indicator for p-adaptive refinement of the DG scheme. The keyword must
1590 : : be used in a pref block. Available options are 'pref_spectral_decay' and
1591 [ + - ][ + - ]: 5380 : 'pref_non_conformity'.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1592 : :
1593 : : keywords.insert({"ndofmax",
1594 : : "Configure the maximum number of degree of freedom for p-adaptive DG",
1595 : : R"(This keyword can be used to configure a maximum number of degree of
1596 : : freedom for p-adaptive refinement of the DG scheme. The keyword must
1597 [ + - ][ + - ]: 6725 : be used in a pref block.)", "uint either 4 or 10"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1598 : :
1599 : : keywords.insert({"tolref",
1600 : : "Configure the tolerance for p-refinement for p-adaptive DG",
1601 : : R"(This keyword can be used to configure a tolerance for p-adaptive
1602 : : refinement for the DG scheme. The keyword must be used in a pref
1603 : : block. All elements with a refinement indicator larger than this
1604 [ + - ][ + - ]: 6725 : tolerance will be p-refined.)", "real between 0 and 1"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1605 : :
1606 : : keywords.insert({"spectral_decay",
1607 : : "Select the spectral-decay indicator for p-adaptive DG scheme",
1608 : : R"(This keyword is used to select the spectral-decay indicator used for
1609 : : p-adaptive discontinuous Galerkin (DG) discretization used in inciter.
1610 : : See Control/Inciter/Options/PrefIndicator.hpp for other valid options.)",
1611 [ + - ][ + - ]: 5380 : "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1612 : :
1613 : : keywords.insert({"non_conformity",
1614 : : "Select the non-conformity indicator for p-adaptive DG scheme",
1615 : : R"(This keyword is used to select the non-conformity indicator used for
1616 : : p-adaptive discontinuous Galerkin (DG) discretization used in inciter.
1617 : : See Control/Inciter/Options/PrefIndicator.hpp for other valid options.)",
1618 [ + - ][ + - ]: 5380 : "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1619 : :
1620 : : // -----------------------------------------------------------------------
1621 : : // boundary condition options
1622 : : // -----------------------------------------------------------------------
1623 : :
1624 : : keywords.insert({"bc",
1625 : : "Start configuration block for boundary conditions",
1626 : : R"(This keyword is used to introduce the bc block, used for
1627 : : boundary conditions. This is a vector block, where each vector entry
1628 [ + - ][ + - ]: 6725 : specifies BCs for a particular mesh)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1629 : :
1630 : : keywords.insert({"mesh",
1631 : : "List meshes on which the following BCs apply",
1632 : : R"(This keyword is used to list multiple meshes on which the boundary
1633 : : conditions listed in this particular bc-block apply.)",
1634 [ + - ][ + - ]: 5380 : "vector of uints"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1635 : :
1636 : : keywords.insert({"dirichlet",
1637 : : "List sidesets with Dirichlet boundary conditions",
1638 : : R"(This keyword is used to list Dirichlet sidesets.
1639 : : This keyword is used to list multiple sidesets on
1640 : : which a prescribed Dirichlet BC is then applied. Such prescribed BCs
1641 : : at each point in space and time are evaluated using a built-in function,
1642 [ + - ][ + - ]: 6725 : e.g., using the method of manufactured solutions.)", "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1643 : :
1644 : : keywords.insert({"symmetry",
1645 : : "List sidesets with symmetry boundary conditions",
1646 : : R"(This keyword is used to list (multiple) symmetry BC sidesets.)",
1647 [ + - ][ + - ]: 6725 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1648 : :
1649 : : keywords.insert({"inlet",
1650 : : "List sidesets with inlet boundary conditions",
1651 : : R"(This keyword is used to list (multiple) inlet BC sidesets.)",
1652 [ + - ][ + - ]: 6725 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1653 : :
1654 : : keywords.insert({"outlet",
1655 : : "List sidesets with outlet boundary conditions",
1656 : : R"(This keyword is used to list (multiple) outlet BC sidesets.)",
1657 [ + - ][ + - ]: 6725 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1658 : :
1659 : : keywords.insert({"farfield",
1660 : : "List sidesets with farfield boundary conditions",
1661 : : R"(This keyword is used to list (multiple) farfield BC sidesets.
1662 : : Keywords allowed in a bc_farfield block are 'density', 'velocity',
1663 [ + - ][ + - ]: 6725 : 'pressure')", "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1664 : :
1665 : : keywords.insert({"extrapolate",
1666 : : "List sidesets with Extrapolation boundary conditions",
1667 : : R"(This keyword is used to list (multiple) extrapolate BC sidesets.)",
1668 [ + - ][ + - ]: 6725 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1669 : :
1670 : : keywords.insert({"noslipwall",
1671 : : "List sidesets with no-slip wall boundary conditions",
1672 : : R"(This keyword is used to list (multiple) no-slip wall BC sidesets.)",
1673 [ + - ][ + - ]: 6725 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1674 : :
1675 : : keywords.insert({"stag",
1676 : : "List sidesets with stagnation boundary conditions",
1677 : : R"(This keyword is used to list (multiple) stagnation BC sidesets.)",
1678 [ + - ][ + - ]: 6725 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1679 : :
1680 : : keywords.insert({"timedep",
1681 : : "Start configuration block describing time dependent boundary conditions",
1682 : : R"(This keyword is used to introduce a bc_timedep block, used to
1683 : : specify the configuration of time dependent boundary conditions for a
1684 : : partial differential equation. A discrete function in time t in the form
1685 : : of a table with 6 columns (t, pressure(t), density(t), vx(t), vy(t), vz(t))
1686 : : is expected inside a fn ... end block, specified within the bc_timedep
1687 : : block. Multiple such bc_timedep blocks can be specified for different
1688 [ + - ][ + - ]: 5380 : time dependent BCs on different groups of side sets.)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1689 : :
1690 : : keywords.insert({"radius", "Specify a radius",
1691 : : R"(This keyword is used to specify a radius, used, e.g., in specifying a
1692 : : point in 3D space for setting a stagnation (velocity vector = 0).)",
1693 [ + - ][ + - ]: 5380 : "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1694 : :
1695 : : keywords.insert({"velocity", "Specify velocity",
1696 : : R"(This keyword is used to configure a velocity vector used in a
1697 : : context-specific way, e.g., for boundary or initial conditions, or
1698 [ + - ][ + - ]: 6725 : specifying overset mesh velocity.)", "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1699 : :
1700 : : // -----------------------------------------------------------------------
1701 : : // IC object
1702 : : // -----------------------------------------------------------------------
1703 : :
1704 : : keywords.insert({"ic",
1705 : : "Introduce an ic block used to configure initial conditions",
1706 : : R"(This keyword is used to introduce an ic block used to set initial
1707 [ + - ][ + - ]: 5380 : conditions.)", "block-title"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1708 : :
1709 : : keywords.insert({"materialid", "Specify material id",
1710 : : R"(This keyword is used to configure the material id within an IC box,
1711 : : IC mesh-block, farfield BC, or in the background as a part of the
1712 [ + - ][ + - ]: 5380 : initialization.)", "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1713 : :
1714 : : keywords.insert({"temperature", "Specify temperature",
1715 : : R"(This keyword is used to configure temperature, used for, e.g.,
1716 [ + - ][ + - ]: 5380 : boundary or initial conditions.)" , "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1717 : :
1718 : : keywords.insert({"mass_fractions", "Specify species mass fractions",
1719 : : R"(This keyword is used to configure species mass fractions, used for,
1720 [ + - ][ + - ]: 5380 : e.g., boundary or initial conditions.)" , "vector of reals"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1721 : :
1722 : : keywords.insert({"box",
1723 : : "Introduce a box block used to assign initial conditions",
1724 : : R"(This keyword is used to introduce a IC box block used to assign
1725 : : initial conditions within a box given by spatial coordinates.)",
1726 [ + - ][ + - ]: 6725 : "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1727 : :
1728 : : keywords.insert({"meshblock",
1729 : : "Introduce a meshblock block used to assign initial conditions",
1730 : : R"(This keyword is used to introduce a IC meshblock block used to
1731 : : assign initial conditions within a mesh block specified in the mesh file.)",
1732 [ + - ][ + - ]: 6725 : "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1733 : :
1734 : : keywords.insert({"blockid", "Specify mesh block id",
1735 : : R"(This keyword is used to configure the mesh block id within the
1736 : : meshblock-block as a part of the initialization. It is strongly
1737 : : recommended to use contiguous block ids in mesh file starting from 1.)",
1738 [ + - ][ + - ]: 5380 : "uint"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1739 : :
1740 : : keywords.insert({"volume", "Specify volume",
1741 : : R"(This keyword is used to configure the volume of a meshblock.)",
1742 [ + - ][ + - ]: 4035 : "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ - + ]
[ - + ][ - - ]
1743 : :
1744 : : keywords.insert({"mass", "Specify mass",
1745 : : R"(This keyword is used to configure the mass within a box/meshblock.)",
1746 [ + - ][ + - ]: 4035 : "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ - + ]
[ - + ][ - - ]
1747 : :
1748 : : keywords.insert({"energy", "Specify energy per unit mass",
1749 : : R"(This keyword is used to configure energy per unit mass, used for, e.g.,
1750 [ + - ][ + - ]: 5380 : boundary or initial conditions.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1751 : :
1752 : : keywords.insert({"energy_content", "Specify energy per unit volume",
1753 : : R"(This keyword is used to configure energy per unit volume, used for
1754 [ + - ][ + - ]: 5380 : initial conditions.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1755 : :
1756 : : keywords.insert({"xmin", "Minimum x coordinate",
1757 : : R"(This keyword used to configure a minimum x coordinate to specify
1758 [ + - ][ + - ]: 5380 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1759 : :
1760 : : keywords.insert({"xmax", "Maximum x coordinate",
1761 : : R"(This keyword used to configure a maximum x coordinate to specify
1762 [ + - ][ + - ]: 5380 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1763 : :
1764 : : keywords.insert({"ymin", "Minimum y coordinate",
1765 : : R"(This keyword used to configure a minimum y coordinate to specify
1766 [ + - ][ + - ]: 5380 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1767 : :
1768 : : keywords.insert({"ymax", "Maximum y coordinate",
1769 : : R"(This keyword used to configure a maximum y coordinate to specify
1770 [ + - ][ + - ]: 5380 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1771 : :
1772 : : keywords.insert({"zmin", "Minimum z coordinate",
1773 : : R"(This keyword used to configure a minimum z coordinate to specify
1774 [ + - ][ + - ]: 5380 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1775 : :
1776 : : keywords.insert({"zmax", "Maximum z coordinate",
1777 : : R"(This keyword used to configure a maximum z coordinate to specify
1778 [ + - ][ + - ]: 5380 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1779 : :
1780 : : keywords.insert({"orientation", "Configure orientation",
1781 : : R"(Configure orientation of an IC box for rotation about centroid of box.)",
1782 [ + - ][ + - ]: 6725 : "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1783 : :
1784 : : keywords.insert({"initiate", "Initiation type",
1785 : : R"(This keyword is used to select an initiation type to configure how
1786 : : values are assigned for a box/meshblock initialization. This can be used
1787 : : to specify, how the values are assigned to mesh nodes within a box. Uses:
1788 : : (1) impulse: assign the full values at t=0 for all points in a box,
1789 : : (2) linear: use a linear function in time and space, configured with an
1790 : : initiation point in space, a constant velocity of the growing spherical
1791 : : front in time (and space) linearly, and width of the front and assigns
1792 : : values to mesh points falling within the growing spherical shell inside
1793 [ + - ][ + - ]: 4035 : a configured box.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ - + ]
[ - + ][ - - ]
1794 : :
1795 : : keywords.insert({"init_time","Specify the initialization time",
1796 : : R"(This keyword is used to specify the time at which the propagating front
1797 : : is initialized for a mesh block or box IC, with 'initiate linear' type.
1798 : : Delays in initializing separate mesh blocks or boxes can be achieved using
1799 [ + - ][ + - ]: 5380 : different initialization times.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1800 : :
1801 : : keywords.insert({"front_width", "Specify a front width",
1802 : : R"(This keyword is used to specify the width of the propagating front for
1803 : : a mesh block or box IC, with 'initiate linear' type. The suggested value
1804 : : of the front width is about 4-5 times the mesh size inside the mesh block
1805 [ + - ][ + - ]: 5380 : or box.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1806 : :
1807 : : keywords.insert({"front_speed", "Specify a front speed",
1808 : : R"(This keyword is used to specify the speed at which a front propagates
1809 [ + - ][ + - ]: 5380 : for a mesh block or box IC, with 'initiate linear' type.)", "real"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1810 : :
1811 : : keywords.insert({"impulse",
1812 : : "Select the impulse initiation type, for a box/meshblock IC",
1813 : : R"(This keyword can be used to select the 'impulse' initiation/assignment
1814 : : type for box initial conditions. It simply assigns the prescribed values
1815 [ + - ][ + - ]: 5380 : to all mesh points within a configured box at t=0.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1816 : :
1817 : : keywords.insert({"linear",
1818 : : "Select the linear initiation type, for a box/meshblock IC",
1819 : : R"(This keyword is be used to specify the 'linear' initiation parameters
1820 : : for a particular box or meshblock, as a part of the 'energy_pill'
1821 : : initialization. Linear initiation uses a linear function in time and space,
1822 : : configured with an initiation point in space, a constant velocity of the
1823 : : growing spherical front in time (and space) linearly, and width of the front
1824 : : and assigns values to mesh points falling within the growing spherical shell
1825 : : inside a configured box or meshblock. The following keywords are required
1826 : : in the box/meshblock block if 'linear' is used: 'init_time',
1827 [ + - ][ + - ]: 5380 : 'front_width', 'front_speed')"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1828 : :
1829 : : // -----------------------------------------------------------------------
1830 : : // Overset mesh object
1831 : : // -----------------------------------------------------------------------
1832 : :
1833 : : keywords.insert({"mesh",
1834 : : "Start configuration block assigning a mesh to a solver",
1835 : : R"(This keyword is used to introduce a mesh block, used to
1836 [ + - ][ + - ]: 6725 : assign and configure a mesh to a solver.)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1837 : :
1838 : : keywords.insert({"filename", "Set filename",
1839 [ + - ][ + - ]: 4035 : R"(Set filename, e.g., mesh filename for solver coupling.)", "string"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ - + ]
[ - + ][ - - ]
1840 : :
1841 : : keywords.insert({"location", "Configure location",
1842 : : R"(Configure location of a mesh relative to another.)",
1843 [ + - ][ + - ]: 6725 : "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1844 : :
1845 : : keywords.insert({"orientation", "Configure orientation",
1846 : : R"(Configure orientation of a mesh relative to another.)",
1847 [ + - ][ + - ]: 6725 : "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
[ + - ][ + - ]
[ - + ][ - - ]
1848 : :
1849 : : // -----------------------------------------------------------------------
1850 : : // pre-configured problems
1851 : : // -----------------------------------------------------------------------
1852 : :
1853 : : keywords.insert({"user_defined",
1854 : : "Select user-defined specification for a problem",
1855 : : R"(This keyword is used to select the user-defined specification for an
1856 : : option. This could be a 'problem' to be solved by a partial differential
1857 : : equation, but can also be a 'user-defined' mesh velocity specification for
1858 [ + - ][ + - ]: 5380 : ALE mesh motion.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1859 : :
1860 : : keywords.insert({"shear_diff",
1861 : : "Select the shear + diffusion test problem ",
1862 : : R"(This keyword is used to select the shear diffusion test problem. The
1863 : : initial and boundary conditions are specified to set up the test problem
1864 : : suitable to exercise and test the advection and diffusion terms of the
1865 [ + - ][ + - ]: 5380 : scalar transport equation.)" });
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1866 : :
1867 : : keywords.insert({"slot_cyl",
1868 : : "Select Zalesak's slotted cylinder test problem",
1869 : : R"(This keyword is used to select Zalesak's slotted cylinder test
1870 : : problem. The initial and boundary conditions are specified to set up the
1871 : : test problem suitable to exercise and test the advection and diffusion
1872 [ + - ][ + - ]: 5380 : terms of the scalar transport equation.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1873 : :
1874 : : keywords.insert({"gauss_hump",
1875 : : "Select advection of 2D Gaussian hump test problem",
1876 : : R"(This keyword is used to select the advection of 2D Gaussian hump test
1877 : : problem. The initial and boundary conditions are specified to set up the
1878 : : test problem suitable to exercise and test the advection
1879 [ + - ][ + - ]: 5380 : terms of the scalar transport equation.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1880 : :
1881 : : keywords.insert({"cyl_advect",
1882 : : "Select advection of cylinder test problem",
1883 : : R"(This keyword is used to select the advection of cylinder test
1884 : : problem. The initial and boundary conditions are specified to set up the
1885 : : test problem suitable to exercise and test the advection
1886 [ + - ][ + - ]: 5380 : terms of the scalar transport equation.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1887 : :
1888 : : keywords.insert({"cyl_vortex",
1889 : : "Select deformation of cylinder in a vortex test problem",
1890 : : R"(This keyword is used to select the test problem which deforms a cylinder
1891 : : in a vortical velocity field. The initial and boundary conditions are
1892 : : specified to set up the test problem suitable to exercise and test the
1893 [ + - ][ + - ]: 5380 : advection terms of the scalar transport equation.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1894 : :
1895 : : keywords.insert({"vortical_flow",
1896 : : "Select the vortical flow test problem ",
1897 : : R"(This keyword is used to select the vortical flow test problem. The
1898 : : purpose of this test problem is to test velocity errors generated by spatial
1899 : : operators in the presence of 3D vorticity and in particluar the
1900 : : superposition of planar and vortical flows, analogous to voritcity
1901 : : stretching. For more details, see Waltz,
1902 : : et. al, "Manufactured solutions for the three-dimensional Euler equations
1903 : : with relevance to Inertial Confinement Fusion", Journal of Computational
1904 [ + - ][ + - ]: 5380 : Physics 267 (2014) 196-209.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1905 : :
1906 : : keywords.insert({"nl_energy_growth",
1907 : : "Select the nonlinear energy growth test problem",
1908 : : R"(This keyword is used to select the nonlinear energy growth test problem.
1909 : : The purpose of this test problem is to test nonlinear, time dependent energy
1910 : : growth and the subsequent development of pressure gradients due to coupling
1911 : : between the internal energy and the equation of state. For more details,
1912 : : see Waltz, et. al, "Manufactured
1913 : : solutions for the three-dimensional Euler equations with relevance to
1914 : : Inertial Confinement Fusion", Journal of Computational Physics 267 (2014)
1915 [ + - ][ + - ]: 5380 : 196-209.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1916 : :
1917 : : keywords.insert({"rayleigh_taylor",
1918 : : "Select the Rayleigh-Taylor test problem ",
1919 : : R"(This keyword is used to select the Rayleigh-Taylor unstable configuration
1920 : : test problem. The purpose of this test problem is to assess time dependent
1921 : : fluid motion in the presence of Rayleigh-Taylor unstable conditions, i.e.
1922 : : opposing density and pressure gradients.
1923 : : For more details, see Waltz, et. al, "Manufactured solutions for the
1924 : : three-dimensional Euler equations with relevance to Inertial Confinement
1925 [ + - ][ + - ]: 5380 : Fusion", Journal of Computational Physics 267 (2014) 196-209.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1926 : :
1927 : : keywords.insert({"taylor_green",
1928 : : "Select the Taylor-Green test problem ",
1929 : : R"(This keyword is used to select the Taylor-Green vortex test problem. The
1930 : : purpose of this problem is to test time accuracy and the correctness of the
1931 : : discretization of the viscous term in the Navier-Stokes equation. For more
1932 : : details on the flow, see G.I. Taylor, A.E.
1933 : : Green, "Mechanism of the Production of Small Eddies from Large Ones", Proc.
1934 : : R. Soc. Lond. A 1937 158 499-521; DOI: 10.1098/rspa.1937.0036. Published 3
1935 [ + - ][ + - ]: 5380 : February 1937.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1936 : :
1937 : : keywords.insert({"sod_shocktube",
1938 : : "Select the Sod shock-tube test problem ",
1939 : : R"(This keyword is used to select the Sod shock-tube test problem. The
1940 : : purpose of this test problem is to test the correctness of the
1941 : : approximate Riemann solver and its shock and interface capturing
1942 : : capabilities. For more details, see
1943 : : G. A. Sod, "A Survey of Several Finite Difference Methods for Systems of
1944 : : Nonlinear Hyperbolic Conservation Laws", J. Comput. Phys., 27 (1978)
1945 [ + - ][ + - ]: 5380 : 1–31.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1946 : :
1947 : : keywords.insert({"rotated_sod_shocktube",
1948 : : "Select the rotated Sod shock-tube test problem ",
1949 : : R"(This keyword is used to select the rotated Sod shock-tube test problem.
1950 : : This the same as Sod shocktube but the geometry is rotated about X, Y, Z
1951 : : each by 45 degrees (in that order) so that none of the domain boundary align
1952 : : with any of the coordinate directions. The purpose of this test problem is
1953 : : to test the correctness of the approximate Riemann solver and its shock and
1954 : : interface capturing capabilities in an arbitrarily oriented geometry.
1955 : : For more details on the Sod
1956 : : problem, see G. A. Sod, "A Survey of Several Finite Difference Methods for
1957 : : Systems of Nonlinear Hyperbolic Conservation Laws", J. Comput. Phys., 27
1958 [ + - ][ + - ]: 5380 : (1978) 1–31.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1959 : :
1960 : : keywords.insert({"shedding_flow",
1961 : : "Select the Shedding flow test problem ",
1962 : : R"(This keyword is used to select the Shedding flow test problem. It
1963 : : describe a quasi-2D inviscid flow over a triangular wedge in tetrahedron
1964 : : grid. The purpose of this test problem is to test the capability of DG
1965 : : scheme for retaining the shape of vortices and also different error
1966 : : indicator behavior for this external flow problem when p-adaptive DG scheme
1967 [ + - ][ + - ]: 5380 : is applied.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1968 : :
1969 : : keywords.insert({"sedov_blastwave",
1970 : : "Select the Sedov blast-wave test problem ",
1971 : : R"(This keyword is used to select the Sedov blast-wave test problem. The
1972 : : purpose of this test problem is to test the correctness of the
1973 : : approximate Riemann solver and its strong shock and interface capturing
1974 [ + - ][ + - ]: 5380 : capabilities.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
1975 : :
1976 : : keywords.insert({"interface_advection",
1977 : : "Select the interface advection test problem ",
1978 : : R"(This keyword is used to select the interface advection test problem.
1979 : : The purpose of this test problem is to test the well-balancedness of the
1980 : : multi-material discretization and its interface capturing
1981 [ + - ][ + - ]: 5380 : capabilities.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1982 : :
1983 : : keywords.insert({"gauss_hump_compflow",
1984 : : "Select advection of 2D Gaussian hump test problem",
1985 : : R"(This keyword is used to select the advection of 2D Gaussian hump test
1986 : : problem. The initial and boundary conditions are specified to set up the
1987 : : test problem suitable to exercise and test the advection terms of the
1988 : : Euler equations. The baseline of the density distribution in this testcase
1989 : : is 1 instead of 0 in gauss_hump_transport which enables it to be the
1990 [ + - ][ + - ]: 5380 : regression testcase for p-adaptive DG scheme.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
1991 : :
1992 : : keywords.insert({"waterair_shocktube",
1993 : : "Select the water-air shock-tube test problem ",
1994 : : R"(This keyword is used to select the Water-air shock-tube test problem.
1995 : : The purpose of this test problem is to test the correctness of the
1996 : : multi-material pressure relaxation procedure and its interface capturing
1997 : : capabilities. For more details, see
1998 : : Chiapolino, A., Saurel, R., & Nkonga, B. (2017). Sharpening diffuse
1999 : : interfaces with compressible fluids on unstructured meshes. Journal of
2000 [ + - ][ + - ]: 5380 : Computational Physics, 340, 389-417.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
2001 : :
2002 : : keywords.insert({"shock_hebubble",
2003 : : "Select the shock He-bubble test problem ",
2004 : : R"(This keyword is used to select the shock He-bubble test problem. The
2005 : : purpose of this test problem is to test the correctness of the
2006 : : multi-material algorithm and its shock-interface interaction
2007 : : capabilities. For more details, see
2008 : : Quirk, J. J., & Karni, S. (1996). On the dynamics of a shock–bubble
2009 [ + - ][ + - ]: 5380 : interaction. Journal of Fluid Mechanics, 318, 129-163.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
2010 : :
2011 : : keywords.insert({"underwater_ex",
2012 : : "Select the underwater explosion test problem ",
2013 : : R"(This keyword is used to select the underwater explosion test problem.
2014 : : The purpose of this test problem is to test the correctness of the
2015 : : multi-material algorithm and its interface capturing capabilities in the
2016 : : presence of strong shocks and large deformations.
2017 : : For more details, see
2018 : : Chiapolino, A., Saurel, R., & Nkonga, B. (2017). Sharpening diffuse
2019 : : interfaces with compressible fluids on unstructured meshes. Journal of
2020 [ + - ][ + - ]: 5380 : Computational Physics, 340, 389-417.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
2021 : :
2022 : : keywords.insert({"shockdensity_wave",
2023 : : "Select the shock-density wave test problem ",
2024 : : R"(This keyword is used to select the shock-density wave test problem.
2025 : : THe purpose of this test problem is to assess the accuracy of high order
2026 : : method in predicting the interaction of a density wave with a shock front.
2027 : : For more details, see Yu, L., Matthias
2028 : : I. (2014). Discontinuous Galerkin method for multicomponent chemically
2029 : : reacting flows and combustion. Journal of Computational Physics, 270,
2030 [ + - ][ + - ]: 5380 : 105-137.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
2031 : :
2032 : : keywords.insert({"equilinterface_advect",
2033 : : "Select the advection of equilibrium interface problem ",
2034 : : R"(This keyword is used to select the advection of equilibrium interface
2035 : : problem. This is a manufactured problem with source terms with nonlinear
2036 : : solutions near the material interface. Source terms are used to ensure
2037 [ + - ][ + - ]: 5380 : that the conservation laws are satisfied by the manufactured solution.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
2038 : :
2039 : : keywords.insert({"sinewave_packet",
2040 : : "Select the advection of sinewave packet problem ",
2041 : : R"(This keyword is used to select the advection of sinewave packet
2042 [ + - ][ + - ]: 5380 : problem.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ - + ][ - - ]
2043 : :
2044 : : keywords.insert({"richtmyer_meshkov",
2045 : : "Select the Richtmyer-Meshkov instability problem ",
2046 : : R"(This keyword is used to select the Richtmyer-Meshkov instability
2047 [ + - ][ + - ]: 6725 : problem. In this problem, a shock hits a perturbed material interface.)"});
[ + - ][ + - ]
[ + - ][ - + ]
[ + - ][ + - ]
[ + - ][ - - ]
2048 : :
2049 : : // -----------------------------------------------------------------------
2050 : :
2051 : : // Initialize help: fill own keywords
2052 : : tk::ctr::Info ctrinfoFill(get< tag::cmd, tag::ctrinfo >());
2053 [ + + ]: 325490 : for (const auto& i : keywords) {
2054 [ + - ]: 324145 : ctrinfoFill.fill(i);
2055 : : }
2056 : 1345 : }
2057 : :
2058 : : //! Query scheme centering
2059 : : //! \return Scheme centering
2060 : 191 : tk::Centering centering() const
2061 [ + - ]: 382 : { return ctr::Scheme().centering( get< tag::scheme >() ); }
2062 : :
2063 : : /** @name Pack/Unpack: Serialize InputDeck object for Charm++ */
2064 : : ///@{
2065 : : //! \brief Pack/Unpack serialize member function
2066 : : //! \param[in,out] p Charm++'s PUP::er serializer object reference
2067 : : void pup( PUP::er& p ) { tk::TaggedTuple< ConfigMembers >::pup(p); }
2068 : : //! \brief Pack/Unpack serialize operator|
2069 : : //! \param[in,out] p Charm++'s PUP::er serializer object reference
2070 : : //! \param[in,out] c InputDeck object reference
2071 : : friend void operator|( PUP::er& p, InputDeck& c ) { c.pup(p); }
2072 : : //@}
2073 : :
2074 : : };
2075 : :
2076 : : } // ctr::
2077 : : } // inciter::
2078 : :
2079 : : #endif // InputDeck_h
|
