Input Parameters Reference

This reference is automatically generated with Parthenon’s ParameterInput class. To generate it, pass the -p flag into a parthenon-based executable (in addition to the other flags you would normally pass), and optionally a regex to specify which blocks you’d like to output. Parthenon will print a valid CSV file to the terminal.

Every call to ParameterInput::Get* optionally takes a “docustring” as a final argument, which is the details column listed here. Default values are recorded if they are available.

In Parthenon

An incomplete list of all input parameters provided by Parthenon is tabulated below

Parthenon input parameters

block

parameters

type

default

description

parthenon/job

problem_id

string

parthenon

prefix for output files

parthenon/job

run_only_analysis

bool

parthenon/loadbalancing

balancer

string

default

load balancing strategy

parthenon/loadbalancing

interval

int

10

how frequently load balancing is performed if the mesh does not change

parthenon/loadbalancing

tolerance

Real

0.5

load balancer tolerance

parthenon/mesh

derefine_count

int

10

number of iterations a block must request derefinement before it is derefined

parthenon/mesh

ix1_bc

string

outflow

global mesh boundary condition on inner X1 face

parthenon/mesh

ix2_bc

string

outflow

global mesh boundary condition on inner X2 face

parthenon/mesh

ix3_bc

string

outflow

global mesh boundary condition on inner X3 face

parthenon/mesh

multigrid

bool

0

enable a multigrid mesh

parthenon/mesh

nghost

int

2

number of ghost zones on a block

parthenon/mesh

num_threads

int

1

number of host threads for infrastructure; unused

parthenon/mesh

nx1

int

number of cells on base mesh in x1 direction

parthenon/mesh

nx2

int

number of cells on base mesh in x2 direction

parthenon/mesh

nx3

int

number of cells on base mesh in x3 direction

parthenon/mesh

ox1_bc

string

outflow

global mesh boundary condition on outer X1 face

parthenon/mesh

ox2_bc

string

outflow

global mesh boundary condition on outer X2 face

parthenon/mesh

ox3_bc

string

outflow

global mesh boundary condition on outer X3 face

parthenon/mesh

packs_per_rank

int

1

number of meshblockpacks per rank, overrides pack_size

parthenon/mesh

refinement

string

none

mesh refinement mode

parthenon/mesh

refinement_in_one_min_nbufs

Real

64

parthenon/mesh

x1max

Real

maximum x1 value of domain

parthenon/mesh

x1min

Real

minimum x1 value of domain

parthenon/mesh

x1rat

Real

1

unused

parthenon/mesh

x2max

Real

maximum x2 value of domain

parthenon/mesh

x2min

Real

minimum x2 value of domain

parthenon/mesh

x2rat

Real

1

unused

parthenon/mesh

x3max

Real

maximum x3 value of domain

parthenon/mesh

x3min

Real

minimum x3 value of domain

parthenon/mesh

x3rat

Real

1

unused

parthenon/meshblock

nx1

int

64

logical size of a meshblock

parthenon/meshblock

nx2

int

64

logical size of a meshblock

parthenon/meshblock

nx3

int

logical size of a meshblock

parthenon/output0

dn

int

-1

output cadence in cycles

parthenon/output0

dt

Real

0.02

output cadence in physical time

parthenon/sparse

alloc_threshold

Real

1e-12

parthenon/sparse

dealloc_count

int

5

parthenon/sparse

dealloc_threshold

Real

1e-14

parthenon/sparse

enable_sparse

bool

1

parthenon/static_refinement0

level

int

parthenon/static_refinement0

x1max

Real

parthenon/static_refinement0

x1min

Real

parthenon/static_refinement0

x2max

Real

parthenon/static_refinement0

x2min

Real

parthenon/swarm

ix1_bc

string

outflow

global particle boundary condition on inner X1 face

parthenon/swarm

ix2_bc

string

outflow

global particle boundary condition on inner X2 face

parthenon/swarm

ix3_bc

string

periodic

global particle boundary condition on inner X3 face

parthenon/swarm

ox1_bc

string

outflow

global particle boundary condition on outer X1 face

parthenon/swarm

ox2_bc

string

outflow

global particle boundary condition on outer X2 face

parthenon/swarm

ox3_bc

string

periodic

global particle boundary condition on outer X3 face

parthenon/time

dt

Real

1.7976931e+308

initial value of time step before constraining via cfl

parthenon/time

dt_ceil

Real

1.7976931e+308

maximum allowed timestep

parthenon/time

dt_factor

Real

2

maximum relative change in dt per timestep

parthenon/time

dt_floor

Real

2.2250739e-308

minimum allowed timestep

parthenon/time

dt_force

Real

-1.7976931e+308

if set manually enforces this time step exactly

parthenon/time

dt_init

Real

1.7976931e+308

the first time step will be at least as small as dt_init

parthenon/time

dt_init_force

bool

0

if set to true, the first time step will be exactly dt_init

parthenon/time

dt_max

Real

1.7976931e+308

if timestep is above this level for dt_max_count_max iterations, parthenon throws an error

parthenon/time

dt_max_cycle_limit

int

1

number of cycles where dt > dt_max before error

parthenon/time

dt_min

Real

2.2250739e-308

if timestep falls below this level for dt_min_count_max iterations, parthenon throws an error

parthenon/time

dt_min_cycle_limit

int

10

number of cycles where dt < dt_min before error

parthenon/time

integrator

string

rk2

parthenon/time

ncycle

int

0

initial iteration count

parthenon/time

ncycle_out

int

1

cadence of outputs to stdout

parthenon/time

ncycle_out_mesh

int

0

cadence of outputs describing mesh

parthenon/time

nlim

int

-1

maximum number of iterations, only limiting if non-negative

parthenon/time

perf_cycle_offset

int

0

don’t measure performance for some number of initial cycles

parthenon/time

recv_bdry_buf_timeout_sec

Real

-1

parthenon/time

start_time

Real

0

physical time at which to start the simulation

parthenon/time

tlim

Real

inf

physical time at which to end the simulation

In the diffusion example

The non-parthenon input parameters used in the diffusion example are tabulated below

Parthenon input parameters

block

parameters

type

default

description

diffusion

boundary_prolongation

string

Linear

diffusion

cfl

Real

1

diffusion

constant_coefficient

bool

1

diffusion

diagonal_alpha

Real

1

diffusion

dt

Real

1

diffusion

flux_correct

bool

0

diffusion

set_flux_boundary

bool

0

diffusion

solver

string

MG

diffusion

t0

Real

0.001

diffusion

x0

Real

0

diffusion

y0

Real

0

diffusion

z0

Real

0

diffusion/solver_params

block_interior_prolongation

string

MetadataDefault

diffusion/solver_params

do_FAS

bool

1

diffusion/solver_params

max_coarsenings

int

2147483647

diffusion/solver_params

max_iterations

int

1000

diffusion/solver_params

prolongation

string

OldLinear

diffusion/solver_params

residual_tolerance

Real

1e-12

diffusion/solver_params

smoother

string

SRJ2

diffusion/solver_params

two_by_two_diagonal

bool

0

In the Burgers benchmark, Parthenon-VIBE

The non-parthenon input parameters used in Parthenon-VIBE are tabulated below

Parthenon input parameters

block

parameters

type

default

description

burgers

cfl

Real

0.8

burgers

kx_fact

Real

1

burgers

ky_fact

Real

1

burgers

kz_fact

Real

1

burgers

num_scalars

int

1

burgers

recon

string

weno5