RNGTest control file keywords

Contents

This page documents the control file keywords of Inciter.

List of all control file keywords

            acceleration            Specify acceleration
                 advdiff     string Specify the advection + diffusion physics configuration for a PDE 
               advection     string Specify the advection physics configuration for a PDE 
                     ale            Start configuration block configuring ALE
                   alecg            Select continuous Galerkin with ALE + Runge-Kutta
               algorithm     string Select mesh partitioning algorithm
                   alpha       real Set PDE parameter(s) alpha
                     amr            Start configuration block configuring adaptive mesh refinement
                analytic            Request analytic solution
                    ausm            Select the Advection Upstream Splitting Method (AUSM) flux function
            bc_dirichlet            Start configuration block describing Dirichlet boundary conditions
          bc_extrapolate            Start configuration block describing Extrapolation boundary conditions
             bc_farfield            Start configuration block describing farfield boundary conditions
                bc_inlet            Start configuration block describing inlet boundary conditions
               bc_outlet            Start configuration block describing outlet boundary conditions
                 bc_skip            Start configuration block describing skip boundary conditions
                 bc_stag            Start configuration block describing stagnation boundary conditions
                  bc_sym            Start configuration block describing symmetry boundary conditions
              bc_timedep            Start configuration block describing time dependent boundary conditions
                    beta       real Set PDE parameter(s) beta
                   betax       real Set PDE parameter(s) betax
                   betay       real Set PDE parameter(s) betay
                   betaz       real Set PDE parameter(s) betaz
                     box            Introduce a box ... end block used to assign initial conditions
                      ce       real Set PDE parameter(s) ce
                     cfl       real Set the Courant-Friedrichs-Lewy (CFL) coefficient
                compflow            Start configuration block for the compressible flow equations
                  coords            Configure initial refinement using coordinate planes
                  couple            Specify coupling of solvers on different meshes
                    ctau       real Set FCT mass diffusion coefficient, ctau
                      cv       real specific heat at constant volume
                 cweight       real Set value for central linear weight used by WENO, cweight
              cyl_advect     string Select advection of cylinder test problem
              cyl_vortex     string Select deformation of cylinder in a vortex test problem
                 default            Select the default ASCII floating-point output
                 density            Request density
                  depvar  character Select dependent variable (in a relevant block)
                      dg            Select 1st-order discontinuous Galerkin discretization + Runge-Kutta
                    dgp1            Select 2nd-order discontinuous Galerkin discretization + Runge-Kutta
                    dgp2            Select 3nd-order discontinuous Galerkin discretization + Runge-Kutta
                  diagcg            Select continuous Galerkin + Lax Wendroff with a lumped-mass matrix LHS
             diagnostics            Specify the diagnostics file name
             diffusivity    real(s) Set PDE parameter(s) diffusivity
                      dt       real Select constant time step size
                  dtfreq        int Set mesh refinement frequency during time stepping
                   dtref     string Enable mesh refinement at t>0
           dtref_uniform     string Enable mesh refinement at t>0 but only perform uniform refinement
                   dvcfl       real Set the volume-change Courant-Friedrichs-Lewy (CFL) coefficient
                edgelist   two ints Configure edge-node pairs for initial refinement
                    elem            Specify elem-centering for output
                     end            End of an input block
                  energy       real Specify energy per unit mass
          energy_content       real Specify energy per unit volume
                     eos     string Select equation of state (type)
                   error     string Configure the error type for solution-adaptive mesh refinement
                   euler     string Specify the Euler (inviscid) compressible flow physics configuration
                exodusii            Select ExodusII output
                     fct     string Turn flux-corrected transport on/off
                 fctclip     string Turn on clipping flux-corrected transport on/off
                  fcteps       real A number that is considered small enough for FCT
            field_output            Start of field_output input block
                filename     string Set filename
                filetype     string Select output file type
                   fixed            Select the fixed ASCII floating-point output
                   fluid            Select the fluid velocity for ALE
                    flux     string Select flux function
                      fn    real(s) Specify a discrete user-defined function
                  fntype     string Select how a user-defined function is interpreted
                  format     string Specify the ASCII floating-point output format
                   gamma       real ratio of specific heats
              gauss_hump     string Select advection of 2D Gaussian hump test problem
     gauss_hump_compflow     string Select advection of 2D Gaussian hump test problem
               helmholtz            Select the Helmholtz velocity for ALE
                 hessian            Error estimation based on the Hessian normalized by solution value
          history_output            Start of history_output input block
                     hll            Select the Harten-Lax-vanLeer (HLL) flux function
                    hllc            Select the Harten-Lax-van Leer-Contact (HLLC) flux function
                    hsfc            Select Hilbert Space Filling Curve (HSFC) mesh partitioner
                      ic            Select initial-conditions-based initial mesh refinement
                      id       uint ID
                 impulse            Select the impulse initiation type, e.g., for a box IC
                 inciter            Start configuration block for inciter
               indicator     string Configure the specific  adaptive indicator for p-adaptive DG scheme
                 initial     string Configure initial mesh refinement (before time stepping)
                initiate     string Initiation/assignemt type
     interface_advection     string Select the interface advection test problem 
                interval       uint Set interval (in units of iteration count)
                intsharp     string Turn multi-material interface sharpening on/off
          intsharp_param       real Parameter for multi-material interface sharpening
                    jump            Error estimation based on the jump in the solution normalized by solution
                     jwl            Select the JWL equation of state
                       k       real heat conductivity
                   kappa       real Set PDE parameter(s) kappa
                      l2     string Select the L2 norm
                  lambda    real(s) Set PDE parameter(s) lambda
                 laplace            Select the Laplace mesh velocity smoother for ALE
           laxfriedrichs            Select Lax-Friedrichs flux function
                 limiter     string Select limiter function
                  linear            Select the linear initiation type, e.g., for a box IC
                    linf     string Select the L_{infinity} norm
                location    real(s) Configure location
                     lua            Introduce a lua ... end block to inject lua code in control files
                    mass       real Specify mass
                material            Start configuration block for material properties
      material_indicator            Request material_indicator
              materialid       uint Specify material id
                   maxit        int Set the max number of iterations for the mesh velocity linear solve for ALE
                    mesh            Start configuration block assigning a mesh to a solver
              mesh_force    real(s) Set ALE mesh force model parameter(s)
             mesh_motion   integers Specify a list of scalar dimension indices that are allowed to move in ALE calculations
           mesh_velocity     string Select mesh velocity
                      mj            Select multi-jagged (MJ) mesh partitioner
                    move            Start configuration block configuring surface movement
                      mu       real dynamic viscosity
                multimat            Start configuration block for the multi-material compressible flow equations
            navierstokes     string Specify the Navier-Stokes (viscous) compressible flow physics configuration
                   ncomp       uint Set number of scalar components for a system of differential equations
                 ndofmax        int Configure the maximum number of degree of freedom for p-adaptive DG scheme
        nl_energy_growth     string Select the nonlinear energy growth test problem 
                    nmat       uint Set number of materials for a system of differential equations
                    node            Specify node-centering for output
               nolimiter            No limiter used
          non_conformity            Select the non-conformity indicator for p-adaptive DG scheme
                    none            Select none option
                    npar       uint Set total number of particles
                   nstep       uint Set number of time steps to take
        operator_reorder     string Operator-access reorder
             orientation    real(s) Configure orientation
                      p0       real Set PDE parameter(s) p0
                    p0p1            Select 2nd-order finite volume discretization + Runge-Kutta
            partitioning            Start configuration block for mesh partitioning
                     pdg            Select adaptive discontinuous Galerkin discretization + Runge-Kutta
         pelocal_reorder     string PE-local reorder
                     phg            Select parallel hypergraph mesh partitioner
                 physics     string Specify the physics configuration for a system of PDEs
                   point    3 reals Specify a point
                position            Introduce the (particle) position equation input block or coupling
               precision        int Precision in digits for ASCII floating-point output
                    pref            Start configuration block configuring p-adaptive refinement
                  prelax     string Turn multi-material finite pressure relaxation on/off
        prelax_timescale       real Time-scale for multi-material finite pressure relaxation
                pressure            Request pressure
                 problem     string Specify problem configuration for a partial differential equation solver
                  pstiff       real EoS stiffness parameter
                      r0       real Set PDE parameter(s) r0
                  radius       real Specify a radius
         rayleigh_taylor     string Select the Rayleigh-Taylor test problem 
                     rcb            Select recursive coordinate bisection mesh partitioner
               reference  character Specify mesh transformation relative to a mesh of another solver
                 refined     string Turn refined field output on/off
                  refvar    strings Configure dependent variables used for adaptive mesh refinement
                 rescomp       uint Equation system component index for convergence
                residual       real Set the convergence criterion for the residual to reach
                     rib            Select recursive inertial bisection mesh partitioner
                    root            Select Root output
                  scheme     string Select discretization scheme
              scientific            Select the scientific ASCII floating-point output
         sedov_blastwave     string Select the Sedov blast-wave test problem 
              shear_diff     string Select the shear + diffusion test problem 
           shedding_flow     string Select the Shedding flow test problem 
          shock_hebubble     string Select the shock He-bubble test problem 
                 sideset    strings Specify configuration for setting BC on a side set
                    sine            Prescribe sinusoidal mesh velocity for ALE
                slot_cyl     string Select Zalesak's slotted cylinder test problem
                smoother     string Select mesh velocity smoother
           sod_shocktube     string Select the Sod shock-tube test problem 
          spectral_decay            Select the spectral-decay indicator for p-adaptive DG scheme
                  sponge            Start configuration block describing a sponge boundary
            steady_state     string March to steady state
            stiffenedgas            Select the stiffened gas equation of state
              superbeep1            Select the Superbee limiter for DGP1
                  sysfct     string Turn on system nature of flux-corrected transport
               sysfctvar   integers Specify a list of scalar component indices that considered for system FCT
                      t0       real Set starting non-dimensional time
                   t0ref     string Enable mesh refinement at t<0
            taylor_green     string Select the Taylor-Green test problem 
             temperature       real Specify temperature
                    term       real Set maximum non-dimensional time to simulate
           time_interval       real Set interval (in units of physics time)
              time_range    3 reals Configure physics time range for output (in units of physics time)
                   title     string Set analysis title
            tol_derefine       real Configure derefine tolerance
              tol_refine       real Configure refine tolerance
               tolerance       real Set the tolerance for the mesh velocity linear solve for ALE
                  tolref       real Configure the tolerance for p-refinement for the p-adaptive DG scheme
               transport            Start configuration block for an transport equation
                    ttyi       uint Set screen output interval
                      u0    real(s) Set PDE parameter(s) u0
           underwater_ex     string Select the underwater explosion test problem 
                 uniform            Select uniform initial mesh refinement
        uniform_derefine            Select uniform initial mesh de-refinement
                  upwind            Select the upwind flux function
            user_defined     string Select user-defined specification for a problem
                     var            Start of var ... end input block
                   veleq     string Specify the multi-material  compressible flow with velocity equilibrium as physics configuration
                velocity    real(s) Specify velocity
           vertexbasedp1            Select the vertex-based limiter for DGP1
           vortical_flow     string Select the vortical flow test problem 
                vortmult       real Configure vorticity multiplier for ALE mesh velocity
      waterair_shocktube     string Select the water-air shock-tube test problem 
                  wenop1            Select the Weighted Essentially Non-Oscillatory (WENO) limiter for DGP1
                      x+       real Configure initial refinement for coordinates larger than an x-normal plane
                      x-       real Configure initial refinement for coordinates lower than an x-normal plane
              x-momentum            Request x-momentum
              x-velocity            Request x-velocity
                    xmax       real Maximum x coordinate
                    xmin       real Minimum x coordinate
                      y+       real Configure initial refinement for coordinates larger than an y-normal plane
                      y-       real Configure initial refinement for coordinates lower than an y-normal plane
              y-momentum            Request y-momentum
              y-velocity            Request y-velocity
                    ymax       real Maximum y coordinate
                    ymin       real Minimum y coordinate
                      z+       real Configure initial refinement for coordinates larger than an z-normal plane
                      z-       real Configure initial refinement for coordinates lower than an z-normal plane
              z-momentum            Request z-momentum
              z-velocity            Request z-velocity
                    zmax       real Maximum z coordinate
                    zmin       real Minimum z coordinate

Detailed description of control file keywords

Keyword 'acceleration'

Specify acceleration

This keyword is used as a keyword that selects acceleration in some other context-specific way, e.g., as opposed to 'velocity' or 'position'.

Keyword 'advdiff'

Specify the advection + diffusion physics configuration for a PDE

This keyword is used to select the advection +diffusion physics configuration for a PDE. Example: "transport physics advdiff end"

Expected type: string

Keyword 'advection'

Specify the advection physics configuration for a PDE

This keyword is used to select the advection physics configuration for a PDE. Example: "transport physics advection end"

Expected type: string

Keyword 'ale'

Start configuration block configuring ALE

This keyword is used to introduce the ale ... end block, used to configure arbitrary Lagrangian-Eulerian (ALE) mesh movement. Keywords allowed in this block: 'vortmult' | 'maxit' | 'tolerance' | 'bc_dirichlet' | 'bc_sym' | 'mesh_force' | 'mesh_velocity'.

Keyword 'alecg'

Select continuous Galerkin with ALE + Runge-Kutta

This keyword is used to select the continuous Galerkin finite element scheme in the arbitrary Lagrangian-Eulerian (ALE) reference frame combined with Runge-Kutta (RK) time stepping. See Control/Inciter/Options/Scheme.hpp for other valid options.

Keyword 'algorithm'

Select mesh partitioning algorithm

This keyword is used to select a mesh partitioning algorithm. See Control/Options/PartitioningAlgorithm.hpp for valid options.

Expected type: string

Expected valid choices: 'rcb' | 'rib' | 'hsfc' | 'mj' | 'phg'

Keyword 'alpha'

Set PDE parameter(s) alpha

This keyword is used to specify a real number used to parameterize a system of partial differential equations. Example: "alpha 5.0".

Expected type: real

Keyword 'amr'

Start configuration block configuring adaptive mesh refinement

This keyword is used to introduce the amr ... end block, used to configure adaptive mesh refinement. Keywords allowed in this block: 't0ref' | 'dtref' | 'dtref_uniform' | 'dtfreq' | 'initial' | 'refvar' | 'tol_refine' | 'tol_derefine' | 'error' | 'coords' | 'edgelist'.

Keyword 'analytic'

Request analytic solution

This keyword is used to request the analytic solution (if exist) as an output variable.

Keyword 'ausm'

Select the Advection Upstream Splitting Method (AUSM) flux function

This keyword is used to select the AUSM flux function used for discontinuous Galerkin (DG) spatial discretization used in inciter. It is only used for for multi-material hydro, it is thus not selectable for anything else, and for multi-material hydro it is the hardcoded flux type.

Keyword 'bc_dirichlet'

Start configuration block describing Dirichlet boundary conditions

This keyword is used to introduce an bc_dirichlet ... end block, used to specify the configuration for setting Dirichlet boundary conditions (BC) for a partial differential equation. This keyword is used to list multiple side sets on which a prescribed Dirichlet BC is then applied. Such prescribed BCs at each point in space and time are evaluated using a built-in function, e.g., using the method of manufactured solutions. Keywords allowed in a bc_dirichlet ... end block: 'sideset'. For an example bc_dirichlet ... end block, see doc/html/inicter_example_shear.html.

Keyword 'bc_extrapolate'

Start configuration block describing Extrapolation boundary conditions

This keyword is used to introduce a bc_extrapolate ... end block, used to specify the configuration for setting extrapolation boundary conditions for a partial differential equation. Keywords allowed in a bc_extrapolate ... end block: 'sideset'. For an example bc_extrapolate ... end block, see doc/html/inciter_example_gausshump.html.

Keyword 'bc_farfield'

Start configuration block describing farfield boundary conditions

This keyword is used to introduce a bc_farfield ... end block, used to specify the configuration for setting farfield boundary conditions for the compressible flow equations. Keywords allowed in a bc_farfield ... end block: 'density', 'pressure', 'velocity', 'sideset'.

Keyword 'bc_inlet'

Start configuration block describing inlet boundary conditions

This keyword is used to introduce an bc_inlet ... end block, used to specify the configuration for setting inlet boundary conditions for a partial differential equation. Keywords allowed in a bc_inlet ... end block: 'sideset'. For an example bc_inlet ... end block, see doc/html/inicter_example_gausshump.html.

Keyword 'bc_outlet'

Start configuration block describing outlet boundary conditions

This keyword is used to introduce an bc_outlet ... end block, used to specify the configuration for setting outlet boundary conditions for a partial differential equation. Keywords allowed in a bc_outlet ... end block: 'sideset'. For an example bc_outlet ... end block, see doc/html/inicter_example_gausshump.html.

Keyword 'bc_skip'

Start configuration block describing skip boundary conditions

This keyword is used to introduce an bc_skip ... end block, used to specify the configuration for setting 'skip' boundary conditions for a partial differential equation. If a mesh point falls into a skip region, configured by a point and a radius, any application of boundary conditions on those points will be skipped. Keywords allowed in a bc_skip ... end block: 'point', 'radius'.

Keyword 'bc_stag'

Start configuration block describing stagnation boundary conditions

This keyword is used to introduce an bc_stag ... end block, used to specify the configuration for setting stagnation boundary conditions for a partial differential equation. Keywords allowed in a bc_stag ... end block: 'point', 'radius'.

Keyword 'bc_sym'

Start configuration block describing symmetry boundary conditions

This keyword is used to introduce an bc_sym ... end block, used to specify the configuration for setting symmetry boundary conditions for a partial differential equation. Keywords allowed in a bc_sym ... end block: 'sideset'. For an example bc_sym ... end block, see doc/html/inicter_example_gausshump.html.

Keyword 'bc_timedep'

Start configuration block describing time dependent boundary conditions

This keyword is used to introduce a bc_timedep ... end block, used to specify the configuration of time dependent boundary conditions for a partial differential equation. A discrete function in time t in the form of a table with 6 columns (t, pressure(t), density(t), vx(t), vy(t), vz(t)) is expected inside a fn ... end block, specified within the bc_timedep ... end block. Multiple such bc_timedep blocks can be specified for different time dependent BCs on different groups of side sets. Keywords allowed in a bc_timedep ... end block: 'sideset', 'fn'. For an example bc_timedep ... end block, see tests/regression/inciter/compflow/Euler/TimedepBC/timedep_bc.q.

Keyword 'beta'

Set PDE parameter(s) beta

This keyword is used to specify a real number used to parameterize a system of partial differential equations. Example: "beta 5.0".

Expected type: real

Keyword 'betax'

Set PDE parameter(s) betax

This keyword is used to specify a real number used to parameterize a system of partial differential equations. Example: "betax 1.0".

Expected type: real

Keyword 'betay'

Set PDE parameter(s) betay

This keyword is used to specify a real number used to parameterize a system of partial differential equations. Example: "betay 0.75".

Expected type: real

Keyword 'betaz'

Set PDE parameter(s) betaz

This keyword is used to specify a real number used to parameterize a system of partial differential equations. Example: "betaz 0.5".

Expected type: real

Keyword 'box'

Introduce a box ... end block used to assign initial conditions

This keyword is used to introduce a box ... end block used to assign initial conditions within a box given by spatial coordinates. Example: box x- 0.5 x+ 1.5 y- -0.5 y+ 0.5 z- -0.5 z+ 0.5 density 1.2 end pressure 1.4 end end", which specifies a box with extends within which the density will be set to 1.2 and the pressure to be 1.4. Besides the box dimensions, the following physics keywords are allowed in a box ... end block:'materialid', 'mass', 'density', 'velocity', 'energy', 'energy_content', 'temperature', 'pressure'.

Keyword 'ce'

Set PDE parameter(s) ce

This keyword is used to specify a real number used to parameterize the Euler equations solving the manufactured solution test case "non-linear energy growth". Example: "ce -1.0". For more information on the test case see Waltz, et. al, "Manufactured solutions for the three-dimensional Euler equations with relevance to Inertial Confinement Fusion", Journal of Computational Physics 267 (2014) 196-209.

Expected type: real

Keyword 'cfl'

Set the Courant-Friedrichs-Lewy (CFL) coefficient

This keyword is used to specify the CFL coefficient for variable-time-step-size simulations. Setting 'cfl' and 'dt' are mutually exclusive. If both 'cfl' and 'dt' are set, 'dt' wins.

Expected type: real

Lower bound: 0.000000

Keyword 'compflow'

Start configuration block for the compressible flow equations

This keyword is used to introduce the compflow ... end block, used to specify the configuration for a system of partial differential equations, governing compressible fluid flow. Keywords allowed in an compflow ... end block: 'depvar', 'physics', 'problem', 'material', 'npar', 'alpha', 'p0', 'betax', 'betay', 'betaz', 'beta', 'r0', 'ce', 'kappa', 'bc_dirichlet', 'bc_sym', 'bc_inlet', 'bc_outlet', 'bc_farfield', 'bc_extrapolate'.bc_timedep'.For an example compflow ... end block, see doc/html/inicter_example_compflow.html.

Keyword 'coords'

Configure initial refinement using coordinate planes

This keyword can be used to configure entire volumes on a given side of a plane in 3D space. The keyword introduces an coords ... end block within an amr ... end block and must contain the either or multiple of the following keywords: x- <real>, x+ <real>, y- <real>, y+ <real>, z- <real>, z+ <real>. All edges of the input mesh will be tagged for refinement whose end-points lie less than (-) or larger than (+) the real number given. Example: 'x- 0.5' refines all edges whose end-point coordinates are less than 0.5. Multiple specifications are understood by combining with a logical AND. That is: 'x- 0.5 y+ 0.3' refines all edges whose end-point x coordinates are less than 0.5 AND y coordinates are larger than 0.3.

Keyword 'couple'

Specify coupling of solvers on different meshes

This keyword is used to introduce a couple ... end block, used to specify coupling of solvers operating on different meshes.

Keyword 'ctau'

Set FCT mass diffusion coefficient, ctau

This keyword is used to set the mass diffusion coefficient used in flux-corrected transport, used for integrating transport equations. Example: "ctau 1.0".

Expected type: real

Lower bound: 0.000000

Upper bound: 1.000000

Expected valid choices: real between [0.000000...1.000000]

Keyword 'cv'

specific heat at constant volume

This keyword is used to specify the material property, specific heat at constant volume.

Expected type: real

Lower bound: 0.000000

Keyword 'cweight'

Set value for central linear weight used by WENO, cweight

This keyword is used to set the central linear weight used for the central stencil in the Weighted Essentially Non-Oscillatory (WENO) limiter for discontinuous Galerkin (DG) methods. Example: "cweight 10.0".

Expected type: real

Lower bound: 1.000000

Upper bound: 1000.000000

Expected valid choices: real between [1.000000...1000.000000]

Keyword 'cyl_advect'

Select advection of cylinder test problem

This keyword is used to select the advection of cylinder test problem. The initial and boundary conditions are specified to set up the test problem suitable to exercise and test the advection terms of the scalar transport equation. Example: "problem cyl_advect".

Expected type: string

Keyword 'cyl_vortex'

Select deformation of cylinder in a vortex test problem

This keyword is used to select the test problem which deforms a cylinder in a vortical velocity field. The initial and boundary conditions are specified to set up the test problem suitable to exercise and test the advection terms of the scalar transport equation. Example: "problem cyl_vortex".

Expected type: string

Keyword 'default'

Select the default ASCII floating-point output

This keyword is used to select the 'default' floating-point output format for ASCII floating-point real number output. Example: "format default", which selects the default floating-point output. Valid options are 'default', 'fixed', and 'scientific'. For more info on these various formats, see http://en.cppreference.com/w/cpp/io/manip/fixed.

Keyword 'density'

Request density

This keyword is used to request the fluid density as an output variable.

Keyword 'depvar'

Select dependent variable (in a relevant block)

Dependent variable, e.g, in differential equations.

Expected type: character

Keyword 'dg'

Select 1st-order discontinuous Galerkin discretization + Runge-Kutta

This keyword is used to select the first-order accurate discontinuous Galerkin, DG(P0), spatial discretiztaion used in Inciter. As this is first order accurate, it is intended for testing and debugging purposes only. Selecting this spatial discretization also selects the Runge-Kutta scheme for time discretization. See Control/Inciter/Options/Scheme.hpp for other valid options.

Keyword 'dgp1'

Select 2nd-order discontinuous Galerkin discretization + Runge-Kutta

This keyword is used to select the second-order accurate discontinuous Galerkin, DG(P1), spatial discretiztaion used in Inciter. Selecting this spatial discretization also selects the Runge-Kutta scheme for time discretization. See Control/Inciter/Options/Scheme.hpp for other valid options.

Keyword 'dgp2'

Select 3nd-order discontinuous Galerkin discretization + Runge-Kutta

This keyword is used to select the third-order accurate discontinuous Galerkin, DG(P2), spatial discretiztaion used in Inciter. Selecting this spatial discretization also selects the Runge-Kutta scheme for time discretization. See Control/Inciter/Options/Scheme.hpp for other valid options.

Keyword 'diagcg'

Select continuous Galerkin + Lax Wendroff with a lumped-mass matrix LHS

This keyword is used to select the lumped-mass matrix continuous Galerkin (CG) finite element spatial discretiztaion used in inciter. CG is combined with a Lax-Wendroff scheme for time discretization and flux-corrected transport (FCT) for treating discontinuous solutions. This option selects the scheme that stores the left-hand side matrix lumped, i.e., only the diagonal elements stored and thus does not require a linear solver. See Control/Inciter/Options/Scheme.hpp for other valid options.

inciter command-line keyword -d, –diagnostics

Specify the diagnostics file name

This option is used to define the diagnostics file name.

Expected type: string

Keyword 'diffusivity'

Set PDE parameter(s) diffusivity

This keyword is used to specify a vector of real numbers used to parameterize a system of partial differential equations. Example: "diffusivity 5.0 2.0 3.0 end". The length of the vector depends on the particular type of PDE system and is controlled by the preceding keyword 'ncomp'.

Expected type: real(s)

Keyword 'dt'

Select constant time step size

This keyword is used to specify the time step size that used as a constant during simulation. Setting 'cfl' and 'dt' are mutually exclusive. If both 'cfl' and 'dt' are set, 'dt' wins.

Expected type: real

Lower bound: 0.000000

Keyword 'dtfreq'

Set mesh refinement frequency during time stepping

This keyword is used to configure the frequency of mesh refinement during time stepping. The default is 3, which means that mesh refinement will be performed every 3rd time step.

Expected type: int

Lower bound: 1

Upper bound: 18446744073709551615

Expected valid choices: integer between [1...18446744073709551615] (both inclusive)

Keyword 'dtref'

Enable mesh refinement at t>0

This keyword is used to enable soution-adaptive mesh refinement during " "time stepping.

Expected type: string

Expected valid choices: true | false

Keyword 'dtref_uniform'

Enable mesh refinement at t>0 but only perform uniform refinement

This keyword is used to force uniform-only soution-adaptive mesh refinement during time stepping.

Expected type: string

Expected valid choices: true | false

Keyword 'dvcfl'

Set the volume-change Courant-Friedrichs-Lewy (CFL) coefficient

This keyword is used to specify the volume-change (dV/dt) CFL coefficient for variable-time-step-size simulations due to volume change in time in arbitrary-Lagrangian-Eulerian (ALE) calculations. Setting 'dvcfl' only has effect in ALE calculations and used together with 'cfl'. See also J. Waltz, N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A three-dimensional finite element arbitrary Lagrangian–Eulerian method for shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187,

Expected type: real

Lower bound: 0.010000

Keyword 'edgelist'

Configure edge-node pairs for initial refinement

This keyword can be used to configure a list of edges that are explicitly tagged for initial refinement during setup in inciter. The keyword introduces an edgelist ... end block within an amr ... end block and must contain a list of integer pairs, i.e., the number of ids must be even, denoting the end-points of the nodes (=edge) which should be tagged for refinement.

Expected type: two ints

Lower bound: 0

Keyword 'elem'

Specify elem-centering for output

This keyword is used to select elem-centering for variable output. In walker for example, this is used to configure probability values on the sample space grid for file output of probability density functions (PDFs). Example: "centering elem", which selects element-centered values. Valid options are 'elem' and 'node', denoting cell-centered and point-centered output, respectively. In inciter this keyword is used in output variable specification blocks, prefixing variable names by either 'node' or 'elem', to specify their centering for output to file.

Keyword 'end'

End of an input block

The end of a block is given by the 'end' keyword in the input file. Example: "rngs ... end".

Keyword 'energy'

Specify energy per unit mass

This keyword is used to configure energy per unit mass, used for, e.g., boundary or initial conditions.

Expected type: real

Keyword 'energy_content'

Specify energy per unit volume

This keyword is used to configure energy per unit volume, used for, e.g., boundary or initial conditions.

Expected type: real

Keyword 'eos'

Select equation of state (type)

This keyword is used to select an equation of state for a material.

Expected type: string

Expected valid choices: 'stiffenedgas' | 'jwl'

Keyword 'error'

Configure the error type for solution-adaptive mesh refinement

This keyword is used to select the algorithm used to estimate the error for solution-adaptive mesh refinement.

Expected type: string

Expected valid choices: 'jump' | 'hessian'

Keyword 'euler'

Specify the Euler (inviscid) compressible flow physics configuration

This keyword is used to select the Euler (inviscid) compressible flow physics configuration. Example: "compflow physics euler end"

Expected type: string

Keyword 'exodusii'

Select ExodusII output

This keyword is used to select the ExodusII output file type readable by, e.g., ParaView of either a requested probability density function (PDF) within a pdfs ... end block or for mesh-based field output in a field_output ... end block. Example: "filetype exodusii", which selects ExodusII file output. For more info on ExodusII, see http://sourceforge.net/projects/exodusii.

Keyword 'fct'

Turn flux-corrected transport on/off

This keyword can be used to turn on/off flux-corrected transport (FCT). Note that FCT is only used in conjunction with continuous Galerkin finite element discretization, configured by scheme diagcg and it has no effect when the discontinuous Galerkin (DG) scheme is used, configured by 'scheme dg'. Also note that even if FCT is turned off, it is still performed, only its result is not applied.

Expected type: string

Expected valid choices: true | false

Keyword 'fctclip'

Turn on clipping flux-corrected transport on/off

This keyword can be used to turn on/off the clipping limiter used for flux-corrected transport (FCT). The clipping limiter only looks at the current low order solution to determine the allowed solution minima and maxima, instead of the minimum and maximum of the low order solution and the previous solution.

Expected type: string

Expected valid choices: true | false

Keyword 'fcteps'

A number that is considered small enough for FCT

This keyword is used to set the epsilon (a small number) below which FCT quantities are considered small enough to be treated as zero. Setting this number to be somewhat larger than the machine zero, e.g., 1.0e-15, helps ignoring some noise that otherwise could contaminate the solution.

Expected type: real

Lower bound: 0.000000

Upper bound: 1.000000

Expected valid choices: real between [0.000000...1.000000]

Keyword 'field_output'

Start of field_output input block

This keyword is used to start a block in the input file containing the list and settings of requested field output.

Keyword 'filename'

Set filename

Set filename, e.g., mesh filename for solver coupling.

Expected type: string

Keyword 'filetype'

Select output file type

This keyword is used to specify the output file type of a requested probability density function (PDF) within a pdfs ... end block or for mesh-based field output in a field_output ... end block. Example: "filetype exodusii", which selects ExodusII output. Valid options depend on which block the keyword is used: in a pdfs ... end the valid choices are 'txt', 'gmshtxt', 'gmshbin', and 'exodusii', in a field_output ... end block the valid choices are 'exodusii' and 'root'.

Expected type: string

Expected valid choices: 'txt' | 'gmshtxt' | 'gmshbin' | 'root' | 'exodusii'

Keyword 'fixed'

Select the fixed ASCII floating-point output

This keyword is used to select the 'fixed' floating-point output format for ASCII floating-point real number output. Example: "format fixed", which selects the fixed floating-point output. Valid options are 'default', 'fixed', and 'scientific'. For more info on these various formats, see http://en.cppreference.com/w/cpp/io/manip/fixed.

Keyword 'fluid'

Select the fluid velocity for ALE

This keyword is used to select the 'fluid' velocity as the mesh velocity for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.

Keyword 'flux'

Select flux function

This keyword is used to select a flux function, used for discontinuous Galerkin (DG) spatial discretization used in inciter. See Control/Inciter/Options/Flux.hpp for valid options.

Expected type: string

Expected valid choices: 'laxfriedrichs' | 'hllc' | 'upwind' | 'ausm' | 'hll'

Keyword 'fn'

Specify a discrete user-defined function

This keyword is used to specify a user-defined function with discrete points, listed between a fn ... end block.

Expected type: real(s)

Keyword 'fntype'

Select how a user-defined function is interpreted

This keyword is used to select how a user-defined function should be interpreted.

Expected type: string

Keyword 'format'

Specify the ASCII floating-point output format

This keyword is used to select the floating-point output format for ASCII floating-point number output. Example: "format scientific", which selects the scientific floating-point output. Valid options are 'default', 'fixed', and 'scientific'. For more info on these various formats, see http://en.cppreference.com/w/cpp/io/manip/fixed.

Expected type: string

Expected valid choices: 'default' | 'scientific' | 'fixed'

Keyword 'gamma'

ratio of specific heats

This keyword is used to specify the material property, ratio of specific heats.

Expected type: real

Lower bound: 0.000000

Keyword 'gauss_hump'

Select advection of 2D Gaussian hump test problem

This keyword is used to select the advection of 2D Gaussian hump test problem. The initial and boundary conditions are specified to set up the test problem suitable to exercise and test the advection terms of the scalar transport equation. Example: "problem gauss_hump".

Expected type: string

Keyword 'gauss_hump_compflow'

Select advection of 2D Gaussian hump test problem

This keyword is used to select the advection of 2D Gaussian hump test problem. The initial and boundary conditions are specified to set up the test problem suitable to exercise and test the advection terms of the Euler equations. The baseline of the density distribution in this testcase is 1 instead of 0 in gauss_hump_transport which enables it to be the regression testcase for p-adaptive DG scheme. Example: "problem gauss_hump_compflow".

Expected type: string

Keyword 'helmholtz'

Select the Helmholtz velocity for ALE

This keyword is used to select the a velocity, computed from the Helmholtz-decomposition as the mesh velocity for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion. See J. Bakosi, J. Waltz, N. Morgan, Improved ALE mesh velocities for complex flows, Int. J. Numer. Meth. Fl., 1-10, 2017, https://doi.org/10.1002/fld.4403.

Keyword 'hessian'

Error estimation based on the Hessian normalized by solution value

This keyword is used to select the Hessian-based error indicator for solution-adaptive mesh refinement. The error is estimated by computing the Hessian (2nd derivative matrix) of the solution normalized by sum of the absolute values of the gradients at edges-end points.

Keyword 'history_output'

Start of history_output input block

This keyword is used to start a block in the input file containing the descriptions and settings of requested history output.

Keyword 'hll'

Select the Harten-Lax-vanLeer (HLL) flux function

This keyword is used to select the HLL flux function used for discontinuous Galerkin (DG) spatial discretization used in inciter. It is only used for for multi-material hydro, it is thus not selectable for anything else, and for multi-material hydro it is the hardcoded flux type.

Keyword 'hllc'

Select the Harten-Lax-van Leer-Contact (HLLC) flux function

This keyword is used to select the Harten-Lax-van Leer-Contact flux function used for discontinuous Galerkin (DG) spatial discretization used in inciter. See Control/Inciter/Options/Flux.hpp for other valid options.

Keyword 'hsfc'

Select Hilbert Space Filling Curve (HSFC) mesh partitioner

This keyword is used to select the Hilbert Space Filling Curve (HSFC) mesh partitioner. HSFC is a geometry-based partitioner used to distribute an input mesh among processing elements. See Control/Options/PartitioningAlgorithm.hpp for other valid options.

Keyword 'ic'

Select initial-conditions-based initial mesh refinement

This keyword is used to select initial-conditions-based initial mesh refinement.

Keyword 'id'

ID

This keyword is used to specify an ID, a positive integer.

Expected type: uint

Lower bound: 1

Keyword 'impulse'

Select the impulse initiation type, e.g., for a box IC

This keyword can be used to select the 'impulse' initiation/assignment type for box initial conditions. It simply assigns the prescribed values to mesh points within a configured box at t=0.

Keyword 'inciter'

Start configuration block for inciter

This keyword is used to select inciter. Inciter, is a continuum-realm shock hydrodynamics tool, solving a PDE.

Keyword 'indicator'

Configure the specific adaptive indicator for p-adaptive DG scheme

This keyword can be used to configure a specific type of adaptive indicator for p-adaptive refinement of the DG scheme. The keyword must be used in pref ... end block. Example specification: 'indicator 1'.

Expected type: string

Expected valid choices: 'spectral_decay' | 'non_conformity'

Keyword 'initial'

Configure initial mesh refinement (before time stepping)

This keyword is used to add to a list of initial mesh refinement types that happens before t = 0. Example: initial uniform initial ic inital uniform, which yiedls an initial uniform refinement, followed by a refinement based on the numerical error computed based on the initial conditions, followed by another step of unfirom refinement.

Expected type: string

Expected valid choices: 'uniform' | 'uniform_derefine' | 'ic' | 'edgelist' | 'coords'

Keyword 'initiate'

Initiation/assignemt type

This keyword is used to select an initiation type to configure how values are assigned, e.g., for a box initial condition. This can be used to specify, how the values are assigned to mesh nodes within a box. Examples: (1) impulse: assign the full values at t=0 for all points in a box, (2) linear: use a linear function in time and space, configured with an initiation point in space, an initial radius around the point, and a velocity that grows a sphere in time (and space) linearly and assigns values to mesh points falling within a growing sphere within a configured box.

Expected type: string

Expected valid choices: 'impulse' | 'linear'

Keyword 'interface_advection'

Select the interface advection test problem

This keyword is used to select the interface advection test problem. The purpose of this test problem is to test the well-balancedness of the multi-material discretization and its interface capturing capabilities. Example: "problem interface_advection".

Expected type: string

Keyword 'interval'

Set interval (in units of iteration count)

This keyword is used to specify an interval in units of iteration count (i.e., number of time steps). This must be used within a relevant block.

Expected type: uint

Lower bound: 0

Keyword 'intsharp'

Turn multi-material interface sharpening on/off

This keyword is used to turn interface sharpening on/off. It uses the multi-material THINC interface reconstruction. Ref. Pandare A. K., Waltz J., & Bakosi J. (2021) Multi-Material Hydrodynamics with Algebraic Sharp Interface Capturing. Computers & Fluids, doi: https://doi.org/10.1016/j.compfluid.2020.104804. It is used for the multi-material and the transport solver, and has no effect when used for the other PDE types.

Expected type: string

Expected valid choices: 1 | 0

Keyword 'intsharp_param'

Parameter for multi-material interface sharpening

This keyword is used to specify the parameter for the interface sharpening. This parameter affects how many cells the material interfaces span, after the use of sharpening. It is used for multimat and transport, and has no effect for the other PDE types.

Expected type: real

Lower bound: 0.100000

Keyword 'jump'

Error estimation based on the jump in the solution normalized by solution

This keyword is used to select the jump-based error indicator for solution-adaptive mesh refinement. The error is estimated by computing the magnitude of the jump in the solution value normalized by the solution value.

Keyword 'jwl'

Select the JWL equation of state

This keyword is used to select the Jones, Wilkins, Lee equation of state.

Keyword 'k'

heat conductivity

This keyword is used to specify the material property, heat conductivity.

Expected type: real

Lower bound: 0.000000

Keyword 'kappa'

Set PDE parameter(s) kappa

This keyword is used to specify a real number used to parameterize a system of partial differential equations. Example: "kappa 0.8"

Expected type: real

Keyword 'l2'

Select the L2 norm

This keyword is used to enable computing the L2 norm. Example: "diagnostics error l2 end'."

Expected type: string

Keyword 'lambda'

Set PDE parameter(s) lambda

This keyword is used to specify a vector of real numbers used to parameterize a system of partial differential equations. Example: "lambda 5.0 2.0 3.0 end". The length of the vector depends on the particular type of PDE system and is controlled by the preceding keyword 'ncomp'.

Expected type: real(s)

Keyword 'laplace'

Select the Laplace mesh velocity smoother for ALE

This keyword is used to select the 'Laplace' mesh velocity smoother for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.

Keyword 'laxfriedrichs'

Select Lax-Friedrichs flux function

This keyword is used to select the Lax-Friedrichs flux function used for discontinuous Galerkin (DG) spatial discretization used in inciter. See Control/Inciter/Options/Flux.hpp for other valid options.

Keyword 'limiter'

Select limiter function

This keyword is used to select a limiter function, used for discontinuous Galerkin (DG) spatial discretization used in inciter. See Control/Inciter/Options/Limiter.hpp for valid options.

Expected type: string

Expected valid choices: 'nolimiter' | 'wenop1' | 'superbeep1' | 'vertexbasedp1'

Keyword 'linear'

Select the linear initiation type, e.g., for a box IC

This keyword can be used to select the 'linear' initiation/assignment type for box initial conditions. Linear initiation uses a linear function in time and space, configured with an initiation point in space, an initial radius around the point, and a constant velocity that grows a sphere in time (and space) linearly and assigns values to mesh points falling within a growing sphere within a configured box.

Keyword 'linf'

Select the L_{infinity} norm

This keyword is used to enable computing the L-infinity norm. Example: "diagnostics error linf end'."

Expected type: string

Keyword 'location'

Configure location

Configure location of a mesh relative to another, e.g., for solver coupling.

Expected type: real(s)

Keyword 'lua'

Introduce a lua ... end block to inject lua code in control files

This keyword is used to introduce a lua ... end block which can be used to inject arbitrary Lua code into control files. For more info on the lua language, see https://www.lua.org.

Keyword 'mass'

Specify mass

This keyword is used to configure the mass and associated volume within a box.

Expected type: real

Keyword 'material'

Start configuration block for material properties

This keyword is used to introduce a material ... end block, used to specify material properties. Keywords allowed in a material ... end block: 'id', 'eos', 'gamma', 'pstiff', 'mu', 'cv', 'k'. For an example material ... end block, see doc/html/inicter_example_compflow.html.

Keyword 'material_indicator'

Request material_indicator

This keyword is used to request the material indicator function as an output variable.

Keyword 'materialid'

Specify material id

This keyword is used to configure the material id within a box as a part of the initialization.

Expected type: uint

Lower bound: 1

Keyword 'maxit'

Set the max number of iterations for the mesh velocity linear solve for ALE

This keyword is used to specify the maximum number of linear solver iterations taken to converge the mesh velocity linear solve in arbitrary-Lagrangian-Eulerian (ALE) calculations. See also J. Waltz, N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A three-dimensional finite element arbitrary Lagrangian–Eulerian method for shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187,

Expected type: int

Keyword 'mesh'

Start configuration block assigning a mesh to a solver

This keyword is used to introduce a mesh ... end block, used to assign and configure a mesh to a solver.

Keyword 'mesh_force'

Set ALE mesh force model parameter(s)

This keyword is used to specify a vector of real numbers used to parameterize a mesh force model for ALE. Example: "mesh_force 1.0 2.0 3.0 4.0 end". The length of the vector must exactly 4. Everything else is an error.

Expected type: real(s)

Keyword 'mesh_motion'

Specify a list of scalar dimension indices that are allowed to move in ALE calculations

This keyword is used to specify a list of integers (0, 1, or 2) whose coordinate directions corresponding to x, y, or z are allowed to move with the mesh velocity in ALE calculations. Example: 'mesh_motion 0 1 end', which means disallow mesh motion in the z coordinate direction, useful for 2D problems in x-y.

Expected type: integers

Keyword 'mesh_velocity'

Select mesh velocity

This keyword is used to select a mesh velocity option, used for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.

Expected type: string

Expected valid choices: 'sine' | 'fluid' | 'user_defined'

Keyword 'mj'

Select multi-jagged (MJ) mesh partitioner

This keyword is used to select the multi-jagged (MJ) mesh partitioner. MJ is a geometry-based partitioner used to distribute an input mesh among processing elements. See Control/Options/PartitioningAlgorithm.hpp for other valid options.

Keyword 'move'

Start configuration block configuring surface movement

This keyword is used to introduce a move ... end block, used to configure surface movement for ALE simulations. Keywords allowed in a move ... end block: 'sideset'.

Keyword 'mu'

dynamic viscosity

This keyword is used to specify the material property, dynamic viscosity.

Expected type: real

Lower bound: 0.000000

Keyword 'multimat'

Start configuration block for the multi-material compressible flow equations

This keyword is used to introduce the multimat ... end block, used to specify the configuration for a system of partial differential equations, governing multi-material compressible fluid flow. Keywords allowed in a multimat ... end block: 'depvar', 'physics', 'problem', 'material', 'nmat', 'prelax', 'prelax_timescale', 'intsharp', 'intsharp_param', 'alpha', 'p0', 'betax', 'betay', 'betaz', 'beta', 'r0', 'ce', 'kappa', 'bc_dirichlet', 'bc_sym', 'bc_inlet', 'bc_outlet', 'bc_extrapolate'.For an example multimat ... end block, see doc/html/inicter_example_multimat.html.

Keyword 'navierstokes'

Specify the Navier-Stokes (viscous) compressible flow physics configuration

This keyword is used to select the Navier-Stokes (viscous) compressible flow physics configuration. Example: "compflow physics navierstokes end"

Expected type: string

Keyword 'ncomp'

Set number of scalar components for a system of differential equations

This keyword is used to specify the number of scalar components of a vector. 'ncomp' means "number of components". It is also used for specifying the number of scalar components of a transporter scalar (see also the keywords 'transport').

Expected type: uint

Lower bound: 1

Keyword 'ndofmax'

Configure the maximum number of degree of freedom for p-adaptive DG scheme

This keyword can be used to configure a maximum number of degree of freedom for p-adaptive refinement of the DG scheme. The keyword must be used in pref ... end block. Example specification: 'ndofmax 10'.

Expected type: int

Lower bound: 4

Upper bound: 10

Expected valid choices: int either 4 or 10

Keyword 'nl_energy_growth'

Select the nonlinear energy growth test problem

This keyword is used to select the nonlinear energy growth test problem. The purpose of this test problem is to test nonlinear, time dependent energy growth and the subsequent development of pressure gradients due to coupling between the internal energy and the equation of state. Example: "problem nl_energy_growth". For more details, see Waltz, et. al, "Manufactured solutions for the three-dimensional Euler equations with relevance to Inertial Confinement Fusion", Journal of Computational Physics 267 (2014) 196-209.

Expected type: string

Keyword 'nmat'

Set number of materials for a system of differential equations

This keyword is used to specify the number of materials, e.g., for multi-material flow, see also the keyword 'multimat' and 'veleq'.

Expected type: uint

Lower bound: 1

Keyword 'node'

Specify node-centering for output

This keyword is used to select node-centering for variable output. In walker for example, this is used to configure probability values on the sample space grid for file output of probability density functions (PDFs). Example: "centering elem", which selects element-centered values. Valid options are 'elem' and 'node', denoting cell-centered and point-centered output, respectively. In inciter this keyword is used in output variable specification blocks, prefixing variable names by either 'node' or 'elem', to specify their centering for output to file.

Keyword 'nolimiter'

No limiter used

This keyword is used for discontinuous Galerkin (DG) spatial discretization without any limiter in inciter. See Control/Inciter/Options/Limiter.hpp for other valid options.

Keyword 'non_conformity'

Select the non-conformity indicator for p-adaptive DG scheme

This keyword is used to select the non-conformity indicator used for p-adaptive discontinuous Galerkin (DG) discretization used in inciter. See Control/Inciter/Options/PrefIndicator.hpp for other valid options.

Keyword 'none'

Select none option

This keyword is used to select the 'none' option from a list of configuration options.

Keyword 'npar'

Set total number of particles

This keyword is used to specify the total number of particles in a simulation.

Expected type: uint

Lower bound: 1

Keyword 'nstep'

Set number of time steps to take

This keyword is used to specify the number of time steps to take in a simulation. The number of time steps are used in conjunction with the maximmum time specified by keyword 'term': the simulation stops whichever is reached first. Both 'nstep' and 'term' can be left unspecified, in which case their default values are used. See also 'term'.

Expected type: uint

Lower bound: 1

Keyword 'operator_reorder'

Operator-access reorder

This keyword is used in inciter as a keyword in the inciter...end block as "operator_reorder on" (or off) to do (or not do) a local mesh node reordering based on the PDE operator access pattern. This reordering is optional.

Expected type: string

Expected valid choices: true | false

Keyword 'orientation'

Configure orientation

Configure orientation of a mesh relative to another, e.g., for solver coupling.

Expected type: real(s)

Keyword 'p0'

Set PDE parameter(s) p0

This keyword is used to specify a real number used to parameterize a system of partial differential equations. Example: "p0 10.0".

Expected type: real

Keyword 'p0p1'

Select 2nd-order finite volume discretization + Runge-Kutta

This keyword is used to select the second-order accurate finite volume, P0P1, spatial discretiztaion used in Inciter. This method uses a least-squares procedure to reconstruct the second-order solution from the first-order one. Selecting this spatial discretization also selects the Runge-Kutta scheme for time discretization. See Control/Inciter/Options/Scheme.hpp for other valid options.

Keyword 'partitioning'

Start configuration block for mesh partitioning

This keyword is used to introduce a partitioning ... end block, used to specify the configuration for mesh partitioning. Keywords allowed in a partitioning ... end block: 'algorithm'.

Keyword 'pdg'

Select adaptive discontinuous Galerkin discretization + Runge-Kutta

This keyword is used to select the adaptive discontinuous Galerkin spatial discretizaion used in Inciter. Selecting this spatial discretization also selects the Runge-Kutta scheme for time discretization. See Control/Inciter/Options/Scheme.hpp for other valid options.

Keyword 'pelocal_reorder'

PE-local reorder

This keyword is used in inciter as a keyword in the inciter...end block as "pelocal_reorder true" (or false) to do (or not do) a global distributed mesh reordering across all PEs that yields an approximately continous mesh node ID order as mesh partitions are assigned to PEs after mesh partitioning. This reordering is optional.

Expected type: string

Expected valid choices: true | false

Keyword 'phg'

Select parallel hypergraph mesh partitioner

This keyword is used to select the parallel hypergraph (PHG) mesh partitioner. PHG is a graph-based partitioner used to distribute an input mesh among processing elements. See Control/Options/PartitioningAlgorithm.hpp for other valid options.

Keyword 'physics'

Specify the physics configuration for a system of PDEs

This keyword is used to select the physics configuration for a particular PDE system. Example: "physics navierstokes", which selects the Navier-Stokes equations for solving viscous compressible flow, given within the compflow ... end block. Valid options depend on the given block the keyword is used.

Expected type: string

Expected valid choices: 'advection' | 'advdiff' | 'navierstokes' | 'euler'

Keyword 'point'

Specify a point

This keyword is used to specify a point, used, e.g., in specifying a point in 3D space for setting a stagnation (velocity vector = 0). Example specification: 'point 0.0 0.1 0.2 end'

Expected type: 3 reals

Keyword 'position'

Introduce the (particle) position equation input block or coupling

This keyword is used to introduce a position ... end block, used to specify the configuration of a system of deterministic or stochastic differential equations, governing particle positions usually in conjunction with velocity model, e.g, the Langevin, model. Note that the random number generator r123_philox is automatically put on the list as a selected RNG if no RNG is selected. Keywords allowed in a position ... end block: 'depvar', 'rng', 'init', 'coeff', 'velocity', 'For an example position ... end block, see doc/html/walker_example_position.html. (2) To specify a dependent variable (by a character) used to couple a differential equation system, in which the 'position' keyword appears) to another labeled by a 'depvar'. Note that this keyword can also be used as a keyword that selects position in some other context-specific way, e.g., 'position' as opposed to 'velocity'.

Keyword 'precision'

Precision in digits for ASCII floating-point output

This keyword is used to select the precision in digits for ASCII floating-point real number output. Example: "precision 10", which selects ten digits for floating-point output, e.g., 3.141592654. The number of digits must be larger than zero and lower than the maximum representable digits for the given floating-point type. For more info on setting the precision in C++, see http://en.cppreference.com/w/cpp/io/manip/setprecision, and http://en.cppreference.com/w/cpp/types/numeric_limits/digits10

Expected type: int

Lower bound: 1

Upper bound: 16

Expected valid choices: integer between [1...16] (both inclusive)

Keyword 'pref'

Start configuration block configuring p-adaptive refinement

This keyword is used to introduce the pref ... end block, used to configure p-adaptive refinement. Keywords allowed in this block: 'indicator' | 'ndofmax' | 'tolref' | '

Keyword 'prelax'

Turn multi-material finite pressure relaxation on/off

This keyword is used to turn finite pressure relaxation between multiple materials on/off. It is used only for the multi-material solver, and has no effect when used for the other PDE types.

Expected type: string

Expected valid choices: 1 | 0

Keyword 'prelax_timescale'

Time-scale for multi-material finite pressure relaxation

This keyword is used to specify the time-scale at which finite pressure relaxation between multiple materials occurs. The default value of 1.0 corresponds to a relaxation time of the order of time required for a sound wave to pass through a computational element. It is used only for multimat, and has no effect for the other PDE types.

Expected type: real

Lower bound: 0.001000

Keyword 'pressure'

Request pressure

This keyword is used to request the fluid pressure as an output variable.

Keyword 'problem'

Specify problem configuration for a partial differential equation solver

This keyword is used to specify the problem configuration for a partial differential equation solver in the input file.

Expected type: string

Expected valid choices: 'user_defined' | 'shear_diff' | 'slot_cyl' | 'gauss_hump' | 'cyl_advect' | 'cyl_vortex' | 'vortical_flow' | 'nl_energy_growth' | 'rayleigh_taylor' | 'taylor_green' | 'sod_shocktube' | 'rotated_sod_shocktube' | 'interface_advection' | 'gauss_hump_compflow'

Keyword 'pstiff'

EoS stiffness parameter

This keyword is used to specify the material property, stiffness parameter in the stiffened gas equation of state.

Expected type: real

Lower bound: 0.000000

Keyword 'r0'

Set PDE parameter(s) r0

This keyword is used to specify a real number used to parameterize the Euler equations solving the manufactured solution test case "non-linear energy growth". Example: "r0 2.0". For more information on the test case see Waltz, et. al, "Manufactured solutions for the three-dimensional Euler equations with relevance to Inertial Confinement Fusion", Journal of Computational Physics 267 (2014) 196-209.

Expected type: real

Keyword 'radius'

Specify a radius

This keyword is used to specify a radius, used, e.g., in specifying a point in 3D space for setting a stagnation (velocity vector = 0). Example specification: 'radius 1.0e-5'

Expected type: real

Lower bound: 0.000000

Keyword 'rayleigh_taylor'

Select the Rayleigh-Taylor test problem

This keyword is used to select the Rayleigh-Taylor unstable configuration test problem. The purpose of this test problem is to assess time dependent fluid motion in the presence of Rayleigh-Taylor unstable conditions, i.e. opposing density and pressure gradients. Example: "problem rayleigh_taylor". For more details, see Waltz, et. al, "Manufactured solutions for the three-dimensional Euler equations with relevance to Inertial Confinement Fusion", Journal of Computational Physics 267 (2014) 196-209.

Expected type: string

Keyword 'rcb'

Select recursive coordinate bisection mesh partitioner

This keyword is used to select the recursive coordinate bisection (RCB) mesh partitioner. RCB is a geometry-based partitioner used to distribute an input mesh among processing elements. See Control/Options/PartitioningAlgorithm.hpp for other valid options.

Keyword 'reference'

Specify mesh transformation relative to a mesh of another solver

This keyword is used to specify a solver, given with a dependent variable, configured upstream in the input file, whose mesh is used as a reference to which the mesh being configured is transformed relative to.

Expected type: character

Keyword 'refined'

Turn refined field output on/off

This keyword can be used to turn on/off refined field output, which refines the mesh and evaluates the solution on the refined mesh for saving the solution.

Expected type: string

Expected valid choices: true | false

Keyword 'refvar'

Configure dependent variables used for adaptive mesh refinement

This keyword is used to configured a list of dependent variables that trigger adaptive mesh refinement based on estimating their numerical error. These refinement variables are used for both initial (i.e., before time stepping) mesh refinement as well as during time stepping. Only previously (i.e., earlier in the input file) selected dependent variables can be configured as refinement variables. Dependent variables are required to be defined in all equation system configuration blocks, e.g., transport ... end, by using the 'depvar' keyword. Example: transport depvar c end amr refvar c end end. Selecting a particular scalar component in a system is done by appending the equation number to the refvar: Example: transport depvar q ncomp 3 end amr refvar q1 q2 end end, which configures two refinement variables: the first and third scalar component of the previously configured transport equation system.

Expected type: strings

Keyword 'rescomp'

Equation system component index for convergence

This keyword is used to specify a single integer that is used to denote the equation component index in the complete system of equation systems configured in an input file to use for the convergence criterion for local time stepping marching towards steady state.

Expected type: uint

Lower bound: 1

Keyword 'residual'

Set the convergence criterion for the residual to reach

This keyword is used to specify a convergence criterion for, e.g., local time stepping marching to steady state, below which the simulation is considered converged.

Expected type: real

Lower bound: 0.000000

Keyword 'rib'

Select recursive inertial bisection mesh partitioner

This keyword is used to select the recursive inertial bisection (RIB) mesh partitioner. RIB is a geometry-based partitioner used to distribute an input mesh among processing elements. See Control/Options/PartitioningAlgorithm.hpp for other valid options.

Keyword 'root'

Select Root output

This keyword is used to select the Root output file type readable by the Root framework from CERN for mesh-based field output in a field_output ... end block. Example: "filetype root", which selects the root file output format. For more info on Root, see https://root.cern.ch.

Keyword 'scheme'

Select discretization scheme

This keyword is used to select a spatial discretization scheme, necessarily connected to the teporal discretization scheme. See Control/Inciter/Options/Scheme.hpp for valid options.

Expected type: string

Expected valid choices: 'diagcg' | 'dg'

Keyword 'scientific'

Select the scientific ASCII floating-point output

This keyword is used to select the 'scientific' floating-point output format for ASCII floating-point real number output. Example: "format scientific", which selects the scientific floating-point output. Valid options are 'default', 'fixed', and 'scientific'. For more info on these various formats, see http://en.cppreference.com/w/cpp/io/manip/fixed.

Keyword 'sedov_blastwave'

Select the Sedov blast-wave test problem

This keyword is used to select the Sedov blast-wave test problem. The purpose of this test problem is to test the correctness of the approximate Riemann solver and its strong shock and interface capturing capabilities. Example: "problem sedov_blastwave".

Expected type: string

Keyword 'shear_diff'

Select the shear + diffusion test problem

This keyword is used to select the shear diffusion test problem. The initial and boundary conditions are specified to set up the test problem suitable to exercise and test the advection and diffusion terms of the scalar transport equation. Example: "problem shear_diff".

Expected type: string

Keyword 'shedding_flow'

Select the Shedding flow test problem

This keyword is used to select the Shedding flow test problem. It describe a quasi-2D inviscid flow over a triangular wedge in tetrahedron grid. The purpose of this test problem is to test the capability of DG scheme for retaining the shape of vortices and also different error indicator behavior for this external flow problem when p-adaptive DG scheme is applied. Example: "problem shedding_flow".

Expected type: string

Keyword 'shock_hebubble'

Select the shock He-bubble test problem

This keyword is used to select the shock He-bubble test problem. The purpose of this test problem is to test the correctness of the multi-material algorithm and its shock-interface interaction capabilities. Example: "problem shock_hebubble". For more details, see Quirk, J. J., & Karni, S. (1996). On the dynamics of a shock–bubble interaction. Journal of Fluid Mechanics, 318, 129-163.

Expected type: string

Keyword 'sideset'

Specify configuration for setting BC on a side set

This keyword is used to specify boundary conditions on a side set for a solving partial differential equation.

Expected type: strings

Keyword 'sine'

Prescribe sinusoidal mesh velocity for ALE

This keyword is used to prescribe a sinusoidal mesh velocity for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.

Keyword 'slot_cyl'

Select Zalesak's slotted cylinder test problem

This keyword is used to select the Zalesak's slotted cylinder test problem. The initial and boundary conditions are specified to set up the test problem suitable to exercise and test the advection and diffusion terms of the scalar transport equation. Example: "problem slot_cyl".

Expected type: string

Keyword 'smoother'

Select mesh velocity smoother

This keyword is used to select a mesh velocity smoother option, used for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.

Expected type: string

Expected valid choices: 'none' | 'laplace' | 'helmholtz'

Keyword 'sod_shocktube'

Select the Sod shock-tube test problem

This keyword is used to select the Sod shock-tube test problem. The purpose of this test problem is to test the correctness of the approximate Riemann solver and its shock and interface capturing capabilities. Example: "problem sod_shocktube". For more details, see G. A. Sod, "A Survey of Several Finite Difference Methods for Systems of Nonlinear Hyperbolic Conservation Laws", J. Comput. Phys., 27 (1978) 1–31.

Expected type: string

Keyword 'spectral_decay'

Select the spectral-decay indicator for p-adaptive DG scheme

This keyword is used to select the spectral-decay indicator used for p-adaptive discontinuous Galerkin (DG) discretization used in inciter. See Control/Inciter/Options/PrefIndicator.hpp for other valid options.

Keyword 'sponge'

Start configuration block describing a sponge boundary

This keyword is used to introduce an sponge ... end block, used to specify the configuration for applying sponge parameters on boundaries. Keywords allowed in a sponge ... end block: 'sideset', 'velocity', 'pressure'.

Keyword 'steady_state'

March to steady state

This keyword is used indicate that local time stepping should be used towards a stationary solution.

Expected type: string

Expected valid choices: true | false

Keyword 'stiffenedgas'

Select the stiffened gas equation of state

This keyword is used to select the stiffened gas equation of state.

Keyword 'superbeep1'

Select the Superbee limiter for DGP1

This keyword is used to select the Superbee limiter used for discontinuous Galerkin (DG) P1 spatial discretization used in inciter. See Control/Inciter/Options/Limiter.hpp for other valid options.

Keyword 'sysfct'

Turn on system nature of flux-corrected transport

This keyword can be used to enable a system-nature for flux-corrected transport (FCT). Note that FCT is only used in conjunction with continuous Galerkin finite element discretization, configured by scheme diagcg and it has no effect when the discontinuous Galerkin (DG) scheme is used, configured by 'scheme dg'. Enabling the system-nature for FCT will choose the limiter coefficients for a system of equations, e.g., compressible flow, in way that takes the system-nature of the equations into account. An example is assinging the minimum of the limit coefficient to all variables limited in a computational cell, e.g., density, momentum, and specitic total energy. This yields better, more monotonic, results.

Expected type: string

Expected valid choices: true | false

Keyword 'sysfctvar'

Specify a list of scalar component indices that considered for system FCT

This keyword is used to specify a list of integers that are considered for computing the system-nature of flux-corrected transport. Example: 'sysfctvar 0 1 2 3 end', which means ignoring the energy (by not listing 4) when computing the coupled limit coefficient for a system of mass, momentum, and energy for single-material compressible flow.

Expected type: integers

Keyword 't0'

Set starting non-dimensional time

This keyword is used to specify the starting time in a simulation.

Expected type: real

Lower bound: 0.000000

Keyword 't0ref'

Enable mesh refinement at t<0

This keyword is used to enable initial mesh refinement, which can be configured to perform multiple levels of mesh refinement based on various refinement criteria and configuration settings.

Expected type: string

Expected valid choices: true | false

Keyword 'taylor_green'

Select the Taylor-Green test problem

This keyword is used to select the Taylor-Green vortex test problem. The purpose of this problem is to test time accuracy and the correctness of the discretization of the viscous term in the Navier-Stokes equation. Example: "problem taylor_green". For more details on the flow, see G.I. Taylor, A.E. Green, "Mechanism of the Production of Small Eddies from Large Ones", Proc. R. Soc. Lond. A 1937 158 499-521; DOI: 10.1098/rspa.1937.0036. Published 3 February 1937.

Expected type: string

Keyword 'temperature'

Specify temperature

This keyword is used to configure temperature, used for, e.g., boundary or initial conditions.

Expected type: real

Keyword 'term'

Set maximum non-dimensional time to simulate

This keyword is used to specify the termination time in a simulation. The termination time and number of time steps, specified by 'nstep', are used in conjunction to determine when to stop a simulation: whichever is reached first. Both 'nstep' and 'term' can be left unspecified, in which case their default values are used. See also 'nstep'.

Expected type: real

Lower bound: 0.000000

Keyword 'time_interval'

Set interval (in units of physics time)

This keyword is used to specify an interval in units of physics time. This must be used within a relevant block.

Expected type: real

Lower bound: 0.000000

Keyword 'time_range'

Configure physics time range for output (in units of physics time)

This keyword is used to configure field-, or history-output, specifying a start time, a stop time, and an output frequency in physics time units. Example: 'time_range 0.2 0.3 0.001 end', which specifies that from t=0.2 to t=0.3 output should happen at physics time units of dt=0.001. This must be used within a relevant block.

Expected type: 3 reals

Keyword 'title'

Set analysis title

The analysis title may be specified in the input file using the 'title' keyword. The 'title' keyword must be followed by a double-quoted string specifying the analysis title. Example: title "Example problem". Specifying a title is optional.

Expected type: string

Keyword 'tol_derefine'

Configure derefine tolerance

This keyword is used to set the tolerance used to tag an edge for derefinement if the relative error is below this value.

Expected type: real

Lower bound: 0.000000

Upper bound: 1.000000

Expected valid choices: integer between [0.000000...1.000000] (both inclusive)

Keyword 'tol_refine'

Configure refine tolerance

This keyword is used to set the tolerance used to tag an edge for refinement if the relative error exceeds this value.

Expected type: real

Lower bound: 0.000000

Upper bound: 1.000000

Expected valid choices: integer between [0.000000...1.000000] (both inclusive)

Keyword 'tolerance'

Set the tolerance for the mesh velocity linear solve for ALE

This keyword is used to specify the tolerance to converge the mesh velocity linear solve for in arbitrary-Lagrangian-Eulerian (ALE) calculations. See also J. Waltz, N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A three-dimensional finite element arbitrary Lagrangian–Eulerian method for shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187, 2014.

Expected type: real

Keyword 'tolref'

Configure the tolerance for p-refinement for the p-adaptive DG scheme

This keyword can be used to configure a tolerance for p-adaptive refinement for the DG scheme. The keyword must be used in pref ... end block. All elements with a refinement indicator larger than this tolerance will be p-refined. Example specification: 'tolref 0.1'.

Expected type: real

Lower bound: 0.000000

Upper bound: 1.000000

Expected valid choices: real between [0.000000...1.000000] (both inclusive)

Keyword 'transport'

Start configuration block for an transport equation

This keyword is used to introduce an transport ... end block, used to specify the configuration for a transport equation type. Keywords allowed in an transport ... end block: 'depvar', 'ncomp', 'problem', 'physics', 'diffusivity', 'lambda', 'bc_dirichlet', 'bc_sym', 'bc_inlet', 'bc_outlet', 'u0'. intsharp', 'intsharp_param', 'For an example transport ... end block, see doc/html/inicter_example_transport.html.

Keyword 'ttyi'

Set screen output interval

This keyword is used to specify the interval in time steps for screen output during a simulation.

Expected type: uint

Lower bound: 0

Keyword 'u0'

Set PDE parameter(s) u0

This keyword is used to specify a vector of real numbers used to parameterize a system of partial differential equations. Example: "u0 5.0 2.0 3.0 end". The length of the vector depends on the particular type of PDE system and is controlled by the preceding keyword 'ncomp'.

Expected type: real(s)

Keyword 'underwater_ex'

Select the underwater explosion test problem

This keyword is used to select the underwater explosion test problem. The purpose of this test problem is to test the correctness of the multi-material algorithm and its interface capturing capabilities in the presence of strong shocks and large deformations. Example: "problem underwater_ex". For more details, see Chiapolino, A., Saurel, R., & Nkonga, B. (2017). Sharpening diffuse interfaces with compressible fluids on unstructured meshes. Journal of Computational Physics, 340, 389-417.

Expected type: string

Keyword 'uniform'

Select uniform initial mesh refinement

This keyword is used to select uniform initial mesh refinement.

Keyword 'uniform_derefine'

Select uniform initial mesh de-refinement

This keyword is used to select uniform initial mesh de-refinement.

Keyword 'upwind'

Select the upwind flux function

This keyword is used to select the upwind flux function used for discontinuous Galerkin (DG) spatial discretization used in inciter. It is really only useful for scalar transport, it is thus not selectable for anything else, and for scalar transport it is the hardcoded flux type. See Control/Inciter/Options/Flux.hpp for other valid options.

Keyword 'user_defined'

Select user-defined specification for a problem

This keyword is used to select the user-defined specification for an option. This could be a 'problem' to be solved by a partial differential equation, but can also be a 'user-defined' mesh velocity specification for ALE mesh motion.

Expected type: string

Keyword 'var'

Start of var ... end input block

This keyword is used to start a block in the input file containing a list of physics variables for output. The following keywords are allowed in an var ... end block:'density', 'x-momentum', 'y-momentum', 'z-momentum', 'specific_total_energy', 'volumetric_total_energy', 'x-velocity', 'y-velocity', 'z-velocity', 'pressure', 'material_indicator', 'analytic'.

Keyword 'veleq'

Specify the multi-material compressible flow with velocity equilibrium as physics configuration

This keyword is used to select a compressible flow algorithm as physics configuration designed for multiple materials assuming velocity equailibrium (single velocity). Example: "multimat physics veleq end"

Expected type: string

Keyword 'velocity'

Specify velocity

This keyword is used to configure a velocity vector, used for, e.g., boundary or initial conditions or as a keyword that selects velocity in some other context-specific way, e.g., 'velocity' as opposed to 'position'.

Expected type: real(s)

Keyword 'vertexbasedp1'

Select the vertex-based limiter for DGP1

This keyword is used to select the vertex-based limiter used for discontinuous Galerkin (DG) P1 spatial discretization used in inciter. Ref. Kuzmin, D. (2010). A vertex-based hierarchical slope limiter for p-adaptive discontinuous Galerkin methods. Journal of computational and applied mathematics, 233(12), 3077-3085. See Control/Inciter/Options/Limiter.hpp for other valid options.

Keyword 'vortical_flow'

Select the vortical flow test problem

This keyword is used to select the vortical flow test problem. The purpose of this test problem is to test velocity errors generated by spatial operators in the presence of 3D vorticity and in particluar the superposition of planar and vortical flows, analogous to voritcity stretching. Example: "problem vortical_flow. For more details, see Waltz, et. al, "Manufactured solutions for the three-dimensional Euler equations with relevance to Inertial Confinement Fusion", Journal of Computational Physics 267 (2014) 196-209.

Expected type: string

Keyword 'vortmult'

Configure vorticity multiplier for ALE mesh velocity

This keyword is used to configure the multiplier for the vorticity term in the mesh velocity smoother (mesh_velocity=fluid) or for the potential gradient for the Helmholtz mesh velocity (mesh_velocity=helmholtz) for ALE mesh motion. For 'fluid' this is coefficient c2 in Eq.(36) of Waltz, Morgan, Canfield, Charest, Risinger, Wohlbier, A three-dimensional finite element arbitrary Lagrangian–Eulerian method for shock hydrodynamics on unstructured grids, Computers & Fluids, 2014, and for 'helmholtz', this is coefficient a1 in Eq.(23) of Bakosi, Waltz, Morgan, Improved ALE mesh velocities for complex flows, International Journal for Numerical Methods in Fluids, 2017.

Expected type: real

Lower bound: 0.000000

Upper bound: 1.000000

Keyword 'waterair_shocktube'

Select the water-air shock-tube test problem

This keyword is used to select the Water-air shock-tube test problem. The purpose of this test problem is to test the correctness of the multi-material pressure relaxation procedure and its interface capturing capabilities. Example: "problem waterair_shocktube". For more details, see Chiapolino, A., Saurel, R., & Nkonga, B. (2017). Sharpening diffuse interfaces with compressible fluids on unstructured meshes. Journal of Computational Physics, 340, 389-417.

Expected type: string

Keyword 'wenop1'

Select the Weighted Essentially Non-Oscillatory (WENO) limiter for DGP1

This keyword is used to select the Weighted Essentially Non-Oscillatory limiter used for discontinuous Galerkin (DG) P1 spatial discretization used in inciter. See Control/Inciter/Options/Limiter.hpp for other valid options.

Keyword 'x+'

Configure initial refinement for coordinates larger than an x-normal plane

This keyword can be used to configure a mesh refinement volume for edges whose end-points are larger than the x coordinate of a plane perpendicular to coordinate x in 3D space. The keyword must be used in a coords ... end block within an amr ... end block with syntax 'x+ <real>'. All edges of the input mesh will be tagged for refinement whose end-points lie larger than (+) the real number given. Example: 'x+ 0.5' refines all edges whose end-point coordinates are larger than 0.5.

Expected type: real

Keyword 'x-'

Configure initial refinement for coordinates lower than an x-normal plane

This keyword can be used to configure a mesh refinement volume for edges whose end-points are less than the x coordinate of a plane perpendicular to coordinate x in 3D space. The keyword must be used in a coords ... end block within an amr ... end block with syntax 'x- <real>'. All edges of the input mesh will be tagged for refinement whose end-points lie less than (-) the real number given. Example: 'x- 0.5' refines all edges whose end-point coordinates are less than 0.5.

Expected type: real

Keyword 'x-momentum'

Request x-momentum

This keyword is used to request the fluid x-momentum as an output variable.

Keyword 'x-velocity'

Request x-velocity

This keyword is used to request the fluid x-velocity as an output variable.

Keyword 'xmax'

Maximum x coordinate

This keyword used to configure a maximum x coordinate, e.g., to specify a box.

Expected type: real

Keyword 'xmin'

Minimum x coordinate

This keyword used to configure a minimum x coordinate, e.g., to specify a box.

Expected type: real

Keyword 'y+'

Configure initial refinement for coordinates larger than an y-normal plane

This keyword can be used to configure a mesh refinement volume for edges whose end-points are larger than the y coordinate of a plane perpendicular to coordinate y in 3D space. The keyword must be used in a coords ... end block within an amr ... end block with syntax 'y+ <real>'. All edges of the input mesh will be tagged for refinement whose end-points lie larger than (+) the real number given. Example: 'y+ 0.5' refines all edges whose end-point coordinates are larger than 0.5.

Expected type: real

Keyword 'y-'

Configure initial refinement for coordinates lower than an y-normal plane

This keyword can be used to configure a mesh refinement volume for edges whose end-points are less than the y coordinate of a plane perpendicular to coordinate y in 3D space. The keyword must be used in a coords ... end block within an amr ... end block with syntax 'y- <real>'. All edges of the input mesh will be tagged for refinement whose end-points lie less than (-) the real number given. Example: 'y- 0.5' refines all edges whose end-point coordinates are less than 0.5.

Expected type: real

Keyword 'y-momentum'

Request y-momentum

This keyword is used to request the fluid y-momentum as an output variable.

Keyword 'y-velocity'

Request y-velocity

This keyword is used to request the fluid y-velocity as an output variable.

Keyword 'ymax'

Maximum y coordinate

This keyword used to configure a maximum y coordinate, e.g., to specify a box.

Expected type: real

Keyword 'ymin'

Minimum y coordinate

This keyword used to configure a minimum y coordinate, e.g., to specify a box.

Expected type: real

Keyword 'z+'

Configure initial refinement for coordinates larger than an z-normal plane

This keyword can be used to configure a mesh refinement volume for edges whose end-points are larger than the z coordinate of a plane perpendicular to coordinate z in 3D space. The keyword must be used in a coords ... end block within an amr ... end block with syntax 'z+ <real>'. All edges of the input mesh will be tagged for refinement whose end-points lie larger than (+) the real number given. Example: 'z+ 0.5' refines all edges whose end-point coordinates are larger than 0.5.

Expected type: real

Keyword 'z-'

Configure initial refinement for coordinates lower than an z-normal plane

This keyword can be used to configure a mesh refinement volume for edges whose end-points are less than the z coordinate of a plane perpendicular to coordinate z in 3D space. The keyword must be used in a coords ... end block within an amr ... end block with syntax 'z- <real>'. All edges of the input mesh will be tagged for refinement whose end-points lie less than (-) the real number given. Example: 'z- 0.5' refines all edges whose end-point coordinates are less than 0.5.

Expected type: real

Keyword 'z-momentum'

Request z-momentum

This keyword is used to request the fluid z-momentum as an output variable.

Keyword 'z-velocity'

Request z-velocity

This keyword is used to request the fluid z-velocity as an output variable.

Keyword 'zmax'

Maximum z coordinate

This keyword used to configure a maximum z coordinate, e.g., to specify a box.

Expected type: real

Keyword 'zmin'

Minimum z coordinate

This keyword used to configure a minimum z coordinate, e.g., to specify a box.

Expected type: real