Writing a setting file

A series of setting files are available here. We list below all the parameters that can be defined in the different group of the setting file with their default values if they are not specified (remove the prefix m_ in the setting file). The parameters needed to define initial conditions are detailed in the initial condition callbacks. See Available callbacks for a description of the different callbacks that can be used.

simulation settings

group simulation-settings

read from the simulation group of the setting file

Variables

std::string m_model: model (default unknown, options monofluid, bifluid5eq or bifluid7eq)

double m_tcurrent: user defined start time (default 0.0)

double m_tmax: user defined maximum time (default 1.0)

double m_cfl: user defined Courant–Friedrichs–Lewy number (default 0.8)

int m_space_order: space order of the scheme (MUSCL, default 1, options 1 or 2)

int m_time_order: time order of the scheme (Hancock, default 1, options 1 or 2)

amr settings

group amr-settings

read from the amr group of the setting file

Variables

double m_ltree: physical size of a p4est tree (default 1.0)

int m_min_quadrants: minimal number of quadrants per MPI processor (default 16)

int m_min_refine: minimum level of refinement (default 5)

int m_max_refine: maximum level of refinement (default 7)

double m_epsilon_refine: threshold value used in refine callback (default 0.1)

double m_epsilon_coarsen: threshold value used in coarsen callback (default 0.1)

int m_ntree_x: number of p4est trees in the x direction (default 1)

int m_ntree_y: number of p4est trees in the y direction (default 1)

int m_ntree_z: number of p4est trees in the z direction (default 1)

int m_periodic_x: periodicity in the x direction (default 0, options 0 or 1)

int m_periodic_y: periodicity in the y direction (default 0, options 0 or 1)

int m_periodic_z: periodicity in the z direction (default 0, options 0 or 1)

io settings

group io-settings

read from the io group of the setting file

Variables

std::string m_output_prefix: the output prefix for the filenames (default output)

std::string m_restart_filename: filename of data from a previous run (default data.p4est)

int m_restart_enabled: is this a restart run ? (default 0, options 0 or 1)

int m_mesh_info: write treeid/level/mpirank to file (default 0, options 0 or 1)

int m_single_precision: write data in single precision (default 1, options 0 or 1)

int m_save_count: requested number of outputs (default 1)

std::vector<std::string> m_write_variables: names of variables to save (default NULL)

int m_statistics_level: verbose level for the timers (default 0)

callback settings

group callback-settings

read from the callback group of the setting file

Variables

std::string m_initial_condition: initial condition callback (default none)

std::string m_boundary_condition: boundary condition callback (default none)

std::string m_refine_condition: refine condition callback (default none)

std::string m_scalar_limiter: scalar limiter callback (default minmod)

std::string m_hyperbolic_flux: user-defined hyperbolic flux callback (default none)

std::string m_diffusion_flux: user-defined diffusion flux callback (default none)

std::string m_source_term: user-defined source term callback (default none)

std::string m_hydrodynamics_flux: hydrodynamics flux callback (default none)

std::string m_conductivity_flux: conductivity flux callback (default none)

std::string m_viscosity_flux: viscosity flux callback (default none)

std::string m_gravity_term: gravity source term callback (default none)

std::string m_pressure_relaxation_term: pressure relaxation callback (for bifluid7eq, default none)

std::string m_velocity_relaxation_term: velocity relaxation callback (for bifluid7eq, default none)

param settings (monofluid model)

eos_t eosFluid: parameters of the stiffened-gas eos (default gamma=1.666, Cv=1)

double gravity_x: gravitational force in the x direction (default 0.0)

double gravity_y: gravitational force in the y direction (default 0.0)

double gravity_z: gravitational force in the z direction (default 0.0)

int lowmach_correction_enabled: low-mach correction for the all-regime solver (default 0, options 0 or 1)

double K: diffusion coefficient for the all-regime solver (default 1.1)

param settings (bifluid5eq model)

eos_t eos_g: parameters of the stiffened-gas eos for the gas phase (default gamma=1.666, Cv=1)

eos_t eos_l: parameters of the stiffened-gas eos for the liquid phase (default gamma=1.666, Cv=1)

double gravity_x: gravitational force in the x direction (default 0.0)

double gravity_y: gravitational force in the y direction (default 0.0)

double gravity_z: gravitational force in the z direction (default 0.0)

int lowmach_correction_enabled: low-mach correction for the all-regime solver (default 0, options 0 or 1)

double K: diffusion coefficient for the all-regime solver (default 1.1)

param settings (bifluid7eq model)

eos_t eos_g: parameters of the stiffened-gas eos for the gas phase (default gamma=1.666, Cv=1)

eos_t eos_l: parameters of the stiffened-gas eos for the liquid phase (default gamma=1.666, Cv=1)

double gravity_x: gravitational force in the x direction (default 0.0)

double gravity_y: gravitational force in the y direction (default 0.0)

double gravity_z: gravitational force in the z direction (default 0.0)

int interface_mode: closure for the interface velocity or pressure (default 1, options 1 to 5, see overview)

EOS settings (Noble-Abel EOS)

inline eos_t()

double gamma: adiabatic index (default 1.666)

double q: heat bond (default 0.0)

double b: covolume (default 0.0)

double pinf: parameter for attractive interactions (default 0.0)

double Cv: specific heat capacity a constant volume (default 1.0)

double qp: parameter to compute specific entropy (default 0.0)

double mu: shear viscosity (default 0.0)

double eta: bulk viscosity (default 0.0)

double kappa: thermal conductivity (default 0.0)