Parameters Struct Reference

#include <global.h>

Public Member Functions
	Parameters (ParameterMap &pmap)

Public Attributes
int	nx
int	ny
int	nz
double	tout
double	outstep
int	n_steps_output
Real	gamma
char	init [MAXLEN]
int	nfile
bool	gas_only_use_static_grav
bool	output_always = false
int	n_steps_limit = -1
Real	xmin
Real	ymin
Real	zmin
Real	xlen
Real	ylen
Real	zlen
int	xl_bcnd
int	xu_bcnd
int	yl_bcnd
int	yu_bcnd
int	zl_bcnd
int	zu_bcnd
char	custom_bcnd [MAXLEN]
char	indir [MAXLEN]
Real	rho
Real	vx
Real	vy
Real	vz
Real	P
Real	A
Real	Bx
Real	By
Real	Bz
Real	rho_l
Real	vx_l
Real	vy_l
Real	vz_l
Real	P_l
Real	Bx_l
Real	By_l
Real	Bz_l
Real	rho_r
Real	vx_r
Real	vy_r
Real	vz_r
Real	P_r
Real	Bx_r
Real	By_r
Real	Bz_r
Real	diaph
Real	rEigenVec_rho
Real	rEigenVec_MomentumX
Real	rEigenVec_MomentumY
Real	rEigenVec_MomentumZ
Real	rEigenVec_E
Real	rEigenVec_Bx
Real	rEigenVec_By
Real	rEigenVec_Bz
Real	pitch
Real	yaw
Real	polarization
Real	radius
Real	P_blast
Real	wave_length
int	n_proc_x
int	n_proc_y
int	n_proc_z
int	bc_potential_type
Real	temperature_floor = 0
Real	density_floor = 0
Real	scalar_floor = 0

Detailed Description

A collection of assorted parameter values.

The existence of this type is largely a historical artifact. The plan is to gradually remove data members from this type.

Guidelines for Removing Parameters

In the vast majority of cases, a parameter value is temporarily stored here and then they are only referenced one subsequent time (while the simulation is being initialized).

• for example, a bunch of parameters are only ever read while initializing Cosmology, Gravity, Header, Particles, etc.
• some parameters, are only read once while setting up initial conditions.
• in all these cases, we can just read the data directly from ParameterMap rather than temporarily storing the values here.

When relocating other parameters, be mindful that a single execution of Cholla should NEVER read a parameter's value from ParameterMap more than once

• in this scenario, it would be extremely easy for different parts of the code to accidentally start using different default values, which would introduce lots of hard to debug issues
• while there are some potential workarounds to this, I think they might produce some undesired long-term behavior (plus, they are imperfect)
• if this situation arises, it's probably a sign that you should make a new struct (maybe a "Model" type?) where a value can be persistently stored

Constructor & Destructor Documentation

Parameters()

Parameters::Parameters ( ParameterMap &  pmap )

explicit

Construct a new instance using values from pmap

Parameters

[in]

pmap

The map of all parsed parameters. Reminder: the only reason this isn't marked const is to reflect the fact that the type internally tracks each parameter that is accessed.

---

The documentation for this struct was generated from the following files:

• global.h
• global.cpp