src/Control/Inciter/InputDeck/Grammar.hpp file

Inciter's input deck grammar definition.

Contents

Inciter's input deck grammar definition. We use the Parsing Expression Grammar Template Library (PEGTL) to create the grammar and the associated parser. Word of advice: read from the bottom up.

Namespaces

namespace inciter
Inciter declarations and definitions.
namespace inciter::deck
Inciter input deck facilitating user input for computing shock hydrodynamics.
namespace tk
Toolkit declarations and definitions for general purpose utilities.
namespace tk::grm
Toolkit general purpose grammar definition.

Classes

template<class eq>
struct tk::grm::register_inciter_eq
Rule used to trigger action.
template<class eq>
struct tk::grm::action<register_inciter_eq<eq>>
Register differential equation after parsing its block.
template<class eq>
struct tk::grm::check_transport
Rule used to trigger action.
template<class eq>
struct tk::grm::action<check_transport<eq>>
Set defaults and do error checking on the transport equation block.
template<class eq>
struct tk::grm::check_compflow
Rule used to trigger action.
template<class eq>
struct tk::grm::action<check_compflow<eq>>
Set defaults and do error checking on the compressible flow equation block.
template<class eq>
struct tk::grm::check_multimat
Rule used to trigger action.
template<class eq>
struct tk::grm::action<check_multimat<eq>>
Set defaults and do error checking on the multimaterial compressible flow equation block.
template<class Option, typename... tags>
struct tk::grm::store_inciter_option
Rule used to trigger action.
template<class Option, typename... tags>
struct tk::grm::action<store_inciter_option<Option, tags...>>
Put option in state at position given by tags.
struct tk::grm::check_inciter
Rule used to trigger action.
template<>
struct tk::grm::action<check_inciter>
Do error checking on the inciter block.
struct tk::grm::enable_amr
Rule used to trigger action.
template<>
struct tk::grm::action<enable_amr>
Enable adaptive mesh refinement (AMR)
struct tk::grm::compute_refvar_idx
Rule used to trigger action.
template<>
struct tk::grm::action<compute_refvar_idx>
struct tk::grm::check_amr_errors
Rule used to trigger action.
template<>
struct tk::grm::action<check_amr_errors>
struct tk::grm::check_pref_errors
Rule used to trigger action.
template<>
struct tk::grm::action<check_pref_errors>
Do error checking for the pref...end block.
template<typename keyword, class eq>
struct inciter::deck::scan_eq
scan and store_back equation keyword and option
template<class eq, template<class> class eqchecker>
struct inciter::deck::check_errors
Error checks after an equation...end block has been parsed.
template<template<class> class use, class keyword, class Option, class Tag>
struct inciter::deck::discroption
Match discretization option.
struct inciter::deck::discretization
Discretization parameters.
template<class keyword, class eq, class param>
struct inciter::deck::pde_parameter_vector
PDE parameter vector.
template<class keyword, class eq, class param>
struct inciter::deck::bc
Boundary conditions block.
struct inciter::deck::edgelist
edgelist ... end block
template<typename keyword, typename Tag>
struct inciter::deck::half_world
xminus configuring coordinate-based edge tagging for mesh refinement
struct inciter::deck::coordref
coordref ... end block
template<class eq, class param>
struct inciter::deck::ic_compflow
initial conditions block for compressible flow
template<typename eq, typename keyword, typename property>
struct inciter::deck::material_property
put in material property for equation matching keyword
template<class eq>
struct inciter::deck::material_properties
Material properties block for compressible flow.
template<typename eq, typename keyword, typename p, class kw_type = tk::grm::number>
struct inciter::deck::parameter
put in PDE parameter for equation matching keyword
struct inciter::deck::transport
transport equation for scalars
struct inciter::deck::compflow
compressible flow
struct inciter::deck::multimat
compressible multi-material flow
struct inciter::deck::partitioning
partitioning ... end block
struct inciter::deck::equations
equation types
struct inciter::deck::refvars
refinement variable(s) (refvar) ... end block
struct inciter::deck::amr
adaptive mesh refinement (AMR) amr...end block
struct inciter::deck::pref
p-adaptive refinement (pref) ...end block
struct inciter::deck::plotvar
plotvar ... end block
struct inciter::deck::inciter
'inciter' block
struct inciter::deck::keywords
All keywords.
struct inciter::deck::read_file
Grammar entry point: parse keywords and ignores until eof.